@medusajs/cache-inmemory 2.0.0-next-20230310141356

package/README.md

@@ -0,0 +1,23 @@
+# Medusa Cache In-memory
+
+Medusa in-memory cache module. Use plain JS Map as a cache store.
+
+## Installation
+
+```
+yarn add @medusajs/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
+- [Medusa Cache Redis](../cache-redis/README.md)

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { ModuleExports } from "@medusajs/modules-sdk";
+declare const moduleDefinition: ModuleExports;
+export default moduleDefinition;

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var inmemory_cache_1 = __importDefault(require("./services/inmemory-cache"));
+var loaders = [];
+var service = inmemory_cache_1.default;
+var moduleDefinition = {
+    service: service,
+    loaders: loaders,
+};
+exports.default = moduleDefinition;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAEA,6EAA4D;AAE5D,IAAM,OAAO,GAAG,EAAE,CAAA;AAClB,IAAM,OAAO,GAAG,wBAAoB,CAAA;AAEpC,IAAM,gBAAgB,GAAkB;IACtC,OAAO,SAAA;IACP,OAAO,SAAA;CACR,CAAA;AAED,kBAAe,gBAAgB,CAAA"}

package/dist/services/index.d.ts

@@ -0,0 +1 @@
+export { default as InMemoryCacheService } from "./inmemory-cache";

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 @@
+/// <reference types="node" />
+import { ICacheService } from "@medusajs/medusa";
+import { CacheRecord, InMemoryCacheModuleOptions } from "../types";
+declare 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;

package/dist/services/inmemory-cache.js

@@ -0,0 +1,141 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var DEFAULT_TTL = 30; // seconds
+/**
+ * Class represents basic, in-memory, cache store.
+ */
+var InMemoryCacheService = /** @class */ (function () {
+    function InMemoryCacheService(deps, options) {
+        if (options === void 0) { options = {}; }
+        var _a;
+        this.store = new Map();
+        this.timoutRefs = new Map();
+        this.TTL = (_a = options.ttl) !== null && _a !== void 0 ? _a : DEFAULT_TTL;
+    }
+    /**
+     * Retrieve data from the cache.
+     * @param key - cache key
+     */
+    InMemoryCacheService.prototype.get = function (key) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var now, record, recordExpire;
+            return __generator(this, function (_b) {
+                now = Date.now();
+                record = this.store.get(key);
+                recordExpire = (_a = record === null || record === void 0 ? void 0 : record.expire) !== null && _a !== void 0 ? _a : Infinity;
+                if (!record || recordExpire < now) {
+                    return [2 /*return*/, null];
+                }
+                return [2 /*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
+     */
+    InMemoryCacheService.prototype.set = function (key, data, ttl) {
+        if (ttl === void 0) { ttl = this.TTL; }
+        return __awaiter(this, void 0, void 0, function () {
+            var record, oldRecord, ref;
+            var _this = this;
+            return __generator(this, function (_a) {
+                record = { data: data, expire: ttl * 1000 + Date.now() };
+                oldRecord = this.store.get(key);
+                if (oldRecord) {
+                    clearTimeout(this.timoutRefs.get(key));
+                    this.timoutRefs.delete(key);
+                }
+                ref = setTimeout(function () {
+                    _this.invalidate(key);
+                }, ttl * 1000);
+                this.timoutRefs.set(key, ref);
+                this.store.set(key, record);
+                return [2 /*return*/];
+            });
+        });
+    };
+    /**
+     * 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
+     */
+    InMemoryCacheService.prototype.invalidate = function (key) {
+        return __awaiter(this, void 0, void 0, function () {
+            var keys, regExp_1;
+            var _this = this;
+            return __generator(this, function (_a) {
+                keys = [key];
+                if (key.includes("*")) {
+                    regExp_1 = new RegExp(key.replace("*", ".*"));
+                    keys = Array.from(this.store.keys()).filter(function (k) { return k.match(regExp_1); });
+                }
+                keys.forEach(function (key) {
+                    var timeoutRef = _this.timoutRefs.get(key);
+                    if (timeoutRef) {
+                        clearTimeout(timeoutRef);
+                        _this.timoutRefs.delete(key);
+                    }
+                    _this.store.delete(key);
+                });
+                return [2 /*return*/];
+            });
+        });
+    };
+    /**
+     * Delete the entire cache.
+     */
+    InMemoryCacheService.prototype.clear = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                this.timoutRefs.forEach(function (ref) { return clearTimeout(ref); });
+                this.timoutRefs.clear();
+                this.store.clear();
+                return [2 /*return*/];
+            });
+        });
+    };
+    return InMemoryCacheService;
+}());
+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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,IAAM,WAAW,GAAG,EAAE,CAAA,CAAC,UAAU;AAIjC;;GAEG;AACH;IAME,8BACE,IAA0B,EAC1B,OAAwC;QAAxC,wBAAA,EAAA,YAAwC;;QALvB,UAAK,GAAG,IAAI,GAAG,EAA4B,CAAA;QAC3C,eAAU,GAAG,IAAI,GAAG,EAA0B,CAAA;QAM/D,IAAI,CAAC,GAAG,GAAG,MAAA,OAAO,CAAC,GAAG,mCAAI,WAAW,CAAA;IACvC,CAAC;IAED;;;OAGG;IACG,kCAAG,GAAT,UAAa,GAAW;;;;;gBAChB,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;gBAChB,MAAM,GAA+B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;gBAExD,YAAY,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,mCAAI,QAAQ,CAAA;gBAE/C,IAAI,CAAC,MAAM,IAAI,YAAY,GAAG,GAAG,EAAE;oBACjC,sBAAO,IAAI,EAAA;iBACZ;gBAED,sBAAO,MAAM,CAAC,IAAI,EAAA;;;KACnB;IAED;;;;;OAKG;IACG,kCAAG,GAAT,UAAa,GAAW,EAAE,IAAO,EAAE,GAAsB;QAAtB,oBAAA,EAAA,MAAc,IAAI,CAAC,GAAG;;;;;gBACjD,MAAM,GAAmB,EAAE,IAAI,MAAA,EAAE,MAAM,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAA;gBAElE,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;gBAErC,IAAI,SAAS,EAAE;oBACb,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;oBACtC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;iBAC5B;gBAEK,GAAG,GAAG,UAAU,CAAC;oBACrB,KAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;gBACtB,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,CAAA;gBAEd,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;gBAC7B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;;;;KAC5B;IAED;;;;;OAKG;IACG,yCAAU,GAAhB,UAAiB,GAAW;;;;;gBACtB,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;gBAEhB,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBACf,WAAS,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;oBACjD,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,KAAK,CAAC,QAAM,CAAC,EAAf,CAAe,CAAC,CAAA;iBACpE;gBAED,IAAI,CAAC,OAAO,CAAC,UAAC,GAAG;oBACf,IAAM,UAAU,GAAG,KAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;oBAC3C,IAAI,UAAU,EAAE;wBACd,YAAY,CAAC,UAAU,CAAC,CAAA;wBACxB,KAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;qBAC5B;oBACD,KAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gBACxB,CAAC,CAAC,CAAA;;;;KACH;IAED;;OAEG;IACG,oCAAK,GAAX;;;gBACE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,UAAC,GAAG,IAAK,OAAA,YAAY,CAAC,GAAG,CAAC,EAAjB,CAAiB,CAAC,CAAA;gBACnD,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAA;gBAEvB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;;;;KACnB;IACH,2BAAC;AAAD,CAAC,AAvFD,IAuFC;AAED,kBAAe,oBAAoB,CAAA"}

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Shape of a record saved in `in-memory`  cache
+ */
+export declare type CacheRecord<T> = {
+    data: T;
+    /**
+     * Timestamp in milliseconds
+     */
+    expire: number;
+};
+export declare type InMemoryCacheModuleOptions = {
+    /**
+     * Time to keep data in cache (in seconds)
+     */
+    ttl?: number;
+};

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": "@medusajs/cache-inmemory",
+  "version": "2.0.0-next-20230310141356",
+  "description": "In-memory Cache Module for Medusa",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medusajs/medusa",
+    "directory": "packages/cache-inmemory"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "Medusa",
+  "license": "MIT",
+  "devDependencies": {
+    "@medusajs/medusa": "2.0.0-next-20230310141356",
+    "cross-env": "^5.2.1",
+    "jest": "^25.5.4",
+    "ts-jest": "^25.5.1",
+    "typescript": "^4.4.4"
+  },
+  "scripts": {
+    "watch": "tsc --build --watch",
+    "prepare": "cross-env NODE_ENV=production yarn run build",
+    "build": "tsc --build",
+    "test": "jest --passWithNoTests",
+    "test:unit": "jest --passWithNoTests"
+  },
+  "peerDependencies": {
+    "@medusajs/medusa": "2.0.0-next-20230310141356"
+  }
+}