@skalfa/skalfa-cache 1.0.0

package/bun.lock

@@ -0,0 +1,42 @@
+{
+  "lockfileVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "@skalfa/skalfa-cache",
+      "dependencies": {
+        "@skalfa/skalfa-redis": "file:../skalfa-redis",
+      },
+      "devDependencies": {
+        "@types/node": "^26.0.0",
+        "typescript": "^6.0.3",
+      },
+    },
+  },
+  "packages": {
+    "@ioredis/commands": ["@ioredis/commands@1.10.0", "", {}, "sha512-UmeW7z4LfctwoQ5wkhVzgq8tXkreED2xZGpX+Bg+zA+WJFZCT6c062AfCK/Dfk81xZnnwdhJCUMkitihRaoC2Q=="],
+
+    "@skalfa/skalfa-redis": ["@skalfa/skalfa-redis@file:../skalfa-redis", { "dependencies": { "ioredis": "^5.4.1" }, "devDependencies": { "@types/node": "^26.0.0", "typescript": "^6.0.3" } }],
+
+    "@types/node": ["@types/node@26.0.0", "", { "dependencies": { "undici-types": "~8.3.0" } }, "sha512-vf2YFi1iY9lHGwNJMs01biZFbKJkrZR1T6/MlzjhJLPdntOHLhTrDSnSVcdtvjihi4VQNlrFRIxLsDBlQpAipA=="],
+
+    "cluster-key-slot": ["cluster-key-slot@1.1.1", "", {}, "sha512-rwHwUfXL40Chm1r08yrhU3qpUvdVlgkKNeyeGPOxnW8/SyVDvgRaed/Uz54AqWNaTCAThlj6QAs3TZcKI0xDEw=="],
+
+    "debug": ["debug@4.4.3", "", { "dependencies": { "ms": "^2.1.3" } }, "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA=="],
+
+    "denque": ["denque@2.1.0", "", {}, "sha512-HVQE3AAb/pxF8fQAoiqpvg9i3evqug3hoiwakOyZAwJm+6vZehbkYXZ0l4JxS+I3QxM97v5aaRNhj8v5oBhekw=="],
+
+    "ioredis": ["ioredis@5.11.1", "", { "dependencies": { "@ioredis/commands": "1.10.0", "cluster-key-slot": "1.1.1", "debug": "4.4.3", "denque": "2.1.0", "redis-errors": "1.2.0", "redis-parser": "3.0.0", "standard-as-callback": "2.1.0" } }, "sha512-ehuGcf94bQXhfagULNXrJdfnWO38v070jxSx/qE87Kjzmu2fU7ro5EFAb+OPituLqgfyuQaym5DlrNydW2sJ9A=="],
+
+    "ms": ["ms@2.1.3", "", {}, "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="],
+
+    "redis-errors": ["redis-errors@1.2.0", "", {}, "sha512-1qny3OExCf0UvUV/5wpYKf2YwPcOqXzkwKKSmKHiE6ZMQs5heeE/c8eXK+PNllPvmjgAbfnsbpkGZWy8cBpn9w=="],
+
+    "redis-parser": ["redis-parser@3.0.0", "", { "dependencies": { "redis-errors": "^1.0.0" } }, "sha512-DJnGAeenTdpMEH6uAJRK/uiyEIH9WVsUmoLwzudwGJUwZPp80PDBWPHXSAGNPwNvIXAbe7MSUB1zQFugFml66A=="],
+
+    "standard-as-callback": ["standard-as-callback@2.1.0", "", {}, "sha512-qoRRSyROncaz1z0mvYqIE4lCd9p2R90i6GxW3uZv5ucSu8tU7B5HXUP1gG8pVZsYNVaXjk8ClXHPttLyxAL48A=="],
+
+    "typescript": ["typescript@6.0.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw=="],
+
+    "undici-types": ["undici-types@8.3.0", "", {}, "sha512-j375ScV60dom+YkPFIfTLcOiPxkN/buHz5GobjLhixFuANaNs3C9l4GmrWqejgXWJ7BbJcFYpTEUkS1Ge8bpZQ=="],
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export declare const cache: {
+    makeKey(type: string, prefix: string, query: any): string;
+    get<T>(key: string): Promise<T | null>;
+    set(key: string, value: any, expired: number): Promise<void>;
+    clear(type: string, prefix: string): Promise<void>;
+};

package/dist/index.js

@@ -0,0 +1,41 @@
+import { redis } from "@skalfa/skalfa-redis";
+export const cache = {
+    // =============================>
+    // ## Cache: Make key of cache database
+    // =============================>
+    makeKey(type, prefix, query) {
+        const keyParts = typeof query === "object" ? JSON.stringify(query) : String(query);
+        return `${type}:${prefix}:${Buffer.from(keyParts).toString("base64")}`;
+    },
+    // =============================>
+    // ## Cache: Get cache with key
+    // =============================>
+    async get(key) {
+        const cached = await redis.get(key);
+        if (!cached)
+            return null;
+        try {
+            return JSON.parse(cached);
+        }
+        catch {
+            return null;
+        }
+    },
+    // =============================>
+    // ## Cache: Set cache record
+    // =============================>
+    async set(key, value, expired) {
+        const ttl = expired ?? 60;
+        await redis.set(key, JSON.stringify(value), "EX", ttl);
+    },
+    // =============================>
+    // ## Cache: Set cache record
+    // =============================>
+    async clear(type, prefix) {
+        const keyPrefix = `${type}:${prefix}:*`;
+        const keys = await redis.keys(keyPrefix);
+        if (keys.length)
+            await redis.del(keys);
+    }
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAE7C,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,iCAAiC;IACjC,uCAAuC;IACvC,iCAAiC;IACjC,OAAO,CAAC,IAAY,EAAE,MAAc,EAAE,KAAU;QAC9C,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnF,OAAO,GAAG,IAAI,IAAI,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;IACzE,CAAC;IAID,iCAAiC;IACjC,+BAA+B;IAC/B,iCAAiC;IACjC,KAAK,CAAC,GAAG,CAAI,GAAW;QACtB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QACzB,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAM,CAAC;QACjC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAID,iCAAiC;IACjC,6BAA6B;IAC7B,iCAAiC;IACjC,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,OAAe;QAChD,MAAM,GAAG,GAAG,OAAO,IAAI,EAAE,CAAC;QAC1B,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IACzD,CAAC;IAID,iCAAiC;IACjC,6BAA6B;IAC7B,iCAAiC;IACjC,KAAK,CAAC,KAAK,CAAC,IAAY,EAAE,MAAc;QACtC,MAAM,SAAS,GAAG,GAAG,IAAI,IAAI,MAAM,IAAI,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACxC,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACxC,CAAC;CACF,CAAA"}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@skalfa/skalfa-cache",
+  "version": "1.0.0",
+  "description": "Cache utility package for Skalfa API framework using Redis.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc --ignoreDeprecations 6.0"
+  },
+  "keywords": [
+    "aluna",
+    "cache",
+    "redis",
+    "skalfa"
+  ],
+  "author": "",
+  "license": "UNLICENSED",
+  "dependencies": {
+    "@skalfa/skalfa-redis": "file:../skalfa-redis"
+  },
+  "devDependencies": {
+    "@types/node": "^26.0.0",
+    "typescript": "^6.0.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,47 @@
+import { redis } from "@skalfa/skalfa-redis";
+
+export const cache = {
+  // =============================>
+  // ## Cache: Make key of cache database
+  // =============================>
+  makeKey(type: string, prefix: string, query: any): string {
+    const keyParts = typeof query === "object" ? JSON.stringify(query) : String(query);
+    return `${type}:${prefix}:${Buffer.from(keyParts).toString("base64")}`;
+  },
+
+
+
+  // =============================>
+  // ## Cache: Get cache with key
+  // =============================>
+  async get<T>(key: string): Promise<T | null> {
+    const cached = await redis.get(key);
+    if (!cached) return null;
+    try {
+      return JSON.parse(cached) as T;
+    } catch {
+      return null;
+    }
+  },
+
+
+
+  // =============================>
+  // ## Cache: Set cache record
+  // =============================>
+  async set(key: string, value: any, expired: number): Promise<void> {
+    const ttl = expired ?? 60; 
+    await redis.set(key, JSON.stringify(value), "EX", ttl);
+  },
+
+
+
+  // =============================>
+  // ## Cache: Set cache record
+  // =============================>
+  async clear(type: string, prefix: string) {
+    const keyPrefix = `${type}:${prefix}:*`
+    const keys = await redis.keys(keyPrefix)
+    if (keys.length) await redis.del(keys)
+  }
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "ignoreDeprecations": "5.0",
+    "target": "ES2021",
+    "module": "ES2022",
+    "moduleResolution": "node",
+    "declaration": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "baseUrl": "."
+  },
+  "include": ["src/**/*"]
+}