@openreceive/react 0.2.4 → 0.3.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { CheckoutComponentProps, CheckoutState, QrEncoder, BrowserLoggerOption, CheckoutStatusRefresh, Status, CheckoutSnapshot, AssetUrlResolver, 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;
@@ -229,6 +231,27 @@ interface PaymentWizardProps {
      * 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;
+    /**
+     * Whether this checkout has a URL the payer can come BACK to — `<Checkout
+     * syncUrl>`, or a host route of its own that carries the order. It decides
+     * which of the two refund-return warnings the deposit panel shows; see
+     * `SwapDisplayModel.refundReturnLabel`. Defaults to false, so a payer is
+     * never told to bookmark a page that will not bring them back.
+     */
+    readonly resumable?: boolean;
     readonly onError?: (error: unknown) => void;
     /**
      * Called when the payer enters or leaves the focused swap flow (a pay-in coin is
@@ -283,20 +306,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.
- *
- * @deprecated Superseded by `<TransactionDetails>`, which the shipped checkout
- * now renders on settlement. This one has no copy button, no explorer link and
- * no truncation contract, and its rows are a strict subset — so the payer's
- * most keep-worthy screen had the least usable copy of the values it shows.
- * Kept exported so an integrator who mounted it directly is not broken; new
- * code should use `<TransactionDetails>`.
- */
-declare function PaymentData(props: {
-    readonly source: PaymentDataSource;
-    readonly className?: string;
-}): React.ReactElement | null;
 declare function WaitingState(props: {
     readonly waiting?: boolean;
     readonly phase?: CheckoutPhase;
@@ -321,6 +330,8 @@ declare function renderSwapDepositPanel(options: {
     readonly onError?: (error: unknown) => void;
     readonly onRefund: (attemptId: string, refundAddress: string, confirm: boolean) => Promise<void>;
     readonly onBackToLightning: () => void;
+    /** Does this checkout have a URL to return to? See `refundReturnLabel`. */
+    readonly resumable?: boolean;
 }): React.ReactElement | null;
 
 declare function useTheme(options?: UseThemeOptions): UseThemeResult;
@@ -358,4 +369,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 };