@faremeter/middleware 0.15.0 → 0.16.0

package/dist/src/common.d.ts

@@ -1,4 +1,4 @@
-import { type x402PaymentRequirements, type x402PaymentPayload } from "@faremeter/types/x402";
+import { type x402PaymentRequirements, type x402PaymentPayload, x402VerifyResponse, x402SettleResponse } from "@faremeter/types/x402";
 import { type AgedLRUCacheOpts } from "./cache.js";
 export declare function findMatchingPaymentRequirements(accepts: x402PaymentRequirements[], payload: x402PaymentPayload): {
     scheme: string;
@@ -19,6 +19,7 @@ type getPaymentRequiredResponseArgs = {
     facilitatorURL: string;
     accepts: RelaxedRequirements[];
     resource: string;
+    fetch?: typeof fetch;
 };
 export declare function getPaymentRequiredResponse(args: getPaymentRequiredResponseArgs): Promise<{
     x402Version: number;
@@ -44,17 +45,33 @@ export type CommonMiddlewareArgs = {
     accepts: (RelaxedRequirements | RelaxedRequirements[])[];
     cacheConfig?: createPaymentRequiredResponseCacheOpts;
 };
+export type SettleResult<MiddlewareResponse> = {
+    success: true;
+    facilitatorResponse: x402SettleResponse;
+} | {
+    success: false;
+    errorResponse: MiddlewareResponse;
+};
+export type VerifyResult<MiddlewareResponse> = {
+    success: true;
+    facilitatorResponse: x402VerifyResponse;
+} | {
+    success: false;
+    errorResponse: MiddlewareResponse;
+};
+export type MiddlewareBodyContext<MiddlewareResponse> = {
+    paymentRequirements: x402PaymentRequirements;
+    paymentPayload: x402PaymentPayload;
+    settle: () => Promise<SettleResult<MiddlewareResponse>>;
+    verify: () => Promise<VerifyResult<MiddlewareResponse>>;
+};
 export type HandleMiddlewareRequestArgs<MiddlewareResponse = unknown> = CommonMiddlewareArgs & {
     resource: string;
     getHeader: (key: string) => string | undefined;
     getPaymentRequiredResponse: typeof getPaymentRequiredResponse;
     sendJSONResponse: (status: PossibleStatusCodes, obj: PossibleJSONResponse) => MiddlewareResponse;
-    body: (context: {
-        paymentRequirements: x402PaymentRequirements;
-        paymentPayload: x402PaymentPayload;
-        settle: () => Promise<MiddlewareResponse | undefined>;
-        verify: () => Promise<MiddlewareResponse | undefined>;
-    }) => Promise<MiddlewareResponse | undefined>;
+    body: (context: MiddlewareBodyContext<MiddlewareResponse>) => Promise<MiddlewareResponse | undefined>;
+    fetch?: typeof fetch;
 };
 export declare function handleMiddlewareRequest<MiddlewareResponse>(args: HandleMiddlewareRequestArgs<MiddlewareResponse>): Promise<MiddlewareResponse | undefined>;
 export type createPaymentRequiredResponseCacheOpts = AgedLRUCacheOpts & {

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

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EAOxB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,KAAK,gBAAgB,EAAgB,MAAM,SAAS,CAAC;AAI9D,wBAAgB,+BAA+B,CAC7C,OAAO,EAAE,uBAAuB,EAAE,EAClC,OAAO,EAAE,kBAAkB;;;;;;;;;;;;cA6B5B;AAED,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,QAAQ,QAS3D;AAED,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;AAEnE,KAAK,8BAA8B,GAAG;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAsB,0BAA0B,CAC9C,IAAI,EAAE,8BAA8B;;;;;;;;;;;;oBA9BU,CAAC;aAAuB,CAAC;;;GA4DxE;AAED,KAAK,mBAAmB,GAAG,GAAG,CAAC;AAC/B,KAAK,oBAAoB,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,CAAC,mBAAmB,GAAG,mBAAmB,EAAE,CAAC,EAAE,CAAC;IACzD,WAAW,CAAC,EAAE,sCAAsC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,2BAA2B,CAAC,kBAAkB,GAAG,OAAO,IAClE,oBAAoB,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IAC/C,0BAA0B,EAAE,OAAO,0BAA0B,CAAC;IAC9D,gBAAgB,EAAE,CAChB,MAAM,EAAE,mBAAmB,EAC3B,GAAG,EAAE,oBAAoB,KACtB,kBAAkB,CAAC;IACxB,IAAI,EAAE,CAAC,OAAO,EAAE;QACd,mBAAmB,EAAE,uBAAuB,CAAC;QAC7C,cAAc,EAAE,kBAAkB,CAAC;QACnC,MAAM,EAAE,MAAM,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;QACtD,MAAM,EAAE,MAAM,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;KACvD,KAAK,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;CAC/C,CAAC;AAEJ,wBAAsB,uBAAuB,CAAC,kBAAkB,EAC9D,IAAI,EAAE,2BAA2B,CAAC,kBAAkB,CAAC,2CA4GtD;AAED,MAAM,MAAM,sCAAsC,GAAG,gBAAgB,GAAG;IACtE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AACF,wBAAgB,kCAAkC,CAChD,IAAI,GAAE,sCAA2C;;EA8BlD"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EAIvB,kBAAkB,EAElB,kBAAkB,EACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,KAAK,gBAAgB,EAAgB,MAAM,SAAS,CAAC;AAI9D,wBAAgB,+BAA+B,CAC7C,OAAO,EAAE,uBAAuB,EAAE,EAClC,OAAO,EAAE,kBAAkB;;;;;;;;;;;;cA6B5B;AAED,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,QAAQ,QAS3D;AAED,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;AAEnE,KAAK,8BAA8B,GAAG;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACtB,CAAC;AAEF,wBAAsB,0BAA0B,CAC9C,IAAI,EAAE,8BAA8B;;;;;;;;;;;;oBA/BU,CAAC;aAAuB,CAAC;;;GA8DxE;AAED,KAAK,mBAAmB,GAAG,GAAG,CAAC;AAC/B,KAAK,oBAAoB,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,CAAC,mBAAmB,GAAG,mBAAmB,EAAE,CAAC,EAAE,CAAC;IACzD,WAAW,CAAC,EAAE,sCAAsC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,kBAAkB,IACvC;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,mBAAmB,EAAE,kBAAkB,CAAA;CAAE,GAC1D;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,aAAa,EAAE,kBAAkB,CAAA;CAAE,CAAC;AAE1D,MAAM,MAAM,YAAY,CAAC,kBAAkB,IACvC;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,mBAAmB,EAAE,kBAAkB,CAAA;CAAE,GAC1D;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,aAAa,EAAE,kBAAkB,CAAA;CAAE,CAAC;AAE1D,MAAM,MAAM,qBAAqB,CAAC,kBAAkB,IAAI;IACtD,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,cAAc,EAAE,kBAAkB,CAAC;IACnC,MAAM,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACxD,MAAM,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,2BAA2B,CAAC,kBAAkB,GAAG,OAAO,IAClE,oBAAoB,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IAC/C,0BAA0B,EAAE,OAAO,0BAA0B,CAAC;IAC9D,gBAAgB,EAAE,CAChB,MAAM,EAAE,mBAAmB,EAC3B,GAAG,EAAE,oBAAoB,KACtB,kBAAkB,CAAC;IACxB,IAAI,EAAE,CACJ,OAAO,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,KAC/C,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;IAC7C,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACtB,CAAC;AAEJ,wBAAsB,uBAAuB,CAAC,kBAAkB,EAC9D,IAAI,EAAE,2BAA2B,CAAC,kBAAkB,CAAC,2CAkHtD;AAED,MAAM,MAAM,sCAAsC,GAAG,gBAAgB,GAAG;IACtE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AACF,wBAAgB,kCAAkC,CAChD,IAAI,GAAE,sCAA2C;;EA8BlD"}

package/dist/src/common.js

@@ -15,7 +15,7 @@ export function findMatchingPaymentRequirements(accepts, payload) {
         possible = accepts.filter((x) => x.network === payload.network && x.scheme === payload.scheme);
     }
     if (possible.length > 1) {
-        logger.warning(`found ${possible.length} ambiguous matching requirements for client payment: {*}`, payload);
+        logger.warning(`found ${possible.length} ambiguous matching requirements for client payment`, payload);
     }
     // XXX - If there are more than one, this really should be an error.
     // For now, err on the side of potential compatibility.
@@ -30,11 +30,12 @@ export function gateGetPaymentRequiredResponse(res) {
     throw new Error(msg);
 }
 export async function getPaymentRequiredResponse(args) {
+    const fetchFn = args.fetch ?? fetch;
     const accepts = args.accepts.map((x) => ({
         ...x,
         resource: x.resource ?? args.resource,
     }));
-    const t = await fetch(`${args.facilitatorURL}/accepts`, {
+    const t = await fetchFn(`${args.facilitatorURL}/accepts`, {
         method: "POST",
         headers: {
             Accept: "application/json",
@@ -54,10 +55,12 @@ export async function getPaymentRequiredResponse(args) {
 }
 export async function handleMiddlewareRequest(args) {
     const accepts = args.accepts.flat();
+    const fetchFn = args.fetch ?? fetch;
     const paymentRequiredResponse = await args.getPaymentRequiredResponse({
         accepts,
         facilitatorURL: args.facilitatorURL,
         resource: args.resource,
+        fetch: fetchFn,
     });
     const sendPaymentRequired = () => args.sendJSONResponse(402, paymentRequiredResponse);
     const paymentHeader = args.getHeader("X-PAYMENT");
@@ -81,7 +84,7 @@ export async function handleMiddlewareRequest(args) {
             paymentPayload,
             paymentRequirements,
         };
-        const t = await fetch(`${args.facilitatorURL}/settle`, {
+        const t = await fetchFn(`${args.facilitatorURL}/settle`, {
             method: "POST",
             headers: {
                 Accept: "application/json",
@@ -97,8 +100,9 @@ export async function handleMiddlewareRequest(args) {
         }
         if (!settlementResponse.success) {
             logger.warning("failed to settle payment: {error}", settlementResponse);
-            return sendPaymentRequired();
+            return { success: false, errorResponse: sendPaymentRequired() };
         }
+        return { success: true, facilitatorResponse: settlementResponse };
     };
     const verify = async () => {
         const verifyRequest = {
@@ -107,7 +111,7 @@ export async function handleMiddlewareRequest(args) {
             paymentPayload,
             paymentRequirements,
         };
-        const t = await fetch(`${args.facilitatorURL}/verify`, {
+        const t = await fetchFn(`${args.facilitatorURL}/verify`, {
             method: "POST",
             headers: {
                 Accept: "application/json",
@@ -122,9 +126,10 @@ export async function handleMiddlewareRequest(args) {
             throw new Error(msg);
         }
         if (!verifyResponse.isValid) {
-            logger.warning("failed to settle payment: {invalidReason}", verifyResponse);
-            return sendPaymentRequired();
+            logger.warning("failed to verify payment: {invalidReason}", verifyResponse);
+            return { success: false, errorResponse: sendPaymentRequired() };
         }
+        return { success: true, facilitatorResponse: verifyResponse };
     };
     return await args.body({
         paymentRequirements,

package/dist/src/express.js

@@ -9,9 +9,9 @@ export async function createMiddleware(args) {
             getHeader: (key) => req.header(key),
             sendJSONResponse: (status, body) => res.status(status).json(body),
             body: async ({ settle }) => {
-                const response = await settle();
-                if (response !== undefined) {
-                    return response;
+                const settleResult = await settle();
+                if (!settleResult.success) {
+                    return settleResult.errorResponse;
                 }
                 next();
             },

package/dist/src/hono.js

@@ -16,16 +16,16 @@ export async function createMiddleware(args) {
                     // 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 +33,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/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"]);