@dynamic-labs-sdk/react-hooks 1.9.0 → 1.11.0

package/dist/index.esm.js

@@ -1,5 +1,5 @@
 import { assertPackageVersion } from "@dynamic-labs-sdk/assert-package-version";
-import { BaseError, acknowledgeRecoveryCodes, addCoinbaseOnrampOrderEventListener, addNetwork, authenticateMfaRecoveryCode, authenticatePasskeyMFA, authenticateTotpMfaDevice, checkStepUpAuth, completeDeviceRegistration, completeSocialRedirect, confirmTransaction, connectAndVerifyWithWalletProvider, connectWithWalletProvider, consumeMfaToken, createCoinbaseOnrampOrder, createCryptoDotComPayment, createKrakenExchangeTransfer, createNewMfaRecoveryCodes, deleteMfaDevice, deletePasskey, deleteUser, executeSwapTransaction, getActiveNetworkData, getAvailableWalletProvidersData, getBalanceForAddress, getCoinbaseBuyUrl, getGoogleDriveBackupReadiness, getKrakenAccounts, getKrakenWhitelistedAddresses, getMfaDevices, getMfaMethods, getMfaRecoveryCodes, getMoonPayCurrencies, getMoonPayUrl, getMultichainTokenBalances, getNativeBalance, getNetworksData, getPasskeys, getRegisteredDevices, getSwapQuote, getSwapStatus, getTokenBalances, getTransactionHistory, getUserSocialAccounts, getWalletAccounts, getWalletConnectCatalog, getWalletOptionsCatalogue, isCaptchaRequired, isUserMissingMfaAuth, isUserOnboardingComplete, logout, onEvent, onWalletProviderEvent, onceEvent, proveWalletAccountOwnership, refreshAuth, registerPasskey, registerTotpMfaDevice, removeWalletAccount, requestExternalAuthElevatedToken, revokeAllRegisteredDevices, revokeRegisteredDevice, sendEmailOTP, sendSmsOTP, setDefaultMfaDevice, signInWithExternalJwt, signInWithPasskey, signInWithSocialPopUp, signInWithSocialRedirect, signMessage, switchActiveNetwork, transferAmount, transferWalletAccount, unlinkSocialAccount, updateUser, verifyOTP, verifyWalletAccount, waitForClientInitialized } from "@dynamic-labs-sdk/client";
+import { BaseError, acknowledgeRecoveryCodes, addCoinbaseOnrampOrderEventListener, addNetwork, attachFlowSource, authenticateMfaRecoveryCode, authenticatePasskeyMFA, authenticateTotpMfaDevice, broadcastFlow, cancelFlow, checkStepUpAuth, completeDeviceRegistration, completeSocialRedirect, confirmTransaction, connectAndVerifyWithWalletProvider, connectWithWalletProvider, consumeMfaToken, createCoinbaseOnrampOrder, createCryptoDotComPayment, createKrakenExchangeTransfer, createNewMfaRecoveryCodes, deleteMfaDevice, deletePasskey, deleteUser, executeSwapTransaction, getActiveNetworkData, getAvailableWalletProvidersData, getBalanceForAddress, getCoinbaseBuyUrl, getFlow, getFlowQuote, getGoogleDriveBackupReadiness, getKrakenAccounts, getKrakenWhitelistedAddresses, getMfaDevices, getMfaMethods, getMfaRecoveryCodes, getMoonPayCurrencies, getMoonPayUrl, getMultichainTokenBalances, getNativeBalance, getNetworksData, getPasskeys, getRegisteredDevices, getSwapQuote, getSwapStatus, getTokenBalances, getTransactionHistory, getUserSocialAccounts, getWalletAccounts, getWalletConnectCatalog, getWalletOptionsCatalogue, isCaptchaRequired, isUserMissingMfaAuth, isUserOnboardingComplete, logout, onEvent, onWalletProviderEvent, onceEvent, prepareFlowSigning, proveWalletAccountOwnership, refreshAuth, registerPasskey, registerTotpMfaDevice, removeWalletAccount, requestExternalAuthElevatedToken, revokeAllRegisteredDevices, revokeRegisteredDevice, sendEmailOTP, sendSmsOTP, setDefaultMfaDevice, signInWithExternalJwt, signInWithPasskey, signInWithSocialPopUp, signInWithSocialRedirect, signMessage, submitFlowTransaction, switchActiveNetwork, transferAmount, transferWalletAccount, unlinkSocialAccount, updateUser, verifyOTP, verifyWalletAccount, waitForClientInitialized } from "@dynamic-labs-sdk/client";
 import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
 import { createContext, useContext, useEffect, useMemo, useRef } from "react";
 import { jsx } from "react/jsx-runtime";
@@ -7,7 +7,7 @@ import { getCore } from "@dynamic-labs-sdk/client/core";
 
 //#region package.json
 var name = "@dynamic-labs-sdk/react-hooks";
-var version = "1.9.0";
+var version = "1.11.0";
 
 //#endregion
 //#region src/modules/DynamicContext/DynamicContext.ts
@@ -174,6 +174,28 @@ const useAddNetwork = ({ mutateParams } = {}) => useBaseMutation({
 	mutationFn: ({ client, variables }) => addNetwork(variables, client)
 });
 
+//#endregion
+//#region src/hooks/wrappers/functions/useAttachFlowSource/useAttachFlowSource.ts
+/**
+* Attaches a payment source to a flow.
+*
+* Wraps `attachFlowSource` from `@dynamic-labs-sdk/client`. Call `mutate({ flowId, sourceType, fromAddress, fromChainId, fromChainName })`
+* to attach a payment source to a flow; the resolved `data` is an object containing
+* the flow and the session token.
+*
+* @example
+* ```tsx
+* const { mutate: attachFlowSource, isPending } = useAttachFlowSource();
+* <button onClick={() => attachFlowSource({ flowId, sourceType, fromAddress, fromChainId, fromChainName })} disabled={isPending}>
+*   Attach flow source
+* </button>
+* ```
+*/
+const useAttachFlowSource = ({ mutateParams } = {}) => useBaseMutation({
+	mutateParams,
+	mutationFn: ({ client, variables }) => attachFlowSource(variables, client)
+});
+
 //#endregion
 //#region src/hooks/wrappers/functions/useAuthenticateMfaRecoveryCode/useAuthenticateMfaRecoveryCode.ts
 /**
@@ -385,6 +407,49 @@ const useBalanceForAddress = ({ queryParams, ...args }) => useBaseQuery({
 	queryParams
 });
 
+//#endregion
+//#region src/hooks/wrappers/functions/useBroadcastFlow/useBroadcastFlow.ts
+/**
+* Records that a flow transaction has been broadcasted.
+*
+* Wraps `broadcastFlow` from `@dynamic-labs-sdk/client`. Call `mutate({ flowId, txHash })`
+* to record the broadcast. For wallet sources pass the on-chain `txHash`; for exchange
+* sources `txHash` can be omitted.
+*
+* @example
+* ```tsx
+* const { mutate: broadcastFlow, isPending } = useBroadcastFlow();
+* <button onClick={() => broadcastFlow({ flowId, txHash })} disabled={isPending}>
+*   Broadcast flow
+* </button>
+* ```
+*/
+const useBroadcastFlow = ({ mutateParams } = {}) => useBaseMutation({
+	mutateParams,
+	mutationFn: ({ client, variables }) => broadcastFlow(variables, client)
+});
+
+//#endregion
+//#region src/hooks/wrappers/functions/useCancelFlow/useCancelFlow.ts
+/**
+* Cancels a flow before it has been broadcasted.
+*
+* Wraps `cancelFlow` from `@dynamic-labs-sdk/client`. Call `mutate({ flowId })`
+* to cancel a flow.
+*
+* @example
+* ```tsx
+* const { mutate: cancelFlow, isPending } = useCancelFlow();
+* <button onClick={() => cancelFlow({ flowId })} disabled={isPending}>
+*   Cancel flow
+* </button>
+* ```
+*/
+const useCancelFlow = ({ mutateParams } = {}) => useBaseMutation({
+	mutateParams,
+	mutationFn: ({ client, variables }) => cancelFlow(variables, client)
+});
+
 //#endregion
 //#region src/hooks/wrappers/functions/useCheckStepUpAuth/useCheckStepUpAuth.ts
 /**
@@ -737,63 +802,81 @@ const useExecuteSwapTransaction = ({ mutateParams } = {}) => useBaseMutation({
 });
 
 //#endregion
-//#region src/hooks/wrappers/functions/useGoogleDriveBackupReadiness/useGoogleDriveBackupReadiness.ts
+//#region src/hooks/wrappers/functions/useGetFlow/useGetFlow.ts
 /**
-* Wraps `getGoogleDriveBackupReadiness` from `@dynamic-labs-sdk/client`. Reports whether the user's Google Drive backup is set up and available.
+* Returns the flow with the given ID.
+*
+* Wraps `getFlow` from `@dynamic-labs-sdk/client`.
 *
 * @example
 * ```tsx
-* const { data: readiness, isLoading } = useGoogleDriveBackupReadiness();
+* const { data: flow, isLoading, refetch } = useGetFlow({ flowId });
 * ```
 */
-const useGoogleDriveBackupReadiness = ({ queryParams } = {}) => useBaseQuery({
-	queryFn: (client) => getGoogleDriveBackupReadiness(client),
-	queryKey: ["useGoogleDriveBackupReadiness"],
+const useGetFlow = ({ flowId, queryParams }) => useBaseQuery({
+	enabled: flowId !== void 0,
+	queryFn: (client) => getFlow({ flowId }, client),
+	queryKey: ["useGetFlow", flowId],
 	queryParams
 });
 
 //#endregion
-//#region src/hooks/wrappers/state/useInitStatus/useInitStatus.ts
+//#region src/hooks/wrappers/functions/useGetFlowQuote/useGetFlowQuote.ts
 /**
-* Returns the current initialization status of the Dynamic client, plus the
-* error that caused initialization to fail (when it did).
+* Fetches a quote for a flow.
 *
-* Exposes only `data` (the reactive init status), `error` and `isError` —
-* see {@link UseInitStatusResult}. Possible `data` values: `'uninitialized'`,
-* `'in-progress'`, `'finished'`, `'failed'`. When `data === 'failed'`, `error`
-* carries the failure reason.
+* Wraps `getFlowQuote` from `@dynamic-labs-sdk/client`. Call `mutate({ flowId, fromTokenAddress, slippage })`
+* to fetch a quote for a flow.
 *
 * @example
 * ```tsx
-* const { data: status, error } = useInitStatus();
-* if (status === 'failed') return <InitErrorScreen message={error?.message} />;
-* if (status !== 'finished') return <LoadingScreen />;
-* return <App />;
+* const { mutate: getFlowQuote, isPending } = useGetFlowQuote();
+* <button onClick={() => getFlowQuote({ flowId, fromTokenAddress, slippage })} disabled={isPending}>
+*   Get flow quote
+* </button>
 * ```
+*/
+const useGetFlowQuote = ({ mutateParams } = {}) => useBaseMutation({
+	mutateParams,
+	mutationFn: ({ client, variables }) => getFlowQuote(variables, client)
+});
+
+//#endregion
+//#region src/hooks/wrappers/functions/usePrepareFlowSigning/usePrepareFlowSigning.ts
+/**
+* Prepares a flow transaction for signing.
 *
-* @not-instrumented
+* Wraps `prepareFlowSigning` from `@dynamic-labs-sdk/client`. Call `mutate({ flowId })`
+* to prepare a flow for signing.
+*
+* @example
+* ```tsx
+* const { mutate: prepareFlowSigning, isPending } = usePrepareFlowSigning();
+* <button onClick={() => prepareFlowSigning({ flowId })} disabled={isPending}>
+*   Prepare flow signing
+* </button>
+* ```
 */
-const useInitStatus = () => {
-	const { data } = useBaseState({
-		defaultValue: {
-			error: null,
-			status: "uninitialized"
-		},
-		event: "initStatusChanged",
-		queryKey: ["useInitStatus"],
-		selector: (client) => ({
-			error: client.initError,
-			status: client.initStatus
-		}),
-		skipWaitForInit: true
-	});
-	const error = data?.error ?? null;
-	return {
-		data: data?.status,
-		error,
-		isError: error !== null
-	};
-};
+const usePrepareFlowSigning = ({ mutateParams } = {}) => useBaseMutation({
+	mutateParams,
+	mutationFn: ({ client, variables }) => prepareFlowSigning(variables, client)
+});
+
+//#endregion
+//#region src/hooks/wrappers/functions/useGoogleDriveBackupReadiness/useGoogleDriveBackupReadiness.ts
+/**
+* Wraps `getGoogleDriveBackupReadiness` from `@dynamic-labs-sdk/client`. Reports whether the user's Google Drive backup is set up and available.
+*
+* @example
+* ```tsx
+* const { data: readiness, isLoading } = useGoogleDriveBackupReadiness();
+* ```
+*/
+const useGoogleDriveBackupReadiness = ({ queryParams } = {}) => useBaseQuery({
+	queryFn: (client) => getGoogleDriveBackupReadiness(client),
+	queryKey: ["useGoogleDriveBackupReadiness"],
+	queryParams
+});
 
 //#endregion
 //#region src/hooks/wrappers/functions/useIsCaptchaRequired/useIsCaptchaRequired.ts
@@ -1362,20 +1445,6 @@ const useSendSmsOtp = ({ mutateParams } = {}) => useBaseMutation({
 	mutationFn: ({ client, variables }) => sendSmsOTP(variables, client)
 });
 
-//#endregion
-//#region src/hooks/wrappers/state/useSessionExpiresAt/useSessionExpiresAt.ts
-/**
-* Returns the session expiration date, or null if no active session.
-*
-* Re-renders when the user changes (which includes session updates).
-*/
-const useSessionExpiresAt = () => useBaseState({
-	defaultValue: null,
-	event: "userChanged",
-	queryKey: ["useSessionExpiresAt"],
-	selector: (client) => client.sessionExpiresAt
-});
-
 //#endregion
 //#region src/hooks/wrappers/functions/useSetDefaultMfaDevice/useSetDefaultMfaDevice.ts
 /**
@@ -1493,6 +1562,28 @@ const useSignMessage = ({ mutateParams } = {}) => useBaseMutation({
 	mutationFn: ({ client, variables }) => signMessage(variables, client)
 });
 
+//#endregion
+//#region src/hooks/wrappers/functions/useSubmitFlowTransaction/useSubmitFlowTransaction.ts
+/**
+* Prepares, signs, and broadcasts a flow transaction in one call.
+*
+* Wraps `submitFlowTransaction` from `@dynamic-labs-sdk/client`. Call
+* `mutate({ flowId, walletAccount })` to run the full submission flow:
+* prepare signing, sign on-chain, and broadcast.
+*
+* @example
+* ```tsx
+* const { mutate: submitFlowTransaction, isPending } = useSubmitFlowTransaction();
+* <button onClick={() => submitFlowTransaction({ flowId, walletAccount })} disabled={isPending}>
+*   Submit flow transaction
+* </button>
+* ```
+*/
+const useSubmitFlowTransaction = ({ mutateParams } = {}) => useBaseMutation({
+	mutateParams,
+	mutationFn: ({ client, variables }) => submitFlowTransaction(variables, client)
+});
+
 //#endregion
 //#region src/hooks/wrappers/functions/useSwapQuote/useSwapQuote.ts
 /**
@@ -1707,20 +1798,6 @@ const useUpdateUser = ({ mutateParams } = {}) => useBaseMutation({
 	mutationFn: ({ client, variables }) => updateUser(variables, client)
 });
 
-//#endregion
-//#region src/hooks/wrappers/state/useUser/useUser.ts
-/**
-* Returns the current authenticated user, or null if not authenticated.
-*
-* Re-renders when the user changes (login, logout, profile update).
-*/
-const useUser = () => useBaseState({
-	defaultValue: null,
-	event: "userChanged",
-	queryKey: ["useUser"],
-	selector: (client) => client.user
-});
-
 //#endregion
 //#region src/hooks/wrappers/functions/useUserSocialAccounts/useUserSocialAccounts.ts
 /**
@@ -1881,10 +1958,81 @@ const useWalletProviderEvent = ({ callback, event, walletProviderKey }) => {
 	]);
 };
 
+//#endregion
+//#region src/hooks/wrappers/state/useInitStatus/useInitStatus.ts
+/**
+* Returns the current initialization status of the Dynamic client, plus the
+* error that caused initialization to fail (when it did).
+*
+* Exposes only `data` (the reactive init status), `error` and `isError` —
+* see {@link UseInitStatusResult}. Possible `data` values: `'uninitialized'`,
+* `'in-progress'`, `'finished'`, `'failed'`. When `data === 'failed'`, `error`
+* carries the failure reason.
+*
+* @example
+* ```tsx
+* const { data: status, error } = useInitStatus();
+* if (status === 'failed') return <InitErrorScreen message={error?.message} />;
+* if (status !== 'finished') return <LoadingScreen />;
+* return <App />;
+* ```
+*
+* @not-instrumented
+*/
+const useInitStatus = () => {
+	const { data } = useBaseState({
+		defaultValue: {
+			error: null,
+			status: "uninitialized"
+		},
+		event: "initStatusChanged",
+		queryKey: ["useInitStatus"],
+		selector: (client) => ({
+			error: client.initError,
+			status: client.initStatus
+		}),
+		skipWaitForInit: true
+	});
+	const error = data?.error ?? null;
+	return {
+		data: data?.status,
+		error,
+		isError: error !== null
+	};
+};
+
+//#endregion
+//#region src/hooks/wrappers/state/useSessionExpiresAt/useSessionExpiresAt.ts
+/**
+* Returns the session expiration date, or null if no active session.
+*
+* Re-renders when the user changes (which includes session updates).
+*/
+const useSessionExpiresAt = () => useBaseState({
+	defaultValue: null,
+	event: "userChanged",
+	queryKey: ["useSessionExpiresAt"],
+	selector: (client) => client.sessionExpiresAt
+});
+
+//#endregion
+//#region src/hooks/wrappers/state/useUser/useUser.ts
+/**
+* Returns the current authenticated user, or null if not authenticated.
+*
+* Re-renders when the user changes (login, logout, profile update).
+*/
+const useUser = () => useBaseState({
+	defaultValue: null,
+	event: "userChanged",
+	queryKey: ["useUser"],
+	selector: (client) => client.user
+});
+
 //#endregion
 //#region src/exports/index.ts
 assertPackageVersion(name, version);
 
 //#endregion
-export { DynamicProvider, useAcknowledgeRecoveryCodes, useActiveNetworkData, useAddNetwork, useAuthenticateMfaRecoveryCode, useAuthenticatePasskeyMfa, useAuthenticateTotpMfaDevice, useAvailableWalletProvidersData, useBalanceForAddress, useCheckStepUpAuth, useCoinbaseBuyUrl, useCoinbaseOnrampOrderEventListener, useCompleteDeviceRegistration, useCompleteSocialRedirect, useConfirmTransaction, useConnectAndVerifyWithWalletProvider, useConnectWithWalletProvider, useConsumeMfaToken, useCreateCoinbaseOnrampOrder, useCreateCryptoDotComPayment, useCreateNewMfaRecoveryCodes, useDeleteMfaDevice, useDeletePasskey, useDeleteUser, useDynamicClient, useEvent, useExecuteSwapTransaction, useGoogleDriveBackupReadiness, useInitStatus, useIsCaptchaRequired, useIsUserMissingMfaAuth, useIsUserOnboardingComplete, useKrakenAccounts, useKrakenExchangeTransfer, useKrakenWhitelistedAddresses, useLogout, useMfaDevices, useMfaMethods, useMfaRecoveryCodes, useMoonPayCurrencies, useMoonPayUrl, useMultichainTokenBalances, useNativeBalance, useNetworksData, useOnceEvent, usePasskeys, useProveWalletAccountOwnership, useRefreshAuth, useRegisterPasskey, useRegisterTotpMfaDevice, useRegisteredDevices, useRemoveWalletAccount, useRequestExternalAuthElevatedToken, useRevokeAllRegisteredDevices, useRevokeRegisteredDevice, useSendEmailOtp, useSendSmsOtp, useSessionExpiresAt, useSetDefaultMfaDevice, useSignInWithExternalJwt, useSignInWithPasskey, useSignInWithSocialPopUp, useSignInWithSocialRedirect, useSignMessage, useSwapQuote, useSwapStatus, useSwitchActiveNetwork, useTokenBalances, useTransactionHistory, useTransferAmount, useTransferWalletAccount, useUnlinkSocialAccount, useUpdateUser, useUser, useUserSocialAccounts, useVerifyOtp, useVerifyWalletAccount, useWalletAccounts, useWalletConnectCatalog, useWalletOptionsCatalogue, useWalletProviderEvent };
+export { DynamicProvider, useAcknowledgeRecoveryCodes, useActiveNetworkData, useAddNetwork, useAttachFlowSource, useAuthenticateMfaRecoveryCode, useAuthenticatePasskeyMfa, useAuthenticateTotpMfaDevice, useAvailableWalletProvidersData, useBalanceForAddress, useBroadcastFlow, useCancelFlow, useCheckStepUpAuth, useCoinbaseBuyUrl, useCoinbaseOnrampOrderEventListener, useCompleteDeviceRegistration, useCompleteSocialRedirect, useConfirmTransaction, useConnectAndVerifyWithWalletProvider, useConnectWithWalletProvider, useConsumeMfaToken, useCreateCoinbaseOnrampOrder, useCreateCryptoDotComPayment, useCreateNewMfaRecoveryCodes, useDeleteMfaDevice, useDeletePasskey, useDeleteUser, useDynamicClient, useEvent, useExecuteSwapTransaction, useGetFlow, useGetFlowQuote, useGoogleDriveBackupReadiness, useInitStatus, useIsCaptchaRequired, useIsUserMissingMfaAuth, useIsUserOnboardingComplete, useKrakenAccounts, useKrakenExchangeTransfer, useKrakenWhitelistedAddresses, useLogout, useMfaDevices, useMfaMethods, useMfaRecoveryCodes, useMoonPayCurrencies, useMoonPayUrl, useMultichainTokenBalances, useNativeBalance, useNetworksData, useOnceEvent, usePasskeys, usePrepareFlowSigning, useProveWalletAccountOwnership, useRefreshAuth, useRegisterPasskey, useRegisterTotpMfaDevice, useRegisteredDevices, useRemoveWalletAccount, useRequestExternalAuthElevatedToken, useRevokeAllRegisteredDevices, useRevokeRegisteredDevice, useSendEmailOtp, useSendSmsOtp, useSessionExpiresAt, useSetDefaultMfaDevice, useSignInWithExternalJwt, useSignInWithPasskey, useSignInWithSocialPopUp, useSignInWithSocialRedirect, useSignMessage, useSubmitFlowTransaction, useSwapQuote, useSwapStatus, useSwitchActiveNetwork, useTokenBalances, useTransactionHistory, useTransferAmount, useTransferWalletAccount, useUnlinkSocialAccount, useUpdateUser, useUser, useUserSocialAccounts, useVerifyOtp, useVerifyWalletAccount, useWalletAccounts, useWalletConnectCatalog, useWalletOptionsCatalogue, useWalletProviderEvent };
 //# sourceMappingURL=index.esm.js.map