@openreceive/browser 0.2.2 → 0.2.4

package/dist/headless.js

@@ -93,6 +93,7 @@ import {
   parseResolvedTheme,
   parseThemePreference,
   paymentAccentId,
+  paymentIconPaths,
   paymentIconUrls,
   paymentMethods,
   prepareCheckout,
@@ -105,13 +106,15 @@ import {
   sanitizeBrowserLogEntry,
   selectCheckoutDisplayInvoice,
   swapAssetMatchesRoute,
+  swapDepositRisk,
   swapGroupLimitOption,
   swapOptionLimitMessage,
+  swapOptionLimitSentence,
   swapPickerKey,
   updatePaymentWizardSelection,
   updateSelectedSwapNetworks,
   wizardNetworkGroupIds
-} from "./chunk-WLLNZH26.js";
+} from "./chunk-GA4FMG7L.js";
 
 // src/internal/checkout-props.ts
 var CREATE_MODE_ONLY_PROPS = [
@@ -866,6 +869,7 @@ export {
   parseResolvedTheme,
   parseThemePreference,
   paymentAccentId,
+  paymentIconPaths,
   paymentIconUrls,
   paymentMethods,
   postJson,
@@ -878,8 +882,10 @@ export {
   selectCheckoutDisplayInvoice,
   startSwapRequest,
   swapAssetMatchesRoute,
+  swapDepositRisk,
   swapGroupLimitOption,
   swapOptionLimitMessage,
+  swapOptionLimitSentence,
   swapPickerKey,
   syncStoredThemeControls,
   toggleStoredThemeControls,

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { aJ as BrowserLogLevel } from './status-B1vDOhvh.js';
-export { aK as BrowserLogEntry, V as BrowserLogger, B as BrowserLoggerOption, X as BrowserRequestError, Y as CheckoutController, Z as CheckoutControllerOptions, k as CheckoutSnapshot, h as CheckoutState, aL as CopyInvoiceOptions, aM as GuestCheckoutResumeController, aN as GuestCheckoutResumeOptions, aO as OpenWalletOptions, aP as PrepareCheckoutOptions, aQ as QrOptions, aR as RequestCheckoutOptions, aj as Status, aS as StatusInvoiceLike, U as UnixSeconds, am as copyInvoice, ao as createCheckoutController, aT as createGuestCheckoutResume, aU as createGuestOrderFetcher, aV as createLightningUri, aW as createQrPngDataUrl, at as createQrSvg, ax as deriveStatus, ay as enterCheckoutResumePath, aG as openWallet, aH as prepareCheckout, aI as requestCheckout } from './status-B1vDOhvh.js';
+import { aK as BrowserLogLevel } from './status-D3VhJsUp.js';
+export { aL as BrowserLogEntry, X as BrowserLogger, B as BrowserLoggerOption, Y as BrowserRequestError, Z as CheckoutController, _ as CheckoutControllerOptions, l as CheckoutSnapshot, i as CheckoutState, aM as CopyInvoiceOptions, aN as GuestCheckoutResumeController, aO as GuestCheckoutResumeOptions, aP as OpenWalletOptions, aQ as PrepareCheckoutOptions, aR as QrOptions, aS as RequestCheckoutOptions, ak as Status, aT as StatusInvoiceLike, U as UnixSeconds, an as copyInvoice, ap as createCheckoutController, aU as createGuestCheckoutResume, aV as createGuestOrderFetcher, aW as createLightningUri, aX as createQrPngDataUrl, au as createQrSvg, ay as deriveStatus, az as enterCheckoutResumePath, aH as openWallet, aI as prepareCheckout, aJ as requestCheckout } from './status-D3VhJsUp.js';
 import '@openreceive/provider-data';
 import '@openreceive/core';
 

package/dist/index.js

@@ -13,7 +13,7 @@ import {
   openWallet,
   prepareCheckout,
   requestCheckout
-} from "./chunk-WLLNZH26.js";
+} from "./chunk-GA4FMG7L.js";
 export {
   BrowserRequestError,
   copyInvoice,

package/dist/{status-B1vDOhvh.d.ts → status-D3VhJsUp.d.ts}

@@ -312,6 +312,11 @@ interface CopyInvoiceOptions {
 }
 interface OpenWalletOptions {
     invoice: string;
+    /**
+     * Where to send the `lightning:` URI. Omitted, {@link openWallet} calls
+     * `location.assign` on the CURRENT window, which navigates the payer off a
+     * still-polling checkout on any device that has a handler registered.
+     */
     open?: (uri: string) => void;
     logger?: BrowserLoggerOption;
     logContext?: BrowserLogContext;
@@ -385,17 +390,61 @@ interface SwapFeeBreakdown {
     /** The fee as a percentage of the cart total, e.g. "5.9%", when computable. */
     readonly feePercent?: string;
 }
+/**
+ * How a deposit on this rail can actually go missing, which is what decides how
+ * loud the deposit panel should be.
+ *
+ * The exposure comes from the deposit ADDRESS failing to pin the chain or the
+ * asset, never from whether the coin is native:
+ *
+ * - `chain_ambiguous` — the address is byte-identical on other chains, so a
+ *   withdrawal can land somewhere unreachable. Every EVM rail (`ETH_ETH`,
+ *   `USDT_ETH`, `USDC_ETH`): a `0x…` address is the same string on Ethereum,
+ *   Arbitrum, Optimism, Base, BSC and Polygon and carries nothing that says
+ *   which. A rail whose network OpenReceive cannot classify is reported here
+ *   too — an unrecognized format has no rule proving it is safe.
+ * - `asset_only` — the address format pins the chain, but the asset is a token
+ *   on it, and every exchange's withdrawal dropdown offers that ticker on a
+ *   dozen networks (`USDT_TRON`).
+ * - `pinned` — the address format pins the chain AND the asset is that chain's
+ *   native coin, so neither mistake is reachable (`SOL_SOL`). Sending an SPL
+ *   token to a Solana address still will not credit the order, so the panel
+ *   still states the exact amount — it just does not shout about lost funds.
+ *
+ * `chain_ambiguous` and `asset_only` both warrant the full alarm; they are kept
+ * apart because they are different mistakes and a custom UI may want to say so.
+ * Note the counter-intuitive half: `ETH_ETH` is a NATIVE coin and needs the
+ * alarm most of anything on the list.
+ */
+type SwapDepositRisk = "chain_ambiguous" | "asset_only" | "pinned";
 interface SwapDisplayModel {
     readonly provider: string;
     readonly attemptId: string;
     readonly payInAsset: string;
     readonly assetLabel: string;
     readonly networkLabel: string;
-    /** Strong deposit-panel alert title, e.g. "Wrong currency or network = lost funds". */
+    /**
+     * Which of the two ways a deposit is lost is reachable on this rail. Drives
+     * `networkWarningTitle`/`networkWarning` below, and is exposed so a custom UI
+     * can pick its own chrome without re-deriving the asset table. See
+     * {@link SwapDepositRisk}.
+     */
+    readonly depositRisk: SwapDepositRisk;
+    /**
+     * Deposit-panel heading. A strong alert ("Wrong currency or network = lost
+     * funds") when `depositRisk` is anything but `pinned`, and a quiet
+     * "Send the exact amount" when it is. A banner shown on every rail is read on
+     * none, and the rails where it is load-bearing are the ones that pay for it.
+     */
     readonly networkWarningTitle: string;
     /** Exact amount + asset + network to emphasize, e.g. "15.01 USDT on the Solana network". */
     readonly networkWarningEmphasis: string;
-    /** Full plain-text network warning (accessible / non-HTML consumers). */
+    /**
+     * Full plain-text network warning (accessible / non-HTML consumers). The
+     * lost-funds sentence is present only when `depositRisk` is not `pinned`; the
+     * "pay with one method only" sentence is on every rail, because double-paying
+     * is reachable on all of them.
+     */
     readonly networkWarning: string;
     readonly depositAddress: string;
     readonly depositMemo?: string;
@@ -828,6 +877,13 @@ interface WizardProviderDisplay {
     readonly kind: string;
     readonly url: string;
     readonly icon: string;
+    /**
+     * The packaged path the icon came from (`assets/provider-icons/strike.png`).
+     * `icon` is only loadable when the host's bundler resolved it; this is the
+     * key a host that serves the files itself maps, without going back to
+     * `providerRegistry` for `icon_path`.
+     */
+    readonly iconPath: string;
     readonly tutorials: readonly WizardProviderTutorialDisplay[];
     readonly copyLabel: string;
     readonly copiedLabel: string;
@@ -901,6 +957,23 @@ declare function createQrSvg(invoice: string, options?: QrOptions): Promise<stri
 declare function createQrPayloadSvg(payload: string, options?: QrOptions): Promise<string>;
 declare function createQrPngDataUrl(invoice: string, options?: QrOptions): Promise<string>;
 declare function copyInvoice(options: CopyInvoiceOptions): Promise<void>;
+/**
+ * Hand the invoice to the payer's wallet as a `lightning:` URI, and return the
+ * URI. **Touch devices.**
+ *
+ * The default path is `location.assign` on the CURRENT window — the right
+ * primitive for a custom-scheme deep link on a phone, and the wrong thing
+ * anywhere else. With no registered `lightning:` handler the call does nothing
+ * visible; with one, it navigates the payer off a checkout that is still
+ * polling `/payments/check`. Pass `open` to route the URI somewhere that is not
+ * the checkout window.
+ *
+ * This is why the shipped `<Checkout>` renders no wallet button of its own and
+ * exposes `components.OpenWalletButton` as an opt-in slot instead: a desktop
+ * payer is never sent to a handler that does not exist, next to the QR code
+ * that IS the desktop payment path. A custom UI drawing its own button owns
+ * that decision — see docs/guides/headless-checkout.md.
+ */
 declare function openWallet(options: OpenWalletOptions): string;
 
 declare function createCheckoutController(options: CheckoutControllerOptions): CheckoutController;
@@ -998,4 +1071,4 @@ declare function deriveStatus(invoice: StatusInvoiceLike, options?: {
     readonly now?: UnixSeconds;
 }): Status;
 
-export { type CheckoutStatusRefresh as $, type ThemeToggleElementAttributes as A, type BrowserLoggerOption as B, type CheckoutInvoiceSnapshot as C, type StoredThemeModelOptions as D, type ThemeModel as E, type ThemeModelOptions as F, type ReadThemePreferenceOptions as G, type ThemeControlTargets as H, type ThemeStorageOptions as I, type PaymentWizardControllerOptions as J, type PaymentWizardController as K, type PaymentWizardSelection as L, type PaymentWizardModel as M, type WizardRouteDisplay as N, type PaymentWizardSelectionAction as O, type ParseOpenReceiveOptionalIntegerOptions as P, type BrowserLogContext as Q, type ResolvedTheme as R, type SwapDisplayModel as S, type ThemePreference as T, type UnixSeconds as U, type BrowserLogger as V, type WizardRouteAssetDisplay as W, BrowserRequestError as X, type CheckoutController as Y, type CheckoutControllerOptions as Z, type CheckoutPhase as _, type PaymentMethod as a, OPENRECEIVE_CHECKOUT_DATA_ATTRIBUTES as a0, OPENRECEIVE_CHECKOUT_DATA_SELECTORS as a1, OPENRECEIVE_CHECKOUT_ELEMENT_ATTRIBUTES as a2, OPENRECEIVE_CHECKOUT_ELEMENT_EVENTS as a3, OPENRECEIVE_CHECKOUT_ELEMENT_PARTS as a4, OPENRECEIVE_CHECKOUT_ELEMENT_PART_SELECTORS as a5, OPENRECEIVE_CHECKOUT_ELEMENT_TAG_NAME as a6, OPENRECEIVE_COPY_FEEDBACK_MS as a7, OPENRECEIVE_DEFAULT_POLL_INTERVAL_MS as a8, OPENRECEIVE_DEFAULT_PREFIX as a9, formatAmountCaption as aA, formatDepositAmount as aB, formatFiatAmount as aC, formatMsats as aD, formatSwapLimit as aE, formatUnixTime as aF, openWallet as aG, prepareCheckout as aH, requestCheckout as aI, type BrowserLogLevel as aJ, type BrowserLogEntry as aK, type CopyInvoiceOptions as aL, type GuestCheckoutResumeController as aM, type GuestCheckoutResumeOptions as aN, type OpenWalletOptions as aO, type PrepareCheckoutOptions as aP, type QrOptions as aQ, type RequestCheckoutOptions as aR, type StatusInvoiceLike as aS, createGuestCheckoutResume as aT, createGuestOrderFetcher as aU, createLightningUri as aV, createQrPngDataUrl as aW, OPENRECEIVE_PAYMENT_WIZARD_ATTRIBUTES as aa, OPENRECEIVE_PAYMENT_WIZARD_SELECTORS as ab, OPENRECEIVE_THEME_STORAGE_KEY as ac, OPENRECEIVE_THEME_TOGGLE_ELEMENT_ATTRIBUTES as ad, OPENRECEIVE_THEME_TOGGLE_ELEMENT_EVENTS as ae, OPENRECEIVE_THEME_TOGGLE_ELEMENT_PARTS as af, OPENRECEIVE_THEME_TOGGLE_ELEMENT_PART_SELECTORS as ag, OPENRECEIVE_THEME_TOGGLE_ELEMENT_TAG_NAME as ah, type QrEncoder as ai, type Status as aj, type WizardProviderDisplay as ak, assertDisplayInvoice as al, copyInvoice as am, createCheckoutActionEvent as an, createCheckoutController as ao, createCheckoutErrorEvent as ap, createCheckoutProviderCopyEvent as aq, createCheckoutStateEvent as ar, createQrPayloadSvg as as, createQrSvg as at, createStatusFetcher as au, createThemeChangeEvent as av, deriveCheckoutStateLabels as aw, deriveStatus as ax, enterCheckoutResumePath as ay, escapeHtml as az, type PaymentMethodOption as b, type TickingValueOptions as c, type TickingValueController as d, type TransientFeedbackOptions as e, type TransientFeedbackController as f, type CheckoutInvoiceSwapSnapshot as g, type CheckoutState as h, type TransactionDetailsInput as i, type TransactionDetailRow as j, type CheckoutSnapshot as k, type CreateCheckoutStateOptions as l, type CheckoutStatusModelInput as m, type CheckoutStatusModel as n, type CheckoutPaymentMethod as o, type ThemeAttributeTarget as p, type CheckoutElementAttributes as q, type CheckoutElementAttributeOptions as r, type CheckoutElementEventHandlers as s, type CheckoutElementListeners as t, type CreateCheckoutShellOptions as u, type CheckoutShellElements as v, type CheckoutShellOptions as w, type CheckoutShellModel as x, type CreateOpenReceiveThemeToggleElementOptions as y, type ThemeToggleElementAttributeOptions as z };
+export { type CheckoutPhase as $, type ThemeToggleElementAttributeOptions as A, type BrowserLoggerOption as B, type CheckoutInvoiceSnapshot as C, type ThemeToggleElementAttributes as D, type StoredThemeModelOptions as E, type ThemeModel as F, type ThemeModelOptions as G, type ReadThemePreferenceOptions as H, type ThemeControlTargets as I, type ThemeStorageOptions as J, type PaymentWizardControllerOptions as K, type PaymentWizardController as L, type PaymentWizardSelection as M, type PaymentWizardModel as N, type WizardRouteDisplay as O, type ParseOpenReceiveOptionalIntegerOptions as P, type PaymentWizardSelectionAction as Q, type ResolvedTheme as R, type SwapDisplayModel as S, type ThemePreference as T, type UnixSeconds as U, type BrowserLogContext as V, type WizardRouteAssetDisplay as W, type BrowserLogger as X, BrowserRequestError as Y, type CheckoutController as Z, type CheckoutControllerOptions as _, type PaymentMethod as a, type CheckoutStatusRefresh as a0, OPENRECEIVE_CHECKOUT_DATA_ATTRIBUTES as a1, OPENRECEIVE_CHECKOUT_DATA_SELECTORS as a2, OPENRECEIVE_CHECKOUT_ELEMENT_ATTRIBUTES as a3, OPENRECEIVE_CHECKOUT_ELEMENT_EVENTS as a4, OPENRECEIVE_CHECKOUT_ELEMENT_PARTS as a5, OPENRECEIVE_CHECKOUT_ELEMENT_PART_SELECTORS as a6, OPENRECEIVE_CHECKOUT_ELEMENT_TAG_NAME as a7, OPENRECEIVE_COPY_FEEDBACK_MS as a8, OPENRECEIVE_DEFAULT_POLL_INTERVAL_MS as a9, escapeHtml as aA, formatAmountCaption as aB, formatDepositAmount as aC, formatFiatAmount as aD, formatMsats as aE, formatSwapLimit as aF, formatUnixTime as aG, openWallet as aH, prepareCheckout as aI, requestCheckout as aJ, type BrowserLogLevel as aK, type BrowserLogEntry as aL, type CopyInvoiceOptions as aM, type GuestCheckoutResumeController as aN, type GuestCheckoutResumeOptions as aO, type OpenWalletOptions as aP, type PrepareCheckoutOptions as aQ, type QrOptions as aR, type RequestCheckoutOptions as aS, type StatusInvoiceLike as aT, createGuestCheckoutResume as aU, createGuestOrderFetcher as aV, createLightningUri as aW, createQrPngDataUrl as aX, OPENRECEIVE_DEFAULT_PREFIX as aa, OPENRECEIVE_PAYMENT_WIZARD_ATTRIBUTES as ab, OPENRECEIVE_PAYMENT_WIZARD_SELECTORS as ac, OPENRECEIVE_THEME_STORAGE_KEY as ad, OPENRECEIVE_THEME_TOGGLE_ELEMENT_ATTRIBUTES as ae, OPENRECEIVE_THEME_TOGGLE_ELEMENT_EVENTS as af, OPENRECEIVE_THEME_TOGGLE_ELEMENT_PARTS as ag, OPENRECEIVE_THEME_TOGGLE_ELEMENT_PART_SELECTORS as ah, OPENRECEIVE_THEME_TOGGLE_ELEMENT_TAG_NAME as ai, type QrEncoder as aj, type Status as ak, type WizardProviderDisplay as al, assertDisplayInvoice as am, copyInvoice as an, createCheckoutActionEvent as ao, createCheckoutController as ap, createCheckoutErrorEvent as aq, createCheckoutProviderCopyEvent as ar, createCheckoutStateEvent as as, createQrPayloadSvg as at, createQrSvg as au, createStatusFetcher as av, createThemeChangeEvent as aw, deriveCheckoutStateLabels as ax, deriveStatus as ay, enterCheckoutResumePath as az, type PaymentMethodOption as b, type TickingValueOptions as c, type TickingValueController as d, type TransientFeedbackOptions as e, type TransientFeedbackController as f, type SwapDepositRisk as g, type CheckoutInvoiceSwapSnapshot as h, type CheckoutState as i, type TransactionDetailsInput as j, type TransactionDetailRow as k, type CheckoutSnapshot as l, type CreateCheckoutStateOptions as m, type CheckoutStatusModelInput as n, type CheckoutStatusModel as o, type CheckoutPaymentMethod as p, type ThemeAttributeTarget as q, type CheckoutElementAttributes as r, type CheckoutElementAttributeOptions as s, type CheckoutElementEventHandlers as t, type CheckoutElementListeners as u, type CreateCheckoutShellOptions as v, type CheckoutShellElements as w, type CheckoutShellOptions as x, type CheckoutShellModel as y, type CreateOpenReceiveThemeToggleElementOptions as z };