@sava-info-systems/api-maker-with-extensions 1.12.1 → 1.14.0

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

@@ -270,6 +270,15 @@ export interface ISchemaProperty { // Add new schema property in ValidateDBSchem
     conversions?: IPropertyConversion;
     validations?: IPropertyValidation;
 
+    /**
+     * These settings are only available only for UI Maker extension. It will have no impact when UI Maker is not installed in your installation.<br/><br/>
+     * When we try to generate default JSON for collection from UI Maker, these settings will be merged with default JSON generation.<br/>
+     * These settings are only used to generate UI Maker code, it has no runtime effect.<br/>
+     *
+     * After generating default code for UI Maker page, system will use these settings and override those configurations.
+     * */
+    uim?: IDBMasterConfigFormField;
+
     instance?: string; // used as strings in _.get
     database?: string; // used as strings in _.get
     collection?: string; // used as strings in _.get
@@ -282,9 +291,19 @@ export interface ISchemaProperty { // Add new schema property in ValidateDBSchem
     /** Database will take care of assigning incremental value for this field. */
     isAutoIncrementByDB?: boolean;
 
-    /** API Maker will take care of assigning incremental value for this field. */
+    /**
+     * API Maker will take care of assigning incremental value for this field.<br/>
+     * if isAutoIncrementByDB is true then isAutoIncrementByAM & isAutoGenerateByAM will have no effect.
+     * */
     isAutoIncrementByAM?: boolean | IIsAutoIncrementByAM;
 
+    /**
+     * API Maker will generate random values for this field based on configuration. When value is provided then it will not generate.<br/>
+     * isAutoGenerateByAM has higher priority over isAutoIncrementByAM.<br/>
+     * if isAutoIncrementByDB is true then isAutoIncrementByAM & isAutoGenerateByAM will have no effect.
+     * */
+    isAutoGenerateByAM?: IIsAutoGenerateByAM;
+
     /**
      * 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/>
@@ -300,6 +319,17 @@ export interface IIsAutoIncrementByAM {
     step?: number; // default value will be 1
 }
 
+export interface IIsAutoGenerateByAM {
+    valueGeneratorType: EValueGeneratorType;
+}
+
+export enum EValueGeneratorType {
+    GUID_UUID = 'GUID_UUID',
+    ObjectID = 'ObjectID',
+    ULID = 'ULID',
+    ShortUUID = 'ShortUUID',
+}
+
 export interface IPropertyConversion {
     trimStart?: boolean;
     trimEnd?: boolean;
@@ -1382,6 +1412,29 @@ export type ITestCaseSandboxCode_P = Partial<ITestCaseSandboxCode>;
 
 // ==== DB Master configurations Start ====
 
+export interface IUIMakerURLQueryParams {
+    /** If you provide id in URL, it will open that Id in edit mode. */
+    id?: any;
+
+    /** Default edit, It will open form in edit or view mode based on passed value. */
+    'form-open-mode'?: EDBMasterGridOperationsOrder | null;
+
+    /** name of ui page */
+    'db-master-name'?: string;
+
+    /** admin user path */
+    'admin-path'?: string;
+
+    /** true | false // If passed, master will wait until parent is done with setting its data. */
+    'wait-for-parent-ready'?: string;
+
+    /** Default: false, If true, it will print debugging logs in console */
+    'show-logs'?: string;
+
+    /** You can pass theme in URL also */
+    theme?: any;
+}
+
 export enum EDBMasterTheme {
     BOOTSTRAP4_LIGHT_BLUE = 'bootstrap4-light-blue',
     BOOTSTRAP4_LIGHT_PURPLE = 'bootstrap4-light-purple',
@@ -1490,8 +1543,6 @@ export interface IDBMasterConfig {
         hideDeleteAllButton?: boolean;
         hideDeleteAllConfirmation?: boolean;
 
-        showRefreshButton?: boolean;
-
         deleteAllButtonSettings?: {
             /** default : true */
             raised?: boolean;
@@ -1508,6 +1559,8 @@ export interface IDBMasterConfig {
             severity?: uiMakerComponentSeverity;
         }
 
+        showRefreshButton?: boolean;
+
         refreshButtonSettings?: {
             /** default : true */
             raised?: boolean;
@@ -1530,6 +1583,7 @@ export interface IDBMasterConfig {
          *           T.EDBMasterOperationsOrder.global_search,
          *           T.EDBMasterOperationsOrder.import,
          *           T.EDBMasterOperationsOrder.export,
+         *           T.EDBMasterOperationsOrder.export_csv_single,
          *           T.EDBMasterOperationsOrder.refresh,
          *           T.EDBMasterOperationsOrder.add,
          *           T.EDBMasterOperationsOrder.custom_actions,
@@ -1541,6 +1595,7 @@ export interface IDBMasterConfig {
             | EDBMasterOperationsOrder.add
             | EDBMasterOperationsOrder.refresh
             | EDBMasterOperationsOrder.export
+            | EDBMasterOperationsOrder.export_csv_single
             | EDBMasterOperationsOrder.import
             | EDBMasterOperationsOrder.global_search
             | EDBMasterOperationsOrder.column_selector
@@ -1571,16 +1626,40 @@ export interface IDBMasterConfig {
             style?: any;
 
             csv?: {
-                enable: boolean;
+                enable?: boolean;
 
                 /** Default : CSV */
-                labelCSV: string;
+                labelCSV?: string;
 
                 /** Default : CSV Selected */
-                labelCSVSelected: string;
+                labelCSVSelected?: string;
+
+                /** Only these fields of grid will be exported. We can include hidden fields or calculated fields also in this. */
+                exportFields?: Pick<IDBMasterConfigGridField, 'path' | 'header'>[];
+
+                /** It will be suggested file name for download */
+                exportFileName?: string;
             }
             // pdf?: boolean;
         }
+
+        showExportCSVSingleButton?: boolean;
+
+        showExportCSVSingleButtonSettings?: {
+            /** default : true */
+            raised?: boolean;
+
+            /** Default : pi pi-sync */
+            icon?: string;
+
+            /** comma separated CSS classes */
+            cssClass?: string;
+
+            /** Give style object in angular style. */
+            style?: any;
+
+            severity?: uiMakerComponentSeverity;
+        }
     };
     /** Provide CDN path of JS/CSS libraries */
     externalLibs?: {
@@ -1603,7 +1682,7 @@ export interface IDBMasterConfig {
          * oncePageLoadWithContext = Code will be run only once on page load with context of data. (config, globalData: any, utils: any, queryParams: any) <br/>
          * gridRender = Gets executed everytime grid gets data. (gridEvent, gridData, globalData: any, utils: any, queryParams: any) <br/>
          * modifyGridRequest = You can modify api call request. (gridEvent, reqBody: IQueryFormat, globalData: any, utils: any, queryParams: any) <br/>
-         * preSaveAndEdit = Change data before saving/update/import. (reqBody: any | any[], globalData: any, utils: any, queryParams: any, mode: 'save' | 'edit' | 'import') <br/>
+         * preSaveAndEdit = run code before save & edit operation of form. Change data before saving/update/import. (reqBody: any | any[], globalData: any, utils: any, queryParams: any, mode: 'save' | 'edit' | 'import') <br/>
          * beforeSaveModalOpen = Change data before save modal open. (formData: any , globalData: any, utils: any, queryParams: any) <br/>
          * beforeEditModalOpen = Change data before edit modal open. (formData: any , globalData: any, utils: any, queryParams: any) <br/>
          *
@@ -1778,6 +1857,9 @@ export interface IDBMasterConfig {
         /** only applicable for top level form modal. */
         draggable?: boolean;
 
+        /** default: true, Whether the dialog can be displayed full screen. */
+        maximizable?: boolean;
+
         /** Ex : 90vw */
         width?: string;
 
@@ -1800,6 +1882,7 @@ export enum EDBMasterOperationsOrder {
     add = 'add',
     refresh = 'refresh',
     export = 'export',
+    export_csv_single = 'export_csv_single',
     import = 'import',
     global_search = 'global_search',
     column_selector = 'column_selector',
@@ -1961,7 +2044,7 @@ export interface IDBMasterConfigOperation {
     /** default : true */
     raised?: boolean;
 
-    /** Applicable for add button only. */
+    /** Gives label to Add button which is visible on top of the grid. Applicable for add button only. */
     label?: string;
 
     /** Applicable for add button only. */
@@ -2050,6 +2133,12 @@ export interface IDBMasterConfigGridField {
     /** If displayField provided, it will display from this field otherwise it will display value of path field. */
     displayField?: string;
 
+    /** Placeholder value for filter in header */
+    placeHolderOfFilterInHeader?: string;
+
+    /** If true, filter in header will be hidden. */
+    hideFilter?: boolean;
+
     /** Default false, it will format dates in 'dd-MM-yyyy hh:mm:ss a' automatically if 'dateTimeFormat' is not provided. */
     autoFormatDate?: boolean;
 
@@ -2101,6 +2190,9 @@ export interface IDBMasterConfigGridFieldExport extends IDBMasterConfigGridField
 
     /** Calculated property based on schema. Used to give type to <p-columnFilter>. */
     filterType?: EDBMasterConfigFilterType;
+
+    /** Sets default match mode to column filter */
+    matchModeForFilterInColumn?: EDBMasterMatchMode;
 }
 
 export enum EDBMasterConfigFilterType {
@@ -2151,7 +2243,12 @@ export interface IDBMasterConfigFormField {
     /** Generates UI controls. */
     fields?: IDBMasterConfigFormField[][];
 
-    validations?: Pick<IPropertyValidation, 'required'>;
+    validations?: Pick<IPropertyValidation, 'required'> & {
+        /** If requiredFun is present, that code will be executed when form data is getting changed and it sets value in required.<br/>
+         * Value of required will be ignored when requiredFun is present because system will evaluate "requiredFun" and it's output will be value of "required"
+         * */
+        requiredFun?: string;
+    };
     validationErrors?: {
         required?: string;
     };
@@ -2215,6 +2312,63 @@ export interface IDBMasterConfigFormField {
     };
     // textAreaSettings : end
 
+    // editorSettings : start
+    editorSettings?: {
+        /** Give style object in angular style. */
+        style?: any;
+
+        placeholder?: string;
+
+        /** Maximum number of character allows in the input field. */
+        maxLength?: number;
+
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
+        /** Only those controls and formats will be allowed
+         * ex: ['background', 'bold', 'color', 'font', 'code', 'italic', 'link', 'size', 'strike', 'script', 'underline', 'blockquote', 'header', 'indent', 'list', 'align', 'direction', 'code-block', 'image', 'video', 'clean']
+         * */
+        formats?: string[];
+
+        jsCode?: {
+            /**
+             * Available variables:<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/>
+             * 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/>
+             * event: any <br/>
+             */
+            appendTo: EDBMasterEditorAppendTo,
+            /**
+             * // 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,
+        }[],
+    };
+    // editorSettings : end
+
     // inputTextSettings : start
     inputTextSettings?: {
         /** Give style object in angular style. */
@@ -2574,7 +2728,7 @@ export interface IDBMasterConfigFormField {
         tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
         tooltipStyleClass?: string;
 
-        /** When specified a cancel icon is displayed to allow removing the value. */
+        /** Default : true, When specified a cancel icon is displayed to allow removing the value. */
         cancel?: boolean;
 
         /** Style class of the on icon. */
@@ -3800,6 +3954,22 @@ export enum EDBMasterTextAreaAppendTo {
 
 // textAreaSettings : end
 
+// editorSettings : start
+export enum EDBMasterEditorAppendTo {
+    visible = 'visible',
+    disabled = 'disabled',
+    ngModelChange = 'ngModelChange',
+    onTextChange = 'onTextChange',
+    onInit = 'onInit',
+    onSelectionChange = 'onSelectionChange',
+    focus = 'focus',
+    blur = 'blur',
+    keyUp = 'keyUp',
+    keyDown = 'keyDown',
+}
+
+// editorSettings : end
+
 // checkboxSettings : start
 export enum EDBMasterCheckboxAppendTo {
     visible = 'visible',
@@ -3877,14 +4047,28 @@ export enum EDBMasterGridAppendTo {
 // gridSettings : end
 
 export enum EDBMasterConfigAppendTo {
+    /** Code will be run only once on page load. config and global data are not available. It will append script to page script tag. */
     oncePageLoad = 'oncePageLoad',
+
+    /** Code will be run only once on page load with context of data. (config, globalData: any, utils: any, queryParams: any) */
     oncePageLoadWithContext = 'oncePageLoadWithContext',
+
+    /** Gets executed everytime grid gets data. (gridEvent, gridData, globalData: any, utils: any, queryParams: any) */
     gridRender = 'gridRender',
+
+    /** You can modify api call request. (gridEvent, reqBody: IQueryFormat, globalData: any, utils: any, queryParams: any) */
     modifyGridRequest = 'modifyGridRequest',
 
-    /** run code before save & edit operation of form */
+    /** Executed once grid data loaded. */
+    onceGridDataLoaded = 'onceGridDataLoaded',
+
+    /** run code before save & edit operation of form. Change data before saving/update/import. (reqBody: any | any[], globalData: any, utils: any, queryParams: any, mode: 'save' | 'edit' | 'import') */
     preSaveAndEdit = 'preSaveAndEdit',
+
+    /** Change data before save modal open. (formData: any , globalData: any, utils: any, queryParams: any) */
     beforeSaveModalOpen = 'beforeSaveModalOpen',
+
+    /** Change data before edit modal open. (formData: any , globalData: any, utils: any, queryParams: any) */
     beforeEditModalOpen = 'beforeEditModalOpen',
     beforeViewModalOpen = 'beforeViewModalOpen',
     columnSelectionChanged = 'columnSelectionChanged',
@@ -3899,6 +4083,7 @@ export enum EDBMasterFormControl {
     password = 'password',
     date_picker = 'date_picker',
     textarea = 'textarea',
+    editor = 'editor',
     checkbox = 'checkbox',
     radio = 'radio',
     color_picker = 'color_picker',
@@ -3994,6 +4179,24 @@ export interface IDBMasterUIPageUtilsScope {
             showWarningToast(msg: string, otherProps?: any): void;
         }
 
+        /** Add | Edit | Delete | View | Refresh Grid operations */
+        operations: {
+            /** Reload grid data. */
+            refreshGrid(): Promise<void>;
+
+            /** Opens form in add mode. */
+            openFormInAddMode(): Promise<void>;
+
+            /** Opens modal in edit mode with data filled in it. */
+            openFormInEditMode(id: any): Promise<void>;
+
+            /** Opens modal in view mode with data filled in it. */
+            openFormInViewMode(id: any): Promise<void>;
+
+            /** Without any confirmation it will directly perform delete operation of given id. */
+            deleteRecord(id: any): Promise<void>;
+        }
+
         /**
          * form fields are in nested form, it returns simple array of form fields.
          * It will not include fields from grid control as they are having different form and grid control itself is a form.
@@ -4026,6 +4229,41 @@ export interface IDBMasterUIPageUtilsScope {
 
         /** It finds grid element having that path. */
         findGridElement(path: string): IDBMasterConfigGridField | undefined;
+
+        /** You can set value in any filter and it will trigger filter automatically on that field. */
+        setValueInFilterOfTopGrid(path: string, value: any): void;
+
+        /**
+         * It will convert array of objects into CSV string<br/>
+         * papaUnparseOptions = https://www.papaparse.com/docs#unparse-config-default
+         * */
+        convertArrayToCSV(dataArr: any[], papaUnparseOptions?: any): string;
+
+        /**
+         * It will throw file to user for download.<br/>
+         * fileContent ex = "Some file content"
+         * filename ex. = clients.csv
+         * fileType ex. = text/csv
+         * */
+        download(fileContent: string, filename: string, fileType: string): void;
+
+        /**
+         * Useful to clear all properties of object and assign all properties of new object without changing object reference.
+         * Use this function to set new value to $scope.<br/>
+         * ex:<br/>
+         * const someNewApiResponse = $scope.apiResponse;<br/>
+         * $scope.utils.setDataInObject($scope.apiResponse, someNewApiResponse);<br/>
+         * */
+        setDataInObject(oldObject: any, newObject: any): void;
+
+        /**
+         * Useful to remove all objects of array and put new objects from new array without changing object reference.
+         * Use this function to set new value to $scope.<br/>
+         * ex:<br/>
+         * const someNewApiResponse = $scope.apiResponse;<br/>
+         * $scope.utils.setDataInArray($scope.apiResponse, someNewApiResponse);<br/>
+         * */
+        setDataInArray(oldArray: any[], newArray: any[]): void;
     };
     queryParams: any;
     userUtils: { [utilName: string]: any };

package/src/public/dist-db-masters/browser/index.html

@@ -4,8 +4,9 @@
     <meta charset="utf-8">
     <title>Database Masters</title>
     <base href="/dist-db-masters/browser/">
-    <meta http-equiv="Cache-control" content="no-cache, no-store, must-revalidate">
+    <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate">
     <meta http-equiv="Pragma" content="no-cache">
+    <meta http-equiv="Expires" content="0">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <link rel="icon" type="image/x-icon" href="favicon.ico">
     <link id="idPrimeNgThemeLinkTag" type="text/css" rel="stylesheet" href="assets/themes/lara-light-blue/theme.css">
@@ -19,9 +20,12 @@
         window.dateFnsTz = dateFnsTz;
     </script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/PapaParse/5.4.1/papaparse.min.js" integrity="sha512-dfX5uYVXzyU8+KHqj8bjo7UkOdg18PaOtpa48djpNbZHwExddghZ+ZmzWT06R5v6NSk3ZUfsH6FNEDepLx9hPQ==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script type="text/javascript">
+        const configObjGlobal = ''; // 👈 Do not modify this line
+    </script>
 <style>@layer primeng{@-webkit-keyframes p-fadein{0%{opacity:0}to{opacity:1}}}@-webkit-keyframes p-icon-spin{0%{-webkit-transform:rotate(0);transform:rotate(0)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}html{font-size:14px}body{margin:0}
-</style><link rel="stylesheet" href="styles.css" media="print" onload="this.media='all'"><noscript><link rel="stylesheet" href="styles.css"></noscript><link rel="modulepreload" href="chunk-MON7YFGF.js"></head>
+</style><link rel="stylesheet" href="styles-2H2JU2BI.css" media="print" onload="this.media='all'"><noscript><link rel="stylesheet" href="styles-2H2JU2BI.css"></noscript><link rel="modulepreload" href="chunk-MON7YFGF.js"></head>
 <body>
 <app-root></app-root>
-<script src="polyfills.js" type="module"></script><script src="main.js" type="module"></script></body>
+<script src="polyfills-6EAL64PA.js" type="module"></script><script src="main-TYGVEM3B.js" type="module"></script></body>
 </html>