@openreceive/elements 0.1.0 → 0.2.1

package/dist/define-elements-CX8Ml6J4.d.ts

@@ -0,0 +1,108 @@
+import { Status, PaymentMethod, CheckoutPaymentMethod, CheckoutInvoiceSnapshot, SwapLimitContext, CheckoutState, QrEncoder, BrowserLoggerOption } from '@openreceive/browser/headless';
+
+interface CheckoutView {
+    readonly invoice_id?: string;
+    readonly invoice: string;
+    readonly rail?: "lightning" | "swap" | "checkout_lock";
+    readonly payment_hash?: string;
+    readonly amount_msats?: number;
+    readonly fiat_quote?: {
+        readonly fiat?: {
+            readonly currency?: string;
+            readonly value?: string;
+        };
+    } | null;
+    readonly status?: Status;
+    readonly expires_at?: number;
+    readonly theme?: "light" | "dark";
+    readonly payment_wizard?: boolean;
+    /**
+     * Base URL of a host-chosen bolt11 decoder, rendered as a "Decode" link.
+     * Omitted (the default), no link is rendered and the invoice — amount, payee,
+     * description, plus the payer's IP — never reaches a third party.
+     */
+    readonly decodeLinkUrl?: string;
+    /**
+     * `false` when the shadow root adopts the compiled stylesheet instead of
+     * carrying an inline `<style>` (see element-styles.ts). Default `true` so a
+     * standalone caller still gets self-contained markup.
+     */
+    readonly inlineStyles?: boolean;
+    /** False until the payer selects Bitcoin in create-mode (deferred Lightning mint). */
+    readonly lightningRequested?: boolean;
+    readonly wizard?: ElementsWizardView;
+    /**
+     * Live controller state, when the element has one. Preferred over the
+     * attribute-reconstructed state: after a swap re-key the attributes still
+     * describe the pre-swap Lightning attempt (or, in create mode, nothing).
+     */
+    readonly liveState?: CheckoutState;
+}
+interface ElementsWizardView {
+    readonly selectedMethod?: PaymentMethod | null;
+    readonly selectedBitcoinRoute?: string | null;
+    readonly swapOptions?: readonly ElementsSwapOption[];
+    /**
+     * True until the first order-status response supplies `payment_methods` /
+     * `swap_pay_options` (provider catalog warm-up). Shows a loader tile.
+     */
+    readonly currenciesLoading?: boolean;
+    /** Selected pay-in asset per multi-network coin label (e.g. USDT → USDT_TRON). */
+    readonly selectedSwapNetworks?: Readonly<Record<string, string>>;
+    /** Compact selector highlight: `method:bitcoin` or `swap:USDT`. */
+    readonly selectedPickerKey?: string | null;
+    /** Pay-in asset whose swap create is in flight — method tiles spin and disable. */
+    readonly startingSwapAsset?: string | null;
+    /** When set, the wizard shows the focused swap deposit flow for this pay-in asset. */
+    readonly selectedSwapAsset?: string | null;
+    /** Invoice amount + fiat, used to render fiat limit messages for out-of-range assets. */
+    readonly amountMsats?: number;
+    readonly fiat?: {
+        readonly currency?: string;
+        readonly value?: string;
+    };
+    readonly reference?: string;
+    readonly checkoutId?: string;
+    /** Display Lightning BOLT11 from the checkout (swap shadows may omit invoice). */
+    readonly lightningInvoice?: string;
+    /** Host-chosen bolt11 decoder base URL; omitted, the tutorial shows no decode link. */
+    readonly decodeLinkUrl?: string;
+    readonly paymentHash?: string;
+    readonly swapInvoice?: CheckoutInvoiceSnapshot;
+    readonly activeTutorialProviderId?: string | null;
+    readonly activeTutorialIndex?: number;
+    readonly activeTutorialCopied?: boolean;
+    /** Swap-start failure rendered inline in the deposit slot with a retry button. */
+    readonly swapStartError?: string;
+    /**
+     * The quote for the selected pay-in asset when it came back unavailable, so
+     * the deposit slot shows the accepted range instead of a generic error.
+     * Matches React's `renderSwapUnavailable` pane.
+     */
+    readonly unavailableSwapQuote?: CheckoutPaymentMethod;
+    /** Checkout context the unavailable panel converts invoice-side limits with. */
+    readonly swapLimitContext?: SwapLimitContext;
+    /** Wizard-level failure (e.g. Lightning mint) rendered inline. */
+    readonly wizardError?: string;
+}
+type ElementsSwapOption = CheckoutPaymentMethod;
+interface DefineElementsOptions {
+    readonly tagName?: string;
+    readonly themeToggleTagName?: string;
+    readonly registry?: CustomElementRegistry;
+    readonly qrEncoder?: QrEncoder;
+    readonly logger?: BrowserLoggerOption;
+}
+
+/**
+ * Register the OpenReceive custom elements with the browser's element
+ * registry. Until this runs, `<openreceive-checkout>` and
+ * `<openreceive-theme-toggle>` are unknown tags the browser renders as
+ * nothing; once it runs, every such tag on the page — already in the HTML or
+ * added later — upgrades into the live checkout / theme toggle. Call it once
+ * from your page's JS; order relative to the markup does not matter, and
+ * calling it again skips tags that are already defined.
+ */
+declare function defineElements(options?: DefineElementsOptions): void;
+
+export { type CheckoutView as C, type DefineElementsOptions as D, type ElementsWizardView as E, defineElements as d };

package/dist/index.d.ts

@@ -1,42 +1,42 @@
-import { type OpenReceiveBrowserLogger, type OpenReceivePaymentMethod, type OpenReceiveQrEncoder, type OpenReceiveRegionId, formatOpenReceiveMsats, type Status } from "@openreceive/browser/internal";
-export interface CheckoutView {
-    readonly invoice_id?: string;
-    readonly invoice: string;
-    readonly payment_hash?: string;
-    readonly amount_msats?: number;
-    readonly fiat_quote?: {
-        readonly fiat?: {
-            readonly currency?: string;
-            readonly value?: string;
-        };
-    } | null;
-    readonly status?: Status;
-    readonly expires_at?: number;
-    readonly theme?: "light" | "dark";
-    readonly payment_wizard?: boolean;
-    readonly wizard?: OpenReceiveElementsWizardView;
-}
-export interface OpenReceiveElementsWizardView {
-    readonly selectedMethod?: OpenReceivePaymentMethod | null;
-    readonly selectedCountryCode?: string;
-    readonly selectedBitcoinRoute?: string | null;
-    readonly selectedCryptoRoute?: string | null;
-    readonly selectedRegion?: OpenReceiveRegionId;
-    readonly countryPickerOpen?: boolean;
-    readonly activeTutorialProviderId?: string | null;
-    readonly activeTutorialIndex?: number;
-    readonly activeTutorialCopied?: boolean;
+import { TransactionDetailsSource } from '@openreceive/browser/headless';
+export { OPENRECEIVE_CHECKOUT_ELEMENT_ATTRIBUTES, OPENRECEIVE_CHECKOUT_ELEMENT_EVENTS, OPENRECEIVE_CHECKOUT_ELEMENT_TAG_NAME, OPENRECEIVE_THEME_TOGGLE_ELEMENT_ATTRIBUTES, OPENRECEIVE_THEME_TOGGLE_ELEMENT_EVENTS, OPENRECEIVE_THEME_TOGGLE_ELEMENT_TAG_NAME, TransactionDetailsSource, createThemeToggleElement } from '@openreceive/browser/headless';
+import { C as CheckoutView } from './define-elements-CX8Ml6J4.js';
+export { D as DefineElementsOptions, E as ElementsWizardView, d as defineElements } from './define-elements-CX8Ml6J4.js';
+
+declare function renderCheckoutHtml(view: CheckoutView): string;
+/**
+ * `false` when the caller adopts the compiled stylesheet into the shadow root
+ * instead (see element-styles.ts); the markup then carries no `<style>`.
+ */
+interface RenderOpenReceiveStyleOptions {
+    readonly inlineStyles?: boolean;
 }
-export interface DefineOpenReceiveElementsOptions {
-    readonly tagName?: string;
-    readonly themeToggleTagName?: string;
-    readonly registry?: CustomElementRegistry;
-    readonly qrEncoder?: OpenReceiveQrEncoder;
-    readonly logger?: OpenReceiveBrowserLogger;
-}
-export { OPENRECEIVE_THEME_TOGGLE_ELEMENT_TAG_NAME } from "@openreceive/browser/internal";
-export declare function renderCheckoutHtml(view: CheckoutView): string;
-export declare function renderOpenReceiveThemeToggleHtml(label: string, resolvedTheme?: "light" | "dark"): string;
-export declare function renderOpenReceivePaymentWizardHtml(view?: OpenReceiveElementsWizardView): string;
-export declare function defineOpenReceiveElements(options?: DefineOpenReceiveElementsOptions): void;
-export declare const formatMsats: typeof formatOpenReceiveMsats;
+/**
+ * The element's ONE failure panel: inline message, never an endless spinner and
+ * never an empty shadow root.
+ *
+ * It shows the create-mode prepare failure, which is always re-runnable — the
+ * payer clicks and the element POSTs again — so the panel always carries the
+ * retry button.
+ */
+declare function renderCheckoutCreateErrorHtml(message: string, options?: RenderOpenReceiveStyleOptions & {
+    readonly theme?: "light" | "dark";
+}): string;
+declare function renderThemeToggleHtml(label: string, options?: RenderOpenReceiveStyleOptions): string;
+
+/**
+ * Collapsible transaction-details panel as an HTML string (vanilla / elements hosts).
+ * Uses the same row builder as React `<TransactionDetails>`.
+ */
+declare function renderTransactionDetailsHtml(source: TransactionDetailsSource, options?: {
+    readonly open?: boolean;
+    readonly className?: string;
+}): string;
+declare function createTransactionDetailsElement(source: TransactionDetailsSource, options?: {
+    readonly open?: boolean;
+    readonly className?: string;
+    readonly onCopyError?: (error: unknown) => void;
+    readonly document?: Document;
+}): HTMLElement | null;
+
+export { CheckoutView, createTransactionDetailsElement, renderCheckoutCreateErrorHtml, renderCheckoutHtml, renderThemeToggleHtml, renderTransactionDetailsHtml };