@opennextjs/cloudflare 1.16.6 → 1.17.1

package/dist/cli/utils/create-wrangler-config.js

@@ -0,0 +1,244 @@
+import assert from "node:assert";
+import { existsSync, readFileSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { findPackagerAndRoot } from "@opennextjs/aws/build/helper.js";
+import Cloudflare from "cloudflare";
+import { parse, stringify } from "comment-json";
+import { getPackageTemplatesDirPath } from "../../utils/get-package-templates-dir-path.js";
+import { runWrangler } from "../commands/utils/run-wrangler.js";
+import { askAccountSelection } from "./ask-account-selection.js";
+/**
+ * Gets the path to the Wrangler configuration file if it exists.
+ *
+ * @param appDir The directory to check for the Wrangler config file
+ * @returns The path to Wrangler config file if it exists, undefined otherwise
+ */
+export function findWranglerConfig(appDir) {
+    const possibleExts = ["toml", "json", "jsonc"];
+    for (const ext of possibleExts) {
+        const path = join(appDir, `wrangler.${ext}`);
+        if (existsSync(path)) {
+            return path;
+        }
+    }
+    return undefined;
+}
+/**
+ * Creates a wrangler.jsonc config file in the target directory for the project.
+ *
+ * If a wrangler.jsonc file already exists it will be overridden.
+ *
+ * The function attempts to create an R2 bucket for incremental cache. If bucket creation
+ * fails (e.g., user not authenticated or R2 not enabled), a configuration without caching
+ * will be created instead.
+ *
+ * @param projectDir The target directory for the project
+ * @param defaultCompatDate The default YYYY-MM-DD compatibility date to use in the config (used if fetching the latest workerd version date fails)
+ * @returns An object containing a `cachingEnabled` which indicates whether caching has been set up during the wrangler
+ *          config file creation or not
+ */
+export async function createWranglerConfigFile(projectDir, defaultCompatDate = "2026-02-01") {
+    const workerName = getWorkerName(projectDir);
+    const compatibilityDate = (await getLatestCompatDate()) ?? defaultCompatDate;
+    const wranglerConfigStr = readFileSync(join(getPackageTemplatesDirPath(), "wrangler.jsonc"), "utf8")
+        .replaceAll("<WORKER_NAME>", workerName)
+        .replaceAll("<COMPATIBILITY_DATE>", compatibilityDate);
+    const wranglerConfig = parse(wranglerConfigStr);
+    assert(Array.isArray(wranglerConfig.r2_buckets));
+    assert(wranglerConfig.r2_buckets[0] != null && typeof wranglerConfig.r2_buckets[0] === "object");
+    assert("bucket_name" in wranglerConfig.r2_buckets[0] &&
+        typeof wranglerConfig.r2_buckets[0].bucket_name === "string");
+    const bucketName = wranglerConfig.r2_buckets[0].bucket_name;
+    const { success: cachingEnabled } = await maybeCreateR2Bucket(projectDir, bucketName);
+    if (!cachingEnabled) {
+        delete wranglerConfig.r2_buckets;
+    }
+    writeFileSync(join(projectDir, "wrangler.jsonc"), stringify(wranglerConfig, null, "\t"));
+    return { cachingEnabled };
+}
+/**
+ * Gets a valid worker name from the project's package.json name, falling back to `app-name`
+ * in case the name could not be detected.
+ *
+ * @param projectDir The project directory containing the package.json file
+ * @returns A valid worker name suitable for a Cloudflare Worker
+ */
+function getWorkerName(projectDir) {
+    const appName = getNameFromPackageJson(projectDir) ?? "app-name";
+    return (appName
+        .toLowerCase()
+        // Remove org prefix if present (e.g., "@org/my-app" -> "my-app")
+        .replace(/^@[^/]+\//, "")
+        .replaceAll("_", "-")
+        .replace(/[^a-z0-9-]/g, ""));
+}
+/**
+ * Reads the `name` field from the `package.json` in the given directory.
+ *
+ * @param sourceDir - The directory containing the `package.json` file.
+ * @returns The package name if found, `undefined` otherwise.
+ */
+function getNameFromPackageJson(sourceDir) {
+    try {
+        const packageJsonStr = readFileSync(join(sourceDir, "package.json"), "utf8");
+        const packageJson = JSON.parse(packageJsonStr);
+        if (typeof packageJson.name === "string")
+            return packageJson.name;
+    }
+    catch {
+        /* empty */
+    }
+}
+/**
+ * Fetches the latest compatibility date from the npm registry based on the latest `workerd` version.
+ *
+ * The workerd version format is `major.yyyymmdd.patch`. The date portion is extracted and formatted
+ * as `YYYY-MM-DD`. If the extracted date is in the future, today's date is returned instead.
+ *
+ * @returns The compatibility date as a `YYYY-MM-DD` string, or `undefined` if the fetch or parsing fails.
+ */
+async function getLatestCompatDate() {
+    try {
+        const resp = await fetch(`https://registry.npmjs.org/workerd`);
+        const latestWorkerdVersion = (await resp.json())["dist-tags"].latest;
+        // The format of the workerd version is `major.yyyymmdd.patch`.
+        const match = latestWorkerdVersion.match(/\d+\.(\d{4})(\d{2})(\d{2})\.\d+/);
+        if (match) {
+            const [, year, month, day] = match;
+            const compatDate = `${year}-${month}-${day}`;
+            const currentDate = new Date().toISOString().slice(0, 10);
+            return compatDate < currentDate ? compatDate : currentDate;
+        }
+    }
+    catch {
+        /* empty */
+    }
+}
+/**
+ * Gets the authentication credentials for Cloudflare API calls.
+ *
+ * Uses `wrangler auth token --json` which checks the following sources in order:
+ * 1. CLOUDFLARE_API_TOKEN environment variable
+ * 2. CLOUDFLARE_API_KEY + CLOUDFLARE_EMAIL environment variables
+ * 3. OAuth token from `wrangler login`
+ *
+ * @param options The build options containing packager and monorepo root
+ * @returns The auth credentials if available, undefined otherwise
+ */
+function getAuthCredentials(options) {
+    const result = runWrangler(options, ["auth", "token", "--json"], { logging: "none" });
+    if (!result.success) {
+        return undefined;
+    }
+    try {
+        const json = JSON.parse(result.stdout);
+        if (json.type === "api_key") {
+            return { type: "api_key", apiKey: json.key, apiEmail: json.email };
+        }
+        // Both "oauth" and "api_token" types have a token field
+        if (json.token) {
+            return { type: "token", token: json.token };
+        }
+    }
+    catch {
+        /* empty */
+    }
+    return undefined;
+}
+/**
+ * Gets the account ID for Cloudflare API calls.
+ *
+ * Tries the following sources in order:
+ * 1. CLOUDFLARE_ACCOUNT_ID or CF_ACCOUNT_ID environment variable
+ * 2. List accounts using the SDK and return the first one
+ *
+ * @param client The Cloudflare SDK client
+ * @returns The account ID if available, undefined otherwise
+ */
+async function getAccountId(client) {
+    if (process.env.CLOUDFLARE_ACCOUNT_ID || process.env.CF_ACCOUNT_ID) {
+        return process.env.CLOUDFLARE_ACCOUNT_ID || process.env.CF_ACCOUNT_ID;
+    }
+    try {
+        const accountsList = await client.accounts.list();
+        const accounts = [];
+        for await (const account of accountsList) {
+            accounts.push({ id: account.id, name: account.name });
+        }
+        if (accounts.length === 0) {
+            return undefined;
+        }
+        if (accounts.length === 1 && accounts[0]) {
+            return accounts[0].id;
+        }
+        return await askAccountSelection(accounts);
+    }
+    catch {
+        /* empty */
+    }
+    return undefined;
+}
+/**
+ * Attempts to log in to Cloudflare via wrangler.
+ *
+ * @param options The build options containing packager and monorepo root
+ * @returns true if login was successful, false otherwise
+ */
+function wranglerLogin(options) {
+    const result = runWrangler(options, ["login"], { logging: "all" });
+    return result.success;
+}
+/**
+ * Creates an R2 bucket.
+ *
+ * If no auth credentials are available, falls back to wrangler login for OAuth authentication.
+ *
+ * @param projectDir The project directory to detect the package manager
+ * @param bucketName The name of the R2 bucket to create
+ * @returns An object indicating success with the bucket name, or failure
+ */
+async function maybeCreateR2Bucket(projectDir, bucketName) {
+    try {
+        const { packager, root: monorepoRoot } = findPackagerAndRoot(projectDir);
+        const options = { packager, monorepoRoot };
+        let authCredentials = getAuthCredentials(options);
+        // If no credentials available, fall back to wrangler login
+        if (!authCredentials) {
+            const loginSuccess = wranglerLogin(options);
+            if (!loginSuccess) {
+                return { success: false };
+            }
+            // Get credentials after login
+            authCredentials = getAuthCredentials(options);
+            if (!authCredentials) {
+                return { success: false };
+            }
+        }
+        const client = authCredentials.type === "api_key"
+            ? new Cloudflare({ apiKey: authCredentials.apiKey, apiEmail: authCredentials.apiEmail })
+            : new Cloudflare({ apiToken: authCredentials.token });
+        const accountId = await getAccountId(client);
+        if (!accountId) {
+            return { success: false };
+        }
+        // Check if bucket already exists
+        try {
+            await client.r2.buckets.get(bucketName, { account_id: accountId });
+            // Bucket exists
+            return { success: true, bucketName };
+        }
+        catch (error) {
+            if (!(error instanceof Cloudflare.NotFoundError)) {
+                return { success: false };
+            }
+        }
+        await client.r2.buckets.create({
+            account_id: accountId,
+            name: bucketName,
+        });
+        return { success: true, bucketName };
+    }
+    catch {
+        return { success: false };
+    }
+}

package/dist/cli/utils/nextjs-support.d.ts

@@ -0,0 +1,10 @@
+import * as buildHelper from "@opennextjs/aws/build/helper.js";
+/**
+ * Validates that the Next.js version is supported and checks wrangler compatibility.
+ *
+ * Note: this function assumes that wrangler is installed.
+ *
+ * @param options.nextVersion The detected Next.js version string
+ * @throws {Error} If the Next.js version is unsupported
+ */
+export declare function ensureNextjsVersionSupported({ nextVersion, }: Pick<buildHelper.BuildOptions, "nextVersion">): Promise<void>;

package/dist/cli/utils/nextjs-support.js

@@ -0,0 +1,24 @@
+import * as buildHelper from "@opennextjs/aws/build/helper.js";
+import logger from "@opennextjs/aws/logger.js";
+/**
+ * Validates that the Next.js version is supported and checks wrangler compatibility.
+ *
+ * Note: this function assumes that wrangler is installed.
+ *
+ * @param options.nextVersion The detected Next.js version string
+ * @throws {Error} If the Next.js version is unsupported
+ */
+export async function ensureNextjsVersionSupported({ nextVersion, }) {
+    if (buildHelper.compareSemver(nextVersion, "<", "14.2.0")) {
+        throw new Error("Next.js version unsupported, please upgrade to version 14.2 or greater.");
+    }
+    const { default: { version: wranglerVersion }, } = await import("wrangler/package.json", { with: { type: "json" } });
+    // We need a version of workerd that has a fix for setImmediate for Next.js 16.1+
+    // See:
+    // - https://github.com/cloudflare/workerd/pull/5869
+    // - https://github.com/opennextjs/opennextjs-cloudflare/issues/1049
+    if (buildHelper.compareSemver(nextVersion, ">=", "16.1.0") &&
+        buildHelper.compareSemver(wranglerVersion, "<", "4.59.2")) {
+        logger.warn(`Next.js 16.1+ requires wrangler 4.59.2 or greater (${wranglerVersion} detected).`);
+    }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "1.16.6",
+  "version": "1.17.1",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"
@@ -48,6 +48,7 @@
     "cloudflare": "^4.4.1",
     "enquirer": "^2.4.1",
     "glob": "^12.0.0",
+    "comment-json": "^4.5.1",
     "ts-tqdm": "^0.8.6",
     "yargs": "^18.0.0"
   },
@@ -75,7 +76,7 @@
     "vitest": "^2.1.1"
   },
   "peerDependencies": {
-    "wrangler": "^4.59.2",
+    "wrangler": "^4.65.0",
     "next": "~15.0.8 || ~15.1.12 || ~15.2.9 || ~15.3.9 || ~15.4.11 || ~15.5.10 || ~16.0.11 || ^16.1.5"
   },
   "scripts": {

package/templates/open-next.config.ts

@@ -1,5 +1,5 @@
 // default open-next.config.ts file created by @opennextjs/cloudflare
-import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
+import { defineCloudflareConfig } from "@opennextjs/cloudflare";
 import r2IncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/r2-incremental-cache";
 
 export default defineCloudflareConfig({

package/templates/wrangler.jsonc

@@ -2,7 +2,7 @@
 	"$schema": "node_modules/wrangler/config-schema.json",
 	"main": ".open-next/worker.js",
 	"name": "<WORKER_NAME>",
-	"compatibility_date": "2025-12-01",
+	"compatibility_date": "<COMPATIBILITY_DATE>",
 	"compatibility_flags": ["nodejs_compat", "global_fetch_strictly_public"],
 	"assets": {
 		"directory": ".open-next/assets",
@@ -24,7 +24,7 @@
 			// Create the bucket before deploying
 			// You can change the bucket name if you want
 			// See https://developers.cloudflare.com/workers/wrangler/commands/#r2-bucket-create
-			"bucket_name": "cache"
+			"bucket_name": "<WORKER_NAME>-opennext-cache"
 		}
 	],
 	"images": {

package/dist/cli/build/utils/create-config-files.d.ts

@@ -1,19 +0,0 @@
-import type { ProjectOptions } from "../../project-options.js";
-/**
- * Creates a `wrangler.jsonc` file for the user if a wrangler config file doesn't already exist,
- * but only after asking for the user's confirmation.
- *
- * If the user refuses a warning is shown (which offers ways to opt out of this check to the user).
- *
- * @param projectOpts The options for the project
- */
-export declare function createWranglerConfigIfNonExistent(projectOpts: ProjectOptions): Promise<void>;
-/**
- * Creates a `open-next.config.ts` file for the user if it doesn't exist, but only after asking for the user's confirmation.
- *
- * If the user refuses an error is thrown (since the file is mandatory).
- *
- * @param sourceDir The source directory for the project
- * @return The path to the created source file
- */
-export declare function createOpenNextConfigIfNotExistent(sourceDir: string): Promise<string>;

package/dist/cli/build/utils/create-config-files.js

@@ -1,44 +0,0 @@
-import { askConfirmation } from "../../utils/ask-confirmation.js";
-import { createOpenNextConfigFile, findOpenNextConfig } from "../../utils/open-next-config.js";
-import { createWranglerConfigFile, findWranglerConfig } from "../../utils/wrangler-config.js";
-/**
- * Creates a `wrangler.jsonc` file for the user if a wrangler config file doesn't already exist,
- * but only after asking for the user's confirmation.
- *
- * If the user refuses a warning is shown (which offers ways to opt out of this check to the user).
- *
- * @param projectOpts The options for the project
- */
-export async function createWranglerConfigIfNonExistent(projectOpts) {
-    const wranglerConfigFileExists = Boolean(findWranglerConfig(projectOpts.sourceDir));
-    if (wranglerConfigFileExists) {
-        return;
-    }
-    const answer = await askConfirmation("No `wrangler.(toml|json|jsonc)` config file found, do you want to create one?");
-    if (!answer) {
-        console.warn("No Wrangler config file created" +
-            "\n" +
-            "(to avoid this check use the `--skipWranglerConfigCheck` flag or set a `SKIP_WRANGLER_CONFIG_CHECK` environment variable to `yes`)");
-        return;
-    }
-    await createWranglerConfigFile(projectOpts.sourceDir);
-}
-/**
- * Creates a `open-next.config.ts` file for the user if it doesn't exist, but only after asking for the user's confirmation.
- *
- * If the user refuses an error is thrown (since the file is mandatory).
- *
- * @param sourceDir The source directory for the project
- * @return The path to the created source file
- */
-export async function createOpenNextConfigIfNotExistent(sourceDir) {
-    const openNextConfigPath = findOpenNextConfig(sourceDir);
-    if (!openNextConfigPath) {
-        const answer = await askConfirmation("Missing required `open-next.config.ts` file, do you want to create one?");
-        if (!answer) {
-            throw new Error("The `open-next.config.ts` file is required, aborting!");
-        }
-        return createOpenNextConfigFile(sourceDir);
-    }
-    return openNextConfigPath;
-}

package/dist/cli/utils/open-next-config.d.ts

@@ -1,14 +0,0 @@
-/**
- * Finds the path to the OpenNext configuration file if it exists.
- *
- * @param appDir The directory to check for the open-next.config.ts file
- * @returns The full path to open-next.config.ts if it exists, undefined otherwise
- */
-export declare function findOpenNextConfig(appDir: string): string | undefined;
-/**
- * Creates a `open-next.config.ts` file in the target directory for the project.
- *
- * @param appDir The Next application root
- * @return The path to the created source file
- */
-export declare function createOpenNextConfigFile(appDir: string): Promise<string>;

package/dist/cli/utils/open-next-config.js

@@ -1,27 +0,0 @@
-import { cpSync, existsSync } from "node:fs";
-import { join } from "node:path";
-import { getPackageTemplatesDirPath } from "../../utils/get-package-templates-dir-path.js";
-/**
- * Finds the path to the OpenNext configuration file if it exists.
- *
- * @param appDir The directory to check for the open-next.config.ts file
- * @returns The full path to open-next.config.ts if it exists, undefined otherwise
- */
-export function findOpenNextConfig(appDir) {
-    const openNextConfigPath = join(appDir, "open-next.config.ts");
-    if (existsSync(openNextConfigPath)) {
-        return openNextConfigPath;
-    }
-    return undefined;
-}
-/**
- * Creates a `open-next.config.ts` file in the target directory for the project.
- *
- * @param appDir The Next application root
- * @return The path to the created source file
- */
-export async function createOpenNextConfigFile(appDir) {
-    const openNextConfigPath = join(appDir, "open-next.config.ts");
-    cpSync(join(getPackageTemplatesDirPath(), "open-next.config.ts"), openNextConfigPath);
-    return openNextConfigPath;
-}

package/dist/cli/utils/run-wrangler.d.ts

@@ -1,12 +0,0 @@
-import type { BuildOptions } from "@opennextjs/aws/build/helper.js";
-export type WranglerTarget = "local" | "remote";
-type WranglerOptions = {
-    target?: WranglerTarget;
-    environment?: string;
-    configPath?: string;
-    logging?: "all" | "error";
-    env?: Record<string, string>;
-};
-export declare function runWrangler(options: BuildOptions, args: string[], wranglerOpts?: WranglerOptions): void;
-export declare function isWranglerTarget(v: string | undefined): v is WranglerTarget;
-export {};

package/dist/cli/utils/wrangler-config.d.ts

@@ -1,15 +0,0 @@
-/**
- * Gets the path to the Wrangler configuration file if it exists.
- *
- * @param appDir The directory to check for the Wrangler config file
- * @returns The path to Wrangler config file if it exists, undefined otherwise
- */
-export declare function findWranglerConfig(appDir: string): string | undefined;
-/**
- * Creates a wrangler.jsonc config file in the target directory for the project.
- *
- * If a wrangler.jsonc file already exists it will be overridden.
- *
- * @param projectDir The target directory for the project
- */
-export declare function createWranglerConfigFile(projectDir: string): Promise<void>;

package/dist/cli/utils/wrangler-config.js

@@ -1,64 +0,0 @@
-import { existsSync, readFileSync, writeFileSync } from "node:fs";
-import { join } from "node:path";
-import { getPackageTemplatesDirPath } from "../../utils/get-package-templates-dir-path.js";
-/**
- * Gets the path to the Wrangler configuration file if it exists.
- *
- * @param appDir The directory to check for the Wrangler config file
- * @returns The path to Wrangler config file if it exists, undefined otherwise
- */
-export function findWranglerConfig(appDir) {
-    const possibleExts = ["toml", "json", "jsonc"];
-    for (const ext of possibleExts) {
-        const path = join(appDir, `wrangler.${ext}`);
-        if (existsSync(path)) {
-            return path;
-        }
-    }
-    return undefined;
-}
-/**
- * Creates a wrangler.jsonc config file in the target directory for the project.
- *
- * If a wrangler.jsonc file already exists it will be overridden.
- *
- * @param projectDir The target directory for the project
- */
-export async function createWranglerConfigFile(projectDir) {
-    let wranglerConfig = readFileSync(join(getPackageTemplatesDirPath(), "wrangler.jsonc"), "utf8");
-    const appName = getAppNameFromPackageJson(projectDir) ?? "app-name";
-    wranglerConfig = wranglerConfig.replaceAll('"<WORKER_NAME>"', JSON.stringify(appName.replaceAll("_", "-")));
-    const compatDate = await getLatestCompatDate();
-    if (compatDate) {
-        wranglerConfig = wranglerConfig.replace(/"compatibility_date": "\d{4}-\d{2}-\d{2}"/, `"compatibility_date": ${JSON.stringify(compatDate)}`);
-    }
-    writeFileSync(join(projectDir, "wrangler.jsonc"), wranglerConfig);
-}
-function getAppNameFromPackageJson(sourceDir) {
-    try {
-        const packageJsonStr = readFileSync(join(sourceDir, "package.json"), "utf8");
-        const packageJson = JSON.parse(packageJsonStr);
-        if (typeof packageJson.name === "string")
-            return packageJson.name;
-    }
-    catch {
-        /* empty */
-    }
-}
-async function getLatestCompatDate() {
-    try {
-        const resp = await fetch(`https://registry.npmjs.org/workerd`);
-        const latestWorkerdVersion = (await resp.json())["dist-tags"].latest;
-        // The format of the workerd version is `major.yyyymmdd.patch`.
-        const match = latestWorkerdVersion.match(/\d+\.(\d{4})(\d{2})(\d{2})\.\d+/);
-        if (match) {
-            const [, year, month, day] = match;
-            const compatDate = `${year}-${month}-${day}`;
-            const currentDate = new Date().toISOString().slice(0, 10);
-            return compatDate < currentDate ? compatDate : currentDate;
-        }
-    }
-    catch {
-        /* empty */
-    }
-}