@openreceive/react 0.2.3 → 0.2.4

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, CheckoutSnapshot, AssetUrlResolver, BrowserLogContext, CheckoutInvoiceSnapshot, ThemePreference, ResolvedTheme, ThemeModel, PaymentDataSource, CheckoutPhase, CheckoutStatusModel, UnixSeconds, BrowserLogger, TransactionDetailsSource } from '@openreceive/browser/headless';
 export { TransactionDetailsSource, resolveTransactionDetailRows } from '@openreceive/browser/headless';
 
 interface CheckoutData {
@@ -152,7 +152,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 +221,14 @@ 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;
     readonly onError?: (error: unknown) => void;
     /**
      * Called when the payer enters or leaves the focused swap flow (a pay-in coin is
@@ -266,7 +283,16 @@ 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. */
+/**
+ * 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;