ApplicationPackager

@webda/core

---

Class: ApplicationPackager<T>

Defined in: packages/core/src/deployers/packager.service.ts:21

Package the application with its deployment applied

The CLI injects it to run webda -d <deployment> package: the package folder only needs webda serve, without the deployment files nor a modules scan at startup.

Webda Modda

Extends

• Service<T>

Type Parameters

T

T extends ServiceParameters = ServiceParameters

Constructors

Constructor

new ApplicationPackager<T>(name, params): ApplicationPackager<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

ApplicationPackager<T>

Inherited from

Service.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

Service._compiledCapabilities

---

[WEBDA_EVENTS]

[WEBDA_EVENTS]: object

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

Set the Webda events here

Inherited from

Service.[WEBDA_EVENTS]

---

logger

protected logger: Logger

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

Logger with class context

Inherited from

Service.logger

---

metrics?

protected optional metrics?: object

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

Get metrics

Inherited from

Service.metrics

---

name

readonly name: string

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

Inherited from

Service.name

---

parameters

readonly parameters: T

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

Inherited from

Service.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

Service.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

Service.filterConfiguration

---

Parameters

static Parameters: typeof ServiceParameters = ServiceParameters

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

Service parameters

Inherited from

Service.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

Service.__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

Service.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

Service.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

Service.authorizeClientEvent

---

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

Service.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

Service.emit

---

getApplication()

protected getApplication(): Application

Defined in: packages/core/src/deployers/packager.service.ts:26

Application to package

Returns

Application

the current application

---

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

Service.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

Service.getClientEvents

---

getConfigurationFile()

protected getConfigurationFile(app): string

Defined in: packages/core/src/deployers/packager.service.ts:35

Configuration file the application is loaded from

Parameters

app

Application

the application

Returns

string

its absolute path, undefined if it has none

---

getMaxListeners()

getMaxListeners(): number

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

Returns

number

Inherited from

Service.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

Service.getMetric

---

getName()

getName(): string

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

Get service name

Returns

string

the result string

Inherited from

Service.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

Service.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

Service.getOperationId

---

getParameters()

getParameters(): T

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

Get the service parameters

Returns

T

the result

Inherited from

Service.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

Service.getService

---

getState()

getState(): ServiceStates

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

Get the current state

Returns

ServiceStates

the result

Inherited from

Service.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

Service.getUrl

---

init()

abstract init(): Promise<ApplicationPackager<T>>

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

Will be called after all the Services are created

Returns

Promise<ApplicationPackager<T>>

Inherited from

Service.init

---

initMetrics()

initMetrics(): void

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

Init the metrics

Returns

void

Inherited from

Service.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

Service.initOperations

---

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

Service.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

Service.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

Service.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

Service.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

Service.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

Service.once

---

package()

package(output?, configOnly?, force?): Promise<string | void>

Defined in: packages/core/src/deployers/packager.service.ts:60

Write the packaged application, or only its deployed configuration

The packager itself is removed from the configuration, as the CLI added it only to run this command. The deployed configuration carries the $packaged marker: it runs with webda serve as the webda.config.json of an application keeping the node_modules layout it was generated in.

Parameters

output?

string

target folder, or JSON file with configOnly; relative to the application folder

configOnly?

boolean

only output the deployed configuration, with the imports of the source tree

force?

boolean

allow configOnly to overwrite the configuration file of the application

Returns

Promise<string | void>

the deployed configuration as JSON with configOnly

Throws

CodeError PACKAGE_OVERWRITE_CONFIGURATION if configOnly targets the application configuration without force

---

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

Service.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

Service.removeListener

---

resolve()

resolve(): this

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

Resolve parameters and load metadata. @Route-declared routes are scanned and registered by Router.discoverRoutes(services) from Core.init() once every service has resolved — nothing to do per-service here.

Returns

this

the result

Inherited from

Service.resolve

---

setMaxListeners()

setMaxListeners(n): this

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

Parameters

n

number

Returns

this

Inherited from

Service.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

Service.stop

---

toJSON()

toJSON(): string

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

Prevent service to be serialized

Returns

string

the result

Inherited from

Service.toJSON

---

toString()

toString(): string

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

Return service representation

Returns

string

the result

Inherited from

Service.toString