esi-cap 1.7.39 → 1.7.40

package/types/lib/impl/index.d.ts

@@ -1,4 +1,59 @@
-export type ServiceEventInterceptor = (oService: object) => Promise<void>;
+export type CDSService = {
+    /**
+     * - Collection of entities served by this service.
+     */
+    entities: Record<string, any>;
+    /**
+     * - Executes a given query against the service.
+     */
+    run: (query: any) => Promise<any>;
+    /**
+     * - Starts a new transaction.
+     */
+    tx: (req: any) => CDSServiceTx;
+    /**
+     * - Alias for the tx method.
+     */
+    transaction: (req: any) => CDSServiceTx;
+    /**
+     * - Registers a handler for specific events.
+     */
+    on: CDSMethod;
+    /**
+     * - Registers a handler to run before the standard logic.
+     */
+    before: CDSMethod;
+    /**
+     * - Registers a handler to run after the standard logic.
+     */
+    after: CDSAfterMethod;
+    /**
+     * - Synchronously or asynchronously triggers an event.
+     */
+    emit: (event: string, data?: any) => Promise<void>;
+    /**
+     * - Sends a custom action or function call to the service.
+     */
+    send: (action: string, params?: any) => Promise<any>;
+    /**
+     * - Deletes records matching the given criteria.
+     */
+    delete: (entity: string, where: any) => Promise<number>;
+};
+/**
+ * Handles 'on' and 'before' event registrations.
+ * Supports both signatures: (event, entities, handler) AND (event, handler).
+ */
+export type CDSMethod = (event: string | string[], entitiesOrHandler: any | CDSHandler, handler?: CDSHandler) => void;
+/**
+ * Handles 'after' event registrations.
+ * Supports both signatures: (event, entities, handler) AND (event, handler).
+ */
+export type CDSAfterMethod = (event: string | string[], entitiesOrHandler: any | CDSAfterHandler, handler?: CDSAfterHandler) => void;
+export type CDSHandler = (req: any) => any | Promise<any>;
+export type CDSAfterHandler = (results: any, req: any) => any | Promise<any>;
+export type CDSServiceTx = CDSService;
+export type ServiceEventInterceptor = (oService: CDSService) => Promise<void>;
 export type Service = typeof import("../service").service;
 export type ServiceEvents = Service["events"];
 export type ServiceEventsKey = keyof ServiceEvents;
@@ -8,9 +63,54 @@ export type ServieEventsHandler = Partial<Record<ServiceEventsKey, ServiceEventI
  * @class
  * @public
  */
+/**
+ * @typedef {Object} CDSService
+ * @property {Record<string, any>} entities - Collection of entities served by this service.
+ * @property {(query: any) => Promise<any>} run - Executes a given query against the service.
+ * @property {(req: any) => CDSServiceTx} tx - Starts a new transaction.
+ * @property {(req: any) => CDSServiceTx} transaction - Alias for the tx method.
+ * @property {CDSMethod} on - Registers a handler for specific events.
+ * @property {CDSMethod} before - Registers a handler to run before the standard logic.
+ * @property {CDSAfterMethod} after - Registers a handler to run after the standard logic.
+ * @property {(event: string, data?: any) => Promise<void>} emit - Synchronously or asynchronously triggers an event.
+ * @property {(action: string, params?: any) => Promise<any>} send - Sends a custom action or function call to the service.
+ * @property {(entity: string, where: any) => Promise<number>} delete - Deletes records matching the given criteria.
+ */
+/**
+ * Handles 'on' and 'before' event registrations.
+ * Supports both signatures: (event, entities, handler) AND (event, handler).
+ * @callback CDSMethod
+ * @param {string | string[]} event - The name of the event (e.g., 'READ', 'UPDATE').
+ * @param {any | CDSHandler} entitiesOrHandler - Either the target entity/entities or the handler function.
+ * @param {CDSHandler} [handler] - The handler function if an entity was provided as the second argument.
+ * @returns {void}
+ */
+/**
+ * Handles 'after' event registrations.
+ * Supports both signatures: (event, entities, handler) AND (event, handler).
+ * @callback CDSAfterMethod
+ * @param {string | string[]} event - The name of the event.
+ * @param {any | CDSAfterHandler} entitiesOrHandler - Either the target entity or the handler function.
+ * @param {CDSAfterHandler} [handler] - The handler function if an entity was provided.
+ * @returns {void}
+ */
+/**
+ * @callback CDSHandler
+ * @param {any} req - The incoming request object.
+ * @returns {any | Promise<any>}
+ */
+/**
+ * @callback CDSAfterHandler
+ * @param {any} results - The results from the primary execution.
+ * @param {any} req - The incoming request object.
+ * @returns {any | Promise<any>}
+ */
+/**
+ * @typedef {CDSService} CDSServiceTx
+ */
 /**
  * @callback ServiceEventInterceptor
- * @param {object} oService - Service object for which request to be executed
+ * @param {CDSService} oService - Service object for which request to be executed
  * @returns {Promise<void>}
  */
 /**

package/types/lib/impl/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../.types/lib/impl/index.js"],"names":[],"mappings":"iDAuBW,MAAM,KACJ,OAAO,CAAC,IAAI,CAAC;sBAIb,cAAc,YAAY,EAAE,OAAO;4BACnC,OAAO,CAAC,QAAQ,CAAC;+BACjB,MAAM,aAAa;kCACnB,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,CAAC;AAhBvE;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AACH;IACI;;;;OAIG;IACH,2BAJW,MAAM,UACN,mBAAmB,GACjB,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;;;;;;;;OAUG;IACH,8BAVW,MAAM,gBACN,MAAM,WACN,mBAAmB,mBACnB,MAAM,GAAC,GAAG,EAAE,iBACZ,mBAAmB,oBACnB,MAAM,GAAC,GAAG,EAAE,oBACZ,GAAG,EAAE,wBACL,OAAO,GACL,OAAO,CAAC,IAAI,CAAC,CA0BzB;IAED;;;;;;;OAOG;IACH,+BAPW,MAAM,WACN,mBAAmB,cACnB,MAAM,GAAC,GAAG,EAAE,cACZ,GAAG,EAAE,wBACL,OAAO,GACL,OAAO,CAAC,IAAI,CAAC,CA8EzB;CACJ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../.types/lib/impl/index.js"],"names":[],"mappings":";;;;cAuBc,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;;;SACnB,CAAC,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC;;;;QAC5B,CAAC,GAAG,EAAE,GAAG,KAAK,YAAY;;;;iBAC1B,CAAC,GAAG,EAAE,GAAG,KAAK,YAAY;;;;QAC1B,SAAS;;;;YACT,SAAS;;;;WACT,cAAc;;;;UACd,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC;;;;UAC5C,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC;;;;YAC9C,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,MAAM,CAAC;;;;;;gCAOlD,MAAM,GAAG,MAAM,EAAE,qBACjB,GAAG,GAAG,UAAU,YAChB,UAAU,KACR,IAAI;;;;;qCAON,MAAM,GAAG,MAAM,EAAE,qBACjB,GAAG,GAAG,eAAe,YACrB,eAAe,KACb,IAAI;+BAKN,GAAG,KACD,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;wCAKpB,GAAG,OACH,GAAG,KACD,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;2BAIlB,UAAU;iDAKZ,UAAU,KACR,OAAO,CAAC,IAAI,CAAC;sBAIb,cAAc,YAAY,EAAE,OAAO;4BACnC,OAAO,CAAC,QAAQ,CAAC;+BACjB,MAAM,aAAa;kCACnB,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,CAAC;AAnEvE;;;;GAIG;AAEH;;;;;;;;;;;;GAYG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;GAQG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;GAEG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;IACI;;;;OAIG;IACH,2BAJW,MAAM,UACN,mBAAmB,GACjB,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;;;;;;;;OAUG;IACH,8BAVW,MAAM,gBACN,MAAM,WACN,mBAAmB,mBACnB,MAAM,GAAC,GAAG,EAAE,iBACZ,mBAAmB,oBACnB,MAAM,GAAC,GAAG,EAAE,oBACZ,GAAG,EAAE,wBACL,OAAO,GACL,OAAO,CAAC,IAAI,CAAC,CA0BzB;IAED;;;;;;;OAOG;IACH,+BAPW,MAAM,WACN,mBAAmB,cACnB,MAAM,GAAC,GAAG,EAAE,cACZ,GAAG,EAAE,wBACL,OAAO,GACL,OAAO,CAAC,IAAI,CAAC,CA8EzB;CACJ"}