@swype-org/react-sdk 0.1.1 → 0.1.3

package/dist/index.d.cts

@@ -38,6 +38,8 @@ interface Wallet {
         id: string;
         name: string;
     };
+    /** The smart account type (e.g. 'metamask'), if the wallet has been upgraded. */
+    smartAccountType?: string | null;
     createDate: string;
     updateDate: string;
     authorizationSessions?: AuthorizationSession[];
@@ -87,6 +89,17 @@ interface TransferDestination {
     };
     amount: Amount;
 }
+/** Sign payload containing the unsigned UserOp and bridge/relay metadata */
+interface TransferSignPayload {
+    userOp: Record<string, unknown>;
+    /** ERC-4337 UserOp hash — used as the WebAuthn challenge for on-chain verification. */
+    userOpHash: string;
+    bridgeRelayAddress: string;
+    tokenSymbol: string;
+    chainName: string;
+    amount: string;
+    estimatedFeeUsd: string;
+}
 /** Transfer object returned by the API */
 interface Transfer {
     id: string;
@@ -102,6 +115,7 @@ interface Transfer {
     createDate: string;
     updateDate: string;
     authorizationSessions: AuthorizationSession[];
+    signPayload?: TransferSignPayload | null;
 }
 /** Standard API error shape */
 interface ErrorResponse {
@@ -123,6 +137,11 @@ interface ActionExecutionResult {
 }
 /** Source type discriminator for transfer creation */
 type SourceType = 'providerId' | 'accountId' | 'walletId' | 'tokenId';
+/** User's chain+token selection for the SELECT_SOURCE action. */
+interface SourceSelection {
+    chainName: string;
+    tokenSymbol: string;
+}
 /** Destination input provided by the host app */
 interface Destination {
     chainId: string;
@@ -142,7 +161,14 @@ interface UserConfig {
 /** Theme mode */
 type ThemeMode = 'light' | 'dark';
 /** Steps in the payment flow */
-type PaymentStep = 'login' | 'select-source' | 'enter-amount' | 'processing' | 'complete';
+type PaymentStep = 'login' | '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. */
+    asset: string | null;
+    /** Override chain name (e.g. 'Base', 'Ethereum'). Null = let backend decide. */
+    chain: string | null;
+}
 
 interface ThemeTokens {
     bg: string;
@@ -176,6 +202,10 @@ interface SwypeConfig {
     apiBaseUrl: string;
     theme: ThemeMode;
     tokens: ThemeTokens;
+    /** Pre-set deposit amount (controlled by host app via useSwypeDepositAmount) */
+    depositAmount: number | null;
+    /** Update the deposit amount from a host-app component */
+    setDepositAmount: (amount: number | null) => void;
 }
 interface SwypeProviderProps {
     /** Base URL for the Swype API (e.g. "http://localhost:3000") */
@@ -201,6 +231,26 @@ interface SwypeProviderProps {
 declare function SwypeProvider({ apiBaseUrl, theme, children, }: SwypeProviderProps): react_jsx_runtime.JSX.Element;
 /** Access the Swype SDK configuration. Throws if used outside SwypeProvider. */
 declare function useSwypeConfig(): SwypeConfig;
+/**
+ * Hook for host apps to pre-set the deposit amount before showing the
+ * payment widget. When set, the amount field in SwypePayment is
+ * auto-populated.
+ *
+ * @example
+ * ```tsx
+ * function ProductPage() {
+ *   const { setAmount } = useSwypeDepositAmount();
+ *   useEffect(() => { setAmount(25.00); }, []);
+ *   return <SwypePayment destination={dest} />;
+ * }
+ * ```
+ */
+declare function useSwypeDepositAmount(): {
+    /** Current deposit amount, or null if not set */
+    amount: number | null;
+    /** Set the deposit amount (pass null to clear) */
+    setAmount: (amount: number | null) => void;
+};
 
 interface SwypePaymentProps {
     /**
@@ -233,13 +283,28 @@ interface UseAuthorizationExecutorResult {
     executing: boolean;
     results: ActionExecutionResult[];
     error: string | null;
+    /** The current action being executed (for UI display). */
+    currentAction: AuthorizationAction | null;
+    /** The SELECT_SOURCE action when paused for user selection, null otherwise. */
+    pendingSelectSource: AuthorizationAction | null;
+    /** Call this from the UI to provide the user's chain+token choice. */
+    resolveSelectSource: (selection: SourceSelection) => void;
     executeSession: (transfer: Transfer) => Promise<void>;
 }
 /**
  * Executes the full authorization flow for a transfer's first session:
  * fetches the session, walks through PENDING actions (OPEN_PROVIDER,
- * SWITCH_CHAIN, APPROVE_PERMIT_2, SIGN_PERMIT2), reports each completion
- * to the server, and chains new actions that appear.
+ * REGISTER_PASSKEY, UPGRADE_SMART_ACCOUNT, GRANT_PERMISSIONS,
+ * SELECT_SOURCE), reports each completion to the server, and chains
+ * new actions that appear.
+ *
+ * Transfer signing (passkey) is handled separately via
+ * `useTransferSigning()` after the authorization flow completes.
+ *
+ * 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.
  */
 declare function useAuthorizationExecutor(): UseAuthorizationExecutorResult;
 
@@ -255,10 +320,25 @@ interface CreateTransferParams {
 }
 declare function createTransfer(apiBaseUrl: string, token: string, params: CreateTransferParams): Promise<Transfer>;
 declare function fetchTransfer(apiBaseUrl: string, token: string, transferId: 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 fetchAuthorizationSession(apiBaseUrl: string, sessionId: string): Promise<AuthorizationSessionDetail>;
 declare function updateUserConfig(apiBaseUrl: string, token: string, config: {
     defaultAllowance: number;
 }): Promise<void>;
+/**
+ * Updates the user's default allowance, authenticated by session ID.
+ * PATCH /v1/authorization-sessions/{id}/user-config
+ *
+ * This does not require a bearer token — the session ID itself serves
+ * as proof of authorization.
+ */
+declare function updateUserConfigBySession(apiBaseUrl: string, sessionId: string, config: {
+    defaultAllowance: number;
+}): Promise<void>;
 declare function reportActionCompletion(apiBaseUrl: string, actionId: string, result: Record<string, unknown>): Promise<AuthorizationSessionDetail>;
 
 type api_CreateTransferParams = CreateTransferParams;
@@ -269,9 +349,11 @@ declare const api_fetchChains: typeof fetchChains;
 declare const api_fetchProviders: typeof fetchProviders;
 declare const api_fetchTransfer: typeof fetchTransfer;
 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_updateUserConfig as updateUserConfig };
+  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 Account, type ActionExecutionResult, 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, 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 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 };

package/dist/index.d.ts

@@ -38,6 +38,8 @@ interface Wallet {
         id: string;
         name: string;
     };
+    /** The smart account type (e.g. 'metamask'), if the wallet has been upgraded. */
+    smartAccountType?: string | null;
     createDate: string;
     updateDate: string;
     authorizationSessions?: AuthorizationSession[];
@@ -87,6 +89,17 @@ interface TransferDestination {
     };
     amount: Amount;
 }
+/** Sign payload containing the unsigned UserOp and bridge/relay metadata */
+interface TransferSignPayload {
+    userOp: Record<string, unknown>;
+    /** ERC-4337 UserOp hash — used as the WebAuthn challenge for on-chain verification. */
+    userOpHash: string;
+    bridgeRelayAddress: string;
+    tokenSymbol: string;
+    chainName: string;
+    amount: string;
+    estimatedFeeUsd: string;
+}
 /** Transfer object returned by the API */
 interface Transfer {
     id: string;
@@ -102,6 +115,7 @@ interface Transfer {
     createDate: string;
     updateDate: string;
     authorizationSessions: AuthorizationSession[];
+    signPayload?: TransferSignPayload | null;
 }
 /** Standard API error shape */
 interface ErrorResponse {
@@ -123,6 +137,11 @@ interface ActionExecutionResult {
 }
 /** Source type discriminator for transfer creation */
 type SourceType = 'providerId' | 'accountId' | 'walletId' | 'tokenId';
+/** User's chain+token selection for the SELECT_SOURCE action. */
+interface SourceSelection {
+    chainName: string;
+    tokenSymbol: string;
+}
 /** Destination input provided by the host app */
 interface Destination {
     chainId: string;
@@ -142,7 +161,14 @@ interface UserConfig {
 /** Theme mode */
 type ThemeMode = 'light' | 'dark';
 /** Steps in the payment flow */
-type PaymentStep = 'login' | 'select-source' | 'enter-amount' | 'processing' | 'complete';
+type PaymentStep = 'login' | '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. */
+    asset: string | null;
+    /** Override chain name (e.g. 'Base', 'Ethereum'). Null = let backend decide. */
+    chain: string | null;
+}
 
 interface ThemeTokens {
     bg: string;
@@ -176,6 +202,10 @@ interface SwypeConfig {
     apiBaseUrl: string;
     theme: ThemeMode;
     tokens: ThemeTokens;
+    /** Pre-set deposit amount (controlled by host app via useSwypeDepositAmount) */
+    depositAmount: number | null;
+    /** Update the deposit amount from a host-app component */
+    setDepositAmount: (amount: number | null) => void;
 }
 interface SwypeProviderProps {
     /** Base URL for the Swype API (e.g. "http://localhost:3000") */
@@ -201,6 +231,26 @@ interface SwypeProviderProps {
 declare function SwypeProvider({ apiBaseUrl, theme, children, }: SwypeProviderProps): react_jsx_runtime.JSX.Element;
 /** Access the Swype SDK configuration. Throws if used outside SwypeProvider. */
 declare function useSwypeConfig(): SwypeConfig;
+/**
+ * Hook for host apps to pre-set the deposit amount before showing the
+ * payment widget. When set, the amount field in SwypePayment is
+ * auto-populated.
+ *
+ * @example
+ * ```tsx
+ * function ProductPage() {
+ *   const { setAmount } = useSwypeDepositAmount();
+ *   useEffect(() => { setAmount(25.00); }, []);
+ *   return <SwypePayment destination={dest} />;
+ * }
+ * ```
+ */
+declare function useSwypeDepositAmount(): {
+    /** Current deposit amount, or null if not set */
+    amount: number | null;
+    /** Set the deposit amount (pass null to clear) */
+    setAmount: (amount: number | null) => void;
+};
 
 interface SwypePaymentProps {
     /**
@@ -233,13 +283,28 @@ interface UseAuthorizationExecutorResult {
     executing: boolean;
     results: ActionExecutionResult[];
     error: string | null;
+    /** The current action being executed (for UI display). */
+    currentAction: AuthorizationAction | null;
+    /** The SELECT_SOURCE action when paused for user selection, null otherwise. */
+    pendingSelectSource: AuthorizationAction | null;
+    /** Call this from the UI to provide the user's chain+token choice. */
+    resolveSelectSource: (selection: SourceSelection) => void;
     executeSession: (transfer: Transfer) => Promise<void>;
 }
 /**
  * Executes the full authorization flow for a transfer's first session:
  * fetches the session, walks through PENDING actions (OPEN_PROVIDER,
- * SWITCH_CHAIN, APPROVE_PERMIT_2, SIGN_PERMIT2), reports each completion
- * to the server, and chains new actions that appear.
+ * REGISTER_PASSKEY, UPGRADE_SMART_ACCOUNT, GRANT_PERMISSIONS,
+ * SELECT_SOURCE), reports each completion to the server, and chains
+ * new actions that appear.
+ *
+ * Transfer signing (passkey) is handled separately via
+ * `useTransferSigning()` after the authorization flow completes.
+ *
+ * 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.
  */
 declare function useAuthorizationExecutor(): UseAuthorizationExecutorResult;
 
@@ -255,10 +320,25 @@ interface CreateTransferParams {
 }
 declare function createTransfer(apiBaseUrl: string, token: string, params: CreateTransferParams): Promise<Transfer>;
 declare function fetchTransfer(apiBaseUrl: string, token: string, transferId: 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 fetchAuthorizationSession(apiBaseUrl: string, sessionId: string): Promise<AuthorizationSessionDetail>;
 declare function updateUserConfig(apiBaseUrl: string, token: string, config: {
     defaultAllowance: number;
 }): Promise<void>;
+/**
+ * Updates the user's default allowance, authenticated by session ID.
+ * PATCH /v1/authorization-sessions/{id}/user-config
+ *
+ * This does not require a bearer token — the session ID itself serves
+ * as proof of authorization.
+ */
+declare function updateUserConfigBySession(apiBaseUrl: string, sessionId: string, config: {
+    defaultAllowance: number;
+}): Promise<void>;
 declare function reportActionCompletion(apiBaseUrl: string, actionId: string, result: Record<string, unknown>): Promise<AuthorizationSessionDetail>;
 
 type api_CreateTransferParams = CreateTransferParams;
@@ -269,9 +349,11 @@ declare const api_fetchChains: typeof fetchChains;
 declare const api_fetchProviders: typeof fetchProviders;
 declare const api_fetchTransfer: typeof fetchTransfer;
 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_updateUserConfig as updateUserConfig };
+  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 Account, type ActionExecutionResult, 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, 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 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 };