@volr/react-ui 0.1.97 → 0.1.99

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import React$1 from 'react';
-import { KeyStorageType, VolrConfig, PaymentResult, PayOptions as PayOptions$1, PaymentHistoryOptions, PaymentHistoryResult } from '@volr/react';
+import { KeyStorageType, VolrConfig, PayOptions as PayOptions$1, PaymentResult, 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';
 
@@ -241,17 +241,24 @@ interface ModalAsset {
     chainId: number;
     symbol: string;
 }
+/**
+ * Payment modal options - payment is created when user clicks Pay button, not when modal opens
+ */
 interface PaymentModalOptions {
-    payment: PaymentResult;
+    /** Payment options (amount, item, etc.) - NOT a created payment record */
     options: PayOptions$1;
+    /** Called when payment is successfully confirmed */
     onComplete?: (result: PaymentResult) => void;
+    /** Called when transaction is broadcasted */
     onProcessing?: (payment: PaymentResult & {
         txHash: string;
     }) => void;
+    /** Called when payment fails */
     onError?: (error: {
         code: string;
         message: string;
     }) => void;
+    /** Called when user cancels (before Pay button click) */
     onCancel?: () => void;
 }
 interface OpenModalOptions {
@@ -327,7 +334,7 @@ interface PaymentError {
  * Payment handlers/callbacks
  */
 interface PaymentHandlers {
-    /** Called when payment is created */
+    /** Called when payment is created (after user clicks Pay) */
     onCreated?: (payment: {
         id: string;
     }) => void;
@@ -366,14 +373,10 @@ interface PayOptions {
  * Payment handle returned from pay()
  */
 interface PaymentHandle {
-    /** Payment ID */
-    id: string;
-    /** Current payment status */
-    status: PaymentResult['status'];
-    /** Wait for payment to complete */
+    /** Wait for payment to complete (resolves when confirmed, cancelled, or failed) */
     wait: () => Promise<PaymentResult>;
-    /** Cancel the payment (only works for PENDING) */
-    cancel: () => Promise<void>;
+    /** Cancel the modal (only works before Pay button is clicked) */
+    cancel: () => void;
 }
 /**
  * useVolrPay return type
@@ -381,10 +384,11 @@ interface PaymentHandle {
 interface UseVolrPayReturn {
     /**
      * Initiate a payment with PaymentModal
+     * Payment is created in DB only when user clicks Pay button
      * @param options Payment options including amount, item, handlers
-     * @returns PaymentHandle with id, status, wait(), cancel()
+     * @returns PaymentHandle with wait(), cancel()
      */
-    pay: (options: PayOptions) => Promise<PaymentHandle>;
+    pay: (options: PayOptions) => PaymentHandle;
     /**
      * Check payment status by ID
      */
@@ -394,7 +398,7 @@ interface UseVolrPayReturn {
      */
     getPaymentHistory: (options?: PaymentHistoryOptions) => Promise<PaymentHistoryResult>;
     /**
-     * Whether a payment is currently in progress
+     * Whether a payment modal is currently open
      */
     isPaymentInProgress: boolean;
 }

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import React$1 from 'react';
-import { KeyStorageType, VolrConfig, PaymentResult, PayOptions as PayOptions$1, PaymentHistoryOptions, PaymentHistoryResult } from '@volr/react';
+import { KeyStorageType, VolrConfig, PayOptions as PayOptions$1, PaymentResult, 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';
 
@@ -241,17 +241,24 @@ interface ModalAsset {
     chainId: number;
     symbol: string;
 }
+/**
+ * Payment modal options - payment is created when user clicks Pay button, not when modal opens
+ */
 interface PaymentModalOptions {
-    payment: PaymentResult;
+    /** Payment options (amount, item, etc.) - NOT a created payment record */
     options: PayOptions$1;
+    /** Called when payment is successfully confirmed */
     onComplete?: (result: PaymentResult) => void;
+    /** Called when transaction is broadcasted */
     onProcessing?: (payment: PaymentResult & {
         txHash: string;
     }) => void;
+    /** Called when payment fails */
     onError?: (error: {
         code: string;
         message: string;
     }) => void;
+    /** Called when user cancels (before Pay button click) */
     onCancel?: () => void;
 }
 interface OpenModalOptions {
@@ -327,7 +334,7 @@ interface PaymentError {
  * Payment handlers/callbacks
  */
 interface PaymentHandlers {
-    /** Called when payment is created */
+    /** Called when payment is created (after user clicks Pay) */
     onCreated?: (payment: {
         id: string;
     }) => void;
@@ -366,14 +373,10 @@ interface PayOptions {
  * Payment handle returned from pay()
  */
 interface PaymentHandle {
-    /** Payment ID */
-    id: string;
-    /** Current payment status */
-    status: PaymentResult['status'];
-    /** Wait for payment to complete */
+    /** Wait for payment to complete (resolves when confirmed, cancelled, or failed) */
     wait: () => Promise<PaymentResult>;
-    /** Cancel the payment (only works for PENDING) */
-    cancel: () => Promise<void>;
+    /** Cancel the modal (only works before Pay button is clicked) */
+    cancel: () => void;
 }
 /**
  * useVolrPay return type
@@ -381,10 +384,11 @@ interface PaymentHandle {
 interface UseVolrPayReturn {
     /**
      * Initiate a payment with PaymentModal
+     * Payment is created in DB only when user clicks Pay button
      * @param options Payment options including amount, item, handlers
-     * @returns PaymentHandle with id, status, wait(), cancel()
+     * @returns PaymentHandle with wait(), cancel()
      */
-    pay: (options: PayOptions) => Promise<PaymentHandle>;
+    pay: (options: PayOptions) => PaymentHandle;
     /**
      * Check payment status by ID
      */
@@ -394,7 +398,7 @@ interface UseVolrPayReturn {
      */
     getPaymentHistory: (options?: PaymentHistoryOptions) => Promise<PaymentHistoryResult>;
     /**
-     * Whether a payment is currently in progress
+     * Whether a payment modal is currently open
      */
     isPaymentInProgress: boolean;
 }