@saltcute/cache 1.0.0

package/dist/cache.d.ts

@@ -0,0 +1,25 @@
+import type { JsonObject } from "./type";
+export declare class Cache<T extends JsonObject> {
+    private namespace;
+    private logger;
+    private memCache;
+    private redisClient;
+    private isRedisAvailable;
+    constructor(namespace: string);
+    private getKey;
+    /**
+     * Get a value from cache.
+     *
+     * @param key Cache key.
+     * @returns Cache value.
+     */
+    get(key: string): Promise<any>;
+    /**
+     * Put a value into cache.
+     *
+     * @param key Cache key.
+     * @param value Cache value.
+     * @param ttl Cache TTL in milliseconds.
+     */
+    put(key: string, value: T, ttl: number): Promise<void>;
+}

package/dist/cache.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cache = void 0;
+const logger_1 = require("@saltcute/logger");
+const memory_cache_1 = require("memory-cache");
+const redis_1 = require("redis");
+class Cache {
+    namespace;
+    logger;
+    memCache;
+    redisClient;
+    isRedisAvailable = true;
+    constructor(namespace) {
+        this.namespace = namespace;
+        this.logger = logger_1.logger.child().withGroup(`${this.namespace}:cache`);
+        this.memCache = new memory_cache_1.Cache();
+        this.redisClient = (0, redis_1.createClient)();
+        this.redisClient.on("error", async () => {
+            this.logger.error("Redis connection error, using memory-cache");
+            this.isRedisAvailable = false;
+            this.redisClient.destroy();
+        });
+        this.redisClient.connect();
+    }
+    getKey(key) {
+        return `${this.namespace}:${key}`;
+    }
+    /**
+     * Get a value from cache.
+     *
+     * @param key Cache key.
+     * @returns Cache value.
+     */
+    async get(key) {
+        const memCacheValue = this.memCache.get(this.getKey(key));
+        if (!memCacheValue && this.isRedisAvailable) {
+            const redisValue = await this.redisClient.get(this.getKey(key));
+            if (redisValue) {
+                try {
+                    const parsed = JSON.parse(redisValue);
+                    this.memCache.put(key, parsed, 1000);
+                    return parsed;
+                }
+                catch {
+                    await this.redisClient.del(key);
+                    return null;
+                }
+            }
+        }
+        else
+            return memCacheValue;
+    }
+    /**
+     * Put a value into cache.
+     *
+     * @param key Cache key.
+     * @param value Cache value.
+     * @param ttl Cache TTL in milliseconds.
+     */
+    async put(key, value, ttl) {
+        if (this.isRedisAvailable) {
+            this.memCache.put(this.getKey(key), value, 1000);
+            await this.redisClient.set(this.getKey(key), JSON.stringify(value), {
+                expiration: {
+                    type: "EX",
+                    value: Math.trunc(ttl / 1000),
+                },
+            });
+        }
+        else
+            this.memCache.put(this.getKey(key), value, ttl);
+    }
+}
+exports.Cache = Cache;
+//# sourceMappingURL=cache.js.map

package/dist/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAC1C,+CAAiD;AACjD,iCAAqC;AAGrC,MAAa,KAAK;IAOM;IANZ,MAAM,CAAC;IAEP,QAAQ,CAAC;IACT,WAAW,CAAC;IAEZ,gBAAgB,GAAG,IAAI,CAAC;IAChC,YAAoB,SAAiB;QAAjB,cAAS,GAAT,SAAS,CAAQ;QACjC,IAAI,CAAC,MAAM,GAAG,eAAM,CAAC,KAAK,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,QAAQ,CAAC,CAAC;QAClE,IAAI,CAAC,QAAQ,GAAG,IAAI,oBAAQ,EAAa,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,IAAA,oBAAY,GAAE,CAAC;QAClC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YACpC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;YAChE,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;YAC9B,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;IAC/B,CAAC;IACO,MAAM,CAAC,GAAW;QACtB,OAAO,GAAG,IAAI,CAAC,SAAS,IAAI,GAAG,EAAE,CAAC;IACtC,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CAAC,GAAW;QACxB,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1D,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAChE,IAAI,UAAU,EAAE,CAAC;gBACb,IAAI,CAAC;oBACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;oBACtC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;oBACrC,OAAO,MAAM,CAAC;gBAClB,CAAC;gBAAC,MAAM,CAAC;oBACL,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAChC,OAAO,IAAI,CAAC;gBAChB,CAAC;YACL,CAAC;QACL,CAAC;;YAAM,OAAO,aAAa,CAAC;IAChC,CAAC;IACD;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAQ,EAAE,GAAW;QAC/C,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YACjD,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CACtB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAChB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EACrB;gBACI,UAAU,EAAE;oBACR,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;iBAChC;aACJ,CACJ,CAAC;QACN,CAAC;;YAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;CACJ;AAjED,sBAiEC"}

package/dist/type.d.ts

@@ -0,0 +1,6 @@
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonObject = {
+    [key: string]: JsonValue;
+};
+export type JsonArray = JsonValue[];
+export type JsonValue = JsonPrimitive | JsonObject | JsonArray;

package/dist/type.js

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

package/dist/type.js.map

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

package/package.json

@@ -0,0 +1,42 @@
+{
+    "name": "@saltcute/cache",
+    "version": "1.0.0",
+    "description": "Layered cache.",
+    "homepage": "https://github.com/saltcute/cache#readme",
+    "bugs": {
+        "url": "https://github.com/saltcute/cache/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/saltcute/cache.git"
+    },
+    "license": "MIT",
+    "author": "saltcute",
+    "type": "commonjs",
+    "exports": {
+        ".": "./dist/cache.js"
+    },
+    "files": [
+        "dist/"
+    ],
+    "scripts": {
+        "build": "tsc && tsc-alias",
+        "clean": "rimraf dist/*",
+        "format": "biome format --write",
+        "lint": "biome lint --write",
+        "make": "npm run clean && npm run format && npm run lint && npm run build"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "^2.5.0",
+        "@types/node": "^25.9.3",
+        "rimraf": "^6.1.3",
+        "tsc-alias": "^1.8.17",
+        "typescript": "^6.0.3"
+    },
+    "dependencies": {
+        "@saltcute/logger": "^1.0.0",
+        "@types/memory-cache": "^0.2.6",
+        "memory-cache": "^0.2.0",
+        "redis": "^6.0.0"
+    }
+}