@swype-org/react-sdk 0.1.3 → 0.1.5

package/dist/index.d.cts

@@ -38,7 +38,7 @@ interface Wallet {
         id: string;
         name: string;
     };
-    /** The smart account type (e.g. 'metamask'), if the wallet has been upgraded. */
+    /** The smart account type (e.g. 'metamask'), if a smart account has been created. */
     smartAccountType?: string | null;
     createDate: string;
     updateDate: string;
@@ -94,6 +94,8 @@ interface TransferSignPayload {
     userOp: Record<string, unknown>;
     /** ERC-4337 UserOp hash — used as the WebAuthn challenge for on-chain verification. */
     userOpHash: string;
+    /** WebAuthn credential ID bound to the smart account validator. */
+    passkeyCredentialId: string;
     bridgeRelayAddress: string;
     tokenSymbol: string;
     chainName: string;
@@ -137,6 +139,15 @@ interface ActionExecutionResult {
 }
 /** Source type discriminator for transfer creation */
 type SourceType = 'providerId' | 'accountId' | 'walletId' | 'tokenId';
+/** A chain+token option from the SELECT_SOURCE action metadata. */
+interface SourceOption {
+    chainName: string;
+    chainId: string;
+    tokenSymbol: string;
+    tokenAddress: string;
+    decimals: number;
+    rawBalance: string;
+}
 /** User's chain+token selection for the SELECT_SOURCE action. */
 interface SourceSelection {
     chainName: string;
@@ -157,11 +168,16 @@ interface ListResponse<T> {
 /** User configuration preferences */
 interface UserConfig {
     defaultAllowance?: number;
+    /** Registered WebAuthn passkey credential, or null if none registered */
+    passkey?: {
+        credentialId: string;
+        publicKey: string;
+    } | null;
 }
 /** Theme mode */
 type ThemeMode = 'light' | 'dark';
 /** Steps in the payment flow */
-type PaymentStep = 'login' | 'enter-amount' | 'ready' | 'processing' | 'complete';
+type PaymentStep = 'login' | 'register-passkey' | 'enter-amount' | 'ready' | 'processing' | 'complete';
 /** User-selected advanced settings for chain/asset override */
 interface AdvancedSettings {
     /** Override asset (e.g. 'USDC', 'USDT'). Null = let backend decide. */
@@ -267,6 +283,19 @@ interface SwypePaymentProps {
 }
 declare function SwypePayment({ destination, onComplete, onError, }: SwypePaymentProps): react_jsx_runtime.JSX.Element | null;
 
+type AccessTokenGetter = () => Promise<string | null | undefined>;
+/**
+ * Creates a WebAuthn passkey credential.
+ * Used for upfront passkey registration before the authorization flow.
+ *
+ * @param userIdentifier - A string used to identify the user in the
+ *   WebAuthn ceremony (e.g. wallet address or Privy user ID).
+ * @returns The base64-encoded credentialId and publicKey.
+ */
+declare function createPasskeyCredential(userIdentifier: string): Promise<{
+    credentialId: string;
+    publicKey: string;
+}>;
 interface UseTransferPollingResult {
     transfer: Transfer | null;
     error: string | null;
@@ -289,24 +318,60 @@ interface UseAuthorizationExecutorResult {
     pendingSelectSource: AuthorizationAction | null;
     /** Call this from the UI to provide the user's chain+token choice. */
     resolveSelectSource: (selection: SourceSelection) => void;
+    /** Execute authorization by session id. */
+    executeSessionById: (sessionId: string) => Promise<void>;
     executeSession: (transfer: Transfer) => Promise<void>;
 }
+interface UseAuthorizationExecutorOptions {
+    /** Optional API base URL override when used outside SwypeProvider. */
+    apiBaseUrl?: string;
+}
 /**
  * Executes the full authorization flow for a transfer's first session:
- * fetches the session, walks through PENDING actions (OPEN_PROVIDER,
- * REGISTER_PASSKEY, UPGRADE_SMART_ACCOUNT, GRANT_PERMISSIONS,
- * SELECT_SOURCE), reports each completion to the server, and chains
- * new actions that appear.
+ * fetches the session, walks through PENDING actions, reports each
+ * completion to the server, and chains new actions that appear.
+ *
+ * Supported action types:
+ *   - OPEN_PROVIDER — connect the user's wallet
+ *   - SELECT_SOURCE — pause for user chain+token selection
+ *   - SWITCH_CHAIN — switch the wallet to the required chain
+ *   - CREATE_SMART_ACCOUNT — server-side smart account deployment
+ *   - APPROVE_PERMIT2 — ERC-20 approve(permit2, maxUint256) from EOA
+ *   - SIGN_PERMIT2 — EIP-712 Permit2 allowance signature from EOA
  *
  * Transfer signing (passkey) is handled separately via
  * `useTransferSigning()` after the authorization flow completes.
+ */
+declare function useAuthorizationExecutor(options?: UseAuthorizationExecutorOptions): UseAuthorizationExecutorResult;
+interface UseTransferSigningResult {
+    signing: boolean;
+    signPayload: TransferSignPayload | null;
+    error: string | null;
+    /**
+     * Starts the signing flow:
+     * 1. Polls GET /v1/transfers/{id} until signPayload is present
+     * 2. Triggers WebAuthn passkey prompt
+     * 3. Submits signed UserOp via PATCH /v1/transfers/{id}
+     */
+    signTransfer: (transferId: string) => Promise<Transfer>;
+}
+interface UseTransferSigningOptions {
+    /** Optional API base URL override when used outside SwypeProvider. */
+    apiBaseUrl?: string;
+    /** Optional access-token getter override (e.g. deeplink query token). */
+    getAccessToken?: AccessTokenGetter;
+    /** Optional authorization-session token for session-authenticated transfer signing. */
+    authorizationSessionToken?: string;
+}
+/**
+ * Post-authorization transfer signing hook.
  *
- * When a SELECT_SOURCE action is encountered, the executor pauses and
- * exposes the action via `pendingSelectSource`. The UI should display
- * a chain+token selector and call `resolveSelectSource()` with the
- * user's choice. The executor then resumes automatically.
+ * After the auth session completes and the transfer reaches AUTHORIZED,
+ * the backend prepares a signPayload containing the unsigned UserOp.
+ * This hook polls for it, prompts the user's passkey via WebAuthn, and
+ * submits the signed UserOp back to the API.
  */
-declare function useAuthorizationExecutor(): UseAuthorizationExecutorResult;
+declare function useTransferSigning(pollIntervalMs?: number, options?: UseTransferSigningOptions): UseTransferSigningResult;
 
 declare function fetchProviders(apiBaseUrl: string, token: string): Promise<Provider[]>;
 declare function fetchChains(apiBaseUrl: string, token: string): Promise<Chain[]>;
@@ -319,13 +384,26 @@ interface CreateTransferParams {
     currency?: string;
 }
 declare function createTransfer(apiBaseUrl: string, token: string, params: CreateTransferParams): Promise<Transfer>;
-declare function fetchTransfer(apiBaseUrl: string, token: string, transferId: string): Promise<Transfer>;
+declare function fetchTransfer(apiBaseUrl: string, token: string, transferId: string, authorizationSessionToken?: string): Promise<Transfer>;
 /**
  * Submit a passkey-signed UserOperation for a transfer.
  * PATCH /v1/transfers/{transferId}
  */
-declare function signTransfer(apiBaseUrl: string, token: string, transferId: string, signedUserOp: Record<string, unknown>): Promise<Transfer>;
+declare function signTransfer(apiBaseUrl: string, token: string, transferId: string, signedUserOp: Record<string, unknown>, authorizationSessionToken?: string): Promise<Transfer>;
 declare function fetchAuthorizationSession(apiBaseUrl: string, sessionId: string): Promise<AuthorizationSessionDetail>;
+/**
+ * Registers a WebAuthn passkey for the authenticated user.
+ * POST /v1/users/config/passkey
+ */
+declare function registerPasskey(apiBaseUrl: string, token: string, credentialId: string, publicKey: string): Promise<void>;
+/**
+ * Fetches the authenticated user's config, including passkey status.
+ * GET /v1/users/config
+ */
+declare function fetchUserConfig(apiBaseUrl: string, token: string): Promise<{
+    id: string;
+    config: UserConfig;
+}>;
 declare function updateUserConfig(apiBaseUrl: string, token: string, config: {
     defaultAllowance: number;
 }): Promise<void>;
@@ -348,12 +426,14 @@ declare const api_fetchAuthorizationSession: typeof fetchAuthorizationSession;
 declare const api_fetchChains: typeof fetchChains;
 declare const api_fetchProviders: typeof fetchProviders;
 declare const api_fetchTransfer: typeof fetchTransfer;
+declare const api_fetchUserConfig: typeof fetchUserConfig;
+declare const api_registerPasskey: typeof registerPasskey;
 declare const api_reportActionCompletion: typeof reportActionCompletion;
 declare const api_signTransfer: typeof signTransfer;
 declare const api_updateUserConfig: typeof updateUserConfig;
 declare const api_updateUserConfigBySession: typeof updateUserConfigBySession;
 declare namespace api {
-  export { type api_CreateTransferParams as CreateTransferParams, api_createTransfer as createTransfer, api_fetchAccounts as fetchAccounts, api_fetchAuthorizationSession as fetchAuthorizationSession, api_fetchChains as fetchChains, api_fetchProviders as fetchProviders, api_fetchTransfer as fetchTransfer, api_reportActionCompletion as reportActionCompletion, api_signTransfer as signTransfer, api_updateUserConfig as updateUserConfig, api_updateUserConfigBySession as updateUserConfigBySession };
+  export { type api_CreateTransferParams as CreateTransferParams, api_createTransfer as createTransfer, api_fetchAccounts as fetchAccounts, api_fetchAuthorizationSession as fetchAuthorizationSession, api_fetchChains as fetchChains, api_fetchProviders as fetchProviders, api_fetchTransfer as fetchTransfer, api_fetchUserConfig as fetchUserConfig, api_registerPasskey as registerPasskey, api_reportActionCompletion as reportActionCompletion, api_signTransfer as signTransfer, api_updateUserConfig as updateUserConfig, api_updateUserConfigBySession as updateUserConfigBySession };
 }
 
-export { type Account, type ActionExecutionResult, type AdvancedSettings, type Amount, type AuthorizationAction, type AuthorizationSession, type AuthorizationSessionDetail, type Chain, type Destination, type ErrorResponse, type ListResponse, type PaymentStep, type Provider, type SourceType, SwypePayment, type SwypePaymentProps, SwypeProvider, type SwypeProviderProps, type ThemeMode, type ThemeTokens, type TokenBalance, type Transfer, type TransferDestination, type UserConfig, type Wallet, type WalletSource, type WalletToken, darkTheme, getTheme, lightTheme, api as swypeApi, useAuthorizationExecutor, useSwypeConfig, useSwypeDepositAmount, useTransferPolling };
+export { type Account, type ActionExecutionResult, type AdvancedSettings, type Amount, type AuthorizationAction, type AuthorizationSession, type AuthorizationSessionDetail, type Chain, type Destination, type ErrorResponse, type ListResponse, type PaymentStep, type Provider, type SourceOption, type SourceSelection, type SourceType, SwypePayment, type SwypePaymentProps, SwypeProvider, type SwypeProviderProps, type ThemeMode, type ThemeTokens, type TokenBalance, type Transfer, type TransferDestination, type UserConfig, type Wallet, type WalletSource, type WalletToken, createPasskeyCredential, darkTheme, getTheme, lightTheme, api as swypeApi, useAuthorizationExecutor, useSwypeConfig, useSwypeDepositAmount, useTransferPolling, useTransferSigning };

package/dist/index.d.ts

@@ -38,7 +38,7 @@ interface Wallet {
         id: string;
         name: string;
     };
-    /** The smart account type (e.g. 'metamask'), if the wallet has been upgraded. */
+    /** The smart account type (e.g. 'metamask'), if a smart account has been created. */
     smartAccountType?: string | null;
     createDate: string;
     updateDate: string;
@@ -94,6 +94,8 @@ interface TransferSignPayload {
     userOp: Record<string, unknown>;
     /** ERC-4337 UserOp hash — used as the WebAuthn challenge for on-chain verification. */
     userOpHash: string;
+    /** WebAuthn credential ID bound to the smart account validator. */
+    passkeyCredentialId: string;
     bridgeRelayAddress: string;
     tokenSymbol: string;
     chainName: string;
@@ -137,6 +139,15 @@ interface ActionExecutionResult {
 }
 /** Source type discriminator for transfer creation */
 type SourceType = 'providerId' | 'accountId' | 'walletId' | 'tokenId';
+/** A chain+token option from the SELECT_SOURCE action metadata. */
+interface SourceOption {
+    chainName: string;
+    chainId: string;
+    tokenSymbol: string;
+    tokenAddress: string;
+    decimals: number;
+    rawBalance: string;
+}
 /** User's chain+token selection for the SELECT_SOURCE action. */
 interface SourceSelection {
     chainName: string;
@@ -157,11 +168,16 @@ interface ListResponse<T> {
 /** User configuration preferences */
 interface UserConfig {
     defaultAllowance?: number;
+    /** Registered WebAuthn passkey credential, or null if none registered */
+    passkey?: {
+        credentialId: string;
+        publicKey: string;
+    } | null;
 }
 /** Theme mode */
 type ThemeMode = 'light' | 'dark';
 /** Steps in the payment flow */
-type PaymentStep = 'login' | 'enter-amount' | 'ready' | 'processing' | 'complete';
+type PaymentStep = 'login' | 'register-passkey' | 'enter-amount' | 'ready' | 'processing' | 'complete';
 /** User-selected advanced settings for chain/asset override */
 interface AdvancedSettings {
     /** Override asset (e.g. 'USDC', 'USDT'). Null = let backend decide. */
@@ -267,6 +283,19 @@ interface SwypePaymentProps {
 }
 declare function SwypePayment({ destination, onComplete, onError, }: SwypePaymentProps): react_jsx_runtime.JSX.Element | null;
 
+type AccessTokenGetter = () => Promise<string | null | undefined>;
+/**
+ * Creates a WebAuthn passkey credential.
+ * Used for upfront passkey registration before the authorization flow.
+ *
+ * @param userIdentifier - A string used to identify the user in the
+ *   WebAuthn ceremony (e.g. wallet address or Privy user ID).
+ * @returns The base64-encoded credentialId and publicKey.
+ */
+declare function createPasskeyCredential(userIdentifier: string): Promise<{
+    credentialId: string;
+    publicKey: string;
+}>;
 interface UseTransferPollingResult {
     transfer: Transfer | null;
     error: string | null;
@@ -289,24 +318,60 @@ interface UseAuthorizationExecutorResult {
     pendingSelectSource: AuthorizationAction | null;
     /** Call this from the UI to provide the user's chain+token choice. */
     resolveSelectSource: (selection: SourceSelection) => void;
+    /** Execute authorization by session id. */
+    executeSessionById: (sessionId: string) => Promise<void>;
     executeSession: (transfer: Transfer) => Promise<void>;
 }
+interface UseAuthorizationExecutorOptions {
+    /** Optional API base URL override when used outside SwypeProvider. */
+    apiBaseUrl?: string;
+}
 /**
  * Executes the full authorization flow for a transfer's first session:
- * fetches the session, walks through PENDING actions (OPEN_PROVIDER,
- * REGISTER_PASSKEY, UPGRADE_SMART_ACCOUNT, GRANT_PERMISSIONS,
- * SELECT_SOURCE), reports each completion to the server, and chains
- * new actions that appear.
+ * fetches the session, walks through PENDING actions, reports each
+ * completion to the server, and chains new actions that appear.
+ *
+ * Supported action types:
+ *   - OPEN_PROVIDER — connect the user's wallet
+ *   - SELECT_SOURCE — pause for user chain+token selection
+ *   - SWITCH_CHAIN — switch the wallet to the required chain
+ *   - CREATE_SMART_ACCOUNT — server-side smart account deployment
+ *   - APPROVE_PERMIT2 — ERC-20 approve(permit2, maxUint256) from EOA
+ *   - SIGN_PERMIT2 — EIP-712 Permit2 allowance signature from EOA
  *
  * Transfer signing (passkey) is handled separately via
  * `useTransferSigning()` after the authorization flow completes.
+ */
+declare function useAuthorizationExecutor(options?: UseAuthorizationExecutorOptions): UseAuthorizationExecutorResult;
+interface UseTransferSigningResult {
+    signing: boolean;
+    signPayload: TransferSignPayload | null;
+    error: string | null;
+    /**
+     * Starts the signing flow:
+     * 1. Polls GET /v1/transfers/{id} until signPayload is present
+     * 2. Triggers WebAuthn passkey prompt
+     * 3. Submits signed UserOp via PATCH /v1/transfers/{id}
+     */
+    signTransfer: (transferId: string) => Promise<Transfer>;
+}
+interface UseTransferSigningOptions {
+    /** Optional API base URL override when used outside SwypeProvider. */
+    apiBaseUrl?: string;
+    /** Optional access-token getter override (e.g. deeplink query token). */
+    getAccessToken?: AccessTokenGetter;
+    /** Optional authorization-session token for session-authenticated transfer signing. */
+    authorizationSessionToken?: string;
+}
+/**
+ * Post-authorization transfer signing hook.
  *
- * When a SELECT_SOURCE action is encountered, the executor pauses and
- * exposes the action via `pendingSelectSource`. The UI should display
- * a chain+token selector and call `resolveSelectSource()` with the
- * user's choice. The executor then resumes automatically.
+ * After the auth session completes and the transfer reaches AUTHORIZED,
+ * the backend prepares a signPayload containing the unsigned UserOp.
+ * This hook polls for it, prompts the user's passkey via WebAuthn, and
+ * submits the signed UserOp back to the API.
  */
-declare function useAuthorizationExecutor(): UseAuthorizationExecutorResult;
+declare function useTransferSigning(pollIntervalMs?: number, options?: UseTransferSigningOptions): UseTransferSigningResult;
 
 declare function fetchProviders(apiBaseUrl: string, token: string): Promise<Provider[]>;
 declare function fetchChains(apiBaseUrl: string, token: string): Promise<Chain[]>;
@@ -319,13 +384,26 @@ interface CreateTransferParams {
     currency?: string;
 }
 declare function createTransfer(apiBaseUrl: string, token: string, params: CreateTransferParams): Promise<Transfer>;
-declare function fetchTransfer(apiBaseUrl: string, token: string, transferId: string): Promise<Transfer>;
+declare function fetchTransfer(apiBaseUrl: string, token: string, transferId: string, authorizationSessionToken?: string): Promise<Transfer>;
 /**
  * Submit a passkey-signed UserOperation for a transfer.
  * PATCH /v1/transfers/{transferId}
  */
-declare function signTransfer(apiBaseUrl: string, token: string, transferId: string, signedUserOp: Record<string, unknown>): Promise<Transfer>;
+declare function signTransfer(apiBaseUrl: string, token: string, transferId: string, signedUserOp: Record<string, unknown>, authorizationSessionToken?: string): Promise<Transfer>;
 declare function fetchAuthorizationSession(apiBaseUrl: string, sessionId: string): Promise<AuthorizationSessionDetail>;
+/**
+ * Registers a WebAuthn passkey for the authenticated user.
+ * POST /v1/users/config/passkey
+ */
+declare function registerPasskey(apiBaseUrl: string, token: string, credentialId: string, publicKey: string): Promise<void>;
+/**
+ * Fetches the authenticated user's config, including passkey status.
+ * GET /v1/users/config
+ */
+declare function fetchUserConfig(apiBaseUrl: string, token: string): Promise<{
+    id: string;
+    config: UserConfig;
+}>;
 declare function updateUserConfig(apiBaseUrl: string, token: string, config: {
     defaultAllowance: number;
 }): Promise<void>;
@@ -348,12 +426,14 @@ declare const api_fetchAuthorizationSession: typeof fetchAuthorizationSession;
 declare const api_fetchChains: typeof fetchChains;
 declare const api_fetchProviders: typeof fetchProviders;
 declare const api_fetchTransfer: typeof fetchTransfer;
+declare const api_fetchUserConfig: typeof fetchUserConfig;
+declare const api_registerPasskey: typeof registerPasskey;
 declare const api_reportActionCompletion: typeof reportActionCompletion;
 declare const api_signTransfer: typeof signTransfer;
 declare const api_updateUserConfig: typeof updateUserConfig;
 declare const api_updateUserConfigBySession: typeof updateUserConfigBySession;
 declare namespace api {
-  export { type api_CreateTransferParams as CreateTransferParams, api_createTransfer as createTransfer, api_fetchAccounts as fetchAccounts, api_fetchAuthorizationSession as fetchAuthorizationSession, api_fetchChains as fetchChains, api_fetchProviders as fetchProviders, api_fetchTransfer as fetchTransfer, api_reportActionCompletion as reportActionCompletion, api_signTransfer as signTransfer, api_updateUserConfig as updateUserConfig, api_updateUserConfigBySession as updateUserConfigBySession };
+  export { type api_CreateTransferParams as CreateTransferParams, api_createTransfer as createTransfer, api_fetchAccounts as fetchAccounts, api_fetchAuthorizationSession as fetchAuthorizationSession, api_fetchChains as fetchChains, api_fetchProviders as fetchProviders, api_fetchTransfer as fetchTransfer, api_fetchUserConfig as fetchUserConfig, api_registerPasskey as registerPasskey, api_reportActionCompletion as reportActionCompletion, api_signTransfer as signTransfer, api_updateUserConfig as updateUserConfig, api_updateUserConfigBySession as updateUserConfigBySession };
 }
 
-export { type Account, type ActionExecutionResult, type AdvancedSettings, type Amount, type AuthorizationAction, type AuthorizationSession, type AuthorizationSessionDetail, type Chain, type Destination, type ErrorResponse, type ListResponse, type PaymentStep, type Provider, type SourceType, SwypePayment, type SwypePaymentProps, SwypeProvider, type SwypeProviderProps, type ThemeMode, type ThemeTokens, type TokenBalance, type Transfer, type TransferDestination, type UserConfig, type Wallet, type WalletSource, type WalletToken, darkTheme, getTheme, lightTheme, api as swypeApi, useAuthorizationExecutor, useSwypeConfig, useSwypeDepositAmount, useTransferPolling };
+export { type Account, type ActionExecutionResult, type AdvancedSettings, type Amount, type AuthorizationAction, type AuthorizationSession, type AuthorizationSessionDetail, type Chain, type Destination, type ErrorResponse, type ListResponse, type PaymentStep, type Provider, type SourceOption, type SourceSelection, type SourceType, SwypePayment, type SwypePaymentProps, SwypeProvider, type SwypeProviderProps, type ThemeMode, type ThemeTokens, type TokenBalance, type Transfer, type TransferDestination, type UserConfig, type Wallet, type WalletSource, type WalletToken, createPasskeyCredential, darkTheme, getTheme, lightTheme, api as swypeApi, useAuthorizationExecutor, useSwypeConfig, useSwypeDepositAmount, useTransferPolling, useTransferSigning };