@astrojs/cloudflare 7.5.3 → 7.6.0

package/README.md

@@ -186,17 +186,25 @@ export default defineConfig({
 
 ### `runtime`
 
-`runtime: "off" | "local"`
+`runtime: { mode: "off" | "local", persistTo: string }`
 
-default `"off"`
+default `{ mode: 'off', persistTo: '' }`
 
 Determines whether and how the Cloudflare Runtime is added to `astro dev`.
 
 The Cloudflare Runtime includes [Cloudflare bindings](https://developers.cloudflare.com/pages/platform/functions/bindings), [environment variables](https://developers.cloudflare.com/pages/platform/functions/bindings/#environment-variables), and the [cf object](https://developers.cloudflare.com/workers/runtime-apis/request/#incomingrequestcfproperties). Read more about [accessing the Cloudflare Runtime](#cloudflare-runtime).
 
+The `mode` property defines how the runtime is added to `astro dev`:
+
 - `local`: uses bindings mocking and locally static placeholders
 - `off`: no access to the Cloudflare runtime using `astro dev`. You can alternatively use [Preview with Wrangler](#preview-with-wrangler)
 
+The `persistTo` property defines where the local runtime is persisted to when using `mode: local`. This value is a directory relative to your `astro dev` execution path.
+
+The default value is set to `.wrangler/state/v3` to match the default path Wrangler uses. This means both tools are able to access and use the local state.
+
+Whichever directory is set in `persistTo`, `.wrangler` or your custom value, must be added to `.gitignore`.
+
 ```diff lang="js"
 // astro.config.mjs
 import { defineConfig } from 'astro/config';
@@ -205,7 +213,7 @@ import cloudflare from '@astrojs/cloudflare';
 export default defineConfig({
   output: 'server',
   adapter: cloudflare({
-+   runtime: 'local',
++   runtime: { mode: 'local' },
   }),
 });
 ```

package/dist/entrypoints/server.advanced.d.ts

@@ -1,4 +1,4 @@
-import type { Request as CFRequest, CacheStorage, ExecutionContext } from '@cloudflare/workers-types';
+import type { CacheStorage, ExecutionContext, Request as CFRequest } from '@cloudflare/workers-types';
 import type { SSRManifest } from 'astro';
 type Env = {
     ASSETS: {

package/dist/entrypoints/server.advanced.js

@@ -1,48 +1,44 @@
-import { App } from "astro/app";
-import { getProcessEnvProxy, isNode } from "../util.js";
+import { App } from 'astro/app';
+import { getProcessEnvProxy, isNode } from '../util.js';
 if (!isNode) {
-  process.env = getProcessEnvProxy();
+    process.env = getProcessEnvProxy();
 }
-function createExports(manifest) {
-  const app = new App(manifest);
-  const fetch = async (request, env, context) => {
-    process.env = env;
-    const { pathname } = new URL(request.url);
-    if (manifest.assets.has(pathname)) {
-      return env.ASSETS.fetch(request);
-    }
-    let routeData = app.match(request, { matchNotFound: true });
-    if (routeData) {
-      Reflect.set(
-        request,
-        Symbol.for("astro.clientAddress"),
-        request.headers.get("cf-connecting-ip")
-      );
-      const locals = {
-        runtime: {
-          waitUntil: (promise) => {
-            context.waitUntil(promise);
-          },
-          env,
-          cf: request.cf,
-          caches
+export function createExports(manifest) {
+    const app = new App(manifest);
+    const fetch = async (request, env, context) => {
+        // TODO: remove this any cast in the future
+        // REF: the type cast to any is needed because the Cloudflare Env Type is not assignable to type 'ProcessEnv'
+        process.env = env;
+        const { pathname } = new URL(request.url);
+        // static assets fallback, in case default _routes.json is not used
+        if (manifest.assets.has(pathname)) {
+            return env.ASSETS.fetch(request);
         }
-      };
-      let response = await app.render(request, routeData, locals);
-      if (app.setCookieHeaders) {
-        for (const setCookieHeader of app.setCookieHeaders(response)) {
-          response.headers.append("Set-Cookie", setCookieHeader);
+        let routeData = app.match(request, { matchNotFound: true });
+        if (routeData) {
+            Reflect.set(request, Symbol.for('astro.clientAddress'), request.headers.get('cf-connecting-ip'));
+            const locals = {
+                runtime: {
+                    waitUntil: (promise) => {
+                        context.waitUntil(promise);
+                    },
+                    env: env,
+                    cf: request.cf,
+                    caches: caches,
+                },
+            };
+            let response = await app.render(request, routeData, locals);
+            if (app.setCookieHeaders) {
+                for (const setCookieHeader of app.setCookieHeaders(response)) {
+                    response.headers.append('Set-Cookie', setCookieHeader);
+                }
+            }
+            return response;
         }
-      }
-      return response;
-    }
-    return new Response(null, {
-      status: 404,
-      statusText: "Not found"
-    });
-  };
-  return { default: { fetch } };
+        return new Response(null, {
+            status: 404,
+            statusText: 'Not found',
+        });
+    };
+    return { default: { fetch } };
 }
-export {
-  createExports
-};

package/dist/entrypoints/server.directory.d.ts

@@ -1,4 +1,4 @@
-import type { Request as CFRequest, CacheStorage, EventContext } from '@cloudflare/workers-types';
+import type { CacheStorage, EventContext, Request as CFRequest } from '@cloudflare/workers-types';
 import type { SSRManifest } from 'astro';
 export interface DirectoryRuntime<T extends object = object> {
     runtime: {

package/dist/entrypoints/server.directory.js

@@ -1,50 +1,46 @@
-import { App } from "astro/app";
-import { getProcessEnvProxy, isNode } from "../util.js";
+import { App } from 'astro/app';
+import { getProcessEnvProxy, isNode } from '../util.js';
 if (!isNode) {
-  process.env = getProcessEnvProxy();
+    process.env = getProcessEnvProxy();
 }
-function createExports(manifest) {
-  const app = new App(manifest);
-  const onRequest = async (context) => {
-    const request = context.request;
-    const { env } = context;
-    process.env = env;
-    const { pathname } = new URL(request.url);
-    if (manifest.assets.has(pathname)) {
-      return env.ASSETS.fetch(request);
-    }
-    let routeData = app.match(request, { matchNotFound: true });
-    if (routeData) {
-      Reflect.set(
-        request,
-        Symbol.for("astro.clientAddress"),
-        request.headers.get("cf-connecting-ip")
-      );
-      const locals = {
-        runtime: {
-          waitUntil: (promise) => {
-            context.waitUntil(promise);
-          },
-          env: context.env,
-          cf: request.cf,
-          caches
+export function createExports(manifest) {
+    const app = new App(manifest);
+    const onRequest = async (context) => {
+        const request = context.request;
+        const { env } = context;
+        // TODO: remove this any cast in the future
+        // REF: the type cast to any is needed because the Cloudflare Env Type is not assignable to type 'ProcessEnv'
+        process.env = env;
+        const { pathname } = new URL(request.url);
+        // static assets fallback, in case default _routes.json is not used
+        if (manifest.assets.has(pathname)) {
+            return env.ASSETS.fetch(request);
         }
-      };
-      let response = await app.render(request, routeData, locals);
-      if (app.setCookieHeaders) {
-        for (const setCookieHeader of app.setCookieHeaders(response)) {
-          response.headers.append("Set-Cookie", setCookieHeader);
+        let routeData = app.match(request, { matchNotFound: true });
+        if (routeData) {
+            Reflect.set(request, Symbol.for('astro.clientAddress'), request.headers.get('cf-connecting-ip'));
+            const locals = {
+                runtime: {
+                    waitUntil: (promise) => {
+                        context.waitUntil(promise);
+                    },
+                    env: context.env,
+                    cf: request.cf,
+                    caches: caches,
+                },
+            };
+            let response = await app.render(request, routeData, locals);
+            if (app.setCookieHeaders) {
+                for (const setCookieHeader of app.setCookieHeaders(response)) {
+                    response.headers.append('Set-Cookie', setCookieHeader);
+                }
+            }
+            return response;
         }
-      }
-      return response;
-    }
-    return new Response(null, {
-      status: 404,
-      statusText: "Not found"
-    });
-  };
-  return { onRequest, manifest };
+        return new Response(null, {
+            status: 404,
+            statusText: 'Not found',
+        });
+    };
+    return { onRequest, manifest };
 }
-export {
-  createExports
-};

package/dist/getAdapter.js

@@ -1,36 +1,30 @@
-function getAdapter({
-  isModeDirectory,
-  functionPerRoute
-}) {
-  const astroFeatures = {
-    hybridOutput: "stable",
-    staticOutput: "unsupported",
-    serverOutput: "stable",
-    assets: {
-      supportKind: "stable",
-      isSharpCompatible: false,
-      isSquooshCompatible: false
+export function getAdapter({ isModeDirectory, functionPerRoute, }) {
+    const astroFeatures = {
+        hybridOutput: 'stable',
+        staticOutput: 'unsupported',
+        serverOutput: 'stable',
+        assets: {
+            supportKind: 'stable',
+            isSharpCompatible: false,
+            isSquooshCompatible: false,
+        },
+    };
+    if (isModeDirectory) {
+        return {
+            name: '@astrojs/cloudflare',
+            serverEntrypoint: '@astrojs/cloudflare/entrypoints/server.directory.js',
+            exports: ['onRequest', 'manifest'],
+            adapterFeatures: {
+                functionPerRoute,
+                edgeMiddleware: false,
+            },
+            supportedAstroFeatures: astroFeatures,
+        };
     }
-  };
-  if (isModeDirectory) {
     return {
-      name: "@astrojs/cloudflare",
-      serverEntrypoint: "@astrojs/cloudflare/entrypoints/server.directory.js",
-      exports: ["onRequest", "manifest"],
-      adapterFeatures: {
-        functionPerRoute,
-        edgeMiddleware: false
-      },
-      supportedAstroFeatures: astroFeatures
+        name: '@astrojs/cloudflare',
+        serverEntrypoint: '@astrojs/cloudflare/entrypoints/server.advanced.js',
+        exports: ['default'],
+        supportedAstroFeatures: astroFeatures,
     };
-  }
-  return {
-    name: "@astrojs/cloudflare",
-    serverEntrypoint: "@astrojs/cloudflare/entrypoints/server.advanced.js",
-    exports: ["default"],
-    supportedAstroFeatures: astroFeatures
-  };
 }
-export {
-  getAdapter
-};

package/dist/index.d.ts

@@ -18,11 +18,19 @@ type Options = {
         exclude?: string[];
     };
     /**
+     * Going forward only the object API should be used. The modes work as known before:
      * 'off': current behaviour (wrangler is needed)
      * 'local': use a static req.cf object, and env vars defined in wrangler.toml & .dev.vars (astro dev is enough)
      * 'remote': use a dynamic real-live req.cf object, and env vars defined in wrangler.toml & .dev.vars (astro dev is enough)
      */
-    runtime?: 'off' | 'local' | 'remote';
+    runtime?: 'off' | 'local' | 'remote' | {
+        mode: 'off';
+    } | {
+        mode: 'remote';
+    } | {
+        mode: 'local';
+        persistTo?: string;
+    };
     wasmModuleImports?: boolean;
 };
 export default function createIntegration(args?: Options): AstroIntegration;