defineConfig -> defineCloudflareConfig

dario-piotrowicz · dario-piotrowicz · commit 3ac122c6725f · 2025-02-26T10:13:16.000Z
diff --git a/.changeset/cold-numbers-bow.md b/.changeset/cold-numbers-bow.md
@@ -2,19 +2,19 @@
 "@opennextjs/cloudflare": patch
 ---
 
-add `defineConfig` utility
+add `defineCloudflareConfig` utility
 
-this change adds a new `defineConfig` utility that developers can use in their `open-next.config.ts`
+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
 
 Example usage:
 
 ```ts
 // open-next.config.ts
 import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig({
+export default defineCloudflareConfig({
   incrementalCache: cache,
 });
 ```
diff --git a/examples/bugs/gh-119/open-next.config.ts b/examples/bugs/gh-119/open-next.config.ts
@@ -1,3 +1,3 @@
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig();
+export default defineCloudflareConfig();
diff --git a/examples/bugs/gh-219/open-next.config.ts b/examples/bugs/gh-219/open-next.config.ts
@@ -1,3 +1,3 @@
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig();
+export default defineCloudflareConfig();
diff --git a/examples/bugs/gh-223/open-next.config.ts b/examples/bugs/gh-223/open-next.config.ts
@@ -1,3 +1,3 @@
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig();
+export default defineCloudflareConfig();
diff --git a/examples/create-next-app/open-next.config.ts b/examples/create-next-app/open-next.config.ts
@@ -1,3 +1,3 @@
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig({});
+export default defineCloudflareConfig({});
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,8 @@
 import kvCache from "@opennextjs/cloudflare/kv-cache";
 import memoryQueue from "@opennextjs/cloudflare/memory-queue";
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig({
+export default defineCloudflareConfig({
   incrementalCache: kvCache,
   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,8 @@
 import memoryQueue from "@opennextjs/cloudflare/memory-queue";
 import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig({
+export default defineCloudflareConfig({
   incrementalCache: cache,
   queue: memoryQueue,
 });
diff --git a/examples/middleware/open-next.config.ts b/examples/middleware/open-next.config.ts
@@ -1,3 +1,3 @@
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig();
+export default defineCloudflareConfig();
diff --git a/examples/playground14/open-next.config.ts b/examples/playground14/open-next.config.ts
@@ -1,6 +1,6 @@
 import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig({
+export default defineCloudflareConfig({
   incrementalCache: cache,
 });
diff --git a/examples/playground15/open-next.config.ts b/examples/playground15/open-next.config.ts
@@ -1,6 +1,6 @@
 import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig({
+export default defineCloudflareConfig({
   incrementalCache: cache,
 });
diff --git a/examples/ssg-app/open-next.config.ts b/examples/ssg-app/open-next.config.ts
@@ -1,6 +1,6 @@
 import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig({
+export default defineCloudflareConfig({
   incrementalCache: cache,
 });
diff --git a/examples/vercel-blog-starter/open-next.config.ts b/examples/vercel-blog-starter/open-next.config.ts
@@ -1,6 +1,6 @@
 import cache from "@opennextjs/cloudflare/kv-cache";
-import { defineConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
 
-export default defineConfig({
+export default defineCloudflareConfig({
   incrementalCache: cache,
 });
diff --git a/packages/cloudflare/src/api/config.ts b/packages/cloudflare/src/api/config.ts
@@ -29,7 +29,7 @@ export type CloudflareConfigOptions = {
  * @param options options that enabled you to configure the application's behavior
  * @returns the OpenNext configuration object
  */
-export function defineConfig(options: CloudflareConfigOptions = {}): OpenNextConfig {
+export function defineCloudflareConfig(options: CloudflareConfigOptions = {}): OpenNextConfig {
   const { incrementalCache, tagCache, queue } = options;
   return {
     default: {
diff --git a/packages/cloudflare/templates/defaults/open-next.config.ts b/packages/cloudflare/templates/defaults/open-next.config.ts
@@ -1,7 +1,7 @@
 // default open-next.config.ts file created by @opennextjs/cloudflare
-import { defineConfig } from "@opennextjs/cloudflare/dist/api/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/dist/api/config";
 import cache from "@opennextjs/cloudflare/dist/api/kv-cache";
 
-export default defineConfig({
+export default defineCloudflareConfig({
   incrementalCache: cache,
 });
