@futdevpro/fsm-dynamo 1.14.10 → 1.14.11

package/build/_models/control-models/range-value.control-model.js

@@ -1,6 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DyFM_RangeValue = void 0;
+/**
+ * A class that represents a range value.
+ *
+ * @example
+ * ```ts
+ * const range: DyFM_RangeValue<number> = new DyFM_RangeValue(1, 10);
+ * ```
+ */
 class DyFM_RangeValue {
     isRange = true;
     from;
@@ -73,33 +81,166 @@ class DyFM_RangeValue {
             return `${this.from}-${this.to}`;
         }
     }
+    /**
+     * Re-types the range value
+     * @param value - The range value to re-type
+     * @returns The re-typed range value
+     *
+     * @example
+     * ```ts
+     * const range: DyFM_RangeValue<number> = new DyFM_RangeValue<number>(5, 100);
+     * const retyped: DyFM_RangeValue<number> = DyFM_RangeValue.reType(range);
+     * ```
+     */
     static reType(value) {
         return new DyFM_RangeValue(value.from, value.to);
     }
+    /**
+     * Adds two range values
+     * @param a - The first range value
+     * @param b - The second range value
+     * @returns The sum of the two range values
+     *
+     * @example
+     * ```ts
+     * const a = new DyFM_RangeValue<number>(5, 10);
+     * const b = new DyFM_RangeValue<number>(2, 3);
+     * const result = DyFM_RangeValue.addRange(a, b);
+     * console.log(result); // 7 - 13
+     * ```
+     */
     static addRange(a, b) {
         return new DyFM_RangeValue(a.from + b.from, a.to + b.to);
     }
+    /**
+     * Subtracts two range values
+     * @param a - The first range value
+     * @param b - The second range value
+     * @returns The difference of the two range values
+     *
+     * @example
+     * ```ts
+     * const a = new DyFM_RangeValue<number>(5, 10);
+     * const b = new DyFM_RangeValue<number>(2, 3);
+     * const result = DyFM_RangeValue.subtractRange(a, b);
+     * console.log(result); // 3 - 7
+     * ```
+     */
     static subtractRange(from, value) {
         return new DyFM_RangeValue(from.from - value.from, from.to - value.to);
     }
+    /**
+     * Multiplies two range values
+     * @param a - The first range value
+     * @param b - The second range value
+     * @returns The product of the two range values
+     *
+     * @example
+     * ```ts
+     * const a = new DyFM_RangeValue<number>(5, 10);
+     * const b = new DyFM_RangeValue<number>(2, 3);
+     * const result = DyFM_RangeValue.multiplyRange(a, b);
+     * console.log(result); // 10 - 30
+     * ```
+     */
     static multiplyRange(from, value) {
         return new DyFM_RangeValue(from.from * value.from, from.to * value.to);
     }
+    /**
+     * Divides two range values
+     * @param a - The first range value
+     * @param b - The second range value
+     * @returns The quotient of the two range values
+     *
+     * @example
+     * ```ts
+     * const a = new DyFM_RangeValue<number>(10, 20);
+     * const b = new DyFM_RangeValue<number>(2, 4);
+     * const result = DyFM_RangeValue.divideRange(a, b);
+     * console.log(result); // 5 - 5
+     * ```
+     */
     static divideRange(from, value) {
         return new DyFM_RangeValue(from.from / value.from, from.to / value.to);
     }
+    /**
+     * Adds a number to a range value
+     * @param a - The range value
+     * @param b - The number to add
+     * @returns The sum of the range value and the number
+     *
+     * @example
+     * ```ts
+     * const a = new DyFM_RangeValue<number>(5, 10);
+     * const result = DyFM_RangeValue.add(a, 5);
+     * console.log(result); // 10 - 15
+     * ```
+     */
     static add(a, b) {
         return new DyFM_RangeValue(a.from + b, a.to + b);
     }
+    /**
+     * Subtracts a number from a range value
+     * @param a - The range value
+     * @param b - The number to subtract
+     * @returns The difference of the range value and the number
+     *
+     * @example
+     * ```ts
+     * const a = new DyFM_RangeValue<number>(5, 10);
+     * const result = DyFM_RangeValue.subtract(a, 5);
+     * console.log(result); // 0 - 5
+     * ```
+     */
     static subtract(a, b) {
         return new DyFM_RangeValue(a.from - b, a.to - b);
     }
+    /**
+     * Multiplies a range value by a number
+     * @param a - The range value
+     * @param b - The number to multiply
+     * @returns The product of the range value and the number
+     *
+     * @example
+     * ```ts
+     * const a = new DyFM_RangeValue<number>(5, 10);
+     * const result = DyFM_RangeValue.multiply(a, 5);
+     * console.log(result); // 25 - 50
+     * ```
+     */
     static multiply(a, b) {
         return new DyFM_RangeValue(a.from * b, a.to * b);
     }
+    /**
+     * Divides a range value by a number
+     * @param a - The range value
+     * @param b - The number to divide
+     * @returns The quotient of the range value and the number
+     *
+     * @example
+     * ```ts
+     * const a = new DyFM_RangeValue<number>(10, 20);
+     * const result = DyFM_RangeValue.divide(a, 5);
+     * console.log(result); // 2 - 4
+     * ```
+     */
     static divide(a, b) {
         return new DyFM_RangeValue(a.from / b, a.to / b);
     }
+    /**
+     * Checks if a value is in a range value
+     * @param value - The value to check
+     * @param range - The range value to check
+     * @returns True if the value is in the range, false otherwise
+     *
+     * @example
+     * ```ts
+     * const value = 5;
+     * const range = new DyFM_RangeValue<number>(0, 10);
+     * const result = DyFM_RangeValue.isInRange(value, range);
+     * console.log(result); // true
+     * ```
+     */
     static isInRange(value, range) {
         return range.from <= value && value <= range.to;
     }

package/build/_models/control-models/range-value.control-model.js.map

@@ -1 +1 @@
-{"version":3,"file":"range-value.control-model.js","sourceRoot":"","sources":["../../../src/_models/control-models/range-value.control-model.ts"],"names":[],"mappings":";;;AAIA,MAAa,eAAe;IACjB,OAAO,GAAY,IAAI,CAAC;IAEjC,IAAI,CAAI;IACR,EAAE,CAAI;IAEN,YACE,IAA4B,EAC5B,EAAM;QAEN,IAAK,IAA2B,EAAE,OAAO,EAAE,CAAC;YAC1C,IAAI,CAAC,IAAI,GAAI,IAA2B,CAAC,IAAI,CAAC;YAC9C,IAAI,CAAC,EAAE,GAAI,IAA2B,CAAC,EAAE,CAAC;YAE1C,OAAO;QACT,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,GAAG,IAAS,CAAC;YACtB,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,IAAS,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAE,KAAyB;QAClC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;IACrB,CAAC;IAED,QAAQ,CAAE,KAA8B;QACrC,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;QACpD,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC;IACnD,CAAC;IAED,aAAa,CAAE,KAA8B;QAC1C,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;QACpD,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC;IACnD,CAAC;IAED,aAAa,CAAE,KAA8B;QAC1C,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;QACpD,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC;IACnD,CAAC;IAED,WAAW,CAAE,KAA8B;QACxC,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;QACpD,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC;IACnD,CAAC;IAED,GAAG,CAAE,KAAa;QACf,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC;QAC/C,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC;IAChD,CAAC;IAED,QAAQ,CAAE,KAAa;QACpB,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC;QAC/C,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC;IAChD,CAAC;IAED,QAAQ,CAAE,KAAa;QACpB,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC;QAC/C,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC;IAChD,CAAC;IAED,MAAM,CAAE,KAAa;QAClB,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC;QAC/C,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC;IAChD,CAAC;IAED,KAAK;QACH,OAAO,IAAI,eAAe,CAAI,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,cAAc,CAAS,SAA0B;QAC/C,OAAO,IAAI,eAAe,CAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,QAAQ,GAAI,IAAI,CAAC,SAAS,CAAC;IAC3B,SAAS,CAAE,SAAkB,IAAI,EAAE,OAAgB,IAAI;QACrD,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;YAClC,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACxB,CAAC;aAAM,IAAI,MAAM,EAAE,CAAC;YAClB,OAAO,GAAG,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,EAAE,EAAE,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;QACnC,CAAC;IACH,CAAC;IAED,MAAM,CAAC,MAAM,CAAI,KAAyB;QACxC,OAAO,IAAI,eAAe,CAAI,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,CAA0B,EAC1B,CAA0B;QAE1B,OAAO,IAAI,eAAe,CAAS,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,CAAC,aAAa,CAClB,IAA6B,EAC7B,KAA8B;QAE9B,OAAO,IAAI,eAAe,CAAS,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;IACjF,CAAC;IAED,MAAM,CAAC,aAAa,CAClB,IAA6B,EAC7B,KAA8B;QAE9B,OAAO,IAAI,eAAe,CAAS,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;IACjF,CAAC;IAED,MAAM,CAAC,WAAW,CAChB,IAA6B,EAC7B,KAA8B;QAE9B,OAAO,IAAI,eAAe,CAAS,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;IACjF,CAAC;IAED,MAAM,CAAC,GAAG,CAAC,CAA0B,EAAE,CAAS;QAC9C,OAAO,IAAI,eAAe,CAAS,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,CAA0B,EAAE,CAAS;QACnD,OAAO,IAAI,eAAe,CAAS,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,CAA0B,EAAE,CAAS;QACnD,OAAO,IAAI,eAAe,CAAS,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,CAA0B,EAAE,CAAS;QACjD,OAAO,IAAI,eAAe,CAAS,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,KAAa,EAAE,KAA8B;QAC5D,OAAO,KAAK,CAAC,IAAI,IAAI,KAAK,IAAI,KAAK,IAAI,KAAK,CAAC,EAAE,CAAC;IAClD,CAAC;CACF;AA5ID,0CA4IC"}
+{"version":3,"file":"range-value.control-model.js","sourceRoot":"","sources":["../../../src/_models/control-models/range-value.control-model.ts"],"names":[],"mappings":";;;AAIA;;;;;;;GAOG;AACH,MAAa,eAAe;IACjB,OAAO,GAAY,IAAI,CAAC;IAEjC,IAAI,CAAI;IACR,EAAE,CAAI;IAEN,YACE,IAA4B,EAC5B,EAAM;QAEN,IAAK,IAA2B,EAAE,OAAO,EAAE,CAAC;YAC1C,IAAI,CAAC,IAAI,GAAI,IAA2B,CAAC,IAAI,CAAC;YAC9C,IAAI,CAAC,EAAE,GAAI,IAA2B,CAAC,EAAE,CAAC;YAE1C,OAAO;QACT,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,GAAG,IAAS,CAAC;YACtB,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,IAAS,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAE,KAAyB;QAClC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;IACrB,CAAC;IAED,QAAQ,CAAE,KAA8B;QACrC,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;QACpD,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC;IACnD,CAAC;IAED,aAAa,CAAE,KAA8B;QAC1C,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;QACpD,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC;IACnD,CAAC;IAED,aAAa,CAAE,KAA8B;QAC1C,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;QACpD,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC;IACnD,CAAC;IAED,WAAW,CAAE,KAA8B;QACxC,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;QACpD,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC;IACnD,CAAC;IAED,GAAG,CAAE,KAAa;QACf,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC;QAC/C,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC;IAChD,CAAC;IAED,QAAQ,CAAE,KAAa;QACpB,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC;QAC/C,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC;IAChD,CAAC;IAED,QAAQ,CAAE,KAAa;QACpB,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC;QAC/C,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC;IAChD,CAAC;IAED,MAAM,CAAE,KAAa;QAClB,IAAgC,CAAC,IAAI,IAAI,KAAK,CAAC;QAC/C,IAAgC,CAAC,EAAE,IAAI,KAAK,CAAC;IAChD,CAAC;IAED,KAAK;QACH,OAAO,IAAI,eAAe,CAAI,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,cAAc,CAAS,SAA0B;QAC/C,OAAO,IAAI,eAAe,CAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,QAAQ,GAAI,IAAI,CAAC,SAAS,CAAC;IAC3B,SAAS,CAAE,SAAkB,IAAI,EAAE,OAAgB,IAAI;QACrD,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;YAClC,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACxB,CAAC;aAAM,IAAI,MAAM,EAAE,CAAC;YAClB,OAAO,GAAG,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,EAAE,EAAE,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;QACnC,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,CAAI,KAAyB;QACxC,OAAO,IAAI,eAAe,CAAI,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,QAAQ,CACb,CAA0B,EAC1B,CAA0B;QAE1B,OAAO,IAAI,eAAe,CAAS,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,aAAa,CAClB,IAA6B,EAC7B,KAA8B;QAE9B,OAAO,IAAI,eAAe,CAAS,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,aAAa,CAClB,IAA6B,EAC7B,KAA8B;QAE9B,OAAO,IAAI,eAAe,CAAS,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,WAAW,CAChB,IAA6B,EAC7B,KAA8B;QAE9B,OAAO,IAAI,eAAe,CAAS,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAG,CAAC,CAA0B,EAAE,CAAS;QAC9C,OAAO,IAAI,eAAe,CAAS,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,QAAQ,CAAC,CAA0B,EAAE,CAAS;QACnD,OAAO,IAAI,eAAe,CAAS,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,QAAQ,CAAC,CAA0B,EAAE,CAAS;QACnD,OAAO,IAAI,eAAe,CAAS,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,CAAC,CAA0B,EAAE,CAAS;QACjD,OAAO,IAAI,eAAe,CAAS,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAS,CAAC,KAAa,EAAE,KAA8B;QAC5D,OAAO,KAAK,CAAC,IAAI,IAAI,KAAK,IAAI,KAAK,IAAI,KAAK,CAAC,EAAE,CAAC;IAClD,CAAC;CACF;AAjRD,0CAiRC"}

package/build/_models/control-models/server-status.control-model.d.ts

@@ -1,5 +1,15 @@
 import { DyFM_DataModel_Params } from '../..';
 import { DyFM_Metadata } from '../data-models/metadata.data-model';
+/**
+ * A class that represents the status of a server.
+ *
+ * @example
+ * ```ts
+ * const serverStatus: DyFM_ServerStatus = new DyFM_ServerStatus({
+ *   status: 'ready',
+ * });
+ * ```
+ */
 export declare class DyFM_ServerStatus extends DyFM_Metadata {
     status?: 'ready';
     systemName?: string;

package/build/_models/control-models/server-status.control-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server-status.control-model.d.ts","sourceRoot":"","sources":["../../../src/_models/control-models/server-status.control-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,OAAO,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnE,qBAAa,iBAAkB,SAAQ,aAAa;IAClD,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;gBAGA,GAAG,CAAC,EAAE,iBAAiB;CAQ1B;AAED,eAAO,MAAM,4BAA4B,0CAsBvC,CAAC"}
+{"version":3,"file":"server-status.control-model.d.ts","sourceRoot":"","sources":["../../../src/_models/control-models/server-status.control-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,OAAO,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnE;;;;;;;;;GASG;AACH,qBAAa,iBAAkB,SAAQ,aAAa;IAClD,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;gBAGA,GAAG,CAAC,EAAE,iBAAiB;CAQ1B;AAED,eAAO,MAAM,4BAA4B,0CAsBvC,CAAC"}

package/build/_models/control-models/server-status.control-model.js

@@ -3,6 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DyFM_serverStatus_dataParams = exports.DyFM_ServerStatus = void 0;
 const __1 = require("../..");
 const metadata_data_model_1 = require("../data-models/metadata.data-model");
+/**
+ * A class that represents the status of a server.
+ *
+ * @example
+ * ```ts
+ * const serverStatus: DyFM_ServerStatus = new DyFM_ServerStatus({
+ *   status: 'ready',
+ * });
+ * ```
+ */
 class DyFM_ServerStatus extends metadata_data_model_1.DyFM_Metadata {
     status;
     systemName;

package/build/_models/control-models/server-status.control-model.js.map

@@ -1 +1 @@
-{"version":3,"file":"server-status.control-model.js","sourceRoot":"","sources":["../../../src/_models/control-models/server-status.control-model.ts"],"names":[],"mappings":";;;AAAA,6BAA8C;AAC9C,4EAAmE;AAEnE,MAAa,iBAAkB,SAAQ,mCAAa;IAClD,MAAM,CAAW;IAEjB,UAAU,CAAU;IACpB,eAAe,CAAU;IAEzB,eAAe,CAAW;IAC1B,mBAAmB,CAAU;IAC7B,0BAA0B,CAAU;IAEpC,aAAa,CAAU;IACvB,oBAAoB,CAAU;IAE9B,MAAM,CAAU;IAEhB,aAAa,CAAU;IAEvB,WAAW,CAMT;IACF,QAAQ,CAGN;IAEF,YACE,GAAuB;QAEvB,KAAK,CAAC,GAAG,CAAC,CAAC;QAEX,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;CACF;AAtCD,8CAsCC;AAEY,QAAA,4BAA4B,GAAG,IAAI,yBAAqB,CAAoB;IACvF,QAAQ,EAAE,eAAe;IACzB,UAAU,EAAE;QACV,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE1B,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAEnC,eAAe,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QACpC,mBAAmB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACvC,0BAA0B,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE9C,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACjC,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAExC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE1B,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAEjC,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC/B,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KAC7B;CACF,CAAC,CAAC"}
+{"version":3,"file":"server-status.control-model.js","sourceRoot":"","sources":["../../../src/_models/control-models/server-status.control-model.ts"],"names":[],"mappings":";;;AAAA,6BAA8C;AAC9C,4EAAmE;AAEnE;;;;;;;;;GASG;AACH,MAAa,iBAAkB,SAAQ,mCAAa;IAClD,MAAM,CAAW;IAEjB,UAAU,CAAU;IACpB,eAAe,CAAU;IAEzB,eAAe,CAAW;IAC1B,mBAAmB,CAAU;IAC7B,0BAA0B,CAAU;IAEpC,aAAa,CAAU;IACvB,oBAAoB,CAAU;IAE9B,MAAM,CAAU;IAEhB,aAAa,CAAU;IAEvB,WAAW,CAMT;IACF,QAAQ,CAGN;IAEF,YACE,GAAuB;QAEvB,KAAK,CAAC,GAAG,CAAC,CAAC;QAEX,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;CACF;AAtCD,8CAsCC;AAEY,QAAA,4BAA4B,GAAG,IAAI,yBAAqB,CAAoB;IACvF,QAAQ,EAAE,eAAe;IACzB,UAAU,EAAE;QACV,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE1B,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAEnC,eAAe,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QACpC,mBAAmB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACvC,0BAA0B,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE9C,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACjC,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAExC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE1B,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAEjC,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC/B,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KAC7B;CACF,CAAC,CAAC"}

package/build/_models/control-models/service-endpoint-settings-base.control-model.d.ts

@@ -7,6 +7,18 @@ export interface DyFM_EndpointTypesContainer<T_Result, T_Inputs extends Array<an
 export type DyFM_ServiceEndpointTypesSettings = {
     [key: string]: DyFM_EndpointTypesContainer<unknown, any, unknown>;
 };
+/**
+ * A class that represents the settings of a service endpoint.
+ *
+ * @example
+ * ```ts
+ * const endpointSettings: DyFM_Endpoint_SettingsBase<string, [string], undefined> = new DyFM_Endpoint_SettingsBase({
+ *   name: 'myEndpoint',
+ *   type: DyFM_HttpCallType.get,
+ *   endpoint: '/get/:id',
+ * });
+ * ```
+ */
 export declare class DyFM_Endpoint_SettingsBase<T_Result, I_Inputs, T_Body> {
     name?: string;
     type?: DyFM_HttpCallType;

package/build/_models/control-models/service-endpoint-settings-base.control-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service-endpoint-settings-base.control-model.d.ts","sourceRoot":"","sources":["../../../src/_models/control-models/service-endpoint-settings-base.control-model.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAgB1E,MAAM,WAAW,2BAA2B,CAC1C,QAAQ,EACR,QAAQ,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAChC,MAAM,GAAG,SAAS;IAElB,UAAU,EAAE,QAAQ,CAAC;IACrB,UAAU,EAAE,QAAQ,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,MAAM,iCAAiC,GAAG;IAC9C,CAAC,GAAG,EAAE,MAAM,GAAG,2BAA2B,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;CACnE,CAAA;AAED,qBAAa,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAM;gBAG5B,GAAG,EAAE,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC;CAwB9D;AACD,MAAM,MAAM,iCAAiC,CAAC,CAAC,SAAS,iCAAiC,IAAI;KAC1F,CAAC,IAAI,MAAM,CAAC,GAAG,0BAA0B,CACxC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CACzD;CACF,CAAA"}
+{"version":3,"file":"service-endpoint-settings-base.control-model.d.ts","sourceRoot":"","sources":["../../../src/_models/control-models/service-endpoint-settings-base.control-model.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAgB1E,MAAM,WAAW,2BAA2B,CAC1C,QAAQ,EACR,QAAQ,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAChC,MAAM,GAAG,SAAS;IAElB,UAAU,EAAE,QAAQ,CAAC;IACrB,UAAU,EAAE,QAAQ,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,MAAM,iCAAiC,GAAG;IAC9C,CAAC,GAAG,EAAE,MAAM,GAAG,2BAA2B,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;CACnE,CAAA;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAM;gBAG5B,GAAG,EAAE,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC;CAwB9D;AACD,MAAM,MAAM,iCAAiC,CAAC,CAAC,SAAS,iCAAiC,IAAI;KAC1F,CAAC,IAAI,MAAM,CAAC,GAAG,0BAA0B,CACxC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CACzD;CACF,CAAA"}

package/build/_models/control-models/service-endpoint-settings-base.control-model.js

@@ -2,6 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DyFM_Endpoint_SettingsBase = void 0;
 const stack_util_1 = require("../../_collections/utils/stack.util");
+/**
+ * A class that represents the settings of a service endpoint.
+ *
+ * @example
+ * ```ts
+ * const endpointSettings: DyFM_Endpoint_SettingsBase<string, [string], undefined> = new DyFM_Endpoint_SettingsBase({
+ *   name: 'myEndpoint',
+ *   type: DyFM_HttpCallType.get,
+ *   endpoint: '/get/:id',
+ * });
+ * ```
+ */
 class DyFM_Endpoint_SettingsBase {
     name;
     type;

package/build/_models/control-models/service-endpoint-settings-base.control-model.js.map

@@ -1 +1 @@
-{"version":3,"file":"service-endpoint-settings-base.control-model.js","sourceRoot":"","sources":["../../../src/_models/control-models/service-endpoint-settings-base.control-model.ts"],"names":[],"mappings":";;;AAAA,oEAAwF;AA8BxF,MAAa,0BAA0B;IACrC,IAAI,CAAU;IACd,IAAI,CAAqB;IACzB,QAAQ,CAAU;IAElB,aAAa,GAAc,EAAE,CAAC;IAE9B,YACE,GAA2D;QAE3D,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,6CAA6C,GAAG,CAAC,IAAI,IAAI,IAAA,8CAAiC,GAAE,GAAG,CAChG,CAAC;QACJ,CAAC;QAED,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,OAAO,CAAC,IAAI,CACV,uEAAuE;gBACvE,sDAAsD,GAAG,CAAC,IAAI,GAAG,CAClE,CAAC;YACF,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAEzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAClD,CAAC,IAAY,EAAW,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAChD,CAAC,GAAG,CACH,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAChD,CAAC;IACJ,CAAC;CACF;AAhCD,gEAgCC;AAOD;;;;;;;;;;;;;;;;;;;;;;IAsBI;AAIJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA0CI"}
+{"version":3,"file":"service-endpoint-settings-base.control-model.js","sourceRoot":"","sources":["../../../src/_models/control-models/service-endpoint-settings-base.control-model.ts"],"names":[],"mappings":";;;AAAA,oEAAwF;AA8BxF;;;;;;;;;;;GAWG;AACH,MAAa,0BAA0B;IACrC,IAAI,CAAU;IACd,IAAI,CAAqB;IACzB,QAAQ,CAAU;IAElB,aAAa,GAAc,EAAE,CAAC;IAE9B,YACE,GAA2D;QAE3D,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,6CAA6C,GAAG,CAAC,IAAI,IAAI,IAAA,8CAAiC,GAAE,GAAG,CAChG,CAAC;QACJ,CAAC;QAED,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,OAAO,CAAC,IAAI,CACV,uEAAuE;gBACvE,sDAAsD,GAAG,CAAC,IAAI,GAAG,CAClE,CAAC;YACF,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAEzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAClD,CAAC,IAAY,EAAW,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAChD,CAAC,GAAG,CACH,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAChD,CAAC;IACJ,CAAC;CACF;AAhCD,gEAgCC;AAOD;;;;;;;;;;;;;;;;;;;;;;IAsBI;AAIJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA0CI"}

package/build/_models/data-models/errors.data-model.d.ts

@@ -6,6 +6,16 @@ export declare const DyFM_errorsFlag = "DyFM-ERRORS-OBJECT";
 /**
  * This obj is the saved version of the DyFM_Error object.
  * It is used to store the error in the database and its statistics.
+ *
+ * @example
+ * ```ts
+ * const errors: DyFM_Errors<DyFM_Error> = new DyFM_Errors({
+ *   message: 'Error message',
+ *   error: new DyFM_Error({
+ *     message: 'Error message',
+ *   }),
+ * });
+ * ```
  */
 export declare class DyFM_Errors<T_Error extends DyFM_Error> extends DyFM_Metadata {
     readonly flag?: string;

package/build/_models/data-models/errors.data-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.data-model.d.ts","sourceRoot":"","sources":["../../../src/_models/data-models/errors.data-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mDAAmD,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAGtD,eAAO,MAAM,eAAe,uBAAuB,CAAC;AAEpD;;;GAGG;AACH,qBAAa,WAAW,CAAC,OAAO,SAAS,UAAU,CAAE,SAAQ,aAAa;IACxE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAmB;IAEzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IAEnB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,KAAK,CAAC,EAAE,MAAM,CAAK;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,iBAAiB,CAAC,EAAE,GAAG,CAAC;IAExB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,CAAM;gBAGzC,GAAG,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;CAQ7B;AAED,eAAO,MAAM,sBAAsB,EAAE,qBAAqB,CAAC,WAAW,CAAC,UAAU,CAAC,CA8B9E,CAAC"}
+{"version":3,"file":"errors.data-model.d.ts","sourceRoot":"","sources":["../../../src/_models/data-models/errors.data-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mDAAmD,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAGtD,eAAO,MAAM,eAAe,uBAAuB,CAAC;AAEpD;;;;;;;;;;;;;GAaG;AACH,qBAAa,WAAW,CAAC,OAAO,SAAS,UAAU,CAAE,SAAQ,aAAa;IACxE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAmB;IAEzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IAEnB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,KAAK,CAAC,EAAE,MAAM,CAAK;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,iBAAiB,CAAC,EAAE,GAAG,CAAC;IAExB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,CAAM;gBAGzC,GAAG,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;CAQ7B;AAED,eAAO,MAAM,sBAAsB,EAAE,qBAAqB,CAAC,WAAW,CAAC,UAAU,CAAC,CA8B9E,CAAC"}

package/build/_models/data-models/errors.data-model.js

@@ -7,6 +7,16 @@ exports.DyFM_errorsFlag = 'DyFM-ERRORS-OBJECT';
 /**
  * This obj is the saved version of the DyFM_Error object.
  * It is used to store the error in the database and its statistics.
+ *
+ * @example
+ * ```ts
+ * const errors: DyFM_Errors<DyFM_Error> = new DyFM_Errors({
+ *   message: 'Error message',
+ *   error: new DyFM_Error({
+ *     message: 'Error message',
+ *   }),
+ * });
+ * ```
  */
 class DyFM_Errors extends metadata_data_model_1.DyFM_Metadata {
     flag = exports.DyFM_errorsFlag;

package/build/_models/data-models/errors.data-model.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.data-model.js","sourceRoot":"","sources":["../../../src/_models/data-models/errors.data-model.ts"],"names":[],"mappings":";;;AAAA,uGAA0F;AAG1F,+DAAsD;AAGzC,QAAA,eAAe,GAAG,oBAAoB,CAAC;AAEpD;;;GAGG;AACH,MAAa,WAAwC,SAAQ,mCAAa;IAC/D,IAAI,GAAY,uBAAe,CAAC;IAEzC,MAAM,CAAU;IAChB,MAAM,CAAU;IAChB,QAAQ,CAAU;IAClB,OAAO,CAAU;IAEjB,SAAS,CAAU;IACnB,MAAM,CAAU;IAEhB,OAAO,CAAU;IACjB,SAAS,CAAU;IACnB,YAAY,CAAO;IAEnB,UAAU,CAAY;IACtB,KAAK,CAAO;IAEZ,KAAK,GAAY,CAAC,CAAC;IAEnB,OAAO,CAAW;IAElB,iBAAiB,CAAO;IAExB,KAAK,CAAmB;IACxB,QAAQ,CAAU;IAClB,YAAY,GAA4B,EAAE,CAAC;IAE3C,YACE,GAA0B;QAE1B,KAAK,CAAC,GAAG,CAAC,CAAC;QAEX,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;CACF;AArCD,kCAqCC;AAEY,QAAA,sBAAsB,GACjC,IAAI,uDAAqB,CAA0B;IACjD,QAAQ,EAAE,QAAQ;IAClB,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAExB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE3B,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE1B,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC3B,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7B,YAAY,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QAE7B,UAAU,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE;QAChC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QAEtB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAEzB,OAAO,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE;QAE/B,iBAAiB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QAElC,KAAK,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE;QAClC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,YAAY,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE;KACxC;CACF,CAAC,CAAC"}
+{"version":3,"file":"errors.data-model.js","sourceRoot":"","sources":["../../../src/_models/data-models/errors.data-model.ts"],"names":[],"mappings":";;;AAAA,uGAA0F;AAG1F,+DAAsD;AAGzC,QAAA,eAAe,GAAG,oBAAoB,CAAC;AAEpD;;;;;;;;;;;;;GAaG;AACH,MAAa,WAAwC,SAAQ,mCAAa;IAC/D,IAAI,GAAY,uBAAe,CAAC;IAEzC,MAAM,CAAU;IAChB,MAAM,CAAU;IAChB,QAAQ,CAAU;IAClB,OAAO,CAAU;IAEjB,SAAS,CAAU;IACnB,MAAM,CAAU;IAEhB,OAAO,CAAU;IACjB,SAAS,CAAU;IACnB,YAAY,CAAO;IAEnB,UAAU,CAAY;IACtB,KAAK,CAAO;IAEZ,KAAK,GAAY,CAAC,CAAC;IAEnB,OAAO,CAAW;IAElB,iBAAiB,CAAO;IAExB,KAAK,CAAmB;IACxB,QAAQ,CAAU;IAClB,YAAY,GAA4B,EAAE,CAAC;IAE3C,YACE,GAA0B;QAE1B,KAAK,CAAC,GAAG,CAAC,CAAC;QAEX,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;CACF;AArCD,kCAqCC;AAEY,QAAA,sBAAsB,GACjC,IAAI,uDAAqB,CAA0B;IACjD,QAAQ,EAAE,QAAQ;IAClB,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAExB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE3B,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE1B,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC3B,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7B,YAAY,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QAE7B,UAAU,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE;QAChC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QAEtB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAEzB,OAAO,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE;QAE/B,iBAAiB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QAElC,KAAK,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE;QAClC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,YAAY,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE;KACxC;CACF,CAAC,CAAC"}

package/build/_models/data-models/metadata.data-model.d.ts

@@ -1,4 +1,15 @@
 export type DyFM_MetaD = DyFM_Metadata;
+/**
+ * This class is the base class for all data models.
+ * It contains the metadata for the data model.
+ *
+ * @example
+ * ```ts
+ * const metadata: DyFM_Metadata = new DyFM_Metadata({
+ *   _id: '123',
+ * });
+ * ```
+ */
 export declare class DyFM_Metadata {
     _id?: string;
     __created?: Date;
@@ -14,6 +25,21 @@ export declare class DyFM_Metadata {
         id?: string;
         issuer: string;
     });
+    /**
+     * Updates the metadata of a data model
+     * @param data - The data model to update
+     * @param issuer - The issuer of the data model
+     * @param id - The id of the data model
+     * @returns The updated data model
+     *
+     * @example
+     * ```ts
+     * const metadata: DyFM_Metadata = new DyFM_Metadata({
+     *   _id: '123',
+     * });
+     * const updatedMetadata = DyFM_Metadata.updateMetadata(metadata, 'user', '456');
+     * ```
+     */
     static updateMetadata?<T extends DyFM_Metadata>(data: T, issuer: string, id?: string): T;
 }
 //# sourceMappingURL=metadata.data-model.d.ts.map

package/build/_models/data-models/metadata.data-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metadata.data-model.d.ts","sourceRoot":"","sources":["../../../src/_models/data-models/metadata.data-model.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,UAAU,GAAG,aAAa,CAAC;AACvC,qBAAa,aAAa;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,IAAI,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,IAAI,CAAC;IAGjB,WAAW,CAAC,EAAE,MAAM,CAAC;gBAGnB,GAAG,CAAC,EAAE,aAAa,EACnB,IAAI,CAAC,EAAE;QACL,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;KAChB;IAiDH,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,CAAC;CA2BzF"}
+{"version":3,"file":"metadata.data-model.d.ts","sourceRoot":"","sources":["../../../src/_models/data-models/metadata.data-model.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,UAAU,GAAG,aAAa,CAAC;AAEvC;;;;;;;;;;GAUG;AACH,qBAAa,aAAa;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,IAAI,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,IAAI,CAAC;IAGjB,WAAW,CAAC,EAAE,MAAM,CAAC;gBAGnB,GAAG,CAAC,EAAE,aAAa,EACnB,IAAI,CAAC,EAAE;QACL,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;KAChB;IAiDH;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,CAAC;CA2BzF"}

package/build/_models/data-models/metadata.data-model.js

@@ -1,6 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DyFM_Metadata = void 0;
+/**
+ * This class is the base class for all data models.
+ * It contains the metadata for the data model.
+ *
+ * @example
+ * ```ts
+ * const metadata: DyFM_Metadata = new DyFM_Metadata({
+ *   _id: '123',
+ * });
+ * ```
+ */
 class DyFM_Metadata {
     _id;
     __created;
@@ -53,6 +64,21 @@ class DyFM_Metadata {
             }
         }
     }
+    /**
+     * Updates the metadata of a data model
+     * @param data - The data model to update
+     * @param issuer - The issuer of the data model
+     * @param id - The id of the data model
+     * @returns The updated data model
+     *
+     * @example
+     * ```ts
+     * const metadata: DyFM_Metadata = new DyFM_Metadata({
+     *   _id: '123',
+     * });
+     * const updatedMetadata = DyFM_Metadata.updateMetadata(metadata, 'user', '456');
+     * ```
+     */
     static updateMetadata(data, issuer, id) {
         if (!data) {
             return data;

package/build/_models/data-models/metadata.data-model.js.map

@@ -1 +1 @@
-{"version":3,"file":"metadata.data-model.js","sourceRoot":"","sources":["../../../src/_models/data-models/metadata.data-model.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IACxB,GAAG,CAAU;IAEb,SAAS,CAAQ;IACjB,WAAW,CAAU;IACrB,cAAc,CAAQ;IACtB,gBAAgB,CAAU;IAC1B,GAAG,CAAU;IAEb,QAAQ,CAAQ;IAChB,UAAU,CAAU;IAEpB,SAAS,CAAQ;IACjB,uBAAuB;IACvB,sBAAsB;IACtB,WAAW,CAAU;IAErB,YACE,GAAmB,EACnB,IAGC;QAED,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;gBACtC,GAAG,CAAC,GAAG,GAAG,SAAS,CAAC;YACtB,CAAC;YAED,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;YACnB,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;YAC/B,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;YACnC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC;YACzC,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;YAC7C,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;YAEnB,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;gBAClB,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;gBAC/B,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;YACrC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,IAAI,CAAC,cAAc,GAAG,IAAI,IAAI,EAAE,CAAC;QACnC,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACd,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;QACf,CAAC;QAED,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,EAAE,EAAE,EAAE,CAAC;gBAC1B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC;YACrB,CAAC;YAED,IAAI,IAAI,EAAE,MAAM,EAAE,CAAC;gBACjB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;oBACtB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;gBACjC,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBAC3B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC;gBACtC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,CAAC,cAAc,CAA2B,IAAO,EAAE,MAAc,EAAE,EAAW;QAClF,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC;YACpB,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC5B,CAAC;QAED,IAAI,CAAC,cAAc,GAAG,IAAI,IAAI,EAAE,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEvC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAlGD,sCAkGC"}
+{"version":3,"file":"metadata.data-model.js","sourceRoot":"","sources":["../../../src/_models/data-models/metadata.data-model.ts"],"names":[],"mappings":";;;AAGA;;;;;;;;;;GAUG;AACH,MAAa,aAAa;IACxB,GAAG,CAAU;IAEb,SAAS,CAAQ;IACjB,WAAW,CAAU;IACrB,cAAc,CAAQ;IACtB,gBAAgB,CAAU;IAC1B,GAAG,CAAU;IAEb,QAAQ,CAAQ;IAChB,UAAU,CAAU;IAEpB,SAAS,CAAQ;IACjB,uBAAuB;IACvB,sBAAsB;IACtB,WAAW,CAAU;IAErB,YACE,GAAmB,EACnB,IAGC;QAED,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;gBACtC,GAAG,CAAC,GAAG,GAAG,SAAS,CAAC;YACtB,CAAC;YAED,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;YACnB,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;YAC/B,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;YACnC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC;YACzC,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;YAC7C,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;YAEnB,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;gBAClB,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;gBAC/B,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;YACrC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,IAAI,CAAC,cAAc,GAAG,IAAI,IAAI,EAAE,CAAC;QACnC,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACd,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;QACf,CAAC;QAED,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,EAAE,EAAE,EAAE,CAAC;gBAC1B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC;YACrB,CAAC;YAED,IAAI,IAAI,EAAE,MAAM,EAAE,CAAC;gBACjB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;oBACtB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;gBACjC,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBAC3B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC;gBACtC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,cAAc,CAA2B,IAAO,EAAE,MAAc,EAAE,EAAW;QAClF,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC;YACpB,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC5B,CAAC;QAED,IAAI,CAAC,cAAc,GAAG,IAAI,IAAI,EAAE,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEvC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAjHD,sCAiHC"}

package/build/_modules/ci-tools/_models/cit-ci-result-info.data-models.d.ts

@@ -2,6 +2,29 @@ import { DyFM_Metadata } from '../../../_models/data-models/metadata.data-model'
 import { DyFM_DataModel_Params } from '../../../_models/control-models/data-model-params.control-model';
 import { DyFM_CIT_CIResultCode } from '../_enums/cit-ci-result-code.enum';
 import { DyFM_CIT_CIStepResult } from './cit-ci-step-result.interface';
+/**
+ * This data model is used to store the result of a CI/CD pipeline.
+ *
+ * @example
+ * ```ts
+ * const resultInfo: DyFM_CIT_CIResultInfo = new DyFM_CIT_CIResultInfo({
+ *   project: 'myProject',
+ *   system: 'mySystem',
+ *   version: '1.0.0',
+ *   environment: 'development',
+ *   branch: 'main',
+ *   result: DyFM_CIT_CIResultCode.success,
+ *   stepResults: [
+ *     { stepName: 'build', resultCode: DyFM_CIT_CIStepResultCode.success },
+ *     { stepName: 'test', resultCode: DyFM_CIT_CIStepResultCode.success },
+ *   ],
+ *   linkToAction: 'https://example.com',
+ *   duration: '10 seconds',
+ *   error: 'Error message',
+ *   errorDetails: { error: 'Error object' },
+ * });
+ * ```
+ */
 export declare class DyFM_CIT_CIResultInfo extends DyFM_Metadata {
     project: string;
     system: string;

package/build/_modules/ci-tools/_models/cit-ci-result-info.data-models.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cit-ci-result-info.data-models.d.ts","sourceRoot":"","sources":["../../../../src/_modules/ci-tools/_models/cit-ci-result-info.data-models.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,iEAAiE,CAAC;AAExG,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAEvE,qBAAa,qBAAsB,SAAQ,aAAa;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,EAAE,qBAAqB,CAAC;IAC9B,WAAW,CAAC,EAAE,qBAAqB,EAAE,CAAM;IAC3C,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,GAAG,CAAC;gBAGjB,GAAG,CAAC,EAAE,qBAAqB;CAQ9B;AAED,eAAO,MAAM,gCAAgC,8CAmB3C,CAAC"}
+{"version":3,"file":"cit-ci-result-info.data-models.d.ts","sourceRoot":"","sources":["../../../../src/_modules/ci-tools/_models/cit-ci-result-info.data-models.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,iEAAiE,CAAC;AAExG,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAEvE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,qBAAsB,SAAQ,aAAa;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,EAAE,qBAAqB,CAAC;IAC9B,WAAW,CAAC,EAAE,qBAAqB,EAAE,CAAM;IAC3C,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,GAAG,CAAC;gBAGjB,GAAG,CAAC,EAAE,qBAAqB;CAQ9B;AAED,eAAO,MAAM,gCAAgC,8CAmB3C,CAAC"}

package/build/_modules/ci-tools/_models/cit-ci-result-info.data-models.js

@@ -3,6 +3,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DyFM_CIT_ciResultInfo_dataParams = exports.DyFM_CIT_CIResultInfo = void 0;
 const metadata_data_model_1 = require("../../../_models/data-models/metadata.data-model");
 const data_model_params_control_model_1 = require("../../../_models/control-models/data-model-params.control-model");
+/**
+ * This data model is used to store the result of a CI/CD pipeline.
+ *
+ * @example
+ * ```ts
+ * const resultInfo: DyFM_CIT_CIResultInfo = new DyFM_CIT_CIResultInfo({
+ *   project: 'myProject',
+ *   system: 'mySystem',
+ *   version: '1.0.0',
+ *   environment: 'development',
+ *   branch: 'main',
+ *   result: DyFM_CIT_CIResultCode.success,
+ *   stepResults: [
+ *     { stepName: 'build', resultCode: DyFM_CIT_CIStepResultCode.success },
+ *     { stepName: 'test', resultCode: DyFM_CIT_CIStepResultCode.success },
+ *   ],
+ *   linkToAction: 'https://example.com',
+ *   duration: '10 seconds',
+ *   error: 'Error message',
+ *   errorDetails: { error: 'Error object' },
+ * });
+ * ```
+ */
 class DyFM_CIT_CIResultInfo extends metadata_data_model_1.DyFM_Metadata {
     project;
     system;

package/build/_modules/ci-tools/_models/cit-ci-result-info.data-models.js.map

@@ -1 +1 @@
-{"version":3,"file":"cit-ci-result-info.data-models.js","sourceRoot":"","sources":["../../../../src/_modules/ci-tools/_models/cit-ci-result-info.data-models.ts"],"names":[],"mappings":";;;AACA,0FAAiF;AACjF,qHAAwG;AAKxG,MAAa,qBAAsB,SAAQ,mCAAa;IACtD,OAAO,CAAS;IAChB,MAAM,CAAS;IACf,OAAO,CAAS;IAChB,WAAW,CAAS;IACpB,MAAM,CAAS;IAEf,MAAM,CAAwB;IAC9B,WAAW,GAA6B,EAAE,CAAC;IAC3C,YAAY,CAAU;IACtB,6BAA6B;IAC7B,QAAQ,CAAU;IAElB,KAAK,CAAU;IACf,YAAY,CAAO;IAEnB,YACE,GAA2B;QAE3B,KAAK,CAAC,GAAG,CAAC,CAAC;QAEX,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;CACF;AAzBD,sDAyBC;AAEY,QAAA,gCAAgC,GAAG,IAAI,uDAAqB,CAAwB;IAC/F,QAAQ,EAAE,gBAAgB;IAC1B,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE;QACV,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC3B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC3B,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC/B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE1B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,WAAW,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE;QAChD,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAChC,yCAAyC;QACzC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE5B,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzB,YAAY,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;KAC9B;CACF,CAAC,CAAC"}
+{"version":3,"file":"cit-ci-result-info.data-models.js","sourceRoot":"","sources":["../../../../src/_modules/ci-tools/_models/cit-ci-result-info.data-models.ts"],"names":[],"mappings":";;;AACA,0FAAiF;AACjF,qHAAwG;AAKxG;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,qBAAsB,SAAQ,mCAAa;IACtD,OAAO,CAAS;IAChB,MAAM,CAAS;IACf,OAAO,CAAS;IAChB,WAAW,CAAS;IACpB,MAAM,CAAS;IAEf,MAAM,CAAwB;IAC9B,WAAW,GAA6B,EAAE,CAAC;IAC3C,YAAY,CAAU;IACtB,6BAA6B;IAC7B,QAAQ,CAAU;IAElB,KAAK,CAAU;IACf,YAAY,CAAO;IAEnB,YACE,GAA2B;QAE3B,KAAK,CAAC,GAAG,CAAC,CAAC;QAEX,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;CACF;AAzBD,sDAyBC;AAEY,QAAA,gCAAgC,GAAG,IAAI,uDAAqB,CAAwB;IAC/F,QAAQ,EAAE,gBAAgB;IAC1B,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE;QACV,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC3B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC3B,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC/B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE1B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,WAAW,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE;QAChD,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAChC,yCAAyC;QACzC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAE5B,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzB,YAAY,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;KAC9B;CACF,CAAC,CAAC"}

package/build/_modules/custom-data/_models/cud.data-model.d.ts

@@ -3,6 +3,13 @@ import { DyFM_Metadata } from '../../../_models/data-models/metadata.data-model'
 export type DyFM_CustomD = DyFM_CustomData;
 /**
  * Generic data container that can store custom information.
+ *
+ * @example
+ * ```ts
+ * const customData: DyFM_CustomData<{ name: string }> = new DyFM_CustomData({
+ *   data: { name: 'John Doe' },
+ * });
+ * ```
  */
 export declare class DyFM_CustomData<T = any> extends DyFM_Metadata {
     data?: T;

package/build/_modules/custom-data/_models/cud.data-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cud.data-model.d.ts","sourceRoot":"","sources":["../../../../src/_modules/custom-data/_models/cud.data-model.ts"],"names":[],"mappings":"AACA,OAAO,EACL,qBAAqB,EACtB,MAAM,iEAAiE,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AAEjF,MAAM,MAAM,YAAY,GAAG,eAAe,CAAC;AAC3C;;GAEG;AACH,qBAAa,eAAe,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,aAAa;IACzD,IAAI,CAAC,EAAE,CAAC,CAAC;gBAGP,GAAG,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC;CAQ3B;AAED,eAAO,MAAM,0BAA0B,EAAE,qBAAqB,CAAC,eAAe,CAM1E,CAAC"}
+{"version":3,"file":"cud.data-model.d.ts","sourceRoot":"","sources":["../../../../src/_modules/custom-data/_models/cud.data-model.ts"],"names":[],"mappings":"AACA,OAAO,EACL,qBAAqB,EACtB,MAAM,iEAAiE,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AAEjF,MAAM,MAAM,YAAY,GAAG,eAAe,CAAC;AAC3C;;;;;;;;;GASG;AACH,qBAAa,eAAe,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,aAAa;IACzD,IAAI,CAAC,EAAE,CAAC,CAAC;gBAGP,GAAG,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC;CAQ3B;AAED,eAAO,MAAM,0BAA0B,EAAE,qBAAqB,CAAC,eAAe,CAM1E,CAAC"}

package/build/_modules/custom-data/_models/cud.data-model.js

@@ -5,6 +5,13 @@ const data_model_params_control_model_1 = require("../../../_models/control-mode
 const metadata_data_model_1 = require("../../../_models/data-models/metadata.data-model");
 /**
  * Generic data container that can store custom information.
+ *
+ * @example
+ * ```ts
+ * const customData: DyFM_CustomData<{ name: string }> = new DyFM_CustomData({
+ *   data: { name: 'John Doe' },
+ * });
+ * ```
  */
 class DyFM_CustomData extends metadata_data_model_1.DyFM_Metadata {
     data;

package/build/_modules/custom-data/_models/cud.data-model.js.map

@@ -1 +1 @@
-{"version":3,"file":"cud.data-model.js","sourceRoot":"","sources":["../../../../src/_modules/custom-data/_models/cud.data-model.ts"],"names":[],"mappings":";;;AACA,qHAEyE;AACzE,0FAAiF;AAGjF;;GAEG;AACH,MAAa,eAAyB,SAAQ,mCAAa;IACzD,IAAI,CAAK;IAET,YACE,GAAwB;QAExB,KAAK,CAAC,GAAG,CAAC,CAAC;QAEX,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;CACF;AAZD,0CAYC;AAEY,QAAA,0BAA0B,GACrC,IAAI,uDAAqB,CAAkB;IACzC,QAAQ,EAAE,aAAa;IACvB,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KACtD;CACF,CAAC,CAAC"}
+{"version":3,"file":"cud.data-model.js","sourceRoot":"","sources":["../../../../src/_modules/custom-data/_models/cud.data-model.ts"],"names":[],"mappings":";;;AACA,qHAEyE;AACzE,0FAAiF;AAGjF;;;;;;;;;GASG;AACH,MAAa,eAAyB,SAAQ,mCAAa;IACzD,IAAI,CAAK;IAET,YACE,GAAwB;QAExB,KAAK,CAAC,GAAG,CAAC,CAAC;QAEX,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;CACF;AAZD,0CAYC;AAEY,QAAA,0BAA0B,GACrC,IAAI,uDAAqB,CAAkB;IACzC,QAAQ,EAAE,aAAa;IACvB,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KACtD;CACF,CAAC,CAAC"}

package/build/_modules/location/_collections/loc-regions.util.d.ts

@@ -13,8 +13,41 @@ export declare class DyFM_Regions {
     private static getAllDivisions;
     private static getAllPhoneCodes;
     private static getAllCountryISO;
+    /**
+     * Converts an ISO-3166 code to a country ISO object.
+     * @param iso2 The ISO-3166 code to convert.
+     * @returns The country ISO object.
+     *
+     * @example
+     * ```ts
+     * const country: DyFM_CountryISO = DyFM_Regions.isoToCountryIso('US');
+     * console.log(country.name); // United States
+     * ```
+     */
     static isoToCountryIso(iso2: string): DyFM_CountryISO;
+    /**
+     * Converts an ISO-3166 code to a region.
+     * @param iso2 The ISO-3166 code to convert.
+     * @returns The region.
+     *
+     * @example
+     * ```ts
+     * const region: DyFM_Region = DyFM_Regions.isoToRegion('US');
+     * console.log(region); // North America
+     * ```
+     */
     static isoToRegion(iso2: string): DyFM_Region;
+    /**
+     * Converts an ISO-3166 code to a phone code.
+     * @param iso2 The ISO-3166 code to convert.
+     * @returns The phone code.
+     *
+     * @example
+     * ```ts
+     * const phoneCode: DyFM_CountryPhoneCode = DyFM_Regions.isoToPhoneCode('US');
+     * console.log(phoneCode.code); // +1
+     * ```
+     */
     static isoToPhoneCode(iso2: string): DyFM_CountryPhoneCode;
 }
 //# sourceMappingURL=loc-regions.util.d.ts.map

package/build/_modules/location/_collections/loc-regions.util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loc-regions.util.d.ts","sourceRoot":"","sources":["../../../../src/_modules/location/_collections/loc-regions.util.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EACL,qBAAqB,EACtB,MAAM,6CAA6C,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AAMjF;;;GAGG;AACH,qBAAa,YAAY;IAEvB,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,EAAE,CAAkC;IACnF,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,qBAAqB,EAAE,CAAmC;IACtF,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,eAAe,EAAE,CAAmC;IAEjF,OAAO,CAAC,MAAM,CAAC,eAAe;IAK9B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAS/B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAiB/B,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe;IAcrD,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW;IAc7C,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB;CAa3D"}
+{"version":3,"file":"loc-regions.util.d.ts","sourceRoot":"","sources":["../../../../src/_modules/location/_collections/loc-regions.util.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EACL,qBAAqB,EACtB,MAAM,6CAA6C,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AAMjF;;;GAGG;AACH,qBAAa,YAAY;IAEvB,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,EAAE,CAAkC;IACnF,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,qBAAqB,EAAE,CAAmC;IACtF,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,eAAe,EAAE,CAAmC;IAEjF,OAAO,CAAC,MAAM,CAAC,eAAe;IAK9B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAS/B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAiB/B;;;;;;;;;;OAUG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe;IAcrD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW;IAc7C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB;CAa3D"}