@webda/core 4.0.0-beta.1 → 4.0.0-beta.3

package/lib/services/service.d.ts

@@ -1,8 +1,16 @@
-import { WorkerLogLevel } from "@webda/workout";
-import * as events from "events";
-import { Constructor, Core, Counter, Gauge, Histogram, Logger, MetricConfiguration, OperationContext } from "../index.js";
-import { OpenAPIWebdaDefinition } from "../router.js";
-import { HttpMethodType } from "../utils/httpcontext.js";
+import type { WorkerLogLevel } from "@webda/workout";
+import { AsyncEventUnknown } from "../events/asynceventemitter.js";
+import type { OpenAPIWebdaDefinition } from "../rest/irest.js";
+import type { HttpMethodType } from "../contexts/httpcontext.js";
+import { CustomConstructor } from "@webda/tsc-esm";
+import { type Counter, type Gauge, type Histogram, type MetricConfiguration } from "../metrics/metrics.js";
+import type { Logger } from "../loggers/ilogger.js";
+import type { OperationContext } from "../contexts/operationcontext.js";
+import { ServiceParameters } from "./serviceparameters.js";
+import type { ServiceName, ServicesMap } from "../core/hooks.js";
+import { AbstractService } from "../core/icore.js";
+import { WEBDA_EVENTS } from "@webda/models";
+import { ServiceStates } from "./iservice.js";
 /**
  * Inject a Bean inside this attribute
  *
@@ -15,110 +23,11 @@ import { HttpMethodType } from "../utils/httpcontext.js";
  * @param parameterOrName of the service to inject
  *
  * Might consider to split into two annotations
+ * TODO @webda/compiler could get all interfaces and ancestors classes to find the correct service
  */
-export declare function Inject(parameterOrName?: string, defaultValue?: string | boolean, optional?: boolean): (target: any, propertyName: string) => void;
-/**
- * Register an Operation within the framework
- *
- * An operation is a callable method with an input and output
- * The method will receive a Context from where it can execute
- *
- * @param id
- * @param input
- * @param output
- */
-export declare function Operation(properties?: {
-    /**
-     * Id of the Operation
-     *
-     * @default methodName
-     */
-    id?: string;
-    /**
-     * WebdaQL to execute on session object to ensure it can access
-     */
-    permission?: string;
-}, route?: {
-    url: string;
-    method?: HttpMethodType;
-    openapi?: OpenAPIWebdaDefinition;
-}): (target: any, executor: string) => void;
-export declare function Route(route: string, methods?: HttpMethodType | HttpMethodType[], openapi?: OpenAPIWebdaDefinition): (target: any, executor: string) => void;
-/**
- * A utility class that takes a array of string or string transformed into regex that includes
- * a start line and end line
- */
-export declare class RegExpValidator {
-    protected validators: RegExp[];
-    constructor(info: string | string[]);
-    static getRegExp(reg: string): RegExp;
-    validate(value: string): boolean;
-}
-/**
- * Standardized way to allow string/regex validation within configuration
- *
- * If url is prefixed with `regex:` it is considered a regex
- *
- * @example
- * ```typescript
- * class MyServiceParameters extends ServiceParameters {
- *    urls: string[];
- * }
- *
- * class MyService extends Service {
- *    loadParameters(params:any) {
- *      const parameters = new MyServiceParameters(params);
- *      this.urlsValidator = new RegExpStringValidator(parameters.urls);
- *      return parameters;
- *    }
- * }
- * ```
- */
-export declare class RegExpStringValidator extends RegExpValidator {
-    stringValidators: string[];
-    constructor(info: string | string[]);
-    /**
-     * Add string validation
-     * @param value
-     * @returns
-     */
-    validate(value: string): boolean;
-}
-/**
- * Interface to specify the Service parameters
- */
-export declare class ServiceParameters {
-    /**
-     * Type of the service
-     */
-    type: string;
-    /**
-     * URL on which to serve the content
-     */
-    url?: string;
-    /**
-     * OpenAPI override
-     * @SchemaIgnore
-     */
-    openapi?: OpenAPIWebdaDefinition;
-    /**
-     * Copy all parameters into the object by default
-     *
-     * @param params from webda.config.json
-     */
-    constructor(params: any);
-}
-/**
- * Create a new type with only optional
- */
-export type DeepPartial<T> = {
-    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
-};
-export type PartialModel<T> = {
-    [P in keyof T]: T[P] extends Function ? T[P] : T[P] extends object ? null | PartialModel<T[P]> : T[P] | null;
-};
-export type Events = {
-    [key: string]: unknown;
+export declare const Inject: {
+    (initialValue: undefined, context: ClassFieldDecoratorContext<Service<ServiceParameters, {}>, Service<ServiceParameters, {}>>): void;
+    (parameterOrName?: string, defaultValue?: string | boolean, optional?: boolean): (initialValue: undefined, context: ClassFieldDecoratorContext<Service<ServiceParameters, {}>, Service<ServiceParameters, {}>>) => void;
 };
 /**
  * Use this object for representing a service in the application
@@ -130,24 +39,20 @@ export type Events = {
  * @abstract
  * @class Service
  */
-declare abstract class Service<T extends ServiceParameters = ServiceParameters, E extends Events = Events> extends events.EventEmitter {
+declare abstract class Service<T extends ServiceParameters = ServiceParameters, E extends AsyncEventUnknown = {}> extends AbstractService<T, E> {
     /**
-     * Webda Core object
+     * Service parameters
      */
-    protected _webda: Core;
+    static Parameters: typeof ServiceParameters;
     /**
-     * Service name
+     * Set the Webda events here
      */
-    protected _name: string;
+    [WEBDA_EVENTS]: E;
     /**
-     * Hold the parameters for your service
-     *
-     * It will be bring from the `webda.config.json`
+     * Get the current state
+     * @returns the result
      */
-    protected parameters: T;
-    _createException: string;
-    _initTime: number;
-    _initException: any;
+    getState(): ServiceStates;
     /**
      * Logger with class context
      */
@@ -155,7 +60,7 @@ declare abstract class Service<T extends ServiceParameters = ServiceParameters,
     /**
      * Get metrics
      */
-    protected metrics?: any;
+    protected metrics?: {};
     /**
      *
      *
@@ -164,57 +69,86 @@ declare abstract class Service<T extends ServiceParameters = ServiceParameters,
      * @param {String} name - The name of the service
      * @param {Object} params - The parameters block define in the configuration file
      */
-    constructor(webda: Core, name: string, params?: DeepPartial<T>);
-    /**
-     * Load the parameters for a service
-     */
-    loadParameters(params: DeepPartial<T>): ServiceParameters;
+    constructor(name: string, params: T);
     /**
      * Used to compute or derivate input parameter to attribute
+     * @deprecated
      */
     computeParameters(): void;
     /**
      * Get the service parameters
+     * @returns the result
      */
     getParameters(): T;
-    /**
-     * Return WebdaCore
-     */
-    getWebda(): Core;
     /**
      * Shutdown the current service if action need to be taken
      */
     stop(): Promise<void>;
     /**
      * Return service representation
+     * @returns the result
      */
     toString(): string;
     /**
-     * Resolve parameters
-     * Call initRoutes and initBeanRoutes
+     * 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 the result
      */
     resolve(): this;
+    /**
+     * Load capabilities from webda.module.json metadata into {@link _compiledCapabilities}.
+     *
+     * Called during {@link 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).
+     *
+     * @example
+     * ```typescript
+     * // 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
+     */
+    protected loadCapabilities(): void;
     /**
      * Init the metrics
      */
     initMetrics(): void;
+    /**
+     * Get a service by name
+     * @param name - the name to use
+     * @returns the result map
+     * @deprecated Use useService, might reconsider
+     */
+    getService<T extends ServiceName>(name: T): ServicesMap[T];
     /**
      * Add service name label
-     * @param type
-     * @param configuration
-     * @returns
+     * @param type - the type to look up
+     * @param configuration - the configuration
+     * @returns the result
      */
-    getMetric<T = Gauge | Counter | Histogram>(type: Constructor<T, [MetricConfiguration<T>]>, configuration: MetricConfiguration<T>): T;
+    getMetric<T = Gauge | Counter | Histogram>(type: CustomConstructor<T, [MetricConfiguration<T>]>, configuration: MetricConfiguration<T>): T;
     /**
      * Return the events that an external system can subscribe to
      *
-     * @returns
+     * @returns the list of results
      */
     getClientEvents(): string[];
     /**
      * Authorize a public event subscription
-     * @param event
-     * @param context
+     * @param event - the event name
+     * @param context - the execution context
+     * @param _event - the event name
+     * @param _context - the execution context
+     * @returns true if the condition is met
      */
     authorizeClientEvent(_event: string, _context: OperationContext): boolean;
     /**
@@ -227,42 +161,32 @@ declare abstract class Service<T extends ServiceParameters = ServiceParameters,
     getUrl(url: string, _methods: HttpMethodType[]): string;
     /**
      * If undefined is returned it cancel the operation registration
-     * @param id
-     * @returns
+     * @param id - the identifier
+     * @returns the result
      */
     getOperationId(id: string): string | undefined;
     /**
      * Add a route dynamicaly
      *
      * @param {String} url of the route can contains dynamic part like {uuid}
-     * @param {Array[]} methods
+     * @param {Array[]} methods - the HTTP methods
      * @param {Function} executer Method to execute for this route
+     * @param openapi - the OpenAPI specification
+     * @param override - whether to override existing
      */
     protected addRoute(url: string, methods: HttpMethodType[], executer: Function, openapi?: OpenAPIWebdaDefinition, override?: boolean): void;
     /**
      * Return variables for replacement in openapi
-     * @returns
+     * @returns the result
      */
     getOpenApiReplacements(): any;
     /**
-     * Init the routes
-     */
-    initRoutes(): void;
-    /**
-     * Init the operations
+     * Init the operations from @Operation decorators on this service
      */
     initOperations(): void;
-    /**
-     * Convert an object to JSON using the Webda json filter
-     *
-     * @class Service
-     * @param {Object} object - The object to export
-     * @return {String} The export of the strip object ( removed all attribute with _ )
-     */
-    toPublicJSON(object: unknown): string;
     /**
      * Prevent service to be serialized
-     * @returns
+     * @returns the result
      */
     toJSON(): string;
     /**
@@ -272,42 +196,15 @@ declare abstract class Service<T extends ServiceParameters = ServiceParameters,
      * @abstract
      */
     init(): Promise<this>;
-    /**
-     *
-     * @param config new parameters for the service
-     */
-    reinit(config: DeepPartial<T>): Promise<this>;
     /**
      * Emit the event with data and wait for Promise to finish if listener returned a Promise
+     * @param event - the event name
+     * @param data - the data to process
      */
-    emitSync<Key extends keyof E>(event: Key, data: E[Key]): Promise<any[]>;
-    /**
-     * Override to allow capturing long listeners
-     * @override
-     */
-    emit<Key extends keyof E>(event: Key | symbol, data: E[Key]): boolean;
-    /**
-     * Type the listener part
-     * @param event
-     * @param listener
-     * @param queue
-     * @returns
-     */
-    on<Key extends keyof E>(event: Key | symbol, listener: (evt: E[Key]) => void): this;
-    /**
-     * Listen to an event as on(...) would do except that it will be asynchronous
-     * @param event
-     * @param callback
-     * @param queue Name of queue to use, can be undefined, queue name are used to define differents priorities
-     */
-    onAsync<Key extends keyof E>(event: Key, listener: (evt: E[Key]) => void, queue?: string): void;
-    /**
-     * Return a webda service
-     * @param service name to retrieve
-     */
-    getService<K extends Service<ServiceParameters>>(service: string): K;
+    emit<Key extends keyof E>(event: Key, data: E[Key]): Promise<void>;
     /**
      * Get service name
+     * @returns the result string
      */
     getName(): string;
     /**
@@ -318,13 +215,15 @@ declare abstract class Service<T extends ServiceParameters = ServiceParameters,
     __clean(): Promise<void>;
     /**
      * @private
+     * @returns the result
      */
     ___cleanData(): Promise<void>;
     /**
      *
      * @param level to log
-     * @param args
+     * @param args - additional arguments
      */
     log(level: WorkerLogLevel, ...args: any[]): void;
 }
 export { Service };
+//# sourceMappingURL=service.d.ts.map

package/lib/services/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/services/service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAqB,MAAM,gCAAgC,CAAC;AAEtF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAA2B,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC5E,OAAO,EAAa,KAAK,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,SAAS,EAAE,KAAK,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEtH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAI3D,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEjE,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAgB,aAAa,EAAE,MAAM,eAAe,CAAC;AAyE5D;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,MAAM;;;CAiBlB,CAAC;AAmBF;;;;;;;;;GASG;AACH,uBAAe,OAAO,CACpB,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAE/C,CAAC,SAAS,iBAAiB,GAAG,EAAE,CAChC,SAAQ,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,UAAU,2BAAqB;IACtC;;OAEG;IACH,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IAElB;;;OAGG;IACH,QAAQ,IAAI,aAAa,CAExB;IAED;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;IACvB;;;;;;;OAOG;IACH,YAAY,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAGlC;IAED;;;OAGG;IACH,iBAAiB,IAAI,IAAI,CAExB;IAED;;;OAGG;IACH,aAAa,IAAI,CAAC,CAEjB;IAED;;OAEG;IAEG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1B;IAED;;;OAGG;IACH,QAAQ,WAEP;IAED;;;;;OAKG;IAEH,OAAO,IAAI,IAAI,CAWd;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,gBAAgB,SAezB;IAED;;OAEG;IACH,WAAW,SAEV;IAED;;;;;OAKG;IACH,UAAU,CAAC,CAAC,SAAS,WAAW,EAAE,IAAI,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAEzD;IAED;;;;;OAKG;IACH,SAAS,CAAC,CAAC,GAAG,KAAK,GAAG,OAAO,GAAG,SAAS,EACvC,IAAI,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,EACpD,aAAa,EAAE,mBAAmB,CAAC,CAAC,CAAC,GACpC,CAAC,CAKH;IAED;;;;OAIG;IACH,eAAe,IAAI,MAAM,EAAE,CAE1B;IAED;;;;;;;OAOG;IACH,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAExE;IAED;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,UAgB7C;IAED;;;;OAIG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE7C;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,CAChB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,cAAc,EAAE,EACzB,QAAQ,EAAE,QAAQ,EAClB,OAAO,GAAE,sBAA2B,EACpC,QAAQ,GAAE,OAAe,QAkB1B;IAED;;;OAGG;IACH,sBAAsB,IAAI,GAAG,CAE5B;IAED;;OAEG;IACH,cAAc,SA0Bb;IAED;;;OAGG;IACH,MAAM,WAEL;IAED;;;;;OAKG;IAEG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAG1B;IAED;;;;OAIG;IACG,IAAI,CAAC,GAAG,SAAS,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAIvE;IAED;;;OAGG;IACH,OAAO,IAAI,MAAM,CAEhB;IAED;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAMvB;IAED;;;OAGG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAE5B;IAED;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,QAGxC;CACF;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}