@creator.co/wapi 1.2.5 → 1.2.6

package/dist/src/BaseEvent/Transaction.js

@@ -78,10 +78,29 @@ var DatabaseManager_1 = require("../Database/DatabaseManager");
 var Globals_1 = require("../Globals");
 var Logger_1 = require("../Logger/Logger");
 var Publisher_1 = require("../Publisher/Publisher");
+/**
+ * Represents a transaction object that handles the execution of a request and manages the response.
+ * @template InputType - The type of the input data for the transaction.
+ * @template ResponseInnerType - The type of the inner response data for the transaction.
+ * @template MiscRespType - The type of miscellaneous response data for the transaction.
+ */
 var Transaction = /** @class */ (function () {
-    //
+    /**
+     * Constructs a new instance of the Transaction class.
+     * @param {APIGatewayEvent | SQSEvent} event - The event object passed to the Lambda function.
+     * @param {Context} context - The context object passed to the Lambda function.
+     * @param {TransactionConfig} [config] - Optional configuration object for the transaction.
+     * @returns None
+     */
     function Transaction(event, context, config) {
+        /**
+         * The instance of the DatabaseManager class used for managing the database.
+         */
         this.databaseManager = DatabaseManager_1.DatabaseManager.INSTANCE;
+        /**
+         * An array of database transactions.
+         * @type {DatabaseTransaction[]}
+         */
         this.transactions = [];
         var transactionId = context.awsRequestId
             ? context.awsRequestId
@@ -102,7 +121,12 @@ var Transaction = /** @class */ (function () {
         this.request = new Request_1.default(this.event, this.context, this.logger);
         this.publisher = new Publisher_1.default(config === null || config === void 0 ? void 0 : config.publisher);
     }
-    //Main interface
+    /**
+     * Executes a transaction using the provided execution function and returns a promise
+     * that resolves to the response or miscellaneous response.
+     * @param {TransactionExecution<Transaction<InputType, ResponseInnerType, MiscRespType>, ResponseInnerType, MiscRespType>} executionFunc - The execution function to be executed.
+     * @returns {Promise<Response<ResponseInnerType | ResponseErrorType> | MiscRespType>} - A promise that resolves to the response or miscellaneous response.
+     */
     Transaction.prototype.execute = function (executionFunc) {
         return __awaiter(this, void 0, void 0, function () {
             var _this = this;
@@ -141,7 +165,11 @@ var Transaction = /** @class */ (function () {
             });
         });
     };
-    //Executions
+    /**
+     * Executes a transaction using the provided execution function and handles the response.
+     * @param {TransactionExecution<Transaction<InputType, ResponseInnerType, MiscRespType>, ResponseInnerType, MiscRespType>} executionFunc - The function to execute the transaction.
+     * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the execution failed or not.
+     */
     Transaction.prototype.iexecute = function (executionFunc) {
         return __awaiter(this, void 0, void 0, function () {
             var executionFailed, _a, e_1;
@@ -222,6 +250,12 @@ var Transaction = /** @class */ (function () {
             });
         });
     };
+    /*
+     * Executes a series of database transactions in a safe manner.
+     * @param {Function} safeExecution - The function that contains the database transactions to be executed.
+     * @returns None
+     * @throws {Error} - If an exception occurs during the execution of the transactions and `retrowErrors` is true.
+     */
     Transaction.prototype.executeDBTransactions = function (safeExecution) {
         return __awaiter(this, void 0, void 0, function () {
             var execFailed, _a, _b, transaction, e_2, e_3_1, e_4, _c, _d, transaction, e_5, e_6_1;
@@ -317,6 +351,12 @@ var Transaction = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Executes a logger flush operation with error handling and logging.
+     * @param {Function} safeExecution - The function to execute safely.
+     * @returns None
+     * @throws {Error} - If `retrowErrors` is true and an error occurs during execution.
+     */
     Transaction.prototype.executeLoggerFlush = function (safeExecution) {
         return __awaiter(this, void 0, void 0, function () {
             var e_7;
@@ -344,7 +384,12 @@ var Transaction = /** @class */ (function () {
             });
         });
     };
-    /* Response support */
+    /**
+     * Returns an error response with the specified error message and error code.
+     * @param {string} error - The error message.
+     * @param {string} code - The error code.
+     * @returns {Response<ResponseErrorType>} - The error response.
+     */
     Transaction.prototype.getErrorResponse = function (error, code) {
         return Response_1.default.BadRequestResponseWithRollback(error, code);
     };

package/dist/src/BaseEvent/Transaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../../src/BaseEvent/Transaction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,0CAAoC;AACpC,4CAA6D;AAC7D,+DAA6D;AAG7D,sCAAgC;AAChC,2CAAuD;AACvD,oDAAmE;AAenE;IAkBE,EAAE;IACF,qBAAY,KAAiC,EAAE,OAAgB,EAAE,MAA0B;QAdnF,oBAAe,GAAoB,iCAAe,CAAC,QAAQ,CAAA;QAC3D,iBAAY,GAA0B,EAAE,CAAA;QAc9C,IAAM,aAAa,GAAG,OAAO,CAAC,YAAY;YACxC,CAAC,CAAC,OAAO,CAAC,YAAY;YACtB,CAAC,CAAmB,KAAM,CAAC,cAAc;gBACzC,CAAC,CAAmB,KAAM,CAAC,cAAc,CAAC,SAAS;gBACnD,CAAC,CAAC,SAAS,CAAA;QACb,kBAAkB;QAClB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,kJAAkJ;QAClJ,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;QACzB,oBAAoB;QACpB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,CAAA,CAAA;QACtC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,aAAa,CAAA,CAAA,CAAC,4BAA4B;QACxE,aAAa;QACb,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,EAAE,aAAa,CAAC,CAAA;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAY,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QAC5E,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAS,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,CAAC,CAAA;IACnD,CAAC;IAED,gBAAgB;IACH,6BAAO,GAApB,UACE,aAIC;;;;;4BAED,qBAAM,IAAI,CAAC,kBAAkB,CAAC;;;;4CAC5B,qBAAM,IAAI,CAAC,qBAAqB,CAAC;;;4DACxB,qBAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAA;4DAAzC,sBAAO,SAAkC,EAAA;;;6CAC1C,CAAC,EAAA;;wCAFF,SAEE,CAAA;;;;6BACH,CAAC;wBACF,kDAAkD;sBADhD;;wBAJF,SAIE,CAAA;wBACF,kDAAkD;wBAClD,IAAI,IAAI,CAAC,UAAU;4BAAE,sBAAO,IAAI,CAAC,QAAQ;gCACzC,wDAAwD;8BADf;wBACzC,wDAAwD;wBACxD,sBAAO,IAAI,EAAA;;;;KACZ;IAED,YAAY;IACE,8BAAQ,GAAtB,UACE,aAIC;;;;;;wBAEG,eAAe,GAAG,IAAI,CAAC,uBAAuB;wBAAxB,CAAA;;;;wBAGxB,SAAS;wBACT,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAA;wBAC/C,KAAA,IAAI,CAAA;wBAAY,qBAAM,aAAa,CAAC,IAAI,CAAC;4BACzC,eAAe;0BAD0B;;wBAAzC,GAAK,QAAQ,GAAG,SAAyB,CAAA;6BAErC,CAAA,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,YAAY,kBAAQ,CAAA,EAAlD,wBAAkD;wBACpD,qBAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAA9D,SAA8D,CAAA;wBAC9D,eAAe,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,CAAC,CAAA;;;6BAC3E,CAAA,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAA,EAAhC,wBAAgC;wBACzC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAA;wBAC7D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;wBAChC,eAAe,GAAG,KAAK,CAAA;;;wBAEvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CACnC,iBAAO,CAAC,kCAAkC,EAC1C,iBAAO,CAAC,kBAAkB,CAC3B,CAAA;wBACD,qBAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAA9D,SAA8D,CAAA;wBAC9D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAA;;;;;wBAGtE,kBAAkB;wBAClB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAA;wBAChE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAC,CAAC,CAAA;wBACxB,SAAS;wBACT,IAAI,IAAI,CAAC,YAAY;4BAAE,MAAM,GAAC,CAAA;wBAC9B,qBAAqB;wBACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CACnC,iBAAO,CAAC,2BAA2B,EACnC,iBAAO,CAAC,kBAAkB,CAC3B,CAAA;wBACD,qBAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAA9D,SAA8D,CAAA;;6BAEhE,sBAAO,eAAe,EAAA;;;;KACvB;IAED;;;;;OAKG;IACU,sCAAgB,GAA7B,UACE,MAAmB;;;;;;wBAEb,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;wBAC9B,qBAAM,EAAE,CAAC,WAAW,EAAE,EAAA;;wBAAhC,OAAO,GAAG,SAAsB;wBACtC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;wBAC/B,sBAAO,OAAc,EAAA;;;;KACtB;IAEa,2CAAqB,GAAnC,UAAoC,aAAqC;;;;;;;;wBAGlD,qBAAM,aAAa,EAAE,EAAA;;wBAAlC,UAAU,GAAG,SAAqB;;;;wBACd,KAAA,SAAA,yBAAI,IAAI,CAAC,YAAY,UAAE,OAAO,EAAE,CAAA;;;;wBAA/C,WAAW;;;;wBAElB,qBAAM,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,EAAE,EAAA;;wBAAjE,SAAiE,CAAA;;;;wBAEjE,kEAAkE;wBAClE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAA;wBAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAC,CAAC,CAAA;;;;;;;;;;;;;;;;;;;;;;wBAMF,KAAA,SAAA,yBAAI,IAAI,CAAC,YAAY,UAAE,OAAO,EAAE,CAAA;;;;wBAA/C,WAAW;;;;wBAElB,qBAAM,WAAW,CAAC,YAAY,EAAE,EAAA;;wBAAhC,SAAgC,CAAA;;;;wBAEhC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAA;wBAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAC,CAAC,CAAA;;;;;;;;;;;;;;;;;wBAG5B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAA;wBAC9D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAC,CAAC,KAAK,CAAC,CAAA;wBACxB,SAAS;wBACT,IAAI,IAAI,CAAC,YAAY;4BAAE,MAAM,GAAC,CAAA;;;;;;KAEjC;IAEa,wCAAkB,GAAhC,UAAiC,aAAa;;;;;;;wBAE1C,qBAAM,aAAa,EAAE,EAAA;;wBAArB,SAAqB,CAAA;;;;wBAErB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAA;wBAClD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAC,CAAC,CAAA;wBACxB,SAAS;wBACT,IAAI,IAAI,CAAC,YAAY;4BAAE,MAAM,GAAC,CAAA;;;wBAE9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;;;;;;KAEzC;IAED,sBAAsB;IACd,sCAAgB,GAAxB,UAAyB,KAAa,EAAE,IAAY;QAClD,OAAO,kBAAQ,CAAC,8BAA8B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAC7D,CAAC;IACH,kBAAC;AAAD,CAAC,AAxKD,IAwKC"}
+{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../../src/BaseEvent/Transaction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,0CAAoC;AACpC,4CAA6D;AAC7D,+DAA6D;AAG7D,sCAAgC;AAChC,2CAAuD;AACvD,oDAAmE;AA0BnE;;;;;GAKG;AACH;IA4DE;;;;;;OAMG;IACH,qBAAY,KAAiC,EAAE,OAAgB,EAAE,MAA0B;QA9D3F;;WAEG;QACK,oBAAe,GAAoB,iCAAe,CAAC,QAAQ,CAAA;QACnE;;;WAGG;QACK,iBAAY,GAA0B,EAAE,CAAA;QAuD9C,IAAM,aAAa,GAAG,OAAO,CAAC,YAAY;YACxC,CAAC,CAAC,OAAO,CAAC,YAAY;YACtB,CAAC,CAAmB,KAAM,CAAC,cAAc;gBACzC,CAAC,CAAmB,KAAM,CAAC,cAAc,CAAC,SAAS;gBACnD,CAAC,CAAC,SAAS,CAAA;QACb,kBAAkB;QAClB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,kJAAkJ;QAClJ,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;QACzB,oBAAoB;QACpB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,CAAA,CAAA;QACtC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,aAAa,CAAA,CAAA,CAAC,4BAA4B;QACxE,aAAa;QACb,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,EAAE,aAAa,CAAC,CAAA;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAY,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QAC5E,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAS,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,CAAC,CAAA;IACnD,CAAC;IAED;;;;;OAKG;IACU,6BAAO,GAApB,UACE,aAIC;;;;;4BAED,qBAAM,IAAI,CAAC,kBAAkB,CAAC;;;;4CAC5B,qBAAM,IAAI,CAAC,qBAAqB,CAAC;;;4DACxB,qBAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAA;4DAAzC,sBAAO,SAAkC,EAAA;;;6CAC1C,CAAC,EAAA;;wCAFF,SAEE,CAAA;;;;6BACH,CAAC;wBACF,kDAAkD;sBADhD;;wBAJF,SAIE,CAAA;wBACF,kDAAkD;wBAClD,IAAI,IAAI,CAAC,UAAU;4BAAE,sBAAO,IAAI,CAAC,QAAQ;gCACzC,wDAAwD;8BADf;wBACzC,wDAAwD;wBACxD,sBAAO,IAAI,EAAA;;;;KACZ;IAED;;;;OAIG;IACW,8BAAQ,GAAtB,UACE,aAIC;;;;;;wBAEG,eAAe,GAAG,IAAI,CAAC,uBAAuB;wBAAxB,CAAA;;;;wBAGxB,SAAS;wBACT,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAA;wBAC/C,KAAA,IAAI,CAAA;wBAAY,qBAAM,aAAa,CAAC,IAAI,CAAC;4BACzC,eAAe;0BAD0B;;wBAAzC,GAAK,QAAQ,GAAG,SAAyB,CAAA;6BAErC,CAAA,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,YAAY,kBAAQ,CAAA,EAAlD,wBAAkD;wBACpD,qBAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAA9D,SAA8D,CAAA;wBAC9D,eAAe,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,CAAC,CAAA;;;6BAC3E,CAAA,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAA,EAAhC,wBAAgC;wBACzC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAA;wBAC7D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;wBAChC,eAAe,GAAG,KAAK,CAAA;;;wBAEvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CACnC,iBAAO,CAAC,kCAAkC,EAC1C,iBAAO,CAAC,kBAAkB,CAC3B,CAAA;wBACD,qBAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAA9D,SAA8D,CAAA;wBAC9D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAA;;;;;wBAGtE,kBAAkB;wBAClB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAA;wBAChE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAC,CAAC,CAAA;wBACxB,SAAS;wBACT,IAAI,IAAI,CAAC,YAAY;4BAAE,MAAM,GAAC,CAAA;wBAC9B,qBAAqB;wBACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CACnC,iBAAO,CAAC,2BAA2B,EACnC,iBAAO,CAAC,kBAAkB,CAC3B,CAAA;wBACD,qBAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAA9D,SAA8D,CAAA;;6BAEhE,sBAAO,eAAe,EAAA;;;;KACvB;IAED;;;;;OAKG;IACU,sCAAgB,GAA7B,UACE,MAAmB;;;;;;wBAEb,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;wBAC9B,qBAAM,EAAE,CAAC,WAAW,EAAE,EAAA;;wBAAhC,OAAO,GAAG,SAAsB;wBACtC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;wBAC/B,sBAAO,OAAc,EAAA;;;;KACtB;IACD;;;;;OAKG;IACW,2CAAqB,GAAnC,UAAoC,aAAqC;;;;;;;;wBAGlD,qBAAM,aAAa,EAAE,EAAA;;wBAAlC,UAAU,GAAG,SAAqB;;;;wBACd,KAAA,SAAA,yBAAI,IAAI,CAAC,YAAY,UAAE,OAAO,EAAE,CAAA;;;;wBAA/C,WAAW;;;;wBAElB,qBAAM,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,EAAE,EAAA;;wBAAjE,SAAiE,CAAA;;;;wBAEjE,kEAAkE;wBAClE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAA;wBAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAC,CAAC,CAAA;;;;;;;;;;;;;;;;;;;;;;wBAMF,KAAA,SAAA,yBAAI,IAAI,CAAC,YAAY,UAAE,OAAO,EAAE,CAAA;;;;wBAA/C,WAAW;;;;wBAElB,qBAAM,WAAW,CAAC,YAAY,EAAE,EAAA;;wBAAhC,SAAgC,CAAA;;;;wBAEhC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAA;wBAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAC,CAAC,CAAA;;;;;;;;;;;;;;;;;wBAG5B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAA;wBAC9D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAC,CAAC,KAAK,CAAC,CAAA;wBACxB,SAAS;wBACT,IAAI,IAAI,CAAC,YAAY;4BAAE,MAAM,GAAC,CAAA;;;;;;KAEjC;IAED;;;;;OAKG;IACW,wCAAkB,GAAhC,UAAiC,aAAa;;;;;;;wBAE1C,qBAAM,aAAa,EAAE,EAAA;;wBAArB,SAAqB,CAAA;;;;wBAErB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAA;wBAClD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAC,CAAC,CAAA;wBACxB,SAAS;wBACT,IAAI,IAAI,CAAC,YAAY;4BAAE,MAAM,GAAC,CAAA;;;wBAE9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;;;;;;KAEzC;IAED;;;;;OAKG;IACK,sCAAgB,GAAxB,UAAyB,KAAa,EAAE,IAAY;QAClD,OAAO,kBAAQ,CAAC,8BAA8B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAC7D,CAAC;IACH,kBAAC;AAAD,CAAC,AAjPD,IAiPC"}

package/dist/src/Config/Configuration.d.ts

@@ -1,8 +1,11 @@
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @typedef {ConfigurationSchema}
+ * Represents the schema for the configuration object.
+ * @typedef {Object} ConfigurationSchema
+ * @property {Object} [name] - The name of the configuration property.
+ * @property {boolean} [name.isLocal] - Indicates if the property is for local use.
+ * @property {boolean} [name.isRemote] - Indicates if the property is for remote use.
+ * @property {boolean} [name.required] - Indicates if the property is required.
+ * @property {string} [name.cachingPolicy] - The caching policy for the property.
  */
 export type ConfigurationSchema = {
     [name: string]: {
@@ -13,10 +16,9 @@ export type ConfigurationSchema = {
     };
 };
 /**
- * ${1:Description placeholder}
- *
- * @typedef {ExtractRemote}
- * @template Type
+ * Extracts the properties from a given type that have the `isRemote` property set to `true`.
+ * @param {Type} - The type to extract properties from.
+ * @returns An object type with the extracted properties.
  */
 type ExtractRemote<Type> = {
     [Property in keyof Type]-?: Type[Property] extends {
@@ -24,10 +26,9 @@ type ExtractRemote<Type> = {
     } ? Property : null;
 };
 /**
- * ${1:Description placeholder}
- *
- * @typedef {ExtractLocal}
- * @template Type
+ * Extracts the properties from a given type that have the `isLocal` property set to `true`.
+ * @typeparam Type - The type to extract properties from.
+ * @returns An object type with the extracted properties as keys and their corresponding types.
  */
 type ExtractLocal<Type> = {
     [Property in keyof Type]-?: Type[Property] extends {
@@ -35,96 +36,77 @@ type ExtractLocal<Type> = {
     } ? Property : null;
 };
 /**
- * ${1:Description placeholder}
- *
- * @typedef {OmitKeysByValueType}
- * @template T
- * @template U
+ * Creates a new type by omitting keys from type T whose values are of type U.
+ * @param {T} - The original type
+ * @param {U} - The type to omit from T
+ * @returns A new type with the omitted keys
  */
 type OmitKeysByValueType<T, U> = {
     [P in keyof T]: T[P] extends U ? never : P;
 }[keyof T];
 /**
- * ${1:Description placeholder}
- *
- * @typedef {OmitByValueType}
- * @template T
- * @template V
+ * Omit properties from an object type by their value type.
+ * @template T - The object type to omit properties from.
+ * @template V - The value type of properties to omit.
+ * @typedef OmitByValueType
+ * @property {T} T - The object type to omit properties from.
+ * @property {V} V - The value type of properties to omit.
+ * @returns {OmitKeysByValueType<T, V>} - The resulting object type after omitting properties.
  */
 type OmitByValueType<T, V> = T extends infer _ ? {
     [key in OmitKeysByValueType<T, V>]: T[key];
 } : never;
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class Configuration
- * @typedef {Configuration}
- * @template {ConfigurationSchema} T
+ * Represents a configuration object with a specified schema and remote prefix.
+ * @template T - The type of the configuration schema.
  */
 export default class Configuration<T extends ConfigurationSchema> {
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @readonly
+     * The schema for the private readonly property.
      * @type {T}
      */
     private readonly schema;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @readonly
+     * The prefix used for remote resources.
      * @type {string}
      */
     private readonly remotePrefix;
     /**
-     * Creates an instance of Configuration.
-     *
-     * @constructor
-     * @param {T} schema
-     * @param {string} remotePrefix
+     * Constructs a new instance of the class.
+     * @param {T} schema - The schema object.
+     * @param {string} remotePrefix - The remote prefix string.
+     * @returns None
      */
     constructor(schema: T, remotePrefix: string);
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @param {keyof OmitByValueType<ExtractLocal<T>, null>} propName
-     * @returns {*}
+     * Retrieves the value of a property from the environment variables or cache.
+     * @param {keyof OmitByValueType<ExtractLocal<T>, null>} propName - The name of the property to retrieve.
+     * @returns The value of the property.
      */
     get(propName: keyof OmitByValueType<ExtractLocal<T>, null>): any;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @async
-     * @param {keyof OmitByValueType<ExtractRemote<T>, null>} propName
-     * @returns {Promise<any>}
+     * Asynchronously retrieves the value of a property from the remote environment.
+     * @param {keyof OmitByValueType<ExtractRemote<T>, null>} propName - The name of the property to retrieve.
+     * @returns {Promise<any>} - A promise that resolves to the value of the property.
      */
     asyncGet(propName: keyof OmitByValueType<ExtractRemote<T>, null>): Promise<any>;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {string} valueKey
-     * @returns {*}
+     * Retrieves the cached value associated with the given key from the cache store.
+     * @param {string} valueKey - The key of the value to retrieve from the cache.
+     * @returns The cached value associated with the given key, or undefined if the key does not exist in the cache.
      */
     private getCachedValue;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {string} valueKey
-     * @param {*} value
-     * @param {string} [policy="1d"]
+     * Caches a value with the specified key and expiration policy.
+     * @param {string} valueKey - The key to associate with the cached value.
+     * @param {any} value - The value to be cached.
+     * @param {string} [policy='1d'] - The expiration policy for the cached value. Defaults to '1d' (1 day).
+     * @returns None
      */
     private cacheValue;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
+     * Resets the cache by creating a new instance of the MemCache class and assigning it to the cacheStore variable.
+     * @returns None
      */
     private resetCache;
 }

package/dist/src/Config/Configuration.js

@@ -42,37 +42,29 @@ var EnvironmentVar_1 = require("./EnvironmentVar");
 // Hold cached values at nodeVM level
 // eslint-disable-next-line no-var
 /**
- * ${1:Description placeholder}
- *
- * @type {*}
+ * Creates a new instance of a memory cache store.
+ * @returns {MemCache} A new instance of a memory cache store.
  */
 var cacheStore = new MemCache();
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class Configuration
- * @typedef {Configuration}
- * @template {ConfigurationSchema} T
+ * Represents a configuration object with a specified schema and remote prefix.
+ * @template T - The type of the configuration schema.
  */
 var Configuration = /** @class */ (function () {
     /**
-     * Creates an instance of Configuration.
-     *
-     * @constructor
-     * @param {T} schema
-     * @param {string} remotePrefix
+     * Constructs a new instance of the class.
+     * @param {T} schema - The schema object.
+     * @param {string} remotePrefix - The remote prefix string.
+     * @returns None
      */
     function Configuration(schema, remotePrefix) {
         this.schema = schema;
         this.remotePrefix = remotePrefix;
     }
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @param {keyof OmitByValueType<ExtractLocal<T>, null>} propName
-     * @returns {*}
+     * Retrieves the value of a property from the environment variables or cache.
+     * @param {keyof OmitByValueType<ExtractLocal<T>, null>} propName - The name of the property to retrieve.
+     * @returns The value of the property.
      */
     Configuration.prototype.get = function (propName) {
         var propString = propName;
@@ -85,12 +77,9 @@ var Configuration = /** @class */ (function () {
         return v;
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @async
-     * @param {keyof OmitByValueType<ExtractRemote<T>, null>} propName
-     * @returns {Promise<any>}
+     * Asynchronously retrieves the value of a property from the remote environment.
+     * @param {keyof OmitByValueType<ExtractRemote<T>, null>} propName - The name of the property to retrieve.
+     * @returns {Promise<any>} - A promise that resolves to the value of the property.
      */
     Configuration.prototype.asyncGet = function (propName) {
         return __awaiter(this, void 0, void 0, function () {
@@ -115,34 +104,28 @@ var Configuration = /** @class */ (function () {
             });
         });
     };
-    // caching layer
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {string} valueKey
-     * @returns {*}
+     * Retrieves the cached value associated with the given key from the cache store.
+     * @param {string} valueKey - The key of the value to retrieve from the cache.
+     * @returns The cached value associated with the given key, or undefined if the key does not exist in the cache.
      */
     Configuration.prototype.getCachedValue = function (valueKey) {
         return cacheStore.get(valueKey);
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {string} valueKey
-     * @param {*} value
-     * @param {string} [policy="1d"]
+     * Caches a value with the specified key and expiration policy.
+     * @param {string} valueKey - The key to associate with the cached value.
+     * @param {any} value - The value to be cached.
+     * @param {string} [policy='1d'] - The expiration policy for the cached value. Defaults to '1d' (1 day).
+     * @returns None
      */
     Configuration.prototype.cacheValue = function (valueKey, value, policy) {
         if (policy === void 0) { policy = '1d'; }
-        cacheStore.set(valueKey, value, DurationParser(policy, 's'));
+        cacheStore.set(valueKey, value, DurationParser(policy, 's') || '');
     };
-    // unit-test support
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
+     * Resets the cache by creating a new instance of the MemCache class and assigning it to the cacheStore variable.
+     * @returns None
      */
     Configuration.prototype.resetCache = function () {
         cacheStore = new MemCache();

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

@@ -1 +1 @@
-{"version":3,"file":"Configuration.js","sourceRoot":"","sources":["../../../src/Config/Configuration.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAsC;AACtC,+CAAgD;AAEhD,mDAAkE;AAElE,qCAAqC;AACrC,kCAAkC;AAClC;;;;GAIG;AACH,IAAI,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAA;AAwE/B;;;;;;;GAOG;AACH;IAiBE;;;;;;OAMG;IACH,uBAAY,MAAS,EAAE,YAAoB;QACzC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED;;;;;;OAMG;IACI,2BAAG,GAAV,UAAW,QAAsD;QAC/D,IAAM,UAAU,GAAG,QAAkB,CAAA;QACrC,IAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QAC1C,IAAI,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;QACvC,CAAC;YACC,CAAC;gBACD,IAAI,wBAAc,CAChB,UAAU,EACV,gCAAe,CAAC,KAAK,EACrB,CAAC,UAAU,CAAC,QAAQ,EACpB,IAAI,CAAC,YAAY,CAClB,CAAC,WAAW,EAAE,CAAA;QACjB,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;QACxD,OAAO,CAAC,CAAA;IACV,CAAC;IACD;;;;;;;OAOG;IACU,gCAAQ,GAArB,UAAsB,QAAuD;;;;;;wBACrE,UAAU,GAAG,QAAkB,CAAA;wBAC/B,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;wBACtC,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;wBAErC,KAAA,CAAC,CAAA;gCAAD,wBAAC;wBACA,qBAAM,IAAI,wBAAc,CACvB,UAAU,EACV,gCAAe,CAAC,WAAW,EAC3B,CAAC,UAAU,CAAC,QAAQ,EACpB,IAAI,CAAC,YAAY,CAClB,CAAC,OAAO,EAAE,EAAA;;wBALX,KAAA,CAAC,SAKU,CAAC,CAAA;;;wBAPd,CAAC,KAOa,CAAA;wBACd,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;wBACxD,sBAAO,CAAC,EAAA;;;;KACT;IACD,gBAAgB;IAChB;;;;;;OAMG;IACK,sCAAc,GAAtB,UAAuB,QAAgB;QACrC,OAAO,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;IACD;;;;;;;OAOG;IACK,kCAAU,GAAlB,UAAmB,QAAgB,EAAE,KAAU,EAAE,MAAqB;QAArB,uBAAA,EAAA,aAAqB;QACpE,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,cAAc,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IAC9D,CAAC;IACD,oBAAoB;IACpB;;;;OAIG;IACK,kCAAU,GAAlB;QACE,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAA;IAC7B,CAAC;IACH,oBAAC;AAAD,CAAC,AAzGD,IAyGC"}
+{"version":3,"file":"Configuration.js","sourceRoot":"","sources":["../../../src/Config/Configuration.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAsC;AACtC,+CAAgD;AAEhD,mDAAkE;AAElE,qCAAqC;AACrC,kCAAkC;AAClC;;;GAGG;AACH,IAAI,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAA;AAyE/B;;;GAGG;AACH;IAYE;;;;;OAKG;IACH,uBAAY,MAAS,EAAE,YAAoB;QACzC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACI,2BAAG,GAAV,UAAW,QAAsD;QAC/D,IAAM,UAAU,GAAG,QAAkB,CAAA;QACrC,IAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QAC1C,IAAI,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;QACvC,CAAC;YACC,CAAC;gBACD,IAAI,wBAAc,CAChB,UAAU,EACV,gCAAe,CAAC,KAAK,EACrB,CAAC,UAAU,CAAC,QAAQ,EACpB,IAAI,CAAC,YAAY,CAClB,CAAC,WAAW,EAAE,CAAA;QACjB,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;QACxD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;OAIG;IACU,gCAAQ,GAArB,UAAsB,QAAuD;;;;;;wBACrE,UAAU,GAAG,QAAkB,CAAA;wBAC/B,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;wBACtC,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;wBAErC,KAAA,CAAC,CAAA;gCAAD,wBAAC;wBACA,qBAAM,IAAI,wBAAc,CACvB,UAAU,EACV,gCAAe,CAAC,WAAW,EAC3B,CAAC,UAAU,CAAC,QAAQ,EACpB,IAAI,CAAC,YAAY,CAClB,CAAC,OAAO,EAAE,EAAA;;wBALX,KAAA,CAAC,SAKU,CAAC,CAAA;;;wBAPd,CAAC,KAOa,CAAA;wBACd,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;wBACxD,sBAAO,CAAC,EAAA;;;;KACT;IAED;;;;OAIG;IACK,sCAAc,GAAtB,UAAuB,QAAgB;QACrC,OAAO,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED;;;;;;OAMG;IACK,kCAAU,GAAlB,UAAmB,QAAgB,EAAE,KAAU,EAAE,MAAqB;QAArB,uBAAA,EAAA,aAAqB;QACpE,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,cAAc,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;IACpE,CAAC;IAED;;;OAGG;IACK,kCAAU,GAAlB;QACE,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAA;IAC7B,CAAC;IACH,oBAAC;AAAD,CAAC,AA5FD,IA4FC"}

package/dist/src/Config/EnvironmentVar.d.ts

@@ -1,8 +1,10 @@
 /**
- * ${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.
  */
 export declare enum EnvironmentType {
     PlainRemote = 0,
@@ -10,92 +12,63 @@ export declare enum EnvironmentType {
     Local = 2
 }
 /**
- * ${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.
  */
 export default class EnvironmentVar<T> {
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @readonly
-     * @type {string}
+     * The name of the parameter.
      */
     private readonly paramName;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
+     * The type of environment.
      * @readonly
-     * @type {EnvironmentType}
      */
     private readonly type;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @readonly
-     * @type {boolean}
+     * A boolean flag indicating whether the field is optional or not.
      */
     private readonly optional;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @readonly
+     * The prefix used for parameters in the class.
      * @type {string}
      */
     private readonly paramPrefix;
     /**
-     * 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.
      */
     constructor(paramName: string, type: EnvironmentType, optional?: boolean, paramPrefix?: string);
     /**
-     * ${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'.
      */
     syncResolve(): T;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @async
-     * @returns {unknown}
+     * Resolves the value based on the environment type.
+     * @returns {Promise<any>} - The resolved value.
      */
     resolve(): Promise<T>;
     /**
-     * ${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.
      */
     private getLocalValue;
     /**
-     * ${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.
      */
     private getPlainValue;
     /**
-     * ${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.
      */
     private getSecureValue;
 }