@faremeter/middleware 0.15.0 → 0.17.0

package/dist/src/hono.js

@@ -1,31 +1,54 @@
-import { handleMiddlewareRequest, createPaymentRequiredResponseCache, } from "./common.js";
+import { handleMiddlewareRequest, createPaymentRequiredResponseCache, resolveSupportedVersions, } from "./common.js";
+/**
+ * Creates Hono middleware that gates routes behind x402 payment.
+ *
+ * The middleware intercepts requests, checks for payment headers, communicates
+ * with the facilitator to validate and settle payments, and only allows the
+ * request to proceed if payment is successful.
+ *
+ * @param args - Configuration including facilitator URL and accepted payment types
+ * @returns A Hono middleware handler
+ */
 export async function createMiddleware(args) {
-    const { getPaymentRequiredResponse } = createPaymentRequiredResponseCache(args.cacheConfig);
+    // Validate configuration at creation time
+    const supportedVersions = resolveSupportedVersions(args.supportedVersions);
+    const { getPaymentRequiredResponse, getPaymentRequiredResponseV2 } = createPaymentRequiredResponseCache(args.cacheConfig);
     return async (c, next) => {
         return await handleMiddlewareRequest({
             ...args,
+            supportedVersions,
             resource: c.req.url,
             getHeader: (key) => c.req.header(key),
+            setResponseHeader: (key, value) => c.header(key, value),
             getPaymentRequiredResponse,
-            sendJSONResponse: (status, body) => {
+            getPaymentRequiredResponseV2,
+            sendJSONResponse: (status, body, headers) => {
                 c.status(status);
-                return c.json(body);
+                if (headers) {
+                    for (const [key, value] of Object.entries(headers)) {
+                        c.header(key, value);
+                    }
+                }
+                if (body) {
+                    return c.json(body);
+                }
+                return c.body(null);
             },
             body: async ({ verify, settle }) => {
                 if (args.verifyBeforeSettle) {
                     // If configured, try to verify the transaction before running
                     // the next operation.
                     const verifyResult = await verify();
-                    if (verifyResult !== undefined) {
-                        return verifyResult;
+                    if (!verifyResult.success) {
+                        return verifyResult.errorResponse;
                     }
                 }
                 else {
                     // Otherwise just settle the payment beforehand, like we've
                     // done historically.
                     const settleResult = await settle();
-                    if (settleResult !== undefined) {
-                        return settleResult;
+                    if (!settleResult.success) {
+                        return settleResult.errorResponse;
                     }
                 }
                 await next();
@@ -33,14 +56,14 @@ export async function createMiddleware(args) {
                     // Close out the verification, by actually settling the
                     // payment.
                     const settleResult = await settle();
-                    if (settleResult !== undefined) {
+                    if (!settleResult.success) {
                         // If the settlement fails, we need to explicitly
                         // overwrite the downstream result.  See:
                         //
                         // https://hono.dev/docs/guides/middleware#modify-the-response-after-next
                         //
                         c.res = undefined;
-                        c.res = settleResult;
+                        c.res = settleResult.errorResponse;
                     }
                 }
             },

package/dist/src/index.d.ts

@@ -1,5 +1,31 @@
+/**
+ * @title Middleware Package
+ * @sidebarTitle Middleware
+ * @description Server middleware for gating routes behind x402 payments
+ * @packageDocumentation
+ */
+/**
+ * @title Express Middleware
+ * @sidebarTitle Middleware / Express
+ * @description x402 payment middleware for Express.js
+ */
 export * as express from "./express.js";
+/**
+ * @title Hono Middleware
+ * @sidebarTitle Middleware / Hono
+ * @description x402 payment middleware for Hono web framework
+ */
 export * as hono from "./hono.js";
+/**
+ * @title Common Middleware
+ * @sidebarTitle Middleware / Common
+ * @description Framework-agnostic middleware utilities and types
+ */
 export * as common from "./common.js";
+/**
+ * @title Middleware Cache
+ * @sidebarTitle Middleware / Cache
+ * @description LRU cache with time-based expiration for payment requirements
+ */
 export * as cache from "./cache.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH;;;;GAIG;AACH,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC;;;;GAIG;AACH,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B;;;;GAIG;AACH,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC;;;;GAIG;AACH,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC"}

package/dist/src/index.js

@@ -1,4 +1,30 @@
+/**
+ * @title Middleware Package
+ * @sidebarTitle Middleware
+ * @description Server middleware for gating routes behind x402 payments
+ * @packageDocumentation
+ */
+/**
+ * @title Express Middleware
+ * @sidebarTitle Middleware / Express
+ * @description x402 payment middleware for Express.js
+ */
 export * as express from "./express.js";
+/**
+ * @title Hono Middleware
+ * @sidebarTitle Middleware / Hono
+ * @description x402 payment middleware for Hono web framework
+ */
 export * as hono from "./hono.js";
+/**
+ * @title Common Middleware
+ * @sidebarTitle Middleware / Common
+ * @description Framework-agnostic middleware utilities and types
+ */
 export * as common from "./common.js";
+/**
+ * @title Middleware Cache
+ * @sidebarTitle Middleware / Cache
+ * @description LRU cache with time-based expiration for payment requirements
+ */
 export * as cache from "./cache.js";

package/dist/src/logger.d.ts

@@ -1,2 +1,2 @@
-export declare const logger: import("@logtape/logtape").Logger;
+export declare const logger: import("@faremeter/logs").Logger;
 //# sourceMappingURL=logger.d.ts.map

package/dist/src/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM,mCAAyC,CAAC"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM,kCAA+C,CAAC"}

package/dist/src/logger.js

@@ -1,2 +1,2 @@
-import { getLogger } from "@logtape/logtape";
-export const logger = getLogger(["faremeter", "middleware"]);
+import { getLogger } from "@faremeter/logs";
+export const logger = await getLogger(["faremeter", "middleware"]);