export kvIncrementalCache, d1TagCache and memoryQueue from api entrypoint

dario-piotrowicz · dario-piotrowicz · commit f0f3739e7f31 · 2025-02-26T14:08:57.000Z
diff --git a/.changeset/cold-numbers-bow.md b/.changeset/cold-numbers-bow.md
@@ -7,14 +7,15 @@ add `defineCloudflareConfig` utility
 this change adds a new `defineCloudflareConfig` utility that developers can use in their `open-next.config.ts`
 file to easily generate a configuration compatible with the adapter
 
+as part of this change also export `kvIncrementalCache`, `d1TagCache` and `memoryQueue` from the main package entrypoint
+
 Example usage:
 
 ```ts
 // open-next.config.ts
-import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+import { defineCloudflareConfig, kvIncrementalCache } from "@opennextjs/cloudflare";
 
 export default defineCloudflareConfig({
-  incrementalCache: cache,
+  incrementalCache: kvIncrementalCache,
 });
 ```
diff --git a/examples/e2e/app-pages-router/open-next.config.ts b/examples/e2e/app-pages-router/open-next.config.ts
@@ -1,8 +1,6 @@
-import kvCache from "@opennextjs/cloudflare/kv-cache";
-import memoryQueue from "@opennextjs/cloudflare/memory-queue";
-import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+import { defineCloudflareConfig, kvIncrementalCache, memoryQueue } from "@opennextjs/cloudflare";
 
 export default defineCloudflareConfig({
-  incrementalCache: kvCache,
+  incrementalCache: kvIncrementalCache,
   queue: memoryQueue,
 });
diff --git a/examples/e2e/app-router/open-next.config.ts b/examples/e2e/app-router/open-next.config.ts
@@ -1,10 +1,7 @@
-import { defineCloudflareConfig } from "@opennextjs/cloudflare";
-import tagCache from "@opennextjs/cloudflare/d1-tag-cache";
-import incrementalCache from "@opennextjs/cloudflare/kv-cache";
-import memoryQueue from "@opennextjs/cloudflare/memory-queue";
+import { defineCloudflareConfig, kvIncrementalCache, d1TagCache, memoryQueue } from "@opennextjs/cloudflare";
 
 export default defineCloudflareConfig({
-  incrementalCache,
-  tagCache,
+  incrementalCache: kvIncrementalCache,
+  tagCache: d1TagCache,
   queue: memoryQueue,
 });
diff --git a/examples/e2e/pages-router/open-next.config.ts b/examples/e2e/pages-router/open-next.config.ts
@@ -1,8 +1,6 @@
-import memoryQueue from "@opennextjs/cloudflare/memory-queue";
-import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+import { defineCloudflareConfig, kvIncrementalCache, memoryQueue } from "@opennextjs/cloudflare";
 
 export default defineCloudflareConfig({
-  incrementalCache: cache,
+  incrementalCache: kvIncrementalCache,
   queue: memoryQueue,
 });
diff --git a/examples/playground14/open-next.config.ts b/examples/playground14/open-next.config.ts
@@ -1,6 +1,5 @@
-import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+import { defineCloudflareConfig, kvIncrementalCache } from "@opennextjs/cloudflare";
 
 export default defineCloudflareConfig({
-  incrementalCache: cache,
+  incrementalCache: kvIncrementalCache,
 });
diff --git a/examples/playground15/open-next.config.ts b/examples/playground15/open-next.config.ts
@@ -1,6 +1,5 @@
-import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+import { defineCloudflareConfig, kvIncrementalCache } from "@opennextjs/cloudflare";
 
 export default defineCloudflareConfig({
-  incrementalCache: cache,
+  incrementalCache: kvIncrementalCache,
 });
diff --git a/examples/ssg-app/open-next.config.ts b/examples/ssg-app/open-next.config.ts
@@ -1,6 +1,5 @@
-import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+import { defineCloudflareConfig, kvIncrementalCache } from "@opennextjs/cloudflare";
 
 export default defineCloudflareConfig({
-  incrementalCache: cache,
+  incrementalCache: kvIncrementalCache,
 });
diff --git a/examples/vercel-blog-starter/open-next.config.ts b/examples/vercel-blog-starter/open-next.config.ts
@@ -1,6 +1,5 @@
-import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+import { defineCloudflareConfig, kvIncrementalCache } from "@opennextjs/cloudflare";
 
 export default defineCloudflareConfig({
-  incrementalCache: cache,
+  incrementalCache: kvIncrementalCache,
 });
diff --git a/packages/cloudflare/src/api/config.ts b/packages/cloudflare/src/api/config.ts
@@ -5,12 +5,10 @@ export type CloudflareConfigOptions = {
   /**
    * The incremental cache implementation to use (for more details see the [Incremental Cache documentation](https://opennext.js.org/aws/config/overrides/incremental_cache))
    *
-   * `@opennextjs/cloudflare` offers a kv incremental cache implementation ready
-   * to use which can be imported from `"@opennextjs/cloudflare/kv-cache"`
+   * `@opennextjs/cloudflare` offers a kv incremental cache implementation exported as `kvIncrementalCache`
    *
    * @example
-   *   import { defineCloudflareConfig } from "@opennextjs/cloudflare";
-   *   import cache from "@opennextjs/cloudflare/kv-cache";
+   *   import { defineCloudflareConfig, kvIncrementalCache } from "@opennextjs/cloudflare";
    *
    *   export default defineCloudflareConfig({
    *     incrementalCache: cache,
@@ -21,28 +19,24 @@ export type CloudflareConfigOptions = {
   /**
    * The tag cache implementation to use (for more details see the [Tag Cache documentation](https://opennext.js.org/aws/config/overrides/tag_cache))
    *
-   * `@opennextjs/cloudflare` offers a d1 tag cache implementation ready
-   * to use which can be imported from `"@opennextjs/cloudflare/d1-tag-cache"`
+   * `@opennextjs/cloudflare` offers a d1 tag cache implementation exported as `d1TagCache`
    *
    * @example
-   *   import { defineCloudflareConfig } from "@opennextjs/cloudflare";
-   *   import cache from "@opennextjs/cloudflare/d1-tag-cache";
+   *   import { defineCloudflareConfig, d1TagCache } from "@opennextjs/cloudflare";
    *
    *   export default defineCloudflareConfig({
-   *     tagCache: cache,
+   *     tagCache: d1TagCache,
    *   });
    */
   tagCache?: TagCache | (() => TagCache | Promise<TagCache>);
 
   /**
    * The revalidation queue implementation to use (for more details see the [Queue documentation](https://opennext.js.org/aws/config/overrides/queue))
    *
-   * `@opennextjs/cloudflare` offers an in memory queue implementation ready
-   * to use which can be imported from `"@opennextjs/cloudflare/memory-queue"`
+   * `@opennextjs/cloudflare` offers an in memory queue implementation exported as `memoryQueue`
    *
    * @example
-   *   import { defineCloudflareConfig } from "@opennextjs/cloudflare";
-   *   import memoryQueue from "@opennextjs/cloudflare/memory-queue";
+   *   import { defineCloudflareConfig, memoryQueue } from "@opennextjs/cloudflare";
    *
    *   export default defineCloudflareConfig({
    *     queue: memoryQueue,
diff --git a/packages/cloudflare/src/api/index.ts b/packages/cloudflare/src/api/index.ts
@@ -1,2 +1,5 @@
 export * from "./cloudflare-context.js";
-export { defineCloudflareConfig } from "./config.js";
+export * from "./config.js";
+export { default as d1TagCache } from "./d1-tag-cache.js";
+export { default as kvIncrementalCache } from "./kv-cache";
+export { default as memoryQueue } from "./memory-queue.js";

Original file line number	Diff line number	Diff line change
`@@ -5,12 +5,10 @@ export type CloudflareConfigOptions = {`
`5`	`5`	`/**`
`6`	`6`	`* The incremental cache implementation to use (for more details see the [Incremental Cache documentation](https://opennext.js.org/aws/config/overrides/incremental_cache))`
`7`	`7`	`*`
`8`		- * `@opennextjs/cloudflare` offers a kv incremental cache implementation ready
`9`		- * to use which can be imported from `"@opennextjs/cloudflare/kv-cache"`
	`8`	+ * `@opennextjs/cloudflare` offers a kv incremental cache implementation exported as `kvIncrementalCache`
`10`	`9`	`*`
`11`	`10`	`* @example`
`12`		`- * import { defineCloudflareConfig } from "@opennextjs/cloudflare";`
`13`		`- * import cache from "@opennextjs/cloudflare/kv-cache";`
	`11`	`+ * import { defineCloudflareConfig, kvIncrementalCache } from "@opennextjs/cloudflare";`
`14`	`12`	`*`
`15`	`13`	`* export default defineCloudflareConfig({`
`16`	`14`	`* incrementalCache: cache,`
`@@ -21,28 +19,24 @@ export type CloudflareConfigOptions = {`
`21`	`19`	`/**`
`22`	`20`	`* The tag cache implementation to use (for more details see the [Tag Cache documentation](https://opennext.js.org/aws/config/overrides/tag_cache))`
`23`	`21`	`*`
`24`		- * `@opennextjs/cloudflare` offers a d1 tag cache implementation ready
`25`		- * to use which can be imported from `"@opennextjs/cloudflare/d1-tag-cache"`
	`22`	+ * `@opennextjs/cloudflare` offers a d1 tag cache implementation exported as `d1TagCache`
`26`	`23`	`*`
`27`	`24`	`* @example`
`28`		`- * import { defineCloudflareConfig } from "@opennextjs/cloudflare";`
`29`		`- * import cache from "@opennextjs/cloudflare/d1-tag-cache";`
	`25`	`+ * import { defineCloudflareConfig, d1TagCache } from "@opennextjs/cloudflare";`
`30`	`26`	`*`
`31`	`27`	`* export default defineCloudflareConfig({`
`32`		`- * tagCache: cache,`
	`28`	`+ * tagCache: d1TagCache,`
`33`	`29`	`* });`
`34`	`30`	`*/`
`35`	`31`	`tagCache?: TagCache \| (() => TagCache \| Promise<TagCache>);`
`36`	`32`
`37`	`33`	`/**`
`38`	`34`	`* The revalidation queue implementation to use (for more details see the [Queue documentation](https://opennext.js.org/aws/config/overrides/queue))`
`39`	`35`	`*`
`40`		- * `@opennextjs/cloudflare` offers an in memory queue implementation ready
`41`		- * to use which can be imported from `"@opennextjs/cloudflare/memory-queue"`
	`36`	+ * `@opennextjs/cloudflare` offers an in memory queue implementation exported as `memoryQueue`
`42`	`37`	`*`
`43`	`38`	`* @example`
`44`		`- * import { defineCloudflareConfig } from "@opennextjs/cloudflare";`
`45`		`- * import memoryQueue from "@opennextjs/cloudflare/memory-queue";`
	`39`	`+ * import { defineCloudflareConfig, memoryQueue } from "@opennextjs/cloudflare";`
`46`	`40`	`*`
`47`	`41`	`* export default defineCloudflareConfig({`
`48`	`42`	`* queue: memoryQueue,`