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

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

@@ -256,6 +256,7 @@ export enum EErrorType {
     schemaNotFound = 'schemaNotFound',
     emailNotValid = 'emailNotValid',
     enumValidation = 'enumValidation',
+    virtualFieldUsedInFind = 'virtualFieldUsedInFind',
 }
 
 // Main interfaces
@@ -284,8 +285,25 @@ export interface ISchemaProperty { // Add new schema property in ValidateDBSchem
     collection?: string; // used as strings in _.get
     table?: string;
 
-    // this column value will be return after nested save.
-    column?: string; // user can define column of target collection here. so no need to define t_key in deep property. Used in getDataForDeep // used as strings in _.get
+    /**
+     * user can define column of target collection here. so no need to define t_key in deep property.
+     * this column value will be return after nested save.
+     * */
+    column?: string;
+
+    /**
+     * Used in virtual field deep populate.<br/>
+     * Current table's which column is used to generate this virtual field.
+     * */
+    s_columnVirtualLinker?: string;
+
+    /**
+     * Used for columns where isVirtualField is true.
+     * Need to place column name of target table which holds primary key value of this table.
+     * It is optional when target table has only one column, in which `collection/table` value is this collection/table name.
+     * */
+    t_columnVirtualLinker?: string;
+
     isPrimaryKey?: boolean;
 
     /** Database will take care of assigning incremental value for this field. */
@@ -312,6 +330,12 @@ export interface ISchemaProperty { // Add new schema property in ValidateDBSchem
      * By using optimistic concurrency control, you can ensure that updates are not overwritten by concurrent modifications, maintaining data integrity.<br/>
      * */
     isConcurrencyControlField?: boolean;
+
+    /**
+     * If true, means it is not actual field in database and just field in schema.
+     * Means we want it to use in deep populate and master save to get & store data in one API call.
+     * */
+    isVirtualField?: boolean;
 }
 
 export interface IIsAutoIncrementByAM {
@@ -343,7 +367,7 @@ export interface IPropertyConversion {
      * This default value will be converted to that type and applied.<br/>
      * Empty string and null values will be treated based on configuration.
      * */
-    defaults?: IPropertyConversionDefaults
+    defaults?: IPropertyConversionDefaults;
 
     /** enable encryption for this property */
     encryption?: boolean | IEncryptionDescription;
@@ -590,11 +614,20 @@ export interface IQueryFormat {
 
 export interface IApiParamsDeepFormat {
     s_key: string;
+    /**
+     * Used in virtual field deep populate.<br/>
+     * Value of which key is used to compare with value of t_keyColumnVirtualLinker in target collection(t_col).
+     * */
+    s_keyColumnVirtualLinker?: string;
+
     // t_apiPath?: string;
     t_instance?: string;
     t_db?: string;
     t_col?: string;
+    /** Primary key of target collection/table */
     t_key?: string;
+    /** Column of target table which holds data to link to current table */
+    t_keyColumnVirtualLinker?: string;
     deep?: IApiParamsDeepFormat[] | string[] | string;
     select?: any;
 
@@ -607,6 +640,21 @@ export interface IApiParamsDeepFormat {
     // We process skip & limit while setting multiple data.
     skip?: number;
     limit?: number;
+
+    /**
+     * Can be used for fields having `isVirtualField: true` in schema.
+     * chunk = System will get data in chunks from database. It is default method with chunk size = 1000. <br/>
+     * one_by_one = System will get nested data one by one for each object. It should be used when we are using limit & skip for target table and it has large amount of data.<br/>
+     * */
+    fetchingTechnique?: 'chunk' | 'one_by_one';
+
+    /**
+     * Can be used for fields having `isVirtualField: true` in schema.
+     * */
+    fetchingTechniqueSettings?: {
+        /** Default : 1000 */
+        chunkSize?: number;
+    }
 }
 
 export interface IDeepFormat extends IApiParamsDeepFormat {
@@ -689,7 +737,7 @@ export interface IArrayOperationBody {
 export interface IArrayOperation {
     operation?: EArrayOperation;
     path?: string;
-    dataToPush?: any[]; // $push, used for push operation. Array/Object of data to pushe in array.
+    dataToPush?: any[]; // $push, used for push operation. Array/Object of data to push in array.
     queryToRemove?: any; // $pull, query to remove docs from array.
     dataToPull?: any[]; // $pullAll, array of items which will be removed from array.
     direction?: -1 | 1; // $pop, -1 remove first, 1 remove last.
@@ -740,20 +788,55 @@ export interface ICustomApiSettingsTypes extends IAuthTokenInfoCommon {
     reqQueryParametersSchema?: ISchemaType;
 
     /**
-     * 👉 If true, code will execute on original Node.js process and not in sandbox.<br/>
-     * 👉 It makes code execution fast, Do not use it if you don't know what you are doing.<br/>
-     * 👉 Bad code can make entire server freeze and give weird behaviour.<br/>
-     * 👉 So, it can not use sandbox packages.<br/>
-     * 👉 It can use Node.js inbuilt packages.<br/>
-     * 👉 It can use packages from package.json of api_maker_be.<br/>
-     * 👉 You can use all features of global variable 'g'.<br/>
+     * - If true, code will execute on original Node.js process and not in sandbox.<br/>
+     * - It makes code execution fast, Do not use it if you don't know what you are doing.<br/>
+     * - Bad code can make entire server freeze and give weird behaviour.<br/>
+     * - So, it can not use sandbox packages.<br/>
+     * - It can use Node.js inbuilt packages.<br/>
+     * - It can use packages from package.json of api_maker_be.<br/>
+     * - You can use all features of global variable 'g'.<br/>
      */
     runOnNativeProcess?: boolean;
 
-    // calculated property
-    errorList: string[]; // list of all errors thrown by this API.
-    pathAndRequestMethod?: string;
+    /** list of all errors thrown by this API. */
+    errorList: string[];
     swaggerDocs?: ISwaggerDocsObj;
+
+    /** 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;
+}
+
+export interface ISeparateSandboxSettings {
+    /**
+     * ex: Sandbox_Group_1, system will create separate sandbox for this particular entity and "Automatic Sandbox Restart In Seconds" will have no effect on this sandbox.
+     * All the packages of custom APIs having value "Sandbox_Group_1" will be available during execution.
+     * */
+    enableSeparateSandboxForThis?: string;
+
+    /**
+     * If any "separateSandboxSettings" has value in this, it will be used instead of "Sandbox Settings" DockerFile
+     * */
+    dockerFileOfSandbox?: string;
+
+    /** It works when we have enableSeparateSandboxForThis as true. */
+    packages?: {
+        /** If true, this sandbox will have all the packages of admin. */
+        allowAllPackagesOfAdmin?: boolean;
+
+        /** If allowAllPackagesOfAdmin == false, then this settings will be applicable and these packages will be installed on this particular sandbox. */
+        sandboxPackages?: {
+            name: string;
+            version: string;
+        }[];
+    }
+
+    /** Sandbox will be restarted automatically based on these settings without failing any request. */
+    autoRestart?: {
+        /**
+         * - It will work when enableSeparateSandboxForThis is true. <br/>
+         * - Sandbox will be restarted after it passes these much of time, after its creation. */
+        afterTheseMuchSeconds?: number;
+    }
 }
 
 export interface ISwaggerDocsObj {
@@ -776,7 +859,7 @@ export interface ISwaggerParametersEntity {
         example?: any,
         default?: any;
         enum?: any[];
-    }
+    };
 }
 
 export enum ESwaggerParamInType {
@@ -1270,6 +1353,8 @@ export interface ICodeRunByResponse {
     workerId: string;
     port: number;
     publishToRedis?: boolean; // true = if request received by redis.
+    enableSeparateSandboxForThis: string;
+    allowAllPackagesOfAdmin: boolean;
 }
 
 export interface IAPIAccessGroupMeta {

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

@@ -27,5 +27,5 @@
 </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-6EAL64PA.js" type="module"></script><script src="main-TYGVEM3B.js" type="module"></script></body>
+<script src="polyfills-6EAL64PA.js" type="module"></script><script src="main-CEUXXN7K.js" type="module"></script></body>
 </html>