esi-cap 1.7.35 → 1.7.37

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

@@ -1,6 +1,46 @@
-export namespace impl {
-    function DBService(oService: any, oEvent: any): Promise<void>;
-    function LocalService(oService: any, sServiceName: any, oEvent?: {}, oLocalEntities?: string, oRemoteEvent?: {}, oRemoteEntities?: any, oRemoteHandlers?: any, bRefreshUserContext?: boolean): Promise<void>;
-    function RemoteService(oService: any, oEvent?: {}, oEntities?: string, oHandlers?: any, bRefreshUserContext?: boolean): Promise<void>;
+/**
+ * impl module
+ */
+export type ServiceEvents = import("../service").service.events;
+export type ServiceEventInterceptor = (oService: object) => Promise<void>;
+/**
+ * impl module
+ * @class
+ * @public
+ * @typedef {import('../service').service.events} ServiceEvents
+ */
+/**
+ * @callback ServiceEventInterceptor
+ * @param {object} oService - Service object for which request to be executed
+ * @returns {Promise<void>}
+ */
+export class impl {
+    /**
+     * @param {object} oService - Service object for which request to be executed
+     * @param {Partial<Record<keyof ServiceEvents, ServiceEventInterceptor>>} oEvent
+     * @returns {Promise<void>}
+     */
+    static DBService(oService: object, oEvent: Partial<Record<keyof ServiceEvents, ServiceEventInterceptor>>): Promise<void>;
+    /**
+     * @param {object} oService - Service object for which request to be executed
+     * @param {string} sServiceName - Service Name
+     * @param {Partial<Record<keyof ServiceEvents, ServiceEventInterceptor>>} oEvent
+     * @param {string|any[]} oLocalEntities
+     * @param {Partial<Record<keyof ServiceEvents, ServiceEventInterceptor>>} oRemoteEvent
+     * @param {string|any[]} [oRemoteEntities]
+     * @param {any[]} [oRemoteHandlers]
+     * @param {boolean} bRefreshUserContext
+     * @returns {Promise<void>}
+     */
+    static LocalService(oService: object, sServiceName: string, oEvent?: Partial<Record<keyof ServiceEvents, ServiceEventInterceptor>>, oLocalEntities?: string | any[], oRemoteEvent?: Partial<Record<keyof ServiceEvents, ServiceEventInterceptor>>, oRemoteEntities?: string | any[], oRemoteHandlers?: any[], bRefreshUserContext?: boolean): Promise<void>;
+    /**
+     * @param {object} oService - Service object for which request to be executed
+     * @param {Partial<Record<keyof ServiceEvents, ServiceEventInterceptor>>} oEvent
+     * @param {string|any[]} oEntities
+     * @param {any[]} [oHandlers]
+     * @param {boolean} bRefreshUserContext
+     * @returns {Promise<void>}
+     */
+    static RemoteService(oService: object, oEvent?: Partial<Record<keyof ServiceEvents, ServiceEventInterceptor>>, oEntities?: string | any[], oHandlers?: any[], bRefreshUserContext?: boolean): Promise<void>;
 }
 //# sourceMappingURL=index.d.ts.map

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":";IAkBmB,8DAIV;IACa,6MAwBb;IACc,sIA4Ed"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../.types/lib/impl/index.js"],"names":[],"mappings":";;;4BAmBa,OAAO,YAAY,EAAE,OAAO,CAAC,MAAM;iDAKrC,MAAM,KACJ,OAAO,CAAC,IAAI,CAAC;AAV1B;;;;;GAKG;AAEH;;;;GAIG;AACH;IACI;;;;OAIG;IACH,2BAJW,MAAM,UACN,OAAO,CAAC,MAAM,CAAC,MAAM,aAAa,EAAE,uBAAuB,CAAC,CAAC,GAC3D,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;;;;;;;;OAUG;IACH,8BAVW,MAAM,gBACN,MAAM,WACN,OAAO,CAAC,MAAM,CAAC,MAAM,aAAa,EAAE,uBAAuB,CAAC,CAAC,mBAC7D,MAAM,GAAC,GAAG,EAAE,iBACZ,OAAO,CAAC,MAAM,CAAC,MAAM,aAAa,EAAE,uBAAuB,CAAC,CAAC,oBAC7D,MAAM,GAAC,GAAG,EAAE,oBACZ,GAAG,EAAE,wBACL,OAAO,GACL,OAAO,CAAC,IAAI,CAAC,CA0BzB;IAED;;;;;;;OAOG;IACH,+BAPW,MAAM,WACN,OAAO,CAAC,MAAM,CAAC,MAAM,aAAa,EAAE,uBAAuB,CAAC,CAAC,cAC7D,MAAM,GAAC,GAAG,EAAE,cACZ,GAAG,EAAE,wBACL,OAAO,GACL,OAAO,CAAC,IAAI,CAAC,CA8EzB;CACJ"}

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

@@ -1,33 +1,110 @@
-export namespace service {
-    namespace events {
-        let PreBefore: string;
-        let PostBefore: string;
-        let PreOn: string;
-        let PreMeshUp: string;
-        let PostOn: string;
-        let PreAfter: string;
-        let PostAfter: string;
-        let None: string;
-    }
-    function enrichUserContext(oRequest: object): Promise<void>;
-    function sanitizeData(oData: any, oFieldsArray: any, includeID?: boolean): any;
-    function get(oRequest: any): any;
-    function getEntityColumns(oService: object, oRequest: object): string[];
-    function sendQuery(oService: object, oRequest: object, oQuery?: object): Promise<any>;
-    function sendRequest(oService: object, oRequest: object): Promise<any>;
-    function executeRequest(oService: object, oRequest: object): Promise<any>;
-    namespace iflow {
-        function call(oRequest: object, oJsonData: object, onError?: () => Promise<void>): Promise<void>;
-    }
-    function handleReadByID(oService: any, oRequest: any, oID: any): Promise<any>;
-    function handleDeleteByID(oService: any, oRequest: any, oID: any): Promise<any>;
-    function handleEvent(oService: object, oRequest: object, fEventHandler?: Function): Promise<any>;
-    function handleCreate(oService: object, oRequest: object, fPreInsert?: Function): Promise<any>;
-    function handleInsert(oService: object, oRequest: object, fPreInsert?: Function): Promise<any>;
-    function handleUpdate(oService: object, oRequest: object, fPreUpdate: Function, oWhere: any, isOldDataRequired?: boolean): Promise<any>;
-    function handleCount(oData: object, oRequest: object): Promise<void>;
-    function handlePostOn(oService: object, oRequest: object): Promise<any[]>;
-    function handleHandler(oService: any, oRequest: any): Promise<any>;
-    function handleRead(oService: object, oRequest: object, fNextHandler: Function): Promise<any>;
+/**
+ * service module
+ * @class
+ * @public
+ */
+export class service {
+    /** All Service Events
+     * @public
+     * @static
+     * @enum {string} */
+    public static events: Readonly<{
+        PreBefore: "PreBefore";
+        PostBefore: "PostBefore";
+        PreOn: "PreOn";
+        PreMeshUp: "PreMeshUp";
+        PostOn: "PostOn";
+        PreAfter: "PreAfter";
+        PostAfter: "PostAfter";
+        None: "";
+    }>;
+    /** This function enriches the user context with configured user function
+     * @param {object} oRequest - Request Object
+     */
+    static enrichUserContext(oRequest: object): Promise<void>;
+    static sanitizeData(oData: any, oFieldsArray: any, includeID?: boolean): any;
+    static get(oRequest: any): any;
+    /**
+     * @param {object} oService - Service object for which request to be executed
+     * @param {object} oRequest - Request Object
+     * @returns {string[]}
+     */
+    static getEntityColumns(oService: object, oRequest: object): string[];
+    /**
+     * @param {object} oService - Service object for which request to be executed
+     * @param {object} oRequest - Request Object
+     * @param {object} oQuery - Query to be send
+     */
+    static sendQuery(oService: object, oRequest: object, oQuery?: object): Promise<any>;
+    /**
+     * @param {object} oService - Service object for which request to be executed
+     * @param {object} oRequest - Request Object
+     */
+    static sendRequest(oService: object, oRequest: object): Promise<any>;
+    /**
+     * @param {object} oService - Service object for which request to be executed
+     * @param {object} oRequest - Request Object
+     */
+    static executeRequest(oService: object, oRequest: object): Promise<any>;
+    /**
+     * @param {object} oRequest - Request Object
+     * @param {object} oJsonData - JSON Data
+     */
+    static executeIflow(oRequest: object, oJsonData: object, onError?: () => Promise<void>): Promise<void>;
+    /**
+     * @param {object} oService - Service Object
+     * @param {object} oRequest - Request Object
+     */
+    static handleReadByID(oService: object, oRequest: object, oID: any): Promise<any>;
+    /**
+     * @param {object} oService - Service Object
+     * @param {object} oRequest - Request Object
+     */
+    static handleDeleteByID(oService: object, oRequest: object, oID: any): Promise<any>;
+    /**
+     * @param {object} oService - Service Object
+     * @param {object} oRequest - Request Object
+     * @param {function} fEventHandler - function to be called before Event for data handling
+     */
+    static handleEvent(oService: object, oRequest: object, fEventHandler?: Function): Promise<any>;
+    /**
+     * @param {object} oService - Service Object
+     * @param {object} oRequest - Request Object
+     * @param {function} fPreInsert - function to be called before insert
+     */
+    static handleCreate(oService: object, oRequest: object, fPreInsert?: Function): Promise<any>;
+    /**
+     * @param {object} oService - Service Object
+     * @param {object} oRequest - Request Object
+     * @param {function} fPreInsert - function to be called before insert
+     */
+    static handleInsert(oService: object, oRequest: object, fPreInsert?: Function): Promise<any>;
+    /**
+     * @param {object} oService - Service Object
+     * @param {object} oRequest - Request Object
+     * @param {function} fPreUpdate - function to be called before Update
+     */
+    static handleUpdate(oService: object, oRequest: object, fPreUpdate: Function, oWhere: any, isOldDataRequired?: boolean): Promise<any>;
+    /**
+     * @param {object} oData - Data Result
+     * @param {object} oRequest - Request Object
+     */
+    static handleCount(oData: object, oRequest: object): Promise<void>;
+    /**
+     * @param {object} oService - Service Object
+     * @param {object} oRequest - Request Object
+     */
+    static handlePostOn(oService: object, oRequest: object): Promise<any[]>;
+    /**
+     * @param {object} oService - Service Object
+     * @param {object} oRequest - Request Object
+     */
+    static handleHandler(oService: object, oRequest: object): Promise<any>;
+    /**
+     * @param {object} oService - Service Object
+     * @param {object} oRequest - Request Object
+     * @param {function} fNextHandler - Alternate handler method
+     */
+    static handleRead(oService: object, oRequest: object, fNextHandler: Function): Promise<any>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../.types/lib/service/index.js"],"names":[],"mappings":";;;;;;;;;;;IA6CuB,qCAFR,MAAM,iBAsBhB;IACa,+EAab;IACI,iCAEJ;IAMiB,oCAJP,MAAM,YACN,MAAM,GACJ,MAAM,EAAE,CAWpB;IAMU,6BAJA,MAAM,YACN,MAAM,WACN,MAAM,gBAgBhB;IAKY,+BAHF,MAAM,YACN,MAAM,gBAYhB;IAKe,kCAHL,MAAM,YACN,MAAM,gBAchB;;QAMS,wBAHK,MAAM,aACN,MAAM,gDAqDhB;;IAEW,8EAKf;IACiB,gFAKjB;IAMY,+BAJF,MAAM,YACN,MAAM,0CAiBhB;IAMa,gCAJH,MAAM,YACN,MAAM,uCAQhB;IAMa,gCAJH,MAAM,YACN,MAAM,uCAQhB;IAMa,gCAJH,MAAM,YACN,MAAM,gFAgBhB;IAKY,4BAHF,MAAM,YACN,MAAM,iBAQhB;IAKa,gCAHH,MAAM,YACN,MAAM,kBAiChB;IACc,mEAiCd;IAMW,8BAJD,MAAM,YACN,MAAM,wCAQhB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../.types/lib/service/index.js"],"names":[],"mappings":"AAsxBA;;;;GAIG;AACH;IAEI;;;wBAGoB;IACpB;;;;;;;;;OASG;IAEH;;OAEG;IACH,mCAFW,MAAM,iBAsBhB;IAED,6EAaC;IAED,+BAEC;IAED;;;;OAIG;IACH,kCAJW,MAAM,YACN,MAAM,GACJ,MAAM,EAAE,CAWpB;IAED;;;;OAIG;IACH,2BAJW,MAAM,YACN,MAAM,WACN,MAAM,gBAgBhB;IAED;;;OAGG;IACH,6BAHW,MAAM,YACN,MAAM,gBAYhB;IAED;;;OAGG;IACH,gCAHW,MAAM,YACN,MAAM,gBAchB;IAED;;;OAGG;IACH,8BAHW,MAAM,aACN,MAAM,gDAqDhB;IAED;;;OAGG;IACH,gCAHW,MAAM,YACN,MAAM,0BAOhB;IAED;;;OAGG;IACH,kCAHW,MAAM,YACN,MAAM,0BAOhB;IAED;;;;OAIG;IACH,6BAJW,MAAM,YACN,MAAM,0CAiBhB;IAED;;;;OAIG;IACH,8BAJW,MAAM,YACN,MAAM,uCAQhB;IAED;;;;OAIG;IACH,8BAJW,MAAM,YACN,MAAM,uCAQhB;IAED;;;;OAIG;IACH,8BAJW,MAAM,YACN,MAAM,gFAgBhB;IAED;;;OAGG;IACH,0BAHW,MAAM,YACN,MAAM,iBAQhB;IAED;;;OAGG;IACH,8BAHW,MAAM,YACN,MAAM,kBAiChB;IAED;;;OAGG;IACH,+BAHW,MAAM,YACN,MAAM,gBAmChB;IAED;;;;OAIG;IACH,4BAJW,MAAM,YACN,MAAM,wCAQhB;CACJ"}