@swype-org/react-sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,277 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+/** Wallet provider (e.g. MetaMask) */
+interface Provider {
+    id: string;
+    name: string;
+    logoURI?: string;
+}
+/** Blockchain chain */
+interface Chain {
+    id: string;
+    name: string;
+}
+/** Token balance within a wallet source */
+interface TokenBalance {
+    available: Amount;
+    total: Amount;
+}
+/** Token within a wallet source */
+interface WalletToken {
+    symbol: string;
+    status: string;
+}
+/** A token source within a wallet (e.g. USDC on a specific chain) */
+interface WalletSource {
+    id: string;
+    token: WalletToken;
+    balance: TokenBalance;
+}
+/** Full wallet with chain, balance, and token sources */
+interface Wallet {
+    id: string;
+    name: string;
+    status: string;
+    sources: WalletSource[];
+    balance: TokenBalance;
+    chain: {
+        id: string;
+        name: string;
+    };
+    createDate: string;
+    updateDate: string;
+    authorizationSessions?: AuthorizationSession[];
+}
+/** Connected account containing wallets */
+interface Account {
+    id: string;
+    name: string;
+    wallets: Wallet[];
+    createDate: string;
+    updateDate: string;
+    authorizationSessions?: AuthorizationSession[];
+}
+/** Authorization session (summary) */
+interface AuthorizationSession {
+    id: string;
+    status: string;
+    uri: string;
+}
+/** A single authorization action within a session */
+interface AuthorizationAction {
+    id: string;
+    type: string;
+    status: string;
+    orderIndex: number;
+    metadata?: Record<string, unknown>;
+}
+/** Full authorization session with ordered actions */
+interface AuthorizationSessionDetail {
+    id: string;
+    status: string;
+    uri: string;
+    actions: AuthorizationAction[];
+}
+/** Monetary amount */
+interface Amount {
+    amount: number;
+    currency: string;
+}
+/** Transfer destination in a response */
+interface TransferDestination {
+    id: string;
+    chainId: string;
+    address: string;
+    token: {
+        symbol: string;
+    };
+    amount: Amount;
+}
+/** Transfer object returned by the API */
+interface Transfer {
+    id: string;
+    status: string;
+    sources: Array<{
+        id: string;
+        status: string;
+        provider: Provider;
+        wallets: unknown[];
+    }>;
+    destinations: TransferDestination[];
+    amount: Amount;
+    createDate: string;
+    updateDate: string;
+    authorizationSessions: AuthorizationSession[];
+}
+/** Standard API error shape */
+interface ErrorResponse {
+    code: string;
+    message: string;
+    details: Array<{
+        code?: string;
+        message?: string;
+    }>;
+    traceId?: string;
+}
+/** Result of executing a single authorization action */
+interface ActionExecutionResult {
+    actionId: string;
+    type: string;
+    status: 'success' | 'error';
+    message: string;
+    data?: unknown;
+}
+/** Source type discriminator for transfer creation */
+type SourceType = 'providerId' | 'accountId' | 'walletId' | 'tokenId';
+/** Destination input provided by the host app */
+interface Destination {
+    chainId: string;
+    address: string;
+    token: {
+        symbol: string;
+    };
+}
+/** List response wrapper */
+interface ListResponse<T> {
+    items: T[];
+}
+/** User configuration preferences */
+interface UserConfig {
+    defaultAllowance?: number;
+}
+/** Theme mode */
+type ThemeMode = 'light' | 'dark';
+/** Steps in the payment flow */
+type PaymentStep = 'login' | 'select-source' | 'enter-amount' | 'processing' | 'complete';
+
+interface ThemeTokens {
+    bg: string;
+    bgCard: string;
+    bgInput: string;
+    bgHover: string;
+    bgOverlay: string;
+    text: string;
+    textSecondary: string;
+    textMuted: string;
+    textInverse: string;
+    border: string;
+    borderFocus: string;
+    accent: string;
+    accentHover: string;
+    accentText: string;
+    success: string;
+    successBg: string;
+    error: string;
+    errorBg: string;
+    shadow: string;
+    shadowLg: string;
+    radius: string;
+    radiusLg: string;
+}
+declare const darkTheme: ThemeTokens;
+declare const lightTheme: ThemeTokens;
+declare function getTheme(mode: ThemeMode): ThemeTokens;
+
+interface SwypeConfig {
+    apiBaseUrl: string;
+    theme: ThemeMode;
+    tokens: ThemeTokens;
+}
+interface SwypeProviderProps {
+    /** Base URL for the Swype API (e.g. "http://localhost:3000") */
+    apiBaseUrl: string;
+    /** Light or dark mode */
+    theme?: ThemeMode;
+    children: React.ReactNode;
+}
+/**
+ * Provides Swype SDK configuration and all required infrastructure
+ * (Privy auth, wagmi, React Query) to child components.
+ *
+ * Must wrap any `<SwypePayment>` usage. The integrator does **not** need
+ * to set up Privy, wagmi, or React Query — this provider handles it all.
+ *
+ * @example
+ * ```tsx
+ * <SwypeProvider apiBaseUrl="https://api.swype.com">
+ *   <SwypePayment destination={dest} onComplete={handler} />
+ * </SwypeProvider>
+ * ```
+ */
+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;
+
+interface SwypePaymentProps {
+    /**
+     * Where the funds go -- controlled by the host app (merchant).
+     *
+     * The merchant sets this prop and can update it at any time; the SDK
+     * reads it reactively whenever a transfer is created.
+     */
+    destination: Destination;
+    /** Called when the transfer reaches COMPLETED status */
+    onComplete?: (transfer: Transfer) => void;
+    /** Called on unrecoverable error */
+    onError?: (error: string) => void;
+}
+declare function SwypePayment({ destination, onComplete, onError, }: SwypePaymentProps): react_jsx_runtime.JSX.Element | null;
+
+interface UseTransferPollingResult {
+    transfer: Transfer | null;
+    error: string | null;
+    isPolling: boolean;
+    startPolling: (transferId: string) => void;
+    stopPolling: () => void;
+}
+/**
+ * Polls GET /v1/transfers/{id} every `intervalMs` until status is
+ * COMPLETED or FAILED.
+ */
+declare function useTransferPolling(intervalMs?: number): UseTransferPollingResult;
+interface UseAuthorizationExecutorResult {
+    executing: boolean;
+    results: ActionExecutionResult[];
+    error: string | null;
+    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.
+ */
+declare function useAuthorizationExecutor(): UseAuthorizationExecutorResult;
+
+declare function fetchProviders(apiBaseUrl: string, token: string): Promise<Provider[]>;
+declare function fetchChains(apiBaseUrl: string, token: string): Promise<Chain[]>;
+declare function fetchAccounts(apiBaseUrl: string, token: string): Promise<Account[]>;
+interface CreateTransferParams {
+    sourceType: SourceType;
+    sourceId: string;
+    destination: Destination;
+    amount: number;
+    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 fetchAuthorizationSession(apiBaseUrl: string, sessionId: string): Promise<AuthorizationSessionDetail>;
+declare function updateUserConfig(apiBaseUrl: string, token: string, config: {
+    defaultAllowance: number;
+}): Promise<void>;
+declare function reportActionCompletion(apiBaseUrl: string, actionId: string, result: Record<string, unknown>): Promise<AuthorizationSessionDetail>;
+
+type api_CreateTransferParams = CreateTransferParams;
+declare const api_createTransfer: typeof createTransfer;
+declare const api_fetchAccounts: typeof fetchAccounts;
+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_reportActionCompletion: typeof reportActionCompletion;
+declare const api_updateUserConfig: typeof updateUserConfig;
+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 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 };