@creator.co/wapi 1.2.5 → 1.2.6

package/dist/src/Config/EnvironmentVar.js

@@ -49,10 +49,12 @@ var client_ssm_1 = require("@aws-sdk/client-ssm");
  */
 var ssmClient = null, secretsClient = null;
 /**
- * ${1:Description placeholder}
- *
- * @export
+ * An enumeration representing different types of environments.
  * @enum {number}
+ * @readonly
+ * @property {number} PlainRemote - Represents a plain remote environment.
+ * @property {number} SecureRemote - Represents a secure remote environment.
+ * @property {number} Local - Represents a local environment.
  */
 var EnvironmentType;
 (function (EnvironmentType) {
@@ -61,22 +63,16 @@ var EnvironmentType;
     EnvironmentType[EnvironmentType["Local"] = 2] = "Local";
 })(EnvironmentType || (exports.EnvironmentType = EnvironmentType = {}));
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class EnvironmentVar
- * @typedef {EnvironmentVar}
- * @template T
+ * Represents an environment variable with methods to resolve its value based on the environment type.
+ * @template T - The type of the environment variable value.
  */
 var EnvironmentVar = /** @class */ (function () {
     /**
-     * Creates an instance of EnvironmentVar.
-     *
-     * @constructor
-     * @param {string} paramName
-     * @param {EnvironmentType} type
-     * @param {?boolean} [optional]
-     * @param {string} [paramPrefix=`/creatorco-api-\${process.env.STAGE\}/env/`]
+     * Constructs a new instance of the EnvironmentVar class.
+     * @param {string} paramName - The name of the environment variable.
+     * @param {EnvironmentType} type - The type of the environment.
+     * @param {boolean} [optional] - Indicates whether the environment variable is optional.
+     * @param {string} [paramPrefix] - The prefix to be added to the environment variable name.
      */
     function EnvironmentVar(paramName, type, optional, paramPrefix /* only allowed process.env */) {
         if (paramPrefix === void 0) { paramPrefix = "/creatorco-api-".concat(process.env.STAGE, "/env/"); }
@@ -86,10 +82,9 @@ var EnvironmentVar = /** @class */ (function () {
         this.paramPrefix = paramPrefix;
     }
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {T}
+     * Resolves the value of the environment variable synchronously.
+     * @returns {T} - The resolved value of the environment variable.
+     * @throws {Error} - If the environment type is not 'Local'.
      */
     EnvironmentVar.prototype.syncResolve = function () {
         if (this.type == EnvironmentType.Local)
@@ -99,11 +94,8 @@ var EnvironmentVar = /** @class */ (function () {
         }
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @async
-     * @returns {unknown}
+     * Resolves the value based on the environment type.
+     * @returns {Promise<any>} - The resolved value.
      */
     EnvironmentVar.prototype.resolve = function () {
         return __awaiter(this, void 0, void 0, function () {
@@ -119,10 +111,9 @@ var EnvironmentVar = /** @class */ (function () {
         });
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @returns {T}
+     * Retrieves the value of a local environment variable.
+     * @returns {T} - The value of the local environment variable.
+     * @throws {Error} - If the local environment variable is not defined and is not optional.
      */
     EnvironmentVar.prototype.getLocalValue = function () {
         var value = process.env[this.paramName];
@@ -132,11 +123,9 @@ var EnvironmentVar = /** @class */ (function () {
         return value;
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @async
-     * @returns {Promise<T>}
+     * Retrieves the plain value of a remote environment parameter.
+     * @returns {Promise<T>} - A promise that resolves to the plain value of the parameter.
+     * @throws {Error} - If the parameter cannot be retrieved and is not optional.
      */
     EnvironmentVar.prototype.getPlainValue = function () {
         return __awaiter(this, void 0, void 0, function () {
@@ -170,11 +159,9 @@ var EnvironmentVar = /** @class */ (function () {
         });
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @async
-     * @returns {Promise<T>}
+     * Retrieves a secure value from the secrets manager.
+     * @returns {Promise<T>} - A promise that resolves to the secure value.
+     * @throws {Error} - Throws an error if the secure value cannot be retrieved and is not optional.
      */
     EnvironmentVar.prototype.getSecureValue = function () {
         return __awaiter(this, void 0, void 0, function () {
@@ -191,8 +178,8 @@ var EnvironmentVar = /** @class */ (function () {
                         return [4 /*yield*/, secretsClient.send(new client_secrets_manager_1.GetSecretValueCommand({ SecretId: pName }))];
                     case 2:
                         data = _a.sent();
-                        if (data.Parameter && data.Parameter.Value)
-                            return [2 /*return*/, data.Parameter.Value];
+                        if (data.SecretString)
+                            return [2 /*return*/, data.SecretString];
                         return [3 /*break*/, 4];
                     case 3:
                         error_2 = _a.sent();

package/dist/src/Config/EnvironmentVar.js.map

@@ -1 +1 @@
-{"version":3,"file":"EnvironmentVar.js","sourceRoot":"","sources":["../../../src/Config/EnvironmentVar.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0EAA6F;AAC7F,kDAAoE;AAEpE,2DAA2D;AAC3D,mDAAmD;AACnD,kCAAkC;AAClC;;;;GAIG;AACH,IAAI,SAAS,GAAG,IAAI,EAClB,aAAa,GAAG,IAAI,CAAA;AAEtB;;;;;GAKG;AACH,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,mEAAW,CAAA;IACX,qEAAY,CAAA;IACZ,uDAAK,CAAA;AACP,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AACD;;;;;;;GAOG;AACH;IAiCE;;;;;;;;OAQG;IACH,wBACE,SAAiB,EACjB,IAAqB,EACrB,QAAkB,EAClB,WAAwD,CAAC,8BAA8B;QAAvF,4BAAA,EAAA,uCAAgC,OAAO,CAAC,GAAG,CAAC,KAAK,UAAO;QAExD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAA;QAC1B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,oCAAW,GAAlB;QACE,IAAI,IAAI,CAAC,IAAI,IAAI,eAAe,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,aAAa,EAAE,CAAA;aAC9D;YACH,MAAM,IAAI,KAAK,CACb,uFAAuF,CACxF,CAAA;SACF;IACH,CAAC;IACD;;;;;;OAMG;IACU,gCAAO,GAApB;;;gBACE,IAAI,IAAI,CAAC,IAAI,IAAI,eAAe,CAAC,KAAK;oBAAE,sBAAO,IAAI,CAAC,aAAa,EAAE,EAAA;qBAC9D,IAAI,IAAI,CAAC,IAAI,IAAI,eAAe,CAAC,YAAY;oBAAE,sBAAO,IAAI,CAAC,cAAc,EAAE,EAAA;;oBAC3E,sBAAO,IAAI,CAAC,aAAa,EAAE,EAAA;;;;KACjC;IAED;;;;;OAKG;IACK,sCAAa,GAArB;QACE,IAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACzC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC5B,MAAM,IAAI,KAAK,CACb,4BAAqB,IAAI,CAAC,SAAS,sEAAmE,CACvG,CAAA;SACF;QACD,OAAO,KAAU,CAAA;IACnB,CAAC;IACD;;;;;;OAMG;IACW,sCAAa,GAA3B;;;;;;wBACE,IAAI,CAAC,SAAS;4BAAE,SAAS,GAAG,IAAI,sBAAS,EAAE,CAAA;wBACrC,KAAK,GAAG,UAAG,IAAI,CAAC,WAAW,SAAG,IAAI,CAAC,SAAS,CAAE,CAAA;;;;wBAErC,qBAAM,SAAS,CAAC,IAAI,CAAC,IAAI,gCAAmB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,EAAA;;wBAArE,IAAI,GAAG,SAA8D;wBAC3E,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK;4BAAE,sBAAO,IAAI,CAAC,SAAS,CAAC,KAAU,EAAA;;;;wBAE5E,OAAO,CAAC,KAAK,CAAC,OAAK,CAAC,CAAA;;;wBAEtB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;4BAClB,MAAM,IAAI,KAAK,CAAC,qDAA8C,KAAK,CAAE,CAAC,CAAA;yBACvE;;;;;KACF;IACD;;;;;;OAMG;IACW,uCAAc,GAA5B;;;;;;wBACE,IAAI,CAAC,aAAa;4BAAE,aAAa,GAAG,IAAI,6CAAoB,EAAE,CAAA;wBACxD,KAAK,GAAG,UAAG,IAAI,CAAC,WAAW,SAAG,IAAI,CAAC,SAAS,CAAE,CAAA;;;;wBAErC,qBAAM,aAAa,CAAC,IAAI,CAAC,IAAI,8CAAqB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,EAAA;;wBAA/E,IAAI,GAAG,SAAwE;wBACrF,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK;4BAAE,sBAAO,IAAI,CAAC,SAAS,CAAC,KAAU,EAAA;;;;wBAE5E,OAAO,CAAC,KAAK,CAAC,OAAK,CAAC,CAAA;;;wBAEtB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;4BAClB,MAAM,IAAI,KAAK,CAAC,gDAAyC,KAAK,CAAE,CAAC,CAAA;yBAClE;;;;;KACF;IACH,qBAAC;AAAD,CAAC,AAxID,IAwIC"}
+{"version":3,"file":"EnvironmentVar.js","sourceRoot":"","sources":["../../../src/Config/EnvironmentVar.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0EAA6F;AAC7F,kDAAoE;AAEpE,2DAA2D;AAC3D,mDAAmD;AACnD,kCAAkC;AAClC;;;;GAIG;AACH,IAAI,SAAS,GAAqB,IAAI,EACpC,aAAa,GAAgC,IAAI,CAAA;AAEnD;;;;;;;GAOG;AACH,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,mEAAW,CAAA;IACX,qEAAY,CAAA;IACZ,uDAAK,CAAA;AACP,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AACD;;;GAGG;AACH;IAoBE;;;;;;OAMG;IACH,wBACE,SAAiB,EACjB,IAAqB,EACrB,QAAkB,EAClB,WAAwD,CAAC,8BAA8B;QAAvF,4BAAA,EAAA,uCAAgC,OAAO,CAAC,GAAG,CAAC,KAAK,UAAO;QAExD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAA;QAC1B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAED;;;;OAIG;IACI,oCAAW,GAAlB;QACE,IAAI,IAAI,CAAC,IAAI,IAAI,eAAe,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,aAAa,EAAE,CAAA;aAC9D;YACH,MAAM,IAAI,KAAK,CACb,uFAAuF,CACxF,CAAA;SACF;IACH,CAAC;IAED;;;OAGG;IACU,gCAAO,GAApB;;;gBACE,IAAI,IAAI,CAAC,IAAI,IAAI,eAAe,CAAC,KAAK;oBAAE,sBAAO,IAAI,CAAC,aAAa,EAAE,EAAA;qBAC9D,IAAI,IAAI,CAAC,IAAI,IAAI,eAAe,CAAC,YAAY;oBAAE,sBAAO,IAAI,CAAC,cAAc,EAAE,EAAA;;oBAC3E,sBAAO,IAAI,CAAC,aAAa,EAAE,EAAA;;;;KACjC;IAED;;;;OAIG;IACK,sCAAa,GAArB;QACE,IAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACzC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC5B,MAAM,IAAI,KAAK,CACb,4BAAqB,IAAI,CAAC,SAAS,sEAAmE,CACvG,CAAA;SACF;QACD,OAAO,KAAU,CAAA;IACnB,CAAC;IAED;;;;OAIG;IACW,sCAAa,GAA3B;;;;;;wBACE,IAAI,CAAC,SAAS;4BAAE,SAAS,GAAG,IAAI,sBAAS,EAAE,CAAA;wBACrC,KAAK,GAAG,UAAG,IAAI,CAAC,WAAW,SAAG,IAAI,CAAC,SAAS,CAAE,CAAA;;;;wBAErC,qBAAM,SAAS,CAAC,IAAI,CAAC,IAAI,gCAAmB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,EAAA;;wBAArE,IAAI,GAAG,SAA8D;wBAC3E,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK;4BAAE,sBAAO,IAAI,CAAC,SAAS,CAAC,KAAU,EAAA;;;;wBAE5E,OAAO,CAAC,KAAK,CAAC,OAAK,CAAC,CAAA;;;wBAEtB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;4BAClB,MAAM,IAAI,KAAK,CAAC,qDAA8C,KAAK,CAAE,CAAC,CAAA;yBACvE;;;;;KACF;IAED;;;;OAIG;IACW,uCAAc,GAA5B;;;;;;wBACE,IAAI,CAAC,aAAa;4BAAE,aAAa,GAAG,IAAI,6CAAoB,EAAE,CAAA;wBACxD,KAAK,GAAG,UAAG,IAAI,CAAC,WAAW,SAAG,IAAI,CAAC,SAAS,CAAE,CAAA;;;;wBAErC,qBAAM,aAAa,CAAC,IAAI,CAAC,IAAI,8CAAqB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,EAAA;;wBAA/E,IAAI,GAAG,SAAwE;wBACrF,IAAI,IAAI,CAAC,YAAY;4BAAE,sBAAO,IAAI,CAAC,YAAiB,EAAA;;;;wBAEpD,OAAO,CAAC,KAAK,CAAC,OAAK,CAAC,CAAA;;;wBAEtB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;4BAClB,MAAM,IAAI,KAAK,CAAC,gDAAyC,KAAK,CAAE,CAAC,CAAA;yBAClE;;;;;KACF;IACH,qBAAC;AAAD,CAAC,AAnHD,IAmHC"}

package/dist/src/Crypto/Crypto.d.ts

@@ -1,57 +1,39 @@
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class Crypto
- * @typedef {Crypto}
+ * Represents a Crypto class that provides encryption and decryption functionality using AWS KMS.
  */
 export default class Crypto {
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @readonly
-     * @type {KMSClient}
+     * The KMSClient instance used for making requests to the Key Management Service (KMS).
      */
     private readonly client;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @readonly
-     * @type {string}
+     * The AWS region of the object. This property is readonly and cannot be modified once set.
      */
     private readonly region;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
+     * The unique identifier for the KMS.
      * @readonly
      * @type {string}
      */
     private readonly keyId;
     /**
-     * Creates an instance of Crypto.
-     *
-     * @constructor
-     * @param {string} region
-     * @param {string} keyId
+     * Constructs a new instance of the KMSClient class.
+     * @param {string} region - The AWS region to use for the client.
+     * @param {string} keyId - The AWS KMS key ID to use for encryption and decryption operations.
+     * @returns None
      */
     constructor(region: string, keyId: string);
     /**
-     * ${1:Description placeholder}
-     *
-     * @async
-     * @param {(string | any)} data
-     * @returns {Promise<string>}
+     * Encrypts the given data using RSAES_OAEP_SHA_256 encryption algorithm.
+     * @param {string | any} data - The data to be encrypted.
+     * @returns {Promise<string | null>} - A promise that resolves to the encrypted data as a hexadecimal string.
      */
-    encryptData(data: string | any): Promise<string>;
+    encryptData(data: string | any): Promise<string | null>;
     /**
-     * ${1:Description placeholder}
-     *
-     * @async
-     * @param {string} data
-     * @returns {Promise<string>}
+     * Decrypts the given data using the RSAES_OAEP_SHA_256 encryption algorithm.
+     * @param {string} data - The encrypted data to decrypt.
+     * @returns {Promise<string | null>} - A promise that resolves to the decrypted plaintext string.
+     * If decryption fails, null is returned.
      */
-    decryptData(data: string): Promise<string>;
+    decryptData(data: string): Promise<string | null>;
 }

package/dist/src/Crypto/Crypto.js

@@ -38,32 +38,24 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var client_kms_1 = require("@aws-sdk/client-kms");
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class Crypto
- * @typedef {Crypto}
+ * Represents a Crypto class that provides encryption and decryption functionality using AWS KMS.
  */
 var Crypto = /** @class */ (function () {
     /**
-     * Creates an instance of Crypto.
-     *
-     * @constructor
-     * @param {string} region
-     * @param {string} keyId
+     * Constructs a new instance of the KMSClient class.
+     * @param {string} region - The AWS region to use for the client.
+     * @param {string} keyId - The AWS KMS key ID to use for encryption and decryption operations.
+     * @returns None
      */
     function Crypto(region, keyId) {
         this.region = region;
         this.keyId = keyId;
         this.client = new client_kms_1.KMSClient({ region: this.region });
     }
-    //
     /**
-     * ${1:Description placeholder}
-     *
-     * @async
-     * @param {(string | any)} data
-     * @returns {Promise<string>}
+     * Encrypts the given data using RSAES_OAEP_SHA_256 encryption algorithm.
+     * @param {string | any} data - The data to be encrypted.
+     * @returns {Promise<string | null>} - A promise that resolves to the encrypted data as a hexadecimal string.
      */
     Crypto.prototype.encryptData = function (data) {
         return __awaiter(this, void 0, void 0, function () {
@@ -90,11 +82,10 @@ var Crypto = /** @class */ (function () {
         });
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @async
-     * @param {string} data
-     * @returns {Promise<string>}
+     * Decrypts the given data using the RSAES_OAEP_SHA_256 encryption algorithm.
+     * @param {string} data - The encrypted data to decrypt.
+     * @returns {Promise<string | null>} - A promise that resolves to the decrypted plaintext string.
+     * If decryption fails, null is returned.
      */
     Crypto.prototype.decryptData = function (data) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/src/Crypto/Crypto.js.map

@@ -1 +1 @@
-{"version":3,"file":"Crypto.js","sourceRoot":"","sources":["../../../src/Crypto/Crypto.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA+E;AAE/E;;;;;;GAMG;AACH;IAyBE;;;;;;OAMG;IACH,gBAAY,MAAc,EAAE,KAAa;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,MAAM,GAAG,IAAI,sBAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IACtD,CAAC;IACD,EAAE;IACF;;;;;;OAMG;IACG,4BAAW,GAAjB,UAAkB,IAAkB;;;;;;;wBAEnB,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,IAAI,2BAAc,CAAC;gCACjB,KAAK,EAAE,IAAI,CAAC,KAAK;gCACjB,mBAAmB,EAAE,oBAAoB;gCACzC,SAAS,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CACjC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACvD;6BACF,CAAC,CACH,EAAA;;wBARK,IAAI,GAAG,SAQZ;wBACD,sBAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAqB,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAA;;;wBAEtE,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,GAAC,CAAC,CAAA;wBACtC,sBAAO,IAAI,EAAA;;;;;KAEd;IACD;;;;;;OAMG;IACG,4BAAW,GAAjB,UAAkB,IAAY;;;;;;;wBAEb,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,IAAI,2BAAc,CAAC;gCACjB,KAAK,EAAE,IAAI,CAAC,KAAK;gCACjB,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC;gCACxC,mBAAmB,EAAE,oBAAoB;6BAC1C,CAAC,CACH,EAAA;;wBANK,IAAI,GAAG,SAMZ;wBACD,sBAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAA;;;wBAE/C,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,GAAC,CAAC,CAAA;wBACtC,sBAAO,IAAI,EAAA;;;;;KAEd;IACH,aAAC;AAAD,CAAC,AApFD,IAoFC"}
+{"version":3,"file":"Crypto.js","sourceRoot":"","sources":["../../../src/Crypto/Crypto.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA+E;AAE/E;;GAEG;AACH;IAgBE;;;;;OAKG;IACH,gBAAY,MAAc,EAAE,KAAa;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,MAAM,GAAG,IAAI,sBAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IACtD,CAAC;IAED;;;;OAIG;IACU,4BAAW,GAAxB,UAAyB,IAAkB;;;;;;;wBAE1B,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,IAAI,2BAAc,CAAC;gCACjB,KAAK,EAAE,IAAI,CAAC,KAAK;gCACjB,mBAAmB,EAAE,oBAAoB;gCACzC,SAAS,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CACjC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACvD;6BACF,CAAC,CACH,EAAA;;wBARK,IAAI,GAAG,SAQZ;wBACD,sBAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAqB,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAA;;;wBAEtE,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,GAAC,CAAC,CAAA;wBACtC,sBAAO,IAAI,EAAA;;;;;KAEd;IAED;;;;;OAKG;IACU,4BAAW,GAAxB,UAAyB,IAAY;;;;;;;wBAEpB,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,IAAI,2BAAc,CAAC;gCACjB,KAAK,EAAE,IAAI,CAAC,KAAK;gCACjB,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC;gCACxC,mBAAmB,EAAE,oBAAoB;6BAC1C,CAAC,CACH,EAAA;;wBANK,IAAI,GAAG,SAMZ;wBACD,sBAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAA;;;wBAE/C,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,GAAC,CAAC,CAAA;wBACtC,sBAAO,IAAI,EAAA;;;;;KAEd;IACH,aAAC;AAAD,CAAC,AAxED,IAwEC"}

package/dist/src/Crypto/JWT.d.ts

@@ -1,8 +1,10 @@
 import * as jwt from 'jsonwebtoken';
 /**
- * ${1:Description placeholder}
- *
- * @typedef {JWTValidationResponse}
+ * Represents the response of a JWT validation.
+ * @typedef {Object} JWTValidationResponse
+ * @property {boolean} isValid - Indicates whether the JWT is valid or not.
+ * @property {jwt.JwtPayload} [decodedToken] - The decoded JWT payload if the JWT is valid.
+ * @property {boolean} [isExpired] - Indicates whether the JWT is expired or not, only present if isValid is false.
  */
 type JWTValidationResponse = {
     isValid: true;
@@ -12,52 +14,39 @@ type JWTValidationResponse = {
     isExpired?: boolean;
 };
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class JWT
- * @typedef {JWT}
+ * Represents a JSON Web Token (JWT) utility class.
  */
 export default class JWT {
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @readonly
+     * The secret key used for generating and verifying tokens.
      * @type {string}
      */
     private readonly tokenSecret;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @readonly
+     * The default expiration time for a cache entry.
      * @type {string}
      */
     private readonly defaultExpiration;
     /**
-     * Creates an instance of JWT.
-     *
-     * @constructor
-     * @param {string} tokenSecret
-     * @param {?string} [defaultExpiration]
+     * Constructs a new instance of the class.
+     * @param {string} tokenSecret - The secret used to sign the tokens.
+     * @param {string} [defaultExpiration] - The default expiration time for the tokens.
+     * @returns None
      */
     constructor(tokenSecret: string, defaultExpiration?: string);
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {object} data
-     * @param {?string} [expiration]
-     * @param {?string} [overrideToken]
-     * @param {?*} [opts]
-     * @returns {string}
+     * Creates a JSON Web Token (JWT) using the provided data and options.
+     * @param {object} data - The data to be included in the token payload.
+     * @param {string} [expiration] - The expiration time for the token. If not provided, the default expiration time will be used.
+     * @param {string} [overrideToken] - An optional token secret to override the default token secret.
+     * @param {any} [opts] - Additional options to be passed to the jwt.sign() function.
+     * @returns {string} - The generated JWT.
      */
     createToken(data: object, expiration?: string, overrideToken?: string, opts?: any): string;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {string} token
-     * @returns {JWTValidationResponse}
+     * Validates a JSON Web Token (JWT) and returns the validation response.
+     * @param {string} token - The JWT to validate.
+     * @returns {JWTValidationResponse} - The validation response object.
      */
     validateToken(token: string): JWTValidationResponse;
 }

package/dist/src/Crypto/JWT.js

@@ -13,43 +13,35 @@ var __assign = (this && this.__assign) || function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 var jwt = require("jsonwebtoken");
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class JWT
- * @typedef {JWT}
+ * Represents a JSON Web Token (JWT) utility class.
  */
 var JWT = /** @class */ (function () {
     /**
-     * Creates an instance of JWT.
-     *
-     * @constructor
-     * @param {string} tokenSecret
-     * @param {?string} [defaultExpiration]
+     * Constructs a new instance of the class.
+     * @param {string} tokenSecret - The secret used to sign the tokens.
+     * @param {string} [defaultExpiration] - The default expiration time for the tokens.
+     * @returns None
      */
     function JWT(tokenSecret, defaultExpiration) {
         this.tokenSecret = tokenSecret;
         this.defaultExpiration = defaultExpiration;
     }
-    //
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {object} data
-     * @param {?string} [expiration]
-     * @param {?string} [overrideToken]
-     * @param {?*} [opts]
-     * @returns {string}
+     * Creates a JSON Web Token (JWT) using the provided data and options.
+     * @param {object} data - The data to be included in the token payload.
+     * @param {string} [expiration] - The expiration time for the token. If not provided, the default expiration time will be used.
+     * @param {string} [overrideToken] - An optional token secret to override the default token secret.
+     * @param {any} [opts] - Additional options to be passed to the jwt.sign() function.
+     * @returns {string} - The generated JWT.
      */
     JWT.prototype.createToken = function (data, expiration, overrideToken, opts) {
         var exp = expiration || this.defaultExpiration;
         return jwt.sign(data, overrideToken || this.tokenSecret, exp ? __assign({ expiresIn: exp }, (opts || {})) : opts || {});
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {string} token
-     * @returns {JWTValidationResponse}
+     * Validates a JSON Web Token (JWT) and returns the validation response.
+     * @param {string} token - The JWT to validate.
+     * @returns {JWTValidationResponse} - The validation response object.
      */
     JWT.prototype.validateToken = function (token) {
         try {

package/dist/src/Crypto/JWT.js.map

@@ -1 +1 @@
-{"version":3,"file":"JWT.js","sourceRoot":"","sources":["../../../src/Crypto/JWT.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,kCAAmC;AAcnC;;;;;;GAMG;AACH;IAiBE;;;;;;OAMG;IACH,aAAY,WAAmB,EAAE,iBAA0B;QACzD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;IAC5C,CAAC;IACD,EAAE;IACF;;;;;;;;OAQG;IACH,yBAAW,GAAX,UAAY,IAAY,EAAE,UAAmB,EAAE,aAAsB,EAAE,IAAU;QAC/E,IAAM,GAAG,GAAG,UAAU,IAAI,IAAI,CAAC,iBAAiB,CAAA;QAChD,OAAO,GAAG,CAAC,IAAI,CACb,IAAI,EACJ,aAAa,IAAI,IAAI,CAAC,WAAW,EACjC,GAAG,CAAC,CAAC,YAAG,SAAS,EAAE,GAAG,IAAK,CAAC,IAAI,IAAI,EAAE,CAAC,EAAG,CAAC,CAAC,IAAI,IAAI,EAAE,CACvD,CAAA;IACH,CAAC;IACD;;;;;OAKG;IACH,2BAAa,GAAb,UAAc,KAAa;QACzB,IAAI;YACF,oBAAoB;YACpB,IAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;YACnD,IAAI,OAAO,EAAE;gBACX,IAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;gBACjD,IAAI,OAAO;oBAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,CAAA;aAC7D;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAClB,IAAI,GAAG,YAAY,GAAG,CAAC,iBAAiB;gBAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAA;SACrF;QACD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IAC3B,CAAC;IACH,UAAC;AAAD,CAAC,AAlED,IAkEC"}
+{"version":3,"file":"JWT.js","sourceRoot":"","sources":["../../../src/Crypto/JWT.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,kCAAmC;AAgBnC;;GAEG;AACH;IAYE;;;;;OAKG;IACH,aAAY,WAAmB,EAAE,iBAA0B;QACzD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;IAC5C,CAAC;IAED;;;;;;;OAOG;IACI,yBAAW,GAAlB,UACE,IAAY,EACZ,UAAmB,EACnB,aAAsB,EACtB,IAAU;QAEV,IAAM,GAAG,GAAG,UAAU,IAAI,IAAI,CAAC,iBAAiB,CAAA;QAChD,OAAO,GAAG,CAAC,IAAI,CACb,IAAI,EACJ,aAAa,IAAI,IAAI,CAAC,WAAW,EACjC,GAAG,CAAC,CAAC,YAAG,SAAS,EAAE,GAAG,IAAK,CAAC,IAAI,IAAI,EAAE,CAAC,EAAG,CAAC,CAAC,IAAI,IAAI,EAAE,CACvD,CAAA;IACH,CAAC;IAED;;;;OAIG;IACI,2BAAa,GAApB,UAAqB,KAAa;QAChC,IAAI;YACF,oBAAoB;YACpB,IAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;YACnD,IAAI,OAAO,EAAE;gBACX,IAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;gBACjD,IAAI,OAAO;oBAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,CAAA;aAC7D;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAClB,IAAI,GAAG,YAAY,GAAG,CAAC,iBAAiB;gBAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAA;SACrF;QACD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IAC3B,CAAC;IACH,UAAC;AAAD,CAAC,AAhED,IAgEC"}

package/dist/src/Globals.d.ts

@@ -1,161 +1,93 @@
 /**
- * Description placeholder
- *
- * @export
- * @class Globals
- * @typedef {Globals}
+ * Class containing global constants and configurations for the application.
  */
 export default class Globals {
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * A constant string representing an error message for input validation failure.
      */
     static ErrorResponseValidationFail: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * A constant string representing an error response for an invalid server response.
      */
     static ErrorResponseInvalidServerResponse: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * The error message for an unhandled error when processing a request.
      */
     static ErrorResponseUnhandledError: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * A static string representing an error response when there are no records to be processed.
      */
     static ErrorResponseNoRecords: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * Represents an error code for a missing parameter.
      * @type {string}
      */
     static ErrorCode_MissingParam: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * Represents an error code for invalid input.
      * @type {string}
      */
     static ErrorCode_InvalidInput: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * Represents an error code for an API error.
      * @type {string}
      */
     static ErrorCode_APIError: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * Represents the error code for when there are no records found.
      * @type {string}
      */
     static ErrorCode_NoRecords: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {*}
+     * Retrieves the default port number for HTTP listeners.
+     * The port number is obtained from the environment variable "PORT" and parsed as an integer.
+     * If the environment variable is not set or cannot be parsed as an integer, the default port number 9000 is used.
+     * @returns {number} - The default port number for HTTP listeners.
      */
     static Listener_HTTP_DefaultPort: number;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * The default host for the HTTP listener.
      */
     static Listener_HTTP_DefaultHost: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * The HTTP proxy route listener for all routes.
      * @type {string}
      */
     static Listener_HTTP_ProxyRoute: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {*}
+     * Retrieves the default timeout value for HTTP listeners.
+     * @returns {number} The default timeout value in milliseconds.
      */
     static Listener_HTTP_DefaultTimeout: number;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {*}
+     * The default health check route for the HTTP listener.
+     * @type {string}
      */
     static Listener_HTTP_DefaultHealthCheckRoute: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * The response message for an exception that occurred during request execution in the Proxy.
      */
     static Resp_MSG_EXCEPTION: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * The response code for an exception that occurred during execution.
      */
     static Resp_CODE_EXCEPTION: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {number}
+     * The HTTP response status code for an exception scenario.
      */
     static Resp_STATUSCODE_EXCEPTION: number;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * The error message for an invalid response from the server.
      */
     static Resp_MSG_INVALIDRESP: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * Represents the response code for an invalid response.
      */
     static Resp_CODE_INVALIDRESP: string;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * The HTTP response status code for an invalid response.
      * @type {number}
+     * @default 400
      */
     static Resp_STATUSCODE_INVALIDRESP: number;
 }