@tsed/directus-sdk 8.19.0 → 8.19.1

package/.barrelsby.json

@@ -1,5 +1,5 @@
 {
   "directory": ["./src"],
-  "exclude": ["**/bin", "**/__mock__", "**/__mocks__", "**/*.spec.ts"],
+  "exclude": ["**/bin", "**/__mock__", "**/__mocks__", "**/*.spec.ts", "**/cache"],
   "delete": true
 }

package/lib/esm/{services → cache}/DirectusCacheInterceptor.js

@@ -1,8 +1,7 @@
-import { getCache, getCacheValue, setCacheValue } from "@directus/api/cache";
 import { classOf } from "@tsed/core/utils/classOf.js";
 import { nameOf } from "@tsed/core/utils/nameOf.js";
 import { bindIntercept, injectable } from "@tsed/di";
-import { snakeCase } from "lodash";
+import { snakeCase } from "change-case";
 /**
  * Default cache key generator that serializes method arguments into a cache key.
  *
@@ -93,6 +92,7 @@ export class DirectusCacheInterceptor {
      * - The system cache is used by default, which persists across requests
      */
     async intercept(context) {
+        const { getCache, getCacheValue, setCacheValue } = await import("@directus/api/cache");
         const { ttl = 900000, // 15 minutes default
         keyGenerator = defaultKeyGenerator, namespace = snakeCase(nameOf(context.target)) + ":" + String(context.propertyKey), useSystemCache = true } = context.options || {};
         // Get appropriate cache instance

package/lib/esm/{decorators → cache/decorators}/cache.js

@@ -1,5 +1,5 @@
 import { Intercept } from "@tsed/di";
-import { DirectusCacheInterceptor } from "../services/DirectusCacheInterceptor.js";
+import { DirectusCacheInterceptor } from "../DirectusCacheInterceptor.js";
 /**
  * Decorator to cache method results using Directus cache system.
  *

package/lib/esm/cache/index.js

@@ -0,0 +1,2 @@
+export * from "./decorators/cache.js";
+export * from "./DirectusCacheInterceptor.js";

package/lib/esm/index.js

@@ -3,12 +3,10 @@
  */
 export * from "./bootstrap/attach-logger.js";
 export * from "./bootstrap/runtime.js";
-export * from "./decorators/cache.js";
 export * from "./fn/defineEndpoint.js";
 export * from "./fn/defineHook.js";
 export * from "./fn/defineOperationApi.js";
 export * from "./fn/wrapEndpoint.js";
 export * from "./fn/wrapOperation.js";
-export * from "./services/DirectusCacheInterceptor.js";
 export * from "./services/DirectusContextService.js";
 export * from "./services/DirectusItemsRepository.js";

package/lib/types/{decorators → cache/decorators}/cache.d.ts

@@ -1,4 +1,4 @@
-import { type DirectusCacheOptions } from "../services/DirectusCacheInterceptor.js";
+import { type DirectusCacheOptions } from "../DirectusCacheInterceptor.js";
 /**
  * Decorator to cache method results using Directus cache system.
  *

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

@@ -0,0 +1,2 @@
+export * from "./decorators/cache.js";
+export * from "./DirectusCacheInterceptor.js";

package/lib/types/index.d.ts

@@ -3,12 +3,10 @@
  */
 export * from "./bootstrap/attach-logger.js";
 export * from "./bootstrap/runtime.js";
-export * from "./decorators/cache.js";
 export * from "./fn/defineEndpoint.js";
 export * from "./fn/defineHook.js";
 export * from "./fn/defineOperationApi.js";
 export * from "./fn/wrapEndpoint.js";
 export * from "./fn/wrapOperation.js";
-export * from "./services/DirectusCacheInterceptor.js";
 export * from "./services/DirectusContextService.js";
 export * from "./services/DirectusItemsRepository.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.0",
+  "version": "8.19.1",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -14,6 +14,12 @@
       "import": "./lib/esm/index.js",
       "default": "./lib/esm/index.js"
     },
+    "./cache": {
+      "tsed-source": "./src/cache/index.ts",
+      "types": "./lib/types/cache/index.d.ts",
+      "import": "./lib/esm/cache/index.js",
+      "default": "./lib/esm/cache/index.js"
+    },
     "./attach-logger": {
       "tsed-source": "./src/bootstrap/attach-logger.ts",
       "types": "./lib/types/bootstrap/attach-logger.d.ts",
@@ -37,8 +43,9 @@
     "@directus/extensions-sdk": "13.1.1",
     "@directus/sdk": "20.2.0",
     "@directus/types": "13.4.0",
-    "@tsed/barrels": "8.19.0",
+    "@tsed/barrels": "8.19.1",
     "@tsed/logger-connect": "8.0.4",
+    "typescript": "5.9.3",
     "vitest": "3.2.4"
   },
   "peerDependencies": {

package/readme.md

@@ -163,59 +163,39 @@ import {inject} from "@tsed/di";
 const myService = inject(MyService);
 ```
 
-### Cache Decorator
+### Directus Context Service
 
-Cache method results using Directus cache infrastructure:
+Access Directus context from anywhere in your code:
 
 ```ts
-import {Injectable} from "@tsed/di";
-import {Cache} from "@tsed/directus-sdk";
+import {injectable} from "@tsed/di";
+import {DirectusContextService} from "@tsed/directus-sdk";
 
-@Injectable()
-export class ApiClient {
-  @Cache({ttl: 900000})
-  async search(query: string) {
-    // Expensive operation
-    return this.performSearch(query);
+export class MyService {
+  directusContext = inject(DirectusContextService);
+
+  async doSomething() {
+    const context = this.directusContext.get();
+    const schema = await context.getSchema();
+    // Use schema...
   }
 
-  @Cache({
-    ttl: 60000,
-    keyGenerator: (userId: string) => `user:${userId}`
-  })
-  async getUserById(userId: string) {
-    return this.fetchUser(userId);
+  async getUsersService() {
+    // Convenience method to get ItemsService
+    return this.directusContext.getItemsService("users");
   }
 }
-```
-
-**Options:**
 
-- `ttl` - Time to live in milliseconds (default: 900000ms = 15 minutes)
-- `keyGenerator` - Custom function to generate cache keys
-- `namespace` - Custom namespace for cache keys
-- `useSystemCache` - Use system cache (true) or regular cache (false). Default: true
-
-> Important: to use decorator you have to configure your tsconfig with the appropriate options (
-> `"experimentalDecorators": true`, `"emitDecoratorMetadata": true`)
-
-### Programmatic Cache Binding
-
-Apply cache programmatically using `useDirectusCache`:
+injectable(MyService);
+```
 
-```ts
-import {injectable} from "@tsed/di";
-import {useDirectusCache} from "@tsed/directus-sdk";
+**Methods:**
 
-export class JiraIssueClient {
-  search(query: string) {
-    return this.performSearch(query);
-  }
-}
+- `set(context)` - Set the Directus context (internal use)
+- `get()` - Get the current Directus context
+- `getItemsService(collection, options?)` - Create an ItemsService for a collection
 
-injectable(JiraIssueClient);
-useDirectusCache(JiraIssueClient, "search", {ttl: 900000});
-```
+---
 
 ### Repository Pattern
 
@@ -292,39 +272,87 @@ export default defineEndpoint({
 });
 ```
 
-### Directus Context Service
+### Cache
 
-Access Directus context from anywhere in your code:
+Because `@directus/api/cache` isn't declared as external dependency to build the extension you have to configure the
+rollup bundler to
+exclude it from the build.
 
-```ts
-import {injectable} from "@tsed/di";
-import {DirectusContextService} from "@tsed/directus-sdk";
+So for each extension you have to add the following to the `extension.config.js`, if your extension build fail:
 
-export class MyService {
-  directusContext = inject(DirectusContextService);
+```js
+function externals() {
+  return {
+    name: "external-plus", // this name will show up in logs and errors
+    version: "1.0.0",
+    options(rawOptions) {
+      if (rawOptions.external?.includes("directus:api")) {
+        rawOptions.external.push("@directus/api/cache");
+      }
 
-  async doSomething() {
-    const context = this.directusContext.get();
-    const schema = await context.getSchema();
-    // Use schema...
+      return rawOptions;
+    }
+  };
+}
+
+export default {
+  plugins: [externals()]
+};
+```
+
+#### Cache Decorator
+
+Cache method results using Directus cache infrastructure:
+
+```ts
+import {Injectable} from "@tsed/di";
+import {Cache} from "@tsed/directus-sdk/cache";
+
+@Injectable()
+export class ApiClient {
+  @Cache({ttl: 900000})
+  async search(query: string) {
+    // Expensive operation
+    return this.performSearch(query);
   }
 
-  async getUsersService() {
-    // Convenience method to get ItemsService
-    return this.directusContext.getItemsService("users");
+  @Cache({
+    ttl: 60000,
+    keyGenerator: (userId: string) => `user:${userId}`
+  })
+  async getUserById(userId: string) {
+    return this.fetchUser(userId);
   }
 }
-
-injectable(MyService);
 ```
 
-**Methods:**
+**Options:**
 
-- `set(context)` - Set the Directus context (internal use)
-- `get()` - Get the current Directus context
-- `getItemsService(collection, options?)` - Create an ItemsService for a collection
+- `ttl` - Time to live in milliseconds (default: 900000ms = 15 minutes)
+- `keyGenerator` - Custom function to generate cache keys
+- `namespace` - Custom namespace for cache keys
+- `useSystemCache` - Use system cache (true) or regular cache (false). Default: true
 
----
+> Important: to use decorator you have to configure your tsconfig with the appropriate options (
+> `"experimentalDecorators": true`, `"emitDecoratorMetadata": true`)
+
+#### Programmatic Cache Binding
+
+Apply cache programmatically using `useDirectusCache`:
+
+```ts
+import {injectable} from "@tsed/di";
+import {useDirectusCache} from "@tsed/directus-sdk/cache";
+
+export class JiraIssueClient {
+  search(query: string) {
+    return this.performSearch(query);
+  }
+}
+
+injectable(JiraIssueClient);
+useDirectusCache(JiraIssueClient, "search", {ttl: 900000});
+```
 
 ## 🔧 Advanced Usage