@openreceive/http 0.2.4 → 0.3.1

package/dist/{adapter-surface-BtXnvW2q.d.ts → adapter-surface-CanN2Y1N.d.ts}

@@ -363,7 +363,7 @@ interface CreateOpenReceiveHostBaseOptions {
      * pay for (the request is answered 404). Called only where a price is
      * minted or quoted; the payer never sends an amount.
      */
-    readonly amountFor: (reference: string, context: ResolveCheckoutContext) => CreateCheckoutAmount | null | Promise<CreateCheckoutAmount | null>;
+    readonly amountFor: (reference: string, context: ResolveCheckoutContext) => HostCheckoutPrice | null | Promise<HostCheckoutPrice | null>;
     readonly clock?: () => number;
 }
 /**
@@ -421,6 +421,14 @@ interface Host {
  * `db` mode.
  */
 declare function createHost(options: CreateHostOptions): Host;
+/**
+ * What the payer is buying, in the host's own words — one optional display
+ * string returned beside the price by `amountFor`. It is peeled off here so the
+ * amount handed to the minting service stays exactly the price.
+ */
+type HostCheckoutPrice = CreateCheckoutAmount & {
+    readonly description?: string;
+};
 
 interface IpRateLimitConfig {
     /** Maximum invoice creations per IP per rolling hour. Default 60. */
@@ -516,6 +524,14 @@ interface ResolvedHostCheckout {
      * attempt never need (or wait for) host pricing.
      */
     readonly amount?: CreateCheckoutAmount;
+    /**
+     * What the payer is buying, in the host's own words — one display string,
+     * echoed on the prepare and create responses so the shipped checkout can show
+     * something other than a QR and a number. OpenReceive owns no line items and
+     * never will; this is the whole of what it carries. Response only: it is
+     * never read from a request body.
+     */
+    readonly description?: string;
     /** Return the selected host payment attempt's hash to reuse or inspect its checkout. */
     readonly paymentHash?: string;
     /** Host-persisted safe checkout snapshot used for retry without a wallet read. */
@@ -719,4 +735,4 @@ declare function createStack(options: CreateStackOptions): Stack;
  */
 declare function isStackOptions(options: CreateHttpHandlerOptions | CreateStackOptions): options is CreateStackOptions;
 
-export { hostError as $, type AttemptStatus as A, type SettlementEventHook as B, type CheckoutCreatedHook as C, type SettlementRecord as D, type SqlClient as E, type SqlDatabase as F, type SqlPaymentRepository as G, type Host as H, type IpRateLimitConfig as I, type SqlPaymentsOptions as J, type SqlQuery as K, type Stack as L, type StackStorage as M, type NotificationListener as N, OPENRECEIVE_ATTEMPT_EXPIRY_GRACE_SECONDS as O, type PaymentInsert as P, type StackWallet as Q, type ReconcilableAttempt as R, type SqlAdapter as S, createHost as T, createHttpHandler as U, createIpRateLimit as V, createProxyRateLimitingConfig as W, createRequestId as X, createSqlPayments as Y, createStack as Z, errorResponse as _, type Authorize as a, isServiceErrorShape as a0, isStackOptions as a1, jsonResponse as a2, mapHostRouteError as a3, paymentsSchemaSql as a4, resolveClientIp as a5, startNotificationListener as a6, startNotificationWorker as a7, type AuthorizeAction as b, type AuthorizeContext as c, type AuthorizeResource as d, type CheckoutCreatedInput as e, type CreateHostDbOptions as f, type CreateHostOptions as g, type CreateHostRepositoryOptions as h, type CreateHttpHandlerOptions as i, type CreateStackOptions as j, HostError as k, HttpError as l, type HttpHandler as m, type NotificationWorker as n, OPENRECEIVE_RECONCILE_BATCH_SIZE as o, type PaymentRecord as p, type PaymentRepository as q, type PaymentSettlement as r, type PaymentSettlementHook as s, type RateLimit as t, type ReconciliationTransition as u, type ResolveCheckoutContext as v, type ResolveCheckoutHook as w, type ResolvedHostCheckout as x, type ServiceErrorShape as y, type SettlementEvent as z };
+export { errorResponse as $, type AttemptStatus as A, type SettlementEvent as B, type CheckoutCreatedHook as C, type SettlementEventHook as D, type SettlementRecord as E, type SqlClient as F, type SqlDatabase as G, type Host as H, type IpRateLimitConfig as I, type SqlPaymentRepository as J, type SqlPaymentsOptions as K, type SqlQuery as L, type Stack as M, type NotificationListener as N, OPENRECEIVE_ATTEMPT_EXPIRY_GRACE_SECONDS as O, type PaymentInsert as P, type StackStorage as Q, type ReconcilableAttempt as R, type SqlAdapter as S, type StackWallet as T, createHost as U, createHttpHandler as V, createIpRateLimit as W, createProxyRateLimitingConfig as X, createRequestId as Y, createSqlPayments as Z, createStack as _, type Authorize as a, hostError as a0, isServiceErrorShape as a1, isStackOptions as a2, jsonResponse as a3, mapHostRouteError as a4, paymentsSchemaSql as a5, resolveClientIp as a6, startNotificationListener as a7, startNotificationWorker as a8, type AuthorizeAction as b, type AuthorizeContext as c, type AuthorizeResource as d, type CheckoutCreatedInput as e, type CreateHostDbOptions as f, type CreateHostOptions as g, type CreateHostRepositoryOptions as h, type CreateHttpHandlerOptions as i, type CreateStackOptions as j, type HostCheckoutPrice as k, HostError as l, HttpError as m, type HttpHandler as n, type NotificationWorker as o, OPENRECEIVE_RECONCILE_BATCH_SIZE as p, type PaymentRecord as q, type PaymentRepository as r, type PaymentSettlement as s, type PaymentSettlementHook as t, type RateLimit as u, type ReconciliationTransition as v, type ResolveCheckoutContext as w, type ResolveCheckoutHook as x, type ResolvedHostCheckout as y, type ServiceErrorShape as z };

package/dist/adapter-surface.d.ts

@@ -1,3 +1,3 @@
 export { Checkout, CreateCheckoutAmount, OpenReceive, PaymentCheck, SwapCheckout } from '@openreceive/node';
-export { a as Authorize, b as AuthorizeAction, c as AuthorizeContext, d as AuthorizeResource, C as CheckoutCreatedHook, e as CheckoutCreatedInput, i as CreateHttpHandlerOptions, j as CreateStackOptions, H as Host, k as HostError, l as HttpError, m as HttpHandler, I as IpRateLimitConfig, n as NotificationWorker, q as PaymentRepository, r as PaymentSettlement, s as PaymentSettlementHook, t as RateLimit, v as ResolveCheckoutContext, w as ResolveCheckoutHook, x as ResolvedHostCheckout, y as ServiceErrorShape, z as SettlementEvent, B as SettlementEventHook, L as Stack, M as StackStorage, Q as StackWallet, U as createHttpHandler, Z as createStack, $ as hostError, a0 as isServiceErrorShape, a3 as mapHostRouteError, a7 as startNotificationWorker } from './adapter-surface-BtXnvW2q.js';
+export { a as Authorize, b as AuthorizeAction, c as AuthorizeContext, d as AuthorizeResource, C as CheckoutCreatedHook, e as CheckoutCreatedInput, i as CreateHttpHandlerOptions, j as CreateStackOptions, H as Host, l as HostError, m as HttpError, n as HttpHandler, I as IpRateLimitConfig, o as NotificationWorker, r as PaymentRepository, s as PaymentSettlement, t as PaymentSettlementHook, u as RateLimit, w as ResolveCheckoutContext, x as ResolveCheckoutHook, y as ResolvedHostCheckout, z as ServiceErrorShape, B as SettlementEvent, D as SettlementEventHook, M as Stack, Q as StackStorage, T as StackWallet, V as createHttpHandler, _ as createStack, a0 as hostError, a1 as isServiceErrorShape, a4 as mapHostRouteError, a8 as startNotificationWorker } from './adapter-surface-CanN2Y1N.js';
 import '@openreceive/core';

package/dist/adapter-surface.js

@@ -7,7 +7,7 @@ import {
   isServiceErrorShape,
   mapHostRouteError,
   startNotificationWorker
-} from "./chunk-SVRY37Z4.js";
+} from "./chunk-EZAV3TC3.js";
 export {
   HostError,
   HttpError,

package/dist/{chunk-SVRY37Z4.js → chunk-EZAV3TC3.js}

@@ -842,7 +842,7 @@ function createHost(options) {
   };
   const resolveCheckout = async (context) => {
     if (context.action === "swap.quote" || context.action === "checkout.prepare") {
-      return { amount: await priceFor(context) };
+      return resolvedPrice(await priceFor(context));
     }
     const isCreate = context.action === "checkout.create" || context.action === "swap.create";
     const amount = isCreate ? await priceFor(context) : void 0;
@@ -884,8 +884,8 @@ function createHost(options) {
         );
       }
       const selected = matching[0];
-      if (selected === void 0) return { amount };
-      if (!isReusablePaymentAttempt(selected.expiresAt, now)) return { amount };
+      if (selected === void 0) return resolvedPrice(amount);
+      if (!isReusablePaymentAttempt(selected.expiresAt, now)) return resolvedPrice(amount);
       return resolvedPayment(amount, selected);
     }
     throw hostError("payment_hash is required for this action.", 400, "INVALID_REQUEST");
@@ -897,9 +897,20 @@ function createHost(options) {
     payments
   };
 }
+function describePrice(price) {
+  const description = price.description?.trim();
+  return description === void 0 || description.length === 0 ? {} : { description };
+}
+function priceOnly(price) {
+  const { description: _description, ...amount } = price;
+  return amount;
+}
+function resolvedPrice(price) {
+  return price === void 0 ? {} : { amount: priceOnly(price), ...describePrice(price) };
+}
 function resolvedPayment(amount, payment) {
   return {
-    ...amount === void 0 ? {} : { amount },
+    ...resolvedPrice(amount),
     paymentHash: payment.paymentHash,
     checkout: structuredClone(payment.checkout),
     // Carried so `payments/check` can serve the row path without re-listing
@@ -1600,6 +1611,7 @@ async function dispatch(runtime, request, requestId, native) {
       {
         reference,
         amount_msats: prepared.amountMsats,
+        ...resolved2.description === void 0 ? {} : { description: resolved2.description },
         fiat_quote: prepared.fiatQuote === null ? null : toSnakeCase(prepared.fiatQuote),
         payment_methods: toSnakeCase(swapOptions.options)
       },
@@ -1636,6 +1648,7 @@ async function dispatch(runtime, request, requestId, native) {
       201,
       {
         checkout: httpCheckout(checkout),
+        ...resolved2.description === void 0 ? {} : { description: resolved2.description },
         payment_methods: await warmPaymentMethods(runtime, checkout.amountMsats)
       },
       requestId

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { OpenReceive, PaymentCheck } from '@openreceive/node';
 export { Checkout, CreateCheckoutAmount, OpenReceive, PaymentCheck, SwapCheckout } from '@openreceive/node';
-import { H as Host, R as ReconcilableAttempt, S as SqlAdapter } from './adapter-surface-BtXnvW2q.js';
-export { A as AttemptStatus, a as Authorize, b as AuthorizeAction, c as AuthorizeContext, d as AuthorizeResource, C as CheckoutCreatedHook, e as CheckoutCreatedInput, f as CreateHostDbOptions, g as CreateHostOptions, h as CreateHostRepositoryOptions, i as CreateHttpHandlerOptions, j as CreateStackOptions, k as HostError, l as HttpError, m as HttpHandler, I as IpRateLimitConfig, N as NotificationListener, n as NotificationWorker, O as OPENRECEIVE_ATTEMPT_EXPIRY_GRACE_SECONDS, o as OPENRECEIVE_RECONCILE_BATCH_SIZE, P as PaymentInsert, p as PaymentRecord, q as PaymentRepository, r as PaymentSettlement, s as PaymentSettlementHook, t as RateLimit, u as ReconciliationTransition, v as ResolveCheckoutContext, w as ResolveCheckoutHook, x as ResolvedHostCheckout, y as ServiceErrorShape, z as SettlementEvent, B as SettlementEventHook, D as SettlementRecord, E as SqlClient, F as SqlDatabase, G as SqlPaymentRepository, J as SqlPaymentsOptions, K as SqlQuery, L as Stack, M as StackStorage, Q as StackWallet, T as createHost, U as createHttpHandler, V as createIpRateLimit, W as createProxyRateLimitingConfig, X as createRequestId, Y as createSqlPayments, Z as createStack, _ as errorResponse, $ as hostError, a0 as isServiceErrorShape, a1 as isStackOptions, a2 as jsonResponse, a3 as mapHostRouteError, a4 as paymentsSchemaSql, a5 as resolveClientIp, a6 as startNotificationListener, a7 as startNotificationWorker } from './adapter-surface-BtXnvW2q.js';
+import { H as Host, R as ReconcilableAttempt, S as SqlAdapter } from './adapter-surface-CanN2Y1N.js';
+export { A as AttemptStatus, a as Authorize, b as AuthorizeAction, c as AuthorizeContext, d as AuthorizeResource, C as CheckoutCreatedHook, e as CheckoutCreatedInput, f as CreateHostDbOptions, g as CreateHostOptions, h as CreateHostRepositoryOptions, i as CreateHttpHandlerOptions, j as CreateStackOptions, k as HostCheckoutPrice, l as HostError, m as HttpError, n as HttpHandler, I as IpRateLimitConfig, N as NotificationListener, o as NotificationWorker, O as OPENRECEIVE_ATTEMPT_EXPIRY_GRACE_SECONDS, p as OPENRECEIVE_RECONCILE_BATCH_SIZE, P as PaymentInsert, q as PaymentRecord, r as PaymentRepository, s as PaymentSettlement, t as PaymentSettlementHook, u as RateLimit, v as ReconciliationTransition, w as ResolveCheckoutContext, x as ResolveCheckoutHook, y as ResolvedHostCheckout, z as ServiceErrorShape, B as SettlementEvent, D as SettlementEventHook, E as SettlementRecord, F as SqlClient, G as SqlDatabase, J as SqlPaymentRepository, K as SqlPaymentsOptions, L as SqlQuery, M as Stack, Q as StackStorage, T as StackWallet, U as createHost, V as createHttpHandler, W as createIpRateLimit, X as createProxyRateLimitingConfig, Y as createRequestId, Z as createSqlPayments, _ as createStack, $ as errorResponse, a0 as hostError, a1 as isServiceErrorShape, a2 as isStackOptions, a3 as jsonResponse, a4 as mapHostRouteError, a5 as paymentsSchemaSql, a6 as resolveClientIp, a7 as startNotificationListener, a8 as startNotificationWorker } from './adapter-surface-CanN2Y1N.js';
 export { OPENRECEIVE_PAYMENTS_SCHEMA_VERSION } from '@openreceive/core';
 
 /** The pieces of a framework request the bridge needs, framework-agnostic. */
@@ -32,6 +32,7 @@ type WirePrepareCheckoutRequest = {
 type WirePrepareCheckoutResponse = {
     readonly reference: string;
     readonly amount_msats: number;
+    readonly description?: string;
     readonly fiat_quote?: null | WireFiatQuote;
     readonly payment_methods: readonly WirePaymentMethod[];
 };
@@ -54,6 +55,7 @@ type WireCheckout = {
 /** Wire shape of the OpenAPI `CreateCheckoutResponse` schema (snake_case JSON body). */
 type WireCreateCheckoutResponse = {
     readonly checkout: WireCheckout;
+    readonly description?: string;
     readonly payment_methods: readonly WirePaymentMethod[];
 };
 /** Wire shape of the OpenAPI `PaymentCheckRequest` schema (snake_case JSON body). */

package/dist/index.js

@@ -34,7 +34,7 @@ import {
   startReconciler,
   typeOrmDb,
   webRequest
-} from "./chunk-SVRY37Z4.js";
+} from "./chunk-EZAV3TC3.js";
 export {
   HostError,
   HttpError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openreceive/http",
-  "version": "0.2.4",
+  "version": "0.3.1",
   "description": "Framework-neutral (Web Request/Response) HTTP handler for OpenReceive checkout that builds on @openreceive/node and requires its Node runtime: request routing, host integration, and payment-attempt persistence.",
   "keywords": [
     "bitcoin",
@@ -17,8 +17,8 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@openreceive/core": "0.2.4",
-    "@openreceive/node": "0.2.4"
+    "@openreceive/core": "0.3.1",
+    "@openreceive/node": "0.3.1"
   },
   "exports": {
     ".": {