@trunkrs/common 1.5.14 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trunkrs/common",
-  "version": "1.5.14",
+  "version": "1.6.0",
   "description": "Common standards library for development in Trunkrs",
   "types": "./index.d.ts",
   "repository": "https://github.com/Trunkrs/common.git",
@@ -33,7 +33,8 @@
     "jest": "^27.0.5",
     "prettier": "^2.1.2",
     "ts-jest": "^27.0.5",
-    "typescript": "^4.2.4"
+    "typescript": "^4.2.4",
+    "redis": "^4.0.4"
   },
   "publishConfig": {
     "access": "public"
@@ -47,6 +48,7 @@
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": ">=4 || <5",
     "@typescript-eslint/parser": ">=4 || <5",
+    "redis": "^4.0.4",
     "aws-sdk": ">2.1000.0 || <3",
     "date-fns": ">=2 || <3",
     "eslint": ">=7.2.0",

package/services/redis/RedisClient.d.ts

@@ -0,0 +1,12 @@
+import { RedisClientType } from 'redis';
+import SetOptions from './types/SetOptions';
+declare class RedisClient {
+    private readonly client;
+    constructor(client: RedisClientType);
+    set(key: string, value: string, options?: SetOptions): Promise<void>;
+    get(key: string): Promise<string | null>;
+    getOrSet(key: string, factory: () => Promise<string>, setOptions?: SetOptions): Promise<string>;
+    delete(...keys: string[]): Promise<void>;
+    clear(): Promise<void>;
+}
+export default RedisClient;

package/services/redis/RedisClient.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class RedisClient {
+    constructor(client) {
+        this.client = client;
+    }
+    async set(key, value, options) {
+        const commandOptions = {};
+        if (options === null || options === void 0 ? void 0 : options.expiresAt) {
+            Object.assign(commandOptions, {
+                PXAT: options.expiresAt.getTime(),
+            });
+        }
+        if (options === null || options === void 0 ? void 0 : options.setCondition) {
+            Object.assign(commandOptions, {
+                [options.setCondition]: true,
+            });
+        }
+        await this.client.connect();
+        await this.client.set(key, value, commandOptions);
+        await this.client.disconnect();
+    }
+    async get(key) {
+        await this.client.connect();
+        const item = await this.client.get(key);
+        await this.client.disconnect();
+        return item;
+    }
+    async getOrSet(key, factory, setOptions) {
+        await this.client.connect();
+        let value = await this.get(key);
+        if (!value) {
+            value = await factory();
+            await this.set(key, value, setOptions);
+        }
+        await this.client.disconnect();
+        return value;
+    }
+    async delete(...keys) {
+        await this.client.connect();
+        await this.client.del(keys);
+        await this.client.disconnect();
+    }
+    async clear() {
+        await this.client.connect();
+        await this.client.FLUSHALL();
+        await this.client.disconnect();
+    }
+}
+exports.default = RedisClient;
+//# sourceMappingURL=RedisClient.js.map

package/services/redis/RedisClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisClient.js","sourceRoot":"","sources":["../../../services/redis/RedisClient.ts"],"names":[],"mappings":";;AAIA,MAAM,WAAW;IACf,YAA6B,MAAuB;QAAvB,WAAM,GAAN,MAAM,CAAiB;IAAG,CAAC;IASjD,KAAK,CAAC,GAAG,CACd,GAAW,EACX,KAAa,EACb,OAAoB;QAEpB,MAAM,cAAc,GAAG,EAAE,CAAA;QAEzB,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,EAAE;YACtB,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE;gBAE5B,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE;aAClC,CAAC,CAAA;SACH;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,EAAE;YACzB,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE;gBAC5B,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI;aAC7B,CAAC,CAAA;SACH;QAED,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAA;QAC3B,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,CAAA;QACjD,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;IAChC,CAAC;IAQM,KAAK,CAAC,GAAG,CAAC,GAAW;QAC1B,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAA;QAC3B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEvC,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;QAE9B,OAAO,IAAI,CAAA;IACb,CAAC;IAWM,KAAK,CAAC,QAAQ,CACnB,GAAW,EACX,OAA8B,EAC9B,UAAuB;QAEvB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAA;QAE3B,IAAI,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAE/B,IAAI,CAAC,KAAK,EAAE;YACV,KAAK,GAAG,MAAM,OAAO,EAAE,CAAA;YAEvB,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAA;SACvC;QAED,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;QAE9B,OAAO,KAAK,CAAA;IACd,CAAC;IAOM,KAAK,CAAC,MAAM,CAAC,GAAG,IAAc;QACnC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAA;QAC3B,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAC3B,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;IAChC,CAAC;IAMM,KAAK,CAAC,KAAK;QAChB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAA;QAC3B,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAA;QAC5B,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;IAChC,CAAC;CACF;AAED,kBAAe,WAAW,CAAA"}

package/services/redis/index.d.ts

@@ -0,0 +1,3 @@
+export { default as RedisClient } from './RedisClient';
+export { default as SetCondition } from './types/SetCondition';
+export { default as SetOptions } from './types/SetOptions';

package/services/redis/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SetCondition = exports.RedisClient = void 0;
+var RedisClient_1 = require("./RedisClient");
+Object.defineProperty(exports, "RedisClient", { enumerable: true, get: function () { return __importDefault(RedisClient_1).default; } });
+var SetCondition_1 = require("./types/SetCondition");
+Object.defineProperty(exports, "SetCondition", { enumerable: true, get: function () { return __importDefault(SetCondition_1).default; } });
+//# sourceMappingURL=index.js.map

package/services/redis/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../services/redis/index.ts"],"names":[],"mappings":";;;;;;AAAA,6CAAsD;AAA7C,2HAAA,OAAO,OAAe;AAC/B,qDAA8D;AAArD,6HAAA,OAAO,OAAgB"}

package/services/redis/types/SetCondition.d.ts

@@ -0,0 +1,5 @@
+declare enum SetCondition {
+    IfNotExists = "NX",
+    IfExists = "XX"
+}
+export default SetCondition;

package/services/redis/types/SetCondition.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var SetCondition;
+(function (SetCondition) {
+    SetCondition["IfNotExists"] = "NX";
+    SetCondition["IfExists"] = "XX";
+})(SetCondition || (SetCondition = {}));
+exports.default = SetCondition;
+//# sourceMappingURL=SetCondition.js.map

package/services/redis/types/SetCondition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SetCondition.js","sourceRoot":"","sources":["../../../../services/redis/types/SetCondition.ts"],"names":[],"mappings":";;AAAA,IAAK,YAGJ;AAHD,WAAK,YAAY;IACf,kCAAkB,CAAA;IAClB,+BAAe,CAAA;AACjB,CAAC,EAHI,YAAY,KAAZ,YAAY,QAGhB;AAED,kBAAe,YAAY,CAAA"}

package/services/redis/types/SetOptions.d.ts

@@ -0,0 +1,6 @@
+import SetCondition from './SetCondition';
+interface SetOptions {
+    expiresAt?: Date;
+    setCondition?: SetCondition;
+}
+export default SetOptions;

package/services/redis/types/SetOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SetOptions.js.map

package/services/redis/types/SetOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SetOptions.js","sourceRoot":"","sources":["../../../../services/redis/types/SetOptions.ts"],"names":[],"mappings":""}

package/utils/caching/RedisCache.d.ts

@@ -0,0 +1,15 @@
+import Cache from './Cache';
+import RedisClient from '../../services/redis/RedisClient';
+import { Serializer } from '../serialization';
+declare class RedisCache extends Cache {
+    private readonly client;
+    private readonly serializer;
+    constructor(stalenessTimeout: number, client: RedisClient, serializer: Serializer);
+    add<TValue>(key: string, value: TValue): Promise<void>;
+    clear(): Promise<void>;
+    get<TValue>(key: string): Promise<TValue | null>;
+    getOrAdd<TValue>(key: string, factory: () => Promise<TValue>): Promise<TValue>;
+    hasKey(key: string): Promise<boolean>;
+    remove(key: string): Promise<void>;
+}
+export default RedisCache;

package/utils/caching/RedisCache.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Cache_1 = __importDefault(require("./Cache"));
+class RedisCache extends Cache_1.default {
+    constructor(stalenessTimeout, client, serializer) {
+        super(stalenessTimeout);
+        this.client = client;
+        this.serializer = serializer;
+    }
+    async add(key, value) {
+        const item = this.createItem(value);
+        const serializedItem = this.serializer.serialize(item, 'string');
+        await this.client.set(key, serializedItem, { expiresAt: item.expiration });
+    }
+    async clear() {
+        await this.client.clear();
+    }
+    async get(key) {
+        const item = await this.client.get(key);
+        if (!item) {
+            return null;
+        }
+        const deserializedItem = this.serializer.deserialize(item);
+        return deserializedItem.value;
+    }
+    async getOrAdd(key, factory) {
+        const item = await this.client.get(key);
+        if (!item) {
+            const newValue = await factory();
+            await this.add(key, newValue);
+            return newValue;
+        }
+        const deserializedItem = this.serializer.deserialize(item);
+        return deserializedItem.value;
+    }
+    async hasKey(key) {
+        const item = await this.client.get(key);
+        return !!item;
+    }
+    async remove(key) {
+        await this.client.delete(key);
+    }
+}
+exports.default = RedisCache;
+//# sourceMappingURL=RedisCache.js.map

package/utils/caching/RedisCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisCache.js","sourceRoot":"","sources":["../../../utils/caching/RedisCache.ts"],"names":[],"mappings":";;;;;AAAA,oDAA0C;AAI1C,MAAM,UAAW,SAAQ,eAAK;IAC5B,YACE,gBAAwB,EACP,MAAmB,EACnB,UAAsB;QAEvC,KAAK,CAAC,gBAAgB,CAAC,CAAA;QAHN,WAAM,GAAN,MAAM,CAAa;QACnB,eAAU,GAAV,UAAU,CAAY;IAGzC,CAAC;IAEM,KAAK,CAAC,GAAG,CAAS,GAAW,EAAE,KAAa;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QACnC,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAEhE,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;IAC5E,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IAC3B,CAAC;IAEM,KAAK,CAAC,GAAG,CAAS,GAAW;QAClC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEvC,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,IAAI,CAAA;SACZ;QAED,MAAM,gBAAgB,GAAc,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;QACrE,OAAO,gBAAgB,CAAC,KAAe,CAAA;IACzC,CAAC;IAEM,KAAK,CAAC,QAAQ,CACnB,GAAW,EACX,OAA8B;QAE9B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEvC,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAA;YAChC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;YAE7B,OAAO,QAAQ,CAAA;SAChB;QAED,MAAM,gBAAgB,GAAc,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;QACrE,OAAO,gBAAgB,CAAC,KAAe,CAAA;IACzC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAW;QAC7B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEvC,OAAO,CAAC,CAAC,IAAI,CAAA;IACf,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAW;QAC7B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC/B,CAAC;CACF;AAED,kBAAe,UAAU,CAAA"}

package/utils/caching/index.d.ts

@@ -4,3 +4,4 @@ export { default as GlobalAtomicCache } from './GlobalAtomicCache';
 export { default as MemoryCache } from './MemoryCache';
 export { default as SecretCache } from './SecretCache';
 export { default as S3Cache } from './S3Cache';
+export { default as RedisCache } from './RedisCache';

package/utils/caching/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.S3Cache = exports.SecretCache = exports.MemoryCache = exports.GlobalAtomicCache = exports.FileCache = exports.Cache = void 0;
+exports.RedisCache = exports.S3Cache = exports.SecretCache = exports.MemoryCache = exports.GlobalAtomicCache = exports.FileCache = exports.Cache = void 0;
 var Cache_1 = require("./Cache");
 Object.defineProperty(exports, "Cache", { enumerable: true, get: function () { return __importDefault(Cache_1).default; } });
 var FileCache_1 = require("./FileCache");
@@ -16,4 +16,6 @@ var SecretCache_1 = require("./SecretCache");
 Object.defineProperty(exports, "SecretCache", { enumerable: true, get: function () { return __importDefault(SecretCache_1).default; } });
 var S3Cache_1 = require("./S3Cache");
 Object.defineProperty(exports, "S3Cache", { enumerable: true, get: function () { return __importDefault(S3Cache_1).default; } });
+var RedisCache_1 = require("./RedisCache");
+Object.defineProperty(exports, "RedisCache", { enumerable: true, get: function () { return __importDefault(RedisCache_1).default; } });
 //# sourceMappingURL=index.js.map

package/utils/caching/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../utils/caching/index.ts"],"names":[],"mappings":";;;;;;AAAA,iCAA0C;AAAjC,+GAAA,OAAO,OAAS;AAEzB,yCAAkD;AAAzC,uHAAA,OAAO,OAAa;AAC7B,yDAAkE;AAAzD,uIAAA,OAAO,OAAqB;AACrC,6CAAsD;AAA7C,2HAAA,OAAO,OAAe;AAC/B,6CAAsD;AAA7C,2HAAA,OAAO,OAAe;AAC/B,qCAA8C;AAArC,mHAAA,OAAO,OAAW"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../utils/caching/index.ts"],"names":[],"mappings":";;;;;;AAAA,iCAA0C;AAAjC,+GAAA,OAAO,OAAS;AAEzB,yCAAkD;AAAzC,uHAAA,OAAO,OAAa;AAC7B,yDAAkE;AAAzD,uIAAA,OAAO,OAAqB;AACrC,6CAAsD;AAA7C,2HAAA,OAAO,OAAe;AAC/B,6CAAsD;AAA7C,2HAAA,OAAO,OAAe;AAC/B,qCAA8C;AAArC,mHAAA,OAAO,OAAW;AAC3B,2CAAoD;AAA3C,yHAAA,OAAO,OAAc"}