@tsed/platform-cache 7.35.0-beta.5 → 7.35.0

package/lib/types/index.d.ts

@@ -7,3 +7,6 @@ export * from "./interfaces/PlatformCacheOptions";
 export * from "./interfaces/PlatformCachedObject";
 export * from "./interfaces/interfaces";
 export * from "./services/PlatformCache";
+export * from "./utils/getInterceptorOptions";
+export * from "./utils/getPrefix";
+export * from "./utils/isEndpoint";

package/lib/types/interceptors/PlatformCacheInterceptor.d.ts

@@ -18,6 +18,7 @@ export declare class PlatformCacheInterceptor implements InterceptorMethods {
     cacheResponse(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
     protected getArgs(context: InterceptorContext<unknown, PlatformCacheOptions>): any;
     protected getOptions(context: InterceptorContext<any, PlatformCacheOptions>): {
+        key: string;
         refreshThreshold: number | undefined;
         ttl: import("../services/PlatformCache").Ttl | undefined;
         type: any;
@@ -25,8 +26,8 @@ export declare class PlatformCacheInterceptor implements InterceptorMethods {
         collectionType: any;
         keyArgs: string;
         canCache: ((item: any) => boolean) | undefined;
+        $ctx: any;
     };
-    protected isEndpoint({ target, propertyKey }: InterceptorContext<any, PlatformCacheOptions>): boolean;
     protected hasKeyInQueue(key: string): Promise<boolean>;
     protected addKeyToQueue(key: string): Promise<void>;
     protected deleteKeyFromQueue(key: string): Promise<void>;

package/lib/types/interfaces/PlatformCacheOptions.d.ts

@@ -2,8 +2,24 @@ import { MetadataTypes } from "@tsed/core";
 import { BaseContext } from "@tsed/di";
 import type { Ttl } from "../services/PlatformCache";
 export interface PlatformCacheOptions extends MetadataTypes {
+    /**
+     * key expiration ttl in seconds.
+     */
     ttl?: Ttl;
+    /**
+     * By default, the key is generated from the method name and the arguments passed to the method.
+     */
+    prefix?: string;
+    /**
+     * Algorithm used to generate the key. By default, the key is generated from the method name and the arguments passed to the method.
+     */
     key?: string | ((args: any[], ctx?: BaseContext) => string);
+    /**
+     * threshold to refresh the cache.
+     */
     refreshThreshold?: number;
+    /**
+     * The function determine if the result must be cached or not.
+     */
     canCache?: ((item: any) => boolean) | "no-nullish";
 }

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

@@ -1,3 +1,4 @@
+import { Type } from "@tsed/core";
 import { Configuration, InjectorService } from "@tsed/di";
 import { JsonDeserializerOptions } from "@tsed/json-mapper";
 import { Logger } from "@tsed/logger";
@@ -16,6 +17,7 @@ export declare class PlatformCache {
     protected logger: Logger;
     get cache(): CacheManager | undefined;
     $onInit(): Promise<void>;
+    getKeysOf(target: Type<any>, propertyKey: string | symbol): Promise<string[]>;
     disabled(): boolean;
     defaultKeyResolver(): (args: any[], ctx?: any) => string;
     defaultTtl(): Ttl;
@@ -31,10 +33,15 @@ export declare class PlatformCache {
     del(key: string): Promise<void>;
     reset(): Promise<void>;
     keys(...args: any[]): Promise<string[]>;
+    deleteKeys(patterns: string): Promise<string[]>;
+    /**
+     * Use micromatch instead native patterns. Use this method if the native store method doesn't support glob patterns
+     * @param patterns
+     */
     getMatchingKeys(patterns: string): Promise<string[]>;
     deleteMatchingKeys(patterns: string): Promise<string[]>;
-    protected createCacheManager(settings: PlatformCacheSettings): Promise<MultiCache | import("cache-manager").MemoryCache>;
-    private mapStore;
     refresh(callback: () => Promise<any> | any): any;
     isForceRefresh(): boolean;
+    protected createCacheManager(settings: PlatformCacheSettings): Promise<MultiCache | import("cache-manager").MemoryCache>;
+    private mapStore;
 }

package/lib/types/utils/getInterceptorOptions.d.ts

@@ -0,0 +1,3 @@
+import { Type } from "@tsed/core";
+import { PlatformCacheOptions } from "../interfaces/PlatformCacheOptions";
+export declare function getInterceptorOptions(target: Type<any>, propertyKey: string | symbol): PlatformCacheOptions;

package/lib/types/utils/getPrefix.d.ts

@@ -0,0 +1,2 @@
+import { Type } from "@tsed/core";
+export declare function getPrefix(target: Type<any>, propertyKey: string | symbol): (string | symbol)[];

package/lib/types/utils/isEndpoint.d.ts

@@ -0,0 +1,2 @@
+import { Type } from "@tsed/core";
+export declare function isEndpoint(target: Type<any>, propertyKey: string | symbol): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/platform-cache",
-  "version": "7.35.0-beta.5",
+  "version": "7.35.0",
   "description": "Platform cache module for Ts.ED Framework",
   "private": false,
   "source": "./src/index.ts",
@@ -27,20 +27,20 @@
     "tslib": "2.5.0"
   },
   "devDependencies": {
-    "@tsed/core": "7.35.0-beta.5",
-    "@tsed/di": "7.35.0-beta.5",
-    "@tsed/eslint": "7.35.0-beta.5",
-    "@tsed/json-mapper": "7.35.0-beta.5",
-    "@tsed/schema": "7.35.0-beta.5",
-    "@tsed/typescript": "7.35.0-beta.5",
+    "@tsed/core": "7.35.0",
+    "@tsed/di": "7.35.0",
+    "@tsed/eslint": "7.35.0",
+    "@tsed/json-mapper": "7.35.0",
+    "@tsed/schema": "7.35.0",
+    "@tsed/typescript": "7.35.0",
     "@types/micromatch": "^4.0.1",
     "eslint": "^8.12.0"
   },
   "peerDependencies": {
-    "@tsed/core": "^7.35.0-beta.5",
-    "@tsed/di": "^7.35.0-beta.5",
-    "@tsed/json-mapper": "^7.35.0-beta.5",
-    "@tsed/schema": "^7.35.0-beta.5"
+    "@tsed/core": "^7.35.0",
+    "@tsed/di": "^7.35.0",
+    "@tsed/json-mapper": "^7.35.0",
+    "@tsed/schema": "^7.35.0"
   },
   "peerDependenciesMeta": {
     "@tsed/core": {
@@ -62,8 +62,5 @@
   },
   "homepage": "https://github.com/tsedio/tsed/tree/production/packages/platform/platform-cache",
   "author": "Romain Lenzotti",
-  "license": "MIT",
-  "publishConfig": {
-    "tag": "beta"
-  }
+  "license": "MIT"
 }