@dynamic-labs-sdk/client 1.10.0 → 1.12.0

package/dist/index.cjs

@@ -1,9 +1,10 @@
-const require_isMfaRequiredForAction = require('./isMfaRequiredForAction-C9Fw0v_g.cjs');
-const require_InvalidParamError = require('./InvalidParamError-CGZRSAOn.cjs');
-const require_getNetworkProviderFromNetworkId = require('./getNetworkProviderFromNetworkId-2wYAIZ6w.cjs');
-const require_getWalletProviderByKey = require('./getWalletProviderByKey-DMNpwDEn.cjs');
-const require_refreshAuth = require('./refreshAuth-DfcR3CWf.cjs');
-const require_NotWaasWalletAccountError = require('./NotWaasWalletAccountError-cIj987D7.cjs');
+const require_isMfaRequiredForAction = require('./isMfaRequiredForAction-DSo1ysdD.cjs');
+const require_InvalidParamError = require('./InvalidParamError-Bgg4SDfm.cjs');
+const require_getNetworkProviderFromNetworkId = require('./getNetworkProviderFromNetworkId-Afx6InoJ.cjs');
+const require_getWalletProviderByKey = require('./getWalletProviderByKey-DRex9vzR.cjs');
+const require_refreshAuth = require('./refreshAuth-Ca_JABru.cjs');
+const require_isDynamicWaasEnabled = require('./isDynamicWaasEnabled-CEVTY3gQ.cjs');
+const require_preconnectWaasIframe = require('./preconnectWaasIframe-Cb9xM6kI.cjs');
 let _dynamic_labs_sdk_assert_package_version = require("@dynamic-labs-sdk/assert-package-version");
 let _dynamic_labs_sdk_api_core = require("@dynamic-labs/sdk-api-core");
 let zod_mini = require("zod/mini");
@@ -363,6 +364,7 @@ const initializeStorageSync = async (client) => {
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A promise that resolves to the authenticated user.
 * @instrumented
+* @noHook Low-level refresh primitive that is not exposed as a React hook.
 */
 const refreshUser = async (client = require_InvalidParamError.getDefaultClient()) => {
 	const core = require_InvalidParamError.getCore(client);
@@ -415,6 +417,7 @@ var ClientAlreadyInitializedError = class extends require_InvalidParamError.Base
 * @returns A promise that resolves when initialization is complete.
 * @throws ClientAlreadyInitializedError If the client is already initialized.
 * @instrumented
+* @noHook Client lifecycle management is not exposed as a React hook.
 */
 const initializeClient = async (client = require_InvalidParamError.getDefaultClient()) => {
 	const core = require_InvalidParamError.getCore(client);
@@ -1857,6 +1860,7 @@ const __signInWithPasskey_wrapped = require_InvalidParamError.instrumentFunction
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns An array of `SocialAccount` objects associated with the user.
 * @not-instrumented
+* @hook Exposed as a hook so consumers get the reactive list of social accounts, updated when the user changes.
 */
 const getUserSocialAccounts = (client = require_InvalidParamError.getDefaultClient()) => {
 	const { user } = client;
@@ -2108,6 +2112,7 @@ const processSocialCallback = async ({ url, requestedScopes }, client) => {
 	if (storedSocialRedirectState.state !== dynamicOauthState) throw new InvalidRedirectStorageStateError();
 	const { provider, codeVerifier } = storedSocialRedirectState;
 	await core.storage.removeItem(redirectStateStorageKeySchema);
+	require_preconnectWaasIframe.preconnectWaasIframe(client);
 	let response;
 	if (client.user) response = await apiClient.oauthVerify({
 		environmentId: core.environmentId,
@@ -2186,6 +2191,7 @@ const __completeSocialRedirect_wrapped = require_InvalidParamError.instrumentFun
 * removed in a future major version.
 *
 * @instrumented
+* @noHook Deprecated alias; the replacement is exposed via its own hook.
 */
 const completeSocialAuthentication = (params, client = require_InvalidParamError.getDefaultClient()) => __completeSocialRedirect_wrapped(params, client);
 const __completeSocialAuthentication_impl = completeSocialAuthentication;
@@ -2231,6 +2237,7 @@ const detectSocialRedirectUrl = async ({ url }, client = require_InvalidParamErr
 * removed in a future major version.
 *
 * @not-instrumented
+* @noHook Deprecated alias; the replacement is exposed via its own hook.
 */
 const detectOAuthRedirect = (params, client = require_InvalidParamError.getDefaultClient()) => detectSocialRedirectUrl(params, client);
 
@@ -2375,6 +2382,7 @@ const getTokenBalances = async ({ walletAccount, networkId, networkIds, includeP
 * multi-chain `getMultichainTokenBalances`.
 *
 * @not-instrumented
+* @noHook Deprecated; the replacement is exposed via its own hook.
 */
 const getBalances = (params, client = require_InvalidParamError.getDefaultClient()) => getTokenBalances(params, client);
 
@@ -2410,6 +2418,7 @@ const getMultichainTokenBalances = async ({ balanceRequest }, client = require_I
 * token balances (not native-only) across multiple chains.
 *
 * @not-instrumented
+* @noHook Deprecated; the replacement is exposed via its own hook.
 */
 const getMultichainBalances = (params, client = require_InvalidParamError.getDefaultClient()) => getMultichainTokenBalances(params, client);
 
@@ -2493,6 +2502,8 @@ const withCheckoutSessionTokenCleanupOn401 = async ({ call, transactionId }, cli
 * exchange source record. The response includes `exchangeSource.metadata.url`
 * which can be embedded in an iframe for the user to complete payment.
 *
+* @deprecated Use {@link attachFlowSource} instead. See https://www.dynamic.xyz/docs/javascript/reference/flow-getting-started
+*
 * @param params AttachCheckoutTransactionSourceParams - The source details to attach.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns The updated checkout transaction (with exchangeSource if sourceType is 'exchange')
@@ -2540,6 +2551,8 @@ const __attachCheckoutTransactionSource_wrapped = require_InvalidParamError.inst
 * For exchange sources, `txHash` can be omitted — the user confirms
 * they completed the payment and the transaction moves to `broadcasted`.
 *
+* @deprecated Use {@link broadcastFlow} instead. See https://www.dynamic.xyz/docs/javascript/reference/flow-getting-started
+*
 * @param params BroadcastCheckoutTransactionParams - The transaction ID and optional tx hash.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns The updated checkout transaction
@@ -2575,6 +2588,8 @@ const __broadcastCheckoutTransaction_wrapped = require_InvalidParamError.instrum
 /**
 * Cancels a checkout transaction before it has been broadcasted
 *
+* @deprecated Use {@link cancelFlow} instead. See https://www.dynamic.xyz/docs/javascript/reference/flow-getting-started
+*
 * @param params CancelCheckoutTransactionParams - The transaction to cancel.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns The cancelled checkout transaction
@@ -2620,6 +2635,8 @@ const getCheckouts = async (client) => {
 /**
 * Creates a new checkout transaction and stores the session token for subsequent calls
 *
+* @deprecated Use the Flow API instead. See https://www.dynamic.xyz/docs/javascript/reference/flow-getting-started
+*
 * @param params CreateCheckoutTransactionParams - The parameters for the checkout transaction.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns The created transaction with session token
@@ -2666,6 +2683,8 @@ const __createCheckoutTransaction_wrapped = require_InvalidParamError.instrument
 /**
 * Fetches the current state of a checkout transaction
 *
+* @deprecated Use {@link getFlow} instead. See https://www.dynamic.xyz/docs/javascript/reference/flow-getting-started
+*
 * @param params GetCheckoutTransactionParams - The parameters for fetching the transaction.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns The checkout transaction
@@ -2684,6 +2703,8 @@ const getCheckoutTransaction = async ({ transactionId }, client = require_Invali
 /**
 * Fetches a quote for a checkout transaction
 *
+* @deprecated Use {@link getFlowQuote} instead. See https://www.dynamic.xyz/docs/javascript/reference/flow-getting-started
+*
 * @param params GetCheckoutTransactionQuoteParams - The quote parameters.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns The updated checkout transaction with quote data
@@ -2713,6 +2734,8 @@ const getCheckoutTransactionQuote = async ({ fromChainId, fromTokenAddress, slip
 * This should be called immediately before triggering the transaction signing.
 * It will confirm the quote is still valid, the risk state is cleared, and the transaction is ready to be signed.
 *
+* @deprecated Use {@link prepareFlowSigning} instead. See https://www.dynamic.xyz/docs/javascript/reference/flow-getting-started
+*
 * @param params PrepareCheckoutTransactionParams - The transaction to prepare.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns The updated checkout transaction
@@ -2860,6 +2883,8 @@ const __executeSwapTransaction_wrapped = require_InvalidParamError.instrumentFun
 * 3. Delegates on-chain signing to the wallet provider's executeSwapTransaction method
 * 4. Calls broadcastCheckoutTransaction with the resulting txHash
 *
+* @deprecated Use {@link submitFlowTransaction} instead. See https://www.dynamic.xyz/docs/javascript/reference/flow-getting-started
+*
 * @param params SubmitCheckoutTransactionParams - The transaction ID, wallet account, and optional step callback.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns The broadcasted checkout transaction
@@ -2911,6 +2936,8 @@ const __submitCheckoutTransaction_wrapped = require_InvalidParamError.instrument
 * the realtime checkout transaction channel. Will be re-enabled once the
 * dashboard-api environment has the Ably wiring in place.
 *
+* @deprecated Use the Flow API instead. See https://www.dynamic.xyz/docs/javascript/reference/flow-getting-started
+*
 * @param params.transactionId - The ID of the checkout transaction to track.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @not-instrumented
@@ -2930,6 +2957,8 @@ const trackCheckoutTransaction = (_params, client = require_InvalidParamError.ge
 * Returns `false` when the from token already matches a settlement token, so no
 * conversion is needed.
 *
+* @deprecated Use the Flow API instead. See https://www.dynamic.xyz/docs/javascript/reference/flow-getting-started
+*
 * @param params - The from token details and the checkout's settlement config.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns Whether a token conversion is required
@@ -3193,6 +3222,96 @@ const __attachFlowSource_wrapped = require_InvalidParamError.instrumentFunction(
 	}
 });
 
+//#endregion
+//#region src/modules/flow/utils/createFlowApiClient/createFlowApiClient.ts
+/** @not-instrumented */
+const createFlowApiClient = async ({ flowId }, client) => {
+	const core = require_InvalidParamError.getCore(client);
+	const apiClient = require_InvalidParamError.createApiClient({}, client);
+	const sessionToken = await core.storage.getItem(createFlowSessionTokenStorageKey(flowId));
+	if (!sessionToken) throw new FlowSessionTokenMissingError({ flowId });
+	return {
+		apiClient,
+		environmentId: core.environmentId,
+		sessionToken
+	};
+};
+
+//#endregion
+//#region src/modules/flow/broadcastFlow/broadcastFlow.ts
+/**
+* Records that a flow transaction has been broadcasted.
+*
+* For wallet sources, pass the `txHash` from the on-chain transaction.
+* For exchange sources, `txHash` can be omitted — the user confirms
+* they completed the payment and the flow moves to `broadcasted`.
+*
+* @param params BroadcastFlowParams - The flow ID and optional tx hash.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The updated flow
+* @instrumented
+*/
+const broadcastFlow = async ({ flowId, txHash }, client = require_InvalidParamError.getDefaultClient()) => {
+	const { apiClient, environmentId, sessionToken } = await createFlowApiClient({ flowId }, client);
+	return withFlowSessionTokenCleanupOn401({
+		call: () => apiClient.broadcastFlow({
+			environmentId,
+			flowId,
+			flowRecordBroadcastRequest: { txHash },
+			xDynamicFlowSessionToken: sessionToken
+		}),
+		flowId
+	}, client);
+};
+const __broadcastFlow_impl = broadcastFlow;
+const __broadcastFlow_wrapped = require_InvalidParamError.instrumentFunction({
+	fn: __broadcastFlow_impl,
+	functionName: "broadcastFlow",
+	getCore: () => {
+		try {
+			return require_InvalidParamError.getCore(require_InvalidParamError.getDefaultClient());
+		} catch {
+			return;
+		}
+	}
+});
+
+//#endregion
+//#region src/modules/flow/cancelFlow/cancelFlow.ts
+/**
+* Cancels a flow before it has been broadcasted
+*
+* @param params CancelFlowParams - The flow to cancel.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The cancelled flow
+* @instrumented
+*/
+const cancelFlow = async ({ flowId }, client = require_InvalidParamError.getDefaultClient()) => {
+	const { apiClient, environmentId, sessionToken } = await createFlowApiClient({ flowId }, client);
+	const result = await withFlowSessionTokenCleanupOn401({
+		call: () => apiClient.cancelFlow({
+			environmentId,
+			flowId,
+			xDynamicFlowSessionToken: sessionToken
+		}),
+		flowId
+	}, client);
+	await clearFlowSessionToken({ flowId }, client);
+	return result;
+};
+const __cancelFlow_impl = cancelFlow;
+const __cancelFlow_wrapped = require_InvalidParamError.instrumentFunction({
+	fn: __cancelFlow_impl,
+	functionName: "cancelFlow",
+	getCore: () => {
+		try {
+			return require_InvalidParamError.getCore(require_InvalidParamError.getDefaultClient());
+		} catch {
+			return;
+		}
+	}
+});
+
 //#endregion
 //#region src/modules/flow/getFlow/getFlow.ts
 /**
@@ -3211,21 +3330,6 @@ const getFlow = async ({ flowId }, client = require_InvalidParamError.getDefault
 	});
 };
 
-//#endregion
-//#region src/modules/flow/utils/createFlowApiClient/createFlowApiClient.ts
-/** @not-instrumented */
-const createFlowApiClient = async ({ flowId }, client) => {
-	const core = require_InvalidParamError.getCore(client);
-	const apiClient = require_InvalidParamError.createApiClient({}, client);
-	const sessionToken = await core.storage.getItem(createFlowSessionTokenStorageKey(flowId));
-	if (!sessionToken) throw new FlowSessionTokenMissingError({ flowId });
-	return {
-		apiClient,
-		environmentId: core.environmentId,
-		sessionToken
-	};
-};
-
 //#endregion
 //#region src/modules/flow/getFlowQuote/getFlowQuote.ts
 /**
@@ -3293,6 +3397,52 @@ const __prepareFlowSigning_wrapped = require_InvalidParamError.instrumentFunctio
 	}
 });
 
+//#endregion
+//#region src/modules/flow/submitFlowTransaction/submitFlowTransaction.ts
+/**
+* Prepares, signs, and broadcasts a flow transaction in one call.
+*
+* Orchestrates the full submission flow:
+* 1. Calls prepareFlowSigning to advance to signing state and lock the quote
+* 2. Ensures the wallet is on the correct network for the transaction
+* 3. Delegates on-chain signing to the wallet provider's executeSwapTransaction method
+* 4. Calls broadcastFlow with the resulting txHash
+*
+* @param params SubmitFlowTransactionParams - The flow ID, wallet account, and optional step callback.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The broadcasted flow
+* @instrumented
+*/
+const submitFlowTransaction = async ({ onStepChange, flowId, walletAccount, assertBalanceForGasCost, assertBalanceForTransferAmount }, client = require_InvalidParamError.getDefaultClient()) => {
+	const signingPayload = (await __prepareFlowSigning_wrapped({
+		assertBalanceForGasCost,
+		assertBalanceForTransferAmount,
+		flowId
+	}, client)).quote?.signingPayload;
+	require_InvalidParamError.assertDefined(signingPayload, "No signing payload returned from prepare — quote may be missing transaction data");
+	const { transactionHash } = await __executeSwapTransaction_wrapped({
+		onStepChange,
+		signingPayload,
+		walletAccount
+	}, client);
+	return __broadcastFlow_wrapped({
+		flowId,
+		txHash: transactionHash
+	}, client);
+};
+const __submitFlowTransaction_impl = submitFlowTransaction;
+const __submitFlowTransaction_wrapped = require_InvalidParamError.instrumentFunction({
+	fn: __submitFlowTransaction_impl,
+	functionName: "submitFlowTransaction",
+	getCore: () => {
+		try {
+			return require_InvalidParamError.getCore(require_InvalidParamError.getDefaultClient());
+		} catch {
+			return;
+		}
+	}
+});
+
 //#endregion
 //#region src/modules/funding/coinbase/addCoinbaseOnrampOrderEventListener/addCoinbaseOnrampOrderEventListener.ts
 /**
@@ -3304,6 +3454,7 @@ const __prepareFlowSigning_wrapped = require_InvalidParamError.instrumentFunctio
 * @throws {ValueMustBeDefinedError} If the window is not available.
 * @docs https://docs.cdp.coinbase.com/onramp-&-offramp/onramp-apis/apple-pay-onramp-api#events-names
 * @not-instrumented
+* @hook Event listeners are error-prone to wire up by hand with useEffect.
 */
 const addCoinbaseOnrampOrderEventListener = ({ listener }, client = require_InvalidParamError.getDefaultClient()) => {
 	const core = require_InvalidParamError.getCore(client);
@@ -3688,6 +3839,7 @@ const __getMoonPayUrl_wrapped = require_InvalidParamError.instrumentFunction({
 *
 * @returns a promise that resolves once the client is fully initialized.
 * @not-instrumented
+* @noHook Client lifecycle management is not exposed as a hook; use useInitStatus.
 */
 const waitForClientInitialized = async (client = require_InvalidParamError.getDefaultClient()) => {
 	await require_InvalidParamError.getCore(client).initTrack.waitForAll();
@@ -4702,7 +4854,9 @@ const __setDefaultMfaDevice_wrapped = require_InvalidParamError.instrumentFuncti
 */
 const sendEmailOTP = async ({ email }, client = require_InvalidParamError.getDefaultClient()) => {
 	const core = require_InvalidParamError.getCore(client);
-	const { verificationUUID } = await require_InvalidParamError.createApiClient({}, client).createEmailVerification({
+	const apiClient = require_InvalidParamError.createApiClient({}, client);
+	require_preconnectWaasIframe.preconnectWaasIframe(client);
+	const { verificationUUID } = await apiClient.createEmailVerification({
 		emailVerificationCreateRequest: {
 			captchaToken: require_getNetworkProviderFromNetworkId.consumeCaptchaToken(client),
 			email
@@ -5665,6 +5819,7 @@ const sendSmsOTP = async ({ isoCountryCode, phoneNumber }, client = require_Inva
 	const core = require_InvalidParamError.getCore(client);
 	const apiClient = require_InvalidParamError.createApiClient({}, client);
 	const phoneCountryCode = supportedCountries[isoCountryCode].code;
+	require_preconnectWaasIframe.preconnectWaasIframe(client);
 	const { verificationUUID } = await apiClient.createSmsVerification({
 		environmentId: core.environmentId,
 		smsVerificationCreateRequest: {
@@ -5752,6 +5907,7 @@ const verifyOTPForUserUpdate = async ({ otpVerification, verificationToken, requ
 * @redact-params
 */
 const verifyOTP = async ({ otpVerification, verificationToken, requestedScopes }, client = require_InvalidParamError.getDefaultClient()) => {
+	require_preconnectWaasIframe.preconnectWaasIframe(client);
 	let response;
 	if (client.user) response = await verifyOTPForUserUpdate({
 		otpVerification,
@@ -7774,6 +7930,7 @@ const getNativeBalance = async ({ walletAccount }, client = require_InvalidParam
 * `getMultichainTokenBalances`).
 *
 * @not-instrumented
+* @noHook Deprecated; the replacement is exposed via its own hook.
 */
 const getBalance = (params, client = require_InvalidParamError.getDefaultClient()) => getNativeBalance(params, client);
 
@@ -7891,6 +8048,7 @@ const __switchActiveNetwork_wrapped = require_InvalidParamError.instrumentFuncti
 /**
 * Make the wallet account provided as the primary wallet account.
 * @instrumented
+* @noHook The primary-wallet concept is discouraged and not exposed as a hook.
 */
 const selectPrimaryWalletAccount = async ({ walletAccount }, client = require_InvalidParamError.getDefaultClient()) => {
 	const core = require_InvalidParamError.getCore(client);
@@ -8135,6 +8293,7 @@ const offWalletProviderEvent = ({ callback, event, walletProviderKey }, client =
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A function that can be called to remove the listener.
 * @not-instrumented
+* @hook Event listeners are error-prone to wire up by hand with useEffect.
 */
 const onWalletProviderEvent = ({ callback, event, walletProviderKey }, client = require_InvalidParamError.getDefaultClient()) => {
 	const walletProvider = require_getWalletProviderByKey.getWalletProviderByKey({ walletProviderKey }, client);
@@ -8288,7 +8447,7 @@ exports.NoNetworkProvidersError = require_getNetworkProviderFromNetworkId.NoNetw
 exports.NoPasskeyCredentialsFoundError = NoPasskeyCredentialsFoundError;
 exports.NoSmartWalletAccountSignerFoundError = NoSmartWalletAccountSignerFoundError;
 exports.NoWebAuthNSupportError = NoWebAuthNSupportError;
-exports.NotWaasWalletAccountError = require_NotWaasWalletAccountError.NotWaasWalletAccountError;
+exports.NotWaasWalletAccountError = require_isDynamicWaasEnabled.NotWaasWalletAccountError;
 exports.SandboxMaximumThresholdReachedError = require_InvalidParamError.SandboxMaximumThresholdReachedError;
 exports.SimulationFailedError = SimulationFailedError;
 exports.TokenSwapError = TokenSwapError;
@@ -8315,8 +8474,10 @@ exports.authenticatePasskeyMFA = authenticatePasskeyMFA;
 exports.authenticateTotpMfaDevice = authenticateTotpMfaDevice;
 exports.authenticateWithSocial = __authenticateWithSocial_wrapped;
 exports.broadcastCheckoutTransaction = __broadcastCheckoutTransaction_wrapped;
+exports.broadcastFlow = __broadcastFlow_wrapped;
 exports.canConnectWithHardwareWallet = canConnectWithHardwareWallet;
 exports.cancelCheckoutTransaction = __cancelCheckoutTransaction_wrapped;
+exports.cancelFlow = __cancelFlow_wrapped;
 exports.checkStepUpAuth = __checkStepUpAuth_wrapped;
 exports.completeDeviceRegistration = __completeDeviceRegistration_wrapped;
 exports.completeSocialAuthentication = __completeSocialAuthentication_wrapped;
@@ -8435,6 +8596,7 @@ exports.signInWithSocialPopUp = __signInWithSocialPopUp_wrapped;
 exports.signInWithSocialRedirect = __signInWithSocialRedirect_wrapped;
 exports.signMessage = __signMessage_wrapped;
 exports.submitCheckoutTransaction = __submitCheckoutTransaction_wrapped;
+exports.submitFlowTransaction = __submitFlowTransaction_wrapped;
 exports.supportedCountries = supportedCountries;
 exports.switchActiveNetwork = __switchActiveNetwork_wrapped;
 exports.trackCheckoutTransaction = trackCheckoutTransaction;