@opennextjs/cloudflare 0.3.1 → 0.3.3

package/dist/cli/build/bundle-server.d.ts

@@ -4,3 +4,10 @@ import { Config } from "../config.js";
  * Bundle the Open Next server.
  */
 export declare function bundleServer(config: Config, openNextOptions: BuildOptions): Promise<void>;
+/**
+ * Gets the path of the worker.js file generated by the build process
+ *
+ * @param openNextOptions the open-next build options
+ * @returns the path of the worker.js file that the build process generates
+ */
+export declare function getOutputWorkerPath(openNextOptions: BuildOptions): string;

package/dist/cli/build/bundle-server.js

@@ -82,13 +82,12 @@ fetch = globalThis.fetch;
 const CustomRequest = class extends globalThis.Request {
   constructor(input, init) {
     if (init) {
-      init = {
-        ...init,
-        cache: undefined,
-        // https://github.com/cloudflare/workerd/issues/2746
-        // https://github.com/cloudflare/workerd/issues/3245
-        body: init.body instanceof __cf_stream.Readable ? ReadableStream.from(init.body) : init.body,
-      };
+      delete init.cache;
+      // https://github.com/cloudflare/workerd/issues/2746
+      // https://github.com/cloudflare/workerd/issues/3245
+      Object.defineProperty(init, "body", {
+        value: init.body instanceof __cf_stream.Readable ? ReadableStream.from(init.body) : init.body;
+      });
     }
     super(input, init);
   }
@@ -107,7 +106,7 @@ globalThis.__BUILD_TIMESTAMP_MS__ = ${Date.now()};
         const packagePosixPath = packagePath.split(path.sep).join(path.posix.sep);
         fs.writeFileSync(path.join(outputPath, "handler.mjs"), `export * from "./${packagePosixPath}/handler.mjs";`);
     }
-    console.log(`\x1b[35mWorker saved in \`${openNextServerBundle}\` 🚀\n\x1b[0m`);
+    console.log(`\x1b[35mWorker saved in \`${getOutputWorkerPath(openNextOptions)}\` 🚀\n\x1b[0m`);
 }
 /**
  * This function applies string replacements on the bundled worker code necessary to get it to run in workerd
@@ -186,3 +185,12 @@ async function patchCodeWithValidations(code, patches) {
     console.log(`All ${patches.length} patches applied\n`);
     return patchedCode;
 }
+/**
+ * Gets the path of the worker.js file generated by the build process
+ *
+ * @param openNextOptions the open-next build options
+ * @returns the path of the worker.js file that the build process generates
+ */
+export function getOutputWorkerPath(openNextOptions) {
+    return path.join(openNextOptions.outputDir, "worker.js");
+}

package/dist/cli/build/index.js

@@ -1,4 +1,4 @@
-import { cpSync } from "node:fs";
+import { cpSync, existsSync } from "node:fs";
 import { createRequire } from "node:module";
 import { dirname, join } from "node:path";
 import { buildNextjsApp, setStandaloneBuildMode } from "@opennextjs/aws/build/buildNextApp.js";
@@ -9,7 +9,9 @@ import { createMiddleware } from "@opennextjs/aws/build/createMiddleware.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 { getPackageTemplatesDirPath } from "../../utils/get-package-templates-dir-path.js";
 import { containsDotNextDir, getConfig } from "../config.js";
+import { askConfirmation } from "../utils/ask-confirmation.js";
 import { bundleServer } from "./bundle-server.js";
 import { compileEnvFiles } from "./open-next/compile-env-files.js";
 import { copyCacheAssets } from "./open-next/copyCacheAssets.js";
@@ -27,6 +29,7 @@ export async function build(projectOpts) {
     const baseDir = projectOpts.sourceDir;
     const require = createRequire(import.meta.url);
     const openNextDistDir = dirname(require.resolve("@opennextjs/aws/index.js"));
+    await createOpenNextConfigIfNotExistent(projectOpts);
     const { config, buildDir } = await compileOpenNextConfig(baseDir);
     ensureCloudflareConfig(config);
     // Initialize options
@@ -75,6 +78,23 @@ export async function build(projectOpts) {
     await bundleServer(projConfig, options);
     logger.info("OpenNext build complete.");
 }
+/**
+ * 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 projectOpts The options for the project
+ */
+async function createOpenNextConfigIfNotExistent(projectOpts) {
+    const openNextConfigPath = join(projectOpts.sourceDir, "open-next.config.ts");
+    if (!existsSync(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!");
+        }
+        cpSync(join(getPackageTemplatesDirPath(), "defaults", "open-next.config.ts"), openNextConfigPath);
+    }
+}
 /**
  * Ensures open next is configured for cloudflare.
  *
@@ -94,30 +114,30 @@ function ensureCloudflareConfig(config) {
         mwUseFetchProxy: config.middleware?.override?.proxyExternalRequest === "fetch",
     };
     if (Object.values(requirements).some((satisfied) => !satisfied)) {
-        throw new Error(`open-next.config.ts should contain:
-{
-  default: {
-    override: {
-      wrapper: "cloudflare-node",
-      converter: "edge",
-      incrementalCache: "dummy" | function,
-      tagCache: "dummy",
-      queue: "dummy",
-    },
-  },
+        throw new Error("The `open-next.config.ts` should have a default export like this:\n\n" +
+            `{
+          default: {
+            override: {
+              wrapper: "cloudflare-node",
+              converter: "edge",
+              incrementalCache: "dummy" | function,
+              tagCache: "dummy",
+              queue: "dummy",
+            },
+          },
 
-  middleware: {
-    external: true,
-    override: {
-      wrapper: "cloudflare-edge",
-      converter: "edge",
-      proxyExternalRequest: "fetch",
-    },
-  },
+          middleware: {
+            external: true,
+            override: {
+              wrapper: "cloudflare-edge",
+              converter: "edge",
+              proxyExternalRequest: "fetch",
+            },
+          },
 
-  "dangerous": {
-    "enableCacheInterception": false
-  }
-}`);
+          "dangerous": {
+            "enableCacheInterception": false
+          },
+        }\n\n`.replace(/^ {8}/gm, ""));
     }
 }

package/dist/cli/build/patches/investigated/copy-package-cli-files.d.ts

@@ -3,4 +3,4 @@ import { Config } from "../../../config.js";
 /**
  * Copies the template files present in the cloudflare adapter package into the standalone node_modules folder
  */
-export declare function copyPackageCliFiles(packageDistDir: string, config: Config, openNextConfig: BuildOptions): void;
+export declare function copyPackageCliFiles(packageDistDir: string, config: Config, openNextOptions: BuildOptions): void;

package/dist/cli/build/patches/investigated/copy-package-cli-files.js

@@ -1,12 +1,13 @@
 import fs from "node:fs";
 import path from "node:path";
+import { getOutputWorkerPath } from "../../bundle-server.js";
 /**
  * Copies the template files present in the cloudflare adapter package into the standalone node_modules folder
  */
-export function copyPackageCliFiles(packageDistDir, config, openNextConfig) {
+export function copyPackageCliFiles(packageDistDir, config, openNextOptions) {
     console.log("# copyPackageTemplateFiles");
     const sourceDir = path.join(packageDistDir, "cli");
     const destinationDir = path.join(config.paths.internal.package, "cli");
     fs.cpSync(sourceDir, destinationDir, { recursive: true });
-    fs.copyFileSync(path.join(packageDistDir, "cli", "templates", "worker.js"), path.join(openNextConfig.outputDir, "worker.js"));
+    fs.copyFileSync(path.join(packageDistDir, "cli", "templates", "worker.js"), getOutputWorkerPath(openNextOptions));
 }

package/dist/cli/utils/ask-confirmation.d.ts

@@ -0,0 +1 @@
+export declare function askConfirmation(message: string): Promise<boolean>;

package/dist/cli/utils/ask-confirmation.js

@@ -0,0 +1,13 @@
+import Enquirer from "enquirer";
+export async function askConfirmation(message) {
+    const questionName = crypto.randomUUID();
+    const enquirerAnswersObject = await Enquirer.prompt({
+        name: questionName,
+        message,
+        type: "confirm",
+        initial: "y",
+    });
+    console.log("");
+    const answer = !!enquirerAnswersObject[questionName];
+    return answer;
+}

package/dist/utils/get-package-templates-dir-path.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Utility for getting the resolved path to the package's templates directory
+ *
+ * @returns the resolved path of the templates directory
+ */
+export declare function getPackageTemplatesDirPath(): string;

package/dist/utils/get-package-templates-dir-path.js

@@ -0,0 +1,10 @@
+import * as path from "node:path";
+const templatesDirPath = path.resolve(`${import.meta.dirname}/../../templates`);
+/**
+ * Utility for getting the resolved path to the package's templates directory
+ *
+ * @returns the resolved path of the templates directory
+ */
+export function getPackageTemplatesDirPath() {
+    return templatesDirPath;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"
@@ -22,7 +22,8 @@
   },
   "files": [
     "README.md",
-    "dist"
+    "dist",
+    "templates"
   ],
   "repository": {
     "type": "git",
@@ -63,7 +64,8 @@
     "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@684",
     "glob": "^11.0.0",
     "rimraf": "^6.0.1",
-    "ts-morph": "^23.0.0"
+    "ts-morph": "^23.0.0",
+    "enquirer": "^2.4.1"
   },
   "peerDependencies": {
     "wrangler": "^3.99.0"

package/templates/defaults/open-next.config.ts

@@ -0,0 +1,30 @@
+// default open-next.config.ts file created by @opennextjs/cloudflare
+
+import cache from "@opennextjs/cloudflare/kvCache";
+
+const config = {
+  default: {
+    override: {
+      wrapper: "cloudflare-node",
+      converter: "edge",
+      incrementalCache: async () => cache,
+      tagCache: "dummy",
+      queue: "dummy",
+    },
+  },
+
+  middleware: {
+    external: true,
+    override: {
+      wrapper: "cloudflare-edge",
+      converter: "edge",
+      proxyExternalRequest: "fetch",
+    },
+  },
+
+  dangerous: {
+    enableCacheInterception: false,
+  },
+};
+
+export default config;