@tsed/platform-cache 7.0.0-alpha.1 → 7.0.0-beta.10

package/lib/esm/interfaces/PlatformCachedObject.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PlatformCachedObject.js.map

package/lib/esm/interfaces/PlatformCachedObject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformCachedObject.js","sourceRoot":"","sources":["../../../src/interfaces/PlatformCachedObject.ts"],"names":[],"mappings":"","sourcesContent":["export interface PlatformCachedObject {\n  ttl: number;\n  args: any[];\n  data: any;\n  expires: number;\n  headers: Record<string, number | string | string[]>;\n}\n"]}

package/lib/esm/interfaces/interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=interfaces.js.map

package/lib/esm/interfaces/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/interfaces/interfaces.ts"],"names":[],"mappings":"","sourcesContent":["import type {BaseContext} from \"@tsed/di\";\nimport type {Cache, CacheOptions, CachingConfig, Store} from \"cache-manager\";\nimport type {CacheManager} from \"../services/PlatformCache\";\n\nexport interface PlatformCacheSettings extends CacheOptions, CachingConfig {\n  caches?: Cache[];\n  store?:\n    | \"memory\"\n    | \"none\"\n    | Store\n    | {\n        create(...args: any[]): Store;\n      }\n    | (() => any);\n  max?: number;\n  keyResolver?: (args: any[], ctx: BaseContext) => string;\n\n  /**\n   * You may pass in any other arguments these will be passed on to the `create` method of your store,\n   * otherwise they will be ignored.\n   */\n  [key: string]: any;\n}\n\ndeclare global {\n  // eslint-disable-next-line @typescript-eslint/no-namespace\n  namespace TsED {\n    interface Configuration {\n      cache?: PlatformCacheSettings | false;\n    }\n  }\n}\n\nexport interface OnCreateCacheManager {\n  $onCreateCacheManager(cache: CacheManager): void | Promise<void>;\n}\n"]}

package/lib/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/lib/esm/services/PlatformCache.js

@@ -0,0 +1,144 @@
+var _PlatformCache_cache;
+import { __classPrivateFieldGet, __classPrivateFieldSet, __decorate, __metadata } from "tslib";
+import { isClass, isFunction } from "@tsed/core";
+import { Configuration, Inject, InjectorService, Module } from "@tsed/di";
+import { deserialize, serialize } from "@tsed/json-mapper";
+import { Logger } from "@tsed/logger";
+const defaultKeyResolver = (args) => {
+    return args.map((arg) => (isClass(arg) ? JSON.stringify(serialize(arg)) : arg)).join(":");
+};
+/**
+ * @platform
+ */
+let PlatformCache = class PlatformCache {
+    constructor() {
+        _PlatformCache_cache.set(this, void 0);
+    }
+    get cache() {
+        return __classPrivateFieldGet(this, _PlatformCache_cache, "f");
+    }
+    async $onInit() {
+        const settings = this.settings.get("cache");
+        if (settings) {
+            __classPrivateFieldSet(this, _PlatformCache_cache, await this.createCacheManager(settings), "f");
+            await this.injector.emit("$onCreateCacheManager", __classPrivateFieldGet(this, _PlatformCache_cache, "f"));
+        }
+    }
+    disabled() {
+        return !this.settings.get("cache");
+    }
+    defaultKeyResolver() {
+        return this.settings.get("cache.keyResolver", defaultKeyResolver);
+    }
+    defaultTtl() {
+        return this.settings.get("cache.ttl");
+    }
+    calculateTTL(result, currentTtl) {
+        const ttl = currentTtl === undefined ? this.defaultTtl() : currentTtl;
+        return isFunction(ttl) ? ttl(result) : ttl;
+    }
+    async ttl(key) {
+        if (this.cache && "store" in this.cache && this.cache.store.ttl) {
+            return this.cache.store.ttl(key);
+        }
+    }
+    wrap(key, fetch, options) {
+        var _a;
+        if (!this.cache) {
+            return fetch();
+        }
+        return (_a = this.cache) === null || _a === void 0 ? void 0 : _a.wrap(key, fetch, options);
+    }
+    async get(key, options = {}) {
+        var _a;
+        return deserialize((_a = this.cache) === null || _a === void 0 ? void 0 : _a.get(key), options);
+    }
+    async set(key, value, options) {
+        var _a;
+        return (_a = this.cache) === null || _a === void 0 ? void 0 : _a.set(key, value, options);
+    }
+    async getCachedObject(key) {
+        try {
+            return await this.get(key);
+        }
+        catch (er) {
+            this.logger.error({
+                event: "CACHE_ERROR",
+                method: "getCachedObject",
+                error: er
+            });
+        }
+    }
+    async setCachedObject(key, data, opts) {
+        try {
+            await this.set(key, {
+                ...opts,
+                data: JSON.stringify(data)
+            }, {
+                ttl: opts.ttl
+            });
+        }
+        catch (er) {
+            this.logger.error({
+                event: "CACHE_ERROR",
+                method: "setCachedObject",
+                error: er
+            });
+        }
+    }
+    async del(key) {
+        var _a;
+        await ((_a = this.cache) === null || _a === void 0 ? void 0 : _a.del(key));
+    }
+    async reset() {
+        var _a;
+        // @ts-ignore
+        await ((_a = this.cache) === null || _a === void 0 ? void 0 : _a.reset());
+    }
+    async keys(...args) {
+        if (this.cache && "store" in this.cache && this.cache.store.keys) {
+            return this.cache.store.keys(...args);
+        }
+        // istanbul ignore next
+        return [];
+    }
+    async getMatchingKeys(patterns) {
+        const [keys, { default: micromatch }] = await Promise.all([this.keys(), import("micromatch")]);
+        return micromatch(keys, patterns);
+    }
+    async deleteMatchingKeys(patterns) {
+        const keys = await this.getMatchingKeys(patterns);
+        await Promise.all(keys.map((key) => this.del(key)));
+        return keys;
+    }
+    async createCacheManager(settings) {
+        const { caches, store = "memory", ttl, ...props } = settings;
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { default: cacheManager } = await import("cache-manager");
+        return (caches === null || caches === void 0 ? void 0 : caches.length)
+            ? cacheManager.multiCaching(caches, { ...props })
+            : cacheManager.caching({
+                ...props,
+                ttl,
+                store: isFunction(store) ? await store() : store
+            });
+    }
+};
+_PlatformCache_cache = new WeakMap();
+__decorate([
+    Configuration(),
+    __metadata("design:type", Object)
+], PlatformCache.prototype, "settings", void 0);
+__decorate([
+    Inject(),
+    __metadata("design:type", InjectorService)
+], PlatformCache.prototype, "injector", void 0);
+__decorate([
+    Inject(),
+    __metadata("design:type", Logger)
+], PlatformCache.prototype, "logger", void 0);
+PlatformCache = __decorate([
+    Module()
+], PlatformCache);
+export { PlatformCache };
+//# sourceMappingURL=PlatformCache.js.map

package/lib/esm/services/PlatformCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformCache.js","sourceRoot":"","sources":["../../../src/services/PlatformCache.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAC,OAAO,EAAE,UAAU,EAAC,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAC,aAAa,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AACxE,OAAO,EAAC,WAAW,EAA2B,SAAS,EAAC,MAAM,mBAAmB,CAAC;AAIlF,OAAO,EAAC,MAAM,EAAC,MAAM,cAAc,CAAC;AAEpC,MAAM,kBAAkB,GAAG,CAAC,IAAW,EAAE,EAAE;IACzC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACjG,CAAC,CAAC;AAIF;;GAEG;AAEH,IAAa,aAAa,GAA1B,MAAa,aAAa;IAA1B;QAUE,uCAAiC;IAsInC,CAAC;IApIC,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,4BAAO,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAwB,OAAO,CAAC,CAAC;QAEnE,IAAI,QAAQ,EAAE;YACZ,uBAAA,IAAI,wBAAU,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,MAAA,CAAC;YAEtD,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,uBAAA,IAAI,4BAAO,CAAC,CAAC;SAChE;IACH,CAAC;IAED,QAAQ;QACN,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAwB,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,kBAAkB;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAqC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;IACxG,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAuB,WAAW,CAAC,CAAC;IAC9D,CAAC;IAED,YAAY,CAAC,MAAY,EAAE,UAAiC;QAC1D,MAAM,GAAG,GAAG,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;QAEtE,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE;YAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SAClC;IACH,CAAC;IAED,IAAI,CAAI,GAAW,EAAE,KAAuB,EAAE,OAAuB;;QACnE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,OAAO,KAAK,EAAE,CAAC;SAChB;QAED,OAAO,MAAA,IAAI,CAAC,KAAK,0CAAE,IAAI,CAAI,GAAG,EAAE,KAAK,EAAE,OAAc,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,UAAmC,EAAE;;QAC7D,OAAO,WAAW,CAAC,MAAA,IAAI,CAAC,KAAK,0CAAE,GAAG,CAAI,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,KAAU,EAAE,OAAuB;;QAC3D,OAAO,MAAA,IAAI,CAAC,KAAK,0CAAE,GAAG,CAAI,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,GAAW;QAC/B,IAAI;YACF,OAAO,MAAM,IAAI,CAAC,GAAG,CAAuB,GAAG,CAAC,CAAC;SAClD;QAAC,OAAO,EAAE,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,KAAK,EAAE,aAAa;gBACpB,MAAM,EAAE,iBAAiB;gBACzB,KAAK,EAAE,EAAE;aACV,CAAC,CAAC;SACJ;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,GAAW,EAAE,IAAS,EAAE,IAAyC;QACrF,IAAI;YACF,MAAM,IAAI,CAAC,GAAG,CACZ,GAAG,EACH;gBACE,GAAG,IAAI;gBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;aAC3B,EACD;gBACE,GAAG,EAAE,IAAI,CAAC,GAAG;aACd,CACF,CAAC;SACH;QAAC,OAAO,EAAE,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,KAAK,EAAE,aAAa;gBACpB,MAAM,EAAE,iBAAiB;gBACzB,KAAK,EAAE,EAAE;aACV,CAAC,CAAC;SACJ;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;;QACnB,MAAM,CAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,GAAG,CAAC,GAAG,CAAC,CAAA,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,KAAK;;QACT,aAAa;QACb,MAAM,CAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,KAAK,EAAE,CAAA,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAG,IAAW;QACvB,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE;YAChE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;SACvC;QAED,uBAAuB;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,QAAgB;QACpC,MAAM,CAAC,IAAI,EAAE,EAAC,OAAO,EAAE,UAAU,EAAC,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAE7F,OAAO,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,QAAgB;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAElD,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAE5D,OAAO,IAAI,CAAC;IACd,CAAC;IAES,KAAK,CAAC,kBAAkB,CAAC,QAA+B;QAChE,MAAM,EAAC,MAAM,EAAE,KAAK,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,KAAK,EAAC,GAAG,QAAQ,CAAC;QAC3D,6DAA6D;QAC7D,MAAM,EAAC,OAAO,EAAE,YAAY,EAAC,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC;QAE9D,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM;YACnB,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,EAAC,GAAG,KAAK,EAAC,CAAC;YAC/C,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC;gBACnB,GAAG,KAAK;gBACR,GAAG;gBACH,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK;aACjD,CAAC,CAAC;IACT,CAAC;CACF,CAAA;;AA9IC;IADC,aAAa,EAAE;;+CACkB;AAGlC;IADC,MAAM,EAAE;8BACW,eAAe;+CAAC;AAGpC;IADC,MAAM,EAAE;8BACS,MAAM;6CAAC;AARd,aAAa;IADzB,MAAM,EAAE;GACI,aAAa,CAgJzB;SAhJY,aAAa","sourcesContent":["import {isClass, isFunction} from \"@tsed/core\";\nimport {Configuration, Inject, InjectorService, Module} from \"@tsed/di\";\nimport {deserialize, JsonDeserializerOptions, serialize} from \"@tsed/json-mapper\";\nimport type {Cache, CachingConfig, MultiCache, TtlFunction} from \"cache-manager\";\nimport {PlatformCachedObject} from \"../interfaces/PlatformCachedObject\";\nimport {PlatformCacheSettings} from \"../interfaces/interfaces\";\nimport {Logger} from \"@tsed/logger\";\n\nconst defaultKeyResolver = (args: any[]) => {\n  return args.map((arg: any) => (isClass(arg) ? JSON.stringify(serialize(arg)) : arg)).join(\":\");\n};\n\nexport type CacheManager = Cache | MultiCache;\n\n/**\n * @platform\n */\n@Module()\nexport class PlatformCache {\n  @Configuration()\n  protected settings: Configuration;\n\n  @Inject()\n  protected injector: InjectorService;\n\n  @Inject()\n  protected logger: Logger;\n\n  #cache: CacheManager | undefined;\n\n  get cache() {\n    return this.#cache;\n  }\n\n  async $onInit() {\n    const settings = this.settings.get<PlatformCacheSettings>(\"cache\");\n\n    if (settings) {\n      this.#cache = await this.createCacheManager(settings);\n\n      await this.injector.emit(\"$onCreateCacheManager\", this.#cache);\n    }\n  }\n\n  disabled(): boolean {\n    return !this.settings.get<PlatformCacheSettings>(\"cache\");\n  }\n\n  defaultKeyResolver() {\n    return this.settings.get<(args: any[], ctx?: any) => string>(\"cache.keyResolver\", defaultKeyResolver);\n  }\n\n  defaultTtl() {\n    return this.settings.get<number | TtlFunction>(\"cache.ttl\");\n  }\n\n  calculateTTL(result?: any, currentTtl?: number | TtlFunction) {\n    const ttl = currentTtl === undefined ? this.defaultTtl() : currentTtl;\n\n    return isFunction(ttl) ? ttl(result) : ttl;\n  }\n\n  async ttl(key: string) {\n    if (this.cache && \"store\" in this.cache && this.cache.store.ttl) {\n      return this.cache.store.ttl(key);\n    }\n  }\n\n  wrap<T>(key: string, fetch: () => Promise<T>, options?: CachingConfig): Promise<T> {\n    if (!this.cache) {\n      return fetch();\n    }\n\n    return this.cache?.wrap<T>(key, fetch, options as any);\n  }\n\n  async get<T>(key: string, options: JsonDeserializerOptions = {}): Promise<T | undefined> {\n    return deserialize(this.cache?.get<T>(key), options);\n  }\n\n  async set<T>(key: string, value: any, options?: CachingConfig): Promise<T | undefined> {\n    return this.cache?.set<T>(key, value, options);\n  }\n\n  async getCachedObject(key: string) {\n    try {\n      return await this.get<PlatformCachedObject>(key);\n    } catch (er) {\n      this.logger.error({\n        event: \"CACHE_ERROR\",\n        method: \"getCachedObject\",\n        error: er\n      });\n    }\n  }\n\n  async setCachedObject(key: string, data: any, opts: {ttl: number} & Record<string, any>) {\n    try {\n      await this.set<PlatformCachedObject>(\n        key,\n        {\n          ...opts,\n          data: JSON.stringify(data)\n        },\n        {\n          ttl: opts.ttl\n        }\n      );\n    } catch (er) {\n      this.logger.error({\n        event: \"CACHE_ERROR\",\n        method: \"setCachedObject\",\n        error: er\n      });\n    }\n  }\n\n  async del(key: string): Promise<void> {\n    await this.cache?.del(key);\n  }\n\n  async reset(): Promise<void> {\n    // @ts-ignore\n    await this.cache?.reset();\n  }\n\n  async keys(...args: any[]): Promise<string[]> {\n    if (this.cache && \"store\" in this.cache && this.cache.store.keys) {\n      return this.cache.store.keys(...args);\n    }\n\n    // istanbul ignore next\n    return [];\n  }\n\n  async getMatchingKeys(patterns: string): Promise<string[]> {\n    const [keys, {default: micromatch}] = await Promise.all([this.keys(), import(\"micromatch\")]);\n\n    return micromatch(keys, patterns);\n  }\n\n  async deleteMatchingKeys(patterns: string): Promise<string[]> {\n    const keys = await this.getMatchingKeys(patterns);\n\n    await Promise.all(keys.map((key: string) => this.del(key)));\n\n    return keys;\n  }\n\n  protected async createCacheManager(settings: PlatformCacheSettings) {\n    const {caches, store = \"memory\", ttl, ...props} = settings;\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const {default: cacheManager} = await import(\"cache-manager\");\n\n    return caches?.length\n      ? cacheManager.multiCaching(caches, {...props})\n      : cacheManager.caching({\n          ...props,\n          ttl,\n          store: isFunction(store) ? await store() : store\n        });\n  }\n}\n"]}

package/lib/types/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from "./decorators/useCache";
+export * from "./interceptors/PlatformCacheInterceptor";
+export * from "./interfaces/PlatformCacheOptions";
+export * from "./interfaces/PlatformCachedObject";
+export * from "./interfaces/interfaces";
+export * from "./services/PlatformCache";

package/lib/{interceptors → types/interceptors}/PlatformCacheInterceptor.d.ts

@@ -8,8 +8,15 @@ import { PlatformCache } from "../services/PlatformCache";
 export declare class PlatformCacheInterceptor implements InterceptorMethods {
     protected cache: PlatformCache;
     intercept(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
+    canRefreshInBackground(key: string, { refreshThreshold, ttl }: {
+        refreshThreshold?: number;
+        ttl: any;
+    }, next: Function): Promise<void>;
+    cacheMethod(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
+    cacheResponse(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
     protected getArgs(context: InterceptorContext<unknown, PlatformCacheOptions>): any;
     protected getOptions(context: InterceptorContext<any, PlatformCacheOptions>): {
+        refreshThreshold: number | undefined;
         ttl: number | import("cache-manager").TtlFunction | undefined;
         type: any;
         args: any;
@@ -17,7 +24,8 @@ export declare class PlatformCacheInterceptor implements InterceptorMethods {
         keyArgs: string;
     };
     protected isEndpoint({ target, propertyKey }: InterceptorContext<any, PlatformCacheOptions>): boolean;
-    protected cacheMethod(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
-    protected cacheResponse(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
+    protected hasKeyInQueue(key: string): Promise<boolean>;
+    protected addKeyToQueue(key: string): Promise<void>;
+    protected deleteKeyFromQueue(key: string): Promise<void>;
     protected sendResponse(cachedObject: PlatformCachedObject, $ctx: BaseContext): any;
 }

package/lib/{interfaces → types/interfaces}/PlatformCacheOptions.d.ts

@@ -1,7 +1,8 @@
 import { MetadataTypes } from "@tsed/core";
 import { BaseContext } from "@tsed/di";
-import { TtlFunction } from "cache-manager";
+import type { TtlFunction } from "cache-manager";
 export interface PlatformCacheOptions extends MetadataTypes {
     ttl?: number | TtlFunction;
     key?: string | ((args: any[], ctx?: BaseContext) => string);
+    refreshThreshold?: number;
 }

package/lib/{interfaces/index.d.ts → types/interfaces/interfaces.d.ts}

@@ -1,11 +1,11 @@
 import type { BaseContext } from "@tsed/di";
-import { Cache, CacheOptions, CachingConfig, Store } from "cache-manager";
-export * from "./PlatformCachedObject";
+import type { Cache, CacheOptions, CachingConfig, Store } from "cache-manager";
+import type { CacheManager } from "../services/PlatformCache";
 export interface PlatformCacheSettings extends CacheOptions, CachingConfig {
     caches?: Cache[];
     store?: "memory" | "none" | Store | {
         create(...args: any[]): Store;
-    };
+    } | (() => any);
     max?: number;
     keyResolver?: (args: any[], ctx: BaseContext) => string;
     /**
@@ -21,3 +21,6 @@ declare global {
         }
     }
 }
+export interface OnCreateCacheManager {
+    $onCreateCacheManager(cache: CacheManager): void | Promise<void>;
+}

package/lib/types/services/PlatformCache.d.ts

@@ -0,0 +1,36 @@
+import { Configuration, InjectorService } from "@tsed/di";
+import { JsonDeserializerOptions } from "@tsed/json-mapper";
+import type { Cache, CachingConfig, MultiCache, TtlFunction } from "cache-manager";
+import { PlatformCachedObject } from "../interfaces/PlatformCachedObject";
+import { PlatformCacheSettings } from "../interfaces/interfaces";
+import { Logger } from "@tsed/logger";
+export declare type CacheManager = Cache | MultiCache;
+/**
+ * @platform
+ */
+export declare class PlatformCache {
+    #private;
+    protected settings: Configuration;
+    protected injector: InjectorService;
+    protected logger: Logger;
+    get cache(): CacheManager | undefined;
+    $onInit(): Promise<void>;
+    disabled(): boolean;
+    defaultKeyResolver(): (args: any[], ctx?: any) => string;
+    defaultTtl(): number | TtlFunction;
+    calculateTTL(result?: any, currentTtl?: number | TtlFunction): number;
+    ttl(key: string): Promise<any>;
+    wrap<T>(key: string, fetch: () => Promise<T>, options?: CachingConfig): Promise<T>;
+    get<T>(key: string, options?: JsonDeserializerOptions): Promise<T | undefined>;
+    set<T>(key: string, value: any, options?: CachingConfig): Promise<T | undefined>;
+    getCachedObject(key: string): Promise<PlatformCachedObject | undefined>;
+    setCachedObject(key: string, data: any, opts: {
+        ttl: number;
+    } & Record<string, any>): Promise<void>;
+    del(key: string): Promise<void>;
+    reset(): Promise<void>;
+    keys(...args: any[]): Promise<string[]>;
+    getMatchingKeys(patterns: string): Promise<string[]>;
+    deleteMatchingKeys(patterns: string): Promise<string[]>;
+    protected createCacheManager(settings: PlatformCacheSettings): Promise<MultiCache>;
+}

package/package.json

@@ -1,45 +1,63 @@
 {
   "name": "@tsed/platform-cache",
-  "version": "7.0.0-alpha.1",
+  "version": "7.0.0-beta.10",
   "description": "Platform cache module for Ts.ED Framework",
   "private": false,
   "source": "./src/index.ts",
-  "main": "./lib/index.js",
-  "typings": "./lib/index.d.ts",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "typings": "./lib/types/index.d.ts",
   "exports": {
-    "require": "./lib/index.js",
-    "default": "./lib/index.modern.js"
+    "types": "./lib/types/index.d.ts",
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
   },
   "scripts": {
-    "build": "microbundle --target node --no-compress --format modern,cjs --tsconfig ./tsconfig.compile.json"
+    "build": "yarn barrels && yarn run build:esm && yarn run build:cjs",
+    "build:cjs": "tsc --build tsconfig.compile.json",
+    "build:esm": "tsc --build tsconfig.compile.esm.json",
+    "test": "cross-env NODE_ENV=test yarn jest --max-workers=2",
+    "barrels": "yarn barrelsby --delete -d ./src -e \"\\.spec\\.ts\" -e \"__mock__\" -e \".benchmark.ts\""
   },
   "dependencies": {
-    "@types/cache-manager": "^3.4.2",
-    "cache-manager": "^3.4.1",
-    "micromatch": "^4.0.2",
-    "tslib": "2.2.0"
+    "@types/cache-manager": "^3.4.3",
+    "cache-manager": "^3.6.0",
+    "micromatch": "4.0.5",
+    "tslib": "2.3.1"
   },
   "devDependencies": {
-    "@tsed/core": "7.0.0-alpha.1",
-    "@tsed/di": "7.0.0-alpha.1",
-    "@tsed/exceptions": "7.0.0-alpha.1",
-    "@tsed/json-mapper": "7.0.0-alpha.1",
-    "@tsed/schema": "7.0.0-alpha.1",
-    "@types/cache-manager": "^3.4.2",
+    "@tsed/core": "7.0.0-beta.10",
+    "@tsed/di": "7.0.0-beta.10",
+    "@tsed/json-mapper": "7.0.0-beta.10",
+    "@tsed/schema": "7.0.0-beta.10",
     "@types/micromatch": "^4.0.1"
   },
   "peerDependencies": {
-    "@tsed/core": "^7.0.0-alpha.1",
-    "@tsed/di": "^7.0.0-alpha.1",
-    "@tsed/exceptions": "^7.0.0-alpha.1",
-    "@tsed/json-mapper": "^7.0.0-alpha.1",
-    "@tsed/schema": "^7.0.0-alpha.1"
+    "@tsed/core": "^7.0.0-beta.10",
+    "@tsed/di": "^7.0.0-beta.10",
+    "@tsed/json-mapper": "^7.0.0-beta.10",
+    "@tsed/schema": "^7.0.0-beta.10"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/core": {
+      "optional": false
+    },
+    "@tsed/di": {
+      "optional": false
+    },
+    "@tsed/json-mapper": {
+      "optional": false
+    },
+    "@tsed/schema": {
+      "optional": false
+    }
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {
     "url": "https://github.com/tsedio/tsed/issues"
   },
-  "homepage": "https://github.com/tsedio/tsed/tree/alpha/packages/platform/platform-cache",
+  "homepage": "https://github.com/tsedio/tsed/tree/beta/packages/platform/platform-cache",
   "author": "Romain Lenzotti",
   "license": "MIT"
 }

package/readme.md

@@ -27,7 +27,7 @@
 
 <hr />
 
-A package of Ts.ED framework. See website: https://tsed.io/
+A package of Ts.ED framework. See website: https://tsed.io/docs/cache.html
 
 # Installation
 
@@ -36,18 +36,17 @@ npm install --save @tsed/platform-cache
 ```
 
 ## Contributors
+
 Please read [contributing guidelines here](https://tsed.io/CONTRIBUTING.html).
 
 <a href="https://github.com/tsedio/ts-express-decorators/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
 
-
 ## Backers
 
 Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
 
 <a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
 
-
 ## Sponsors
 
 Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]

package/tsconfig.compile.esm.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.compile.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ES2020",
+    "rootDir": "src",
+    "outDir": "./lib/esm",
+    "declaration": true,
+    "declarationDir": "./lib/types"
+  },
+  "exclude": ["node_modules", "test", "lib", "benchmark", "coverage", "spec", "**/*.benchmark.ts", "**/*.spec.ts", "keys", "jest.config.js"]
+}

package/lib/PlatformCacheModule.d.ts

@@ -1,5 +0,0 @@
-/**
- * @ignore
- */
-export declare class PlatformCacheModule {
-}

package/lib/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./interfaces";
-export * from "./services/PlatformCache";
-export * from "./decorators/useCache";
-export * from "./PlatformCacheModule";