@opennextjs/cloudflare 0.0.0-9758666 → 0.0.0-9aff12e

package/README.md

@@ -2,7 +2,7 @@
 
 Deploy Next.js apps to Cloudflare!
 
-OpenNext for Cloudflare is Cloudflare specific adapter that enables deployment of Next.js applications to Cloudflare.
+[OpenNext for Cloudflare](https://opennext.js.org/cloudflare) is Cloudflare specific adapter that enables deployment of Next.js applications to Cloudflare.
 
 ## Getting started
 
@@ -13,7 +13,13 @@ You can use [`create-next-app`](https://nextjs.org/docs/pages/api-reference/cli/
 - add the following `devDependencies` to the `package.json`:
 
   ```bash
+  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
@@ -27,9 +33,34 @@ You can use [`create-next-app`](https://nextjs.org/docs/pages/api-reference/cli/
   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:
@@ -41,13 +72,25 @@ Run the following commands to preview the production build of your application l
 - build the app and adapt it for Cloudflare
 
   ```bash
-  pnpx cloudflare
+  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
@@ -57,9 +100,11 @@ Deploy your application to production with the following:
 - build the app and adapt it for Cloudflare
 
   ```bash
-  pnpx cloudflare
-  ```
-
-  ```bash
-  pnpm wrangler deploy
+  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;
+    /**
+     * 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/{cache-handler.mjs → cli/cache-handler.mjs}

@@ -1,6 +1,6 @@
 import "./chunk-UJCSKKID.mjs";
 
-// src/cache-handler.ts
+// src/cli/cache-handler.ts
 var CfWorkersKvCacheHandler = class _CfWorkersKvCacheHandler {
   constructor(ctx) {
     this.ctx = ctx;
@@ -18,7 +18,7 @@ var CfWorkersKvCacheHandler = class _CfWorkersKvCacheHandler {
       return null;
     }
   }
-  async set(key, entry, ctx) {
+  async set(key, entry, _ctx) {
     if (_CfWorkersKvCacheHandler.maybeKVNamespace === void 0) {
       return;
     }