@fastly/hono-fastly-compute 0.3.2 → 0.3.3

package/CHANGELOG.md

@@ -7,6 +7,16 @@ 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
@@ -32,7 +42,8 @@ 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.2...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

package/README.md

@@ -35,10 +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
@@ -50,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
@@ -96,14 +111,13 @@ The core adapter function that connects Hono to the Fastly Compute `FetchEvent`.
 
 ### `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 defined on `fire.Bindings` and available on `c.env`, even if the bindings definitions are empty:
+`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 { buildFire } from '@fastly/hono-fastly-compute';
+import { fire, type Bindings } from '@fastly/hono-fastly-compute';
 
-const fire = buildFire({});
-const app = new Hono<{Bindings: typeof fire.Bindings}>();
+const app = new Hono<{ Bindings: Bindings }>();
 
 app.get('/', (c) => {
   const clientInfo = c.env.clientInfo;
@@ -125,9 +139,8 @@ An implementation of the [ConnInfo helper](https://hono.dev/docs/helpers/conninf
 
 ```typescript
 import { Hono } from 'hono';
-import { buildFire, getConnInfo } from '@fastly/hono-fastly-compute';
+import { fire, getConnInfo } from '@fastly/hono-fastly-compute';
 
-const fire = buildFire({});
 const app = new Hono();
 
 app.get('/', (c) => {

package/build/fire.d.ts

@@ -37,7 +37,7 @@ type FireFn<D extends BindingsDefs> = {
      */
     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.
@@ -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

@@ -35,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastly/hono-fastly-compute",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Helper utilities for using Hono with Fastly Compute",
   "license": "MIT",
   "repository": {