@connect-xyz/auth-js 1.61.0 → 1.62.1

package/dist/index.d.ts

@@ -88,13 +88,10 @@ export { Auth }
 export default Auth;
 
 /**
- * Callback function types for Connect Auth components
- * Extends common callbacks with auth-specific callbacks
+ * Callback function types for Connect Auth components.
+ * Common ones (incl. `onDeposit`) come from `CommonCallbacks`.
  */
-declare type AuthCallbacks = CommonCallbacks<AuthEvent> & {
-    /** Called when a deposit action occurs */
-    onDeposit?: (deposit: DepositCompletedPayload) => void;
-};
+declare type AuthCallbacks = CommonCallbacks<AuthEvent>;
 
 export declare interface AuthConfig extends BaseConfig<AuthEvent>, AuthCallbacks {
 }
@@ -408,25 +405,27 @@ declare type CommonCallbacks<TEvent = AppEvent> = {
     onEvent?: (event: TEvent) => void;
     /** Called when the widget has loaded and is ready */
     onLoaded?: () => void;
+    /**
+     * Called when a deposit reaches a terminal state (success/failure/verifying).
+     * Optional — only SDKs that drive the integrations deposit flow emit it.
+     */
+    onDeposit?: (deposit: DepositCompletedPayload) => void;
 };
 
 export declare type ConnectAuthElement = SdkElement<AuthConfig>;
 
 /**
- * Deposit completed payload structure for deposit callbacks
+ * Deposit completed payload — emitted by SDKs that drive a deposit through
+ * the integrations flow. Lives on `CommonCallbacks` because both Auth and
+ * any SDK embedding `@zerohash/integrations-flow` (e.g. fund with `useAuth`)
+ * resolve through the same deposit-status hook.
  */
 declare type DepositCompletedPayload = {
-    /** Data associated with the deposit */
     data: {
-        /** Unique identifier for the deposit */
         depositId: string;
-        /** Current status of the deposit */
         status: DepositStatus;
-        /** Asset identifier (e.g., 'btc', 'eth') */
         assetId: string;
-        /** Network identifier (e.g., 'bitcoin', 'ethereum') */
         networkId: string;
-        /** Amount being deposited */
         amount?: string;
         accountMatchingValidation?: {
             status: 'PENDING' | 'VALID' | 'INVALID' | 'ERROR';
@@ -436,14 +435,11 @@ declare type DepositCompletedPayload = {
 };
 
 /**
- * Deposit status object structure
+ * Deposit status object — shared across SDKs that surface deposit completion.
  */
 declare type DepositStatus = {
-    /** Status value */
     value: string;
-    /** Human-readable details about the status */
     details: string;
-    /** Timestamp when the status occurred (ISO 8601 format) */
     occurredAt: string;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connect-xyz/auth-js",
-  "version": "1.61.0",
+  "version": "1.62.1",
   "private": false,
   "type": "module",
   "main": "./dist/index.js",