@futdevpro/nts-dynamo 1.10.49 → 1.10.50

package/.github/workflows/main.yml

@@ -20,8 +20,12 @@ jobs:
   notification0:
     name: Discord start Notification
     runs-on: ubuntu-latest
+    outputs:
+      start: ${{ steps.mark_start.outputs.started }}
     steps:
     - uses: actions/checkout@master
+    - id: mark_start
+      run: echo "started=$(date +%s)" >> "$GITHUB_OUTPUT"
     - name: send custom message with args
       uses: appleboy/discord-action@master
       with:
@@ -247,6 +251,12 @@ jobs:
         echo "THIS_VERSION=$RAW_THIS_VERSION" >> $GITHUB_ENV
   
     - uses: actions/checkout@master
+    - id: duration
+      run: |
+        START_TIME=${{ needs.notification0.outputs.start }}
+        END_TIME=$(date +%s)
+        DIFF=$((END_TIME - START_TIME))
+        echo "human=$(printf '%dm %ds' $((DIFF/60)) $((DIFF%60)))" >> "$GITHUB_OUTPUT"
     - name: send custom message with args
       uses: appleboy/discord-action@master
       with:
@@ -262,6 +272,7 @@ jobs:
           - ${{ needs.deploy.result == 'failure' && ':cross_mark:' || needs.deploy.result == 'success' && ':white_check_mark:' || needs.deploy.result == 'skipped' && ':zzz:' || ':question:' }}
           Deploy: ${{ needs.deploy.result }} (${{ env.THIS_VERSION }}) 
           ${{ needs.deploy.result == 'success' && ':rocket:' || '' }}\n\
+          :stopwatch: Duration: ${{ steps.duration.outputs.human }}\n\
           :cd: (${{ github.run_number }}) [:link:](
             https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})"
 

package/build/_collections/archive.util.d.ts

@@ -1,3 +1,13 @@
+/** Suffix appended to database names when archived. */
 export declare const DyNTS_archiveSuffix = "archived";
+/**
+ * Create the archive database name for a given base database.
+ *
+ * @example
+ * ```ts
+ * const name = DyNTS_getArchivedDBName('users');
+ * // => 'users_archived'
+ * ```
+ */
 export declare function DyNTS_getArchivedDBName(dbName: string): string;
 //# sourceMappingURL=archive.util.d.ts.map

package/build/_collections/archive.util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"archive.util.d.ts","sourceRoot":"","sources":["../../src/_collections/archive.util.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,mBAAmB,aAAa,CAAC;AAE9C,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE9D"}
+{"version":3,"file":"archive.util.d.ts","sourceRoot":"","sources":["../../src/_collections/archive.util.ts"],"names":[],"mappings":"AAEA,uDAAuD;AACvD,eAAO,MAAM,mBAAmB,aAAa,CAAC;AAE9C;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE9D"}

package/build/_collections/archive.util.js

@@ -1,7 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DyNTS_getArchivedDBName = exports.DyNTS_archiveSuffix = void 0;
+/** Suffix appended to database names when archived. */
 exports.DyNTS_archiveSuffix = 'archived';
+/**
+ * Create the archive database name for a given base database.
+ *
+ * @example
+ * ```ts
+ * const name = DyNTS_getArchivedDBName('users');
+ * // => 'users_archived'
+ * ```
+ */
 function DyNTS_getArchivedDBName(dbName) {
     return `${dbName}_${exports.DyNTS_archiveSuffix}`;
 }

package/build/_collections/archive.util.js.map

@@ -1 +1 @@
-{"version":3,"file":"archive.util.js","sourceRoot":"","sources":["../../src/_collections/archive.util.ts"],"names":[],"mappings":";;;AAGa,QAAA,mBAAmB,GAAG,UAAU,CAAC;AAE9C,SAAgB,uBAAuB,CAAC,MAAc;IACpD,OAAO,GAAG,MAAM,IAAI,2BAAmB,EAAE,CAAC;AAC5C,CAAC;AAFD,0DAEC"}
+{"version":3,"file":"archive.util.js","sourceRoot":"","sources":["../../src/_collections/archive.util.ts"],"names":[],"mappings":";;;AAEA,uDAAuD;AAC1C,QAAA,mBAAmB,GAAG,UAAU,CAAC;AAE9C;;;;;;;;GAQG;AACH,SAAgB,uBAAuB,CAAC,MAAc;IACpD,OAAO,GAAG,MAAM,IAAI,2BAAmB,EAAE,CAAC;AAC5C,CAAC;AAFD,0DAEC"}

package/build/_collections/global-settings.const.d.ts

@@ -1,3 +1,7 @@
 import { DyNTS_Global_Settings } from '../_models/interfaces/global-settings.interface';
+/**
+ * Default configuration used across the NodeTS framework.
+ * These values can be overridden when bootstrapping the server.
+ */
 export declare const DyNTS_global_settings: DyNTS_Global_Settings;
 //# sourceMappingURL=global-settings.const.d.ts.map

package/build/_collections/global-settings.const.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"global-settings.const.d.ts","sourceRoot":"","sources":["../../src/_collections/global-settings.const.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,qBAAqB,EAAE,MAAM,iDAAiD,CAAC;AAGxF,eAAO,MAAM,qBAAqB,EAAE,qBAoCnC,CAAC"}
+{"version":3,"file":"global-settings.const.d.ts","sourceRoot":"","sources":["../../src/_collections/global-settings.const.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,qBAAqB,EAAE,MAAM,iDAAiD,CAAC;AAGxF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,qBAoCnC,CAAC"}

package/build/_collections/global-settings.const.js

@@ -4,6 +4,10 @@ exports.DyNTS_global_settings = void 0;
 const fsm_dynamo_1 = require("@futdevpro/fsm-dynamo");
 const route_security_enum_1 = require("../_enums/route-security.enum");
 const socket_security_enum_1 = require("../_modules/socket/_enums/socket-security.enum");
+/**
+ * Default configuration used across the NodeTS framework.
+ * These values can be overridden when bootstrapping the server.
+ */
 exports.DyNTS_global_settings = {
     baseUrl: '/api',
     systemVersion: 'unknown-version',

package/build/_collections/global-settings.const.js.map

@@ -1 +1 @@
-{"version":3,"file":"global-settings.const.js","sourceRoot":"","sources":["../../src/_collections/global-settings.const.ts"],"names":[],"mappings":";;;AACA,sDAAuF;AAEvF,uEAAoE;AAEpE,yFAAsF;AAEzE,QAAA,qBAAqB,GAA0B;IAC1D,OAAO,EAAE,MAAM;IACf,aAAa,EAAE,iBAAiB;IAChC,oBAAoB,EAAE,yCAAmB,CAAC,IAAI;IAC9C,qBAAqB,EAAE,2CAAoB,CAAC,IAAI;IAChD,eAAe,EAAE,EAAE;IACnB,oCAAoC,EAAE,IAAI;IAC1C,gBAAgB,EAAE,GAAG;IACrB,WAAW,EAAE,qCAAwB,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAA2B,CAAC,CAAC,CAAC;QACvF,OAAO,CAAC,GAAG,CAAC,WAAmC,CAAC,CAAC;QACjD,iCAAoB,CAAC,KAAK;IAE5B,YAAY,EAAE;QACZ,gBAAgB,EAAE,KAAK;QAEvB,KAAK,EAAE,KAAK;QAEZ,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,KAAK;QACtB,eAAe,EAAE,KAAK;QACtB,oBAAoB,EAAE,KAAK;QAE3B,gBAAgB,EAAE,IAAI;QACtB,iBAAiB,EAAE,IAAI;QACvB,mBAAmB,EAAE,KAAK;QAE1B,UAAU,EAAE,IAAI;QAChB,mBAAmB,EAAE,KAAK;QAC1B,mBAAmB,EAAE,KAAK;QAC1B,oBAAoB,EAAE,KAAK;QAC3B,UAAU,EAAE,IAAI;QAEhB,cAAc,EAAE,KAAK;QAErB,YAAY,EAAE,KAAK;KACpB;CACF,CAAC"}
+{"version":3,"file":"global-settings.const.js","sourceRoot":"","sources":["../../src/_collections/global-settings.const.ts"],"names":[],"mappings":";;;AACA,sDAAuF;AAEvF,uEAAoE;AAEpE,yFAAsF;AAEtF;;;GAGG;AACU,QAAA,qBAAqB,GAA0B;IAC1D,OAAO,EAAE,MAAM;IACf,aAAa,EAAE,iBAAiB;IAChC,oBAAoB,EAAE,yCAAmB,CAAC,IAAI;IAC9C,qBAAqB,EAAE,2CAAoB,CAAC,IAAI;IAChD,eAAe,EAAE,EAAE;IACnB,oCAAoC,EAAE,IAAI;IAC1C,gBAAgB,EAAE,GAAG;IACrB,WAAW,EAAE,qCAAwB,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAA2B,CAAC,CAAC,CAAC;QACvF,OAAO,CAAC,GAAG,CAAC,WAAmC,CAAC,CAAC;QACjD,iCAAoB,CAAC,KAAK;IAE5B,YAAY,EAAE;QACZ,gBAAgB,EAAE,KAAK;QAEvB,KAAK,EAAE,KAAK;QAEZ,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,KAAK;QACtB,eAAe,EAAE,KAAK;QACtB,oBAAoB,EAAE,KAAK;QAE3B,gBAAgB,EAAE,IAAI;QACtB,iBAAiB,EAAE,IAAI;QACvB,mBAAmB,EAAE,KAAK;QAE1B,UAAU,EAAE,IAAI;QAChB,mBAAmB,EAAE,KAAK;QAC1B,mBAAmB,EAAE,KAAK;QAC1B,oBAAoB,EAAE,KAAK;QAC3B,UAAU,EAAE,IAAI;QAEhB,cAAc,EAAE,KAAK;QAErB,YAAY,EAAE,KAAK;KACpB;CACF,CAAC"}

package/build/_enums/data-model-type.enum.d.ts

@@ -1,9 +1,9 @@
 /**
- * DataModelType is declaring where the data type is used
+ * Declares where a given model definition is used.
  *
- * dataModel: used in DB
- * controlModel: used only in runtime
- * interfaceModel: used only in runtime and doesnt need constructor
+ * - `dataModel`: persisted in the database
+ * - `controlModel`: runtime only
+ * - `interfaceModel`: runtime without constructor
  */
 /** @deprecated */
 export declare enum DyNTS_DataModelType {

package/build/_enums/data-model-type.enum.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DyNTS_DataModelType = void 0;
 /**
- * DataModelType is declaring where the data type is used
+ * Declares where a given model definition is used.
  *
- * dataModel: used in DB
- * controlModel: used only in runtime
- * interfaceModel: used only in runtime and doesnt need constructor
+ * - `dataModel`: persisted in the database
+ * - `controlModel`: runtime only
+ * - `interfaceModel`: runtime without constructor
  */
 /** @deprecated */
 var DyNTS_DataModelType;

package/build/_enums/data-service-function.enum.d.ts

@@ -1,13 +1,19 @@
 /**
- * DataServiceFunctions
+ * Commonly used operations within data services.
  *
- * #unconnected TODO
+ * Each value represents a standard CRUD style method
+ * that can be implemented by a service.
  */
 export declare enum DyNTS_DSF {
+    /** Retrieve all documents from the store. */
     getAll = "getAll",
+    /** Load a single document by its identifier. */
     getDataById = "getDataById",
+    /** Update an existing document. */
     modifyData = "modifyData",
+    /** Remove a document. */
     deleteData = "deleteData",
+    /** Return data supplied directly rather than fetched. */
     getProvidedData = "getProvidedData"
 }
 //# sourceMappingURL=data-service-function.enum.d.ts.map

package/build/_enums/data-service-function.enum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data-service-function.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/data-service-function.enum.ts"],"names":[],"mappings":"AACA;;;;GAIG;AACH,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAG3B,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,eAAe,oBAAoB;CACpC"}
+{"version":3,"file":"data-service-function.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/data-service-function.enum.ts"],"names":[],"mappings":"AACA;;;;;GAKG;AACH,oBAAY,SAAS;IACnB,6CAA6C;IAC7C,MAAM,WAAW;IAEjB,gDAAgD;IAChD,WAAW,gBAAgB;IAG3B,mCAAmC;IACnC,UAAU,eAAe;IAEzB,yBAAyB;IACzB,UAAU,eAAe;IAEzB,yDAAyD;IACzD,eAAe,oBAAoB;CACpC"}

package/build/_enums/data-service-function.enum.js

@@ -2,18 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DyNTS_DSF = void 0;
 /**
- * DataServiceFunctions
+ * Commonly used operations within data services.
  *
- * #unconnected TODO
+ * Each value represents a standard CRUD style method
+ * that can be implemented by a service.
  */
 var DyNTS_DSF;
 (function (DyNTS_DSF) {
+    /** Retrieve all documents from the store. */
     DyNTS_DSF["getAll"] = "getAll";
+    /** Load a single document by its identifier. */
     DyNTS_DSF["getDataById"] = "getDataById";
     /* checkIfDataExists = 'checkIfDataExists',
     createData = 'createNewData', */
+    /** Update an existing document. */
     DyNTS_DSF["modifyData"] = "modifyData";
+    /** Remove a document. */
     DyNTS_DSF["deleteData"] = "deleteData";
+    /** Return data supplied directly rather than fetched. */
     DyNTS_DSF["getProvidedData"] = "getProvidedData";
 })(DyNTS_DSF || (exports.DyNTS_DSF = DyNTS_DSF = {}));
 //# sourceMappingURL=data-service-function.enum.js.map

package/build/_enums/data-service-function.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-service-function.enum.js","sourceRoot":"","sources":["../../src/_enums/data-service-function.enum.ts"],"names":[],"mappings":";;;AACA;;;;GAIG;AACH,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,wCAA2B,CAAA;IAC3B;oCACgC;IAChC,sCAAyB,CAAA;IACzB,sCAAyB,CAAA;IACzB,gDAAmC,CAAA;AACrC,CAAC,EARW,SAAS,yBAAT,SAAS,QAQpB"}
+{"version":3,"file":"data-service-function.enum.js","sourceRoot":"","sources":["../../src/_enums/data-service-function.enum.ts"],"names":[],"mappings":";;;AACA;;;;;GAKG;AACH,IAAY,SAgBX;AAhBD,WAAY,SAAS;IACnB,6CAA6C;IAC7C,8BAAiB,CAAA;IAEjB,gDAAgD;IAChD,wCAA2B,CAAA;IAC3B;oCACgC;IAChC,mCAAmC;IACnC,sCAAyB,CAAA;IAEzB,yBAAyB;IACzB,sCAAyB,CAAA;IAEzB,yDAAyD;IACzD,gDAAmC,CAAA;AACrC,CAAC,EAhBW,SAAS,yBAAT,SAAS,QAgBpB"}

package/build/_enums/predefined-data-types.enum.d.ts

@@ -1,5 +1,6 @@
 /**
- * the most basic data types
+ * A small set of primitive data type names used when
+ * describing field types in various models.
  */
 export declare enum DyanmoNTS_PredefinedDataTypes {
     'string' = 0,
@@ -9,19 +10,7 @@ export declare enum DyanmoNTS_PredefinedDataTypes {
     'object' = 4
 }
 /**
- * 'null' | 'boolean' | 'number' | 'string' | 'array' | 'object' |
- * 'date' | 'objectId' | 'mixed' | 'decimal128' | 'buffer' | 'map' |
- * 'documentArray' | 'embedded' | 'array' | 'objectId' | 'string' |
- * 'number' | 'boolean' | 'date' | 'buffer' | 'mixed' | 'decimal128' |
- * 'map' | 'documentArray' | 'embedded' | 'array' | 'objectId' |
- * 'string' | 'number' | 'boolean' | 'date' | 'buffer' | 'mixed' |
- * 'decimal128' | 'map' | 'documentArray' | 'embedded' | 'array' |
- * 'objectId' | 'string' | 'number' | 'boolean' | 'date' | 'buffer' |
- * 'mixed' | 'decimal128' | 'map' | 'documentArray' | 'embedded' |
- * 'array' | 'objectId' | 'string' | 'number' | 'boolean' | 'date' |
- * 'buffer' | 'mixed' | 'decimal128' | 'map' | 'documentArray' |
- * 'embedded' | 'array' | 'objectId' | 'string' | 'number' | 'boolean' |
- * 'date' | 'buffer' | 'mixed' | 'decimal128' | 'map' | 'documentArray' |
- * 'embedded'
+ * Full list of complex types supported by the framework
+ * when interacting with the database.
  */ 
 //# sourceMappingURL=predefined-data-types.enum.d.ts.map

package/build/_enums/predefined-data-types.enum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"predefined-data-types.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/predefined-data-types.enum.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,oBAAY,6BAA6B;IACvC,QAAQ,IAAA;IACR,QAAQ,IAAA;IACR,SAAS,IAAA;IACT,MAAM,IAAA;IACN,QAAQ,IAAA;CACT;AAED;;;;;;;;;;;;;;;GAeG"}
+{"version":3,"file":"predefined-data-types.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/predefined-data-types.enum.ts"],"names":[],"mappings":"AACA;;;GAGG;AACH,oBAAY,6BAA6B;IACvC,QAAQ,IAAA;IACR,QAAQ,IAAA;IACR,SAAS,IAAA;IACT,MAAM,IAAA;IACN,QAAQ,IAAA;CACT;AAED;;;GAGG"}

package/build/_enums/predefined-data-types.enum.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DyanmoNTS_PredefinedDataTypes = void 0;
 /**
- * the most basic data types
+ * A small set of primitive data type names used when
+ * describing field types in various models.
  */
 var DyanmoNTS_PredefinedDataTypes;
 (function (DyanmoNTS_PredefinedDataTypes) {
@@ -13,19 +14,7 @@ var DyanmoNTS_PredefinedDataTypes;
     DyanmoNTS_PredefinedDataTypes[DyanmoNTS_PredefinedDataTypes["object"] = 4] = "object";
 })(DyanmoNTS_PredefinedDataTypes || (exports.DyanmoNTS_PredefinedDataTypes = DyanmoNTS_PredefinedDataTypes = {}));
 /**
- * 'null' | 'boolean' | 'number' | 'string' | 'array' | 'object' |
- * 'date' | 'objectId' | 'mixed' | 'decimal128' | 'buffer' | 'map' |
- * 'documentArray' | 'embedded' | 'array' | 'objectId' | 'string' |
- * 'number' | 'boolean' | 'date' | 'buffer' | 'mixed' | 'decimal128' |
- * 'map' | 'documentArray' | 'embedded' | 'array' | 'objectId' |
- * 'string' | 'number' | 'boolean' | 'date' | 'buffer' | 'mixed' |
- * 'decimal128' | 'map' | 'documentArray' | 'embedded' | 'array' |
- * 'objectId' | 'string' | 'number' | 'boolean' | 'date' | 'buffer' |
- * 'mixed' | 'decimal128' | 'map' | 'documentArray' | 'embedded' |
- * 'array' | 'objectId' | 'string' | 'number' | 'boolean' | 'date' |
- * 'buffer' | 'mixed' | 'decimal128' | 'map' | 'documentArray' |
- * 'embedded' | 'array' | 'objectId' | 'string' | 'number' | 'boolean' |
- * 'date' | 'buffer' | 'mixed' | 'decimal128' | 'map' | 'documentArray' |
- * 'embedded'
+ * Full list of complex types supported by the framework
+ * when interacting with the database.
  */ 
 //# sourceMappingURL=predefined-data-types.enum.js.map

package/build/_enums/predefined-data-types.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"predefined-data-types.enum.js","sourceRoot":"","sources":["../../src/_enums/predefined-data-types.enum.ts"],"names":[],"mappings":";;;AACA;;GAEG;AACH,IAAY,6BAMX;AAND,WAAY,6BAA6B;IACvC,qFAAQ,CAAA;IACR,qFAAQ,CAAA;IACR,uFAAS,CAAA;IACT,iFAAM,CAAA;IACN,qFAAQ,CAAA;AACV,CAAC,EANW,6BAA6B,6CAA7B,6BAA6B,QAMxC;AAED;;;;;;;;;;;;;;;GAeG"}
+{"version":3,"file":"predefined-data-types.enum.js","sourceRoot":"","sources":["../../src/_enums/predefined-data-types.enum.ts"],"names":[],"mappings":";;;AACA;;;GAGG;AACH,IAAY,6BAMX;AAND,WAAY,6BAA6B;IACvC,qFAAQ,CAAA;IACR,qFAAQ,CAAA;IACR,uFAAS,CAAA;IACT,iFAAM,CAAA;IACN,qFAAQ,CAAA;AACV,CAAC,EANW,6BAA6B,6CAA7B,6BAA6B,QAMxC;AAED;;;GAGG"}

package/build/_models/control-models/app-params.control-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app-params.control-model.d.ts","sourceRoot":"","sources":["../../../src/_models/control-models/app-params.control-model.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C;;GAEG;AACH,qBAAa,gBAAgB;IAC3B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,cAAc,CAElC;IAED,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;gBAGpC,GAAG,EAAE,gBAAgB;CAqCxB"}
+{"version":3,"file":"app-params.control-model.d.ts","sourceRoot":"","sources":["../../../src/_models/control-models/app-params.control-model.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C;;GAEG;AACH,qBAAa,gBAAgB;IAC3B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC;IAEpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;gBAGpC,GAAG,EAAE,gBAAgB;CAwCxB"}

package/build/_models/control-models/app-params.control-model.js

@@ -33,9 +33,7 @@ class DyNTS_App_Params {
     /**
      * options for the MongoDB connection
      */
-    dbOptions = {
-        directConnection: true,
-    };
+    dbOptions;
     openHost;
     secureHost;
     expressBacklog;
@@ -53,6 +51,9 @@ class DyNTS_App_Params {
         this.version = set.version;
         this.dbName = set.dbName;
         this.dbUri = set.dbUri ?? `mongodb://localhost:27017/${this.dbName}`;
+        this.dbOptions = set.dbOptions ?? {
+            directConnection: true,
+        };
         this.systemName = set.systemName ?? this.name.replace(' ', '-');
         this.systemShortCodeName = set.systemShortCodeName ?? this.systemName.replace(/[^A-Z]/g, '');
         this.openHost = set.openHost ?? 'localhost';

package/build/_models/control-models/app-params.control-model.js.map

@@ -1 +1 @@
-{"version":3,"file":"app-params.control-model.js","sourceRoot":"","sources":["../../../src/_models/control-models/app-params.control-model.ts"],"names":[],"mappings":";;;AAAA,sDAAiD;AAGjD;;GAEG;AACH,MAAa,gBAAgB;IAC3B;;OAEG;IACM,IAAI,CAAS;IACtB;;OAEG;IACM,KAAK,CAAU;IACxB;;;;;OAKG;IACM,OAAO,CAAS;IAEzB;;;OAGG;IACM,KAAK,CAAU;IACxB;;OAEG;IACM,MAAM,CAAU;IACzB;;OAEG;IACM,SAAS,GAAoB;QACpC,gBAAgB,EAAE,IAAI;KACvB,CAAA;IAEQ,QAAQ,CAAU;IAClB,UAAU,CAAU;IACpB,cAAc,CAAU;IAEjC;;OAEG;IACM,UAAU,CAAU;IAC7B;;OAEG;IACM,mBAAmB,CAAU;IAEtC,YACE,GAAqB;QAErB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,IAAI,6BAA6B,IAAI,CAAC,MAAM,EAAE,CAAC;QACrE,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAChE,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAC7F,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,WAAW,CAAC;QAC5C,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,IAAI,WAAW,CAAC;QAChD,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,IAAI,CAAC,CAAC;QAE9C,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,qBAAQ,CAAC,KAAK,CACZ,gCAAgC;gBAChC,yBAAyB,IAAI,CAAC,IAAI,UAAU;gBAC5C,2BAA2B,CAC5B,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,qBAAQ,CAAC,IAAI,CACX,gCAAgC;gBAChC,sCAAsC,IAAI,CAAC,MAAM,UAAU;gBAC3D,2BAA2B,CAC5B,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,qBAAQ,CAAC,IAAI,CACX,gCAAgC;gBAChC,qCAAqC,IAAI,CAAC,MAAM,UAAU;gBAC1D,2BAA2B,CAC5B,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AApFD,4CAoFC;AAED;;;;;;IAMI"}
+{"version":3,"file":"app-params.control-model.js","sourceRoot":"","sources":["../../../src/_models/control-models/app-params.control-model.ts"],"names":[],"mappings":";;;AAAA,sDAAiD;AAGjD;;GAEG;AACH,MAAa,gBAAgB;IAC3B;;OAEG;IACM,IAAI,CAAS;IACtB;;OAEG;IACM,KAAK,CAAU;IACxB;;;;;OAKG;IACM,OAAO,CAAS;IAEzB;;;OAGG;IACM,KAAK,CAAU;IACxB;;OAEG;IACM,MAAM,CAAU;IACzB;;OAEG;IACM,SAAS,CAAkB;IAE3B,QAAQ,CAAU;IAClB,UAAU,CAAU;IACpB,cAAc,CAAU;IAEjC;;OAEG;IACM,UAAU,CAAU;IAC7B;;OAEG;IACM,mBAAmB,CAAU;IAEtC,YACE,GAAqB;QAErB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,IAAI,6BAA6B,IAAI,CAAC,MAAM,EAAE,CAAC;QACrE,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,IAAI;YAChC,gBAAgB,EAAE,IAAI;SACvB,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAChE,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAC7F,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,WAAW,CAAC;QAC5C,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,IAAI,WAAW,CAAC;QAChD,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,IAAI,CAAC,CAAC;QAE9C,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,qBAAQ,CAAC,KAAK,CACZ,gCAAgC;gBAChC,yBAAyB,IAAI,CAAC,IAAI,UAAU;gBAC5C,2BAA2B,CAC5B,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,qBAAQ,CAAC,IAAI,CACX,gCAAgC;gBAChC,sCAAsC,IAAI,CAAC,MAAM,UAAU;gBAC3D,2BAA2B,CAC5B,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,qBAAQ,CAAC,IAAI,CACX,gCAAgC;gBAChC,qCAAqC,IAAI,CAAC,MAAM,UAAU;gBAC1D,2BAA2B,CAC5B,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AArFD,4CAqFC;AAED;;;;;;IAMI"}

package/build/_services/shared.static-service.d.ts

@@ -2,31 +2,35 @@ import { Request } from 'express';
 import { DyFM_Shared } from '@futdevpro/fsm-dynamo';
 import { DyFM_GeoIpLocation } from '@futdevpro/fsm-dynamo/location';
 /**
- *
+ * Collection of static helper utilities shared across modules.
  */
 export declare class DyNTS_Shared extends DyFM_Shared {
     /**
+     * Extract the IP address from an Express request.
      *
-     * @param request
-     * @returns
+     * @param request Incoming HTTP request
+     * @returns Resolved IP string
      */
     static getIpFromRequest(request: Request): string;
     /**
+     * Lookup the Geo location of a request based on its IP address.
      *
-     * @param request
-     * @returns
+     * @param request Incoming request
+     * @returns Resolved geo location information
      */
     static getLocationDataByRequest(request: Request): DyFM_GeoIpLocation;
     /**
+     * Lookup the Geo location of a raw IP address.
      *
-     * @param request
-     * @returns
+     * @param ip IP address string
+     * @returns Geo location information
      */
     static getLocationByIp(ip: string): DyFM_GeoIpLocation;
     /**
+     * Simple CLI helper to prompt the user for input.
      *
-     * @param question
-     * @returns
+     * @param question Text displayed to the user
+     * @returns Entered string value
      */
     static prompt(question: string): Promise<string>;
 }

package/build/_services/shared.static-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.static-service.d.ts","sourceRoot":"","sources":["../../src/_services/shared.static-service.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAE3C;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IAejD;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,GAAG,kBAAkB;IAIrE;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,kBAAkB;IAItD;;;;OAIG;WACU,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAiBvD"}
+{"version":3,"file":"shared.static-service.d.ts","sourceRoot":"","sources":["../../src/_services/shared.static-service.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAE3C;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IAejD;;;;;OAKG;IACH,MAAM,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,GAAG,kBAAkB;IAIrE;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,kBAAkB;IAItD;;;;;OAKG;WACU,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAiBvD"}

package/build/_services/shared.static-service.js

@@ -6,13 +6,14 @@ const ReadLine = tslib_1.__importStar(require("readline"));
 const GeoIp = tslib_1.__importStar(require("geoip-lite"));
 const fsm_dynamo_1 = require("@futdevpro/fsm-dynamo");
 /**
- *
+ * Collection of static helper utilities shared across modules.
  */
 class DyNTS_Shared extends fsm_dynamo_1.DyFM_Shared {
     /**
+     * Extract the IP address from an Express request.
      *
-     * @param request
-     * @returns
+     * @param request Incoming HTTP request
+     * @returns Resolved IP string
      */
     static getIpFromRequest(request) {
         let ip;
@@ -27,25 +28,28 @@ class DyNTS_Shared extends fsm_dynamo_1.DyFM_Shared {
         return ip;
     }
     /**
+     * Lookup the Geo location of a request based on its IP address.
      *
-     * @param request
-     * @returns
+     * @param request Incoming request
+     * @returns Resolved geo location information
      */
     static getLocationDataByRequest(request) {
         return GeoIp.lookup(this.getIpFromRequest(request));
     }
     /**
+     * Lookup the Geo location of a raw IP address.
      *
-     * @param request
-     * @returns
+     * @param ip IP address string
+     * @returns Geo location information
      */
     static getLocationByIp(ip) {
         return GeoIp.lookup(ip);
     }
     /**
+     * Simple CLI helper to prompt the user for input.
      *
-     * @param question
-     * @returns
+     * @param question Text displayed to the user
+     * @returns Entered string value
      */
     static async prompt(question) {
         const readLine = ReadLine.createInterface({

package/build/_services/shared.static-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"shared.static-service.js","sourceRoot":"","sources":["../../src/_services/shared.static-service.ts"],"names":[],"mappings":";;;;AACA,2DAAqC;AACrC,0DAAoC;AAGpC,sDAAoD;AAGpD;;GAEG;AACH,MAAa,YAAa,SAAQ,wBAAW;IAE3C;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAgB;QACtC,IAAI,EAAU,CAAC;QAEf,IAAI,OAAO,EAAE,OAAO,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC1C,MAAM,KAAK,GAAc,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAEnF,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;YACrC,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC;QACpC,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,CAAC,OAAgB;QAC9C,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,EAAU;QAC/B,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAgB;QAClC,MAAM,QAAQ,GAAG,QAAQ,CAAC,eAAe,CAAC;YACxC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QAEH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC;gBACH,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,MAAc,EAAE,EAAE;oBAC7C,OAAO,CAAC,MAAM,CAAC,CAAC;oBAChB,QAAQ,CAAC,KAAK,EAAE,CAAC;gBACnB,CAAC,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA9DD,oCA8DC"}
+{"version":3,"file":"shared.static-service.js","sourceRoot":"","sources":["../../src/_services/shared.static-service.ts"],"names":[],"mappings":";;;;AACA,2DAAqC;AACrC,0DAAoC;AAGpC,sDAAoD;AAGpD;;GAEG;AACH,MAAa,YAAa,SAAQ,wBAAW;IAE3C;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAgB;QACtC,IAAI,EAAU,CAAC;QAEf,IAAI,OAAO,EAAE,OAAO,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC1C,MAAM,KAAK,GAAc,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAEnF,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;YACrC,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC;QACpC,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,wBAAwB,CAAC,OAAgB;QAC9C,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,EAAU;QAC/B,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAgB;QAClC,MAAM,QAAQ,GAAG,QAAQ,CAAC,eAAe,CAAC;YACxC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QAEH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC;gBACH,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,MAAc,EAAE,EAAE;oBAC7C,OAAO,CAAC,MAAM,CAAC,CAAC;oBAChB,QAAQ,CAAC,KAAK,EAAE,CAAC;gBACnB,CAAC,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAlED,oCAkEC"}

package/build/index.d.ts

@@ -1,13 +1,44 @@
+/**
+ * Utility helpers for dealing with archived collections.
+ *
+ * @example
+ * ```ts
+ * const name = DyNTS_getArchivedDBName('users');
+ * // => 'users_archived'
+ * ```
+ */
 export * from './_collections/archive.util';
+/**
+ * Common application wide settings used across the framework.
+ *
+ * @example
+ * ```ts
+ * console.log(DyNTS_global_settings.baseUrl);
+ * ```
+ */
 export * from './_collections/global-settings.const';
+/**
+ * Enumerations describing model usage locations.
+ */
 export * from './_enums/data-model-type.enum';
+/**
+ * Enumerations listing the supported service function names.
+ */
 export * from './_enums/data-service-function.enum';
+/**
+ * Common primitive data types used in models.
+ */
 export * from './_enums/predefined-data-types.enum';
+/**
+ * Defines if routes should use HTTP, HTTPS or both.
+ */
 export * from './_enums/route-security.enum';
+/** Interfaces describing global configuration and certificates. */
 export * from './_models/interfaces/certification-settings.interface';
 export * from './_models/interfaces/global-service-settings.interface';
 export * from './_models/interfaces/global-settings.interface';
 export * from './_models/interfaces/routing-module-settings.interface';
+/** Classes defining runtime structures without database persistence. */
 export * from './_models/control-models/api-call-params.control-model';
 export * from './_models/control-models/app-ext-system-controls.control-model';
 export * from './_models/control-models/app-params.control-model';
@@ -15,19 +46,34 @@ export * from './_models/control-models/app-system-controls.control-model';
 export * from './_models/control-models/endpoint-params.control-model';
 export * from './_models/control-models/http-settings.control-model';
 export * from './_models/control-models/system-control.control-model';
+/** Types describing MongoDB style update objects. */
 export * from './_models/types/db-update.type';
+/** Client side helper for making HTTP requests. */
 export * from './_services/core/api.service';
+/** Basic authentication helper functions. */
 export * from './_services/core/auth.service';
+/** Utility for sending transactional emails. */
 export * from './_services/core/email.service';
+/** Global service registry and bootstrapping utilities. */
 export * from './_services/core/global.service';
+/** Singleton service container. */
 export * from './_services/core/service-collection.service';
+/** Handles moving data to archive collections. */
 export * from './_services/base/archive-data.service';
+/** Basic CRUD service used by feature modules. */
 export * from './_services/base/data.service';
+/** Thin wrapper around the database driver. */
 export * from './_services/base/db.service';
+/** Base class for implementing singleton services. */
 export * from './_services/base/singleton.service';
+/** Express server wrapper. */
 export * from './_services/server/app.server';
+/** Environment detection helpers. */
 export * from './_services/server/env-set';
+/** Abstract base controller for defining routes. */
 export * from './_services/route/controller.service';
+/** Handles route registration and mounting. */
 export * from './_services/route/routing-module.service';
+/** Assorted shared helpers accessible statically. */
 export * from './_services/shared.static-service';
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sCAAsC,CAAC;AAIrD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,8BAA8B,CAAC;AAK7C,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,wDAAwD,CAAC;AAGvE,cAAc,wDAAwD,CAAC;AACvE,cAAc,gEAAgE,CAAA;AAC9E,cAAc,mDAAmD,CAAC;AAClE,cAAc,4DAA4D,CAAC;AAC3E,cAAc,wDAAwD,CAAC;AACvE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AAGtE,cAAc,gCAAgC,CAAC;AAK/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,6CAA6C,CAAC;AAG5D,cAAc,uCAAuC,CAAC;AACtD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AAGnD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAG3C,cAAc,sCAAsC,CAAC;AACrD,cAAc,0CAA0C,CAAC;AAGzD,cAAc,mCAAmC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,cAAc,6BAA6B,CAAC;AAE5C;;;;;;;GAOG;AACH,cAAc,sCAAsC,CAAC;AAIrD;;GAEG;AACH,cAAc,+BAA+B,CAAC;AAE9C;;GAEG;AACH,cAAc,qCAAqC,CAAC;AAEpD;;GAEG;AACH,cAAc,qCAAqC,CAAC;AAEpD;;GAEG;AACH,cAAc,8BAA8B,CAAC;AAK7C,mEAAmE;AACnE,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,wDAAwD,CAAC;AAIvE,wEAAwE;AACxE,cAAc,wDAAwD,CAAC;AACvE,cAAc,gEAAgE,CAAA;AAC9E,cAAc,mDAAmD,CAAC;AAClE,cAAc,4DAA4D,CAAC;AAC3E,cAAc,wDAAwD,CAAC;AACvE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AAItE,qDAAqD;AACrD,cAAc,gCAAgC,CAAC;AAK/C,mDAAmD;AACnD,cAAc,8BAA8B,CAAC;AAE7C,6CAA6C;AAC7C,cAAc,+BAA+B,CAAC;AAE9C,gDAAgD;AAChD,cAAc,gCAAgC,CAAC;AAE/C,2DAA2D;AAC3D,cAAc,iCAAiC,CAAC;AAEhD,mCAAmC;AACnC,cAAc,6CAA6C,CAAC;AAG5D,kDAAkD;AAClD,cAAc,uCAAuC,CAAC;AAEtD,kDAAkD;AAClD,cAAc,+BAA+B,CAAC;AAE9C,+CAA+C;AAC/C,cAAc,6BAA6B,CAAC;AAE5C,sDAAsD;AACtD,cAAc,oCAAoC,CAAC;AAGnD,8BAA8B;AAC9B,cAAc,+BAA+B,CAAC;AAE9C,qCAAqC;AACrC,cAAc,4BAA4B,CAAC;AAG3C,oDAAoD;AACpD,cAAc,sCAAsC,CAAC;AAErD,+CAA+C;AAC/C,cAAc,0CAA0C,CAAC;AAGzD,qDAAqD;AACrD,cAAc,mCAAmC,CAAC"}

package/build/index.js

@@ -2,20 +2,50 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 // COLLECTIONS
+/**
+ * Utility helpers for dealing with archived collections.
+ *
+ * @example
+ * ```ts
+ * const name = DyNTS_getArchivedDBName('users');
+ * // => 'users_archived'
+ * ```
+ */
 tslib_1.__exportStar(require("./_collections/archive.util"), exports);
+/**
+ * Common application wide settings used across the framework.
+ *
+ * @example
+ * ```ts
+ * console.log(DyNTS_global_settings.baseUrl);
+ * ```
+ */
 tslib_1.__exportStar(require("./_collections/global-settings.const"), exports);
 // ENUMS
+/**
+ * Enumerations describing model usage locations.
+ */
 tslib_1.__exportStar(require("./_enums/data-model-type.enum"), exports);
+/**
+ * Enumerations listing the supported service function names.
+ */
 tslib_1.__exportStar(require("./_enums/data-service-function.enum"), exports);
+/**
+ * Common primitive data types used in models.
+ */
 tslib_1.__exportStar(require("./_enums/predefined-data-types.enum"), exports);
+/**
+ * Defines if routes should use HTTP, HTTPS or both.
+ */
 tslib_1.__exportStar(require("./_enums/route-security.enum"), exports);
 // MODELS (CONTROL-MODELS, INTERFACES, TYPES)
-// models/INTERFACES
+/** Interfaces describing global configuration and certificates. */
 tslib_1.__exportStar(require("./_models/interfaces/certification-settings.interface"), exports);
 tslib_1.__exportStar(require("./_models/interfaces/global-service-settings.interface"), exports);
 tslib_1.__exportStar(require("./_models/interfaces/global-settings.interface"), exports);
 tslib_1.__exportStar(require("./_models/interfaces/routing-module-settings.interface"), exports);
 // models/CONTROL MODELS
+/** Classes defining runtime structures without database persistence. */
 tslib_1.__exportStar(require("./_models/control-models/api-call-params.control-model"), exports);
 tslib_1.__exportStar(require("./_models/control-models/app-ext-system-controls.control-model"), exports);
 tslib_1.__exportStar(require("./_models/control-models/app-params.control-model"), exports);
@@ -24,25 +54,40 @@ tslib_1.__exportStar(require("./_models/control-models/endpoint-params.control-m
 tslib_1.__exportStar(require("./_models/control-models/http-settings.control-model"), exports);
 tslib_1.__exportStar(require("./_models/control-models/system-control.control-model"), exports);
 // models/TYPES
+/** Types describing MongoDB style update objects. */
 tslib_1.__exportStar(require("./_models/types/db-update.type"), exports);
 // SERVICES
 // services/CORE
+/** Client side helper for making HTTP requests. */
 tslib_1.__exportStar(require("./_services/core/api.service"), exports);
+/** Basic authentication helper functions. */
 tslib_1.__exportStar(require("./_services/core/auth.service"), exports);
+/** Utility for sending transactional emails. */
 tslib_1.__exportStar(require("./_services/core/email.service"), exports);
+/** Global service registry and bootstrapping utilities. */
 tslib_1.__exportStar(require("./_services/core/global.service"), exports);
+/** Singleton service container. */
 tslib_1.__exportStar(require("./_services/core/service-collection.service"), exports);
 // services/BASE
+/** Handles moving data to archive collections. */
 tslib_1.__exportStar(require("./_services/base/archive-data.service"), exports);
+/** Basic CRUD service used by feature modules. */
 tslib_1.__exportStar(require("./_services/base/data.service"), exports);
+/** Thin wrapper around the database driver. */
 tslib_1.__exportStar(require("./_services/base/db.service"), exports);
+/** Base class for implementing singleton services. */
 tslib_1.__exportStar(require("./_services/base/singleton.service"), exports);
 // services/SERVER
+/** Express server wrapper. */
 tslib_1.__exportStar(require("./_services/server/app.server"), exports);
+/** Environment detection helpers. */
 tslib_1.__exportStar(require("./_services/server/env-set"), exports);
 // services/ROUTE
+/** Abstract base controller for defining routes. */
 tslib_1.__exportStar(require("./_services/route/controller.service"), exports);
+/** Handles route registration and mounting. */
 tslib_1.__exportStar(require("./_services/route/routing-module.service"), exports);
 // services/SHARED
+/** Assorted shared helpers accessible statically. */
 tslib_1.__exportStar(require("./_services/shared.static-service"), exports);
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,cAAc;AACd,sEAA4C;AAC5C,+EAAqD;AAGrD,QAAQ;AACR,wEAA8C;AAC9C,8EAAoD;AACpD,8EAAoD;AACpD,uEAA6C;AAG7C,6CAA6C;AAC7C,oBAAoB;AACpB,gGAAsE;AACtE,iGAAuE;AACvE,yFAA+D;AAC/D,iGAAuE;AAEvE,wBAAwB;AACxB,iGAAuE;AACvE,yGAA8E;AAC9E,4FAAkE;AAClE,qGAA2E;AAC3E,iGAAuE;AACvE,+FAAqE;AACrE,gGAAsE;AAEtE,eAAe;AACf,yEAA+C;AAG/C,WAAW;AACX,gBAAgB;AAChB,uEAA6C;AAC7C,wEAA8C;AAC9C,yEAA+C;AAC/C,0EAAgD;AAChD,sFAA4D;AAE5D,gBAAgB;AAChB,gFAAsD;AACtD,wEAA8C;AAC9C,sEAA4C;AAC5C,6EAAmD;AAEnD,kBAAkB;AAClB,wEAA8C;AAC9C,qEAA2C;AAE3C,iBAAiB;AACjB,+EAAqD;AACrD,mFAAyD;AAEzD,kBAAkB;AAClB,4EAAkD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,cAAc;AACd;;;;;;;;GAQG;AACH,sEAA4C;AAE5C;;;;;;;GAOG;AACH,+EAAqD;AAGrD,QAAQ;AACR;;GAEG;AACH,wEAA8C;AAE9C;;GAEG;AACH,8EAAoD;AAEpD;;GAEG;AACH,8EAAoD;AAEpD;;GAEG;AACH,uEAA6C;AAG7C,6CAA6C;AAE7C,mEAAmE;AACnE,gGAAsE;AACtE,iGAAuE;AACvE,yFAA+D;AAC/D,iGAAuE;AAEvE,wBAAwB;AAExB,wEAAwE;AACxE,iGAAuE;AACvE,yGAA8E;AAC9E,4FAAkE;AAClE,qGAA2E;AAC3E,iGAAuE;AACvE,+FAAqE;AACrE,gGAAsE;AAEtE,eAAe;AAEf,qDAAqD;AACrD,yEAA+C;AAG/C,WAAW;AACX,gBAAgB;AAChB,mDAAmD;AACnD,uEAA6C;AAE7C,6CAA6C;AAC7C,wEAA8C;AAE9C,gDAAgD;AAChD,yEAA+C;AAE/C,2DAA2D;AAC3D,0EAAgD;AAEhD,mCAAmC;AACnC,sFAA4D;AAE5D,gBAAgB;AAChB,kDAAkD;AAClD,gFAAsD;AAEtD,kDAAkD;AAClD,wEAA8C;AAE9C,+CAA+C;AAC/C,sEAA4C;AAE5C,sDAAsD;AACtD,6EAAmD;AAEnD,kBAAkB;AAClB,8BAA8B;AAC9B,wEAA8C;AAE9C,qCAAqC;AACrC,qEAA2C;AAE3C,iBAAiB;AACjB,oDAAoD;AACpD,+EAAqD;AAErD,+CAA+C;AAC/C,mFAAyD;AAEzD,kBAAkB;AAClB,qDAAqD;AACrD,4EAAkD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@futdevpro/nts-dynamo",
-  "version": "01.10.49",
+  "version": "01.10.50",
   "description": "Dynamic NodeTS (NodeJS-Typescript), MongoDB Backend System Framework by Future Development Program Ltd.",
   "DyBu_settings": {
     "packageType": "server-package",
@@ -136,12 +136,12 @@
   },
   "homepage": "https:/futdevpro.hu/projects/dynamo",
   "DISABLED": {
-    "@futdevpro/fsm-dynamo": "file:../tgz-collection/dynamo-fsm/futdevpro-fsm-dynamo-01.10.38.tgz",
+    "@futdevpro/fsm-dynamo": "file:../tgz-collection/dynamo-fsm/futdevpro-fsm-dynamo-01.10.39.tgz",
     
     "empty": ""
   },
   "peerDependencies": {
-    "@futdevpro/fsm-dynamo": "1.10.38",
+    "@futdevpro/fsm-dynamo": "1.10.39",
 
     "@types/express": "4.17.21",
     "@types/geoip-lite": "~1.4.1",

package/src/_collections/archive.util.ts

@@ -1,8 +1,17 @@
 
 
-
+/** Suffix appended to database names when archived. */
 export const DyNTS_archiveSuffix = 'archived';
 
+/**
+ * Create the archive database name for a given base database.
+ *
+ * @example
+ * ```ts
+ * const name = DyNTS_getArchivedDBName('users');
+ * // => 'users_archived'
+ * ```
+ */
 export function DyNTS_getArchivedDBName(dbName: string): string {
   return `${dbName}_${DyNTS_archiveSuffix}`;
 }

package/src/_collections/global-settings.const.ts

@@ -5,6 +5,10 @@ import { DyNTS_RouteSecurity } from '../_enums/route-security.enum';
 import { DyNTS_Global_Settings } from '../_models/interfaces/global-settings.interface';
 import { DyNTS_SocketSecurity } from '../_modules/socket/_enums/socket-security.enum';
 
+/**
+ * Default configuration used across the NodeTS framework.
+ * These values can be overridden when bootstrapping the server.
+ */
 export const DyNTS_global_settings: DyNTS_Global_Settings = {
   baseUrl: '/api',
   systemVersion: 'unknown-version',

package/src/_enums/data-model-type.enum.ts

@@ -1,10 +1,10 @@
 
 /**
- * DataModelType is declaring where the data type is used
- * 
- * dataModel: used in DB
- * controlModel: used only in runtime
- * interfaceModel: used only in runtime and doesnt need constructor
+ * Declares where a given model definition is used.
+ *
+ * - `dataModel`: persisted in the database
+ * - `controlModel`: runtime only
+ * - `interfaceModel`: runtime without constructor
  */
 /** @deprecated */
 export enum DyNTS_DataModelType {

package/src/_enums/data-service-function.enum.ts

@@ -1,15 +1,24 @@
 
 /**
- * DataServiceFunctions
- * 
- * #unconnected TODO
+ * Commonly used operations within data services.
+ *
+ * Each value represents a standard CRUD style method
+ * that can be implemented by a service.
  */
 export enum DyNTS_DSF {
+  /** Retrieve all documents from the store. */
   getAll = 'getAll',
+
+  /** Load a single document by its identifier. */
   getDataById = 'getDataById',
   /* checkIfDataExists = 'checkIfDataExists',
   createData = 'createNewData', */
+  /** Update an existing document. */
   modifyData = 'modifyData',
+
+  /** Remove a document. */
   deleteData = 'deleteData',
+
+  /** Return data supplied directly rather than fetched. */
   getProvidedData = 'getProvidedData',
 }

package/src/_enums/predefined-data-types.enum.ts

@@ -1,9 +1,10 @@
 
 /**
- * the most basic data types
+ * A small set of primitive data type names used when
+ * describing field types in various models.
  */
 export enum DyanmoNTS_PredefinedDataTypes {
-  'string', 
+  'string',
   'number',
   'boolean',
   'Date',
@@ -11,18 +12,6 @@ export enum DyanmoNTS_PredefinedDataTypes {
 }
 
 /**
- * 'null' | 'boolean' | 'number' | 'string' | 'array' | 'object' | 
- * 'date' | 'objectId' | 'mixed' | 'decimal128' | 'buffer' | 'map' | 
- * 'documentArray' | 'embedded' | 'array' | 'objectId' | 'string' | 
- * 'number' | 'boolean' | 'date' | 'buffer' | 'mixed' | 'decimal128' | 
- * 'map' | 'documentArray' | 'embedded' | 'array' | 'objectId' | 
- * 'string' | 'number' | 'boolean' | 'date' | 'buffer' | 'mixed' | 
- * 'decimal128' | 'map' | 'documentArray' | 'embedded' | 'array' | 
- * 'objectId' | 'string' | 'number' | 'boolean' | 'date' | 'buffer' | 
- * 'mixed' | 'decimal128' | 'map' | 'documentArray' | 'embedded' | 
- * 'array' | 'objectId' | 'string' | 'number' | 'boolean' | 'date' | 
- * 'buffer' | 'mixed' | 'decimal128' | 'map' | 'documentArray' | 
- * 'embedded' | 'array' | 'objectId' | 'string' | 'number' | 'boolean' | 
- * 'date' | 'buffer' | 'mixed' | 'decimal128' | 'map' | 'documentArray' | 
- * 'embedded'
+ * Full list of complex types supported by the framework
+ * when interacting with the database.
  */

package/src/_models/control-models/app-params.control-model.ts

@@ -33,9 +33,7 @@ export class DyNTS_App_Params {
   /**
    * options for the MongoDB connection
    */
-  readonly dbOptions?: ConnectOptions = {
-    directConnection: true,
-  }
+  readonly dbOptions?: ConnectOptions;
 
   readonly openHost?: string;
   readonly secureHost?: string;
@@ -58,6 +56,9 @@ export class DyNTS_App_Params {
     this.version = set.version;
     this.dbName = set.dbName;
     this.dbUri = set.dbUri ?? `mongodb://localhost:27017/${this.dbName}`;
+    this.dbOptions = set.dbOptions ?? {
+      directConnection: true,
+    };
     this.systemName = set.systemName ?? this.name.replace(' ', '-');
     this.systemShortCodeName = set.systemShortCodeName ?? this.systemName.replace(/[^A-Z]/g, '');
     this.openHost = set.openHost ?? 'localhost';

package/src/_services/shared.static-service.ts

@@ -7,14 +7,15 @@ import { DyFM_Shared } from '@futdevpro/fsm-dynamo';
 import { DyFM_GeoIpLocation } from '@futdevpro/fsm-dynamo/location';
 
 /**
- * 
+ * Collection of static helper utilities shared across modules.
  */
 export class DyNTS_Shared extends DyFM_Shared {
 
   /**
-   * 
-   * @param request 
-   * @returns 
+   * Extract the IP address from an Express request.
+   *
+   * @param request Incoming HTTP request
+   * @returns Resolved IP string
    */
   static getIpFromRequest(request: Request): string {
     let ip: string;
@@ -32,27 +33,30 @@ export class DyNTS_Shared extends DyFM_Shared {
   }
 
   /**
-   * 
-   * @param request 
-   * @returns 
+   * Lookup the Geo location of a request based on its IP address.
+   *
+   * @param request Incoming request
+   * @returns Resolved geo location information
    */
   static getLocationDataByRequest(request: Request): DyFM_GeoIpLocation {
     return GeoIp.lookup(this.getIpFromRequest(request));
   }
 
   /**
-   * 
-   * @param request 
-   * @returns 
+   * Lookup the Geo location of a raw IP address.
+   *
+   * @param ip IP address string
+   * @returns Geo location information
    */
   static getLocationByIp(ip: string): DyFM_GeoIpLocation {
     return GeoIp.lookup(ip);
   }
 
   /**
-   * 
-   * @param question 
-   * @returns 
+   * Simple CLI helper to prompt the user for input.
+   *
+   * @param question Text displayed to the user
+   * @returns Entered string value
    */
   static async prompt(question: string): Promise<string> {
     const readLine = ReadLine.createInterface({ 

package/src/index.ts

@@ -1,24 +1,60 @@
 
 // COLLECTIONS
+/**
+ * Utility helpers for dealing with archived collections.
+ *
+ * @example
+ * ```ts
+ * const name = DyNTS_getArchivedDBName('users');
+ * // => 'users_archived'
+ * ```
+ */
 export * from './_collections/archive.util';
+
+/**
+ * Common application wide settings used across the framework.
+ *
+ * @example
+ * ```ts
+ * console.log(DyNTS_global_settings.baseUrl);
+ * ```
+ */
 export * from './_collections/global-settings.const';
 
 
 // ENUMS
+/**
+ * Enumerations describing model usage locations.
+ */
 export * from './_enums/data-model-type.enum';
+
+/**
+ * Enumerations listing the supported service function names.
+ */
 export * from './_enums/data-service-function.enum';
+
+/**
+ * Common primitive data types used in models.
+ */
 export * from './_enums/predefined-data-types.enum';
+
+/**
+ * Defines if routes should use HTTP, HTTPS or both.
+ */
 export * from './_enums/route-security.enum';
 
 
 // MODELS (CONTROL-MODELS, INTERFACES, TYPES)
-// models/INTERFACES
+
+/** Interfaces describing global configuration and certificates. */
 export * from './_models/interfaces/certification-settings.interface';
 export * from './_models/interfaces/global-service-settings.interface';
 export * from './_models/interfaces/global-settings.interface';
 export * from './_models/interfaces/routing-module-settings.interface';
 
 // models/CONTROL MODELS
+
+/** Classes defining runtime structures without database persistence. */
 export * from './_models/control-models/api-call-params.control-model';
 export * from './_models/control-models/app-ext-system-controls.control-model'
 export * from './_models/control-models/app-params.control-model';
@@ -28,32 +64,57 @@ export * from './_models/control-models/http-settings.control-model';
 export * from './_models/control-models/system-control.control-model';
 
 // models/TYPES
+
+/** Types describing MongoDB style update objects. */
 export * from './_models/types/db-update.type';
 
 
 // SERVICES
 // services/CORE
+/** Client side helper for making HTTP requests. */
 export * from './_services/core/api.service';
+
+/** Basic authentication helper functions. */
 export * from './_services/core/auth.service';
+
+/** Utility for sending transactional emails. */
 export * from './_services/core/email.service';
+
+/** Global service registry and bootstrapping utilities. */
 export * from './_services/core/global.service';
+
+/** Singleton service container. */
 export * from './_services/core/service-collection.service';
 
 // services/BASE
+/** Handles moving data to archive collections. */
 export * from './_services/base/archive-data.service';
+
+/** Basic CRUD service used by feature modules. */
 export * from './_services/base/data.service';
+
+/** Thin wrapper around the database driver. */
 export * from './_services/base/db.service';
+
+/** Base class for implementing singleton services. */
 export * from './_services/base/singleton.service';
 
 // services/SERVER
+/** Express server wrapper. */
 export * from './_services/server/app.server';
+
+/** Environment detection helpers. */
 export * from './_services/server/env-set';
 
 // services/ROUTE
+/** Abstract base controller for defining routes. */
 export * from './_services/route/controller.service';
+
+/** Handles route registration and mounting. */
 export * from './_services/route/routing-module.service';
 
 // services/SHARED
+/** Assorted shared helpers accessible statically. */
 export * from './_services/shared.static-service';