@creator.co/wapi 1.2.3 → 1.2.4

package/dist/src/BaseEvent/Transaction.d.ts

@@ -0,0 +1,29 @@
+import type { APIGatewayEvent, Context, SQSEvent } from 'aws-lambda';
+import Request from '../API/Request';
+import Response, { ResponseErrorType } from '../API/Response';
+import Logger, { LoggerConfig } from '../Logger/Logger';
+import Publisher, { PublisherConfig } from '../Publisher/Publisher';
+export type TransactionExecution<TransactionType, ResponseInnerType, MiscRespType = null> = (transaction: TransactionType) => Promise<Response<ResponseInnerType> | Response<ResponseErrorType> | MiscRespType>;
+export type TransactionConfig = {
+    throwOnErrors?: boolean;
+    syncReturn?: boolean;
+    logger?: LoggerConfig;
+    publisher?: PublisherConfig;
+};
+export default class Transaction<InputType = object, ResponseInnerType = null, MiscRespType = null> {
+    private event;
+    private context;
+    private response;
+    private syncReturn;
+    private retrowErrors;
+    readonly logger: Logger;
+    readonly request: Request<InputType>;
+    readonly publisher: Publisher;
+    responseProxy: (response: Response<ResponseInnerType>) => Promise<void>;
+    constructor(event: APIGatewayEvent | SQSEvent, context: Context, config?: TransactionConfig);
+    execute(executionFunc: TransactionExecution<Transaction<InputType, ResponseInnerType, MiscRespType>, ResponseInnerType, MiscRespType>): Promise<Response<ResponseInnerType | ResponseErrorType> | MiscRespType>;
+    private iexecute;
+    private executeDBTransactions;
+    private executeLoggerFlush;
+    private getErrorResponse;
+}

package/dist/src/BaseEvent/Transaction.js

@@ -0,0 +1,244 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var Request_1 = require("../API/Request");
+var Response_1 = require("../API/Response");
+var Globals_1 = require("../Globals");
+var Logger_1 = require("../Logger/Logger");
+var Publisher_1 = require("../Publisher/Publisher");
+var Transaction = /** @class */ (function () {
+    //
+    function Transaction(event, context, config) {
+        var transactionId = context.awsRequestId
+            ? context.awsRequestId
+            : event.requestContext
+                ? event.requestContext.requestId
+                : 'unknown';
+        // transaction ctx
+        this.event = event;
+        this.context = context;
+        this.response = null;
+        // when set, this will be called with the response context right before calling the context suceed/fail - useful for writing the resp for example.
+        this.responseProxy = null;
+        // transaction flags
+        this.syncReturn = !!(config === null || config === void 0 ? void 0 : config.syncReturn);
+        this.retrowErrors = !!(config === null || config === void 0 ? void 0 : config.throwOnErrors); /* retrow internal errors */
+        // components
+        this.logger = new Logger_1.default(config === null || config === void 0 ? void 0 : config.logger, transactionId);
+        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
+    Transaction.prototype.execute = function (executionFunc) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.executeLoggerFlush(function () { return __awaiter(_this, void 0, void 0, function () {
+                            var _this = this;
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0: return [4 /*yield*/, this.executeDBTransactions(function () { return __awaiter(_this, void 0, void 0, function () {
+                                            return __generator(this, function (_a) {
+                                                switch (_a.label) {
+                                                    case 0: return [4 /*yield*/, this.iexecute(executionFunc)];
+                                                    case 1: return [2 /*return*/, _a.sent()];
+                                                }
+                                            });
+                                        }); })];
+                                    case 1:
+                                        _a.sent();
+                                        return [2 /*return*/];
+                                }
+                            });
+                        }); })
+                        // return raw response if sync return is requested
+                    ];
+                    case 1:
+                        _a.sent();
+                        // return raw response if sync return is requested
+                        if (this.syncReturn)
+                            return [2 /*return*/, this.response
+                                // allow request to async succeed through lambda context
+                            ];
+                        // allow request to async succeed through lambda context
+                        return [2 /*return*/, null];
+                }
+            });
+        });
+    };
+    //Executions
+    Transaction.prototype.iexecute = function (executionFunc) {
+        return __awaiter(this, void 0, void 0, function () {
+            var executionFailed, _a, e_1;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        executionFailed = true //failed til we say no!
+                        ;
+                        _b.label = 1;
+                    case 1:
+                        _b.trys.push([1, 8, , 10]);
+                        //Execute
+                        this.logger.debug('Starting main request code');
+                        _a = this;
+                        return [4 /*yield*/, executionFunc(this)
+                            //Answer client
+                        ];
+                    case 2:
+                        _a.response = _b.sent();
+                        if (!(this.response && this.response instanceof Response_1.default)) return [3 /*break*/, 4];
+                        return [4 /*yield*/, this.response.build(this.context, this, this.syncReturn)];
+                    case 3:
+                        _b.sent();
+                        executionFailed = !!(this.response.getBody() && this.response.getBody()['rollback']);
+                        return [3 /*break*/, 7];
+                    case 4:
+                        if (!(this.syncReturn && this.response)) return [3 /*break*/, 5];
+                        this.logger.log('Sync return with different response object');
+                        this.logger.debug(this.response);
+                        executionFailed = false;
+                        return [3 /*break*/, 7];
+                    case 5:
+                        this.response = this.getErrorResponse(Globals_1.default.ErrorResponseInvalidServerResponse, Globals_1.default.ErrorCode_APIError);
+                        return [4 /*yield*/, this.response.build(this.context, this, this.syncReturn)];
+                    case 6:
+                        _b.sent();
+                        this.logger.error('Invalid response object from main request code.');
+                        _b.label = 7;
+                    case 7: return [3 /*break*/, 10];
+                    case 8:
+                        e_1 = _b.sent();
+                        /*EXECUTION FAIL*/
+                        this.logger.error('Exception when executing main request code.');
+                        this.logger.exception(e_1);
+                        //retrow?
+                        if (this.retrowErrors)
+                            throw e_1;
+                        //envelope exception?
+                        this.response = this.getErrorResponse(Globals_1.default.ErrorResponseUnhandledError, Globals_1.default.ErrorCode_APIError);
+                        return [4 /*yield*/, this.response.build(this.context, this, this.syncReturn)];
+                    case 9:
+                        _b.sent();
+                        return [3 /*break*/, 10];
+                    case 10: return [2 /*return*/, executionFailed];
+                }
+            });
+        });
+    };
+    Transaction.prototype.executeDBTransactions = function (safeExecution) {
+        return __awaiter(this, void 0, void 0, function () {
+            var e_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        // //start DB
+                        // if (this.db) await this.db.connect();
+                        // //start transaction
+                        // if (this.db) await this.db.beginTransaction();
+                        // //
+                        // let executionFailed =
+                        return [4 /*yield*/, safeExecution()
+                            // //Commit if not failed, rollback if failed
+                            // if (!executionFailed) {
+                            //   if (this.db) await this.db.commit();
+                            // } else {
+                            //   this.logger.log("Rolling back DB transactions. Main code failed!");
+                            //   if (this.db) await this.db.rollback();
+                            // }
+                            // //Cleanup DB after execution
+                            // if (this.db) await this.db.cleanup();
+                        ];
+                    case 1:
+                        // //start DB
+                        // if (this.db) await this.db.connect();
+                        // //start transaction
+                        // if (this.db) await this.db.beginTransaction();
+                        // //
+                        // let executionFailed =
+                        _a.sent();
+                        return [3 /*break*/, 3];
+                    case 2:
+                        e_2 = _a.sent();
+                        this.logger.error('Exception when executing DB transactions.');
+                        this.logger.log(e_2.stack);
+                        //retrow?
+                        if (this.retrowErrors)
+                            throw e_2;
+                        return [3 /*break*/, 3];
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Transaction.prototype.executeLoggerFlush = function (safeExecution) {
+        return __awaiter(this, void 0, void 0, function () {
+            var e_3;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, 3, 4]);
+                        return [4 /*yield*/, safeExecution()];
+                    case 1:
+                        _a.sent();
+                        return [3 /*break*/, 4];
+                    case 2:
+                        e_3 = _a.sent();
+                        this.logger.error('Exception when flushing logs.');
+                        this.logger.exception(e_3);
+                        //retrow?
+                        if (this.retrowErrors)
+                            throw e_3;
+                        return [3 /*break*/, 4];
+                    case 3:
+                        this.logger.debug('Transaction ended');
+                        return [7 /*endfinally*/];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /* Response support */
+    Transaction.prototype.getErrorResponse = function (error, code) {
+        return Response_1.default.BadRequestResponseWithRollback(error, code);
+    };
+    return Transaction;
+}());
+exports.default = Transaction;
+//# sourceMappingURL=Transaction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../../src/BaseEvent/Transaction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,0CAAoC;AACpC,4CAA6D;AAC7D,sCAAgC;AAChC,2CAAuD;AACvD,oDAAmE;AAenE;IAeE,EAAE;IACF,qBAAY,KAAiC,EAAE,OAAgB,EAAE,MAA0B;QACzF,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;IACD,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;IACa,2CAAqB,GAAnC,UAAoC,aAAa;;;;;;;wBAE7C,aAAa;wBACb,wCAAwC;wBACxC,sBAAsB;wBACtB,iDAAiD;wBACjD,KAAK;wBACL,wBAAwB;wBACxB,qBAAM,aAAa,EAAE;4BACrB,6CAA6C;4BAC7C,0BAA0B;4BAC1B,yCAAyC;4BACzC,WAAW;4BACX,wEAAwE;4BACxE,2CAA2C;4BAC3C,IAAI;4BACJ,+BAA+B;4BAC/B,wCAAwC;0BATnB;;wBANrB,aAAa;wBACb,wCAAwC;wBACxC,sBAAsB;wBACtB,iDAAiD;wBACjD,KAAK;wBACL,wBAAwB;wBACxB,SAAqB,CAAA;;;;wBAWrB,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;IACa,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;IACD,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,AA7ID,IA6IC"}

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

@@ -0,0 +1,131 @@
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @typedef {ConfigurationSchema}
+ */
+export type ConfigurationSchema = {
+    [name: string]: {
+        isLocal?: boolean;
+        isRemote?: boolean;
+        required?: boolean;
+        cachingPolicy?: string;
+    };
+};
+/**
+ * ${1:Description placeholder}
+ *
+ * @typedef {ExtractRemote}
+ * @template Type
+ */
+type ExtractRemote<Type> = {
+    [Property in keyof Type]-?: Type[Property] extends {
+        isRemote: true;
+    } ? Property : null;
+};
+/**
+ * ${1:Description placeholder}
+ *
+ * @typedef {ExtractLocal}
+ * @template Type
+ */
+type ExtractLocal<Type> = {
+    [Property in keyof Type]-?: Type[Property] extends {
+        isLocal: true;
+    } ? Property : null;
+};
+/**
+ * ${1:Description placeholder}
+ *
+ * @typedef {OmitKeysByValueType}
+ * @template T
+ * @template U
+ */
+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
+ */
+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
+ */
+export default class Configuration<T extends ConfigurationSchema> {
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @readonly
+     * @type {T}
+     */
+    private readonly schema;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @readonly
+     * @type {string}
+     */
+    private readonly remotePrefix;
+    /**
+     * Creates an instance of Configuration.
+     *
+     * @constructor
+     * @param {T} schema
+     * @param {string} remotePrefix
+     */
+    constructor(schema: T, remotePrefix: string);
+    /**
+     * ${1:Description placeholder}
+     *
+     * @public
+     * @param {keyof OmitByValueType<ExtractLocal<T>, null>} propName
+     * @returns {*}
+     */
+    get(propName: keyof OmitByValueType<ExtractLocal<T>, null>): any;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @public
+     * @async
+     * @param {keyof OmitByValueType<ExtractRemote<T>, null>} propName
+     * @returns {Promise<any>}
+     */
+    asyncGet(propName: keyof OmitByValueType<ExtractRemote<T>, null>): Promise<any>;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @param {string} valueKey
+     * @returns {*}
+     */
+    private getCachedValue;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @param {string} valueKey
+     * @param {*} value
+     * @param {string} [policy="1d"]
+     */
+    private cacheValue;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     */
+    private resetCache;
+}
+export {};

package/dist/src/Config/Configuration.js

@@ -0,0 +1,153 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var MemCache = require("node-cache");
+var DurationParser = require("parse-duration");
+var EnvironmentVar_1 = require("./EnvironmentVar");
+// Hold cached values at nodeVM level
+// eslint-disable-next-line no-var
+/**
+ * ${1:Description placeholder}
+ *
+ * @type {*}
+ */
+var cacheStore = new MemCache();
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @class Configuration
+ * @typedef {Configuration}
+ * @template {ConfigurationSchema} T
+ */
+var Configuration = /** @class */ (function () {
+    /**
+     * Creates an instance of Configuration.
+     *
+     * @constructor
+     * @param {T} schema
+     * @param {string} remotePrefix
+     */
+    function Configuration(schema, remotePrefix) {
+        this.schema = schema;
+        this.remotePrefix = remotePrefix;
+    }
+    /**
+     * ${1:Description placeholder}
+     *
+     * @public
+     * @param {keyof OmitByValueType<ExtractLocal<T>, null>} propName
+     * @returns {*}
+     */
+    Configuration.prototype.get = function (propName) {
+        var propString = propName;
+        var propSchema = this.schema[propString];
+        var v = this.getCachedValue(propString);
+        v =
+            v ||
+                new EnvironmentVar_1.default(propString, EnvironmentVar_1.EnvironmentType.Local, !propSchema.required, this.remotePrefix).syncResolve();
+        this.cacheValue(propString, v, propSchema.cachingPolicy);
+        return v;
+    };
+    /**
+     * ${1:Description placeholder}
+     *
+     * @public
+     * @async
+     * @param {keyof OmitByValueType<ExtractRemote<T>, null>} propName
+     * @returns {Promise<any>}
+     */
+    Configuration.prototype.asyncGet = function (propName) {
+        return __awaiter(this, void 0, void 0, function () {
+            var propString, propSchema, v, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        propString = propName;
+                        propSchema = this.schema[propString];
+                        v = this.getCachedValue(propString);
+                        _a = v;
+                        if (_a) return [3 /*break*/, 2];
+                        return [4 /*yield*/, new EnvironmentVar_1.default(propString, EnvironmentVar_1.EnvironmentType.PlainRemote, !propSchema.required, this.remotePrefix).resolve()];
+                    case 1:
+                        _a = (_b.sent());
+                        _b.label = 2;
+                    case 2:
+                        v = _a;
+                        this.cacheValue(propString, v, propSchema.cachingPolicy);
+                        return [2 /*return*/, v];
+                }
+            });
+        });
+    };
+    // caching layer
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @param {string} valueKey
+     * @returns {*}
+     */
+    Configuration.prototype.getCachedValue = function (valueKey) {
+        return cacheStore.get(valueKey);
+    };
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @param {string} valueKey
+     * @param {*} value
+     * @param {string} [policy="1d"]
+     */
+    Configuration.prototype.cacheValue = function (valueKey, value, policy) {
+        if (policy === void 0) { policy = '1d'; }
+        cacheStore.set(valueKey, value, DurationParser(policy, 's'));
+    };
+    // unit-test support
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     */
+    Configuration.prototype.resetCache = function () {
+        cacheStore = new MemCache();
+    };
+    return Configuration;
+}());
+exports.default = Configuration;
+//# sourceMappingURL=Configuration.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,101 @@
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @enum {number}
+ */
+export declare enum EnvironmentType {
+    PlainRemote = 0,
+    SecureRemote = 1,
+    Local = 2
+}
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @class EnvironmentVar
+ * @typedef {EnvironmentVar}
+ * @template T
+ */
+export default class EnvironmentVar<T> {
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @readonly
+     * @type {string}
+     */
+    private readonly paramName;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @readonly
+     * @type {EnvironmentType}
+     */
+    private readonly type;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @readonly
+     * @type {boolean}
+     */
+    private readonly optional;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @readonly
+     * @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/`]
+     */
+    constructor(paramName: string, type: EnvironmentType, optional?: boolean, paramPrefix?: string);
+    /**
+     * ${1:Description placeholder}
+     *
+     * @public
+     * @returns {T}
+     */
+    syncResolve(): T;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @public
+     * @async
+     * @returns {unknown}
+     */
+    resolve(): Promise<T>;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @returns {T}
+     */
+    private getLocalValue;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @async
+     * @returns {Promise<T>}
+     */
+    private getPlainValue;
+    /**
+     * ${1:Description placeholder}
+     *
+     * @private
+     * @async
+     * @returns {Promise<T>}
+     */
+    private getSecureValue;
+}