@opennextjs/cloudflare 0.5.4 → 0.5.6

package/dist/api/config.d.ts

@@ -0,0 +1,56 @@
+import { OpenNextConfig } from "@opennextjs/aws/types/open-next";
+import type { IncrementalCache, Queue, TagCache } from "@opennextjs/aws/types/overrides";
+export type CloudflareConfigOptions = {
+    /**
+     * The incremental cache implementation to use, for more details see the [Caching documentation](https://opennext.js.org/cloudflare/caching))
+     *
+     * `@opennextjs/cloudflare` offers a kv incremental cache implementation ready
+     * to use which can be imported from `"@opennextjs/cloudflare/kv-cache"`
+     *
+     * @example
+     *   import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+     *   import kvIncrementalCache from "@opennextjs/cloudflare/kv-cache";
+     *
+     *   export default defineCloudflareConfig({
+     *     incrementalCache: kvIncrementalCache,
+     *   });
+     */
+    incrementalCache?: "dummy" | IncrementalCache | (() => IncrementalCache | Promise<IncrementalCache>);
+    /**
+     * The tag cache implementation to use, for more details see the [Caching documentation](https://opennext.js.org/cloudflare/caching))
+     *
+     * `@opennextjs/cloudflare` offers a d1 tag cache implementation ready
+     * to use which can be imported from `"@opennextjs/cloudflare/d1-tag-cache"`
+     *
+     * @example
+     *   import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+     *   import d1TagCache from "@opennextjs/cloudflare/d1-tag-cache";
+     *
+     *   export default defineCloudflareConfig({
+     *     tagCache: d1TagCache,
+     *   });
+     */
+    tagCache?: "dummy" | TagCache | (() => TagCache | Promise<TagCache>);
+    /**
+     * The revalidation queue implementation to use, for more details see the [Caching documentation](https://opennext.js.org/cloudflare/caching))
+     *
+     * `@opennextjs/cloudflare` offers an in memory queue implementation ready
+     * to use which can be imported from `"@opennextjs/cloudflare/memory-queue"`
+     *
+     * @example
+     *   import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+     *   import memoryQueue from "@opennextjs/cloudflare/memory-queue";
+     *
+     *   export default defineCloudflareConfig({
+     *     queue: memoryQueue,
+     *   });
+     */
+    queue?: "dummy" | "direct" | Queue | (() => Queue | Promise<Queue>);
+};
+/**
+ * Defines the OpenNext configuration that targets the Cloudflare adapter
+ *
+ * @param options options that enabled you to configure the application's behavior
+ * @returns the OpenNext configuration object
+ */
+export declare function defineCloudflareConfig(options?: CloudflareConfigOptions): OpenNextConfig;

package/dist/api/config.js

@@ -0,0 +1,37 @@
+/**
+ * Defines the OpenNext configuration that targets the Cloudflare adapter
+ *
+ * @param options options that enabled you to configure the application's behavior
+ * @returns the OpenNext configuration object
+ */
+export function defineCloudflareConfig(options = {}) {
+    const { incrementalCache, tagCache, queue } = options;
+    return {
+        default: {
+            override: {
+                wrapper: "cloudflare-node",
+                converter: "edge",
+                incrementalCache: resolveOverride(incrementalCache),
+                tagCache: resolveOverride(tagCache),
+                queue: resolveOverride(queue),
+            },
+        },
+        middleware: {
+            external: true,
+            override: {
+                wrapper: "cloudflare-edge",
+                converter: "edge",
+                proxyExternalRequest: "fetch",
+            },
+        },
+    };
+}
+function resolveOverride(value) {
+    if (!value || value === "dummy") {
+        return "dummy";
+    }
+    if (value === "direct") {
+        return "direct";
+    }
+    return (typeof value === "function" ? value : () => value);
+}

package/dist/api/d1-tag-cache.d.ts

@@ -1,4 +1,4 @@
-import type { TagCache } from "@opennextjs/aws/types/overrides.js";
+import type { OriginalTagCache } from "@opennextjs/aws/types/overrides.js";
 /**
  * An instance of the Tag Cache that uses a D1 binding (`NEXT_CACHE_D1`) as it's underlying data store.
  *
@@ -16,7 +16,7 @@ import type { TagCache } from "@opennextjs/aws/types/overrides.js";
  * and `revalidatedAt`. The table name can be configured with `NEXT_CACHE_D1_REVALIDATIONS_TABLE`
  * environment variable.
  */
-declare class D1TagCache implements TagCache {
+declare class D1TagCache implements OriginalTagCache {
     readonly name = "d1-tag-cache";
     getByPath(rawPath: string): Promise<string[]>;
     getByTag(rawTag: string): Promise<string[]>;

package/dist/api/index.d.ts

@@ -1 +1,2 @@
 export * from "./cloudflare-context.js";
+export { defineCloudflareConfig } from "./config.js";

package/dist/api/index.js

@@ -1 +1,2 @@
 export * from "./cloudflare-context.js";
+export { defineCloudflareConfig } from "./config.js";

package/dist/api/kvCache.d.ts

@@ -1,5 +1,5 @@
-import cache from "./kv-cache.js";
+import kvIncrementalCache from "./kv-cache.js";
 /**
  * @deprecated Please import from `kv-cache` instead of `kvCache`.
  */
-export default cache;
+export default kvIncrementalCache;

package/dist/api/kvCache.js

@@ -1,5 +1,5 @@
-import cache from "./kv-cache.js";
+import kvIncrementalCache from "./kv-cache.js";
 /**
  * @deprecated Please import from `kv-cache` instead of `kvCache`.
  */
-export default cache;
+export default kvIncrementalCache;

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

@@ -88,6 +88,11 @@ export async function bundleServer(buildOpts) {
         ],
         external: ["./middleware/handler.mjs"],
         alias: {
+            // Note: it looks like node-fetch is actually not necessary for us, so we could replace it with an empty shim
+            //       but just to be safe we replace it with a module that re-exports the native fetch
+            //       we do this to both save on bundle size (there isn't really any benefit in us shipping the node-fetch code)
+            //       and also get rid of a warning in the terminal caused by the package (because it performs an === comparison with -0)
+            "next/dist/compiled/node-fetch": path.join(buildOpts.outputDir, "cloudflare-templates/shims/fetch.js"),
             // Note: we apply an empty shim to next/dist/compiled/ws because it generates two `eval`s:
             //   eval("require")("bufferutil");
             //   eval("require")("utf-8-validate");
@@ -109,7 +114,7 @@ export async function bundleServer(buildOpts) {
             // Note: we need the __non_webpack_require__ variable declared as it is used by next-server:
             // https://github.com/vercel/next.js/blob/be0c3283/packages/next/src/server/next-server.ts#L116-L119
             __non_webpack_require__: "require",
-            // Ask mhart if he can explain why the `define`s below are necessary
+            // We make sure that environment variables that Next.js expects are properly defined
             "process.env.NEXT_RUNTIME": '"nodejs"',
             "process.env.NODE_ENV": '"production"',
             "process.env.NEXT_MINIMAL": "true",
@@ -117,10 +122,11 @@ export async function bundleServer(buildOpts) {
         platform: "node",
         banner: {
             js: `
-// __dirname is used by unbundled js files (which don't inherit the __dirname present in the define field)
+// Used by unbundled js files (which don't inherit the __dirname present in the define field)
 // so we also need to set it on the global scope
 // Note: this was hit in the next/dist/compiled/@opentelemetry/api module
 globalThis.__dirname ??= "";
+globalThis.__filename ??= "";
 
 // Do not crash on cache not supported
 // https://github.com/cloudflare/workerd/pull/2434

package/dist/cli/build/open-next/createServerBundle.js

@@ -11,6 +11,7 @@ import { installDependencies } from "@opennextjs/aws/build/installDeps.js";
 import logger from "@opennextjs/aws/logger.js";
 import { minifyAll } from "@opennextjs/aws/minimize-js.js";
 import { openNextEdgePlugins } from "@opennextjs/aws/plugins/edge.js";
+import { openNextExternalMiddlewarePlugin } from "@opennextjs/aws/plugins/externalMiddleware.js";
 import { openNextReplacementPlugin } from "@opennextjs/aws/plugins/replacement.js";
 import { openNextResolvePlugin } from "@opennextjs/aws/plugins/resolve.js";
 import { getCrossPlatformPathRegex } from "@opennextjs/aws/utils/regex.js";
@@ -103,7 +104,13 @@ async function generateBundle(name, options, fnOptions) {
     // Copy env files
     buildHelper.copyEnvFile(appBuildOutputPath, packagePath, outputPath);
     // Copy all necessary traced files
-    await copyTracedFiles(appBuildOutputPath, packagePath, outputPath, fnOptions.routes ?? ["app/page.tsx"], isBundled);
+    await copyTracedFiles({
+        buildOutputPath: appBuildOutputPath,
+        packagePath,
+        outputDir: outputPath,
+        routes: fnOptions.routes ?? ["app/page.tsx"],
+        bundledNextServer: isBundled,
+    });
     // Build Lambda code
     // note: bundle in OpenNext package b/c the adapter relies on the
     //       "serverless-http" package which is not a dependency in user's
@@ -136,9 +143,9 @@ async function generateBundle(name, options, fnOptions) {
             fnName: name,
             overrides,
         }),
+        openNextExternalMiddlewarePlugin(path.join(options.openNextDistDir, "core/edgeFunctionHandler.js")),
         openNextEdgePlugins({
             nextDir: path.join(options.appBuildOutputPath, ".next"),
-            edgeFunctionHandlerPath: path.join(options.openNextDistDir, "core", "edgeFunctionHandler.js"),
             isInCloudfare: true,
         }),
     ];

package/dist/cli/build/patches/ast/patch-vercel-og-library.js

@@ -13,7 +13,9 @@ export function patchVercelOgLibrary(buildOpts) {
     const { appBuildOutputPath, outputDir } = buildOpts;
     const functionsPath = path.join(outputDir, "server-functions/default");
     const packagePath = path.join(functionsPath, getPackagePath(buildOpts));
-    for (const traceInfoPath of globSync(path.join(appBuildOutputPath, ".next/server/**/*.nft.json"))) {
+    for (const traceInfoPath of globSync(path.join(appBuildOutputPath, ".next/server/**/*.nft.json"), {
+        windowsPathsNoEscape: true,
+    })) {
         const traceInfo = JSON.parse(readFileSync(traceInfoPath, { encoding: "utf8" }));
         const tracedNodePath = traceInfo.files.find((p) => p.endsWith("@vercel/og/index.node.js"));
         if (!tracedNodePath)

package/dist/cli/build/patches/plugins/eval-manifest.js

@@ -18,7 +18,9 @@ async function getRule(buildOpts) {
     const { outputDir } = buildOpts;
     const baseDir = join(outputDir, "server-functions/default", getPackagePath(buildOpts), ".next");
     const appDir = join(baseDir, "server/app");
-    const manifests = await glob(join(baseDir, "**/*_client-reference-manifest.js"));
+    const manifests = await glob(join(baseDir, "**/*_client-reference-manifest.js"), {
+        windowsPathsNoEscape: true,
+    });
     const returnManifests = manifests
         .map((manifest) => {
         const endsWith = normalizePath(relative(baseDir, manifest));

package/dist/cli/build/patches/plugins/load-manifest.js

@@ -18,7 +18,7 @@ async function getRule(buildOpts) {
     const { outputDir } = buildOpts;
     const baseDir = join(outputDir, "server-functions/default", getPackagePath(buildOpts));
     const dotNextDir = join(baseDir, ".next");
-    const manifests = await glob(join(dotNextDir, "**/*-manifest.json"));
+    const manifests = await glob(join(dotNextDir, "**/*-manifest.json"), { windowsPathsNoEscape: true });
     const returnManifests = (await Promise.all(manifests.map(async (manifest) => `
             if ($PATH.endsWith("${normalizePath("/" + relative(dotNextDir, manifest))}")) {
               return ${await readFile(manifest, "utf-8")};

package/dist/cli/templates/shims/fetch.d.ts

@@ -0,0 +1 @@
+export default fetch;

package/dist/cli/templates/shims/fetch.js

@@ -0,0 +1 @@
+export default fetch;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "0.5.4",
+  "version": "0.5.6",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"
@@ -63,7 +63,7 @@
   "dependencies": {
     "@ast-grep/napi": "^0.34.1",
     "@dotenvx/dotenvx": "1.31.0",
-    "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@748",
+    "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@756",
     "enquirer": "^2.4.1",
     "glob": "^11.0.0",
     "yaml": "^2.7.0"

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

@@ -1,26 +1,7 @@
 // default open-next.config.ts file created by @opennextjs/cloudflare
+import { defineCloudflareConfig } from "@opennextjs/cloudflare/dist/api/config";
+import kvIncrementalCache from "@opennextjs/cloudflare/dist/api/kv-cache";
 
-import cache from "@opennextjs/cloudflare/kv-cache";
-
-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",
-    },
-  },
-};
-
-export default config;
+export default defineCloudflareConfig({
+  incrementalCache: kvIncrementalCache,
+});