@techextensor/tab-sdk 0.0.50 → 0.0.51

package/lib/crud/crud.service.d.ts

@@ -1,4 +1,5 @@
 import { APISelectQuery, CommonApiResponse, DeletePayload, GetPayload, InsertPayload, UpdatePayload, ImprotDataPayload, RcordHistoryPayload, SearchDataPayload, executeStoredProcedurePayload } from '@techextensor/tab-core-utility';
+import { CrudOptions } from '../interface/crud.interface';
 import * as i0 from "@angular/core";
 export declare class CrudService {
     private readonly _tabCrudService;
@@ -15,34 +16,34 @@ export declare class CrudService {
      * 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.
      */
-    insert(payload: InsertPayload, headers?: any): Promise<CommonApiResponse>;
+    insert(payload: InsertPayload, optionsOrHeaders?: CrudOptions): Promise<CommonApiResponse>;
     /**
-       * 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.
-       */
-    bulkInsert(payload: InsertPayload, headers?: any): Promise<CommonApiResponse>;
+     * 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.
+     */
+    bulkInsert(payload: InsertPayload, optionsOrHeaders?: CrudOptions): Promise<CommonApiResponse>;
     /**
      * 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.
      */
-    update(payload: UpdatePayload, headers?: any): Promise<CommonApiResponse>;
+    update(payload: UpdatePayload, optionsOrHeaders?: CrudOptions): Promise<CommonApiResponse>;
     /**
      * 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.
      */
-    delete(payload: DeletePayload, headers?: any): Promise<CommonApiResponse>;
+    delete(payload: DeletePayload, optionsOrHeaders?: CrudOptions): Promise<CommonApiResponse>;
     /**
      * Executes a stored procedure using the provided payload.
      *
@@ -70,8 +71,7 @@ export declare class CrudService {
     /**
      * 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.
      */
@@ -79,18 +79,31 @@ export declare class CrudService {
     /**
      * 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.
      */
     getRecordHistory(payload: RcordHistoryPayload): Promise<CommonApiResponse>;
     /**
      * 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.
      */
     import(payload: ImprotDataPayload): Promise<any>;
+    /**
+     * 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)
+     */
+    private handleNotification;
     static ɵfac: i0.ɵɵFactoryDeclaration<CrudService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<CrudService>;
 }

package/lib/enum/crud.enum.d.ts

@@ -0,0 +1,14 @@
+/**
+ * CRUD operation types used internally by the SDK
+ * to determine default success messages and notification behavior.
+ */
+export declare enum CrudOperationType {
+    Insert = "insert",
+    Update = "update",
+    Delete = "delete",
+    ProcessRequest = "processRequest"
+}
+/**
+ * Default success messages shown after each CRUD operation.
+ */
+export declare const CRUD_DEFAULT_SUCCESS_MESSAGES: Record<CrudOperationType, string>;

package/lib/interface/crud.interface.d.ts

@@ -0,0 +1,85 @@
+import { IndividualConfig } from 'ngx-toastr';
+/**
+ * Notification configuration for a single notification type (success or error).
+ *
+ * Supports full ngx-toastr IndividualConfig for toast customization
+ * (timeOut, positionClass, progressBar, closeButton, etc.)
+ */
+export interface CrudNotificationConfig {
+    /** Override the default notification message */
+    message?: string;
+    /** Override the default notification title */
+    title?: string;
+    /** Full ngx-toastr configuration for toast customization */
+    configuration?: Partial<IndividualConfig<any>>;
+}
+/**
+ * Options to control automatic notifications after CRUD operations.
+ *
+ * By default:
+ * - Success notifications are ENABLED (auto-shown on StatusCode 200)
+ * - Error notifications are DISABLED (already handled by the API interceptor)
+ *
+ * @example
+ * ```typescript
+ * // Default behavior — auto success, no error (interceptor handles it)
+ * await TabSdk.crud.insert({ ... });
+ *
+ * // Custom success message
+ * await TabSdk.crud.insert(payload, {
+ *   notify: { success: { message: 'User registered!', title: 'Welcome' } }
+ * });
+ *
+ * // Silent — no success notification
+ * await TabSdk.crud.insert(payload, { notify: { silent: true } });
+ *
+ * // Suppress only success, keep default error handling
+ * await TabSdk.crud.delete(payload, { notify: { success: false } });
+ *
+ * // Custom error notification (overrides interceptor for this call)
+ * await TabSdk.crud.update(payload, {
+ *   notify: { error: { message: 'Could not save changes' } }
+ * });
+ *
+ * // Full toast customization
+ * await TabSdk.crud.update(payload, {
+ *   notify: {
+ *     success: {
+ *       message: 'Saved!',
+ *       configuration: { timeOut: 2000, positionClass: 'toast-top-center' }
+ *     }
+ *   }
+ * });
+ * ```
+ */
+export interface CrudNotificationOptions {
+    /**
+     * When true, suppresses both success and error notifications.
+     * Useful for background/silent operations (e.g., toggling favorites).
+     */
+    silent?: boolean;
+    /**
+     * Success notification configuration.
+     * - `undefined` (default): auto-shows default success message (e.g., "Record Created Successfully")
+     * - `false`: suppresses success notification
+     * - `CrudNotificationConfig`: shows custom success notification
+     */
+    success?: CrudNotificationConfig | false;
+    /**
+     * Error notification configuration.
+     * - `undefined` (default): no error notification (interceptor handles it globally)
+     * - `false`: explicitly suppresses error notification
+     * - `CrudNotificationConfig`: shows custom error notification (overrides interceptor for this call)
+     */
+    error?: CrudNotificationConfig | false;
+}
+/**
+ * Extended options for CRUD operations.
+ * Pass as the second argument to TabSdk.crud.insert/update/delete.
+ */
+export interface CrudOptions {
+    /** Optional HTTP headers to pass to the server */
+    headers?: any;
+    /** Notification options to control automatic success/error popups */
+    notify?: CrudNotificationOptions;
+}

package/lib/ui/form.service.d.ts

@@ -1,4 +1,5 @@
 import { BuildFormComponentType, CommonApiResponse, GetScreenConfig, ProcessRequestPayload, TemplateParsePayload } from '@techextensor/tab-core-utility';
+import { CrudOptions } from '../interface/crud.interface';
 import * as i0 from "@angular/core";
 export declare class FormService {
     private readonly _tabFormioService;
@@ -23,9 +24,10 @@ export declare 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.
      */
-    processRequest(requestPayload: ProcessRequestPayload): Promise<CommonApiResponse>;
+    processRequest(requestPayload: ProcessRequestPayload, options?: CrudOptions): Promise<CommonApiResponse>;
     /**
      * Builds Form.io components for the specified app object ID and type.
      *
@@ -42,6 +44,13 @@ export declare class FormService {
      * @returns A promise of the response from the server.
      */
     parseTemplate(requestPayload: TemplateParsePayload, onFailedParseOnServer?: boolean): Promise<CommonApiResponse>;
+    /**
+     * 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)
+     */
+    private handleNotification;
     static ɵfac: i0.ɵɵFactoryDeclaration<FormService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<FormService>;
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@techextensor/tab-sdk",
-  "version": "0.0.50",
+  "version": "0.0.51",
   "peerDependencies": {
     "@angular/common": "^19.2.15",
     "@angular/core": "^19.2.15",
-    "@techextensor/tab-core-utility": "2.2.181"
+    "@techextensor/tab-core-utility": "2.2.191"
   },
   "dependencies": {
     "tslib": "^2.8.1"

package/public-api.d.ts

@@ -1,6 +1,8 @@
 export * from './lib/tab-sdk.service';
 export * from './lib/enum/ui.enum';
 export * from './lib/enum/store.enum';
+export * from './lib/enum/crud.enum';
 export * from './lib/interface/ui.interface';
 export * from './lib/interface/http.interface';
 export * from './lib/interface/state.interface';
+export * from './lib/interface/crud.interface';