@astrojs/cloudflare 6.7.0 → 6.8.1

package/README.md

@@ -73,16 +73,61 @@ It's then possible to update the preview script in your `package.json` to `"prev
 
 ## Access to the Cloudflare runtime
 
-You can access all the Cloudflare bindings and environment variables from Astro components and API routes through the adapter API.
+You can access all the Cloudflare bindings and environment variables from Astro components and API routes through `Astro.locals`.
+
+If you're inside an `.astro` file, you access the runtime using the `Astro.locals` global:
+
+```astro
+const env = Astro.locals.runtime.env;
+```
+
+From an endpoint:
 
 ```js
-import { getRuntime } from '@astrojs/cloudflare/runtime';
+// src/pages/api/someFile.js
+export function get(context) {
+  const runtime = context.locals.runtime;
 
-getRuntime(Astro.request);
+  return new Response('Some body');
+}
 ```
 
 Depending on your adapter mode (advanced = worker, directory = pages), the runtime object will look a little different due to differences in the Cloudflare API.
 
+If you're using the `advanced` runtime, you can type the `runtime` object as following:
+
+```ts
+// src/env.d.ts
+/// <reference types="astro/client" />
+import type { AdvancedRuntime } from '@astrojs/cloudflare';
+
+declare namespace App {
+  interface Locals extends AdvancedRuntime {
+    user: {
+      name: string;
+      surname: string;
+    };
+  }
+}
+```
+
+If you're using the `directory` runtime, you can type the `runtime` object as following:
+
+```ts
+// src/env.d.ts
+/// <reference types="astro/client" />
+import type { DirectoryRuntime } from '@astrojs/cloudflare';
+
+declare namespace App {
+  interface Locals extends DirectoryRuntime {
+    user: {
+      name: string;
+      surname: string;
+    };
+  }
+}
+```
+
 ## Environment Variables
 
 See Cloudflare's documentation for [working with environment variables](https://developers.cloudflare.com/pages/platform/functions/bindings/#environment-variables).

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import type { AstroAdapter, AstroIntegration } from 'astro';
+export type { AdvancedRuntime } from './server.advanced';
+export type { DirectoryRuntime } from './server.directory';
 type Options = {
     mode: 'directory' | 'advanced';
 };
 export declare function getAdapter(isModeDirectory: boolean): AstroAdapter;
 export default function createIntegration(args?: Options): AstroIntegration;
-export {};

package/dist/runtime.d.ts

@@ -22,4 +22,14 @@ export type PagesRuntime<T = unknown, U = unknown> = {
     };
     cf?: IncomingRequestCfProperties;
 };
+/**
+ * @deprecated since version 6.8.0
+ * The `getRuntime` utility has been deprecated and should be updated to the new [`Astro.locals`](https://docs.astro.build/en/guides/middleware/#locals) API.
+ * ```diff
+ * - import { getRuntime } from '@astrojs/cloudflare/runtime';
+ * - getRuntime(Astro.request);
+ *
+ * + const runtime = Astro.locals.runtime;
+ * ```
+ */
 export declare function getRuntime<T = unknown, U = unknown>(request: Request): WorkerRuntime<T> | PagesRuntime<T, U>;

package/dist/server.advanced.d.ts

@@ -6,6 +6,14 @@ type Env = {
     };
     name: string;
 };
+export interface AdvancedRuntime {
+    runtime: {
+        waitUntil: (promise: Promise<any>) => void;
+        env: Env;
+        cf: CFRequest['cf'];
+        caches: typeof caches;
+    };
+}
 export declare function createExports(manifest: SSRManifest): {
     default: {
         fetch: (request: Request & CFRequest, env: Env, context: ExecutionContext) => Promise<Response>;

package/dist/server.advanced.js

@@ -28,7 +28,17 @@ function createExports(manifest) {
           context.waitUntil(promise);
         }
       });
-      let response = await app.render(request, routeData);
+      const locals = {
+        runtime: {
+          waitUntil: (promise) => {
+            context.waitUntil(promise);
+          },
+          env,
+          cf: request.cf,
+          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);

package/dist/server.directory.d.ts

@@ -1,10 +1,14 @@
 import type { Request as CFRequest, EventContext } from '@cloudflare/workers-types';
 import type { SSRManifest } from 'astro';
+export interface DirectoryRuntime {
+    runtime: {
+        waitUntil: (promise: Promise<any>) => void;
+        env: EventContext<unknown, string, unknown>['env'];
+        cf: CFRequest['cf'];
+        caches: typeof caches;
+    };
+}
 export declare function createExports(manifest: SSRManifest): {
-    onRequest: ({ request, next, ...runtimeEnv }: {
-        request: Request & CFRequest;
-        next: (request: Request) => void;
-        waitUntil: EventContext<unknown, any, unknown>['waitUntil'];
-    } & Record<string, unknown>) => Promise<import("@cloudflare/workers-types").Response | Response>;
+    onRequest: (context: EventContext<unknown, string, unknown>) => Promise<import("@cloudflare/workers-types").Response | Response>;
     manifest: SSRManifest;
 };

package/dist/server.directory.js

@@ -5,17 +5,13 @@ if (!isNode) {
 }
 function createExports(manifest) {
   const app = new App(manifest);
-  const onRequest = async ({
-    request,
-    next,
-    ...runtimeEnv
-  }) => {
-    process.env = runtimeEnv.env;
+  const onRequest = async (context) => {
+    const request = context.request;
+    const { next, env } = context;
+    process.env = env;
     const { pathname } = new URL(request.url);
     if (manifest.assets.has(pathname)) {
-      return runtimeEnv.env.ASSETS.fetch(
-        request
-      );
+      return env.ASSETS.fetch(request);
     }
     let routeData = app.match(request, { matchNotFound: true });
     if (routeData) {
@@ -25,16 +21,26 @@ function createExports(manifest) {
         request.headers.get("cf-connecting-ip")
       );
       Reflect.set(request, Symbol.for("runtime"), {
-        ...runtimeEnv,
+        ...context,
         waitUntil: (promise) => {
-          runtimeEnv.waitUntil(promise);
+          context.waitUntil(promise);
         },
         name: "cloudflare",
         next,
         caches,
         cf: request.cf
       });
-      let response = await app.render(request, routeData);
+      const locals = {
+        runtime: {
+          waitUntil: (promise) => {
+            context.waitUntil(promise);
+          },
+          env: context.env,
+          cf: request.cf,
+          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);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/cloudflare",
   "description": "Deploy your site to Cloudflare Workers/Pages",
-  "version": "6.7.0",
+  "version": "6.8.1",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -38,14 +38,15 @@
     "tiny-glob": "^0.2.9"
   },
   "peerDependencies": {
-    "astro": "^2.10.5"
+    "astro": "^2.10.14"
   },
   "devDependencies": {
     "chai": "^4.3.7",
     "cheerio": "1.0.0-rc.12",
+    "kill-port": "^2.0.1",
     "mocha": "^9.2.2",
-    "wrangler": "^2.0.23",
-    "astro": "2.10.5",
+    "wrangler": "^3.5.0",
+    "astro": "2.10.14",
     "astro-scripts": "0.0.14"
   },
   "scripts": {