@qelos/cache-manager 3.0.1

package/.nvmrc

@@ -0,0 +1 @@
+16

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Qelos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @qelos/cache-manager
+
+cache manager library for backend services, using redis or internal memory.

package/cache-manager-options.ts

@@ -0,0 +1,5 @@
+
+export interface CacheManagerOptions {
+    // in seconds
+    ttl: number
+}

package/cache-type.ts

@@ -0,0 +1,6 @@
+import { CacheManagerOptions } from "./cache-manager-options";
+
+export interface ICache {
+    getItem: (key: string) => Promise<string>;
+    setItem: (key: string, value: string, options: CacheManagerOptions) => Promise<void>;
+}

package/dist/cache-manager-options.d.ts

@@ -0,0 +1,3 @@
+export interface CacheManagerOptions {
+    ttl: number;
+}

package/dist/cache-manager-options.js

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

package/dist/cache-manager-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache-manager-options.js","sourceRoot":"","sources":["../cache-manager-options.ts"],"names":[],"mappings":""}

package/dist/cache-type.d.ts

@@ -0,0 +1,5 @@
+import { CacheManagerOptions } from "./cache-manager-options";
+export interface ICache {
+    getItem: (key: string) => Promise<string>;
+    setItem: (key: string, value: string, options: CacheManagerOptions) => Promise<void>;
+}

package/dist/cache-type.js

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

package/dist/cache-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache-type.js","sourceRoot":"","sources":["../cache-type.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { CacheManagerOptions } from "./cache-manager-options";
+import { ICache } from "./cache-type";
+export declare type IDataProviderCallback = () => string | Promise<string>;
+export interface CacheManager {
+    getItem: (key: string) => Promise<string>;
+    setItem: (key: string, value: string, { ttl }?: CacheManagerOptions) => Promise<void>;
+    wrap: (key: string, fallback: IDataProviderCallback, setterOptions?: Partial<CacheManagerOptions>) => Promise<string>;
+}
+export declare function createCacheManager(cacher: ICache, applicationOptions?: CacheManagerOptions): CacheManager;

package/dist/index.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCacheManager = void 0;
+function createCacheManager(cacher, applicationOptions = { ttl: 6000 }) {
+    return {
+        getItem: cacher.getItem,
+        setItem(key, value, options = {}) {
+            return cacher.setItem(key, value, { ...applicationOptions, ...options });
+        },
+        async wrap(key, fallback, setterOptions = {}) {
+            let currentValue;
+            try {
+                currentValue = await cacher.getItem(key);
+            }
+            catch {
+                //
+            }
+            if (currentValue) {
+                return currentValue;
+            }
+            try {
+                currentValue = await fallback();
+                // doing it in background
+                setImmediate(() => {
+                    cacher.setItem(key, currentValue, { ...applicationOptions, ...setterOptions }).catch(() => console.warn('could not set value on cache provider', key));
+                });
+            }
+            catch {
+            }
+            return currentValue;
+        }
+    };
+}
+exports.createCacheManager = createCacheManager;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAWA,SAAgB,kBAAkB,CAAC,MAAc,EAAE,qBAA0C,EAAE,GAAG,EAAE,IAAI,EAAE;IAEtG,OAAO;QACH,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,OAAO,CAAC,GAAW,EAAE,KAAa,EAAE,UAAwC,EAAE;YAC1E,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,GAAG,kBAAkB,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QAC7E,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,QAA+B,EAAE,gBAA8C,EAAE;YACrG,IAAI,YAAY,CAAC;YACjB,IAAI;gBACA,YAAY,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;aAC5C;YAAC,MAAM;gBACJ,EAAE;aACL;YACD,IAAI,YAAY,EAAE;gBACd,OAAO,YAAY,CAAC;aACvB;YACD,IAAI;gBACA,YAAY,GAAG,MAAM,QAAQ,EAAE,CAAC;gBAEhC,yBAAyB;gBACzB,YAAY,CAAC,GAAG,EAAE;oBACd,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,GAAG,kBAAkB,EAAE,GAAG,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE,GAAG,CAAC,CAAC,CAAC;gBAC3J,CAAC,CAAC,CAAC;aACN;YAAC,MAAM;aAEP;YACD,OAAO,YAAY,CAAC;QACxB,CAAC;KACJ,CAAA;AACL,CAAC;AA9BD,gDA8BC"}

package/dist/memory-cache.d.ts

@@ -0,0 +1,2 @@
+import { ICache } from "./cache-type";
+export declare function createMemoryCache(): ICache;

package/dist/memory-cache.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMemoryCache = void 0;
+function createMemoryCache() {
+    const storage = new Map();
+    const keysToRemove = new Map();
+    const getItem = (key) => {
+        return Promise.resolve(storage.get(key));
+    };
+    const setItem = (key, value, { ttl }) => {
+        storage.set(key, value);
+        if (ttl) {
+            keysToRemove.set(key, Date.now() + (ttl * 1000));
+        }
+        return Promise.resolve();
+    };
+    setInterval(() => {
+        const now = Date.now();
+        keysToRemove.forEach((timeToRemove, key) => {
+            if (now > timeToRemove) {
+                keysToRemove.delete(key);
+                storage.delete(key);
+            }
+        });
+    }, 5000);
+    return { getItem, setItem };
+}
+exports.createMemoryCache = createMemoryCache;
+//# sourceMappingURL=memory-cache.js.map

package/dist/memory-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory-cache.js","sourceRoot":"","sources":["../memory-cache.ts"],"names":[],"mappings":";;;AAGA,SAAgB,iBAAiB;IAC7B,MAAM,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;IAC1B,MAAM,YAAY,GAAG,IAAI,GAAG,EAAE,CAAC;IAE/B,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,EAAE;QAC5B,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAA;IAED,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,KAAa,EAAE,EAAE,GAAG,EAAuB,EAAE,EAAE;QACzE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACxB,IAAI,GAAG,EAAE;YACL,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC;SACpD;QACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC,CAAA;IAED,WAAW,CAAC,GAAG,EAAE;QACb,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,YAAY,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,GAAG,EAAE,EAAE;YACvC,IAAI,GAAG,GAAG,YAAY,EAAE;gBACpB,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACzB,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aACvB;QACL,CAAC,CAAC,CAAC;IACP,CAAC,EAAE,IAAI,CAAC,CAAC;IAET,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;AAChC,CAAC;AA3BD,8CA2BC"}

package/dist/redis-cache.d.ts

@@ -0,0 +1,2 @@
+import { ICache } from "./cache-type";
+export declare function createRedisCache(redisUrl: string): ICache;

package/dist/redis-cache.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRedisCache = void 0;
+const util_1 = require("util");
+const redis_1 = require("redis");
+function createRedisCache(redisUrl) {
+    const client = (0, redis_1.createClient)(redisUrl);
+    client.on("connect", function () {
+        console.log('redis is connected for cache manager');
+    });
+    client.on("error", function (error) {
+        console.warn("failed to connect to redis server");
+    });
+    const getItem = (0, util_1.promisify)(client.get).bind(client);
+    const setItem = (0, util_1.promisify)(client.set).bind(client);
+    return {
+        getItem,
+        async setItem(key, value, { ttl }) {
+            await setItem(key, value);
+            if (ttl) {
+                client.expire(key, ttl);
+            }
+        }
+    };
+}
+exports.createRedisCache = createRedisCache;
+//# sourceMappingURL=redis-cache.js.map

package/dist/redis-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-cache.js","sourceRoot":"","sources":["../redis-cache.ts"],"names":[],"mappings":";;;AACA,+BAAiC;AACjC,iCAAqC;AAGrC,SAAgB,gBAAgB,CAAC,QAAgB;IAC7C,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,QAAQ,CAAC,CAAC;IACtC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE;QACjB,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK;QAC9B,OAAO,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,OAAO,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEnD,OAAO;QACH,OAAO;QACP,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,KAAa,EAAE,EAAE,GAAG,EAAuB;YAClE,MAAM,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC1B,IAAI,GAAG,EAAE;gBACL,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aAC3B;QACL,CAAC;KACJ,CAAC;AACN,CAAC;AArBD,4CAqBC"}

package/index.ts

@@ -0,0 +1,42 @@
+import { CacheManagerOptions } from "./cache-manager-options";
+import { ICache } from "./cache-type";
+
+export type IDataProviderCallback = () => string | Promise<string>;
+
+export interface CacheManager {
+    getItem: (key: string) => Promise<string>;
+    setItem: (key: string, value: string, { ttl }?: CacheManagerOptions) => Promise<void>;
+    wrap: (key: string, fallback: IDataProviderCallback, setterOptions?: Partial<CacheManagerOptions>) => Promise<string>;
+}
+
+export function createCacheManager(cacher: ICache, applicationOptions: CacheManagerOptions = { ttl: 6000 }): CacheManager {
+
+    return {
+        getItem: cacher.getItem,
+        setItem(key: string, value: string, options: Partial<CacheManagerOptions> = {}) {
+            return cacher.setItem(key, value, { ...applicationOptions, ...options });
+        },
+        async wrap(key: string, fallback: IDataProviderCallback, setterOptions: Partial<CacheManagerOptions> = {}) {
+            let currentValue;
+            try {
+                currentValue = await cacher.getItem(key);
+            } catch {
+                //
+            }
+            if (currentValue) {
+                return currentValue;
+            }
+            try {
+                currentValue = await fallback();
+
+                // doing it in background
+                setImmediate(() => {
+                    cacher.setItem(key, currentValue, { ...applicationOptions, ...setterOptions }).catch(() => console.warn('could not set value on cache provider', key));
+                });
+            } catch {
+
+            }
+            return currentValue;
+        }
+    }
+}

package/memory-cache.ts

@@ -0,0 +1,31 @@
+import { CacheManagerOptions } from "./cache-manager-options";
+import { ICache } from "./cache-type";
+
+export function createMemoryCache(): ICache {
+    const storage = new Map();
+    const keysToRemove = new Map();
+
+    const getItem = (key: string) => {
+        return Promise.resolve(storage.get(key));
+    }
+
+    const setItem = (key: string, value: string, { ttl }: CacheManagerOptions) => {
+        storage.set(key, value);
+        if (ttl) {
+            keysToRemove.set(key, Date.now() + (ttl * 1000));
+        }
+        return Promise.resolve();
+    }
+
+    setInterval(() => {
+        const now = Date.now();
+        keysToRemove.forEach((timeToRemove, key) => {
+            if (now > timeToRemove) {
+                keysToRemove.delete(key);
+                storage.delete(key);
+            }
+        });
+    }, 5000);
+
+    return { getItem, setItem };
+}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@qelos/cache-manager",
+  "version": "3.0.1",
+  "description": "",
+  "main": "./dist/index.js",
+  "private": false,
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "redis": "3.0.2"
+  },
+  "devDependencies": {
+    "@types/redis": "^2.8.31",
+    "typescript": "^4.6.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "c4a69b318689cb5c7d35a05f057e0ed6c9676594"
+}

package/redis-cache.ts

@@ -0,0 +1,27 @@
+import { ICache } from "./cache-type";
+import { promisify } from "util";
+import { createClient } from 'redis';
+import { CacheManagerOptions } from "./cache-manager-options";
+
+export function createRedisCache(redisUrl: string): ICache {
+    const client = createClient(redisUrl);
+    client.on("connect", function () {
+        console.log('redis is connected for cache manager');
+    });
+    client.on("error", function (error) {
+        console.warn("failed to connect to redis server");
+    });
+
+    const getItem = promisify(client.get).bind(client);
+    const setItem = promisify(client.set).bind(client);
+
+    return {
+        getItem,
+        async setItem(key: string, value: string, { ttl }: CacheManagerOptions): Promise<void> {
+            await setItem(key, value);
+            if (ttl) {
+                client.expire(key, ttl);
+            }
+        }
+    };
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "esnext",
+    "outDir": "./dist",
+    "sourceMap": true,
+    "declaration": true,
+    "skipLibCheck": true
+  },
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}