@tsed/directus-sdk 8.19.4 → 8.20.0

package/lib/esm/extends/cache.js

@@ -0,0 +1,6 @@
+import { ProviderBuilder } from "@tsed/di";
+import { DirectusCacheInterceptor } from "../cache/index.js";
+ProviderBuilder.add("directusCache", function directusCache(propertyKey, options = {}) {
+    this.intercept(propertyKey, DirectusCacheInterceptor, options);
+    return this;
+});

package/lib/esm/index.js

@@ -3,6 +3,7 @@
  */
 export * from "./bootstrap/attach-logger.js";
 export * from "./bootstrap/runtime.js";
+export * from "./extends/cache.js";
 export * from "./fn/defineEndpoint.js";
 export * from "./fn/defineHook.js";
 export * from "./fn/defineOperationApi.js";

package/lib/types/extends/cache.d.ts

@@ -0,0 +1,73 @@
+import { type Type } from "@tsed/core";
+import { type DirectusCacheOptions } from "../cache/index.js";
+declare global {
+    namespace TsED {
+        interface ClassProviderBuilder<Token extends Type> {
+            /**
+             * Programmatically applies cache interception to a method using Directus cache infrastructure.
+             *
+             * This function allows you to add caching to a method after the class is defined,
+             * which is useful when you can't use decorators or need dynamic cache configuration.
+             *
+             * @example Basic usage
+             *
+             * ```ts
+             * import {injectable} from "@tsed/di";
+             * import {useDirectusCache} from "@tsed/directus-sdk";
+             *
+             * export class JiraIssueClient {
+             *   search(query: string) {
+             *     // Expensive search operation
+             *     return this.performSearch(query);
+             *   }
+             * }
+             *
+             * injectable(JiraIssueClient)
+             *   .directusCache("search", { ttl: 900000 });
+             * ```
+             *
+             * ### With custom options
+             *
+             * ```ts
+             * injectable(MyService)
+             *   .directusCache("fetchData", {
+             *     ttl: 60000,
+             *     keyGenerator: (id: string) => `data:${id}`,
+             *     namespace: "my_service:data",
+             *     useSystemCache: false
+             *   });
+             * ```
+             *
+             * ### Applying cache to multiple methods
+             *
+             * ```ts
+             * import {injectable} from "@tsed/di";
+             * import {useDirectusCache} from "@tsed/directus-sdk";
+             *
+             * export class ApiClient {
+             *   getUser(id: string) { }
+             *   getPosts() { }
+             * }
+             * injectable(ApiClient)
+             *   .directusCache("getUser", { ttl: 300000 })
+             *   .directusCache("getPosts", { ttl: 60000 });
+             * ```
+             *
+             * @template K - The class type
+             * @template Props - The property key type (method name)
+             *
+             * @param propertyKey - The name of the method to cache
+             * @param options - Cache configuration options
+             *
+             * @remarks
+             * - Must be called after the class is marked as `@Injectable()` or `injectable()`
+             * - The class must be registered in the DI container
+             * - Prefer using the `@Cache` decorator when possible for better readability
+             *
+             * @see {@link Cache} decorator for the declarative approach
+             * @see {@link DirectusCacheInterceptor} for implementation details
+             */
+            directusCache(propertyKey: keyof InstanceType<Token>, options?: DirectusCacheOptions): this;
+        }
+    }
+}

package/lib/types/index.d.ts

@@ -3,6 +3,7 @@
  */
 export * from "./bootstrap/attach-logger.js";
 export * from "./bootstrap/runtime.js";
+export * from "./extends/cache.js";
 export * from "./fn/defineEndpoint.js";
 export * from "./fn/defineHook.js";
 export * from "./fn/defineOperationApi.js";

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/directus-sdk",
   "description": "A library to integrate Directus SDK with Ts.ED, facilitating the creation of extensions (endpoints, hooks, operations) and the use of Directus services.",
   "type": "module",
-  "version": "8.19.4",
+  "version": "8.20.0",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -43,8 +43,9 @@
     "@directus/extensions-sdk": "13.1.1",
     "@directus/sdk": "20.2.0",
     "@directus/types": "13.4.0",
-    "@tsed/barrels": "8.19.4",
+    "@tsed/barrels": "8.20.0",
     "@tsed/logger-connect": "8.0.4",
+    "@types/express": "4.17.21",
     "typescript": "5.9.3",
     "vitest": "3.2.4"
   },

package/readme.md

@@ -350,8 +350,7 @@ export class JiraIssueClient {
   }
 }
 
-injectable(JiraIssueClient);
-useDirectusCache(JiraIssueClient, "search", {ttl: 900000});
+injectable(JiraIssueClient).directusCache("search", {ttl: 900000});
 ```
 
 ## 🔧 Advanced Usage