@techextensor/tab-sdk 0.0.50 → 0.0.52

package/fesm2022/techextensor-tab-sdk.mjs

@@ -446,6 +446,27 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.16", ngImpo
                 }]
         }] });
 
+/**
+ * CRUD operation types used internally by the SDK
+ * to determine default success messages and notification behavior.
+ */
+var CrudOperationType;
+(function (CrudOperationType) {
+    CrudOperationType["Insert"] = "insert";
+    CrudOperationType["Update"] = "update";
+    CrudOperationType["Delete"] = "delete";
+    CrudOperationType["ProcessRequest"] = "processRequest";
+})(CrudOperationType || (CrudOperationType = {}));
+/**
+ * Default success messages shown after each CRUD operation.
+ */
+const CRUD_DEFAULT_SUCCESS_MESSAGES = {
+    [CrudOperationType.Insert]: 'Record Created Successfully',
+    [CrudOperationType.Update]: 'Record Updated Successfully',
+    [CrudOperationType.Delete]: 'Record Deleted Successfully',
+    [CrudOperationType.ProcessRequest]: 'Record Submitted Successfully',
+};
+
 class FormService {
     _tabFormioService = inject(TabFormioService);
     _templateHelper = inject(TemplateHelper);
@@ -477,12 +498,12 @@ class FormService {
      * Processes a request using the provided request payload.
      *
      * @param requestPayload The payload to be processed.
+     * @param options - Optional CrudOptions object with headers and notify config.
      * @returns A promise of the response from the server.
      */
-    async processRequest(requestPayload) {
-        // Send the request payload to the server and await the response.
+    async processRequest(requestPayload, options) {
         const response = await firstValueFrom(this._tabFormioService.processRequest(requestPayload));
-        // Return the server's response.
+        this.handleNotification(response, options?.skipDefaultToast, CrudOperationType.ProcessRequest);
         return response;
     }
     /**
@@ -511,6 +532,20 @@ class FormService {
         // Return the response from the server.
         return response;
     }
+    /**
+     * Handles notification display after a process request operation.
+     * Default: auto-shows success toast. When skipDefaultToast is true, no toast is shown.
+     */
+    handleNotification(response, skipDefaultToast, operation) {
+        if (skipDefaultToast)
+            return;
+        const isSuccess = response?.IsSuccess === true;
+        if (isSuccess) {
+            TabSdk.ui.showSuccess({
+                message: CRUD_DEFAULT_SUCCESS_MESSAGES[operation] || 'Success',
+            });
+        }
+    }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.16", ngImport: i0, type: FormService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
     static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "19.2.16", ngImport: i0, type: FormService, providedIn: 'root' });
 }
@@ -529,9 +564,9 @@ class TransitionService {
      * @param payload - The payload containing information to determine the next status.
      * @returns A promise that resolves to the common API response.
      */
-    async getNextStatus(payload) {
+    async getNextStatus(payload, headers) {
         // Await the response from the getNextStatus method of the tabBlueprintService
-        const response = await firstValueFrom(this._tabBlueprintService.getNextStatus(payload));
+        const response = await firstValueFrom(this._tabBlueprintService.getNextStatus(payload, undefined, headers));
         // Return the obtained response
         return response;
     }
@@ -541,8 +576,8 @@ class TransitionService {
      * @param payload - The payload containing information to update the status.
      * @returns A promise that resolves to the common API response.
      */
-    async updateStatus(payload) {
-        const response = await firstValueFrom(TabSdk.util?.updateStatus(payload));
+    async updateStatus(payload, headers) {
+        const response = await firstValueFrom(TabSdk.util?.updateStatus(payload, undefined, headers));
         // Return the obtained response
         return response;
     }
@@ -749,9 +784,9 @@ class FileService {
      * @param mediaId The ID of the media file to remove.
      * @returns A promise that resolves to a common API response.
      */
-    async removeMediaFile(mediaId) {
+    async removeMediaFile(mediaId, headers) {
         // Use the firstValueFrom RxJs operator to wait for the observable to complete
-        const response = await firstValueFrom(this._mediaUploadHelper.removeMediaFile(mediaId));
+        const response = await firstValueFrom(this._mediaUploadHelper.removeMediaFile(mediaId, headers));
         // Return the response from the server
         return response;
     }
@@ -915,9 +950,9 @@ class AnalyticsService {
      * @param payload The screen performance payload containing the statistics to be inserted.
      * @returns A promise that resolves to a common API response containing the result of the insertion.
      */
-    async insertScreenPerformance(payload) {
+    async insertScreenPerformance(payload, headers) {
         // Use the firstValueFrom RxJs operator to wait for the observable to complete
-        const response = await firstValueFrom(this._appHelper.insertScreenPerformanceStatistics(payload));
+        const response = await firstValueFrom(this._appHelper.insertScreenPerformanceStatistics(payload, headers));
         // Return the response from the server
         return response;
     }
@@ -1015,83 +1050,57 @@ class CrudService {
      * @returns A promise that resolves to a common API response containing the retrieved record.
      */
     async executeDsq(payload, headers) {
-        // Use the firstValueFrom RxJs operator to wait for the observable to complete
         const response = await firstValueFrom(this._tabCrudService.get(payload, headers));
-        // Return the response from the server
         return response;
     }
     /**
      * Inserts a record into the database using the provided payload.
      *
      * @param payload - The payload containing information to insert the record.
-     * @param headers - Optional headers to pass to the server.
+     * @param optionsOrHeaders - Optional CrudOptions object with headers and notify config, or legacy headers object.
      * @returns A promise that resolves to a common API response containing the inserted record.
      */
-    async insert(payload, headers) {
-        const response = await firstValueFrom(
-        // Call the insert method of the TabCrudService and pass the payload and headers
-        this._tabCrudService.insert(payload, headers));
-        // Return the response from the server
+    async insert(payload, optionsOrHeaders) {
+        const response = await firstValueFrom(this._tabCrudService.insert(payload, optionsOrHeaders?.headers));
+        this.handleNotification(response, optionsOrHeaders?.skipDefaultToast, CrudOperationType.Insert);
         return response;
     }
     /**
-       * Inserts multiple records into the database using the provided payload.
-       *
-       * @param payload - The payload containing information to insert multiple records.
-       * @param headers - Optional headers to pass to the server.
-       * @returns A promise that resolves to a common API response containing the inserted records.
-       */
-    async bulkInsert(payload, headers) {
-        const response = await firstValueFrom(
-        // Call the bulkInsert method of the TabCrudService and pass the payload and headers
-        this._tabCrudService.bulkInsert(payload, headers));
-        // Return the response from the server
+     * Inserts multiple records into the database using the provided payload.
+     *
+     * @param payload - The payload containing information to insert multiple records.
+     * @param optionsOrHeaders - Optional CrudOptions object with headers and notify config, or legacy headers object.
+     * @returns A promise that resolves to a common API response containing the inserted records.
+     */
+    async bulkInsert(payload, optionsOrHeaders) {
+        const response = await firstValueFrom(this._tabCrudService.bulkInsert(payload, optionsOrHeaders?.headers));
+        this.handleNotification(response, optionsOrHeaders?.skipDefaultToast, CrudOperationType.Insert);
         return response;
     }
     /**
      * Updates a record in the database using the provided payload.
      *
      * @param payload - The payload containing information to update the record.
-     * @param headers - Optional headers to pass to the server.
+     * @param optionsOrHeaders - Optional CrudOptions object with headers and notify config, or legacy headers object.
      * @returns A promise that resolves to a common API response containing the updated record.
      */
-    async update(payload, headers) {
-        // Use the firstValueFrom RxJs operator to wait for the observable to complete
-        const response = await firstValueFrom(this._tabCrudService.update(payload, headers));
-        // Return the response from the server
+    async update(payload, optionsOrHeaders) {
+        const response = await firstValueFrom(this._tabCrudService.update(payload, optionsOrHeaders?.headers));
+        this.handleNotification(response, optionsOrHeaders?.skipDefaultToast, CrudOperationType.Update);
         return response;
     }
     /**
      * Deletes a record from the database using the provided payload.
      *
      * @param payload - The payload containing information to delete the record.
-     * @param headers - Optional headers to pass to the server.
+     * @param optionsOrHeaders - Optional CrudOptions object with headers and notify config, or legacy headers object.
      * @returns A promise that resolves to a common API response containing the deleted record.
      */
-    async delete(payload, headers) {
-        // Use the firstValueFrom RxJs operator to wait for the observable to complete
-        const response = await firstValueFrom(
-        // Call the delete method of the TabCrudService and pass the payload and headers
-        this._tabCrudService.delete(payload, headers));
-        // Return the response from the server
+    async delete(payload, optionsOrHeaders) {
+        const response = await firstValueFrom(this._tabCrudService.delete(payload, optionsOrHeaders?.headers));
+        this.handleNotification(response, optionsOrHeaders?.skipDefaultToast, CrudOperationType.Delete);
         return response;
     }
-    // /**
-    //  * Executes a stored procedure using the provided payload.
-    //  *
-    //  * @param sp - The name of the stored procedure to execute.
-    //  * @param headers - Optional headers to pass to the server.
-    //  * @returns A promise that resolves to a common API response containing the result of executing the stored procedure.
-    //  */
-    // async executeSp(sp: string, headers?: any): Promise<CommonApiResponse> {
-    //     // Use the firstValueFrom RxJs operator to wait for the observable to complete
-    //     const response = await firstValueFrom(
-    //         // Call the executeSp method of the TabCrudService and pass the name of the stored procedure and headers
-    //         this._tabCrudService.executeSp(sp, headers)
-    //     );
-    //     // Return the response from the server
-    //     return response;
-    // }
     /**
      * Executes a stored procedure using the provided payload.
      *
@@ -1100,11 +1109,7 @@ class CrudService {
      * @returns A promise that resolves to a common API response containing the result of executing the stored procedure.
      */
     async executeStoredProcedure(payload, headers) {
-        // Use the firstValueFrom RxJs operator to wait for the observable to complete
-        const response = await firstValueFrom(
-        // Call the executeStoredProcedure method of the TabCrudService and pass the payload and headers
-        this._tabCrudService.executeStoredProcedure(payload, headers));
-        // Return the response from the server
+        const response = await firstValueFrom(this._tabCrudService.executeStoredProcedure(payload, headers));
         return response;
     }
     /**
@@ -1114,12 +1119,8 @@ class CrudService {
      * @param parameters - Optional parameters to pass to the select query.
      * @returns A promise that resolves to a common API response containing the result of executing the select query.
      */
-    async executeSelectQuery(selectQueryId, parameters, additionalConfig) {
-        // Use the firstValueFrom RxJs operator to wait for the observable to complete
-        const response = await firstValueFrom(
-        // Call the executeSelectQueryById method of the TabGetService and pass the ID of the select query and parameters
-        this._tabGetService.executeSelectQueryById(selectQueryId, parameters, additionalConfig));
-        // Return the response from the server
+    async executeSelectQuery(selectQueryId, parameters, additionalConfig, headers) {
+        const response = await firstValueFrom(this._tabGetService.executeSelectQueryById(selectQueryId, parameters, additionalConfig, headers));
         return response;
     }
     /**
@@ -1129,49 +1130,35 @@ class CrudService {
      * @param parameters - Optional parameters to pass to the select query.
      * @returns A promise that resolves to a common API response containing the result of executing the select query.
      */
-    async executeSelectExecutor(data, parameters) {
-        // Use the firstValueFrom RxJs operator to wait for the observable to complete
-        const response = await firstValueFrom(
-        // Call the selectExecutor method of the TabGetService and pass the select query data and parameters
-        this._tabGetService.selectExecutor(data, parameters));
-        // Return the response from the server
+    async executeSelectExecutor(data, parameters, headers) {
+        const response = await firstValueFrom(this._tabGetService.selectExecutor(data, parameters, undefined, headers));
         return response;
     }
     /**
      * Gets the search data using the provided search query and limit.
      *
-     * @param searchQuery - The search query to search for.
-     * @param limit - The number of records to limit the results to.
+     * @param payload - The payload containing search query and limit.
      * @param parameters - Optional parameters to pass to the search query.
      * @returns A promise that resolves to a common API response containing the search data.
      */
     async getSearchData(payload, parameters) {
-        // Use the firstValueFrom RxJs operator to wait for the observable to complete
-        const response = await firstValueFrom(
-        // Call the getSearchData method of the TabGetService and pass the search query and limit
-        this._tabGetService.getSearchData(payload, parameters));
-        // Return the response from the server
+        const response = await firstValueFrom(this._tabGetService.getSearchData(payload, parameters));
         return response;
     }
     /**
      * Retrieves the history of records for a specified app object.
      *
-     * @param appObjectId - The ID of the app object to retrieve the record history for.
-     * @param recordIds - An array of record IDs to retrieve the history for.
+     * @param payload - The payload containing app object ID and record IDs.
      * @returns A promise that resolves to a common API response containing the record history.
      */
-    async getRecordHistory(payload) {
-        // Use the firstValueFrom RxJs operator to wait for the observable to complete
-        const response = await firstValueFrom(
-        // Call the getHistory method of the TabGetService and pass the app object ID and record IDs
-        this._tabGetService.getHistory(payload));
-        // Return the response from the server
+    async getRecordHistory(payload, headers) {
+        const response = await firstValueFrom(this._tabGetService.getHistory(payload, headers));
         return response;
     }
     /**
      * Imports data into the database.
      *
-     * @param data - The data to import.
+     * @param payload - The data to import.
      * @returns A promise that resolves to a common API response containing the result of importing the data.
      */
     async import(payload) {
@@ -1181,6 +1168,22 @@ class CrudService {
         // Return the response from the server
         return response;
     }
+    /**
+     * Handles notification display after a CRUD operation.
+     *
+     * Default behavior: auto-shows success toast with operation-specific message.
+     * When skipDefaultToast is true, no toast is shown — caller handles it via TabSdk.ui.showSuccess().
+     */
+    handleNotification(response, skipDefaultToast, operation) {
+        if (skipDefaultToast)
+            return;
+        const isSuccess = response?.IsSuccess === true;
+        if (isSuccess) {
+            TabSdk.ui.showSuccess({
+                message: CRUD_DEFAULT_SUCCESS_MESSAGES[operation],
+            });
+        }
+    }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.16", ngImport: i0, type: CrudService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
     static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "19.2.16", ngImport: i0, type: CrudService, providedIn: 'root' });
 }
@@ -2922,5 +2925,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.16", ngImpo
  * Generated bundle index. Do not edit.
  */
 
-export { NavigationType, ScreenDisplayMode, StorageType, TabSdk };
+export { CRUD_DEFAULT_SUCCESS_MESSAGES, CrudOperationType, NavigationType, ScreenDisplayMode, StorageType, TabSdk };
 //# sourceMappingURL=techextensor-tab-sdk.mjs.map