esi-cap 1.7.41 → 1.7.42

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

@@ -40,6 +40,115 @@ export type CDSService = {
      */
     delete: (entity: string, where: any) => Promise<number>;
 };
+export type CDSRequest<T> = {
+    /**
+     * - The request payload.
+     */
+    data: T & {
+        params?: any;
+    };
+    /**
+     * - Map of request headers.
+     */
+    headers: Record<string, string>;
+    /**
+     * - Positional parameters from the URL.
+     */
+    params: any[];
+    /**
+     * - The authenticated user information.
+     */
+    user: CDSUser;
+    /**
+     * - The CQN (OData-like) query structure.
+     */
+    query: any;
+    /**
+     * - Information about the target entity.
+     */
+    target: CDSTarget;
+    /**
+     * - The name of the event (e.g., 'READ', 'UPDATE').
+     */
+    event: string;
+    /**
+     * - The underlying HTTP request (if applicable).
+     */
+    http?: {
+        req: {
+            headers: Record<string, string>;
+        };
+    };
+    /**
+     * - Rejects the request with a specific status and message.
+     */
+    reject: CDSReject;
+    /**
+     * - Adds an error to the request without necessarily stopping execution.
+     */
+    error: CDSError;
+    /**
+     * - Adds a warning message to the response.
+     */
+    warn: (opts: {
+        message: string;
+    }) => void;
+    /**
+     * - Adds an informational message to the response.
+     */
+    info: (msg: string) => void;
+    /**
+     * - Collection of errors collected during processing.
+     */
+    errors?: any[];
+    /**
+     * - esi-cap runtime extension: logic to run before the 'on' phase.
+     */
+    PreOn?: any;
+    /**
+     * - esi-cap runtime extension: logic to run after the 'on' phase.
+     */
+    PostOn?: any;
+    /**
+     * - esi-cap runtime extension: pre-mashup processing.
+     */
+    PreMeshUp?: any;
+};
+export type CDSUser = {
+    /**
+     * - The user's unique identifier.
+     */
+    id: string;
+    /**
+     * - Custom user attributes.
+     */
+    attr: Record<string, any>;
+    /**
+     * - Checks if the user has a specific role.
+     */
+    is: (role: string) => boolean;
+};
+export type CDSTarget = {
+    /**
+     * - The absolute name of the target entity.
+     */
+    name: string;
+    /**
+     * - Any projection (select list) applied to the entity.
+     */
+    projection?: any;
+};
+export type CDSReject = (opts?: {
+    status?: number;
+    message?: string;
+}) => void;
+export type CDSError = (opts: {
+    status?: number;
+    message?: string;
+    code?: string;
+    target?: string;
+    args?: any[];
+}) => void;
 /**
  * Handles 'on' and 'before' event registrations.
  * Supports both signatures: (event, entities, handler) AND (event, handler).
@@ -50,14 +159,14 @@ export type CDSMethod = (event: string | string[], entitiesOrHandler: any | CDSH
  * 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, next: () => Promise<any>) => any | Promise<any>;
-export type CDSAfterHandler = (results: any, req: any) => any | Promise<any>;
+export type CDSHandler = (req: CDSRequest, next: () => Promise<any>) => any | Promise<any>;
+export type CDSAfterHandler = (results: any, req: CDSRequest) => any | Promise<any>;
 export type CDSServiceTx = CDSService;
-export type ServiceEventInterceptor = (oService: CDSService) => Promise<void>;
+export type ServiceEventsServiceInterceptor = (oService: CDSService) => Promise<void>;
 export type Service = typeof import("../service").service;
 export type ServiceEvents = Service["events"];
 export type ServiceEventsKey = keyof ServiceEvents;
-export type ServieEventsHandler = Partial<Record<ServiceEventsKey, ServiceEventInterceptor>>;
+export type ServieEventsHandler = Partial<Record<ServiceEventsKey, ServiceEventsServiceInterceptor>>;
 /**
  * impl module
  * @class
@@ -76,6 +185,47 @@ export type ServieEventsHandler = Partial<Record<ServiceEventsKey, ServiceEventI
  * @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.
  */
+/**
+ * @template T
+ * @typedef {Object} CDSRequest
+ * @property {T & { params?: any }} data - The request payload.
+ * @property {Record<string, string>} headers - Map of request headers.
+ * @property {any[]} params - Positional parameters from the URL.
+ * @property {CDSUser} user - The authenticated user information.
+ * @property {any} query - The CQN (OData-like) query structure.
+ * @property {CDSTarget} target - Information about the target entity.
+ * @property {string} event - The name of the event (e.g., 'READ', 'UPDATE').
+ * @property {{ req: { headers: Record<string, string> } }} [http] - The underlying HTTP request (if applicable).
+ * @property {CDSReject} reject - Rejects the request with a specific status and message.
+ * @property {CDSError} error - Adds an error to the request without necessarily stopping execution.
+ * @property {(opts: { message: string }) => void} warn - Adds a warning message to the response.
+ * @property {(msg: string) => void} info - Adds an informational message to the response.
+ * @property {any[]} [errors] - Collection of errors collected during processing.
+ * @property {any} [PreOn] - esi-cap runtime extension: logic to run before the 'on' phase.
+ * @property {any} [PostOn] - esi-cap runtime extension: logic to run after the 'on' phase.
+ * @property {any} [PreMeshUp] - esi-cap runtime extension: pre-mashup processing.
+ */
+/**
+ * @typedef {Object} CDSUser
+ * @property {string} id - The user's unique identifier.
+ * @property {Record<string, any>} attr - Custom user attributes.
+ * @property {(role: string) => boolean} is - Checks if the user has a specific role.
+ */
+/**
+ * @typedef {Object} CDSTarget
+ * @property {string} name - The absolute name of the target entity.
+ * @property {any} [projection] - Any projection (select list) applied to the entity.
+ */
+/**
+ * @callback CDSReject
+ * @param {{ status?: number; message?: string }} [opts]
+ * @returns {void}
+ */
+/**
+ * @callback CDSError
+ * @param {{ status?: number; message?: string; code?: string; target?: string; args?: any[] }} opts
+ * @returns {void}
+ */
 /**
  * Handles 'on' and 'before' event registrations.
  * Supports both signatures: (event, entities, handler) AND (event, handler).
@@ -96,29 +246,34 @@ export type ServieEventsHandler = Partial<Record<ServiceEventsKey, ServiceEventI
  */
 /**
  * @callback CDSHandler
- * @param {any} req - The incoming request object.
+ * @param {CDSRequest} req - The incoming request object.
  * @param {() => Promise<any>} next - The function to call the next handler in the chain.
  * @returns {any | Promise<any>}
  */
 /**
  * @callback CDSAfterHandler
  * @param {any} results - The results from the primary execution.
- * @param {any} req - The incoming request object.
+ * @param {CDSRequest} req - The incoming request object.
  * @returns {any | Promise<any>}
  */
 /**
  * @typedef {CDSService} CDSServiceTx
  */
 /**
- * @callback ServiceEventInterceptor
+ * @callback ServiceEventsServiceInterceptor
  * @param {CDSService} oService - Service object for which request to be executed
  * @returns {Promise<void>}
  */
+/**
+ * @callback ServiceEventsServiceInterceptor
+ * @param {CDSRequest} oRequest - Request object
+ * @returns {Promise<void>}
+ */
 /**
  * @typedef {typeof import('../service').service} Service
  * @typedef {Service['events']} ServiceEvents
  * @typedef {keyof ServiceEvents} ServiceEventsKey
- * @typedef {Partial<Record<ServiceEventsKey, ServiceEventInterceptor>>} ServieEventsHandler
+ * @typedef {Partial<Record<ServiceEventsKey, ServiceEventsServiceInterceptor>>} ServieEventsHandler
  */
 export class impl {
     /**

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":";;;;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,QACH,MAAM,OAAO,CAAC,GAAG,CAAC,KAChB,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;AApEvE;;;;GAIG;AAEH;;;;;;;;;;;;GAYG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;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"}
+{"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;;uBAIhD,CAAC;;;;UAEA,CAAC,GAAG;QAAE,MAAM,CAAC,EAAE,GAAG,CAAA;KAAE;;;;aACpB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;;;;YACtB,GAAG,EAAE;;;;UACL,OAAO;;;;WACP,GAAG;;;;YACH,SAAS;;;;WACT,MAAM;;;;WACN;QAAE,GAAG,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;SAAE,CAAA;KAAE;;;;YAC5C,SAAS;;;;WACT,QAAQ;;;;UACR,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI;;;;UACnC,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI;;;;aACrB,GAAG,EAAE;;;;YACL,GAAG;;;;aACH,GAAG;;;;gBACH,GAAG;;;;;;QAKH,MAAM;;;;UACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;;;QACnB,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO;;;;;;UAKzB,MAAM;;;;iBACN,GAAG;;gCAKN;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,KACnC,IAAI;8BAKN;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;CAAE,KACjF,IAAI;;;;;gCAON,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,UAAU,QACV,MAAM,OAAO,CAAC,GAAG,CAAC,KAChB,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;wCAKpB,GAAG,OACH,UAAU,KACR,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;2BAIlB,UAAU;yDAKZ,UAAU,KACR,OAAO,CAAC,IAAI,CAAC;sBAUb,cAAc,YAAY,EAAE,OAAO;4BACnC,OAAO,CAAC,QAAQ,CAAC;+BACjB,MAAM,aAAa;kCACnB,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,+BAA+B,CAAC,CAAC;AAxH/E;;;;GAIG;AAEH;;;;;;;;;;;;GAYG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AAEH;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;GAEG;AAEH;;;;GAIG;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"}