@spytecgps/lambda-utils 1.0.3 → 1.0.5

package/dist/index.d.ts

@@ -4,3 +4,4 @@ export * from './validation';
 export * from './types';
 export * from './middleware';
 export * from './logger/logger';
+export * from './utils';

package/dist/index.js

@@ -16,3 +16,4 @@ __exportStar(require("./validation"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./middleware"), exports);
 __exportStar(require("./logger/logger"), exports);
+__exportStar(require("./utils"), exports);

package/dist/utils/cache.d.ts

@@ -0,0 +1,23 @@
+export declare class LambdaCache {
+    private collectionName;
+    /**
+     * @param {String} collectionName (not required) - The collection key used to store the cache values.
+     *                                If not provide default collection name uses :
+     *                                ${process.env.AWS_LAMBDA_FUNCTION_NAME}-${process.env.AWS_LAMBDA_FUNCTION_VERSION}
+     * */
+    constructor(collectionName?: string);
+    /**
+     * @param {String} key (required) - cache key
+     * @param {Object} value (required) - cache value
+     * @param {Number} expire (required) - cache expiration time (seconds)
+     * */
+    set(key: string, value: unknown, ttl: number): void;
+    /**
+     * @param {String} key (required) - cache key to get
+     * */
+    get(key: string): unknown;
+    /**
+     * @param {String} key (required) - cache key to remove
+     * */
+    remove(key: any): void;
+}

package/dist/utils/cache.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LambdaCache = void 0;
+var LambdaCache = /** @class */ (function () {
+    /**
+     * @param {String} collectionName (not required) - The collection key used to store the cache values.
+     *                                If not provide default collection name uses :
+     *                                ${process.env.AWS_LAMBDA_FUNCTION_NAME}-${process.env.AWS_LAMBDA_FUNCTION_VERSION}
+     * */
+    function LambdaCache(collectionName) {
+        this.collectionName = collectionName !== null && collectionName !== void 0 ? collectionName : process.env.AWS_LAMBDA_FUNCTION_NAME + "-" + process.env.AWS_LAMBDA_FUNCTION_VERSION;
+        if (!global['CACHE_STORAGE']) {
+            global['CACHE_STORAGE'] = {};
+        }
+        if (!global['CACHE_STORAGE'][this.collectionName]) {
+            global['CACHE_STORAGE'][this.collectionName] = new Map();
+        }
+    }
+    /**
+     * @param {String} key (required) - cache key
+     * @param {Object} value (required) - cache value
+     * @param {Number} expire (required) - cache expiration time (seconds)
+     * */
+    LambdaCache.prototype.set = function (key, value, ttl) {
+        var expire = 1000 * ttl + Date.now();
+        global['CACHE_STORAGE'][this.collectionName].set(key, { value: value, expire: expire });
+    };
+    /**
+     * @param {String} key (required) - cache key to get
+     * */
+    LambdaCache.prototype.get = function (key) {
+        if (!key) {
+            throw new Error('key is required!');
+        }
+        var record = global['CACHE_STORAGE'][this.collectionName].get(key);
+        if (!record) {
+            return null;
+        }
+        if (!record.expire || record.expire > Date.now()) {
+            return record.value;
+        }
+        else {
+            return this.remove(key);
+        }
+    };
+    /**
+     * @param {String} key (required) - cache key to remove
+     * */
+    LambdaCache.prototype.remove = function (key) {
+        var record = global['CACHE_STORAGE'][this.collectionName].get(key);
+        if (!record) {
+            return;
+        }
+        global['CACHE_STORAGE'][this.collectionName].delete(key);
+    };
+    return LambdaCache;
+}());
+exports.LambdaCache = LambdaCache;

package/dist/utils/cacheWrapper.d.ts

@@ -0,0 +1,2 @@
+import { LambdaCache } from './cache';
+export declare const promiseWithCache: <T>(promise: () => Promise<T>, cacheInstance: LambdaCache, cacheKey: string, ttl: number) => Promise<T>;

package/dist/utils/cacheWrapper.js

@@ -0,0 +1,55 @@
+"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 (_) 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 });
+exports.promiseWithCache = void 0;
+exports.promiseWithCache = function (promise, cacheInstance, cacheKey, ttl) { return __awaiter(void 0, void 0, void 0, function () {
+    var instance;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                instance = cacheInstance.get(cacheKey);
+                if (!!instance) return [3 /*break*/, 2];
+                return [4 /*yield*/, promise()];
+            case 1:
+                instance = _a.sent();
+                cacheInstance.set(cacheKey, instance, ttl);
+                _a.label = 2;
+            case 2: return [2 /*return*/, instance];
+        }
+    });
+}); };

package/dist/utils/index.d.ts

@@ -0,0 +1,4 @@
+import { LambdaCache } from './cache';
+export * from './cacheWrapper';
+export * from './timeOut';
+export { LambdaCache };

package/dist/utils/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LambdaCache = void 0;
+var cache_1 = require("./cache");
+Object.defineProperty(exports, "LambdaCache", { enumerable: true, get: function () { return cache_1.LambdaCache; } });
+__exportStar(require("./cacheWrapper"), exports);
+__exportStar(require("./timeOut"), exports);

package/dist/utils/timeOut.d.ts

@@ -0,0 +1 @@
+export declare const promiseWithTimeout: <T>(promise: Promise<T>, ms: number, timeoutError?: Error) => Promise<T>;

package/dist/utils/timeOut.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promiseWithTimeout = void 0;
+exports.promiseWithTimeout = function (promise, ms, timeoutError) {
+    if (timeoutError === void 0) { timeoutError = new Error('Promise timed out'); }
+    // create a promise that rejects in milliseconds
+    var timeout = new Promise(function (_, reject) {
+        setTimeout(function () {
+            reject(timeoutError);
+        }, ms);
+    });
+    // returns a race between timeout and the passed promise
+    return Promise.race([promise, timeout]);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spytecgps/lambda-utils",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Lambda Utils",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",