@sava-info-systems/api-maker-with-extensions 1.15.1 → 1.17.0

package/sandbox/src/utils/VmInit.js

@@ -1,11 +1,11 @@
-Object.defineProperty(Error.prototype, 'toJSON', {
-    value: function() {
-        const alt = {};
-        Object.getOwnPropertyNames(this).forEach(function(key) {
-            alt[key] = this[key];
-        }, this);
-        return alt;
-    },
-    configurable: true,
-    writable: true,
-});
+Object.defineProperty(Error.prototype, 'toJSON', {
+    value: function() {
+        const alt = {};
+        Object.getOwnPropertyNames(this).forEach(function(key) {
+            alt[key] = this[key];
+        }, this);
+        return alt;
+    },
+    configurable: true,
+    writable: true,
+});

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

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

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

@@ -186,10 +186,10 @@ export interface IBaseParams {
 
     // 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/
+    dbEnvironment?: string;
 
     /** 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/
+    dbUser?: string;
 
     /**
      * If true, it will not throw cycle error.
@@ -604,7 +604,7 @@ export interface IQueryFormat {
     skip?: number;
     limit?: number;
     select?: any;
-    deep?: IApiParamsDeepFormat[] | string[] | string; // do not use it, it will return old cached obj because of caching so do not use it.
+    deep?: IApiParamsDeepFormat[] | string[] | string;
     set?: any; // It will be used for bulk update.
     groupBy?: any; // it is used in mysql query
     updateData?: any; // it is used in updateMany API
@@ -804,6 +804,29 @@ export interface ICustomApiSettingsTypes extends IAuthTokenInfoCommon {
 
     /** if runOnNativeProcess is true, these settings will have no effect. "Automatic Sandbox Restart In Seconds" will have no effect when this setting is provided. */
     separateSandboxSettings?: ISeparateSandboxSettings;
+
+    fileUpload?: IFileUploadSettings;
+}
+
+export interface IFileUploadSettings {
+    /** Default true, Allow file upload feature. */
+    enable?: boolean;
+
+    /** System will only allow file upload on these fields only. */
+    allowFileUploadFields?: EFilesVariables[];
+
+    validations?: {
+        [key in EFilesVariables]?: IFileUploadSettingsValidations;
+    }
+}
+
+export interface IFileUploadSettingsValidations {
+    /** System will throw error if file size is less than given size */
+    minFileSizeBytes?: number;
+    /** System will throw error if file size is greater than given size */
+    maxFileSizeBytes?: number;
+    /** ex: ['.png', '.jpeg', '.jpg'] */
+    allowedExtensionsArr?: string[];
 }
 
 export interface ISeparateSandboxSettings {
@@ -1188,7 +1211,7 @@ export interface IApiParamsQueryStream extends IAMGlobalBaseParams {
     skip?: number;
     limit?: number;
     select?: any;
-    deep?: IApiParamsDeepFormat[] | string[] | string; // do not use it, it will return old cached obj because of caching so do not use it.
+    deep?: IApiParamsDeepFormat[] | string[] | string;
     groupBy?: any; // it is used in mysql query
     updateData?: any;
 }
@@ -1208,6 +1231,10 @@ export interface IApiParamsUpdate extends IAMGlobalBaseParams {
     upsert?: boolean; // insert if item not available.
     returnDocument?: string; // return old doc if 'before', 'before' | 'after'
     select?: any; // to select which rows will return in response.
+    deep?: IApiParamsDeepFormat[] | string[] | string;
+
+    /** System will throw when record not found for the operation */
+    throwErrorIfRecordNotFound?: boolean;
 
     /** Default true, if true, it will allow update by id & replace by id & master save without version field and it will not throw error when version is different. */
     skipConcurrencyControl?: boolean;
@@ -1226,6 +1253,10 @@ export interface IApiParamsRemove extends IAMGlobalBaseParams {
     id?: any;
     primaryKey?: string;
     select?: any;
+    deep?: IApiParamsDeepFormat[] | string[] | string;
+
+    /** System will throw when record not found for the operation */
+    throwErrorIfRecordNotFound?: boolean;
 }
 
 export interface IApiParamsDistinct extends IAMGlobalBaseParams {
@@ -1495,6 +1526,60 @@ export interface ITestCaseSandboxCode {
 
 export type ITestCaseSandboxCode_P = Partial<ITestCaseSandboxCode>;
 
+export enum EFilesVariables {
+    files = 'files',
+    files1 = 'files1',
+    files2 = 'files2',
+    files3 = 'files3',
+    files4 = 'files4',
+    files5 = 'files5',
+    files6 = 'files6',
+    files7 = 'files7',
+    files8 = 'files8',
+    files9 = 'files9',
+    files10 = 'files10',
+    files11 = 'files11',
+    files12 = 'files12',
+    files13 = 'files13',
+    files14 = 'files14',
+    files15 = 'files15',
+    files16 = 'files16',
+    files17 = 'files17',
+    files18 = 'files18',
+    files19 = 'files19',
+    files20 = 'files20',
+    files21 = 'files21',
+    files22 = 'files22',
+    files23 = 'files23',
+    files24 = 'files24',
+    files25 = 'files25',
+    files26 = 'files26',
+    files27 = 'files27',
+    files28 = 'files28',
+    files29 = 'files29',
+    files30 = 'files30',
+    files31 = 'files31',
+    files32 = 'files32',
+    files33 = 'files33',
+    files34 = 'files34',
+    files35 = 'files35',
+    files36 = 'files36',
+    files37 = 'files37',
+    files38 = 'files38',
+    files39 = 'files39',
+    files40 = 'files40',
+    files41 = 'files41',
+    files42 = 'files42',
+    files43 = 'files43',
+    files44 = 'files44',
+    files45 = 'files45',
+    files46 = 'files46',
+    files47 = 'files47',
+    files48 = 'files48',
+    files49 = 'files49',
+    files50 = 'files50',
+}
+
 // ==== DB Master configurations Start ====
 
 export interface IUIMakerURLQueryParams {
@@ -1948,6 +2033,9 @@ export interface IDBMasterConfig {
         /** Ex : 90vw */
         width?: string;
 
+        /** Default: false, If true, it will hide close button. */
+        hideCloseButton?: boolean;
+
         /** Default : true,
          * If multiple is coming from API which is not mapped to any field, it will show in table.
          * In case of only one error, it will show in notification.
@@ -2149,9 +2237,14 @@ export interface IDBMasterConfigOperation {
 export interface IDBMasterAPICallOverrides {
     url: string;
     headers?: any;
-    method?: 'POST';
+    method?: 'POST' | 'GET' | 'PUT' | 'DELETE';
     body?: any;
 
+    /**
+     * JSON is expected and it will be converted query parameters and appended in URL.
+     * */
+    queryParams?: any;
+
     /** Primary key field name for current table. _id for mongodb. */
     pkField?: string;
 
@@ -4221,6 +4314,7 @@ export enum IDBMasterEventFromIframeToParent {
     GRID_EXPORTED = 'GRID_EXPORTED',
     GRID_REFRESHED = 'GRID_REFRESHED',
     ADD_NEW_BUTTON_CLICKED = 'ADD_NEW_BUTTON_CLICKED',
+    CLOSE_BUTTON_CLICKED = 'CLOSE_BUTTON_CLICKED',
     CUSTOM_ACTION_BUTTON_CLICKED = 'CUSTOM_ACTION_BUTTON_CLICKED',
     DROPDOWN_ADD_NEW_RECORD_SAVED = 'DROPDOWN_ADD_NEW_RECORD_SAVED',
 }

package/src/json/DefaultEmptyMongoSchema.ts

@@ -0,0 +1,64 @@
+import { ISchemaType, EType, ISchemaProperty, IPropertyValidation } from 'types';
+import * as T from 'types';
+
+const schema: ISchemaType = {
+    _id: EType.objectId,
+    email: <ISchemaProperty>{
+        __type: EType.string,
+        validations: <IPropertyValidation>{
+            required: true,
+            email: true,
+        },
+    },
+    password: <ISchemaProperty>{
+        __type: EType.string,
+        validations: <IPropertyValidation>{
+            required: true,
+        },
+    },
+    dob: <ISchemaProperty>{
+        __type: EType.date,
+    },
+    company_id: <ISchemaProperty>{
+        __type: EType.objectId,
+        collection: 'companies',
+    },
+    country_id: <ISchemaProperty>{
+        __type: EType.objectId,
+        instance: 'ins_master', // Optional in case of same instance
+        database: 'master', // Optional in case of same database
+        collection: 'countries',
+    },
+    createdAt: {
+        __type: EType.date,
+        conversions: {
+            defaults: {
+                defaultFun: () => {
+                    return new Date();
+                },
+            },
+        },
+    },
+    updatedAt: {
+        __type: EType.date,
+        conversions: {
+            conversionFun: (val, data) => {
+                // Every time generate new value on update or save
+                return new Date();
+
+                // If it is present in payload, take that value and set in db.
+                // if (data.updatedAt) return data.updatedAt;
+                // else return new Date();
+            },
+        },
+
+    },
+    status: {
+        __type: EType.string,
+        validations: {
+            enum: ['Active', 'Inactive'],
+        },
+    },
+};
+
+module.exports = { schema };

package/src/json/DefaultUsers.json

@@ -1,18 +1,18 @@
-[
-    {
-        "email": "root@root.com",
-        "name": "Root",
-        "password": "R00t_123456789",
-        "userType": "ROOT",
-        "apiPath": "root",
-        "active": true
-    },
-    {
-        "email": "admin@admin.com",
-        "name": "Admin",
-        "password": "Admin_123456789",
-        "userType": "ADMIN",
-        "apiPath": "admin",
-        "active": true
-    }
-]
+[
+    {
+        "email": "root@root.com",
+        "name": "Root",
+        "password": "R00t_123456789",
+        "userType": "ROOT",
+        "apiPath": "root",
+        "active": true
+    },
+    {
+        "email": "admin@admin.com",
+        "name": "Admin",
+        "password": "Admin_123456789",
+        "userType": "ADMIN",
+        "apiPath": "admin",
+        "active": true
+    }
+]