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

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

@@ -329,7 +329,7 @@ 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. */
+    /** defaultValue has higher priority compare to defaultFun. 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. */
@@ -1788,7 +1788,7 @@ export interface IDBMasterConfig {
          * */
         showOtherFieldErrors?: boolean;
 
-        /** If it is empty, and operation.add is true, then it will generate form based on schema with all fields. */
+        /** Generates UI controls. */
         fields?: IDBMasterConfigFormField[][];
     };
 
@@ -2127,8 +2127,17 @@ export interface IDBMasterConfigFormField {
     /** This text will be displayed under control in small. HTML supported. */
     helpText?: string;
 
+    /** database field name, UI control value will be saved on this property in save/update object. */
     path?: string;
-    control: EDBMasterFormControl;
+
+    /** UI control type */
+    control?: EDBMasterFormControl;
+
+    /**
+     * Default : col-lg mt-4 col-md-{ 12 / ((columns.length === 2 ? 4 : columns.length) / 2) } <br/>
+     * It will be applied to parent div which holds UI control in it.
+     * */
+    cssClassDiv?: string;
 
     /** if true, that control will take focus automatically. */
     autofocus?: boolean;
@@ -2139,6 +2148,9 @@ export interface IDBMasterConfigFormField {
     /** if true or undefined, control will be visible. If string provides, it will evaluate that string and make it visible/invisible based on that. */
     visible?: boolean | string;
 
+    /** Generates UI controls. */
+    fields?: IDBMasterConfigFormField[][];
+
     validations?: Pick<IPropertyValidation, 'required'>;
     validationErrors?: {
         required?: string;
@@ -2161,6 +2173,13 @@ export interface IDBMasterConfigFormField {
         /** 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;
+
         jsCode?: {
             /**
              * Available variables:<br/>
@@ -2215,6 +2234,13 @@ export interface IDBMasterConfigFormField {
         /** Minimum number of character allows in the input field. */
         minLength?: number;
 
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
         jsCode?: {
             /**
              * Available variables:<br/>
@@ -2293,6 +2319,13 @@ export interface IDBMasterConfigFormField {
         /** Minimum number of character allows in the input field. */
         minLength?: number;
 
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
         jsCode?: {
             /**
              * Available variables:<br/>
@@ -2365,6 +2398,13 @@ export interface IDBMasterConfigFormField {
         /** 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;
+
         jsCode?: {
             /**
              * Available variables:<br/>
@@ -2416,6 +2456,13 @@ export interface IDBMasterConfigFormField {
 
         /** Number of characters to initiate. */
         length?: number;
+
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
     };
     // inputOtpSettings : end
 
@@ -2432,6 +2479,13 @@ export interface IDBMasterConfigFormField {
         /** 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;
+
         jsCode?: {
             /**
              * Available variables:<br/>
@@ -2469,6 +2523,13 @@ export interface IDBMasterConfigFormField {
 
     // checkboxSettings : start
     checkboxSettings?: {
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
         jsCode?: {
             /**
              * Available variables:<br/>
@@ -2504,12 +2565,92 @@ export interface IDBMasterConfigFormField {
     };
     // checkboxSettings : end
 
+    // ratingSettings : start
+    ratingSettings?: {
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
+        /** When specified a cancel icon is displayed to allow removing the value. */
+        cancel?: boolean;
+
+        /** Style class of the on icon. */
+        iconOnClass?: string;
+
+        /** Inline style of the on icon. */
+        iconOnStyle?: any;
+
+        /** Style class of the off icon. */
+        iconOffClass?: string;
+
+        /** Inline style of the off icon. */
+        iconOffStyle?: any;
+
+        /** Style class of the cancel icon. */
+        iconCancelClass?: string;
+
+        /** Inline style of the cancel icon. */
+        iconCancelStyle?: any;
+
+        /** Number of stars. */
+        stars?: number;
+
+        /** cancel rating custom HTML */
+        cancelIconHTML?: string;
+        onIconHTML?: string;
+        offIconHTML?: 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: EDBMasterRatingAppendTo,
+            /**
+             * // 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,
+        }[],
+    };
+    // ratingSettings : end
+
     // radioSettings : start
     radioSettings?: {
         displayType?: 'inline' | 'new_line';
         displayInCenter?: boolean;
         options: { label: string; value: any }[];
 
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
         jsCode?: {
             /**
              * Available variables:<br/>
@@ -2579,6 +2720,13 @@ export interface IDBMasterConfigFormField {
          */
         view?: 'date' | 'month' | 'year';
 
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
         jsCode?: {
             /**
              * Available variables:<br/>
@@ -2624,6 +2772,13 @@ export interface IDBMasterConfigFormField {
 
         format?: 'hex' | 'rgb' | 'hsb';
 
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
         jsCode?: {
             /**
              * Available variables:<br/>
@@ -2699,12 +2854,19 @@ export interface IDBMasterConfigFormField {
         /** 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. */
+        /** on value change of current dropdown | auto complete | multi select, it will change values of these dropdowns | auto completes | multi selects and reload them. */
         reloadDropdownsOfPath?: string[];
 
         /** API call will happen when these values of path are present in formData */
         isDependentOnPath?: string[];
 
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
         jsCode?: {
             /**
              * modifyDropdownRequest = It will run before hitting API call. So we can do whatever we want.<br/>
@@ -2761,7 +2923,7 @@ export interface IDBMasterConfigFormField {
         showClear?: boolean;
 
         /** Minimum number of characters to initiate a search. */
-        minLength?: number;
+        minLengthForSearch?: number;
 
         /** Delay between keystrokes to wait before sending a query. */
         delay?: number;
@@ -2784,7 +2946,7 @@ export interface IDBMasterConfigFormField {
         optionLabel?: string;
 
         /** Default : value */
-        optionValue?: string;
+        // optionValue?: string;
 
         /** one field or multiple comma separated fields are supported without any space in between. */
         filterBy?: string;
@@ -2796,14 +2958,25 @@ export interface IDBMasterConfigFormField {
         /** 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. */
+        /** on value change of current dropdown | auto complete | multi select, it will change values of these dropdowns | auto completes | multi selects and reload them. */
         reloadDropdownsOfPath?: string[];
 
         /** API call will happen when these values of path are present in formData */
         isDependentOnPath?: string[];
 
+        /** Displays a button next to the input field when enabled. */
         dropdown?: boolean;
 
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
+        /** Maximum number of character allows in the input field. */
+        maxLength?: number;
+
         addNewFormConfig?: IDBMasterConfig;
 
         apiCallOverrides?: IDBMasterAPICallOverrides;
@@ -2883,12 +3056,17 @@ export interface IDBMasterConfigFormField {
         /** Default : value */
         optionValue?: string;
 
+        /** Whether to show the header. */
+        showHeader?: boolean;
+
         /** 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: 'contains', Defines how the items are filtered.  */
+        filterMatchMode?: 'endsWith' | 'startsWith' | 'contains' | 'equals' | 'notEquals' | 'in' | 'lt' | 'lte' | 'gt' | 'gte';
 
         /** Default : false, if true it will get latest data when form opens for add/edit operation. */
         alwaysGetLatestDataOnFormOpen?: boolean;
@@ -2896,7 +3074,41 @@ export interface IDBMasterConfigFormField {
         /** 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. */
+        /** Decides how many selected item labels to show at most. */
+        maxSelectedLabels?: number;
+
+        /** Decides how many items can be selected at most. */
+        selectionLimit?: number;
+
+        /** Ex: "{0} items selected", Label to display after exceeding max selected labels. defaults "ellipsis" keyword to indicate a text-overflow. */
+        selectedItemsLabel?: string;
+
+        /** Whether to show the checkbox at header to toggle all items at once. */
+        showToggleAll?: boolean;
+
+        /** Name of the disabled field of an option. */
+        optionDisabled?: string;
+
+        /** Name of the label field of an option group. */
+        optionGroupLabel?: string;
+
+        /** Name of the options field of an option group. */
+        optionGroupChildren?: string;
+
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
+        /**
+         * Defines how the selected items are displayed.
+         * @group Props
+         */
+        display: 'comma' | 'chip';
+
+        /** on value change of current dropdown | auto complete | multi select, it will change values of these dropdowns | auto completes | multi selects and reload them. */
         reloadDropdownsOfPath?: string[];
 
         /** API call will happen when these values of path are present in formData */
@@ -2991,6 +3203,13 @@ export interface IDBMasterConfigFormField {
 
         /** internal use only */
         _fileSelectEvent?: any;
+
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
     };
     // fileUploadSettings : end
 
@@ -3191,6 +3410,13 @@ export interface IDBMasterConfigFormField {
         /** Style class of the badge. */
         size?: 'small' | 'large' | undefined | null;
 
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
         jsCode?: {
             /**
              * Available variables:<br/>
@@ -3254,6 +3480,13 @@ export interface IDBMasterConfigFormField {
         /** The source path for the preview image. */
         previewImageSrc?: string;
 
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
         jsCode?: {
             /**
              * Available variables:<br/>
@@ -3295,6 +3528,83 @@ export interface IDBMasterConfigFormField {
     };
     // customHTMLSettings : end
 
+    // knobSettings : start
+    knobSettings?: {
+        /** Advisory information to display in a tooltip on hover. */
+        tooltip?: string;
+
+        /** Type of CSS position. */
+        tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
+        tooltipStyleClass?: string;
+
+        /** Style class of the component. */
+        cssClass?: string | undefined;
+
+        /** Inline style of the component. */
+        style?: any;
+
+        /** Background of the value. */
+        valueColor?: string | undefined;
+
+        /** Background color of the range. */
+        rangeColor?: string;
+
+        /** Color of the value text. */
+        textColor?: string;
+
+        /** Template string of the value. */
+        valueTemplate?: string;
+
+        /** Size of the component in pixels. */
+        size?: number;
+
+        /** Step factor to increment/decrement the value. */
+        step?: number;
+
+        /** Minimum boundary value. */
+        min?: number;
+
+        /** Maximum boundary value. */
+        max?: number;
+
+        /** Width of the knob stroke. */
+        strokeWidth?: number;
+
+        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: EDBMasterKnobAppendTo,
+            /**
+             * // 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,
+        }[],
+    };
+    // knobSettings : end
+
 // genericConfig : start
 }
 
@@ -3335,6 +3645,14 @@ export enum EDBMasterAutoCompleteAppendTo {
     disabled = 'disabled',
     modifyAutoCompleteRequest = 'modifyAutoCompleteRequest',
     onceAutoCompleteDataLoaded = 'onceAutoCompleteDataLoaded',
+    focus = 'focus',
+    blur = 'blur',
+    keyUp = 'keyUp',
+    keyDown = 'keyDown',
+    onShow = 'onShow',
+    onHide = 'onHide',
+    onClear = 'onClear',
+    onDropdownClick = 'onDropdownClick',
 }
 
 // autocompleteSettings : end
@@ -3346,6 +3664,12 @@ export enum EDBMasterMultiSelectAppendTo {
     modifyMultiSelectRequest = 'modifyMultiSelectRequest',
     onceMultiSelectDataLoaded = 'onceMultiSelectDataLoaded',
     onChange = 'onChange',
+    focus = 'focus',
+    blur = 'blur',
+    keyUp = 'keyUp',
+    keyDown = 'keyDown',
+    onClear = 'onClear',
+    onSelectAllChange = 'onSelectAllChange',
 }
 
 // multiselectSettings : end
@@ -3485,6 +3809,28 @@ export enum EDBMasterCheckboxAppendTo {
 
 // checkboxSettings : end
 
+// ratingSettings : start
+export enum EDBMasterRatingAppendTo {
+    visible = 'visible',
+    disabled = 'disabled',
+    ngModelChange = 'ngModelChange',
+    onRate = 'onRate',
+    onCancel = 'onCancel',
+    onFocus = 'onFocus',
+    onBlur = 'onBlur',
+}
+
+// ratingSettings : end
+
+// knobSettings : start
+export enum EDBMasterKnobAppendTo {
+    visible = 'visible',
+    disabled = 'disabled',
+    ngModelChange = 'ngModelChange',
+}
+
+// knobSettings : end
+
 // radioSettings : start
 export enum EDBMasterRadioAppendTo {
     visible = 'visible',
@@ -3562,6 +3908,8 @@ export enum EDBMasterFormControl {
     file_upload = 'file_upload',
     grid = 'grid',
     divider = 'divider',
+    rating = 'rating',
+    knob = 'knob',
 
     // Field holder controls
     accordion = 'accordion',