@volr/react-ui 0.1.94 → 0.1.96

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import React$1 from 'react';
-import { KeyStorageType, VolrConfig, PaymentResult, PayOptions } from '@volr/react';
-export { EvmClient, KeyStorageType, SendBatchOverloads, SignerType, VolrClient, VolrConfig, VolrProvider, VolrUser, useDepositListener, usePasskeyEnrollment, useVolr, useVolrLogin } from '@volr/react';
+import { KeyStorageType, VolrConfig, PaymentResult, PayOptions as PayOptions$1, PaymentHistoryOptions, PaymentHistoryResult } from '@volr/react';
+export { EvmClient, KeyStorageType, PaymentHistoryOptions, PaymentHistoryResult, PaymentResult, PaymentStatus, PaymentToken, SendBatchOverloads, SignerType, UseVolrPaymentApiReturn, VolrClient, VolrConfig, VolrProvider, VolrUser, useDepositListener, usePasskeyEnrollment, useVolr, useVolrLogin, useVolrPaymentApi } from '@volr/react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 interface BrandingConfig {
@@ -243,7 +243,7 @@ interface ModalAsset {
 }
 interface PaymentModalOptions {
     payment: PaymentResult;
-    options: PayOptions;
+    options: PayOptions$1;
     onComplete?: (result: PaymentResult) => void;
     onProcessing?: (payment: PaymentResult & {
         txHash: string;
@@ -298,4 +298,106 @@ declare function useSwitchNetwork(): (chainId: number) => Promise<void>;
  */
 declare function getCurrentChainId(): Promise<number>;
 
-export { I18nContext, type I18nContextValue, I18nProvider, type I18nProviderProps, type Locale, MpcConnectView, type MpcConnectViewProps, type NetworkWalletConfig, PasskeyEnrollView, type PasskeyEnrollViewProps, type Translations, type VolrTheme, type VolrUIConfig, VolrUIProvider, type VolrUIProviderProps, getCurrentChainId, useI18n, useSwitchNetwork, useTranslation, useVolrModal, useVolrUI, useVolrUIOptional };
+/**
+ * useVolrPay hook - Payment with UI integration
+ *
+ * This hook provides payment functionality with PaymentModal integration.
+ * For headless API-only access, use useVolrPaymentApi from @volr/react
+ */
+
+/**
+ * Payment item displayed in modal
+ */
+interface PaymentItem {
+    /** Item name */
+    name: string;
+    /** Item description (optional) */
+    description?: string;
+    /** Item image URL (optional, falls back to project branding logo) */
+    image?: string;
+}
+/**
+ * Payment error
+ */
+interface PaymentError {
+    code: string;
+    message: string;
+}
+/**
+ * Payment handlers/callbacks
+ */
+interface PaymentHandlers {
+    /** Called when payment is created */
+    onCreated?: (payment: {
+        id: string;
+    }) => void;
+    /** Called when transaction is broadcasted */
+    onProcessing?: (payment: {
+        id: string;
+        txHash: string;
+    }) => void;
+    /** Called when payment is confirmed on-chain */
+    onSuccess?: (result: PaymentResult) => void;
+    /** Called when payment fails */
+    onError?: (error: PaymentError) => void;
+    /** Called when user cancels */
+    onCancel?: () => void;
+}
+/**
+ * Options for pay() function
+ */
+interface PayOptions {
+    /** Amount in token units (before decimals) */
+    amount: number;
+    /** Item information to display in modal */
+    item?: PaymentItem;
+    /** Client-side reference ID */
+    referenceId?: string;
+    /** Custom metadata (max 50 keys) */
+    metadata?: Record<string, string>;
+    /** Idempotency key to prevent duplicates */
+    idempotencyKey?: string;
+    /** Expiration time in seconds (default: 900 = 15 min) */
+    expiresInSec?: number;
+    /** Callback handlers */
+    handlers?: PaymentHandlers;
+}
+/**
+ * Payment handle returned from pay()
+ */
+interface PaymentHandle {
+    /** Payment ID */
+    id: string;
+    /** Current payment status */
+    status: PaymentResult['status'];
+    /** Wait for payment to complete */
+    wait: () => Promise<PaymentResult>;
+    /** Cancel the payment (only works for PENDING) */
+    cancel: () => Promise<void>;
+}
+/**
+ * useVolrPay return type
+ */
+interface UseVolrPayReturn {
+    /**
+     * Initiate a payment with PaymentModal
+     * @param options Payment options including amount, item, handlers
+     * @returns PaymentHandle with id, status, wait(), cancel()
+     */
+    pay: (options: PayOptions) => Promise<PaymentHandle>;
+    /**
+     * Check payment status by ID
+     */
+    checkPayment: (paymentId: string) => Promise<PaymentResult>;
+    /**
+     * Get payment history for current user
+     */
+    getPaymentHistory: (options?: PaymentHistoryOptions) => Promise<PaymentHistoryResult>;
+    /**
+     * Whether a payment is currently in progress
+     */
+    isPaymentInProgress: boolean;
+}
+declare function useVolrPay(): UseVolrPayReturn;
+
+export { I18nContext, type I18nContextValue, I18nProvider, type I18nProviderProps, type Locale, MpcConnectView, type MpcConnectViewProps, type NetworkWalletConfig, PasskeyEnrollView, type PasskeyEnrollViewProps, type PayOptions, type PaymentError, type PaymentHandle, type PaymentHandlers, type PaymentItem, type Translations, type UseVolrPayReturn, type VolrTheme, type VolrUIConfig, VolrUIProvider, type VolrUIProviderProps, getCurrentChainId, useI18n, useSwitchNetwork, useTranslation, useVolrModal, useVolrPay, useVolrUI, useVolrUIOptional };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import React$1 from 'react';
-import { KeyStorageType, VolrConfig, PaymentResult, PayOptions } from '@volr/react';
-export { EvmClient, KeyStorageType, SendBatchOverloads, SignerType, VolrClient, VolrConfig, VolrProvider, VolrUser, useDepositListener, usePasskeyEnrollment, useVolr, useVolrLogin } from '@volr/react';
+import { KeyStorageType, VolrConfig, PaymentResult, PayOptions as PayOptions$1, PaymentHistoryOptions, PaymentHistoryResult } from '@volr/react';
+export { EvmClient, KeyStorageType, PaymentHistoryOptions, PaymentHistoryResult, PaymentResult, PaymentStatus, PaymentToken, SendBatchOverloads, SignerType, UseVolrPaymentApiReturn, VolrClient, VolrConfig, VolrProvider, VolrUser, useDepositListener, usePasskeyEnrollment, useVolr, useVolrLogin, useVolrPaymentApi } from '@volr/react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 interface BrandingConfig {
@@ -243,7 +243,7 @@ interface ModalAsset {
 }
 interface PaymentModalOptions {
     payment: PaymentResult;
-    options: PayOptions;
+    options: PayOptions$1;
     onComplete?: (result: PaymentResult) => void;
     onProcessing?: (payment: PaymentResult & {
         txHash: string;
@@ -298,4 +298,106 @@ declare function useSwitchNetwork(): (chainId: number) => Promise<void>;
  */
 declare function getCurrentChainId(): Promise<number>;
 
-export { I18nContext, type I18nContextValue, I18nProvider, type I18nProviderProps, type Locale, MpcConnectView, type MpcConnectViewProps, type NetworkWalletConfig, PasskeyEnrollView, type PasskeyEnrollViewProps, type Translations, type VolrTheme, type VolrUIConfig, VolrUIProvider, type VolrUIProviderProps, getCurrentChainId, useI18n, useSwitchNetwork, useTranslation, useVolrModal, useVolrUI, useVolrUIOptional };
+/**
+ * useVolrPay hook - Payment with UI integration
+ *
+ * This hook provides payment functionality with PaymentModal integration.
+ * For headless API-only access, use useVolrPaymentApi from @volr/react
+ */
+
+/**
+ * Payment item displayed in modal
+ */
+interface PaymentItem {
+    /** Item name */
+    name: string;
+    /** Item description (optional) */
+    description?: string;
+    /** Item image URL (optional, falls back to project branding logo) */
+    image?: string;
+}
+/**
+ * Payment error
+ */
+interface PaymentError {
+    code: string;
+    message: string;
+}
+/**
+ * Payment handlers/callbacks
+ */
+interface PaymentHandlers {
+    /** Called when payment is created */
+    onCreated?: (payment: {
+        id: string;
+    }) => void;
+    /** Called when transaction is broadcasted */
+    onProcessing?: (payment: {
+        id: string;
+        txHash: string;
+    }) => void;
+    /** Called when payment is confirmed on-chain */
+    onSuccess?: (result: PaymentResult) => void;
+    /** Called when payment fails */
+    onError?: (error: PaymentError) => void;
+    /** Called when user cancels */
+    onCancel?: () => void;
+}
+/**
+ * Options for pay() function
+ */
+interface PayOptions {
+    /** Amount in token units (before decimals) */
+    amount: number;
+    /** Item information to display in modal */
+    item?: PaymentItem;
+    /** Client-side reference ID */
+    referenceId?: string;
+    /** Custom metadata (max 50 keys) */
+    metadata?: Record<string, string>;
+    /** Idempotency key to prevent duplicates */
+    idempotencyKey?: string;
+    /** Expiration time in seconds (default: 900 = 15 min) */
+    expiresInSec?: number;
+    /** Callback handlers */
+    handlers?: PaymentHandlers;
+}
+/**
+ * Payment handle returned from pay()
+ */
+interface PaymentHandle {
+    /** Payment ID */
+    id: string;
+    /** Current payment status */
+    status: PaymentResult['status'];
+    /** Wait for payment to complete */
+    wait: () => Promise<PaymentResult>;
+    /** Cancel the payment (only works for PENDING) */
+    cancel: () => Promise<void>;
+}
+/**
+ * useVolrPay return type
+ */
+interface UseVolrPayReturn {
+    /**
+     * Initiate a payment with PaymentModal
+     * @param options Payment options including amount, item, handlers
+     * @returns PaymentHandle with id, status, wait(), cancel()
+     */
+    pay: (options: PayOptions) => Promise<PaymentHandle>;
+    /**
+     * Check payment status by ID
+     */
+    checkPayment: (paymentId: string) => Promise<PaymentResult>;
+    /**
+     * Get payment history for current user
+     */
+    getPaymentHistory: (options?: PaymentHistoryOptions) => Promise<PaymentHistoryResult>;
+    /**
+     * Whether a payment is currently in progress
+     */
+    isPaymentInProgress: boolean;
+}
+declare function useVolrPay(): UseVolrPayReturn;
+
+export { I18nContext, type I18nContextValue, I18nProvider, type I18nProviderProps, type Locale, MpcConnectView, type MpcConnectViewProps, type NetworkWalletConfig, PasskeyEnrollView, type PasskeyEnrollViewProps, type PayOptions, type PaymentError, type PaymentHandle, type PaymentHandlers, type PaymentItem, type Translations, type UseVolrPayReturn, type VolrTheme, type VolrUIConfig, VolrUIProvider, type VolrUIProviderProps, getCurrentChainId, useI18n, useSwitchNetwork, useTranslation, useVolrModal, useVolrPay, useVolrUI, useVolrUIOptional };