@astrojs/cloudflare 7.1.0 → 7.2.0

package/README.md

@@ -115,8 +115,12 @@ If you're using the `advanced` runtime, you can type the `runtime` object as fol
 /// <reference types="astro/client" />
 import type { AdvancedRuntime } from '@astrojs/cloudflare';
 
+type ENV = {
+  SERVER_URL: string;
+};
+
 declare namespace App {
-  interface Locals extends AdvancedRuntime {
+  interface Locals extends AdvancedRuntime<ENV> {
     user: {
       name: string;
       surname: string;
@@ -132,8 +136,12 @@ If you're using the `directory` runtime, you can type the `runtime` object as fo
 /// <reference types="astro/client" />
 import type { DirectoryRuntime } from '@astrojs/cloudflare';
 
+type ENV = {
+  SERVER_URL: string;
+};
+
 declare namespace App {
-  interface Locals extends DirectoryRuntime {
+  interface Locals extends DirectoryRuntime<ENV> {
     user: {
       name: string;
       surname: string;
@@ -194,6 +202,33 @@ This will enable Cloudflare to serve files and process static redirects without
 
 See [Cloudflare's documentation](https://developers.cloudflare.com/pages/platform/functions/routing/#create-a-_routesjson-file) for more details.
 
+## Node.js compatibility
+
+Astro's Cloudflare adapter allows you to use any Node.js runtime API supported by Cloudflare:
+
+- assert
+- AsyncLocalStorage
+- Buffer
+- Diagnostics Channel
+- EventEmitter
+- path
+- process
+- Streams
+- StringDecoder
+- util
+
+To use these APIs, your page or endpoint must be server-side rendered (not pre-rendered) and must use the the `import {} from 'node:*'` import syntax.
+
+```js
+// pages/api/endpoint.js
+export const prerender = false;
+import { Buffer } from 'node:buffer';
+```
+
+Additionally, you'll need to enable the Compatibility Flag in Cloudflare. The configuration for this flag may vary based on where you deploy your Astro site.
+
+For detailed guidance, please refer to the [Cloudflare documentation](https://developers.cloudflare.com/workers/runtime-apis/nodejs).
+
 ## Troubleshooting
 
 For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import type { AstroAdapter, AstroIntegration } from 'astro';
-export type { AdvancedRuntime } from './server.advanced';
-export type { DirectoryRuntime } from './server.directory';
+export type { AdvancedRuntime } from './server.advanced.js';
+export type { DirectoryRuntime } from './server.directory.js';
 type Options = {
     mode?: 'directory' | 'advanced';
     functionPerRoute?: boolean;

package/dist/index.js

@@ -241,6 +241,18 @@ function createIntegration(args) {
             target: "es2020",
             platform: "browser",
             conditions: ["workerd", "worker", "browser"],
+            external: [
+              "node:assert",
+              "node:async_hooks",
+              "node:buffer",
+              "node:diagnostics_channel",
+              "node:events",
+              "node:path",
+              "node:process",
+              "node:stream",
+              "node:string_decoder",
+              "node:util"
+            ],
             entryPoints: entryPaths,
             outdir: outputDir,
             allowOverwrite: true,
@@ -287,6 +299,18 @@ function createIntegration(args) {
             target: "es2020",
             platform: "browser",
             conditions: ["workerd", "worker", "browser"],
+            external: [
+              "node:assert",
+              "node:async_hooks",
+              "node:buffer",
+              "node:diagnostics_channel",
+              "node:events",
+              "node:path",
+              "node:process",
+              "node:stream",
+              "node:string_decoder",
+              "node:util"
+            ],
             entryPoints: [entryPath],
             outfile: buildPath,
             allowOverwrite: true,

package/dist/server.advanced.d.ts

@@ -4,12 +4,11 @@ type Env = {
     ASSETS: {
         fetch: (req: Request) => Promise<Response>;
     };
-    name: string;
 };
-export interface AdvancedRuntime {
+export interface AdvancedRuntime<T extends object = object> {
     runtime: {
         waitUntil: (promise: Promise<any>) => void;
-        env: Env;
+        env: Env & T;
         cf: CFRequest['cf'];
         caches: typeof caches;
     };

package/dist/server.directory.d.ts

@@ -1,9 +1,9 @@
 import type { Request as CFRequest, EventContext } from '@cloudflare/workers-types';
 import type { SSRManifest } from 'astro';
-export interface DirectoryRuntime {
+export interface DirectoryRuntime<T extends object = object> {
     runtime: {
         waitUntil: (promise: Promise<any>) => void;
-        env: EventContext<unknown, string, unknown>['env'];
+        env: EventContext<unknown, string, unknown>['env'] & T;
         cf: CFRequest['cf'];
         caches: typeof caches;
     };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/cloudflare",
   "description": "Deploy your site to Cloudflare Workers/Pages",
-  "version": "7.1.0",
+  "version": "7.2.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -33,26 +33,27 @@
   ],
   "dependencies": {
     "@cloudflare/workers-types": "^4.20230821.0",
-    "esbuild": "^0.19.2",
-    "tiny-glob": "^0.2.9",
-    "find-up": "^6.3.0",
     "@iarna/toml": "^2.2.5",
-    "dotenv": "^16.3.1",
     "@miniflare/cache": "^2.14.1",
     "@miniflare/shared": "^2.14.1",
     "@miniflare/storage-memory": "^2.14.1",
+    "dotenv": "^16.3.1",
+    "esbuild": "^0.19.2",
+    "find-up": "^6.3.0",
+    "tiny-glob": "^0.2.9",
     "@astrojs/underscore-redirects": "0.3.0"
   },
   "peerDependencies": {
-    "astro": "^3.0.13"
+    "astro": "^3.1.2"
   },
   "devDependencies": {
+    "@types/iarna__toml": "^2.0.2",
     "chai": "^4.3.7",
     "cheerio": "1.0.0-rc.12",
     "kill-port": "^2.0.1",
     "mocha": "^10.2.0",
     "wrangler": "^3.5.1",
-    "astro": "3.0.13",
+    "astro": "3.1.2",
     "astro-scripts": "0.0.14"
   },
   "scripts": {