@pollar/react 0.11.4-rc.2 → 0.11.4

package/dist/index.d.mts

@@ -37,6 +37,14 @@ interface PollarContextValue {
     getClient: () => PollarClient;
     openLoginModal: () => void;
     isAuthenticated: boolean;
+    /**
+     * Whether the signed-in user has a wallet. False for an app that creates
+     * wallets on demand until {@link createWallet} runs, and always for one that
+     * creates none.
+     */
+    hasWallet: boolean;
+    /** Create the signed-in user's wallet; see `PollarClient.createWallet`. */
+    createWallet: () => Promise<WalletInfo>;
     /**
      * `true` once the server has confirmed the session (login / refresh /
      * `/auth/session/resume`). `false` while a cold-start session is still
@@ -167,6 +175,12 @@ interface PollarContextValue {
     earnWithdraw: (params: EarnTxParams) => Promise<SubmitOutcome>;
     /** Open the Earn modal. */
     openEarnModal: () => void;
+    /**
+     * Open the Cards modal: sign-up, identity verification, issuing, the card
+     * itself and its activity. The card calls live on {@link PollarClient}
+     * (`getCardProviders`, `issueCard`, `revealCardSecrets`, ...).
+     */
+    openCardModal: () => void;
     openDistributionRulesModal: () => void;
     adapters?: PollarAdapters;
 }
@@ -299,6 +313,16 @@ interface WalletButtonTemplateProps {
      */
     notReadyReason?: string | null;
     creatingAccount: boolean;
+    /**
+     * Signed in with no wallet yet (an app that creates wallets on demand, or
+     * none). The button then shows the account menu instead of Login, with Create
+     * wallet only when `onCreateWallet` is set. Optional, so a custom template
+     * written before this existed keeps compiling.
+     */
+    signedIn?: boolean;
+    creatingWallet?: boolean;
+    createWalletError?: string | null;
+    onCreateWallet?: () => void;
     onToggleOpen: () => void;
     onCreateAccount: () => void;
     onCopy: () => void;
@@ -313,7 +337,7 @@ interface WalletButtonTemplateProps {
     onLogout: () => void;
     onLogin: () => void;
 }
-declare function WalletButtonTemplate({ walletAddress, accentColor, open, copied, dropdownBg, dropdownBorder, itemColor, wrapperRef, isInProgress, showCreateAccount, notReadyReason, creatingAccount, onToggleOpen, onCreateAccount, onCopy, onWalletBalance, onTxHistory, onSend, onReceive, onSessions, onKyc, onRamp, onDistributionRules, onLogout, onLogin, }: WalletButtonTemplateProps): react_jsx_runtime.JSX.Element;
+declare function WalletButtonTemplate({ walletAddress, accentColor, open, copied, dropdownBg, dropdownBorder, itemColor, wrapperRef, isInProgress, showCreateAccount, notReadyReason, creatingAccount, onToggleOpen, onCreateAccount, onCopy, onWalletBalance, onTxHistory, onSend, onReceive, onSessions, onKyc, onRamp, onDistributionRules, onLogout, onLogin, signedIn, creatingWallet, createWalletError, onCreateWallet, }: WalletButtonTemplateProps): react_jsx_runtime.JSX.Element;
 
 /**
  * The chain a record lives on, with the legacy shape folded in: sessions and
@@ -375,6 +399,8 @@ declare function useChains(): UseChainsResult;
 
 interface KycModalProps {
     corridorId?: string;
+    /** A card provider's steps, in place of a route's. */
+    cardProviderId?: string;
     /** Open this option directly instead of listing the choices (the one a ramp's KYC gate names). */
     providerId?: string;
     onClose: () => void;
@@ -385,7 +411,7 @@ interface KycModalProps {
     /** Called when KYC is successfully approved. */
     onApproved?: () => void;
 }
-declare function KycModal({ onClose, country, level, onApproved, corridorId, providerId }: KycModalProps): react_jsx_runtime.JSX.Element;
+declare function KycModal({ onClose, country, level, onApproved, corridorId, cardProviderId, providerId, }: KycModalProps): react_jsx_runtime.JSX.Element;
 
 interface RequirementFormModalProps {
     formId: string;
@@ -419,7 +445,10 @@ interface RegistryCheckModalProps {
 declare function RegistryCheckModal({ optionId, progress, onClose, onApproved }: RegistryCheckModalProps): react_jsx_runtime.JSX.Element;
 
 interface ProviderRegistrationModalProps {
-    corridorId: string;
+    /** The route whose ramp the user registers with. */
+    corridorId?: string;
+    /** Or the card provider. One of the two. */
+    cardProviderId?: string;
     /** Position of this step over the route's steps, when known. */
     progress?: {
         position: number;
@@ -433,7 +462,7 @@ interface ProviderRegistrationModalProps {
  * One PROVIDER_REGISTRATION step: what the ramp provider receives, listed before the
  * user consents. Registering is the consent; nothing is sent until then.
  */
-declare function ProviderRegistrationModal({ corridorId, progress, onClose, onRegistered }: ProviderRegistrationModalProps): react_jsx_runtime.JSX.Element;
+declare function ProviderRegistrationModal({ corridorId, cardProviderId, progress, onClose, onRegistered, }: ProviderRegistrationModalProps): react_jsx_runtime.JSX.Element;
 
 interface KycStatusProps {
     status: KycStatus$1;
@@ -483,6 +512,11 @@ interface EarnModalProps {
 }
 declare function EarnModal({ onClose }: EarnModalProps): react_jsx_runtime.JSX.Element;
 
+interface CardModalProps {
+    onClose: () => void;
+}
+declare function CardModal({ onClose }: CardModalProps): react_jsx_runtime.JSX.Element;
+
 interface ReceiveModalProps {
     onClose: () => void;
 }
@@ -1000,4 +1034,4 @@ interface DistributionRulesModalTemplateProps {
 }
 declare function DistributionRulesModalTemplate({ theme, accentColor, styleOverrides, state, claimingId, claimErrors, claimedIds, onRefresh, onClaim, onClose, }: DistributionRulesModalTemplateProps): react_jsx_runtime.JSX.Element;
 
-export { type AuthModalProps, ChainSelect, type ChainSelectProps, type CustomTrustlineModalTemplateProps, DistributionRulesModal, DistributionRulesModalTemplate, EarnModal, EnabledAssetsModal, EnabledAssetsModalTemplate, type EnabledAssetsModalTemplateProps, KycModal, KycModalTemplate, KycStatus, type KycStep, type LoginButtonProps, LoginModalTemplate, type ModalChrome, type ModalStyleOverrides, type ModalVariant, type PollarConfig, PollarProvider, type PollarStyles, ProviderRegistrationModal, type RampStep, RampWidget, RampWidgetTemplate, ReceiveModal, ReceiveModalTemplate, type ReceiveModalTemplateProps, RegistryCheckModal, RequirementFormModal, RouteDisplay, SendModal, SendModalTemplate, type SendModalTemplateProps, SessionsModal, SessionsModalTemplate, type SessionsModalTemplateProps, type SwapAssetOption, SwapModal, SwapModalTemplate, type SwapModalTemplateProps, TransactionModalTemplate, type TransactionModalTemplateProps, TxHistoryModalTemplate, TxStatusView, type TxStatusViewProps, type UseChainsResult, WalletBalanceModal, WalletBalanceModalTemplate, type WalletBalanceModalTemplateProps, WalletButton, WalletButtonTemplate, type WalletButtonTemplateProps, addressForChain, browserPasskeyCeremony, browserPasskeySigner, buildModalCssVars, chainsOf, createPollarAdapterHook, modalChrome, readableTextOn, resolveChain, useChains, usePollar, walletNotReadyReason };
+export { type AuthModalProps, CardModal, ChainSelect, type ChainSelectProps, type CustomTrustlineModalTemplateProps, DistributionRulesModal, DistributionRulesModalTemplate, EarnModal, EnabledAssetsModal, EnabledAssetsModalTemplate, type EnabledAssetsModalTemplateProps, KycModal, KycModalTemplate, KycStatus, type KycStep, type LoginButtonProps, LoginModalTemplate, type ModalChrome, type ModalStyleOverrides, type ModalVariant, type PollarConfig, PollarProvider, type PollarStyles, ProviderRegistrationModal, type RampStep, RampWidget, RampWidgetTemplate, ReceiveModal, ReceiveModalTemplate, type ReceiveModalTemplateProps, RegistryCheckModal, RequirementFormModal, RouteDisplay, SendModal, SendModalTemplate, type SendModalTemplateProps, SessionsModal, SessionsModalTemplate, type SessionsModalTemplateProps, type SwapAssetOption, SwapModal, SwapModalTemplate, type SwapModalTemplateProps, TransactionModalTemplate, type TransactionModalTemplateProps, TxHistoryModalTemplate, TxStatusView, type TxStatusViewProps, type UseChainsResult, WalletBalanceModal, WalletBalanceModalTemplate, type WalletBalanceModalTemplateProps, WalletButton, WalletButtonTemplate, type WalletButtonTemplateProps, addressForChain, browserPasskeyCeremony, browserPasskeySigner, buildModalCssVars, chainsOf, createPollarAdapterHook, modalChrome, readableTextOn, resolveChain, useChains, usePollar, walletNotReadyReason };

package/dist/index.d.ts

@@ -37,6 +37,14 @@ interface PollarContextValue {
     getClient: () => PollarClient;
     openLoginModal: () => void;
     isAuthenticated: boolean;
+    /**
+     * Whether the signed-in user has a wallet. False for an app that creates
+     * wallets on demand until {@link createWallet} runs, and always for one that
+     * creates none.
+     */
+    hasWallet: boolean;
+    /** Create the signed-in user's wallet; see `PollarClient.createWallet`. */
+    createWallet: () => Promise<WalletInfo>;
     /**
      * `true` once the server has confirmed the session (login / refresh /
      * `/auth/session/resume`). `false` while a cold-start session is still
@@ -167,6 +175,12 @@ interface PollarContextValue {
     earnWithdraw: (params: EarnTxParams) => Promise<SubmitOutcome>;
     /** Open the Earn modal. */
     openEarnModal: () => void;
+    /**
+     * Open the Cards modal: sign-up, identity verification, issuing, the card
+     * itself and its activity. The card calls live on {@link PollarClient}
+     * (`getCardProviders`, `issueCard`, `revealCardSecrets`, ...).
+     */
+    openCardModal: () => void;
     openDistributionRulesModal: () => void;
     adapters?: PollarAdapters;
 }
@@ -299,6 +313,16 @@ interface WalletButtonTemplateProps {
      */
     notReadyReason?: string | null;
     creatingAccount: boolean;
+    /**
+     * Signed in with no wallet yet (an app that creates wallets on demand, or
+     * none). The button then shows the account menu instead of Login, with Create
+     * wallet only when `onCreateWallet` is set. Optional, so a custom template
+     * written before this existed keeps compiling.
+     */
+    signedIn?: boolean;
+    creatingWallet?: boolean;
+    createWalletError?: string | null;
+    onCreateWallet?: () => void;
     onToggleOpen: () => void;
     onCreateAccount: () => void;
     onCopy: () => void;
@@ -313,7 +337,7 @@ interface WalletButtonTemplateProps {
     onLogout: () => void;
     onLogin: () => void;
 }
-declare function WalletButtonTemplate({ walletAddress, accentColor, open, copied, dropdownBg, dropdownBorder, itemColor, wrapperRef, isInProgress, showCreateAccount, notReadyReason, creatingAccount, onToggleOpen, onCreateAccount, onCopy, onWalletBalance, onTxHistory, onSend, onReceive, onSessions, onKyc, onRamp, onDistributionRules, onLogout, onLogin, }: WalletButtonTemplateProps): react_jsx_runtime.JSX.Element;
+declare function WalletButtonTemplate({ walletAddress, accentColor, open, copied, dropdownBg, dropdownBorder, itemColor, wrapperRef, isInProgress, showCreateAccount, notReadyReason, creatingAccount, onToggleOpen, onCreateAccount, onCopy, onWalletBalance, onTxHistory, onSend, onReceive, onSessions, onKyc, onRamp, onDistributionRules, onLogout, onLogin, signedIn, creatingWallet, createWalletError, onCreateWallet, }: WalletButtonTemplateProps): react_jsx_runtime.JSX.Element;
 
 /**
  * The chain a record lives on, with the legacy shape folded in: sessions and
@@ -375,6 +399,8 @@ declare function useChains(): UseChainsResult;
 
 interface KycModalProps {
     corridorId?: string;
+    /** A card provider's steps, in place of a route's. */
+    cardProviderId?: string;
     /** Open this option directly instead of listing the choices (the one a ramp's KYC gate names). */
     providerId?: string;
     onClose: () => void;
@@ -385,7 +411,7 @@ interface KycModalProps {
     /** Called when KYC is successfully approved. */
     onApproved?: () => void;
 }
-declare function KycModal({ onClose, country, level, onApproved, corridorId, providerId }: KycModalProps): react_jsx_runtime.JSX.Element;
+declare function KycModal({ onClose, country, level, onApproved, corridorId, cardProviderId, providerId, }: KycModalProps): react_jsx_runtime.JSX.Element;
 
 interface RequirementFormModalProps {
     formId: string;
@@ -419,7 +445,10 @@ interface RegistryCheckModalProps {
 declare function RegistryCheckModal({ optionId, progress, onClose, onApproved }: RegistryCheckModalProps): react_jsx_runtime.JSX.Element;
 
 interface ProviderRegistrationModalProps {
-    corridorId: string;
+    /** The route whose ramp the user registers with. */
+    corridorId?: string;
+    /** Or the card provider. One of the two. */
+    cardProviderId?: string;
     /** Position of this step over the route's steps, when known. */
     progress?: {
         position: number;
@@ -433,7 +462,7 @@ interface ProviderRegistrationModalProps {
  * One PROVIDER_REGISTRATION step: what the ramp provider receives, listed before the
  * user consents. Registering is the consent; nothing is sent until then.
  */
-declare function ProviderRegistrationModal({ corridorId, progress, onClose, onRegistered }: ProviderRegistrationModalProps): react_jsx_runtime.JSX.Element;
+declare function ProviderRegistrationModal({ corridorId, cardProviderId, progress, onClose, onRegistered, }: ProviderRegistrationModalProps): react_jsx_runtime.JSX.Element;
 
 interface KycStatusProps {
     status: KycStatus$1;
@@ -483,6 +512,11 @@ interface EarnModalProps {
 }
 declare function EarnModal({ onClose }: EarnModalProps): react_jsx_runtime.JSX.Element;
 
+interface CardModalProps {
+    onClose: () => void;
+}
+declare function CardModal({ onClose }: CardModalProps): react_jsx_runtime.JSX.Element;
+
 interface ReceiveModalProps {
     onClose: () => void;
 }
@@ -1000,4 +1034,4 @@ interface DistributionRulesModalTemplateProps {
 }
 declare function DistributionRulesModalTemplate({ theme, accentColor, styleOverrides, state, claimingId, claimErrors, claimedIds, onRefresh, onClaim, onClose, }: DistributionRulesModalTemplateProps): react_jsx_runtime.JSX.Element;
 
-export { type AuthModalProps, ChainSelect, type ChainSelectProps, type CustomTrustlineModalTemplateProps, DistributionRulesModal, DistributionRulesModalTemplate, EarnModal, EnabledAssetsModal, EnabledAssetsModalTemplate, type EnabledAssetsModalTemplateProps, KycModal, KycModalTemplate, KycStatus, type KycStep, type LoginButtonProps, LoginModalTemplate, type ModalChrome, type ModalStyleOverrides, type ModalVariant, type PollarConfig, PollarProvider, type PollarStyles, ProviderRegistrationModal, type RampStep, RampWidget, RampWidgetTemplate, ReceiveModal, ReceiveModalTemplate, type ReceiveModalTemplateProps, RegistryCheckModal, RequirementFormModal, RouteDisplay, SendModal, SendModalTemplate, type SendModalTemplateProps, SessionsModal, SessionsModalTemplate, type SessionsModalTemplateProps, type SwapAssetOption, SwapModal, SwapModalTemplate, type SwapModalTemplateProps, TransactionModalTemplate, type TransactionModalTemplateProps, TxHistoryModalTemplate, TxStatusView, type TxStatusViewProps, type UseChainsResult, WalletBalanceModal, WalletBalanceModalTemplate, type WalletBalanceModalTemplateProps, WalletButton, WalletButtonTemplate, type WalletButtonTemplateProps, addressForChain, browserPasskeyCeremony, browserPasskeySigner, buildModalCssVars, chainsOf, createPollarAdapterHook, modalChrome, readableTextOn, resolveChain, useChains, usePollar, walletNotReadyReason };
+export { type AuthModalProps, CardModal, ChainSelect, type ChainSelectProps, type CustomTrustlineModalTemplateProps, DistributionRulesModal, DistributionRulesModalTemplate, EarnModal, EnabledAssetsModal, EnabledAssetsModalTemplate, type EnabledAssetsModalTemplateProps, KycModal, KycModalTemplate, KycStatus, type KycStep, type LoginButtonProps, LoginModalTemplate, type ModalChrome, type ModalStyleOverrides, type ModalVariant, type PollarConfig, PollarProvider, type PollarStyles, ProviderRegistrationModal, type RampStep, RampWidget, RampWidgetTemplate, ReceiveModal, ReceiveModalTemplate, type ReceiveModalTemplateProps, RegistryCheckModal, RequirementFormModal, RouteDisplay, SendModal, SendModalTemplate, type SendModalTemplateProps, SessionsModal, SessionsModalTemplate, type SessionsModalTemplateProps, type SwapAssetOption, SwapModal, SwapModalTemplate, type SwapModalTemplateProps, TransactionModalTemplate, type TransactionModalTemplateProps, TxHistoryModalTemplate, TxStatusView, type TxStatusViewProps, type UseChainsResult, WalletBalanceModal, WalletBalanceModalTemplate, type WalletBalanceModalTemplateProps, WalletButton, WalletButtonTemplate, type WalletButtonTemplateProps, addressForChain, browserPasskeyCeremony, browserPasskeySigner, buildModalCssVars, chainsOf, createPollarAdapterHook, modalChrome, readableTextOn, resolveChain, useChains, usePollar, walletNotReadyReason };