@coinlist-co/react 0.12.0 → 0.12.1-rc.0fa5c3b

package/dist/client/index.d.cts

@@ -1,9 +1,9 @@
 import * as react from 'react';
 import { ReactNode, ButtonHTMLAttributes } from 'react';
-import { A as AuthorizationCode, C as CodeVerifier, L as Logger, W as WalletError, E as Erc20Namespace, a as EthereumChain, b as EvmContractAddress, B as BlockchainAmount, c as CoinListTokenSaleNamespace, O as OfferId, d as OfferOptionId, e as AssetId, P as Participation, f as CoinListTokenSaleNamespaceImpl, U as UniversalNamespaceContext, g as OndoNamespace, h as AssetSymbol, i as OfferSwapContract, j as OndoBuyTransaction, k as OndoSellTransaction, l as OndoSwapTransactionCore, m as OrderBookSide, n as OndoNamespaceImpl, S as SuperstateSwapNamespace, o as WalletsNamespace, p as Bps, q as EvmWalletAddress, r as SuperstateSwapNamespaceImpl, R as RequirementsNamespace, s as Requirement, t as RequirementsNamespaceImpl, u as Config, v as OAuthAccessToken, w as OffersNamespace, T as TokensNamespace, x as StablecoinSymbol, y as Erc20Asset, z as OfferDetail, D as TokenMetadata, F as OfferType, G as Offer, H as RequirementStatusInfo, I as RequirementType, J as RequirementStatusValue, K as OfferOptionAddress, M as RequirementId, N as KycLevelName, Q as DocumentSubmission, V as WalletChallengeType, X as PinoLoggerOptions, Y as OndoTradingStatus, Z as AssetDecimals, _ as BuildOndoBuyParams, $ as BuildOndoSellParams, a0 as OndoQuote, a1 as OndoQuoteSize, a2 as TokenIdentifier, a3 as OfferOptionAddressId, a4 as TokenLogo } from '../config-DIaFzrMW.cjs';
-export { a5 as DebugEvent, a6 as FrontlineEventId, a7 as HttpError, a8 as HttpResponse, a9 as KycToken, aa as LogBinding, ab as LogBindings, ac as LogCause, ad as LogLevel, ae as LogScope, af as LogValue, ag as ProductionLogLevel, ah as RedactedWalletError, ai as RequestId, aj as SafeEvent, ak as SafeFields, al as UnredactedFields } from '../config-DIaFzrMW.cjs';
-import { P as PKCEConfig, E as EvmWallet, S as SwapQuote, A as AssetIconUrl, a as ShortenedWalletAddress, F as FormattedAmountAssetUi, b as FormattedPercentUi, T as TxExplorerUrl, C as ConnectWallet, N as NonEmptyArray } from '../collections-DOm9VKVm.cjs';
-export { B as BroadcastTxParams, c as EvmSigner, W as WriteContractParams } from '../collections-DOm9VKVm.cjs';
+import { A as AuthorizationCode, C as CodeVerifier, L as Logger, W as WalletError, E as Erc20Namespace, a as EthereumChain, b as EvmContractAddress, B as BlockchainAmount, c as CoinListTokenSaleNamespace, O as OfferId, d as OfferOptionId, e as AssetId, P as Participation, f as CoinListTokenSaleNamespaceImpl, U as UniversalNamespaceContext, g as OndoNamespace, h as AssetSymbol, i as OfferSwapContract, j as OndoBuyTransaction, k as OndoSellTransaction, l as OndoSwapTransactionCore, m as OrderBookSide, n as OndoNamespaceImpl, S as SuperstateSwapNamespace, o as WalletsNamespace, p as Bps, q as EvmWalletAddress, r as SuperstateSwapNamespaceImpl, R as RequirementsNamespace, s as Requirement, t as RequirementsNamespaceImpl, u as Config, v as OAuthAccessToken, w as OffersNamespace, T as TokensNamespace, x as StablecoinSymbol, y as Erc20Asset, z as OfferDetail, D as TokenMetadata, F as OfferType, G as Offer, H as RequirementStatusInfo, I as RequirementType, J as RequirementStatusValue, K as OfferOptionAddress, M as RequirementId, N as KycLevelName, Q as DocumentSubmission, V as WalletChallengeType, X as PinoLoggerOptions, Y as OndoTradingStatus, Z as AssetDecimals, _ as BuildOndoBuyParams, $ as BuildOndoSellParams, a0 as OndoQuote, a1 as OndoQuoteSize, a2 as TokenIdentifier, a3 as OfferOptionAddressId, a4 as TokenLogo } from '../tokens-namespace-C-BxcYMj.cjs';
+export { a5 as DebugEvent, a6 as FrontlineEventId, a7 as HttpError, a8 as HttpResponse, a9 as KycToken, aa as LogBinding, ab as LogBindings, ac as LogCause, ad as LogLevel, ae as LogScope, af as LogValue, ag as ProductionLogLevel, ah as RedactedWalletError, ai as RequestId, aj as RpcFailureReason, ak as SafeEvent, al as SafeFields, am as UnredactedFields } from '../tokens-namespace-C-BxcYMj.cjs';
+import { P as PKCEConfig, E as EvmWallet, S as SwapQuote, A as AssetIconUrl, a as ShortenedWalletAddress, F as FormattedAmountAssetUi, b as FormattedPercentUi, T as TxExplorerUrl, C as ConnectWallet, N as NonEmptyArray } from '../collections-UYVlXbEh.cjs';
+export { B as BroadcastTxParams, c as EvmSigner, W as WriteContractParams } from '../collections-UYVlXbEh.cjs';
 import { Hash } from 'viem';
 import * as class_variance_authority_types from 'class-variance-authority/types';
 import { VariantProps } from 'class-variance-authority';
@@ -508,6 +508,14 @@ type SwapExecutionPhase = 'checking-status' | 'checking-allowance' | 'resetting-
 /** A step-tagged reason {@link executeSwap} failed. */
 type SwapExecutionError = {
     step: 'status-check';
+}
+/**
+ * The contract has suspended swapping and may resume. Distinct from
+ * `swap-stopped`, which is permanent, so a host can say "try again shortly"
+ * to one and "this swap has closed" to the other.
+ */
+ | {
+    step: 'swap-paused';
 } | {
     step: 'swap-stopped';
 } | Erc20AllowanceError | {
@@ -1507,11 +1515,8 @@ type OndoCheckoutConfig = {
      * catalogue does agree can return `AssetSymbol(offer.asset.code)`; one whose
      * does not maps the exceptions.
      *
-     * Must be total. Ondo's viewmodel is called for every offer - React hooks
-     * cannot be called conditionally - so this runs for Superstate and
-     * token-sale offers too, where its result is passed to a viewmodel that is
-     * `enabled: false` and never reads it. Throwing on an offer you do not
-     * recognise would take down a checkout Ondo has no part in; return anything.
+     * Called only for an `ondo::swap` offer, when that branch is mounted. A
+     * Superstate or token-sale checkout never runs it.
      */
     symbol: (offer: OfferDetail) => AssetSymbol;
     /**
@@ -1524,10 +1529,8 @@ type OndoCheckoutConfig = {
      * page rather than of the catalogue. A host closes over whatever selects the
      * direction - a route, a tab - and returns it.
      *
-     * Still called for every offer, Superstate's and the token sale's included,
-     * because both Ondo viewmodels are called unconditionally; on those its
-     * answer is handed to a viewmodel that is `enabled: false` and never reads
-     * it. Nothing to be total over, so nothing to get wrong.
+     * Called only for an `ondo::swap` offer, when that branch is mounted. A
+     * Superstate or token-sale checkout never runs it.
      *
      * Required, with no default. The wire parameter behind it defaults to `buy`
      * silently, and the day sell ships an unstated direction should be a compile
@@ -1613,8 +1616,8 @@ interface CheckoutContainerProps {
     /** What each offer type needs beyond the offer itself. */
     config: CheckoutConfig;
     /**
-     * Default `true`. `false` turns off every request and timer in every
-     * provider, for a checkout that is mounted but not on screen yet.
+     * Default `true`. `false` turns off every request and timer in the mounted
+     * provider, for a checkout that is on the tree but not on screen yet.
      */
     enabled?: boolean;
     className?: string;
@@ -1623,11 +1626,10 @@ interface CheckoutContainerProps {
  * The plug-and-play checkout: hand it an offer and it renders the right
  * provider's flow.
  *
- * Every provider's viewmodel is called on every render, because React hooks
- * cannot be called conditionally — and both Ondo products, since `side` picks
- * between them at the same level. Only the one matching `offer.type` and
- * `side` is `enabled`, so the rest fetch nothing and run no timers — that
- * `enabled` flag is why every checkout viewmodel has one.
+ * Only the matching provider's container is mounted, so its viewmodel is the
+ * only one that runs. `enabled` is forwarded as-is — a pause for a checkout
+ * that is mounted but not on screen yet, not a stand-in for the offer-type
+ * switch.
  *
  * The `switch` is exhaustive against `OfferType`, and the `default` branch
  * assigns to `const exhaustive: never`, so a new offer type is a compile error
@@ -1901,19 +1903,30 @@ type OndoCheckoutErrorReason =
 type OndoSidebarUiState = {
     asset: CheckoutAssetUi;
     /**
-     * Who issues the asset, e.g. `Ondo Global Markets`.
-     *
-     * `null` hides the row. No frontline endpoint carries an issuer today, so
-     * absence is the normal case rather than an edge one — the same reasoning as
-     * `coinlistFee` on the review step.
+     * Who issues the *token*, e.g. `Ondo Global Markets` — not the issuer of the
+     * security it tracks, which is the asset's own name. `null` hides the row.
      */
     issuer: string | null;
     /** The underlying's ticker, e.g. `AAPL` — not the token symbol. `null` hides the row. */
     tickerSymbol: string | null;
-    /** The underlying's ISIN, e.g. `US0378331005`. `null` hides the row. */
+    /**
+     * The underlying's ISIN, e.g. `US0378331005`. `null` hides the row, and is
+     * the normal case for the few securities the supplier publishes none for.
+     */
     isin: string | null;
-    /** What kind of instrument it is, e.g. `Common Stock`. `null` hides the row. */
+    /**
+     * What kind of instrument it is, in the supplier's own vocabulary — a common
+     * stock arrives as `Stock`, not `Common Stock`. Rendered as given, never
+     * branched on, because the vocabulary can grow. `null` hides the row.
+     */
     assetType: string | null;
+    /**
+     * The venue the underlying lists on, e.g. `NASDAQ`. Unlike the rows above it
+     * is recorded by hand rather than served by the supplier, so `null` — which
+     * hides the row — is the normal state until someone records it, and says
+     * nothing about whether the offer tokenizes a security.
+     */
+    listingVenue: string | null;
     /** Display name of the chain the token lives on, e.g. `Ethereum`. */
     networkName: string;
     price: OndoSidebarPriceUi;
@@ -2118,8 +2131,8 @@ interface OndoBuyCheckoutContainerProps {
      */
     wallets: CheckoutWalletSelection;
     /**
-     * Default `true`. `false` turns off every request and timer, which is what
-     * `CheckoutContainer` uses to call each provider's checkout unconditionally.
+     * Default `true`. `false` turns off every request and timer, for a checkout
+     * that is mounted but not on screen yet.
      */
     enabled?: boolean;
     /** Fired once the swap has mined. The dialog shows either way. */
@@ -2555,8 +2568,8 @@ interface OndoSellCheckoutContainerProps {
      */
     wallets: CheckoutWalletSelection;
     /**
-     * Default `true`. `false` turns off every request and timer, which is what
-     * `CheckoutContainer` uses to call each provider's checkout unconditionally.
+     * Default `true`. `false` turns off every request and timer, for a checkout
+     * that is mounted but not on screen yet.
      */
     enabled?: boolean;
     /** Fired once the swap has mined. The dialog shows either way. */
@@ -3095,8 +3108,8 @@ interface SuperstateSwapCheckoutContainerProps {
      */
     wallets: CheckoutWalletSelection;
     /**
-     * Default `true`. `false` turns off every request and timer, which is what
-     * `CheckoutContainer` uses to call each provider's checkout unconditionally.
+     * Default `true`. `false` turns off every request and timer, for a checkout
+     * that is mounted but not on screen yet.
      */
     enabled?: boolean;
     /** Fired once the swap has mined. The dialog shows either way. */
@@ -3238,6 +3251,11 @@ interface OffersGridContainerProps {
      * fetch entirely.
      */
     data?: Offer[];
+    /**
+     * Default `true`. When `false` nothing is fetched, so the container can be
+     * mounted while the grid is not needed yet.
+     */
+    enabled?: boolean;
 }
 /**
  * Displays a responsive live-sale grid of {@link OfferSaleCard}, backed by
@@ -3246,14 +3264,16 @@ interface OffersGridContainerProps {
  * past-sales browse rows, compose {@link OffersAssetGrid} instead.
  *
  * Pass `data` (pre-fetched server-side) to use that data as-is and skip the
- * client-side fetch entirely. Uses the `loading` / `error` / `emptyState` slots
- * when provided; otherwise renders the standard fallbacks. Cards are
- * interactive only when `onOfferClick` is provided.
+ * client-side fetch entirely. Pass `enabled={false}` to skip the fetch when
+ * the container is mounted but the grid is not needed yet. Uses the
+ * `loading` / `error` / `emptyState` slots when provided; otherwise renders
+ * the standard fallbacks. Cards are interactive only when `onOfferClick` is
+ * provided.
  *
  * Self-scoped: renders fully styled on its own, with no `CoinListStyleScope`
  * needed.
  */
-declare function OffersGridContainer({ data, onOfferClick, ...viewProps }?: OffersGridContainerProps): ReactNode;
+declare function OffersGridContainer({ data, onOfferClick, enabled, ...viewProps }?: OffersGridContainerProps): ReactNode;
 
 /**
  * An offer as {@link OfferSaleCard} renders it. Countdown copy is derived in
@@ -3630,6 +3650,12 @@ interface UseRequirementsOptions {
      * Calling `refetch()` will still trigger a fresh fetch.
      */
     data?: RequirementsData;
+    /**
+     * When `false`, the hook sends no request. A seeded or already-fetched
+     * `CONTENT` survives; otherwise the hook stays `LOADING`. Defaults to `true`.
+     * `refetch()` is a no-op while disabled.
+     */
+    enabled?: boolean;
 }
 interface UseRequirementsResult {
     requirementsState: LoadRequirementsState;
@@ -3642,6 +3668,8 @@ interface UseRequirementsResult {
  *
  * Pass `data` (pre-fetched server-side) to use that data as-is and skip
  * the initial client-side fetch. Calling `refetch()` will still trigger a fresh fetch.
+ * Pass `enabled: false` to skip the fetch when the hook must be called but
+ * the data is not needed yet.
  *
  * Returns `LOADING` while CoinList is initializing or while data is being fetched.
  * Returns `CONTENT` with requirements and statuses on success.
@@ -3709,6 +3737,11 @@ interface RequirementsChecklistContainerProps {
      * not part of `RequirementsData` and are always fetched client-side.
      */
     data?: RequirementsData;
+    /**
+     * Default `true`. When `false` nothing is fetched, so the container can be
+     * mounted while the checklist is not needed yet.
+     */
+    enabled?: boolean;
     /**
      * Options for the inline Sumsub verification flow, shown when
      * `onRequirementActionOverride` is not provided. The flow starts whenever
@@ -3729,7 +3762,8 @@ interface RequirementsChecklistContainerProps {
  * specified option.
  *
  * Pass `data` (pre-fetched server-side) to use that data as-is and skip the
- * initial client-side fetch.
+ * initial client-side fetch. Pass `enabled={false}` to skip fetches when the
+ * container is mounted but the checklist is not needed yet.
  *
  * When the user is not authenticated, renders a sign-in card instead of the
  * checklist - without fetching. Pass `unauthenticatedState` to customize that
@@ -3743,7 +3777,7 @@ interface RequirementsChecklistContainerProps {
  *
  * Self-scoped: renders fully styled on its own, with no `CoinListStyleScope` needed.
  */
-declare function RequirementsChecklistContainer({ loading, error, unauthenticatedState, className, ...options }: RequirementsChecklistContainerProps): ReactNode;
+declare function RequirementsChecklistContainer({ loading, error, unauthenticatedState, className, enabled, ...options }: RequirementsChecklistContainerProps): ReactNode;
 
 interface RequirementsChecklistViewProps {
     state: RequirementsChecklistUiState;
@@ -4196,6 +4230,11 @@ interface UseParticipationsOptions {
      * When provided, the hook uses this data as-is and skips the client-side fetch entirely.
      */
     data?: Participation[];
+    /**
+     * When `false`, the hook sends no request. A seeded or already-fetched
+     * `CONTENT` survives; otherwise the hook stays `LOADING`. Defaults to `true`.
+     */
+    enabled?: boolean;
 }
 interface UseParticipationsResult {
     participationsState: LoadParticipationsState;
@@ -4205,7 +4244,8 @@ interface UseParticipationsResult {
  * Optionally filters by offer when `offerId` is provided.
  *
  * Pass `data` (pre-fetched server-side) to use that data as-is and skip
- * the client-side fetch entirely.
+ * the client-side fetch entirely. Pass `enabled: false` to skip the fetch
+ * when the hook must be called but the data is not needed yet.
  *
  * Returns `LOADING` while CoinList is initializing or while participations are being fetched.
  * Returns `CONTENT` with all participations when `fetchParticipations()` succeeds.
@@ -4519,8 +4559,8 @@ interface UseOndoBuyCheckoutViewModelOptions {
     /** The host's wallets, and the lambdas that connect and disconnect one. */
     wallets: CheckoutWalletSelection;
     /**
-     * Default `true`. When `false` nothing is fetched and no timer runs, so the
-     * hook can be called unconditionally beside other providers' viewmodels.
+     * Default `true`. When `false` nothing is fetched and no timer runs, for a
+     * checkout that is mounted but not on screen yet.
      */
     enabled?: boolean;
     /**
@@ -4902,8 +4942,8 @@ interface UseOndoSellCheckoutViewModelOptions {
      */
     wallets: CheckoutWalletSelection;
     /**
-     * Default `true`. When `false` nothing is fetched and no timer runs, so the
-     * hook can be called unconditionally beside other providers' viewmodels.
+     * Default `true`. When `false` nothing is fetched and no timer runs, for a
+     * checkout that is mounted but not on screen yet.
      */
     enabled?: boolean;
     /**
@@ -5539,8 +5579,8 @@ interface UseSuperstateSwapCheckoutViewModelOptions {
     /** The host's wallets, and the lambdas that connect and disconnect one. */
     wallets: CheckoutWalletSelection;
     /**
-     * Default `true`. When `false` nothing is fetched and no timer runs, so the
-     * hook can be called unconditionally beside other providers' viewmodels.
+     * Default `true`. When `false` nothing is fetched and no timer runs, for a
+     * checkout that is mounted but not on screen yet.
      */
     enabled?: boolean;
     /**
@@ -5649,6 +5689,11 @@ interface UseOfferDetailsOptions {
      * When provided, the hook uses this data as-is and skips the client-side fetch entirely.
      */
     data?: OfferDetail;
+    /**
+     * When `false`, the hook sends no request. A seeded or already-fetched
+     * `CONTENT` survives; otherwise the hook stays `LOADING`. Defaults to `true`.
+     */
+    enabled?: boolean;
 }
 interface UseOfferDetailsResult {
     offerDetailsState: LoadOfferDetailsState;
@@ -5657,7 +5702,8 @@ interface UseOfferDetailsResult {
  * Loads CoinList offer details for a given offer id and exposes a UI-friendly state.
  *
  * Pass `data` (pre-fetched server-side) to use that data as-is and skip
- * the client-side fetch entirely.
+ * the client-side fetch entirely. Pass `enabled: false` to skip the fetch
+ * when the hook must be called but the data is not needed yet.
  *
  * Returns `LOADING` while CoinList is initializing or while details are being fetched.
  * Returns `CONTENT` with the offer when `offers.get()` succeeds.
@@ -5683,6 +5729,11 @@ interface UseOffersOptions {
      * When provided, the hook uses this data as-is and skips the client-side fetch entirely.
      */
     data?: Offer[];
+    /**
+     * When `false`, the hook sends no request. A seeded or already-fetched
+     * `CONTENT` survives; otherwise the hook stays `LOADING`. Defaults to `true`.
+     */
+    enabled?: boolean;
 }
 interface UseOffersResult {
     offersState: LoadOffersState;
@@ -5691,7 +5742,8 @@ interface UseOffersResult {
  * Loads all CoinList offers for the current user and exposes a UI-friendly state.
  *
  * Pass `data` (pre-fetched server-side) to use that data as-is and skip
- * the client-side fetch entirely.
+ * the client-side fetch entirely. Pass `enabled: false` to skip the fetch
+ * when the hook must be called but the data is not needed yet.
  *
  * Returns `LOADING` while CoinList is initializing or while offers are being fetched.
  * Returns `CONTENT` with all offers when `fetchOffers()` succeeds.
@@ -5707,6 +5759,11 @@ interface UseOffersGridViewModelOptions {
      * When provided, the client-side fetch is skipped entirely.
      */
     data?: Offer[];
+    /**
+     * Default `true`. When `false` nothing is fetched, so the hook can be called
+     * unconditionally while the grid is not needed yet.
+     */
+    enabled?: boolean;
     /** Called with the domain offer behind the card the user clicked. */
     onOfferClick?: (offer: Offer) => void;
 }
@@ -5717,6 +5774,9 @@ interface UseOffersGridViewModelResult {
 /**
  * Drives {@link OffersGridView}: loads the offers, formats them for the cards,
  * and resolves a clicked card back to its domain offer for the host callback.
+ *
+ * Pass `enabled: false` to skip the fetch when the hook must be called but
+ * the grid is not needed yet.
  */
 declare function useOffersGridViewModel(options?: UseOffersGridViewModelOptions): UseOffersGridViewModelResult;
 
@@ -6011,6 +6071,11 @@ interface UseRequirementsChecklistViewModelOptions {
     getDescription?: (requirement: Requirement) => string | null;
     /** Requirements pre-fetched on the server. */
     data?: RequirementsData;
+    /**
+     * Default `true`. When `false` nothing is fetched, so the hook can be called
+     * unconditionally while the checklist is not needed yet.
+     */
+    enabled?: boolean;
     /** Options for the inline Sumsub verification flow. */
     identityVerificationOptions?: {
         levelName?: KycLevelName;
@@ -6025,6 +6090,9 @@ interface UseRequirementsChecklistViewModelResult {
  * Drives {@link RequirementsChecklistView}: loads the requirements and their
  * statuses for one offer option, shapes each row, and owns the three flows the
  * checklist can open (tax document, wallet connect, identity verification).
+ *
+ * Pass `enabled: false` to skip fetches when the hook must be called but
+ * the checklist is not needed yet.
  */
 declare function useRequirementsChecklistViewModel(options: UseRequirementsChecklistViewModelOptions): UseRequirementsChecklistViewModelResult;