@sava-info-systems/api-maker-with-extensions 1.5.3 → 1.6.0

package/README.md

@@ -10,13 +10,13 @@
 <hr/>
 
 👉 This version is API Maker comes with additional extensions which makes software development process even more faster.<br/>
-👉 You will need --extensionsLicenseKey=YOUR_KEY for installation.<br/>
+👉 You will need --extLicenseKey=YOUR_KEY for installation.<br/>
 👉 Contact us to buy license of extensions : https://apimaker.dev <br/>
 👉 Email address : contact@apimaker.dev <br/>
 
 ```shell
 # Add your key in below command
-curl -fsSL https://apimaker.dev/install.sh > install.sh && bash install.sh --default --version=latest --extensionsLicenseKey=YOUR_KEY
+curl -fsSL https://apimaker.dev/v1/install.sh > install.sh && bash install.sh --default --version=latest --extLicenseKey=YOUR_KEY
 
 ```
 

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

@@ -904,13 +904,14 @@ export interface IExecuteQuery {
     instance: string;
     database?: string; // required for postgresql, mongodb only
     collection?: string; // required for mongodb only
-    query: string | {
-        find: any;
-        sort?: any;
-        skip?: number;
-        limit?: number;
-        select?: any;
-    };
+
+    /**
+     * You can give SQL query for SQL based databases.<br/>
+     * MongoDB = You can give object which will be passed in "command" function.
+     * ex: https://www.mongodb.com/docs/drivers/node/current/usage-examples/command/
+     * Supported commands : https://www.mongodb.com/docs/v6.0/reference/command/
+     */
+    query: string | any;
     headers?: any;
 }
 
@@ -1215,6 +1216,10 @@ export enum EDBMasterGridExport {
     // PDF = 'PDF',
 }
 
+export enum EDBMasterDataImport {
+    CSV = 'CSV',
+}
+
 export interface IDBMasterConfig {
     theme?: EDBMasterTheme;
 
@@ -1248,7 +1253,16 @@ export interface IDBMasterConfig {
     operations?: {
         add?: IDBMasterConfigOperation;
         hideAddConfirmation?: boolean;
+        /** Default : false. If true, it will not show delete all button. */
+        hideDeleteAllButton?: boolean;
         hideDeleteAllConfirmation?: boolean;
+
+        showRefreshButton?: boolean;
+        showExportButton?: boolean;
+
+        customActionButtons?: IDBMasterTopLevelCustomActionButton[];
+
+        importData?: IDBMasterImportData;
     };
     externalLibs?: {
         css?: string[],
@@ -1261,13 +1275,15 @@ export interface IDBMasterConfig {
     jsCode?: {
 
         /**
-         * oncePageLoad = Code will be run only once on page load. (config) <br/>
-         * gridRender = Gets executed everytime grid gets data. (gridEvent, gridData) <br/>
-         * modifyGridRequest = You can modify api call request. (gridEvent, reqBody: IQueryFormat) <br/>
-         * preSave = Change data before saving them in data. (reqBody: any) <br/>
+         * oncePageLoad = Code will be run only once on page load. (config, globalData: any) <br/>
+         * gridRender = Gets executed everytime grid gets data. (gridEvent, gridData, globalData: any) <br/>
+         * modifyGridRequest = You can modify api call request. (gridEvent, reqBody: IQueryFormat, globalData: any) <br/>
+         * preSaveAndEdit = Change data before saving/update/import. (reqBody: any | any[], globalData: any) <br/>
+         * beforeSaveModalOpen = Change data before save modal open. (formData: any , globalData: any) <br/>
+         * beforeEditModalOpen = Change data before edit modal open. (formData: any , globalData: any) <br/>
          *
          */
-        appendTo: 'oncePageLoad' | 'gridRender' | 'modifyGridRequest' | 'preSaveAndEdit',
+        appendTo: EDBMasterConfigAppendTo,
         /**
          * // gridEvent, gridData are available to use.
          *
@@ -1296,19 +1312,31 @@ export interface IDBMasterConfig {
         /** Default : 50rem */
         minWidth?: string;
 
+        /** Default : 40rem */
+        breakpoint?: string;
+
         /** Used for nested grid only. From this field it will pickup data array and show grid based on that */
         dataFieldPath?: string;
 
         operations?: {
-            delete?: Omit<IDBMasterConfigOperation, 'label'>;
-            edit?: Omit<IDBMasterConfigOperation, 'label'>;
+            delete?: Omit<IDBMasterConfigOperation, 'label'> & { apiCallOverridesDeleteMany?: IDBMasterAPICallOverrides; };
+            edit?: Omit<IDBMasterConfigOperation, 'label'> & { apiCallOverridesGetById?: IDBMasterAPICallOverrides; };
 
             hideDeleteConfirmation?: boolean;
             hideEditConfirmation?: boolean;
 
+            disableDoubleClickForEdit?: boolean;
+            disableDeleteButtonClickForDelete?: boolean;
+
+            /** Only 3 & do not give duplicates */
             gridOperationsOrder?: ('delete' | 'edit' | 'custom')[];
 
+            /** Only 3 & do not give duplicates */
+            gridColumnsOrder?: ('checkbox' | 'actions' | 'dbFields')[];
+
             actionColumnWidth?: string;
+
+            customActionButtons?: IDBMasterCustomActionButton[];
         };
 
         /**
@@ -1355,7 +1383,30 @@ export interface IDBMasterConfig {
             rowsPerPageOptions?: number[];
         }
 
+        grouping?: {
+            // rowGroupMode: 'subheader'; // default : subheader. rowspan = is not supported.
+
+            /** group by column name */
+            groupRowsBy: string;
+
+            /** Give style object in angular style. */
+            headerStyle?: any;
+
+            /** You can provide single or multiple classes. */
+            headerCssClass?: string,
+
+            /** Give style object in angular style. */
+            footerStyle?: any;
+
+            /** You can provide single or multiple classes. */
+            footerCssClass?: string,
+
+            /** Group footer will be generated from this property of object. */
+            footerColumnPath?: string,
+        }
+
         selection?: {
+            /** Default grid selection mode is multiple */
             mode: 'single' | 'multiple';
 
             /** name of primary key field. Default : it will be automatically pickup from schema. */
@@ -1383,6 +1434,8 @@ export interface IDBMasterConfig {
             /** Default : false, if true it will show filter for each column */
             rowFilter?: boolean;
         }
+
+        apiCallOverrides?: IDBMasterAPICallOverrides;
     };
     form?: {
         /** Ex : 90vw */
@@ -1398,6 +1451,72 @@ export interface IDBMasterConfig {
     }
 }
 
+export interface IDBMasterImportData {
+    enable: boolean;
+
+    fieldMappings: IDBMasterImportGridColumn[];
+}
+
+export interface IDBMasterImportGridColumn {
+    header: string;
+    sourceField: string;
+    targetField: string;
+    convertTargetFieldToType: EType;
+
+    /** Default: ISO date format, date-fns format, Dates from CSV will be parsed using this format. */
+    dateParseFormat?: string;
+
+    /** Dates will be converted into this timezone before sending to database query. */
+    dateTimeZone?: string;
+
+    /** Dates will be converted to this format to display in UI.<br/> */
+    dateFormatUIDisplay?: string;
+
+    /** Dates will be converted to this format to display in UI.<br/> */
+    dateTimeZoneUIDisplay?: string;
+
+    // calculated property
+    filterType?: EDBMasterConfigFilterType;
+}
+
+export interface IDBMasterCustomActionButton {
+    /** So parent can identify which custom action button clicked. */
+    actionName: string;
+
+    /** ex : pi pi-check. https://primeng.org/icons */
+    cssClass: string,
+
+    /** Give style object in angular style. */
+    style?: any;
+
+    /**
+     * If provided, it will ask for confirmation with this message.<br/>
+     * Below variables are available<br/>
+     * rowData = entire row object.<br/>
+     * message = Assign your custom confirmation message to this variable.<br/>
+     * ex: confirmationMessageScript: "message = `Do you want to approve ${rowData.name}?`",
+     *
+     * */
+    confirmationMessageScript?: string;
+}
+
+export interface IDBMasterTopLevelCustomActionButton extends Omit<IDBMasterCustomActionButton, 'cssClass'> {
+    /** custom CSS class to assign to button */
+    cssClass?: string,
+
+    /** Give label to button */
+    label?: string;
+
+    /** Default: info */
+    severity?: 'contrast' | 'danger' | 'help' | 'info' | 'primary' | 'secondary' | 'success' | 'warning';
+
+    /** ex : pi pi-check https://primeng.org/icons */
+    icon?: string;
+
+    /** Default: true, if false it will be enabled even if no row selected in grid. */
+    isDependentOnGridSelection?: boolean;
+}
+
 export interface IDBMasterConfigGridFilterOfField {
     matchMode: EDBMasterMatchMode;
     value: string;
@@ -1409,6 +1528,16 @@ export interface IDBMasterConfigOperation {
     /** Applicable for add button only. */
     label?: string;
     cssClass?: string;
+
+    apiCallOverrides?: IDBMasterAPICallOverrides;
+}
+
+export interface IDBMasterAPICallOverrides {
+    url: string;
+    headers?: any;
+    method?: 'POST';
+    body?: any;
+    pkField?: string;
 }
 
 export enum EDBMasterMatchMode {
@@ -1438,7 +1567,7 @@ export interface IDBMasterConfigGridField {
     /** Default false, it will format dates in 'dd-MM-yyyy hh:mm:ss a' automatically if 'dateTimeFormat' is not provided. */
     autoFormatDate?: boolean;
 
-    /** Default : browser timezone. Dates will be converted into this timezone before sending to database query. */
+    /** Dates will be converted into this timezone before sending to database query. */
     dateTimeZone?: string;
 
     /** Default : 'dd-MM-yyyy hh:mm:ss a' . System is using date-fns formats to format date object. */
@@ -1446,6 +1575,33 @@ export interface IDBMasterConfigGridField {
 
     /** Default : false, if true sorting will be enabled for this field. */
     enableSorting?: boolean;
+
+    dataSource?: 'db_data';
+    dbData?: {
+        instance?: string;
+        database?: string;
+        collection?: string;
+        pkField?: string;
+        displayField: string;
+
+        /** if select is provided, it will get those data. Make sure displayField is included in it. */
+        select?: any;
+    };
+
+    /** ex: 200px */
+    width?: string;
+
+    /** Give style object in angular style. */
+    headerStyle?: any;
+
+    /** custom CSS class to assign */
+    headerCssClass?: string,
+
+    /** Give style object in angular style. */
+    dataCellStyle?: any;
+
+    /** custom CSS class to assign */
+    dataCellCssClass?: string,
 }
 
 /** For internal use only. */
@@ -1468,10 +1624,20 @@ export enum EDBMasterConfigFilterType {
 
 export interface IDBMasterConfigFormField {
     label: string;
+
+    /** This text will be displayed under control in small. HTML supported. */
+    helpText?: string;
+
     path: string;
     control: EDBMasterFormControl;
+    disabled?: boolean;
+
+    validations?: Pick<IPropertyValidation, 'required'>;
+    validationErrors?: {
+        required: string;
+    };
 
-    // gridSettings?: IDBMasterConfig;
+    gridSettings?: IDBMasterConfig;
 
     textAreaSettings?: {
         rows?: number;
@@ -1503,6 +1669,9 @@ export interface IDBMasterConfigFormField {
         /** 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'>>;
 
@@ -1526,7 +1695,19 @@ export interface IDBMasterConfigFormField {
         virtualScroll?: boolean;
 
         jsCode?: {
-            appendTo: 'onceDropdownDataLoaded',
+            /**
+             * 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/>
+             * formData: any = Entire form object<br/>
+             * column: IDBMasterConfigFormField = Configuration of that form column<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.
+             */
+            appendTo: EDBMasterDropdownAppendTo,
             /**
              * // dropdownData is available to use.
              *
@@ -1545,7 +1726,10 @@ export interface IDBMasterConfigFormField {
              *
              */
             code: string,
+
         }[],
+
+        addNewFormConfig?: IDBMasterConfig;
     };
 
     autocompleteSettings?: {
@@ -1577,9 +1761,30 @@ export interface IDBMasterConfigFormField {
 
         /** Maximum file size allowed in bytes. Default : 10000000 (10MB) */
         maxFileSize?: number;
+    };
+
+    dividerSettings?: {
+        align?: 'center' | 'left' | 'right' | 'bottom' | 'top';
+        type?: 'dashed' | 'dotted' | 'solid';
+        dividerText?: string;
+        style?: any;
     }
 }
 
+export enum EDBMasterDropdownAppendTo {
+    modifyDropdownRequest = 'modifyDropdownRequest',
+    onceDropdownDataLoaded = 'onceDropdownDataLoaded',
+}
+
+export enum EDBMasterConfigAppendTo {
+    oncePageLoad = 'oncePageLoad',
+    gridRender = 'gridRender',
+    modifyGridRequest = 'modifyGridRequest',
+    preSaveAndEdit = 'preSaveAndEdit',
+    beforeSaveModalOpen = 'beforeSaveModalOpen',
+    beforeEditModalOpen = 'beforeEditModalOpen',
+}
+
 export enum EDBMasterFormControl {
     input = 'input',
     password = 'password',
@@ -1589,10 +1794,58 @@ export enum EDBMasterFormControl {
     color_picker = 'color_picker',
     dropdown = 'dropdown',
     file_upload = 'file_upload',
-    // grid = 'grid',
+    grid = 'grid',
+    divider = 'divider',
     // Save is working for editor but setting data is not working. PrimeNG has bug in it.
     // editor = 'editor',
     // auto_complete = 'auto_complete',
 }
 
+export interface IDBMasterMessageFromIframeToParent {
+    fromDBMaster: string;
+    eventType: IDBMasterEventFromIframeToParent;
+    eventData: any;
+}
+
+export interface IDBMasterMessageFromParentToIframe {
+    eventType: IDBMasterEventFromParentToIframe;
+    eventData: any;
+}
+
+export enum IDBMasterEventFromIframeToParent {
+    PAGE_READY = 'PAGE_READY',
+    RECORD_SAVED = 'RECORD_SAVED',
+    RECORDS_IMPORTED = 'RECORDS_IMPORTED',
+    RECORD_UPDATED = 'RECORD_UPDATED',
+    RECORD_DELETED = 'RECORD_DELETED',
+    MANY_RECORD_DELETED = 'MANY_RECORD_DELETED',
+    GRID_EXPORTED = 'GRID_EXPORTED',
+    GRID_REFRESHED = 'GRID_REFRESHED',
+    ADD_NEW_BUTTON_CLICKED = 'ADD_NEW_BUTTON_CLICKED',
+    CUSTOM_ACTION_BUTTON_CLICKED = 'CUSTOM_ACTION_BUTTON_CLICKED',
+    DROPDOWN_ADD_NEW_RECORD_SAVED = 'DROPDOWN_ADD_NEW_RECORD_SAVED',
+}
+
+export enum IDBMasterEventFromParentToIframe {
+    TRIGGER_ADD_NEW_BUTTON_CLICK = 'TRIGGER_ADD_NEW_BUTTON_CLICK',
+    TRIGGER_REFRESH_BUTTON_CLICK = 'TRIGGER_REFRESH_BUTTON_CLICK',
+    DATA_TO_APPEND_IN_GRID_LOAD_FIND_QUERY = 'DATA_TO_APPEND_IN_GRID_LOAD_FIND_QUERY',
+    DATA_TO_APPEND_IN_RECORD_SAVE_API_PAYLOAD = 'DATA_TO_APPEND_IN_RECORD_SAVE_API_PAYLOAD',
+    DATA_TO_APPEND_IN_RECORD_UPDATE_API_PAYLOAD = 'DATA_TO_APPEND_IN_RECORD_UPDATE_API_PAYLOAD',
+    SET_GLOBAL_DATA_TO_USE_IN_ANY_SCRIPT = 'SET_GLOBAL_DATA_TO_USE_IN_ANY_SCRIPT',
+    PARENT_READY = 'PARENT_READY', // parent will send message when it is ready with grid conditions.
+}
+
+/**
+ * If you want to hide custom action provide below property
+ * ____hide_actionName = true
+ */
+export enum IDBMasterSpecialRowProperties {
+    /** if this property found in row with value true, it will hide delete button for that row even if that is supported. */
+    ____hide_delete_button = '____hide_delete_button',
+
+    /** if this property found in row with value true, it will hide edit button for that row even if that is supported. */
+    ____hide_edit_button = '____hide_edit_button',
+}
+
 // ==== DB Master configurations End ====