@opennextjs/cloudflare 0.0.0-fd3c2b9 → 0.0.3

package/README.md

@@ -1,37 +1,110 @@
-# Next.js builder for Cloudflare
+# OpenNext for Cloudflare
 
-## Configure your app
+Deploy Next.js apps to Cloudflare!
 
-- add the following `devDependency` to the `package.json`:
+[OpenNext for Cloudflare](https://opennext.js.org/cloudflare) is Cloudflare specific adapter that enables deployment of Next.js applications to Cloudflare.
 
-  ```bash
-  pnpm add -D wrangler@latest @opennextjs/cloudflare
-  ```
+## Getting started
 
-## Serve your app
+You can use [`create-next-app`](https://nextjs.org/docs/pages/api-reference/cli/create-next-app) to start a new application or take an existing Next.js application and deploy it to Cloudflare using the following few steps:
 
-- build the app and adapt it for Cloudflare
+## Configure your app
+
+- add the following `devDependencies` to the `package.json`:
 
   ```bash
-  pnpx cloudflare
+  npm add -D wrangler@latest @opennextjs/cloudflare
+  # or
+  pnpm add -D wrangler@latest @opennextjs/cloudflare
+  # or
+  yarn add -D wrangler@latest @opennextjs/cloudflare
+  # or
+  bun add -D wrangler@latest @opennextjs/cloudflare
   ```
 
 - add a `wrangler.toml` at the root of your project
 
   ```toml
   #:schema node_modules/wrangler/config-schema.json
-  name = "<app-name>"
+  name = "<your-app-name>"
   main = ".worker-next/index.mjs"
 
-  compatibility_date = "2024-08-29"
-  compatibility_flags = ["nodejs_compat_v2"]
+  compatibility_date = "2024-09-23"
+  compatibility_flags = ["nodejs_compat"]
 
   # Use the new Workers + Assets to host the static frontend files
-  experimental_assets = { directory = ".worker-next/assets", binding = "ASSETS" }
+  assets = { directory = ".worker-next/assets", binding = "ASSETS" }
+  ```
+
+You can enable Incremental Static Regeneration ([ISR](https://nextjs.org/docs/app/building-your-application/data-fetching/incremental-static-regeneration)) by adding a KV binding named `NEXT_CACHE_WORKERS_KV` to your `wrangler.toml`:
+
+- Create the binding
+
+  ```bash
+  npx wrangler kv namespace create NEXT_CACHE_WORKERS_KV
+  # or
+  pnpm wrangler kv namespace create NEXT_CACHE_WORKERS_KV
+  # or
+  yarn wrangler kv namespace create NEXT_CACHE_WORKERS_KV
+  # or
+  bun wrangler kv namespace create NEXT_CACHE_WORKERS_KV
+  ```
+
+- Paste the snippet to your `wrangler.toml`:
+
+  ```bash
+  [[kv_namespaces]]
+  binding = "NEXT_CACHE_WORKERS_KV"
+  id = "..."
+  ```
+
+> [!WARNING]
+> The current support for ISR is limited.
+
+## Local development
+
+- you can use the regular `next` CLI to start the Next.js dev server:
+
+## Local preview
+
+Run the following commands to preview the production build of your application locally:
+
+- build the app and adapt it for Cloudflare
+
+  ```bash
+  npx cloudflare
+  # or
+  pnpm cloudflare
+  # or
+  yarn cloudflare
+  # or
+  bun cloudflare
   ```
 
 - Preview the app in Wrangler
 
   ```bash
+  npx wrangler dev
+  # or
   pnpm wrangler dev
+  # or
+  yarn wrangler dev
+  # or
+  bun wrangler dev
+  ```
+
+## Deploy your app
+
+Deploy your application to production with the following:
+
+- build the app and adapt it for Cloudflare
+
+  ```bash
+  npx cloudflare && npx wrangler deploy
+  # or
+  pnpm cloudflare && pnpm wrangler deploy
+  # or
+  yarn cloudflare && yarn wrangler deploy
+  # or
+  bun cloudflare && bun wrangler deploy
   ```

package/dist/api/chunk-VTBEIZPQ.mjs

@@ -0,0 +1,32 @@
+// src/api/get-cloudflare-context.ts
+import "server-only";
+var cloudflareContextSymbol = Symbol.for("__cloudflare-context__");
+async function getCloudflareContext() {
+  const global = globalThis;
+  const cloudflareContext = global[cloudflareContextSymbol];
+  if (!cloudflareContext) {
+    return getCloudflareContextInNextDev();
+  }
+  return cloudflareContext;
+}
+var cloudflareContextInNextDevSymbol = Symbol.for("__next-dev/cloudflare-context__");
+async function getCloudflareContextInNextDev() {
+  const global = globalThis;
+  if (!global[cloudflareContextInNextDevSymbol]) {
+    const { getPlatformProxy } = await import(
+      /* webpackIgnore: true */
+      `${"__wrangler".replaceAll("_", "")}`
+    );
+    const { env, cf, ctx } = await getPlatformProxy();
+    global[cloudflareContextInNextDevSymbol] = {
+      env,
+      cf,
+      ctx
+    };
+  }
+  return global[cloudflareContextInNextDevSymbol];
+}
+
+export {
+  getCloudflareContext
+};

package/dist/api/get-cloudflare-context.d.mts

@@ -0,0 +1,26 @@
+declare global {
+    interface CloudflareEnv {
+    }
+}
+type CloudflareContext<CfProperties extends Record<string, unknown> = IncomingRequestCfProperties, Context = ExecutionContext> = {
+    /**
+     * the worker's [bindings](https://developers.cloudflare.com/workers/runtime-apis/bindings/)
+     */
+    env: CloudflareEnv;
+    /**
+     * the request's [cf properties](https://developers.cloudflare.com/workers/runtime-apis/request/#the-cf-property-requestinitcfproperties)
+     */
+    cf: CfProperties | undefined;
+    /**
+     * the current [execution context](https://developers.cloudflare.com/workers/runtime-apis/context)
+     */
+    ctx: Context;
+};
+/**
+ * Utility to get the current Cloudflare context
+ *
+ * @returns the cloudflare context
+ */
+declare function getCloudflareContext<CfProperties extends Record<string, unknown> = IncomingRequestCfProperties, Context = ExecutionContext>(): Promise<CloudflareContext<CfProperties, Context>>;
+
+export { type CloudflareContext, getCloudflareContext };

package/dist/api/get-cloudflare-context.mjs

@@ -0,0 +1,6 @@
+import {
+  getCloudflareContext
+} from "./chunk-VTBEIZPQ.mjs";
+export {
+  getCloudflareContext
+};

package/dist/api/index.d.mts

@@ -0,0 +1 @@
+export { CloudflareContext, getCloudflareContext } from './get-cloudflare-context.mjs';

package/dist/api/index.mjs

@@ -0,0 +1,6 @@
+import {
+  getCloudflareContext
+} from "./chunk-VTBEIZPQ.mjs";
+export {
+  getCloudflareContext
+};

package/dist/cli/cache-handler/index.mjs

@@ -0,0 +1,20 @@
+import {
+  NEXT_BODY_SUFFIX,
+  NEXT_DATA_SUFFIX,
+  NEXT_HTML_SUFFIX,
+  NEXT_META_SUFFIX,
+  OpenNextCacheHandler,
+  RSC_PREFETCH_SUFFIX,
+  RSC_SUFFIX,
+  SEED_DATA_DIR
+} from "../chunk-F7LECSR5.mjs";
+export {
+  NEXT_BODY_SUFFIX,
+  NEXT_DATA_SUFFIX,
+  NEXT_HTML_SUFFIX,
+  NEXT_META_SUFFIX,
+  OpenNextCacheHandler,
+  RSC_PREFETCH_SUFFIX,
+  RSC_SUFFIX,
+  SEED_DATA_DIR
+};

package/dist/cli/chunk-F7LECSR5.mjs

@@ -0,0 +1,160 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/cli/cache-handler/constants.ts
+var RSC_PREFETCH_SUFFIX = ".prefetch.rsc";
+var RSC_SUFFIX = ".rsc";
+var NEXT_DATA_SUFFIX = ".json";
+var NEXT_META_SUFFIX = ".meta";
+var NEXT_BODY_SUFFIX = ".body";
+var NEXT_HTML_SUFFIX = ".html";
+var SEED_DATA_DIR = "cdn-cgi/_cf_seed_data";
+
+// src/cli/cache-handler/utils.ts
+async function getAsset(key, cb) {
+  const resp = await process.env.ASSETS.fetch(key);
+  return resp.status === 200 ? await cb(resp) : void 0;
+}
+function getSeedBodyFile(key, suffix) {
+  return getAsset(key + suffix, (resp) => resp.arrayBuffer());
+}
+function getSeedTextFile(key, suffix) {
+  return getAsset(key + suffix, (resp) => resp.text());
+}
+function getSeedMetaFile(key) {
+  return getAsset(key + NEXT_META_SUFFIX, (resp) => resp.json());
+}
+function parseCtx(ctx = {}) {
+  return { ...ctx, kind: ctx?.kindHint?.toUpperCase() };
+}
+
+// src/cli/cache-handler/open-next-cache-handler.ts
+var OpenNextCacheHandler = class _OpenNextCacheHandler {
+  constructor(ctx) {
+    this.ctx = ctx;
+  }
+  static maybeKVNamespace = void 0;
+  debug = !!process.env.NEXT_PRIVATE_DEBUG_CACHE;
+  async get(...args) {
+    const [key, _ctx] = args;
+    const ctx = parseCtx(_ctx);
+    if (this.debug) console.log(`cache - get: ${key}, ${ctx?.kind}`);
+    if (_OpenNextCacheHandler.maybeKVNamespace !== void 0) {
+      try {
+        const value = await _OpenNextCacheHandler.maybeKVNamespace.get(key, "json");
+        if (value) return value;
+      } catch (e) {
+        console.error(`Failed to get value for key = ${key}: ${e}`);
+      }
+    }
+    if (ctx?.kind === "FETCH" || ctx?.kind === "IMAGE") return null;
+    const seedKey = `http://assets.local/${SEED_DATA_DIR}/${key}`.replace(/\/\//g, "/");
+    if (ctx?.kind === "APP" || ctx?.kind === "APP_ROUTE") {
+      const fallbackBody = await getSeedBodyFile(seedKey, NEXT_BODY_SUFFIX);
+      if (fallbackBody) {
+        const meta = await getSeedMetaFile(seedKey);
+        return {
+          lastModified: meta?.lastModified,
+          value: {
+            kind: ctx.kind === "APP_ROUTE" ? ctx.kind : "ROUTE",
+            body: fallbackBody,
+            status: meta?.status ?? 200,
+            headers: meta?.headers ?? {}
+          }
+        };
+      }
+      if (ctx.kind === "APP_ROUTE") {
+        return null;
+      }
+    }
+    const seedHtml = await getSeedTextFile(seedKey, NEXT_HTML_SUFFIX);
+    if (!seedHtml) return null;
+    if (ctx?.kind === "PAGES" || ctx?.kind === "APP" || ctx?.kind === "APP_PAGE") {
+      const metaPromise = getSeedMetaFile(seedKey);
+      let pageDataPromise = Promise.resolve(void 0);
+      if (!ctx.isFallback) {
+        const rscSuffix = ctx.isRoutePPREnabled ? RSC_PREFETCH_SUFFIX : RSC_SUFFIX;
+        if (ctx.kind === "APP_PAGE") {
+          pageDataPromise = getSeedBodyFile(seedKey, rscSuffix);
+        } else {
+          pageDataPromise = getSeedTextFile(seedKey, ctx.kind === "APP" ? rscSuffix : NEXT_DATA_SUFFIX);
+        }
+      }
+      const [meta, pageData] = await Promise.all([metaPromise, pageDataPromise]);
+      return {
+        lastModified: meta?.lastModified,
+        value: {
+          kind: ctx.kind === "APP_PAGE" ? "APP_PAGE" : "PAGE",
+          html: seedHtml,
+          pageData: pageData ?? "",
+          ...ctx.kind === "APP_PAGE" && { rscData: pageData },
+          postponed: meta?.postponed,
+          status: meta?.status,
+          headers: meta?.headers
+        }
+      };
+    }
+    return null;
+  }
+  async set(...args) {
+    const [key, entry, _ctx] = args;
+    if (_OpenNextCacheHandler.maybeKVNamespace === void 0) {
+      return;
+    }
+    if (this.debug) console.log(`cache - set: ${key}`);
+    const data = {
+      lastModified: Date.now(),
+      value: entry
+    };
+    try {
+      await _OpenNextCacheHandler.maybeKVNamespace.put(key, JSON.stringify(data));
+    } catch (e) {
+      console.error(`Failed to set value for key = ${key}: ${e}`);
+    }
+  }
+  async revalidateTag(...args) {
+    const [tags] = args;
+    if (_OpenNextCacheHandler.maybeKVNamespace === void 0) {
+      return;
+    }
+    if (this.debug) console.log(`cache - revalidateTag: ${JSON.stringify([tags].flat())}`);
+  }
+  resetRequestCache() {
+  }
+};
+
+export {
+  __commonJS,
+  __toESM,
+  RSC_PREFETCH_SUFFIX,
+  RSC_SUFFIX,
+  NEXT_DATA_SUFFIX,
+  NEXT_META_SUFFIX,
+  NEXT_BODY_SUFFIX,
+  NEXT_HTML_SUFFIX,
+  SEED_DATA_DIR,
+  OpenNextCacheHandler
+};