@trunkrs/common 1.4.5 → 1.4.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trunkrs/common",
-  "version": "1.4.5",
+  "version": "1.4.6",
   "description": "Common standards library for development in Trunkrs",
   "types": "./index.d.ts",
   "repository": "https://github.com/Trunkrs/common.git",

package/utils/caching/S3Cache.d.ts

@@ -0,0 +1,18 @@
+import { Serializer } from '../serialization';
+import Cache from './Cache';
+declare class S3Cache extends Cache {
+    private readonly serializer;
+    private readonly bucketArn;
+    private readonly keyPrefix;
+    private readonly expirationTagName;
+    private readonly s3Client;
+    constructor(serializer: Serializer, bucketArn: string, keyPrefix?: string, stalenessTimeout?: number);
+    private getFullKey;
+    hasKey(key: string): Promise<boolean>;
+    add<TValue>(key: string, value: TValue): Promise<void>;
+    get<TValue>(key: string): Promise<TValue | null>;
+    getOrAdd<TValue>(key: string, factory: () => Promise<TValue>): Promise<TValue>;
+    remove(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+export default S3Cache;

package/utils/caching/S3Cache.js

@@ -0,0 +1,114 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const aws_sdk_1 = require("aws-sdk");
+const Cache_1 = __importDefault(require("./Cache"));
+class S3Cache extends Cache_1.default {
+    constructor(serializer, bucketArn, keyPrefix = 'cached', stalenessTimeout = 0) {
+        super(stalenessTimeout);
+        this.serializer = serializer;
+        this.bucketArn = bucketArn;
+        this.keyPrefix = keyPrefix;
+        this.expirationTagName = 'CacheExpiration';
+        this.s3Client = new aws_sdk_1.S3();
+    }
+    getFullKey(key) {
+        return `${this.keyPrefix}/${key}`;
+    }
+    async hasKey(key) {
+        try {
+            const meta = await this.s3Client
+                .headObject({
+                Bucket: this.bucketArn,
+                Key: this.getFullKey(key),
+            })
+                .promise();
+            const { [this.expirationTagName]: expiration } = meta.Metadata;
+            return this.isValidItem({
+                expiration: new Date(expiration),
+            });
+        }
+        catch (error) {
+            const s3Error = error;
+            if (s3Error.statusCode === 404) {
+                return false;
+            }
+            throw error;
+        }
+    }
+    async add(key, value) {
+        const cacheItem = this.createItem(value);
+        await this.s3Client
+            .putObject({
+            Bucket: this.bucketArn,
+            Key: this.getFullKey(key),
+            Body: this.serializer.serialize(value, 'string'),
+            Metadata: {
+                [this.expirationTagName]: String(Number(cacheItem.expiration)),
+            },
+        })
+            .promise();
+    }
+    async get(key) {
+        const isValid = await this.hasKey(key);
+        if (!isValid) {
+            return null;
+        }
+        const object = await this.s3Client
+            .getObject({
+            Bucket: this.bucketArn,
+            Key: this.getFullKey(key),
+        })
+            .promise();
+        return this.serializer.deserialize(object.Body);
+    }
+    async getOrAdd(key, factory) {
+        const value = await this.get(key);
+        if (value) {
+            return value;
+        }
+        const newValue = await factory();
+        await this.add(key, newValue);
+        return newValue;
+    }
+    async remove(key) {
+        try {
+            await this.s3Client
+                .deleteObject({
+                Bucket: this.bucketArn,
+                Key: this.getFullKey(key),
+            })
+                .promise();
+        }
+        catch (error) {
+            const s3Error = error;
+            if (s3Error.statusCode !== 404) {
+                throw error;
+            }
+        }
+    }
+    async clear() {
+        const bucketItems = await this.s3Client
+            .listObjectsV2({
+            Bucket: this.bucketArn,
+        })
+            .promise();
+        if (!bucketItems.Contents || !bucketItems.Contents.length) {
+            return;
+        }
+        await this.s3Client
+            .deleteObjects({
+            Bucket: this.bucketArn,
+            Delete: {
+                Objects: bucketItems.Contents.map((bucketObject) => ({
+                    Key: bucketObject.Key,
+                })),
+            },
+        })
+            .promise();
+    }
+}
+exports.default = S3Cache;
+//# sourceMappingURL=S3Cache.js.map

package/utils/caching/S3Cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3Cache.js","sourceRoot":"","sources":["../../../utils/caching/S3Cache.ts"],"names":[],"mappings":";;;;;AAAA,qCAAsC;AAItC,oDAA0C;AAE1C,MAAM,OAAQ,SAAQ,eAAK;IAKzB,YACmB,UAAsB,EACtB,SAAiB,EACjB,YAAoB,QAAQ,EAC7C,gBAAgB,GAAG,CAAC;QAEpB,KAAK,CAAC,gBAAgB,CAAC,CAAA;QALN,eAAU,GAAV,UAAU,CAAY;QACtB,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAmB;QAP9B,sBAAiB,GAAG,iBAAiB,CAAA;QAErC,aAAQ,GAAG,IAAI,YAAE,EAAE,CAAA;IASpC,CAAC;IAEO,UAAU,CAAC,GAAW;QAC5B,OAAO,GAAG,IAAI,CAAC,SAAS,IAAI,GAAG,EAAE,CAAA;IACnC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAW;QAC7B,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ;iBAC7B,UAAU,CAAC;gBACV,MAAM,EAAE,IAAI,CAAC,SAAS;gBACtB,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;aAC1B,CAAC;iBACD,OAAO,EAAE,CAAA;YAEZ,MAAM,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,QAAoB,CAAA;YAC1E,OAAO,IAAI,CAAC,WAAW,CAAC;gBACtB,UAAU,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC;aACpB,CAAC,CAAA;SAChB;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,OAAO,GAAG,KAAiB,CAAA;YACjC,IAAI,OAAO,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC9B,OAAO,KAAK,CAAA;aACb;YAED,MAAM,KAAK,CAAA;SACZ;IACH,CAAC;IAEM,KAAK,CAAC,GAAG,CAAS,GAAW,EAAE,KAAa;QACjD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QAExC,MAAM,IAAI,CAAC,QAAQ;aAChB,SAAS,CAAC;YACT,MAAM,EAAE,IAAI,CAAC,SAAS;YACtB,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YACzB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC;YAChD,QAAQ,EAAE;gBACR,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;aAC/D;SACF,CAAC;aACD,OAAO,EAAE,CAAA;IACd,CAAC;IAEM,KAAK,CAAC,GAAG,CAAS,GAAW;QAClC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACtC,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,IAAI,CAAA;SACZ;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ;aAC/B,SAAS,CAAC;YACT,MAAM,EAAE,IAAI,CAAC,SAAS;YACtB,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;SAC1B,CAAC;aACD,OAAO,EAAE,CAAA;QAEZ,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAS,MAAM,CAAC,IAAc,CAAC,CAAA;IACnE,CAAC;IAEM,KAAK,CAAC,QAAQ,CACnB,GAAW,EACX,OAA8B;QAE9B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAS,GAAG,CAAC,CAAA;QACzC,IAAI,KAAK,EAAE;YACT,OAAO,KAAK,CAAA;SACb;QAED,MAAM,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAA;QAChC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;QAC7B,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAW;QAC7B,IAAI;YACF,MAAM,IAAI,CAAC,QAAQ;iBAChB,YAAY,CAAC;gBACZ,MAAM,EAAE,IAAI,CAAC,SAAS;gBACtB,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;aAC1B,CAAC;iBACD,OAAO,EAAE,CAAA;SACb;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,OAAO,GAAG,KAAiB,CAAA;YACjC,IAAI,OAAO,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC9B,MAAM,KAAK,CAAA;aACZ;SACF;IACH,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,QAAQ;aACpC,aAAa,CAAC;YACb,MAAM,EAAE,IAAI,CAAC,SAAS;SACvB,CAAC;aACD,OAAO,EAAE,CAAA;QAEZ,IAAI,CAAC,WAAW,CAAC,QAAQ,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,EAAE;YACzD,OAAM;SACP;QAED,MAAM,IAAI,CAAC,QAAQ;aAChB,aAAa,CAAC;YACb,MAAM,EAAE,IAAI,CAAC,SAAS;YACtB,MAAM,EAAE;gBACN,OAAO,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;oBACnD,GAAG,EAAE,YAAY,CAAC,GAAa;iBAChC,CAAC,CAAC;aACJ;SACF,CAAC;aACD,OAAO,EAAE,CAAA;IACd,CAAC;CACF;AAED,kBAAe,OAAO,CAAA"}

package/utils/caching/index.d.ts

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

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.SecretCache = exports.MemoryCache = exports.GlobalAtomicCache = exports.FileCache = exports.Cache = void 0;
+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");
@@ -14,4 +14,6 @@ var MemoryCache_1 = require("./MemoryCache");
 Object.defineProperty(exports, "MemoryCache", { enumerable: true, get: function () { return __importDefault(MemoryCache_1).default; } });
 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; } });
 //# 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"}
+{"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"}