@dynamic-labs/sdk-react-core 4.67.0 → 4.67.2

package/src/lib/utils/constants/values.cjs

@@ -12,6 +12,7 @@ const DEFAULT_NUMBER_OF_WALLETS_TO_SHOW = 10;
 const ChainEnumToVerifiedCredentialName = {
     ALEO: 'aleo',
     ALGO: 'algorand',
+    APTOS: 'aptos',
     BTC: 'bip122', // see: https://namespaces.chainagnostic.org/bip122/caip2
     COSMOS: 'cosmos',
     ETH: 'eip155',
@@ -20,11 +21,14 @@ const ChainEnumToVerifiedCredentialName = {
     SOL: 'solana',
     STARK: 'starknet',
     STELLAR: 'stellar',
+    SUI: 'sui',
     TON: 'ton',
+    TRON: 'tron',
 };
 const VerifiedCredentialNameToChainEnum = {
     aleo: sdkApiCore.ChainEnum.Aleo,
     algorand: sdkApiCore.ChainEnum.Algo,
+    aptos: sdkApiCore.ChainEnum.Aptos,
     bip122: sdkApiCore.ChainEnum.Btc,
     cosmos: sdkApiCore.ChainEnum.Cosmos,
     eip155: sdkApiCore.ChainEnum.Evm,
@@ -34,6 +38,7 @@ const VerifiedCredentialNameToChainEnum = {
     stellar: sdkApiCore.ChainEnum.Stellar,
     sui: sdkApiCore.ChainEnum.Sui,
     ton: sdkApiCore.ChainEnum.Ton,
+    tron: sdkApiCore.ChainEnum.Tron,
 };
 
 exports.ChainEnumToVerifiedCredentialName = ChainEnumToVerifiedCredentialName;

package/src/lib/utils/constants/values.js

@@ -8,6 +8,7 @@ const DEFAULT_NUMBER_OF_WALLETS_TO_SHOW = 10;
 const ChainEnumToVerifiedCredentialName = {
     ALEO: 'aleo',
     ALGO: 'algorand',
+    APTOS: 'aptos',
     BTC: 'bip122', // see: https://namespaces.chainagnostic.org/bip122/caip2
     COSMOS: 'cosmos',
     ETH: 'eip155',
@@ -16,11 +17,14 @@ const ChainEnumToVerifiedCredentialName = {
     SOL: 'solana',
     STARK: 'starknet',
     STELLAR: 'stellar',
+    SUI: 'sui',
     TON: 'ton',
+    TRON: 'tron',
 };
 const VerifiedCredentialNameToChainEnum = {
     aleo: ChainEnum.Aleo,
     algorand: ChainEnum.Algo,
+    aptos: ChainEnum.Aptos,
     bip122: ChainEnum.Btc,
     cosmos: ChainEnum.Cosmos,
     eip155: ChainEnum.Evm,
@@ -30,6 +34,7 @@ const VerifiedCredentialNameToChainEnum = {
     stellar: ChainEnum.Stellar,
     sui: ChainEnum.Sui,
     ton: ChainEnum.Ton,
+    tron: ChainEnum.Tron,
 };
 
 export { ChainEnumToVerifiedCredentialName, DEFAULT_NUMBER_OF_WALLETS_TO_SHOW, VerifiedCredentialNameToChainEnum };

package/src/lib/utils/functions/compareChains/compareChains.cjs

@@ -5,13 +5,19 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 const synonyms = {
     aleo: 'ALEO',
+    algorand: 'ALGO',
+    aptos: 'APTOS',
     bip122: 'BTC',
     bitcoin: 'BTC',
+    cosmos: 'COSMOS',
     eip155: 'EVM',
+    flow: 'FLOW',
     solana: 'SOL',
+    starknet: 'STARK',
     stellar: 'STELLAR',
     sui: 'SUI',
     ton: 'TON',
+    tron: 'TRON',
 };
 for (const chain in synonyms)
     synonyms[synonyms[chain]] = chain;

package/src/lib/utils/functions/compareChains/compareChains.js

@@ -1,13 +1,19 @@
 'use client'
 const synonyms = {
     aleo: 'ALEO',
+    algorand: 'ALGO',
+    aptos: 'APTOS',
     bip122: 'BTC',
     bitcoin: 'BTC',
+    cosmos: 'COSMOS',
     eip155: 'EVM',
+    flow: 'FLOW',
     solana: 'SOL',
+    starknet: 'STARK',
     stellar: 'STELLAR',
     sui: 'SUI',
     ton: 'TON',
+    tron: 'TRON',
 };
 for (const chain in synonyms)
     synonyms[synonyms[chain]] = chain;

package/src/lib/utils/hooks/index.d.ts

@@ -109,4 +109,4 @@ export type { CheckWalletLockStateParams, UnlockWalletParams, UpdatePasswordPara
 export { usePromptWalletUnlock } from './usePromptWalletUnlock';
 export { useGetWalletPassword } from './useGetWalletPassword';
 export { useStepUpAuthentication } from './useStepUpAuthentication';
-export type { IsStepUpRequiredParams, StepUpAuthenticationState, UseStepUpAuthenticationParams, UseStepUpAuthenticationReturn, VerifyOtpParams, VerifyPasskeyMfaParams, VerifyTotpMfaParams, VerifyWalletParams, } from './useStepUpAuthentication';
+export type { IsStepUpRequiredParams, PromptMfaParams, StepUpAuthenticationState, UseStepUpAuthenticationParams, UseStepUpAuthenticationReturn, VerifyOtpParams, VerifyPasskeyMfaParams, VerifyRecoveryCodeParams, VerifyTotpMfaParams, VerifyWalletParams, } from './useStepUpAuthentication';

package/src/lib/utils/hooks/useAuthenticatePasskeyMFA/useAuthenticatePasskeyMFA.d.ts

@@ -1,7 +1,8 @@
-import { CreateMfaToken } from '@dynamic-labs/sdk-api-core';
+import { CreateMfaToken, TokenScope } from '@dynamic-labs/sdk-api-core';
 type UseAuthenticatePasskeyMFAProps = {
     createMfaToken?: CreateMfaToken;
     relatedOriginRpId?: string;
+    requestedScopes?: TokenScope[];
 };
 /**
  * Authenticate passkey for MFA

package/src/lib/utils/hooks/useMfa/useMfa.cjs

@@ -35,7 +35,7 @@ var useUserAuth = require('../useUserAuth/useUserAuth.cjs');
 
 const useMfa = () => {
     const { completeAuth } = useUserAuth.useUserAuth({});
-    const handleMfaAuth = React.useCallback((_a) => _tslib.__awaiter(void 0, [_a], void 0, function* ({ code, type, deviceId, createMfaToken, resultHandler, }) {
+    const handleMfaAuth = React.useCallback((_a) => _tslib.__awaiter(void 0, [_a], void 0, function* ({ code, type, deviceId, createMfaToken, requestedScopes, resultHandler, }) {
         let result;
         yield completeAuth({
             updateJwtFunction: () => _tslib.__awaiter(void 0, void 0, void 0, function* () {
@@ -46,6 +46,7 @@ const useMfa = () => {
                     code,
                     createMfaTokenOptions: createMfaToken,
                     deviceId,
+                    requestedScopes,
                 });
                 result = resultHandler(response);
                 return {
@@ -103,11 +104,12 @@ const useMfa = () => {
         });
         return isValid;
     }), [handleMfaAuth]);
-    const authenticateDevice = React.useCallback((_b) => _tslib.__awaiter(void 0, [_b], void 0, function* ({ code, type = sdkApiCore.MFADeviceType.Totp, deviceId, createMfaToken, }) {
+    const authenticateDevice = React.useCallback((_b) => _tslib.__awaiter(void 0, [_b], void 0, function* ({ code, type = sdkApiCore.MFADeviceType.Totp, deviceId, createMfaToken, requestedScopes, }) {
         return handleMfaAuth({
             code,
             createMfaToken,
             deviceId,
+            requestedScopes,
             resultHandler: (response) => response.mfaToken,
             type,
         });
@@ -140,13 +142,14 @@ const useMfa = () => {
         });
         return isValid;
     }), [completeAuth]);
-    const authenticateRecoveryCode = React.useCallback((_c) => _tslib.__awaiter(void 0, [_c], void 0, function* ({ code, createMfaToken, }) {
+    const authenticateRecoveryCode = React.useCallback((_c) => _tslib.__awaiter(void 0, [_c], void 0, function* ({ code, createMfaToken, requestedScopes, }) {
         let mfaToken = undefined;
         yield completeAuth({
             updateJwtFunction: () => _tslib.__awaiter(void 0, void 0, void 0, function* () {
                 const response = yield client.authenticateMfaRecoveryCode({
                     code,
                     createMfaTokenOptions: createMfaToken,
+                    requestedScopes,
                 });
                 if (!response) {
                     throw new Error('Failed to authenticate recovery code');

package/src/lib/utils/hooks/useMfa/useMfa.d.ts

@@ -1,4 +1,4 @@
-import { CreateMfaToken, MFADevice, MFADeviceType } from '@dynamic-labs/sdk-api-core';
+import { CreateMfaToken, MFADevice, MFADeviceType, TokenScope } from '@dynamic-labs/sdk-api-core';
 type UseMfaHookResult = {
     /**
      * Add a new device to the user's account.
@@ -22,19 +22,21 @@ type UseMfaHookResult = {
      * Authenticates a recovery code and returns a single use MFA token
      * if the authentication is successful and createMfaToken param is provided.
      */
-    authenticateRecoveryCode: ({ code, createMfaToken, }: {
+    authenticateRecoveryCode: ({ code, createMfaToken, requestedScopes, }: {
         code: string;
         createMfaToken?: CreateMfaToken;
+        requestedScopes?: TokenScope[];
     }) => Promise<string | undefined>;
     /**
      * Authenticates a device and returns a single use MFA token
      * if the authentication is successful and createMfaToken param is provided.
      */
-    authenticateDevice: ({ code, type, deviceId, createMfaToken, }: {
+    authenticateDevice: ({ code, type, deviceId, createMfaToken, requestedScopes, }: {
         code: string;
         type?: MFADeviceType;
         deviceId?: string;
         createMfaToken?: CreateMfaToken;
+        requestedScopes?: TokenScope[];
     }) => Promise<string | undefined>;
     completeAcknowledgement: () => Promise<void>;
     /**

package/src/lib/utils/hooks/useMfa/useMfa.js

@@ -31,7 +31,7 @@ import { useUserAuth } from '../useUserAuth/useUserAuth.js';
 
 const useMfa = () => {
     const { completeAuth } = useUserAuth({});
-    const handleMfaAuth = useCallback((_a) => __awaiter(void 0, [_a], void 0, function* ({ code, type, deviceId, createMfaToken, resultHandler, }) {
+    const handleMfaAuth = useCallback((_a) => __awaiter(void 0, [_a], void 0, function* ({ code, type, deviceId, createMfaToken, requestedScopes, resultHandler, }) {
         let result;
         yield completeAuth({
             updateJwtFunction: () => __awaiter(void 0, void 0, void 0, function* () {
@@ -42,6 +42,7 @@ const useMfa = () => {
                     code,
                     createMfaTokenOptions: createMfaToken,
                     deviceId,
+                    requestedScopes,
                 });
                 result = resultHandler(response);
                 return {
@@ -99,11 +100,12 @@ const useMfa = () => {
         });
         return isValid;
     }), [handleMfaAuth]);
-    const authenticateDevice = useCallback((_b) => __awaiter(void 0, [_b], void 0, function* ({ code, type = MFADeviceType.Totp, deviceId, createMfaToken, }) {
+    const authenticateDevice = useCallback((_b) => __awaiter(void 0, [_b], void 0, function* ({ code, type = MFADeviceType.Totp, deviceId, createMfaToken, requestedScopes, }) {
         return handleMfaAuth({
             code,
             createMfaToken,
             deviceId,
+            requestedScopes,
             resultHandler: (response) => response.mfaToken,
             type,
         });
@@ -136,13 +138,14 @@ const useMfa = () => {
         });
         return isValid;
     }), [completeAuth]);
-    const authenticateRecoveryCode = useCallback((_c) => __awaiter(void 0, [_c], void 0, function* ({ code, createMfaToken, }) {
+    const authenticateRecoveryCode = useCallback((_c) => __awaiter(void 0, [_c], void 0, function* ({ code, createMfaToken, requestedScopes, }) {
         let mfaToken = undefined;
         yield completeAuth({
             updateJwtFunction: () => __awaiter(void 0, void 0, void 0, function* () {
                 const response = yield authenticateMfaRecoveryCode({
                     code,
                     createMfaTokenOptions: createMfaToken,
+                    requestedScopes,
                 });
                 if (!response) {
                     throw new Error('Failed to authenticate recovery code');

package/src/lib/utils/hooks/usePromptMfaAuth/usePromptMfaAuth.cjs

@@ -3,193 +3,22 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var _tslib = require('../../../../../_virtual/_tslib.cjs');
-var React = require('react');
-var client$1 = require('@dynamic-labs-sdk/client');
-var sdkApiCore = require('@dynamic-labs/sdk-api-core');
-var utils = require('@dynamic-labs/utils');
-var useGetUserMfaMethods = require('../useGetUserMfaMethods/useGetUserMfaMethods.cjs');
-var ViewContext = require('../../../context/ViewContext/ViewContext.cjs');
-require('../../../context/DynamicContext/DynamicContext.cjs');
-require('../../../store/state/loadingAndLifecycle/loadingAndLifecycle.cjs');
-require('@dynamic-labs/iconic');
-require('@dynamic-labs/wallet-connector-core');
-require('react/jsx-runtime');
-require('../../../shared/logger.cjs');
-require('@dynamic-labs/wallet-book');
-require('../../constants/colors.cjs');
-require('../../constants/values.cjs');
-require('../../../shared/consts/index.cjs');
-var dynamicEvents = require('../../../events/dynamicEvents.cjs');
-require('../../../context/CaptchaContext/CaptchaContext.cjs');
-require('../../../context/ErrorContext/ErrorContext.cjs');
-require('@dynamic-labs/multi-wallet');
-require('react-international-phone');
-require('../../../store/state/nonce/nonce.cjs');
-require('@dynamic-labs-sdk/client/core');
-var client = require('../../../client/client.cjs');
-require('../../../config/ApiEndpoint.cjs');
-require('@dynamic-labs/locale');
-require('../../../store/state/dynamicContextProps/dynamicContextProps.cjs');
-require('../../../store/state/primaryWalletId/primaryWalletId.cjs');
-require('../../../store/state/connectedWalletsInfo/connectedWalletsInfo.cjs');
-require('../../functions/getWaasAddressTypeLabel/getWaasAddressTypeLabel.cjs');
-require('../../../context/AccessDeniedContext/AccessDeniedContext.cjs');
-require('../../../context/AccountExistsContext/AccountExistsContext.cjs');
-require('../../../context/UserWalletsContext/UserWalletsContext.cjs');
-require('../../../store/state/authMode/authMode.cjs');
-require('../../../context/VerificationContext/VerificationContext.cjs');
-require('react-dom');
-require('../../functions/compareChains/compareChains.cjs');
-require('../../../views/Passkey/utils/findPrimaryEmbeddedChain/findPrimaryEmbeddedChain.cjs');
-require('../../../context/ThemeContext/ThemeContext.cjs');
-require('../useUserUpdateRequest/useUpdateUser/userFieldsSchema.cjs');
-require('bs58');
-require('@dynamic-labs/types');
-require('../../../context/SocialRedirectContext/SocialRedirectContext.cjs');
-require('../../../context/LoadingContext/LoadingContext.cjs');
-require('../../../context/WalletContext/WalletContext.cjs');
-require('../useEmbeddedWallet/useSecureEnclaveEmbeddedWallet/constants.cjs');
-require('yup');
-require('../../../context/MockContext/MockContext.cjs');
-require('../../../views/CollectUserDataView/useFields.cjs');
-require('../../../context/FieldsStateContext/FieldsStateContext.cjs');
-require('../../../context/UserFieldEditorContext/UserFieldEditorContext.cjs');
-require('@dynamic-labs/rpc-providers');
-require('../../../store/state/walletOptions/walletOptions.cjs');
-require('react-i18next');
-require('../../../components/Accordion/components/AccordionItem/AccordionItem.cjs');
-require('../../../components/Alert/Alert.cjs');
-require('../../../components/ShadowDOM/ShadowDOM.cjs');
-require('../../../components/IconButton/IconButton.cjs');
-require('../../../components/InlineWidget/InlineWidget.cjs');
-require('../../../components/Input/Input.cjs');
-require('../../../components/IsBrowser/IsBrowser.cjs');
-require('../../../components/MenuList/Dropdown/Dropdown.cjs');
-require('../../../components/OverlayCard/OverlayCard.cjs');
-require('../../../components/Transition/ZoomTransition/ZoomTransition.cjs');
-require('../../../components/Transition/SlideInUpTransition/SlideInUpTransition.cjs');
-require('../../../components/Transition/OpacityTransition/OpacityTransition.cjs');
-require('../../../components/PasskeyCreatedSuccessBanner/PasskeyCreatedSuccessBanner.cjs');
-require('../../../components/Popper/Popper/Popper.cjs');
-require('../../../components/Popper/PopperContext/PopperContext.cjs');
-require('react-focus-lock');
-require('qrcode');
-require('formik');
-require('../useSubdomainCheck/useSubdomainCheck.cjs');
-require('../../../context/WalletGroupContext/WalletGroupContext.cjs');
-require('../../../widgets/DynamicWidget/context/DynamicWidgetContext.cjs');
-require('../useWalletBackup/useWalletBackup.cjs');
-require('../useWalletBackup/types.cjs');
-require('../useWalletBackup/cloudProviders.cjs');
-require('../../../context/IpConfigurationContext/IpConfigurationContext.cjs');
-require('../../../context/ConnectWithOtpContext/ConnectWithOtpContext.cjs');
-require('../../../widgets/DynamicBridgeWidget/views/WalletsView/components/SecondaryWallets/SecondaryWallets.cjs');
-require('@hcaptcha/react-hcaptcha');
-require('../../../widgets/DynamicWidget/helpers/convertExchangeKeyAndProviderEnum.cjs');
-require('../../../views/ExchangeWhitelistWarning/ExchangeWhitelistWarning.cjs');
-require('../../../context/ErrorContext/hooks/useErrorText/useErrorText.cjs');
-require('../../../context/FooterAnimationContext/index.cjs');
-require('../../../views/MfaChooseDeviceView/useGetMfaOptions/useGetMfaOptions.cjs');
-require('../../../context/PasskeyContext/PasskeyContext.cjs');
-require('../../../context/OnrampContext/OnrampContext.cjs');
-require('../../../store/state/sendBalances.cjs');
-require('../../../store/state/connectorsInitializing/connectorsInitializing.cjs');
-require('../../../components/OverlayCardBase/OverlayCardTarget/OverlayCardTarget.cjs');
-require('../../../widgets/DynamicWidget/components/DynamicWidgetHeader/DynamicWidgetHeader.cjs');
-require('../../../views/TransactionConfirmationView/TransactionConfirmationView.cjs');
-require('../../../widgets/DynamicWidget/components/PasskeyCard/PasskeyCard.cjs');
-require('../../../widgets/DynamicWidget/views/CryptoComOnramp/CryptoComOnramp.cjs');
-require('../../../../index.cjs');
-require('../../../widgets/DynamicWidget/views/ReceiveWalletFunds/ReceiveWalletFunds.cjs');
-require('../../../store/state/tokenBalances.cjs');
-require('../../../store/state/multichainBalances.cjs');
-var useAuthenticatePasskeyMFA = require('../useAuthenticatePasskeyMFA/useAuthenticatePasskeyMFA.cjs');
-require('../../../shared/utils/functions/getInitialUrl/getInitialUrl.cjs');
-var useInternalDynamicContext = require('../../../context/DynamicContext/useDynamicContext/useInternalDynamicContext/useInternalDynamicContext.cjs');
+var useStepUpAuthentication = require('../useStepUpAuthentication/useStepUpAuthentication.cjs');
 
+/**
+ * Opens the Dynamic MFA modal (passkey or TOTP) and resolves when the user completes MFA.
+ *
+ * @deprecated Use `useStepUpAuthentication().promptMfa()` instead. Step-up authentication
+ * is the generic category; MFA is one verification method. The `promptMfa` method on
+ * `useStepUpAuthentication` provides the same behavior. This hook will be removed in the
+ * next major version.
+ *
+ * @returns A function that opens the MFA flow and returns a promise resolving to the
+ *   MFA token (or `undefined` when using `requestedScopes` — use `getElevatedAccessToken({ scope })` after completion).
+ */
 const usePromptMfaAuth = () => {
-    const { setShowAuthFlow } = useInternalDynamicContext.useInternalDynamicContext();
-    const { pushView } = ViewContext.useViewContext();
-    const getUserMfaMethods = useGetUserMfaMethods.useGetUserMfaMethods();
-    const authenticatePasskeyMFA = useAuthenticatePasskeyMFA.useAuthenticatePasskeyMFA();
-    const dynamicClient = client.useDynamicClient();
-    const promptMfaAuth = React.useCallback((props) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
-        const methods = yield getUserMfaMethods();
-        const allMethods = [
-            ...methods.passkeys.map((passkey) => (Object.assign(Object.assign({}, passkey), { type: sdkApiCore.MFADeviceType.Passkey }))),
-            ...methods.devices.map((device) => (Object.assign(Object.assign({}, device), { type: sdkApiCore.MFADeviceType.Totp }))),
-        ];
-        if (!methods.userHasVerifiedMfaMethods || allMethods.length === 0) {
-            setShowAuthFlow(true);
-            pushView('mfa-choose-device', {
-                createMfaToken: props === null || props === void 0 ? void 0 : props.createMfaToken,
-            });
-            return;
-        }
-        const lastCreatedMethod = allMethods.reduce((a, b) => {
-            if (a.createdAt && b.createdAt) {
-                return a.createdAt >= b.createdAt ? a : b;
-            }
-            if (b.createdAt) {
-                return b;
-            }
-            return a;
-        });
-        switch (lastCreatedMethod.type) {
-            case sdkApiCore.MFADeviceType.Passkey: {
-                const createMfaTokenOptions = (props === null || props === void 0 ? void 0 : props.createMfaToken)
-                    ? { singleUse: true }
-                    : undefined;
-                // we're calling authenticatePasskeyMFA here because we don't want
-                // it to be called twice by the usePromise in the confirmPasskey view
-                const authenticatePasskeyPromise = authenticatePasskeyMFA({
-                    createMfaToken: createMfaTokenOptions,
-                });
-                setShowAuthFlow(true);
-                pushView('passkey-confirm', {
-                    authenticatePasskeyPromise,
-                    createMfaToken: props === null || props === void 0 ? void 0 : props.createMfaToken,
-                });
-                // Return the promise so callers can await MFA completion
-                return authenticatePasskeyPromise;
-            }
-            case sdkApiCore.MFADeviceType.Totp: {
-                if (dynamicClient === null || dynamicClient === void 0 ? void 0 : dynamicClient.mfaToken) {
-                    return dynamicClient === null || dynamicClient === void 0 ? void 0 : dynamicClient.mfaToken;
-                }
-                // If the mfaToken is not present, we need to open the MFA UI and wait for it to be available
-                const deferred = new utils.DeferredPromise();
-                // Open the MFA UI if the mfaToken is not available yet
-                setShowAuthFlow(true);
-                pushView('mfa-verification', {
-                    createMfaToken: props === null || props === void 0 ? void 0 : props.createMfaToken,
-                });
-                const mfaCompletionSuccessOff = client$1.onEvent({
-                    event: 'mfaCompletionSuccess',
-                    listener: ({ mfaToken }) => deferred.resolve(mfaToken),
-                }, dynamicClient);
-                // Reject the promise if the auth flow is closed
-                const onAuthFlowCloseHandler = () => deferred.reject(new Error('MFA view closed'));
-                dynamicEvents.dynamicEvents.on('authFlowClose', onAuthFlowCloseHandler);
-                // Cleanup the event listeners
-                deferred.promise.finally(() => {
-                    mfaCompletionSuccessOff();
-                    dynamicEvents.dynamicEvents.off('authFlowClose', onAuthFlowCloseHandler);
-                });
-                return deferred.promise;
-            }
-            default:
-                throw new Error('Error determining MFA method to use');
-        }
-    }), [
-        authenticatePasskeyMFA,
-        dynamicClient,
-        getUserMfaMethods,
-        pushView,
-        setShowAuthFlow,
-    ]);
-    return promptMfaAuth;
+    const { promptMfa } = useStepUpAuthentication.useStepUpAuthentication();
+    return promptMfa;
 };
 
 exports.usePromptMfaAuth = usePromptMfaAuth;

package/src/lib/utils/hooks/usePromptMfaAuth/usePromptMfaAuth.d.ts

@@ -1,5 +1,17 @@
-type PromptMfaAuthProps = {
+import { TokenScope } from '@dynamic-labs/sdk-api-core';
+export type PromptMfaAuthProps = {
     createMfaToken?: boolean;
+    requestedScopes?: TokenScope[];
 };
-export declare const usePromptMfaAuth: () => (props?: PromptMfaAuthProps) => Promise<string | undefined>;
-export {};
+/**
+ * Opens the Dynamic MFA modal (passkey or TOTP) and resolves when the user completes MFA.
+ *
+ * @deprecated Use `useStepUpAuthentication().promptMfa()` instead. Step-up authentication
+ * is the generic category; MFA is one verification method. The `promptMfa` method on
+ * `useStepUpAuthentication` provides the same behavior. This hook will be removed in the
+ * next major version.
+ *
+ * @returns A function that opens the MFA flow and returns a promise resolving to the
+ *   MFA token (or `undefined` when using `requestedScopes` — use `getElevatedAccessToken({ scope })` after completion).
+ */
+export declare const usePromptMfaAuth: () => (props?: import("../useStepUpAuthentication").PromptMfaParams | undefined) => Promise<string | undefined>;