OperationIdTransport

@webda/core

---

Class: OperationIdTransport<T>

Defined in: packages/core/src/rest/operationstransport.service.ts:38

Generic operation transport for clients that work by operation id (Webda CLI): list the callable operations, call one

Webda Modda

OperationsTransport

Extends

• OperationsTransport<T>

Type Parameters

T

T extends OperationIdTransportParameters = OperationIdTransportParameters

Constructors

Constructor

new OperationIdTransport<T>(name, params): OperationIdTransport<T>

Defined in: packages/core/src/services/service.ts:191

Service

Parameters

name

string

The name of the service

params

T

The parameters block define in the configuration file

Returns

OperationIdTransport<T>

Inherited from

OperationsTransport.constructor

Properties

_compiledCapabilities

protected _compiledCapabilities: Record<string, any> = {}

Defined in: packages/core/src/services/iservice.ts:49

Capabilities detected at compile-time from @WebdaCapability-tagged interfaces.

Populated during Service.resolve by reading the service's entry in webda.module.json. Each key is a capability name (e.g., "request-filter"), and the value is an empty object {} by default. Override getCapabilities to provide capability-specific configuration or to conditionally disable capabilities.

See

getCapabilities

Inherited from

OperationsTransport._compiledCapabilities

---

[WEBDA_EVENTS]

[WEBDA_EVENTS]: object

Defined in: packages/core/src/services/service.ts:165

Set the Webda events here

Inherited from

OperationsTransport.[WEBDA_EVENTS]

---

logger

protected logger: Logger

Defined in: packages/core/src/services/service.ts:178

Logger with class context

Inherited from

OperationsTransport.logger

---

metrics?

protected optional metrics?: object

Defined in: packages/core/src/services/service.ts:182

Get metrics

Inherited from

OperationsTransport.metrics

---

name

readonly name: string

Defined in: packages/core/src/services/iservice.ts:26

Inherited from

OperationsTransport.name

---

parameters

readonly parameters: T

Defined in: packages/core/src/services/iservice.ts:27

Inherited from

OperationsTransport.parameters

---

createConfiguration?

static optional createConfiguration?: (params) => any

Defined in: packages/core/src/services/iservice.ts:32

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

OperationsTransport.createConfiguration

---

filterConfiguration?

static optional filterConfiguration?: (params) => any

Defined in: packages/core/src/services/iservice.ts:37

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

OperationsTransport.filterConfiguration

---

Parameters

static Parameters: typeof ServiceParameters = ServiceParameters

Defined in: packages/core/src/services/service.ts:161

Service parameters

Inherited from

OperationsTransport.Parameters

Methods

__clean()

abstract __clean(): Promise<void>

Defined in: packages/core/src/services/service.ts:494

Clean the service data, can only be used in test mode

Returns

Promise<void>

Inherited from

OperationsTransport.__clean

---

addListener()

addListener<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:83

Type Parameters

Key

Key extends never

Parameters

eventName

Key

the event name

listener

(event) => void | Promise<void>

the event listener

Returns

this

this for chaining

See

EventEmitter.addListener

Inherited from

OperationsTransport.addListener

---

addRoute()

protected addRoute(url, methods, executer, openapi?, override?): void

Defined in: packages/core/src/services/service.ts:386

Add a route dynamicaly

Parameters

url

string

of the route can contains dynamic part like {uuid}

methods

HttpMethodType[]

the HTTP methods

executer

Function

Method to execute for this route

openapi?

OpenAPIWebdaDefinition = {}

the OpenAPI specification

override?

boolean = false

whether to override existing

Returns

void

Inherited from

OperationsTransport.addRoute

---

authorizeClientEvent()

authorizeClientEvent(_event, _context): boolean

Defined in: packages/core/src/services/service.ts:339

Authorize a public event subscription

Parameters

_event

string

the event name

_context

OperationContext

the execution context

Returns

boolean

true if the condition is met

Inherited from

OperationsTransport.authorizeClientEvent

---

call()

call(ctx): Promise<void>

Defined in: packages/core/src/rest/operationstransport.service.ts:110

Call an operation by id

Parameters

ctx

WebContext

web context

Returns

Promise<void>

---

computeParameters()

computeParameters(): void

Defined in: packages/core/src/services/service.ts:200

Used to compute or derivate input parameter to attribute

Returns

void

Deprecated

Inherited from

OperationsTransport.computeParameters

---

emit()

emit<Key>(event, data): Promise<void>

Defined in: packages/core/src/services/service.ts:475

Emit the event with data and wait for Promise to finish if listener returned a Promise

Type Parameters

Key

Key extends never

Parameters

event

Key

the event name

data

object[Key]

the data to process

Returns

Promise<void>

Inherited from

OperationsTransport.emit

---

exposeOperation()

exposeOperation(): void

Defined in: packages/core/src/rest/operationstransport.service.ts:59

Returns

void

Overrides

OperationsTransport.exposeOperation

---

getCapabilities()

getCapabilities(): Record<string, any>

Defined in: packages/core/src/services/iservice.ts:77

Return the capabilities of this service.

By default returns capabilities detected at compile-time from

Returns

Record<string, any>

the result

Webda Capability-tagged

interfaces in webda.module.json.

Override to disable capabilities based on configuration:

getCapabilities() {
  const caps = super.getCapabilities();
  if (!this.parameters.enabled) delete caps["request-filter"];
  return caps;
}

Inherited from

OperationsTransport.getCapabilities

---

getClientEvents()

getClientEvents(): string[]

Defined in: packages/core/src/services/service.ts:327

Return the events that an external system can subscribe to

Returns

string[]

the list of results

Inherited from

OperationsTransport.getClientEvents

---

getMaxListeners()

getMaxListeners(): number

Defined in: packages/core/src/events/asynceventemitter.ts:90

Returns

number

Inherited from

OperationsTransport.getMaxListeners

---

getMetric()

getMetric<T>(type, configuration): T

Defined in: packages/core/src/services/service.ts:309

Add service name label

Type Parameters

T

T = Gauge<string> | Counter<string> | Histogram<string>

Parameters

type

CustomConstructor<T, [MetricConfiguration<T>]>

the type to look up

configuration

MetricConfiguration<T>

the configuration

Returns

T

the result

Inherited from

OperationsTransport.getMetric

---

getName()

getName(): string

Defined in: packages/core/src/services/service.ts:485

Get service name

Returns

string

the result string

Inherited from

OperationsTransport.getName

---

getOpenApiReplacements()

getOpenApiReplacements(): any

Defined in: packages/core/src/services/service.ts:415

Return variables for replacement in openapi

Returns

any

the result

Inherited from

OperationsTransport.getOpenApiReplacements

---

getOperationId()

getOperationId(id): string

Defined in: packages/core/src/services/service.ts:373

If undefined is returned it cancel the operation registration

Parameters

id

string

the identifier

Returns

string

the result

Inherited from

OperationsTransport.getOperationId

---

getOperations()

getOperations(): Record<string, OperationDefinition>

Defined in: packages/core/src/services/operationstransport.ts:106

Get all registered operations, filtered by this transport's include/exclude config

Returns

Record<string, OperationDefinition>

filtered map of operation id to definition

Inherited from

OperationsTransport.getOperations

---

getParameters()

getParameters(): T

Defined in: packages/core/src/services/service.ts:208

Get the service parameters

Returns

T

the result

Inherited from

OperationsTransport.getParameters

---

getService()

getService<T>(name): ServicesMap[T]

Defined in: packages/core/src/services/service.ts:299

Get a service by name

Type Parameters

T

T extends keyof ServicesMap

Parameters

name

T

the name to use

Returns

ServicesMap[T]

the result map

Deprecated

Use useService, might reconsider

Inherited from

OperationsTransport.getService

---

getState()

getState(): ServiceStates

Defined in: packages/core/src/services/service.ts:171

Get the current state

Returns

ServiceStates

the result

Inherited from

OperationsTransport.getState

---

getUrl()

getUrl(url, _methods): string

Defined in: packages/core/src/services/service.ts:350

Return the full path url based on parameters

Parameters

url

string

relative url to service

_methods

HttpMethodType[]

in case we need filtering (like Store)

Returns

string

absolute url or undefined if need to skip the Route

Inherited from

OperationsTransport.getUrl

---

init()

init(): Promise<OperationIdTransport<T>>

Defined in: packages/core/src/services/operationstransport.ts:121

Initialize the transport by exposing all non-hidden operations

Returns

Promise<OperationIdTransport<T>>

this for chaining

Inherited from

OperationsTransport.init

---

initMetrics()

initMetrics(): void

Defined in: packages/core/src/services/service.ts:289

Init the metrics

Returns

void

Inherited from

OperationsTransport.initMetrics

---

initOperations()

initOperations(): void

Defined in: packages/core/src/services/service.ts:422

Init the operations from

Returns

void

Operation

decorators on this service

Inherited from

OperationsTransport.initOperations

---

initTransport()

protected initTransport(): void

Defined in: packages/core/src/rest/operationstransport.service.ts:54

Routes are fixed, operations are not exposed one by one

Returns

void

Overrides

OperationsTransport.initTransport

---

isServed()

protected isServed(id): boolean

Defined in: packages/core/src/rest/operationstransport.service.ts:46

Whether this transport serves an operation: known, visible, included by the operations filter and not client-streamed

Parameters

id

string

the operation identifier

Returns

boolean

true when it can be listed and called

---

list()

list(ctx): Promise<void>

Defined in: packages/core/src/rest/operationstransport.service.ts:78

List the operations the caller (and its token scope) may call: { version, aliases?, operations }. version is a hash of the listing (16 hex characters): it changes whenever an operation the caller sees is added, removed or changed, so a client can cache the listing. aliases maps a model plural to its singular (MindNodes → MindNode), as model operations use both (MindNodes.Query, MindNode.Get), for the models of the listed operations only

Parameters

ctx

WebContext

web context

Returns

Promise<void>

---

listeners()

listeners(eventName): Function[]

Defined in: packages/core/src/events/asynceventemitter.ts:183

Get all listeners for an event

Parameters

eventName

never

the event name

Returns

Function[]

the list of results

Inherited from

OperationsTransport.listeners

---

loadCapabilities()

protected loadCapabilities(): void

Defined in: packages/core/src/services/service.ts:269

Load capabilities from webda.module.json metadata into _compiledCapabilities.

Called during resolve after dependency injection. Reads the service's type name from parameters, looks it up in the application's module metadata (moddas or beans section), and populates _compiledCapabilities with an empty object for each declared capability name.

Fails silently if the application is not available (e.g., in unit tests where services are instantiated without a full application context).

Returns

void

Example

// If webda.module.json contains:
// { "moddas": { "MyApp/HawkService": { "capabilities": ["request-filter", "cors-filter"] } } }
// Then after resolve(), this.getCapabilities() returns:
// { "request-filter": {}, "cors-filter": {} }

See

getCapabilities

Inherited from

OperationsTransport.loadCapabilities

---

log()

log(level, ...args): void

Defined in: packages/core/src/services/service.ts:515

Parameters

level

WorkerLogLevel

to log

args

...any[]

additional arguments

Returns

void

Inherited from

OperationsTransport.log

---

off()

off<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:141

Type Parameters

Key

Key extends never

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.off

Inherited from

OperationsTransport.off

---

on()

on<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:119

Type Parameters

Key

Key extends never

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.once

Inherited from

OperationsTransport.on

---

once()

once<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:108

Type Parameters

Key

Key extends never

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.once

Inherited from

OperationsTransport.once

---

removeAllListeners()

removeAllListeners<Key>(eventName?): this

Defined in: packages/core/src/events/asynceventemitter.ts:150

Type Parameters

Key

Key extends never

Parameters

eventName?

Key

the event name

Returns

this

this for chaining

See

EventEmitter.removeAllListeners

Inherited from

OperationsTransport.removeAllListeners

---

removeListener()

removeListener<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:130

Type Parameters

Key

Key extends never

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.removeListener

Inherited from

OperationsTransport.removeListener

---

resolve()

resolve(): this

Defined in: packages/core/src/rest/operationstransport.service.ts:64

Returns

this

Overrides

OperationsTransport.resolve

---

setMaxListeners()

setMaxListeners(n): this

Defined in: packages/core/src/events/asynceventemitter.ts:97

Parameters

n

number

Returns

this

Inherited from

OperationsTransport.setMaxListeners

---

stop()

stop(): Promise<void>

Defined in: packages/core/src/services/service.ts:216

Shutdown the current service if action need to be taken

Returns

Promise<void>

Inherited from

OperationsTransport.stop

---

toJSON()

toJSON(): string

Defined in: packages/core/src/services/service.ts:454

Prevent service to be serialized

Returns

string

the result

Inherited from

OperationsTransport.toJSON

---

toString()

toString(): string

Defined in: packages/core/src/services/service.ts:224

Return service representation

Returns

string

the result

Inherited from

OperationsTransport.toString