@sava-info-systems/api-maker-with-extensions 1.9.0 → 1.11.0

package/src/assets/schema-types/types.ts

@@ -56,6 +56,7 @@ export enum EAPICategoryEnum {
     EVENTS = 'EVENTS',
     SCHEDULERS = 'SCHEDULERS',
     MIGRATION_SCRIPT = 'MIGRATION_SCRIPT',
+    WEB_SOCKET_EVENT_CAN_USER_CONNECT_CODE = 'WEB_SOCKET_EVENT_CAN_USER_CONNECT_CODE',
     PROCESS_INITIALIZER = 'PROCESS_INITIALIZER',
     UTILITY_CLASS = 'UTILITY_CLASS',
 }
@@ -201,6 +202,9 @@ export interface IBaseParams {
      */
     skipHookRunning?: boolean;
 
+    /** Default true, if true, it will allow update by id & replace by id & master save without version field and it will not throw error when version is different. */
+    skipConcurrencyControl?: boolean;
+
     /**
      * It is used in instance & database & collection hooks
      */
@@ -251,6 +255,7 @@ export enum EErrorType {
     schemaKeyNotFound = 'schemaKeyNotFound',
     schemaNotFound = 'schemaNotFound',
     emailNotValid = 'emailNotValid',
+    enumValidation = 'enumValidation',
 }
 
 // Main interfaces
@@ -279,7 +284,15 @@ export interface ISchemaProperty { // Add new schema property in ValidateDBSchem
 
     /** API Maker will take care of assigning incremental value for this field. */
     isAutoIncrementByAM?: boolean | IIsAutoIncrementByAM;
-    // defaultValue?: any; it can be very dynamic so skipping it right now.
+
+    /**
+     * if true, system will fail update/replace operation when value of this field in request payload, and value of database is not same.<br/>
+     * Sending this field in update request is mandatory.<br/>
+     * We can use conversions -> conversionFun to generate it's values.<br/>
+     * This will not work for SCHEMA_UPDATE_MANY API because it is direct query on database for updating multiple rows.<br/>
+     * By using optimistic concurrency control, you can ensure that updates are not overwritten by concurrent modifications, maintaining data integrity.<br/>
+     * */
+    isConcurrencyControlField?: boolean;
 }
 
 export interface IIsAutoIncrementByAM {
@@ -295,6 +308,13 @@ export interface IPropertyConversion {
     toUpperCase?: boolean;
     conversionFun?: Function;
 
+    /**
+     * When we are tying to save/replace and property is not present in payload, this default value will be applied to it.<br/>
+     * This default value will be converted to that type and applied.<br/>
+     * Empty string and null values will be treated based on configuration.
+     * */
+    defaults?: IPropertyConversionDefaults
+
     /** enable encryption for this property */
     encryption?: boolean | IEncryptionDescription;
 
@@ -305,6 +325,25 @@ export interface IPropertyConversion {
     hashing?: boolean | IPropertyHashing;
 }
 
+export interface IPropertyConversionDefaults {
+    /** This default value will converted to type and applied. */
+    defaultValue?: any;
+
+    /** defaultValue has higher priority. If defaultValue is not present, system will execution this function and returned value will be set. */
+    defaultFun?: Function;
+
+    /** If true, it will apply default value when value is also null. */
+    shouldReplaceNullWithDefault?: boolean;
+
+    /** If true, it will apply default value when value is also empty string. */
+    shouldReplaceEmptyStringWithDefault?: boolean;
+}
+
+export enum EIPropertyConversionDefaults {
+    defaultValue = 'defaultValue',
+    defaultFun = 'defaultFun',
+}
+
 export interface IEncryptionDescription {
     /** by default is DB for encryption and User for decryption. value will be encrypted while sending to DB | User */
     sendingTo?: ESendingToSchema;
@@ -400,6 +439,9 @@ export interface IAuthTokenAMDB extends Partial<IAuthTokenAM> {
     table?: string;
     usernameColumn?: string;
     passwordColumn?: string;
+    /** If you use this column, password field will not be present in JWT token and this value will be present, It is used to identify pass is changed or not. */
+    passwordChangedAtColumn?: string;
+
     /** column name which holds values of, comma separated groups assigned to this db user. * = means all groups of api user. DB user can hit API if he/she has access in any of these groups. */
     groupsColumn?: string;
     countOfUsersForTesting?: number; // load these much users in dropdown.
@@ -774,8 +816,8 @@ export interface ICommonApisSchema {
     /**
      * => Returns [a object] or [an array of objects].
      */
-    saveSingleOrMultiple<T>(query: IApiParamsSave): Promise<T | T[]>;
-    saveSingleOrMultiple<T>(query: IApiParamsSave, getFullResponse: boolean): Promise<IAPIResponse<T | T[]>>;
+    saveSingleOrMultiple<T>(query: Omit<IApiParamsSave, 'skipConcurrencyControl'>): Promise<T | T[]>;
+    saveSingleOrMultiple<T>(query: Omit<IApiParamsSave, 'skipConcurrencyControl'>, getFullResponse: boolean): Promise<IAPIResponse<T | T[]>>;
     /**
      * => Returns [a object] or [an array of objects].
      */
@@ -843,21 +885,21 @@ export interface ICommonApisGen {
     /**
      * => Returns [a object] or [an array of objects].
      */
-    saveSingleOrMultipleGen<T>(query: IApiParamsSave): Promise<T | T[]>;
-    saveSingleOrMultipleGen<T>(query: IApiParamsSave, getFullResponse: boolean): Promise<IAPIResponse<T | T[]>>;
+    saveSingleOrMultipleGen<T>(query: Omit<IApiParamsSave, 'skipConcurrencyControl'>): Promise<T | T[]>;
+    saveSingleOrMultipleGen<T>(query: Omit<IApiParamsSave, 'skipConcurrencyControl'>, getFullResponse: boolean): Promise<IAPIResponse<T | T[]>>;
     /**
      * => Returns [a object] or [an array of objects].
      */
-    masterSaveGen<T>(query: IApiParamsSave): Promise<T | T[]>;
-    masterSaveGen<T>(query: IApiParamsSave, getFullResponse: boolean): Promise<IAPIResponse<T | T[]>>;
+    masterSaveGen<T>(query: Omit<IApiParamsSave, 'skipConcurrencyControl'>): Promise<T | T[]>;
+    masterSaveGen<T>(query: Omit<IApiParamsSave, 'skipConcurrencyControl'>, getFullResponse: boolean): Promise<IAPIResponse<T | T[]>>;
 
     arrayOperationsGen<T>(query: IArrayOperationBody & IAMGlobalBaseParams): Promise<T>;
     arrayOperationsGen<T>(query: IArrayOperationBody & IAMGlobalBaseParams, getFullResponse: boolean): Promise<IAPIResponse<T>>;
     /**
      * => Returns [a single object].
      */
-    updateByIdGen<T>(query: IApiParamsUpdate): Promise<T>;
-    updateByIdGen<T>(query: IApiParamsUpdate, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    updateByIdGen<T>(query: Omit<IApiParamsUpdate, 'skipConcurrencyControl'>): Promise<T>;
+    updateByIdGen<T>(query: Omit<IApiParamsUpdate, 'skipConcurrencyControl'>, getFullResponse: boolean): Promise<IAPIResponse<T>>;
     /**
      * => Returns [updatedRowsCount].
      */
@@ -866,8 +908,8 @@ export interface ICommonApisGen {
     /**
      * => Returns [a single object].
      */
-    replaceByIdGen<T>(query: IApiParamsUpdate): Promise<T>;
-    replaceByIdGen<T>(query: IApiParamsUpdate, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    replaceByIdGen<T>(query: Omit<IApiParamsUpdate, 'skipConcurrencyControl'>): Promise<T>;
+    replaceByIdGen<T>(query: Omit<IApiParamsUpdate, 'skipConcurrencyControl'>, getFullResponse: boolean): Promise<IAPIResponse<T>>;
     /**
      * => Returns [a single object].
      */
@@ -1022,6 +1064,9 @@ export interface IApiParamsGetById extends IAMGlobalBaseParams {
 
 export interface IApiParamsSave extends IAMGlobalBaseParams {
     saveData?: any; // used to save data in db.
+
+    /** Default true, if true, it will allow update by id & replace by id & master save without version field and it will not throw error when version is different. */
+    skipConcurrencyControl?: boolean;
 }
 
 export interface IApiParamsQueryStream extends IAMGlobalBaseParams {
@@ -1050,6 +1095,9 @@ export interface IApiParamsUpdate extends IAMGlobalBaseParams {
     upsert?: boolean; // insert if item not available.
     returnDocument?: string; // return old doc if 'before', 'before' | 'after'
     select?: any; // to select which rows will return in response.
+
+    /** Default true, if true, it will allow update by id & replace by id & master save without version field and it will not throw error when version is different. */
+    skipConcurrencyControl?: boolean;
 }
 
 export interface IApiParamsUpdateMany extends IAMGlobalBaseParams {
@@ -1260,6 +1308,7 @@ export interface IWSObject {
         apiUser?: any; // IApiUser
         amUser?: any; // IUser
     };
+    auth: ISandboxReqAuthObj;
 }
 
 export type IWSObject_P = Partial<IWSObject>;
@@ -1835,7 +1884,7 @@ export interface IDBMasterCustomActionButton {
     actionName: string;
 
     /** ex : pi pi-check. https://primeng.org/icons */
-    cssClass: string,
+    cssClass?: string,
 
     /** Give style object in angular style. */
     style?: any;
@@ -1851,6 +1900,35 @@ export interface IDBMasterCustomActionButton {
      * ex: confirmationMessageScript: "`Do you want to approve ${selectedGridItems.length}?`",
      * */
     confirmationMessageScript?: string;
+
+    /** custom HTML code of button */
+    htmlCode?: string;
+
+    jsCode?: {
+        /**
+         * Available variables:<br/>
+         * globalData: any = User will send it using SET_GLOBAL_DATA_TO_USE_IN_ANY_SCRIPT event from parent. <br/>
+         * utils: any = Common utility functions for user to use. <br/>
+         * queryParams: any = Query params received from URL. <br/>
+         * config: IDBMasterConfigFormField <br/>
+         * gridData: Array of grid data. <br/>
+         * selectedGridItems: Selected grid items. <br/>
+         * event: any <br/>
+         */
+        appendTo: EDBMasterCustomActionButtonAppendTo,
+        /**
+         * // Return promise for long awaiting tasks.
+         * new Promise(async (resolve, reject) => {
+         *     await new Promise(r => setTimeout(r, 3000));
+         *     resolve();
+         * });
+         *
+         * // Return function
+         * (function setData() { dropdownData[0].name = 'Sample data'; } );
+         *
+         */
+        code: string,
+    }[],
 }
 
 type uiMakerComponentSeverity = 'contrast' | 'danger' | 'help' | 'info' | 'primary' | 'secondary' | 'success' | 'warning';
@@ -2673,10 +2751,202 @@ export interface IDBMasterConfigFormField {
 
     // autocompleteSettings : start
     autocompleteSettings?: {
+        /** Give style object in angular style. */
+        style?: any;
+
+        /** custom CSS class to assign to control */
+        cssClass?: string,
+
+        placeholder?: string;
+        showClear?: boolean;
+
+        /** Minimum number of characters to initiate a search. */
+        minLength?: number;
+
+        /** Delay between keystrokes to wait before sending a query. */
+        delay?: number;
+
+        /** When present, autocomplete clears the manual input if it does not match of the suggestions to force only accepting values from the suggestions. */
+        forceSelection?: number;
+
+        dataSource: 'static_data' | 'db_data' | 'api_call'; // custom_code = We can call any API in that.
+
+        /** it will use used when dataSource is 'static_data'. */
+        staticData?: any[]; // { label: string; value: any; }[] works default.
+
+        /**
+         * it can pickup IDB values from schema also.
+         */
+        dbData?: Partial<Pick<ICollectionIdentity, 'instance' | 'database' | 'collection' | 'table'>
+            & Pick<IQueryFormat, 'find' | 'select' | 'limit' | 'deep' | 'sort'>>;
+
+        /** Default : label */
+        optionLabel?: string;
+
+        /** Default : value */
+        optionValue?: string;
+
+        /** one field or multiple comma separated fields are supported without any space in between. */
+        filterBy?: string;
+        filterMatchMode?: 'contains' | 'startsWith' | 'endsWith';
+
+        /** Default : false, if true it will get latest data when form opens for add/edit operation. */
+        alwaysGetLatestDataOnFormOpen?: boolean;
+
+        /** Default : false, Make it true to handle huge amount of data. */
+        virtualScroll?: boolean;
+
+        /** on value change of current dropdown, it will change values of these dropdowns and reload them. */
+        reloadDropdownsOfPath?: string[];
+
+        /** API call will happen when these values of path are present in formData */
+        isDependentOnPath?: string[];
+
         dropdown?: boolean;
+
+        addNewFormConfig?: IDBMasterConfig;
+
+        apiCallOverrides?: IDBMasterAPICallOverrides;
+
+        jsCode?: {
+            /**
+             * modifyDropdownRequest = It will run before hitting API call. So we can do whatever we want.<br/>
+             * onceDropdownDataLoaded = Execute code when dropdown data is loaded.<br/>
+             *
+             * Available variables:<br/>
+             * reqBody: IQueryFormat | any. Useful to modify apiCallOverrides also,<br/>
+             * formData: any = Entire form object<br/>
+             * column: IDBMasterConfigFormField = Configuration of that form column. column.dropdownSettings?.dbData?.find will be query to get data. <br/>
+             * allDropdownDataMap: {[path: string]: any[]} = Map of all dropdown data<br/>
+             * dropdownData: any[] = Latest loaded dropdown data<br/>
+             * reloadDropdownsOfPath: string[] = Add path to this variable to reload its dropdown data.<br/>
+             * globalData: any = User will send it using SET_GLOBAL_DATA_TO_USE_IN_ANY_SCRIPT event from parent.<br/>
+             * utils: any = Common utility functions for user to use. <br/>
+             * queryParams: any = Query params received from URL. <br/>
+             */
+            appendTo: EDBMasterAutoCompleteAppendTo,
+            /**
+             * // dropdownData is available to use.
+             *
+             * // Return promise for long awaiting tasks.
+             * new Promise(async (resolve, reject) => {
+             *     await new Promise(r => setTimeout(r, 3000));
+             *     dropdownData[0].name = 'Sample data';
+             *     resolve();
+             * });
+             *
+             * // Directly modify data of grid
+             * dropdownData[0].name = 'Sample data';
+             *
+             * // Return function
+             * (function setData() { dropdownData[0].name = 'Sample data'; } );
+             *
+             */
+            code: string,
+
+        }[],
+
     };
     // autocompleteSettings : end
 
+    // multiselectSettings : start
+    multiselectSettings?: {
+        /** Give style object in angular style. */
+        style?: any;
+
+        /** custom CSS class to assign to control */
+        cssClass?: string,
+
+        placeholder?: string;
+        showClear?: boolean;
+
+        /** Minimum number of characters to initiate a search. */
+        minLength?: number;
+
+        /** Delay between keystrokes to wait before sending a query. */
+        delay?: number;
+
+        dataSource: 'static_data' | 'db_data' | 'api_call'; // custom_code = We can call any API in that.
+
+        /** it will use used when dataSource is 'static_data'. */
+        staticData?: any[]; // { label: string; value: any; }[] works default.
+
+        /**
+         * it can pickup IDB values from schema also.
+         */
+        dbData?: Partial<Pick<ICollectionIdentity, 'instance' | 'database' | 'collection' | 'table'>
+            & Pick<IQueryFormat, 'find' | 'select' | 'limit' | 'deep' | 'sort'>>;
+
+        /** Default : label */
+        optionLabel?: string;
+
+        /** Default : value */
+        optionValue?: string;
+
+        /** Enable filter */
+        filter?: boolean;
+
+        /** one field or multiple comma separated fields are supported without any space in between. */
+        filterBy?: string;
+        filterMatchMode?: 'contains' | 'startsWith' | 'endsWith';
+
+        /** Default : false, if true it will get latest data when form opens for add/edit operation. */
+        alwaysGetLatestDataOnFormOpen?: boolean;
+
+        /** Default : false, Make it true to handle huge amount of data. */
+        virtualScroll?: boolean;
+
+        /** on value change of current dropdown, it will change values of these dropdowns and reload them. */
+        reloadDropdownsOfPath?: string[];
+
+        /** API call will happen when these values of path are present in formData */
+        isDependentOnPath?: string[];
+
+        addNewFormConfig?: IDBMasterConfig;
+
+        apiCallOverrides?: IDBMasterAPICallOverrides;
+
+        jsCode?: {
+            /**
+             * modifyDropdownRequest = It will run before hitting API call. So we can do whatever we want.<br/>
+             * onceDropdownDataLoaded = Execute code when dropdown data is loaded.<br/>
+             *
+             * Available variables:<br/>
+             * reqBody: IQueryFormat | any. Useful to modify apiCallOverrides also,<br/>
+             * formData: any = Entire form object<br/>
+             * column: IDBMasterConfigFormField = Configuration of that form column. column.dropdownSettings?.dbData?.find will be query to get data. <br/>
+             * allDropdownDataMap: {[path: string]: any[]} = Map of all dropdown data<br/>
+             * dropdownData: any[] = Latest loaded dropdown data<br/>
+             * reloadDropdownsOfPath: string[] = Add path to this variable to reload its dropdown data.<br/>
+             * globalData: any = User will send it using SET_GLOBAL_DATA_TO_USE_IN_ANY_SCRIPT event from parent.<br/>
+             * utils: any = Common utility functions for user to use. <br/>
+             * queryParams: any = Query params received from URL. <br/>
+             */
+            appendTo: EDBMasterMultiSelectAppendTo,
+            /**
+             * // dropdownData is available to use.
+             *
+             * // Return promise for long awaiting tasks.
+             * new Promise(async (resolve, reject) => {
+             *     await new Promise(r => setTimeout(r, 3000));
+             *     dropdownData[0].name = 'Sample data';
+             *     resolve();
+             * });
+             *
+             * // Directly modify data of grid
+             * dropdownData[0].name = 'Sample data';
+             *
+             * // Return function
+             * (function setData() { dropdownData[0].name = 'Sample data'; } );
+             *
+             */
+            code: string,
+
+        }[],
+
+    };
+    // multiselectSettings : end
+
     // fileUploadSettings : start
     fileUploadSettings?: {
         /** Give style object in angular style. */
@@ -3040,6 +3310,9 @@ export interface IPropertyValidation {
     unique?: boolean;
     email?: boolean; // Allowed Types : string
     validatorFun?: Function;
+
+    /** If value is present it should be from this array. */
+    enum?: any[];
 }
 
 // genericConfig : end
@@ -3055,6 +3328,28 @@ export enum EDBMasterDropdownAppendTo {
 
 // dropdownSettings : end
 
+// autocompleteSettings : start
+export enum EDBMasterAutoCompleteAppendTo {
+    onSelect = 'onSelect',
+    visible = 'visible',
+    disabled = 'disabled',
+    modifyAutoCompleteRequest = 'modifyAutoCompleteRequest',
+    onceAutoCompleteDataLoaded = 'onceAutoCompleteDataLoaded',
+}
+
+// autocompleteSettings : end
+
+// multiselectSettings : start
+export enum EDBMasterMultiSelectAppendTo {
+    visible = 'visible',
+    disabled = 'disabled',
+    modifyMultiSelectRequest = 'modifyMultiSelectRequest',
+    onceMultiSelectDataLoaded = 'onceMultiSelectDataLoaded',
+    onChange = 'onChange',
+}
+
+// multiselectSettings : end
+
 // inputTextSettings : start
 export enum EDBMasterInputTextAppendTo {
     visible = 'visible',
@@ -3262,6 +3557,8 @@ export enum EDBMasterFormControl {
     radio = 'radio',
     color_picker = 'color_picker',
     dropdown = 'dropdown',
+    auto_complete = 'auto_complete',
+    multi_select = 'multi_select',
     file_upload = 'file_upload',
     grid = 'grid',
     divider = 'divider',
@@ -3276,6 +3573,10 @@ export enum EDBMasterFormControl {
     customHTML = 'customHTML',
 }
 
+export enum EDBMasterCustomActionButtonAppendTo {
+    click = 'click',
+}
+
 // genericConfig : end
 
 export interface IDBMasterMessageFromIframeToParent {