@fastly/hono-fastly-compute 0.3.1 → 0.3.3

package/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.3.3] - 2025-10-15
+
+### Changed
+
+- Change debugging definition field to `_defs`
+
+### Added
+
+- Expose default `fire` and `Bindings`
+
+## [0.3.2] - 2025-10-14
+
+### Added
+
+- Extend env with client and server info
+- Implement ConnInfo helpers
+
 ## [0.3.1] - 2025-10-08
 
 ### Fixed
@@ -25,7 +42,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial public release
 
-[unreleased]: https://github.com/fastly/hono-fastly-compute/compare/v0.3.1...HEAD
+[unreleased]: https://github.com/fastly/hono-fastly-compute/compare/v0.3.3...HEAD
+[0.3.3]: https://github.com/fastly/hono-fastly-compute/compare/v0.3.2...v0.3.3
+[0.3.2]: https://github.com/fastly/hono-fastly-compute/compare/v0.3.1...v0.3.2
 [0.3.1]: https://github.com/fastly/hono-fastly-compute/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/fastly/hono-fastly-compute/compare/v0.1.0...v0.3.0
 [0.1.0]: https://github.com/fastly/hono-fastly-compute/releases/tag/v0.1.0

package/README.md

@@ -35,11 +35,7 @@ const fire = buildFire({
 });
 
 // Use the inferred Bindings type in your Hono environment
-type Env = {
-  Bindings: typeof fire.Bindings;
-};
-
-const app = new Hono<Env>();
+const app = new Hono<{ Bindings: typeof fire.Bindings }>();
 
 app.get('/', async (c) => {
   // Access your bindings from the context
@@ -51,15 +47,33 @@ app.get('/', async (c) => {
 fire(app);
 ```
 
+### Example with no user resources
+
+An application that defines no user resources is even simpler:
+
+```typescript
+import { Hono } from 'hono';
+import { fire, type Bindings } from '@fastly/hono-fastly-compute';
+
+const app = new Hono<{ Bindings: Bindings }>();
+
+app.get('/', async (c) => {
+  // `clientInfo` and `serverInfo` are always available on `c.env`.
+  const clientInfo = c.env.clientInfo;
+  c.text(`Accessed from ${clientInfo.address}`);
+});
+
+fire(app);
+```
+
 ### Using the `logFastlyServiceVersion` Middleware
 
 This package includes a simple middleware to log the `FASTLY_SERVICE_VERSION` for debugging purposes.
 
 ```typescript
 import { Hono } from 'hono';
-import { buildFire, logFastlyServiceVersion } from '@fastly/hono-fastly-compute';
+import { fire, logFastlyServiceVersion } from '@fastly/hono-fastly-compute';
 
-const fire = buildFire({});
 const app = new Hono();
 
 // Use the middleware
@@ -95,10 +109,48 @@ The core adapter function that connects Hono to the Fastly Compute `FetchEvent`.
 - **`bindingsDefs`**: The environment bindings definition.
 - **`options`**: An optional object with a `fetch` property.
 
+### `clientInfo` and `serverInfo`
+
+`clientInfo` ([ClientInfo](https://github.com/fastly/js-compute-runtime/blob/f9d6a121f13efbb586d6af210dedec61661dfc6d/types/globals.d.ts#L419-L436)) and `serverInfo` ([ServerInfo](https://github.com/fastly/js-compute-runtime/blob/f9d6a121f13efbb586d6af210dedec61661dfc6d/types/globals.d.ts#L438-L446)) are always defined on `fire.Bindings` and can be made available on `c.env`, even if the bindings definitions are empty:
+
+```typescript
+import { Hono } from 'hono';
+import { fire, type Bindings } from '@fastly/hono-fastly-compute';
+
+const app = new Hono<{ Bindings: Bindings }>();
+
+app.get('/', (c) => {
+  const clientInfo = c.env.clientInfo;
+  const serverInfo = c.env.serverInfo;
+
+  c.text(`${clientInfo.address} ${serverInfo.address}`);
+});
+
+fire(app);
+```
+
 ### `logFastlyServiceVersion()`
 
 A Hono middleware that logs to the console the string `FASTLY_SERVICE_VERSION` followed by the value of the environment variable **FASTLY_SERVICE_VERSION**.
 
+### `getConnInfo()`
+
+An implementation of the [ConnInfo helper](https://hono.dev/docs/helpers/conninfo) for Fastly Compute.
+
+```typescript
+import { Hono } from 'hono';
+import { fire, getConnInfo } from '@fastly/hono-fastly-compute';
+
+const app = new Hono();
+
+app.get('/', (c) => {
+  const info = getConnInfo(c); // info is `ConnInfo`
+  return c.text(`Your remote address is ${info.remote.address}`);
+});
+
+fire(app);
+```
+
 ## Issues
 
 If you encounter any non-security-related bug or unexpected behavior, please [file an issue][bug] using the bug report template.

package/build/conninfo.d.ts

@@ -0,0 +1,3 @@
+import type { GetConnInfo } from 'hono/conninfo';
+export declare const getConnInfo: GetConnInfo;
+//# sourceMappingURL=conninfo.d.ts.map

package/build/conninfo.js

@@ -0,0 +1,28 @@
+/*
+ * Copyright Fastly, Inc.
+ * Licensed under the MIT license. See LICENSE file for details.
+ */
+const ipv4Regex = /^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;
+const ipv6Regex = /^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/;
+export const getConnInfo = (c) => {
+    const clientInfo = c.env.clientInfo;
+    if (clientInfo == null) {
+        throw new TypeError('env has to include clientInfo.');
+    }
+    let address = undefined;
+    let addressType = undefined;
+    if (ipv4Regex.test(clientInfo.address)) {
+        address = clientInfo.address;
+        addressType = 'IPv4';
+    }
+    else if (ipv6Regex.test(clientInfo.address)) {
+        address = clientInfo.address;
+        addressType = 'IPv6';
+    }
+    return {
+        remote: {
+            address,
+            addressType,
+        },
+    };
+};

package/build/fire.d.ts

@@ -1,7 +1,7 @@
 import type { Schema } from 'hono';
 import type { HonoBase } from 'hono/hono-base';
-import type { ContextProxy, BindingsDefs } from '@fastly/compute-js-context';
-import { type HandleOptions } from './handler.js';
+import type { BindingsDefs, ContextProxy } from '@fastly/compute-js-context';
+import { type BindingsWithClientInfo, type HandleOptions } from './handler.js';
 /**
  * Registers a Hono app to handle fetch events in Fastly Compute.
  *
@@ -35,9 +35,9 @@ type FireFn<D extends BindingsDefs> = {
      * The inferred bindings type, derived from the defs passed to `buildFire()`.
      * Use this in your Env definition: `{ Bindings: typeof fire.Bindings }`.
      */
-    Bindings: ContextProxy<D>;
+    Bindings: BindingsWithClientInfo<D>;
     /** For debugging: the raw defs object you passed to buildFire */
-    defs: D;
+    _defs: D;
 };
 /**
  * Creates a `fire` function bound to a specific set of environment bindings.
@@ -51,8 +51,8 @@ type FireFn<D extends BindingsDefs> = {
  * const fire = buildFire({ grip: "ConfigStore", foo: "KVStore" });
  *
  * type Env = {
- *   Variables: Variables;
- *   Bindings: typeof fire.Bindings; // infer binding types automatically
+ *   Variables: Variables,
+ *   Bindings: typeof fire.Bindings, // infer binding types automatically
  * };
  *
  * const app = new Hono<Env>();
@@ -71,8 +71,22 @@ type FireFn<D extends BindingsDefs> = {
  *                          (e.g. `{ foo: "KVStore", bar: "ConfigStore" }`).
  * @returns A `fire` function that:
  *  - Registers your Hono app to handle fetch events
+ *  - Applies `bindingsDefs` to `c.env`
  *  - Exposes a `.Bindings` type inferred from the given defs
  */
 export declare function buildFire<D extends BindingsDefs>(bindingsDefs: D): FireFn<D>;
+/**
+ * Registers your Hono app to handle fetch events. No user-defined bindings are
+ * applied to `c.env`.
+ * `fire.Bindings` is a type you can use when defining your `Env`,
+ * providing access to platform-defined bindings such as `clientInfo` and
+ * `serverInfo`.
+ */
+export declare const fire: FireFn<{}>;
+/**
+ * Default bindings which can be used when no user-defined bindings are present.
+ * Alias of `fire.Bindings`.
+ */
+export type Bindings = typeof fire.Bindings;
 export {};
 //# sourceMappingURL=fire.d.ts.map

package/build/fire.js

@@ -1,3 +1,7 @@
+/*
+ * Copyright Fastly, Inc.
+ * Licensed under the MIT license. See LICENSE file for details.
+ */
 import { handle } from './handler.js';
 /**
  * Creates a `fire` function bound to a specific set of environment bindings.
@@ -11,8 +15,8 @@ import { handle } from './handler.js';
  * const fire = buildFire({ grip: "ConfigStore", foo: "KVStore" });
  *
  * type Env = {
- *   Variables: Variables;
- *   Bindings: typeof fire.Bindings; // infer binding types automatically
+ *   Variables: Variables,
+ *   Bindings: typeof fire.Bindings, // infer binding types automatically
  * };
  *
  * const app = new Hono<Env>();
@@ -31,12 +35,21 @@ import { handle } from './handler.js';
  *                          (e.g. `{ foo: "KVStore", bar: "ConfigStore" }`).
  * @returns A `fire` function that:
  *  - Registers your Hono app to handle fetch events
+ *  - Applies `bindingsDefs` to `c.env`
  *  - Exposes a `.Bindings` type inferred from the given defs
  */
 export function buildFire(bindingsDefs) {
     const fireFn = ((app, options = { fetch: undefined, }) => {
         addEventListener('fetch', handle(app, bindingsDefs, options));
     });
-    fireFn.defs = bindingsDefs;
+    fireFn._defs = bindingsDefs;
     return fireFn;
 }
+/**
+ * Registers your Hono app to handle fetch events. No user-defined bindings are
+ * applied to `c.env`.
+ * `fire.Bindings` is a type you can use when defining your `Env`,
+ * providing access to platform-defined bindings such as `clientInfo` and
+ * `serverInfo`.
+ */
+export const fire = buildFire({});

package/build/handler.d.ts

@@ -1,18 +1,19 @@
 import type { Schema } from 'hono';
 import type { HonoBase } from 'hono/hono-base';
 import { type BindingsDefs, type ContextProxy } from '@fastly/compute-js-context';
+export type BindingsWithClientInfo<D extends BindingsDefs> = ContextProxy<D> & {
+    clientInfo: ClientInfo;
+    serverInfo: ServerInfo;
+};
 type Handler = (evt: FetchEvent) => void;
 export type HandleOptions = {
     fetch?: typeof fetch;
 };
 type HandleFn = {
-    <D extends BindingsDefs, V extends {
-        Variables?: object;
-    }, S extends Schema, BasePath extends string>(app: HonoBase<(keyof D extends never ? {} : never) & V, S, BasePath>, envBindingsDefs: D, opts?: HandleOptions): Handler;
     <D extends BindingsDefs, V extends {
         Variables?: object;
     }, S extends Schema, BasePath extends string>(app: HonoBase<{
-        Bindings: ContextProxy<D>;
+        Bindings: BindingsWithClientInfo<D>;
     } & V, S, BasePath>, envBindingsDefs: D, opts?: HandleOptions): Handler;
 };
 /**

package/build/handler.js

@@ -1,4 +1,8 @@
-import { createContext, buildContextProxy, } from '@fastly/compute-js-context';
+/*
+ * Copyright Fastly, Inc.
+ * Licensed under the MIT license. See LICENSE file for details.
+ */
+import { buildContextProxyOn, } from '@fastly/compute-js-context';
 /**
  * Adapter for Fastly Compute
  */
@@ -8,8 +12,11 @@ export const handle = (app, envBindingsDefs, opts = {
 }) => {
     return (evt) => {
         evt.respondWith((async () => {
-            const context = createContext();
-            const env = buildContextProxy(context, envBindingsDefs);
+            const envBase = {
+                clientInfo: evt.client,
+                serverInfo: evt.server,
+            };
+            const env = buildContextProxyOn(envBase, envBindingsDefs);
             const res = await app.fetch(evt.request, env, {
                 waitUntil: evt.waitUntil.bind(evt),
                 passThroughOnException() {

package/build/index.d.ts

@@ -1,5 +1,6 @@
 export * from './fire.js';
 export * from './handler.js';
 export * from './utils.js';
+export * from './conninfo.js';
 export type { ResourceType, Context, ContextProxy, BindingsDefs, } from '@fastly/compute-js-context';
 //# sourceMappingURL=index.d.ts.map

package/build/index.js

@@ -1,3 +1,8 @@
+/*
+ * Copyright Fastly, Inc.
+ * Licensed under the MIT license. See LICENSE file for details.
+ */
 export * from './fire.js';
 export * from './handler.js';
 export * from './utils.js';
+export * from './conninfo.js';

package/build/utils.js

@@ -1,3 +1,7 @@
+/*
+ * Copyright Fastly, Inc.
+ * Licensed under the MIT license. See LICENSE file for details.
+ */
 import { env } from 'fastly:env';
 import { createMiddleware } from 'hono/factory';
 export const logFastlyServiceVersion = () => createMiddleware(async (_, next) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastly/hono-fastly-compute",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Helper utilities for using Hono with Fastly Compute",
   "license": "MIT",
   "repository": {
@@ -26,7 +26,7 @@
     "clean": "rm -rf build"
   },
   "dependencies": {
-    "@fastly/compute-js-context": "^0.4.2",
+    "@fastly/compute-js-context": "^0.5.1",
     "@fastly/js-compute": "^3.0.0"
   },
   "devDependencies": {