@opennextjs/cloudflare 0.0.0-fd3c2b9 → 0.1.0

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/constants/incremental-cache.ts

@@ -0,0 +1,8 @@
+export const RSC_PREFETCH_SUFFIX = ".prefetch.rsc";
+export const RSC_SUFFIX = ".rsc";
+export const NEXT_DATA_SUFFIX = ".json";
+export const NEXT_META_SUFFIX = ".meta";
+export const NEXT_BODY_SUFFIX = ".body";
+export const NEXT_HTML_SUFFIX = ".html";
+
+export const SEED_DATA_DIR = "cdn-cgi/_cf_seed_data";