fix(directus-sdk): restructure cache directories and update imports

- Moved `DirectusCacheInterceptor` and related files to a new `cache` directory.
- Updated all relevant imports to reflect new file paths.
- Modified `.barrelsby.json` to exclude `cache` folder from barrel generation.
- Adjusted `tsconfig` and package.json exports to support new cache path.
- Added support for dynamically importing `@directus/api/cache` in `DirectusCacheInterceptor`.

Author: Romakita

packages/third-parties/directus-sdk/.barrelsby.json

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

packages/third-parties/directus-sdk/package.json

@@ -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",
@@ -39,6 +45,7 @@
     "@directus/types": "13.4.0",
     "@tsed/barrels": "workspace:*",
     "@tsed/logger-connect": "8.0.4",
+    "typescript": "5.9.3",
     "vitest": "3.2.4"
   },
   "peerDependencies": {

packages/third-parties/directus-sdk/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
 

packages/third-parties/directus-sdk/src/services/DirectusCacheInterceptor.spec.ts renamed to packages/third-parties/directus-sdk/src/cache/DirectusCacheInterceptor.spec.ts

@@ -1,4 +1,3 @@
-import {getCache, getCacheValue, setCacheValue} from "@directus/api/cache";
 import type {Type} from "@tsed/core";
 import {classOf} from "@tsed/core/utils/classOf.js";
 import {nameOf} from "@tsed/core/utils/nameOf.js";
@@ -111,6 +110,7 @@ export class DirectusCacheInterceptor implements InterceptorMethods {
    * - The system cache is used by default, which persists across requests
    */
   async intercept(context: InterceptorContext<unknown, DirectusCacheOptions>) {
+    const {getCache, getCacheValue, setCacheValue} = await import("@directus/api/cache");
     const {
       ttl = 900000, // 15 minutes default
       keyGenerator = defaultKeyGenerator,

packages/third-parties/directus-sdk/src/services/DirectusCacheInterceptor.ts renamed to packages/third-parties/directus-sdk/src/cache/DirectusCacheInterceptor.ts

@@ -1,8 +1,7 @@
-import {Intercept} from "@tsed/di";
-import {DITest} from "@tsed/di";
+import {DITest, Intercept} from "@tsed/di";
 import {afterEach, beforeEach, describe, expect, it, vi} from "vitest";
 
-import {DirectusCacheInterceptor} from "../services/DirectusCacheInterceptor.js";
+import {DirectusCacheInterceptor} from "../DirectusCacheInterceptor.js";
 import {Cache} from "./cache.js";
 
 vi.mock("@tsed/di", async () => {

packages/third-parties/directus-sdk/src/decorators/cache.spec.ts renamed to packages/third-parties/directus-sdk/src/cache/decorators/cache.spec.ts

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

packages/third-parties/directus-sdk/src/decorators/cache.ts renamed to packages/third-parties/directus-sdk/src/cache/decorators/cache.ts

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

packages/third-parties/directus-sdk/src/cache/index.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";

packages/third-parties/directus-sdk/src/index.ts

@@ -12340,6 +12340,7 @@ __metadata:
     "@tsed/logger-connect": "npm:8.0.4"
     semver: "npm:^7.6.3"
     tslib: "npm:2.8.1"
+    typescript: "npm:5.9.3"
     vitest: "npm:3.2.4"
   peerDependencies:
     "@directus/api": ">=31.0.0"