@acmekit/cache-inmemory 2.13.1

package/README.md

@@ -0,0 +1,25 @@
+# AcmeKit Cache In-memory
+
+AcmeKit in-memory cache module. Use plain JS Map as a cache store.
+
+## Installation
+
+```
+yarn add @acmekit/cache-inmemory
+```
+
+## Options
+
+```
+{
+  ttl?: number // Time to keep data in cache (in seconds)
+}
+```
+
+### Note
+
+Recommended for testing and development. For production, use Redis cache module.
+
+### Other caching modules
+
+- [AcmeKit Cache Redis](../cache-redis/README.md)

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { ModuleExports } from "@acmekit/framework/types";
+declare const moduleDefinition: ModuleExports;
+export default moduleDefinition;
+export * from "./initialize";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAKxD,QAAA,MAAM,gBAAgB,EAAE,aAEvB,CAAA;AAED,eAAe,gBAAgB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,SAAS,CAAA"}

package/dist/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const inmemory_cache_1 = __importDefault(require("./services/inmemory-cache"));
+const service = inmemory_cache_1.default;
+const moduleDefinition = {
+    service,
+};
+exports.default = moduleDefinition;
+__exportStar(require("./initialize"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AACA,+EAA4D;AAE5D,MAAM,OAAO,GAAG,wBAAoB,CAAA;AAEpC,MAAM,gBAAgB,GAAkB;IACtC,OAAO;CACR,CAAA;AAED,kBAAe,gBAAgB,CAAA;AAC/B,+CAA4B;AAC5B,0CAAuB"}

package/dist/initialize/index.d.ts

@@ -0,0 +1,4 @@
+import { ExternalModuleDeclaration, ICacheService } from "@acmekit/framework/types";
+import { InMemoryCacheModuleOptions } from "../types";
+export declare const initialize: (options?: InMemoryCacheModuleOptions | ExternalModuleDeclaration) => Promise<ICacheService>;
+//# sourceMappingURL=index.d.ts.map

package/dist/initialize/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/initialize/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,yBAAyB,EACzB,aAAa,EAEd,MAAM,0BAA0B,CAAA;AAEjC,OAAO,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAA;AAErD,eAAO,MAAM,UAAU,GACrB,UAAU,0BAA0B,GAAG,yBAAyB,KAC/D,OAAO,CAAC,aAAa,CAWvB,CAAA"}

package/dist/initialize/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initialize = void 0;
+const modules_sdk_1 = require("@acmekit/framework/modules-sdk");
+const utils_1 = require("@acmekit/framework/utils");
+const initialize = async (options) => {
+    const serviceKey = utils_1.Modules.CACHE;
+    const loaded = await modules_sdk_1.AcmeKitModule.bootstrap({
+        moduleKey: serviceKey,
+        defaultPath: "@acmekit//cache-inmemory",
+        declaration: options,
+    });
+    return loaded[serviceKey];
+};
+exports.initialize = initialize;
+//# sourceMappingURL=index.js.map

package/dist/initialize/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/initialize/index.ts"],"names":[],"mappings":";;;AAAA,gEAA8D;AAM9D,oDAAkD;AAG3C,MAAM,UAAU,GAAG,KAAK,EAC7B,OAAgE,EACxC,EAAE;IAC1B,MAAM,UAAU,GAAG,eAAO,CAAC,KAAK,CAAA;IAChC,MAAM,MAAM,GAAG,MAAM,2BAAa,CAAC,SAAS,CAAgB;QAC1D,SAAS,EAAE,UAAU;QACrB,WAAW,EAAE,0BAA0B;QACvC,WAAW,EAAE,OAEgB;KAC9B,CAAC,CAAA;IAEF,OAAO,MAAM,CAAC,UAAU,CAAC,CAAA;AAC3B,CAAC,CAAA;AAbY,QAAA,UAAU,cAatB"}

package/dist/services/index.d.ts

@@ -0,0 +1,2 @@
+export { default as InMemoryCacheService } from "./inmemory-cache";
+//# sourceMappingURL=index.d.ts.map

package/dist/services/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,kBAAkB,CAAA"}

package/dist/services/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InMemoryCacheService = void 0;
+var inmemory_cache_1 = require("./inmemory-cache");
+Object.defineProperty(exports, "InMemoryCacheService", { enumerable: true, get: function () { return __importDefault(inmemory_cache_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":";;;;;;AAAA,mDAAkE;AAAzD,uIAAA,OAAO,OAAwB"}

package/dist/services/inmemory-cache.d.ts

@@ -0,0 +1,37 @@
+import { ICacheService } from "@acmekit/framework/types";
+import { CacheRecord, InMemoryCacheModuleOptions } from "../types";
+type InjectedDependencies = {};
+/**
+ * Class represents basic, in-memory, cache store.
+ */
+declare class InMemoryCacheService implements ICacheService {
+    protected readonly TTL: number;
+    protected readonly store: Map<string, CacheRecord<any>>;
+    protected readonly timoutRefs: Map<string, NodeJS.Timeout>;
+    constructor(deps: InjectedDependencies, options?: InMemoryCacheModuleOptions);
+    /**
+     * Retrieve data from the cache.
+     * @param key - cache key
+     */
+    get<T>(key: string): Promise<T | null>;
+    /**
+     * Set data to the cache.
+     * @param key - cache key under which the data is stored
+     * @param data - data to be stored in the cache
+     * @param ttl - expiration time in seconds
+     */
+    set<T>(key: string, data: T, ttl?: number): Promise<void>;
+    /**
+     * Delete data from the cache.
+     * Could use wildcard (*) matcher e.g. `invalidate("ps:*")` to delete all keys that start with "ps:"
+     *
+     * @param key - cache key
+     */
+    invalidate(key: string): Promise<void>;
+    /**
+     * Delete the entire cache.
+     */
+    clear(): Promise<void>;
+}
+export default InMemoryCacheService;
+//# sourceMappingURL=inmemory-cache.d.ts.map

package/dist/services/inmemory-cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inmemory-cache.d.ts","sourceRoot":"","sources":["../../src/services/inmemory-cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AACxD,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAA;AAIlE,KAAK,oBAAoB,GAAG,EAAE,CAAA;AAE9B;;GAEG;AACH,cAAM,oBAAqB,YAAW,aAAa;IACjD,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IAE9B,SAAS,CAAC,QAAQ,CAAC,KAAK,gCAAsC;IAC9D,SAAS,CAAC,QAAQ,CAAC,UAAU,8BAAoC;gBAG/D,IAAI,EAAE,oBAAoB,EAC1B,OAAO,GAAE,0BAA+B;IAK1C;;;OAGG;IACG,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAa5C;;;;;OAKG;IACG,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,GAAE,MAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBzE;;;;;OAKG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB5C;;OAEG;IACG,KAAK;CAMZ;AAED,eAAe,oBAAoB,CAAA"}

package/dist/services/inmemory-cache.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const DEFAULT_TTL = 30; // seconds
+/**
+ * Class represents basic, in-memory, cache store.
+ */
+class InMemoryCacheService {
+    constructor(deps, options = {}) {
+        this.store = new Map();
+        this.timoutRefs = new Map();
+        this.TTL = options.ttl ?? DEFAULT_TTL;
+    }
+    /**
+     * Retrieve data from the cache.
+     * @param key - cache key
+     */
+    async get(key) {
+        const now = Date.now();
+        const record = this.store.get(key);
+        const recordExpire = record?.expire ?? Infinity;
+        if (!record || recordExpire < now) {
+            return null;
+        }
+        return record.data;
+    }
+    /**
+     * Set data to the cache.
+     * @param key - cache key under which the data is stored
+     * @param data - data to be stored in the cache
+     * @param ttl - expiration time in seconds
+     */
+    async set(key, data, ttl = this.TTL) {
+        if (ttl === 0) {
+            return;
+        }
+        const record = { data, expire: ttl * 1000 + Date.now() };
+        const oldRecord = this.store.get(key);
+        if (oldRecord) {
+            clearTimeout(this.timoutRefs.get(key));
+            this.timoutRefs.delete(key);
+        }
+        const ref = setTimeout(async () => {
+            await this.invalidate(key);
+        }, ttl * 1000);
+        ref.unref();
+        this.timoutRefs.set(key, ref);
+        this.store.set(key, record);
+    }
+    /**
+     * Delete data from the cache.
+     * Could use wildcard (*) matcher e.g. `invalidate("ps:*")` to delete all keys that start with "ps:"
+     *
+     * @param key - cache key
+     */
+    async invalidate(key) {
+        let keys = [key];
+        if (key.includes("*")) {
+            const regExp = new RegExp(key.replace("*", ".*"));
+            keys = Array.from(this.store.keys()).filter((k) => k.match(regExp));
+        }
+        keys.forEach((key) => {
+            const timeoutRef = this.timoutRefs.get(key);
+            if (timeoutRef) {
+                clearTimeout(timeoutRef);
+                this.timoutRefs.delete(key);
+            }
+            this.store.delete(key);
+        });
+    }
+    /**
+     * Delete the entire cache.
+     */
+    async clear() {
+        this.timoutRefs.forEach((ref) => clearTimeout(ref));
+        this.timoutRefs.clear();
+        this.store.clear();
+    }
+}
+exports.default = InMemoryCacheService;
+//# sourceMappingURL=inmemory-cache.js.map

package/dist/services/inmemory-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inmemory-cache.js","sourceRoot":"","sources":["../../src/services/inmemory-cache.ts"],"names":[],"mappings":";;AAGA,MAAM,WAAW,GAAG,EAAE,CAAA,CAAC,UAAU;AAIjC;;GAEG;AACH,MAAM,oBAAoB;IAMxB,YACE,IAA0B,EAC1B,UAAsC,EAAE;QALvB,UAAK,GAAG,IAAI,GAAG,EAA4B,CAAA;QAC3C,eAAU,GAAG,IAAI,GAAG,EAA0B,CAAA;QAM/D,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,WAAW,CAAA;IACvC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG,CAAI,GAAW;QACtB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,MAAM,MAAM,GAA+B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAE9D,MAAM,YAAY,GAAG,MAAM,EAAE,MAAM,IAAI,QAAQ,CAAA;QAE/C,IAAI,CAAC,MAAM,IAAI,YAAY,GAAG,GAAG,EAAE,CAAC;YAClC,OAAO,IAAI,CAAA;QACb,CAAC;QAED,OAAO,MAAM,CAAC,IAAI,CAAA;IACpB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,IAAO,EAAE,MAAc,IAAI,CAAC,GAAG;QACvD,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;YACd,OAAM;QACR,CAAC;QAED,MAAM,MAAM,GAAmB,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAA;QAExE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAErC,IAAI,SAAS,EAAE,CAAC;YACd,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;YACtC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC7B,CAAC;QAED,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,IAAI,EAAE;YAChC,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QAC5B,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,CAAA;QAEd,GAAG,CAAC,KAAK,EAAE,CAAA;QAEX,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;QAC7B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IAC7B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,GAAW;QAC1B,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;QAEhB,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;YACjD,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;QACrE,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC3C,IAAI,UAAU,EAAE,CAAC;gBACf,YAAY,CAAC,UAAU,CAAC,CAAA;gBACxB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAC7B,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACxB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAA;QACnD,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAA;QAEvB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;IACpB,CAAC;CACF;AAED,kBAAe,oBAAoB,CAAA"}

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts","../src/initialize/index.ts","../src/services/index.ts","../src/services/inmemory-cache.ts","../src/services/__tests__/inmemory-cache.js","../src/types/index.ts"],"version":"5.9.3"}

package/dist/types/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Shape of a record saved in `in-memory`  cache
+ */
+export type CacheRecord<T> = {
+    data: T;
+    /**
+     * Timestamp in milliseconds
+     */
+    expire: number;
+};
+export type InMemoryCacheModuleOptions = {
+    /**
+     * Time to keep data in cache (in seconds)
+     */
+    ttl?: number;
+};
+declare module "@acmekit/types" {
+    interface ModuleOptions {
+        "@acmekit/cache-inmemory": InMemoryCacheModuleOptions;
+        "@acmekit/acmekit/cache-inmemory": InMemoryCacheModuleOptions;
+    }
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,IAAI,EAAE,CAAC,CAAA;IACP;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED,OAAO,QAAQ,gBAAgB,CAAC;IAC9B,UAAU,aAAa;QACrB,yBAAyB,EAAE,0BAA0B,CAAA;QACrD,iCAAiC,EAAE,0BAA0B,CAAA;KAC9D;CACF"}

package/dist/types/index.js

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

package/dist/types/index.js.map

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

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@acmekit/cache-inmemory",
+  "version": "2.13.1",
+  "description": "In-memory Cache Module for AcmeKit",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/acmekit/acmekit",
+    "directory": "packages/modules/cache-inmemory"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "!dist/**/__tests__",
+    "!dist/**/__mocks__",
+    "!dist/**/__fixtures__"
+  ],
+  "author": "AcmeKit",
+  "license": "MIT",
+  "devDependencies": {
+    "@acmekit/framework": "2.13.1"
+  },
+  "scripts": {
+    "watch": "yarn run -T tsc --build --watch",
+    "build": "yarn run -T rimraf dist && yarn run -T tsc --build",
+    "test": "../../../node_modules/.bin/jest --passWithNoTests"
+  },
+  "peerDependencies": {
+    "@acmekit/framework": "2.13.1"
+  }
+}