@openreceive/react 0.2.3 → 0.3.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { CheckoutComponentProps, CheckoutState, QrEncoder, BrowserLoggerOption, CheckoutStatusRefresh, Status, CheckoutSnapshot, BrowserLogContext, CheckoutInvoiceSnapshot, ThemePreference, ResolvedTheme, ThemeModel, PaymentDataSource, CheckoutPhase, CheckoutStatusModel, UnixSeconds, BrowserLogger, TransactionDetailsSource } from '@openreceive/browser/headless';
+import { CheckoutComponentProps, CheckoutState, QrEncoder, BrowserLoggerOption, CheckoutStatusRefresh, Status, SwapRefundStaging, CheckoutSnapshot, AssetUrlResolver, BrowserLogContext, CheckoutInvoiceSnapshot, ThemePreference, ResolvedTheme, ThemeModel, CheckoutPhase, CheckoutStatusModel, UnixSeconds, BrowserLogger, TransactionDetailsSource } from '@openreceive/browser/headless';
 export { TransactionDetailsSource, resolveTransactionDetailRows } from '@openreceive/browser/headless';
 
 interface CheckoutData {
@@ -49,7 +49,7 @@ interface UseCheckoutOptions extends CheckoutData, Omit<CheckoutEventHandlers, "
     readonly polling?: boolean;
     readonly pollIntervalMs?: number;
 }
-interface UseCheckoutResult extends CheckoutViewModel {
+interface UseCheckoutResult extends CheckoutViewModel, SwapRefundStaging {
     readonly checkout: CheckoutSnapshot;
     readonly copied: boolean;
     readonly countdownLabel?: string;
@@ -115,7 +115,9 @@ interface CheckoutClassNames extends InvoiceSummaryClassNames {
     readonly satsDetail?: string;
     readonly lightningPane?: string;
     readonly invoiceTitle?: string;
-    /** Applied to the settled payment-data disclosure. */
+    /** Applied to the host-supplied order description above the amount. */
+    readonly orderDescription?: string;
+    /** Applied to the settled transaction-details disclosure. */
     readonly details?: string;
     readonly waiting?: string;
     readonly countdown?: string;
@@ -152,7 +154,16 @@ interface CheckoutProps extends CheckoutComponentProps, CheckoutEventHandlers, O
     readonly refreshStatus?: CheckoutStatusRefresh;
     readonly components?: CheckoutComponents;
     readonly classNames?: CheckoutClassNames;
+    /**
+     * Render-prop or plain node rendered inside the checkout, above the payment
+     * panel. The slot for order context — a line-item summary, a thumbnail, a
+     * "you are buying" strip — which the shipped checkout otherwise never shows:
+     * it renders the amount, never the order. The function form receives the live
+     * `useCheckout` model.
+     */
     readonly children?: CheckoutChildren;
+    /** Passed through to the payment wizard. See {@link PaymentWizardProps.resolveAssetUrl}. */
+    readonly resolveAssetUrl?: AssetUrlResolver;
 }
 interface UseThemeOptions {
     readonly defaultTheme?: ThemePreference;
@@ -212,6 +223,27 @@ interface PaymentWizardProps {
     readonly qrEncoder?: QrEncoder;
     /** Base URL of an external bolt11 decoder; omitted, no "Decode" link is rendered. */
     readonly decodeLinkUrl?: string;
+    /**
+     * Rewrite a packaged asset path (`assets/provider-icons/strike.png`,
+     * `assets/icons/btc.svg`) into a URL this host can serve. The packaged URLs
+     * only resolve under Vite/Rollup; every other bundler needs this, or the
+     * method icons, provider logos and pay tutorials come out as dead `file://`
+     * links. See docs/guides/provider-registry.md.
+     */
+    readonly resolveAssetUrl?: AssetUrlResolver;
+    /**
+     * The string form of the same seam: where this host serves the packages'
+     * `dist/assets` trees. `resolveAssetUrl` wins when both are set.
+     */
+    readonly assetBaseUrl?: string;
+    /**
+     * The two-step refund, from whoever owns the checkout controller —
+     * `<Checkout>` passes its `useCheckout` model. Given one, the wizard stages
+     * and confirms through it, so the address the payer is reviewing survives
+     * every poll. Standalone (a host driving its own snapshot), the wizard falls
+     * back to posting the refund itself and carrying the staging locally.
+     */
+    readonly swapRefund?: SwapRefundStaging;
     readonly onError?: (error: unknown) => void;
     /**
      * Called when the payer enters or leaves the focused swap flow (a pay-in coin is
@@ -266,11 +298,6 @@ declare function QRCode(props: QRCodeProps): React.ReactElement;
 declare function CopyInvoiceButton(props: CopyInvoiceButtonProps): React.ReactElement;
 declare function OpenWalletButton(props: OpenWalletButtonProps): React.ReactElement;
 declare function PaymentState(props: PaymentStateProps): React.ReactElement;
-/** Collapsible "everything the client knows about this payment" panel, shown once settled. */
-declare function PaymentData(props: {
-    readonly source: PaymentDataSource;
-    readonly className?: string;
-}): React.ReactElement | null;
 declare function WaitingState(props: {
     readonly waiting?: boolean;
     readonly phase?: CheckoutPhase;
@@ -332,4 +359,4 @@ declare function createCheckoutViewModel(data: CheckoutData): CheckoutViewModel;
 
 declare function PaymentWizard(props: PaymentWizardProps): React.ReactElement;
 
-export { type ButtonComponent, Checkout, type CheckoutChildren, type CheckoutClassNames, type CheckoutComponents, type CheckoutData, type CheckoutProps, CheckoutProvider, type CheckoutProviderProps, type CheckoutViewModel, CopyInvoiceButton, type CopyInvoiceButtonProps, InvoiceSummary, type InvoiceSummaryClassNames, type InvoiceSummaryProps, OpenWalletButton, type OpenWalletButtonProps, PaymentData, PaymentState, type PaymentStateProps, PaymentWizard, type PaymentWizardProps, QRCode, type QRCodeProps, SatsDetail, type SatsDetailProps, ThemeScope, type ThemeScopeChildren, type ThemeScopeProps, ThemeToggle, type ThemeToggleProps, TransactionDetails, type TransactionDetailsProps, type UseCheckoutOptions, type UseCheckoutResult, type UseThemeOptions, type UseThemeResult, WaitingState, createCheckoutViewModel, renderSwapDepositPanel, useCheckout, useCheckoutContext, useTheme };
+export { type ButtonComponent, Checkout, type CheckoutChildren, type CheckoutClassNames, type CheckoutComponents, type CheckoutData, type CheckoutProps, CheckoutProvider, type CheckoutProviderProps, type CheckoutViewModel, CopyInvoiceButton, type CopyInvoiceButtonProps, InvoiceSummary, type InvoiceSummaryClassNames, type InvoiceSummaryProps, OpenWalletButton, type OpenWalletButtonProps, PaymentState, type PaymentStateProps, PaymentWizard, type PaymentWizardProps, QRCode, type QRCodeProps, SatsDetail, type SatsDetailProps, ThemeScope, type ThemeScopeChildren, type ThemeScopeProps, ThemeToggle, type ThemeToggleProps, TransactionDetails, type TransactionDetailsProps, type UseCheckoutOptions, type UseCheckoutResult, type UseThemeOptions, type UseThemeResult, WaitingState, createCheckoutViewModel, renderSwapDepositPanel, useCheckout, useCheckoutContext, useTheme };