@techextensor/tab-sdk 0.0.49 → 0.0.51

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?.notify, CrudOperationType.ProcessRequest);
         return response;
     }
     /**
@@ -511,6 +532,40 @@ class FormService {
         // Return the response from the server.
         return response;
     }
+    /**
+     * Handles notification display after a process request operation.
+     * Same behavior as CrudService notifications:
+     * - Success: auto-shown by default
+     * - Error: NOT shown by default (interceptor handles)
+     */
+    handleNotification(response, notify, operation) {
+        if (notify?.silent)
+            return;
+        const isSuccess = response?.StatusCode === '200' || response?.IsSuccess === true;
+        const hasErrors = response?.Errors?.length > 0;
+        if (isSuccess) {
+            const successOpt = notify?.success;
+            if (successOpt === false)
+                return;
+            const successConfig = typeof successOpt === 'object' ? successOpt : undefined;
+            TabSdk.ui.showSuccess({
+                message: successConfig?.message || CRUD_DEFAULT_SUCCESS_MESSAGES[operation] || 'Success',
+                ...(successConfig?.title ? { title: successConfig.title } : {}),
+                ...(successConfig?.configuration ? { configuration: successConfig.configuration } : {})
+            });
+        }
+        else if (hasErrors) {
+            const errorOpt = notify?.error;
+            if (!errorOpt)
+                return;
+            const errorConfig = errorOpt;
+            TabSdk.ui.showError({
+                message: errorConfig.message || response.Errors[0],
+                ...(errorConfig.title ? { title: errorConfig.title } : {}),
+                ...(errorConfig.configuration ? { configuration: errorConfig.configuration } : {})
+            });
+        }
+    }
     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' });
 }
@@ -1015,83 +1070,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?.notify, 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?.notify, 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?.notify, 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?.notify, 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 +1129,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;
     }
     /**
@@ -1115,11 +1140,7 @@ class CrudService {
      * @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
+        const response = await firstValueFrom(this._tabGetService.executeSelectQueryById(selectQueryId, parameters, additionalConfig));
         return response;
     }
     /**
@@ -1130,48 +1151,34 @@ class CrudService {
      * @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
+        const response = await firstValueFrom(this._tabGetService.selectExecutor(data, parameters));
         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
+        const response = await firstValueFrom(this._tabGetService.getHistory(payload));
         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 +1188,51 @@ class CrudService {
         // Return the response from the server
         return response;
     }
+    /**
+     * Handles notification display after a CRUD operation.
+     *
+     * Default behavior:
+     * - Success: auto-shown with operation-specific message (e.g., "Record Created Successfully")
+     * - Error: NOT shown (interceptor handles errors globally)
+     *
+     * Can be customized via CrudNotificationOptions:
+     * - `silent: true` - suppresses all notifications
+     * - `success: false` - suppresses success only
+     * - `success: { message, title, configuration }` - custom success notification
+     * - `error: { message, title, configuration }` - custom error notification (overrides interceptor)
+     */
+    handleNotification(response, notify, operation) {
+        // If silent, skip all notifications
+        if (notify?.silent)
+            return;
+        const isSuccess = response?.StatusCode === '200' || response?.IsSuccess === true;
+        const hasErrors = response?.Errors?.length > 0;
+        if (isSuccess) {
+            // Success notification: shown by default, unless explicitly suppressed
+            const successOpt = notify?.success;
+            if (successOpt === false)
+                return;
+            const successConfig = typeof successOpt === 'object' ? successOpt : undefined;
+            TabSdk.ui.showSuccess({
+                message: successConfig?.message || CRUD_DEFAULT_SUCCESS_MESSAGES[operation],
+                ...(successConfig?.title ? { title: successConfig.title } : {}),
+                ...(successConfig?.configuration ? { configuration: successConfig.configuration } : {})
+            });
+        }
+        else if (hasErrors) {
+            // Error notification: NOT shown by default (interceptor handles it)
+            // Only shown if user explicitly provides error config
+            const errorOpt = notify?.error;
+            if (!errorOpt)
+                return;
+            const errorConfig = errorOpt;
+            TabSdk.ui.showError({
+                message: errorConfig.message || response.Errors[0],
+                ...(errorConfig.title ? { title: errorConfig.title } : {}),
+                ...(errorConfig.configuration ? { configuration: errorConfig.configuration } : {})
+            });
+        }
+    }
     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 +2974,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