@astrojs/cloudflare 6.8.0 → 6.8.1

package/README.md

@@ -75,12 +75,59 @@ It's then possible to update the preview script in your `package.json` to `"prev
 
 You can access all the Cloudflare bindings and environment variables from Astro components and API routes through `Astro.locals`.
 
-```js
+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
+// src/pages/api/someFile.js
+export function get(context) {
+  const runtime = context.locals.runtime;
+
+  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/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.directory.d.ts

@@ -1,5 +1,13 @@
-import type { EventContext } from '@cloudflare/workers-types';
+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: (context: EventContext<unknown, string, unknown>) => Promise<import("@cloudflare/workers-types").Response | Response>;
     manifest: SSRManifest;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/cloudflare",
   "description": "Deploy your site to Cloudflare Workers/Pages",
-  "version": "6.8.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.6"
+    "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.6",
+    "wrangler": "^3.5.0",
+    "astro": "2.10.14",
     "astro-scripts": "0.0.14"
   },
   "scripts": {