@faremeter/middleware 0.8.0 → 0.9.0

package/dist/src/cache.d.ts

@@ -0,0 +1,16 @@
+export type AgedLRUCacheOpts = {
+    capacity?: number;
+    maxAge?: number;
+    now?: () => number;
+};
+export declare class AgedLRUCache<K, V> {
+    private maxAge;
+    private capacity;
+    private cache;
+    private now;
+    constructor(opts?: AgedLRUCacheOpts);
+    get(key: K): V | undefined;
+    put(key: K, value: V): void;
+    get size(): number;
+}
+//# sourceMappingURL=cache.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../src/cache.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;CACpB,CAAC;AAEF,qBAAa,YAAY,CAAC,CAAC,EAAE,CAAC;IAC5B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,KAAK,CAAsC;IACnD,OAAO,CAAC,GAAG,CAAe;gBAEd,IAAI,GAAE,gBAAqB;IAOvC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAiB1B,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAY3B,IAAW,IAAI,WAEd;CACF"}

package/dist/src/cache.js

@@ -0,0 +1,39 @@
+export class AgedLRUCache {
+    maxAge;
+    capacity;
+    cache;
+    now;
+    constructor(opts = {}) {
+        this.capacity = opts.capacity ?? 256;
+        this.maxAge = opts.maxAge ?? 30 * 1000;
+        this.now = opts.now ?? Date.now;
+        this.cache = new Map();
+    }
+    get(key) {
+        const value = this.cache.get(key);
+        if (value === undefined) {
+            return undefined;
+        }
+        this.cache.delete(key);
+        if (this.now() - value.birth >= this.maxAge) {
+            return undefined;
+        }
+        this.cache.set(key, value);
+        return value.value;
+    }
+    put(key, value) {
+        if (this.cache.has(key)) {
+            this.cache.delete(key);
+        }
+        else if (this.cache.size >= this.capacity) {
+            const lruKey = this.cache.keys().next().value;
+            if (lruKey !== undefined) {
+                this.cache.delete(lruKey);
+            }
+        }
+        this.cache.set(key, { birth: this.now(), value });
+    }
+    get size() {
+        return this.cache.size;
+    }
+}

package/dist/src/cache.test.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env pnpm tsx
+export {};
+//# sourceMappingURL=cache.test.d.ts.map

package/dist/src/cache.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.test.d.ts","sourceRoot":"","sources":["../../src/cache.test.ts"],"names":[],"mappings":""}

package/dist/src/cache.test.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env pnpm tsx
+import t from "tap";
+import { AgedLRUCache } from "./cache.js";
+await t.test("checkBasicCaching", async (t) => {
+    let theTime = 0;
+    const now = () => theTime;
+    const cache = new AgedLRUCache({
+        capacity: 3,
+        maxAge: 1000,
+        now,
+    });
+    t.equal(cache.size, 0);
+    t.matchOnly(cache.get("somekey"), undefined);
+    cache.put("somekey", 42);
+    theTime += 500;
+    t.equal(cache.size, 1);
+    t.matchOnly(cache.get("somekey"), 42);
+    theTime += 1000;
+    t.matchOnly(cache.get("somekey"), undefined);
+    t.matchOnly(cache.size, 0);
+    cache.put("0key", 0);
+    cache.put("1key", 1);
+    cache.put("2key", 2);
+    t.equal(cache.size, 3);
+    t.matchOnly(cache.get("0key"), 0);
+    cache.put("3key", 3);
+    t.equal(cache.size, 3);
+    t.matchOnly(cache.get("1key"), undefined);
+    t.matchOnly(cache.get("2key"), 2);
+    cache.put("4key", 4);
+    t.equal(cache.size, 3);
+    t.matchOnly(cache.get("0key"), undefined);
+    t.matchOnly(cache.get("2key"), 2);
+    t.matchOnly(cache.get("3key"), 3);
+    t.matchOnly(cache.get("4key"), 4);
+    theTime += 1000;
+    t.matchOnly(cache.get("2key"), undefined);
+    t.matchOnly(cache.get("3key"), undefined);
+    t.matchOnly(cache.get("4key"), undefined);
+    t.equal(cache.size, 0);
+    t.pass();
+    t.end();
+});

package/dist/src/common.d.ts

@@ -1,4 +1,5 @@
 import { type x402PaymentRequirements, type x402PaymentPayload } from "@faremeter/types/x402";
+import { type AgedLRUCacheOpts } from "./cache.js";
 export declare function findMatchingPaymentRequirements(accepts: x402PaymentRequirements[], payload: x402PaymentPayload): {
     scheme: string;
     network: string;
@@ -41,12 +42,20 @@ type PossibleJSONResponse = object;
 export type CommonMiddlewareArgs = {
     facilitatorURL: string;
     accepts: RelaxedRequirements[];
+    cacheConfig?: createPaymentRequiredResponseCacheOpts;
 };
 export type HandleMiddlewareRequestArgs<MiddlewareResponse = unknown> = CommonMiddlewareArgs & {
     resource: string;
     getHeader: (key: string) => string | undefined;
+    getPaymentRequiredResponse: typeof getPaymentRequiredResponse;
     sendJSONResponse: (status: PossibleStatusCodes, obj: PossibleJSONResponse) => MiddlewareResponse;
 };
 export declare function handleMiddlewareRequest<MiddlewareResponse>(args: HandleMiddlewareRequestArgs<MiddlewareResponse>): Promise<MiddlewareResponse | undefined>;
+export type createPaymentRequiredResponseCacheOpts = AgedLRUCacheOpts & {
+    disable?: boolean;
+};
+export declare function createPaymentRequiredResponseCache(opts?: createPaymentRequiredResponseCacheOpts): {
+    getPaymentRequiredResponse: typeof getPaymentRequiredResponse;
+};
 export {};
 //# sourceMappingURL=common.d.ts.map

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,EAKxB,MAAM,uBAAuB,CAAC;AAI/B,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;;;;;;;;;;;;oBApCkC,CAAC;aAIhE,CAAC;;;GA8DT;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,mBAAmB,EAAE,CAAC;CAChC,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,gBAAgB,EAAE,CAChB,MAAM,EAAE,mBAAmB,EAC3B,GAAG,EAAE,oBAAoB,KACtB,kBAAkB,CAAC;CACzB,CAAC;AAEJ,wBAAsB,uBAAuB,CAAC,kBAAkB,EAC9D,IAAI,EAAE,2BAA2B,CAAC,kBAAkB,CAAC,2CA6DtD"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EAKxB,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;;;;;;;;;;;;oBApC5B,CAAA;aAAuB,CAAC;;;GAkEjC;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,mBAAmB,EAAE,CAAC;IAC/B,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;CACzB,CAAC;AAEJ,wBAAsB,uBAAuB,CAAC,kBAAkB,EAC9D,IAAI,EAAE,2BAA2B,CAAC,kBAAkB,CAAC,2CA2DtD;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

@@ -1,5 +1,6 @@
 import { isValidationError } from "@faremeter/types";
 import { x402PaymentRequiredResponse, x402PaymentHeaderToPayload, x402SettleRequest, x402SettleResponse, } from "@faremeter/types/x402";
+import { AgedLRUCache } from "./cache.js";
 import { logger } from "./logger.js";
 export function findMatchingPaymentRequirements(accepts, payload) {
     let possible;
@@ -52,9 +53,7 @@ export async function getPaymentRequiredResponse(args) {
     return response;
 }
 export async function handleMiddlewareRequest(args) {
-    // XXX - Temporarily request this every time.  This will be
-    // cached in future.
-    const paymentRequiredResponse = await getPaymentRequiredResponse(args);
+    const paymentRequiredResponse = await args.getPaymentRequiredResponse(args);
     const sendPaymentRequired = () => args.sendJSONResponse(402, paymentRequiredResponse);
     const paymentHeader = args.getHeader("X-PAYMENT");
     if (!paymentHeader) {
@@ -94,3 +93,22 @@ export async function handleMiddlewareRequest(args) {
         return sendPaymentRequired();
     }
 }
+export function createPaymentRequiredResponseCache(opts = {}) {
+    if (opts.disable) {
+        logger.warning("payment required response cache disabled");
+        return {
+            getPaymentRequiredResponse,
+        };
+    }
+    const cache = new AgedLRUCache(opts);
+    return {
+        getPaymentRequiredResponse: async (args) => {
+            let response = cache.get(args.accepts);
+            if (response === undefined) {
+                response = await getPaymentRequiredResponse(args);
+                cache.put(args.accepts, response);
+            }
+            return response;
+        },
+    };
+}

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

@@ -1 +1 @@
-{"version":3,"file":"express.d.ts","sourceRoot":"","sources":["../../src/express.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE/D,KAAK,oBAAoB,GAAG,oBAAoB,CAAC;AAEjD,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,iBAC5C,OAAO,OAAO,QAAQ,QAAQ,YAAY,oBAc9D"}
+{"version":3,"file":"express.d.ts","sourceRoot":"","sources":["../../src/express.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,oBAAoB,EAE1B,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE/D,KAAK,oBAAoB,GAAG,oBAAoB,CAAC;AAEjD,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,iBAK5C,OAAO,OAAO,QAAQ,QAAQ,YAAY,oBAe9D"}

package/dist/src/express.js

@@ -1,9 +1,11 @@
-import { handleMiddlewareRequest } from "./common.js";
+import { handleMiddlewareRequest, createPaymentRequiredResponseCache, } from "./common.js";
 export async function createMiddleware(args) {
+    const { getPaymentRequiredResponse } = createPaymentRequiredResponseCache(args.cacheConfig);
     return async (req, res, next) => {
         const response = await handleMiddlewareRequest({
             ...args,
             resource: `${req.protocol}://${req.headers.host}${req.path}`,
+            getPaymentRequiredResponse,
             getHeader: (key) => req.header(key),
             sendJSONResponse: (status, body) => res.status(status).json(body),
         });

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

@@ -1 +1 @@
-{"version":3,"file":"hono.d.ts","sourceRoot":"","sources":["../../src/hono.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAE9C,KAAK,oBAAoB,GAAG,oBAAoB,CAAC;AAEjD,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,iBAAiB,CAAC,CAkB5B"}
+{"version":3,"file":"hono.d.ts","sourceRoot":"","sources":["../../src/hono.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,oBAAoB,EAE1B,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAE9C,KAAK,oBAAoB,GAAG,oBAAoB,CAAC;AAEjD,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,iBAAiB,CAAC,CAuB5B"}

package/dist/src/hono.js

@@ -1,10 +1,12 @@
-import { handleMiddlewareRequest } from "./common.js";
+import { handleMiddlewareRequest, createPaymentRequiredResponseCache, } from "./common.js";
 export async function createMiddleware(args) {
+    const { getPaymentRequiredResponse } = createPaymentRequiredResponseCache(args.cacheConfig);
     return async (c, next) => {
         const response = await handleMiddlewareRequest({
             ...args,
             resource: c.req.url,
             getHeader: (key) => c.req.header(key),
+            getPaymentRequiredResponse,
             sendJSONResponse: (status, body) => {
                 c.status(status);
                 return c.json(body);

package/dist/src/index.d.ts

@@ -1,4 +1,5 @@
 export * as express from "./express.js";
 export * as hono from "./hono.js";
 export * as common from "./common.js";
+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"}
+{"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"}

package/dist/src/index.js

@@ -1,3 +1,4 @@
 export * as express from "./express.js";
 export * as hono from "./hono.js";
 export * as common from "./common.js";
+export * as cache from "./cache.js";