esi-cap 1.7.34 → 1.7.36

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

@@ -1,4 +1,23 @@
-export namespace connect {
-    function to(oService: any): any;
+/**
+ * connect module for establishing connections to various services, including SOAP, ODATA v2/v4, Integration Flow and RESTful services.
+ * @class
+ * @public
+ */
+export class connect {
+    /**
+     * Establishes a connection to the specified service based on its configuration in `cds.requires`.
+     * It supports connecting to local services defined in the application as well as remote services,
+     * including SOAP, ODATA v2/v4, Integration Flow and RESTful services. The method determines the type of
+     * service based on the configuration and uses the appropriate connection method to establish the connection.
+     *
+     * @public
+     * @static
+     * @param {string} sServiceName - The name of the service to connect to (e.g., "LocalService.MyService", "RemoteService.MyService").
+     * @returns {Promise<any>} Resolves to the service connection object.
+     * @example
+     * await connect.to("LocalService.MyService"); // returns the service connection object
+     * await connect.to("RemoteService.MyService"); // returns the service connection object
+     */
+    public static to(sServiceName: string): Promise<any>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../.types/lib/connect/index.js"],"names":[],"mappings":";IAoDQ,gCAiCH"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../.types/lib/connect/index.js"],"names":[],"mappings":"AAmDA;;;;GAIG;AACH;IACI;;;;;;;;;;;;;OAaG;IACH,+BAA2B,MAAM,GALpB,OAAO,CAAC,GAAG,CAAC,CAsCxB;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"}