@opennextjs/cloudflare 1.16.3 → 1.16.5

package/dist/api/overrides/asset-resolver/index.js

@@ -34,13 +34,31 @@ const resolver = {
             type: "core",
             statusCode: response.status,
             headers: Object.fromEntries(response.headers.entries()),
-            // Workers and Node types differ.
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            body: response.body || new ReadableStream(),
+            body: getResponseBody(method, response),
             isBase64Encoded: false,
         };
     },
 };
+/**
+ * Returns the response body for an asset result.
+ *
+ * HEAD responses must return `null` because `response.body` is `null` per the HTTP spec
+ * and the `new ReadableStream()` fallback would create a stream that never closes, hanging the Worker.
+ *
+ * @param method - The HTTP method of the request.
+ * @param response - The response from the ASSETS binding.
+ * @returns The body to use in the internal result.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function getResponseBody(method, response) {
+    if (method === "HEAD") {
+        return null;
+    }
+    // Workers and Node ReadableStream types differ.
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return response.body || new ReadableStream();
+}
 /**
  * @param runWorkerFirst `run_worker_first` config
  * @param pathname pathname of the request

package/dist/cli/build/build.js

@@ -6,6 +6,7 @@ import * as buildHelper from "@opennextjs/aws/build/helper.js";
 import { patchOriginalNextConfig } from "@opennextjs/aws/build/patch/patches/index.js";
 import { printHeader } from "@opennextjs/aws/build/utils.js";
 import logger from "@opennextjs/aws/logger.js";
+import { ensureNextjsVersionSupported } from "../commands/utils.js";
 import { bundleServer } from "./bundle-server.js";
 import { compileCacheAssetsManifestSqlFile } from "./open-next/compile-cache-assets-manifest.js";
 import { compileEnvFiles } from "./open-next/compile-env-files.js";
@@ -75,18 +76,3 @@ export async function build(options, config, projectOpts, wranglerConfig, allowU
     await bundleServer(options, projectOpts);
     logger.info("OpenNext build complete.");
 }
-async function ensureNextjsVersionSupported({ nextVersion }) {
-    if (buildHelper.compareSemver(nextVersion, "<", "14.2.0")) {
-        logger.error("Next.js version unsupported, please upgrade to version 14.2 or greater.");
-        process.exit(1);
-    }
-    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/dist/cli/build/utils/files.d.ts

@@ -6,6 +6,10 @@
  *
  * @param filepath The path to the file.
  * @param text The text to append to the file.
- * @param condition A function that receives the current file content and returns `true` if the text should be appended to it, the condition is skipped when the file is being created.
+ * @param opts.appendIf A function that receives the current file content and returns `true` if the text should be appended to it, the condition is skipped when the file is being created. Defaults to a function that always returns true.
+ * @param opts.appendPrefix A string that will be inserted between the pre-existing file's content and the new text in case the file already existed. Defaults to an empty string.
  */
-export declare function conditionalAppendFileSync(filepath: string, text: string, condition: (fileContent: string) => boolean): void;
+export declare function conditionalAppendFileSync(filepath: string, text: string, { appendIf, appendPrefix, }?: {
+    appendIf?: (fileContent: string) => boolean;
+    appendPrefix?: string;
+}): void;

package/dist/cli/build/utils/files.js

@@ -1,4 +1,5 @@
 import fs from "node:fs";
+import path from "node:path";
 /**
  * Appends text to a file
  *
@@ -7,11 +8,17 @@ import fs from "node:fs";
  *
  * @param filepath The path to the file.
  * @param text The text to append to the file.
- * @param condition A function that receives the current file content and returns `true` if the text should be appended to it, the condition is skipped when the file is being created.
+ * @param opts.appendIf A function that receives the current file content and returns `true` if the text should be appended to it, the condition is skipped when the file is being created. Defaults to a function that always returns true.
+ * @param opts.appendPrefix A string that will be inserted between the pre-existing file's content and the new text in case the file already existed. Defaults to an empty string.
  */
-export function conditionalAppendFileSync(filepath, text, condition) {
+export function conditionalAppendFileSync(filepath, text, { appendIf = () => true, appendPrefix = "", } = {}) {
     const fileExists = fs.existsSync(filepath);
-    if (!fileExists || condition(fs.readFileSync(filepath, "utf8"))) {
-        fs.appendFileSync(filepath, text);
+    const maybeFileContent = fileExists ? fs.readFileSync(filepath, "utf8") : "";
+    if (!fileExists) {
+        const dir = path.dirname(filepath);
+        fs.mkdirSync(dir, { recursive: true });
+    }
+    if (!fileExists || appendIf(maybeFileContent)) {
+        fs.appendFileSync(filepath, `${maybeFileContent.length > 0 ? appendPrefix : ""}${text}`);
     }
 }

package/dist/cli/commands/build.js

@@ -26,7 +26,7 @@ async function buildCommand(args) {
  * Consumes 1 positional parameter.
  */
 export function addBuildCommand(y) {
-    return y.command("build", "Build an OpenNext Cloudflare worker", (c) => withWranglerOptions(c)
+    return y.command("build [args..]", "Build an OpenNext Cloudflare worker", (c) => withWranglerOptions(c)
         .option("skipNextBuild", {
         type: "boolean",
         alias: ["skipBuild", "s"],

package/dist/cli/commands/deploy.js

@@ -46,5 +46,5 @@ export async function deployCommand(args) {
  * Consumes 1 positional parameter.
  */
 export function addDeployCommand(y) {
-    return y.command("deploy", "Deploy a built OpenNext app to Cloudflare Workers", (c) => withPopulateCacheOptions(c), (args) => deployCommand(withWranglerPassthroughArgs(args)));
+    return y.command("deploy [args..]", "Deploy a built OpenNext app to Cloudflare Workers", (c) => withPopulateCacheOptions(c), (args) => deployCommand(withWranglerPassthroughArgs(args)));
 }

package/dist/cli/commands/migrate.js

@@ -1,12 +1,14 @@
+import assert from "node:assert";
 import childProcess from "node:child_process";
 import fs from "node:fs";
 import path from "node:path";
-import { checkRunningInsideNextjsApp, findNextConfig, findPackagerAndRoot, } from "@opennextjs/aws/build/helper.js";
+import { checkRunningInsideNextjsApp, findNextConfig, findPackagerAndRoot, getNextVersion, } from "@opennextjs/aws/build/helper.js";
 import logger from "@opennextjs/aws/logger.js";
 import { conditionalAppendFileSync } from "../build/utils/files.js";
+import { askConfirmation } from "../utils/ask-confirmation.js";
 import { createOpenNextConfigFile, findOpenNextConfig } from "../utils/open-next-config.js";
 import { createWranglerConfigFile, findWranglerConfig } from "../utils/wrangler-config.js";
-import { printHeaders } from "./utils.js";
+import { ensureNextjsVersionSupported, printHeaders } from "./utils.js";
 /**
  * Implementation of the `opennextjs-cloudflare migrate` command.
  *
@@ -16,6 +18,14 @@ async function migrateCommand(args) {
     printHeaders("migrate");
     logger.info("🚀 Setting up the OpenNext Cloudflare adapter...\n");
     const projectDir = process.cwd();
+    const nextConfigFileCreated = await maybeCreateNextConfigFileIfMissing(projectDir, args.forceInstall).catch((e) => {
+        logger.error(`${e instanceof Error ? e.message : e}\n`);
+        process.exit(1);
+    });
+    if (nextConfigFileCreated === false) {
+        logger.error("The next.config file is required, aborting!\n");
+        process.exit(1);
+    }
     checkRunningInsideNextjsApp({ appPath: projectDir });
     const wranglerConfigFilePath = findWranglerConfig(projectDir);
     if (wranglerConfigFilePath) {
@@ -49,12 +59,18 @@ async function migrateCommand(args) {
     await createOpenNextConfigFile("./");
     const devVarsExists = fs.existsSync(".dev.vars");
     printStepTitle(`${devVarsExists ? "Updating" : "Creating"} .dev.vars file`);
-    conditionalAppendFileSync(".dev.vars", "\nNEXTJS_ENV=development\n", (content) => !/\bNEXTJS_ENV\b/.test(content));
+    conditionalAppendFileSync(".dev.vars", "NEXTJS_ENV=development\n", {
+        appendIf: (content) => !/\bNEXTJS_ENV\b/.test(content),
+        appendPrefix: "\n",
+    });
     printStepTitle(`${fs.existsSync("public/_headers") ? "Updating" : "Creating"} public/_headers file`);
-    conditionalAppendFileSync("public/_headers", "\n\n# https://developers.cloudflare.com/workers/static-assets/headers\n" +
+    conditionalAppendFileSync("public/_headers", "# https://developers.cloudflare.com/workers/static-assets/headers\n" +
         "# https://opennext.js.org/cloudflare/caching#static-assets-caching\n" +
         "/_next/static/*\n" +
-        "  Cache-Control: public,max-age=31536000,immutable\n\n", (content) => !/^\/_next\/static\/*\b/.test(content));
+        "  Cache-Control: public,max-age=31536000,immutable\n", {
+        appendIf: (content) => !/^\/_next\/static\/*\b/.test(content),
+        appendPrefix: "\n\n",
+    });
     printStepTitle("Updating package.json scripts");
     const openNextScripts = {
         preview: "opennextjs-cloudflare build && opennextjs-cloudflare preview",
@@ -82,9 +98,19 @@ async function migrateCommand(args) {
     }
     const gitIgnoreExists = fs.existsSync(".gitignore");
     printStepTitle(`${gitIgnoreExists ? "Updating" : "Creating"} .gitignore file`);
-    conditionalAppendFileSync(".gitignore", "\n# OpenNext\n.open-next\n", (content) => !content.includes(".open-next"));
+    conditionalAppendFileSync(".gitignore", "# OpenNext\n.open-next\n", {
+        appendIf: (content) => !content.includes(".open-next"),
+        appendPrefix: "\n",
+    });
+    const nextConfig = findNextConfig({ appPath: projectDir });
+    // At this point the next config file should exist (it either
+    // was part of the original project or we've created it)
+    assert(nextConfig, "Next config file unexpectedly missing");
     printStepTitle("Updating Next.js config");
-    conditionalAppendFileSync(findNextConfig({ appPath: projectDir }), "\nimport('@opennextjs/cloudflare').then(m => m.initOpenNextCloudflareForDev());\n", (content) => !content.includes("initOpenNextCloudflareForDev"));
+    conditionalAppendFileSync(nextConfig.path, "import('@opennextjs/cloudflare').then(m => m.initOpenNextCloudflareForDev());\n", {
+        appendIf: (content) => !content.includes("initOpenNextCloudflareForDev"),
+        appendPrefix: "\n",
+    });
     printStepTitle("Checking for edge runtime usage");
     try {
         const extensions = [".ts", ".tsx", ".js", ".jsx", ".mjs", ".mts"];
@@ -158,6 +184,53 @@ function findFilesRecursive(dir, extensions, fileList = []) {
 function printStepTitle(title) {
     logger.info(`⚙️  ${title}...\n`);
 }
+/**
+ * Creates a plain next.config.ts file
+ *
+ * @param appDir The directory where the config file should be created
+ */
+function createNextConfigFile(appDir) {
+    const nextConfigPath = path.join(appDir, "next.config.ts");
+    const content = `import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {};
+
+export default nextConfig;
+`;
+    fs.writeFileSync(nextConfigPath, content);
+}
+/**
+ * Creates a next.config.ts file, after asking for the user's confirmation, if missing in the project's directory.
+ *
+ * To be safe, this function also ensures that the "next" package is installed and its version is compatible with OpenNext.
+ *
+ * @param projectDir The project directory to check
+ * @param skipNextVersionCheck Whether to bypass the "next" version compatibility check
+ * @returns A boolean representing whether the user has accepter the creation of the config file, undefined if the file already existed
+ * @throws {Error} If "next" is not installed or the Next.js version is incompatible with open-next
+ */
+async function maybeCreateNextConfigFileIfMissing(projectDir, skipNextVersionCheck) {
+    if (findNextConfig({ appPath: projectDir })) {
+        return;
+    }
+    let nextVersion;
+    try {
+        nextVersion = getNextVersion(projectDir);
+    }
+    catch {
+        throw new Error("This does not appear to be a Next.js application. The 'next' package is not installed and no next.config file was found.");
+    }
+    if (!skipNextVersionCheck) {
+        await ensureNextjsVersionSupported({ nextVersion });
+    }
+    const answer = await askConfirmation("Missing required next.config file. Do you want to create one?");
+    if (!answer) {
+        return false;
+    }
+    createNextConfigFile(projectDir);
+    logger.info("Created next.config.ts\n");
+    return true;
+}
 /**
  * Add the `migrate` command to yargs configuration.
  */

package/dist/cli/commands/populate-cache.js

@@ -219,8 +219,8 @@ function populateStaticAssetsIncrementalCache(options) {
  */
 export function addPopulateCacheCommand(y) {
     return y.command("populateCache", "Populate the cache for a built Next.js app", (c) => c
-        .command("local", "Local dev server cache", (c) => withPopulateCacheOptions(c), (args) => populateCacheCommand("local", withWranglerPassthroughArgs(args)))
-        .command("remote", "Remote Cloudflare Worker cache", (c) => withPopulateCacheOptions(c), (args) => populateCacheCommand("remote", withWranglerPassthroughArgs(args)))
+        .command("local [args..]", "Local dev server cache", (c) => withPopulateCacheOptions(c), (args) => populateCacheCommand("local", withWranglerPassthroughArgs(args)))
+        .command("remote [args..]", "Remote Cloudflare Worker cache", (c) => withPopulateCacheOptions(c), (args) => populateCacheCommand("remote", withWranglerPassthroughArgs(args)))
         .demandCommand(1, 1));
 }
 export function withPopulateCacheOptions(args) {

package/dist/cli/commands/preview.js

@@ -28,7 +28,7 @@ export async function previewCommand(args) {
  * Consumes 1 positional parameter.
  */
 export function addPreviewCommand(y) {
-    return y.command("preview", "Preview a built OpenNext app with a Wrangler dev server", (c) => withPopulateCacheOptions(c).option("remote", {
+    return y.command("preview [args..]", "Preview a built OpenNext app with a Wrangler dev server", (c) => withPopulateCacheOptions(c).option("remote", {
         type: "boolean",
         alias: "r",
         default: false,

package/dist/cli/commands/upload.js

@@ -40,5 +40,5 @@ export async function uploadCommand(args) {
  * Consumes 1 positional parameter.
  */
 export function addUploadCommand(y) {
-    return y.command("upload", "Upload a built OpenNext app to Cloudflare Workers", (c) => withPopulateCacheOptions(c), (args) => uploadCommand(withWranglerPassthroughArgs(args)));
+    return y.command("upload [args..]", "Upload a built OpenNext app to Cloudflare Workers", (c) => withPopulateCacheOptions(c), (args) => uploadCommand(withWranglerPassthroughArgs(args)));
 }

package/dist/cli/commands/utils.d.ts

@@ -1,3 +1,4 @@
+import * as buildHelper from "@opennextjs/aws/build/helper.js";
 import type yargs from "yargs";
 import type { OpenNextConfig } from "../../api/config.js";
 export type WithWranglerArgs<T = unknown> = T & {
@@ -12,6 +13,15 @@ export declare const nextAppDir: string;
  * @param command
  */
 export declare function printHeaders(command: string): void;
+/**
+ * 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>;
 /**
  * Compile the OpenNext config.
  *

package/dist/cli/commands/utils.js

@@ -4,6 +4,7 @@ import path from "node:path";
 import url from "node:url";
 import { compileOpenNextConfig } from "@opennextjs/aws/build/compileConfig.js";
 import { normalizeOptions } from "@opennextjs/aws/build/helper.js";
+import * as buildHelper from "@opennextjs/aws/build/helper.js";
 import { printHeader, showWarningOnWindows } from "@opennextjs/aws/build/utils.js";
 import logger from "@opennextjs/aws/logger.js";
 import { unstable_readConfig } from "wrangler";
@@ -18,6 +19,28 @@ export function printHeaders(command) {
     printHeader(`Cloudflare ${command}`);
     showWarningOnWindows();
 }
+/**
+ * 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).`);
+    }
+}
 /**
  * Compile the OpenNext config.
  *
@@ -120,8 +143,8 @@ function getWranglerArgs(args) {
         ...(args.config ? ["--config", args.config] : []),
         ...(args.env ? ["--env", args.env] : []),
         ...(args.remote ? ["--remote"] : []),
-        // Note: the first args in `_` will be the commands.
-        ...args._.slice(args._[0] === "populateCache" ? 2 : 1).map((a) => `${a}`),
+        // Note: the `args` array contains unrecognised flags.
+        ...(args.args?.map((a) => `${a}`) ?? []),
     ];
 }
 /**

package/dist/cli/index.js

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
+import logger from "@opennextjs/aws/logger.js";
 import yargs from "yargs";
+import { getVersion } from "./build/utils/version.js";
 import { addBuildCommand } from "./commands/build.js";
 import { addDeployCommand } from "./commands/deploy.js";
 import { addMigrateCommand } from "./commands/migrate.js";
@@ -9,7 +11,22 @@ import { addUploadCommand } from "./commands/upload.js";
 export function runCommand() {
     const y = yargs(process.argv.slice(2).filter((arg) => arg !== "--"))
         .scriptName("opennextjs-cloudflare")
-        .parserConfiguration({ "unknown-options-as-args": true });
+        .parserConfiguration({ "unknown-options-as-args": true })
+        .strictCommands()
+        .help()
+        .alias("h", "help")
+        .version(getVersion().cloudflare)
+        .alias("v", "version")
+        .fail((msg, err, yargs) => {
+        if (msg) {
+            logger.error(`${msg}\n`);
+        }
+        if (err) {
+            throw err;
+        }
+        yargs.showHelp();
+        process.exit(1);
+    });
     addBuildCommand(y);
     addPreviewCommand(y);
     addDeployCommand(y);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "1.16.3",
+  "version": "1.16.5",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"
@@ -44,7 +44,7 @@
   "dependencies": {
     "@ast-grep/napi": "^0.40.5",
     "@dotenvx/dotenvx": "1.31.0",
-    "@opennextjs/aws": "3.9.15",
+    "@opennextjs/aws": "3.9.16",
     "cloudflare": "^4.4.1",
     "enquirer": "^2.4.1",
     "glob": "^12.0.0",