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

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

@@ -1,4 +1,4 @@
-import { ISchemaType } from './types';
+import { ISchemaType, ISwaggerDocsObj } from './types';
 
 export interface IApiSchema {
     name: string;
@@ -14,6 +14,7 @@ export interface IApiSchema {
     reqBodySchema?: ISchemaType;
     reqQueryParametersSchema?: ISchemaType;
     errorList: string[];
+    swaggerDocs?: ISwaggerDocsObj;
 }
 
 export type IApiSchemaUI = Omit<IApiSchema, 'headers' | 'autoAddHeaders' | 'queryParams' | 'autoAddQueryParams' | 'requestBodyTypeSupported'>;

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

@@ -16,11 +16,12 @@ export interface IAMGlobalLogger {
 
 export interface IAMGlobalRequest {
     headers: any;
-    params: any;
+    params: IBaseParams;
     query: any;
     body: any;
     eventData: any;
     auth: ISandboxReqAuthObj;
+    reqInfo: IRequestInfo;
 
     /** It will be true, when request is coming from actual end user and not from internal code like custom API or not from AM UI. */
     isApiRequestFromUser?: boolean;
@@ -35,6 +36,96 @@ export interface ISandboxReqAuthObj {
     authAzure?: any;
 }
 
+export interface IRequestInfo {
+    url: string;
+    apiCategory: EAPICategoryEnum;
+    apiInfo: {
+        schemaType: 'SCHEMA' | 'GEN',
+        id: EAPIIdEnum;
+        name: string;
+        url: string;
+    };
+    reqMethod?: ERequestMethod;
+}
+
+export enum EAPICategoryEnum {
+    INSTANCES = 'INSTANCES',
+    THIRD_PARTY_APIS = 'THIRD_PARTY_APIS',
+    CUSTOM_APIS = 'CUSTOM_APIS',
+    SYSTEM_APIS = 'SYSTEM_APIS',
+    EVENTS = 'EVENTS',
+    SCHEDULERS = 'SCHEDULERS',
+    MIGRATION_SCRIPT = 'MIGRATION_SCRIPT',
+    PROCESS_INITIALIZER = 'PROCESS_INITIALIZER',
+    UTILITY_CLASS = 'UTILITY_CLASS',
+}
+
+export enum EAPIIdEnum {
+    // Schema APIs
+    SCHEMA_GET_ALL = 'SCHEMA_GET_ALL',
+    SCHEMA_GET_ALL_STREAM = 'SCHEMA_GET_ALL_STREAM',
+    SCHEMA_GET_BY_ID = 'SCHEMA_GET_BY_ID',
+    SCHEMA_POST_BULK_INSERT = 'SCHEMA_POST_BULK_INSERT',
+    SCHEMA_MASTER_SAVE = 'SCHEMA_MASTER_SAVE',
+    SCHEMA_ARRAY_OPERATIONS = 'SCHEMA_ARRAY_OPERATIONS',
+    SCHEMA_UPDATE_MANY = 'SCHEMA_UPDATE_MANY',
+    SCHEMA_PUT_UPDATE_BY_ID = 'SCHEMA_PUT_UPDATE_BY_ID',
+    SCHEMA_PUT_REPLACE_BY_ID = 'SCHEMA_PUT_REPLACE_BY_ID',
+    SCHEMA_DEL_DELETE_BY_ID = 'SCHEMA_DEL_DELETE_BY_ID',
+    SCHEMA_POST_QUERY = 'SCHEMA_POST_QUERY',
+    SCHEMA_POST_QUERY_STREAM = 'SCHEMA_POST_QUERY_STREAM',
+    SCHEMA_POST_QUERY_DELETE = 'SCHEMA_POST_QUERY_DELETE',
+    SCHEMA_POST_AGGREGATE = 'SCHEMA_POST_AGGREGATE',
+    SCHEMA_POST_COUNT = 'SCHEMA_POST_COUNT',
+    SCHEMA_GET_DISTINCT = 'SCHEMA_GET_DISTINCT',
+    SCHEMA_POST_DISTINCT_QUERY = 'SCHEMA_POST_DISTINCT_QUERY',
+
+    // GEN APIs
+    GEN_GET_ALL = 'GEN_GET_ALL',
+    GEN_GET_ALL_STREAM = 'GEN_GET_ALL_STREAM',
+    GEN_GET_BY_ID = 'GEN_GET_BY_ID',
+    GEN_POST_BULK_INSERT = 'GEN_POST_BULK_INSERT',
+    GEN_MASTER_SAVE = 'GEN_MASTER_SAVE',
+    GEN_ARRAY_OPERATIONS = 'GEN_ARRAY_OPERATIONS',
+    GEN_UPDATE_MANY = 'GEN_UPDATE_MANY',
+    GEN_PUT_UPDATE_BY_ID = 'GEN_PUT_UPDATE_BY_ID',
+    GEN_PUT_REPLACE_BY_ID = 'GEN_PUT_REPLACE_BY_ID',
+    GEN_DEL_DELETE_BY_ID = 'GEN_DEL_DELETE_BY_ID',
+    GEN_POST_QUERY = 'GEN_POST_QUERY',
+    GEN_POST_QUERY_STREAM = 'GEN_POST_QUERY_STREAM',
+    GEN_POST_QUERY_DELETE = 'GEN_POST_QUERY_DELETE',
+    GEN_POST_AGGREGATE = 'GEN_POST_AGGREGATE',
+    GEN_POST_COUNT = 'GEN_POST_COUNT',
+    GEN_GET_DISTINCT = 'GEN_GET_DISTINCT',
+    GEN_POST_DISTINCT_QUERY = 'GEN_POST_DISTINCT_QUERY',
+
+    // System APIs
+    EXECUTE_PLAIN_QUERY = 'EXECUTE_PLAIN_QUERY',
+    ENCRYPT_DATA = 'ENCRYPT_DATA',
+    DECRYPT_DATA = 'DECRYPT_DATA',
+    HASH_DATA = 'HASH_DATA',
+    GET_TOKEN = 'GET_TOKEN',
+    CALL_EXTERNAL_API = 'CALL_EXTERNAL_API',
+    GET_SECRET = 'GET_SECRET',
+
+    GET_REDIS_KEY = 'GET_REDIS_KEY',
+    SET_REDIS_KEY = 'SET_REDIS_KEY',
+    REMOVE_REDIS_KEY = 'REMOVE_REDIS_KEY',
+    CUSTOM_USER_CACHING = 'CUSTOM_USER_CACHING', // it is used for CRUD of user keys from system API.
+
+    RESET_REDIS_CACHE_DB = 'RESET_REDIS_CACHE_DB',
+    RESET_REDIS_CACHE_CUSTOM_APIS = 'RESET_REDIS_CACHE_CUSTOM_APIS',
+    RESET_REDIS_CACHE_SYSTEM_APIS = 'RESET_REDIS_CACHE_SYSTEM_APIS',
+    RESET_REDIS_CACHE_TP_APIS = 'RESET_REDIS_CACHE_TP_APIS',
+    GET_TABLE_META = 'GET_TABLE_META',
+    EMIT_EVENT = 'EMIT_EVENT',
+    EMIT_EVENT_WS = 'EMIT_EVENT_WS',
+
+    IS_VALID_DATA_FOR_TABLE = 'IS_VALID_DATA_FOR_TABLE',
+    IS_VALID_DATA_FOR_CUSTOM_API = 'IS_VALID_DATA_FOR_CUSTOM_API',
+    IS_VALID_DATA_FOR_THIRD_PARTY_API = 'IS_VALID_DATA_FOR_THIRD_PARTY_API',
+}
+
 export interface IAuthInfoObjects {
     authAMDBInfo?: IAuthTokenAMDB; //
     authAMDBGroups?: any[]; // IGroup[]
@@ -65,6 +156,57 @@ export enum ERequestMethod {
     DELETE = 'DELETE',
 }
 
+export interface IBaseParams {
+    apiPath?: string;
+    reqMethod?: ERequestMethod;
+
+    // instance apis
+    instanceName?: string;
+
+    /** Do not use this field. Use dbEnvironment | dbUser */
+    database?: string;
+    collection?: string;
+    column?: string;
+    id?: any;
+    primaryKey?: any;
+
+    // instance apis -> distinct api params
+    field?: string;
+    order?: string;
+
+    // third party
+    apiBundleName?: string;
+    apiVersionName?: string;
+    apiName?: string;
+    apiCodePath?: string;
+
+    // swagger
+    swaggerToken?: string;
+
+    // calculated fields from database field
+    /** database name given by user and it will be converted to masked database. ex: inventory_db */
+    dbEnvironment?: string; // am_cloud // use it in git push/pull/get-schema/get api list/
+
+    /** Actual database name on which operation is getting performed. ex: inventory_db_dev_1 */
+    dbUser?: string; // am_cloud_mayur // use it to get data/redis key/
+
+    /**
+     * If true, it will not throw cycle error.
+     */
+    noCycle?: boolean;
+
+    /**
+     * Default is true, If true, it will skip pre hook & post hook running.
+     * It will be made true from code of custom API
+     */
+    skipHookRunning?: boolean;
+
+    /**
+     * It is used in instance & database & collection hooks
+     */
+    hookType?: 'pre' | 'post';
+}
+
 export interface IAMGlobalResponse {
     /** Status code of response. ex: 401, 500 */
     statusCode?: EStatusCode;
@@ -539,6 +681,38 @@ export interface ICustomApiSettingsTypes extends IAuthTokenInfoCommon {
     // calculated property
     errorList: string[]; // list of all errors thrown by this API.
     pathAndRequestMethod?: string;
+    swaggerDocs?: ISwaggerDocsObj;
+}
+
+export interface ISwaggerDocsObj {
+    tag?: string | string[];
+    /**
+     * Useful to provide custom dynamic parameters.
+     * For files you can provide this : [{ in: T.ESwaggerParamInType.formData, name: 'files', type: 'file' }]
+     */
+    parameters?: ISwaggerParametersEntity[];
+}
+
+export interface ISwaggerParametersEntity {
+    name: string;
+    in: ESwaggerParamInType;
+    description?: string;
+    required?: boolean;
+    format?: string | null;
+    schema?: {
+        type: 'array' | 'object' | 'string' | 'integer' | 'boolean' | 'file';
+        example?: any,
+        default?: any;
+        enum?: any[];
+    }
+}
+
+export enum ESwaggerParamInType {
+    body = 'body',
+    query = 'query',
+    path = 'path',
+    header = 'header',
+    formData = 'formData',
 }
 
 export interface ISystemApiSettingsTypes extends IAuthTokenInfoCommon {
@@ -1229,6 +1403,16 @@ export interface IDBMasterConfig {
      */
     screenName?: string;
 
+    /**
+     * We can provide schema in this and it will append fields to parent schema.
+     */
+    schema?: {
+        instanceName: string;
+        databaseName: string;
+        collectionName: string;
+        properties: ISchemaType;
+    }
+
     /** Default : false */
     showThemeSelector?: boolean;
 
@@ -1259,6 +1443,38 @@ export interface IDBMasterConfig {
 
         showRefreshButton?: boolean;
 
+        deleteAllButtonSettings?: {
+            /** default : true */
+            raised?: boolean;
+
+            /** Default : pi pi-trash */
+            icon?: string;
+
+            /** comma separated CSS classes */
+            cssClass?: string;
+
+            /** Give style object in angular style. */
+            style?: any;
+
+            severity?: uiMakerComponentSeverity;
+        }
+
+        refreshButtonSettings?: {
+            /** 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;
+        }
+
         /**
          * Default : T.EDBMasterOperationsOrder.theme_selector,
          *           T.EDBMasterOperationsOrder.column_selector,
@@ -1291,6 +1507,20 @@ export interface IDBMasterConfig {
             /** Default : pi pi-download */
             icon?: string;
 
+            /** default : true */
+            raised?: boolean;
+
+            /** comma separated CSS classes */
+            cssClass?: string;
+
+            severity?: uiMakerComponentSeverity;
+
+            /** default : Export data */
+            tooltip?: string;
+
+            /** Give style object in angular style. */
+            style?: any;
+
             csv?: {
                 enable: boolean;
 
@@ -1546,6 +1776,20 @@ export interface IDBMasterImportData {
     /** Default : pi pi-file-import */
     icon?: string;
 
+    /** default : true */
+    raised?: boolean;
+
+    /** comma separated CSS classes */
+    cssClass?: string;
+
+    severity?: uiMakerComponentSeverity;
+
+    /** default : Export data */
+    tooltip?: string;
+
+    /** Give style object in angular style. */
+    style?: any;
+
     /** width of grid. */
     gridWidth?: string;
 
@@ -1596,17 +1840,21 @@ export interface IDBMasterCustomActionButton {
     /** Give style object in angular style. */
     style?: any;
 
+    /** default : true */
+    raised?: boolean;
+
     /**
      * 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}?`",
-     *
+     * selectedGridItems = entire row object or array of selected rows. If grid header level action button clicked it will be array of selected rows.
+     *     -- If grid row action button clicked it will be entire row.<br/>
+     * ex: confirmationMessageScript: "`Do you want to approve ${selectedGridItems.length}?`",
      * */
     confirmationMessageScript?: string;
 }
 
+type uiMakerComponentSeverity = 'contrast' | 'danger' | 'help' | 'info' | 'primary' | 'secondary' | 'success' | 'warning';
+
 export interface IDBMasterTopLevelCustomActionButton extends Omit<IDBMasterCustomActionButton, 'cssClass'> {
     /** custom CSS class to assign to button */
     cssClass?: string,
@@ -1615,7 +1863,7 @@ export interface IDBMasterTopLevelCustomActionButton extends Omit<IDBMasterCusto
     label?: string;
 
     /** Default: info */
-    severity?: 'contrast' | 'danger' | 'help' | 'info' | 'primary' | 'secondary' | 'success' | 'warning';
+    severity?: uiMakerComponentSeverity;
 
     /** ex : pi pi-check https://primeng.org/icons */
     icon?: string;
@@ -1632,11 +1880,23 @@ export interface IDBMasterConfigGridFilterOfField {
 export interface IDBMasterConfigOperation {
     enable: boolean;
 
+    /** default : true */
+    raised?: boolean;
+
     /** Applicable for add button only. */
     label?: string;
+
     /** Applicable for add button only. */
     cssClass?: string;
 
+    /** Give style object in angular style. */
+    style?: any;
+
+    severity?: uiMakerComponentSeverity;
+
+    /** ex : pi pi-plus https://primeng.org/icons */
+    icon?: string;
+
     apiCallOverrides?: IDBMasterAPICallOverrides;
 }
 
@@ -1808,7 +2068,7 @@ export interface IDBMasterConfigFormField {
     // genericConfig : end
 
     // gridSettings : start
-    gridSettings?: IDBMasterConfig;
+    gridSettings?: Omit<IDBMasterConfig, 'schema'>;
     // gridSettings : end
 
     // textAreaSettings : start
@@ -2373,7 +2633,7 @@ export interface IDBMasterConfigFormField {
              * onceDropdownDataLoaded = Execute code when dropdown data is loaded.<br/>
              *
              * Available variables:<br/>
-             * body: IQueryFormat | any. Useful to modify apiCallOverrides also,<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/>
@@ -2638,7 +2898,7 @@ export interface IDBMasterConfigFormField {
         loadingIcon?: string;
 
         /** Defines the style of the button. */
-        severity?: 'success' | 'info' | 'warning' | 'danger' | 'help' | 'primary' | 'secondary' | 'contrast' | null | undefined;
+        severity?: uiMakerComponentSeverity | null | undefined;
 
         /** Add a shadow to indicate elevation. */
         raised?: boolean;