@sava-info-systems/api-maker-with-extensions 1.8.1 → 1.8.3

package/dist/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,54 @@ 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;
+
+    // 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;