@dynamic-labs/sdk-react-core 4.79.2 → 4.81.0

package/src/lib/context/DynamicContext/DynamicContext.js

@@ -370,7 +370,7 @@ const InnerDynamicContextProvider = (props) => {
             }
         });
     };
-    const handleLogOut = useHandleLogout({
+    const { handleLogOut, handleLogOutWithReason } = useHandleLogout({
         bridgeChains,
         clearAllWalletConnectSessions,
         connectedWallets,
@@ -392,7 +392,7 @@ const InnerDynamicContextProvider = (props) => {
     });
     useValidateSession({
         environmentId,
-        handleLogOut,
+        handleLogOutWithReason,
     });
     // For some reason, calling useNonce in useGlobalLoading causes errors
     const nonce = useNonce();
@@ -418,7 +418,7 @@ const InnerDynamicContextProvider = (props) => {
     // Listen for wallet deep link returns and emit events (mobile only)
     useWalletReturnRoute();
     const removeWallet = useRemoveWallet({
-        handleLogOut,
+        handleLogOutWithReason,
         secondaryWallets,
         setPrimaryWallet,
     });
@@ -433,7 +433,7 @@ const InnerDynamicContextProvider = (props) => {
     useWalletEventListeners({
         detectNewWalletsForLinking,
         disconnectWallet,
-        handleLogOut,
+        handleLogOutWithReason,
         multiWallet,
         multiWalletWidgetState,
         primaryWallet,
@@ -534,6 +534,7 @@ const InnerDynamicContextProvider = (props) => {
             getConnectedWalletById,
             getNameService,
             handleLogOut,
+            handleLogOutWithReason,
             handlers,
             i18nSDKInstance,
             isBridgeFlow,
@@ -649,6 +650,7 @@ const InnerDynamicContextProvider = (props) => {
         getConnectedWalletById,
         getNameService,
         handleLogOut,
+        handleLogOutWithReason,
         removeWallet,
         handlers,
         i18nSDKInstance,

package/src/lib/context/DynamicContext/hooks/useHandleLogout/index.d.ts

@@ -1 +1,2 @@
 export * from './useHandleLogout';
+export type { SdkLogoutReason } from './types';

package/src/lib/context/DynamicContext/hooks/useHandleLogout/types.d.ts

@@ -1,4 +1,5 @@
 import { Dispatch, SetStateAction } from 'react';
+import { LogoutReason } from '@dynamic-labs-sdk/client';
 import { AuthMode, UserProfile } from '@dynamic-labs/types';
 import { WalletConnector } from '@dynamic-labs/wallet-connector-core';
 import { DynamicEventsCallbacks, Wallet } from '../../../../shared';
@@ -6,6 +7,14 @@ import { MultiWalletWidgetStateSetter } from '../../../../utils/hooks/multiWalle
 import { ChainsToConnect } from '../../types';
 import { SetShowAuthFlow } from '../useShowAuthFlow';
 import { SetSelectedWalletConnectorKey } from '../useSelectedWalletConnector/SetSelectedWalletConnectorKey.type';
+/**
+ * Diagnostic reason tag for a logout. Widens the official LogoutReason union
+ * from @dynamic-labs-sdk/client with SDK-invented strings so each internal
+ * logout call site can be attributed in Datadog. Cast to LogoutReason at the
+ * boundary inside handleLogOutWithReason (the client SDK forwards unknown
+ * strings through to Datadog as-is).
+ */
+export type SdkLogoutReason = LogoutReason | 'auth-cancelled' | 'last-wallet-removed' | 'network-unsupported' | 'wallet-info-out-of-sync' | 'token-expired-validate-session' | 'embedded-wallet-session-key-invalid' | 'storage-parse-failure' | 'mfa-verification-cancelled' | 'mfa-choose-device-cancelled' | 'mfa-secure-device-cancelled' | 'backup-unsuccessful' | 'user-data-collection-cancelled' | 'store-environment-mismatch' | 'primary-wallet-disconnected';
 export type UseHandleLogoutParams = {
     clearAllWalletConnectSessions: () => void;
     bridgeChains: ChainsToConnect[] | undefined;

package/src/lib/context/DynamicContext/hooks/useHandleLogout/useHandleLogout.cjs

@@ -5,7 +5,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var _tslib = require('../../../../../../_virtual/_tslib.cjs');
 var React = require('react');
-var client = require('@dynamic-labs-sdk/client');
+var client$1 = require('@dynamic-labs-sdk/client');
+var core = require('@dynamic-labs-sdk/client/core');
 var utils = require('@dynamic-labs/utils');
 require('@dynamic-labs/iconic');
 require('@dynamic-labs/wallet-connector-core');
@@ -29,8 +30,7 @@ require('../../../ErrorContext/ErrorContext.cjs');
 require('@dynamic-labs/multi-wallet');
 require('react-international-phone');
 require('../../../../store/state/nonce/nonce.cjs');
-require('@dynamic-labs-sdk/client/core');
-require('eventemitter3');
+var client = require('../../../../client/client.cjs');
 require('../../../../config/ApiEndpoint.cjs');
 require('../../../../events/dynamicEvents.cjs');
 require('@dynamic-labs/locale');
@@ -111,6 +111,8 @@ require('../../../../store/state/multichainBalances.cjs');
 require('@dynamic-labs/store');
 require('../../../../shared/utils/functions/getInitialUrl/getInitialUrl.cjs');
 
+const PUBLIC_LOGOUT_REASON = 'user-intent';
+const STORAGE_PARSE_FAILURE_REASON = 'storage-parse-failure';
 const useHandleLogout = (params) => {
     const paramsRef = React.useRef(params);
     paramsRef.current = params;
@@ -124,8 +126,9 @@ const useHandleLogout = (params) => {
         ];
         logger.logger.logVerboseTroubleshootingMessage('useHandleLogout called', {
             params: paramsRef.current,
+            reason,
         });
-        utils.tracing.logEvent('logout', 'useHandleLogout called');
+        utils.tracing.logEvent('logout', `useHandleLogout called (reason=${reason})`);
         p.setSelectedWalletConnectorKey(null);
         p.clearAllWalletConnectSessions();
         p.setShowDynamicUserProfile(false);
@@ -149,13 +152,23 @@ const useHandleLogout = (params) => {
         primaryWalletId.resetPrimaryWalletId();
         p.removeConnectedNameService();
         p.removeSessionStorageSessionKeys();
-        yield Promise.all(activeConnectors.map((connector) => connector.endSession(reason)));
+        yield Promise.all(
+        // Narrow to the client-SDK LogoutReason at the connector boundary. SDK-invented
+        // reasons flow through untyped; connectors ignore values they don't recognize.
+        activeConnectors.map((connector) => connector.endSession(reason)));
     }), []);
-    const logout = React.useCallback((reason) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
-        yield client.logout();
+    const handleLogOutWithReason = React.useCallback((reason) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
+        if (typeof reason !== 'string') {
+            throw new Error('Invalid reason');
+        }
+        // Cast to LogoutReason here — this is the one place unsound widening meets
+        // the client SDK's narrow union. The client SDK forwards the string to
+        // Datadog as-is; unknown values are logged, not parsed.
+        yield core.logoutWithReason({ reason: reason }, client.getDynamicClient());
         yield logoutReactSdk(reason);
     }), [logoutReactSdk]);
-    React.useEffect(() => client.onEvent({
+    const handleLogOut = React.useCallback(() => handleLogOutWithReason(PUBLIC_LOGOUT_REASON), [handleLogOutWithReason]);
+    React.useEffect(() => client$1.onEvent({
         event: 'logout',
         listener: (metadata) => {
             logoutReactSdk(metadata === null || metadata === void 0 ? void 0 : metadata.reason);
@@ -163,15 +176,15 @@ const useHandleLogout = (params) => {
     }), [logoutReactSdk]);
     /** Trigger a logout when the SDK failed to load data from storage */
     React.useEffect(() => {
-        const handler = () => logout();
+        const handler = () => handleLogOutWithReason(STORAGE_PARSE_FAILURE_REASON);
         utils.StorageService.events.on('parseFailure', handler);
         return () => {
             utils.StorageService.events.off('parseFailure', handler);
         };
-    }, [logout]);
+    }, [handleLogOutWithReason]);
     /** Allows triggering a logout from anywhere in the code */
-    useDynamicEvents.useInternalDynamicEvents('triggerLogout', () => logout());
-    return logout;
+    useDynamicEvents.useInternalDynamicEvents('triggerLogout', (reason) => handleLogOutWithReason(reason));
+    return { handleLogOut, handleLogOutWithReason };
 };
 
 exports.useHandleLogout = useHandleLogout;

package/src/lib/context/DynamicContext/hooks/useHandleLogout/useHandleLogout.d.ts

@@ -1,3 +1,5 @@
-import { LogoutReason } from '@dynamic-labs-sdk/client';
-import { UseHandleLogoutParams } from './types';
-export declare const useHandleLogout: (params: UseHandleLogoutParams) => (reason?: LogoutReason) => Promise<void>;
+import { SdkLogoutReason, UseHandleLogoutParams } from './types';
+export declare const useHandleLogout: (params: UseHandleLogoutParams) => {
+    handleLogOut: () => Promise<void>;
+    handleLogOutWithReason: (reason: SdkLogoutReason) => Promise<void>;
+};

package/src/lib/context/DynamicContext/hooks/useHandleLogout/useHandleLogout.js

@@ -1,7 +1,8 @@
 'use client'
 import { __awaiter } from '../../../../../../_virtual/_tslib.js';
 import { useRef, useCallback, useEffect } from 'react';
-import { logout, onEvent } from '@dynamic-labs-sdk/client';
+import { onEvent } from '@dynamic-labs-sdk/client';
+import { logoutWithReason } from '@dynamic-labs-sdk/client/core';
 import { tracing, StorageService } from '@dynamic-labs/utils';
 import '@dynamic-labs/iconic';
 import '@dynamic-labs/wallet-connector-core';
@@ -25,8 +26,7 @@ import '../../../ErrorContext/ErrorContext.js';
 import '@dynamic-labs/multi-wallet';
 import 'react-international-phone';
 import '../../../../store/state/nonce/nonce.js';
-import '@dynamic-labs-sdk/client/core';
-import 'eventemitter3';
+import { getDynamicClient } from '../../../../client/client.js';
 import '../../../../config/ApiEndpoint.js';
 import '../../../../events/dynamicEvents.js';
 import '@dynamic-labs/locale';
@@ -107,6 +107,8 @@ import '../../../../store/state/multichainBalances.js';
 import '@dynamic-labs/store';
 import '../../../../shared/utils/functions/getInitialUrl/getInitialUrl.js';
 
+const PUBLIC_LOGOUT_REASON = 'user-intent';
+const STORAGE_PARSE_FAILURE_REASON = 'storage-parse-failure';
 const useHandleLogout = (params) => {
     const paramsRef = useRef(params);
     paramsRef.current = params;
@@ -120,8 +122,9 @@ const useHandleLogout = (params) => {
         ];
         logger.logVerboseTroubleshootingMessage('useHandleLogout called', {
             params: paramsRef.current,
+            reason,
         });
-        tracing.logEvent('logout', 'useHandleLogout called');
+        tracing.logEvent('logout', `useHandleLogout called (reason=${reason})`);
         p.setSelectedWalletConnectorKey(null);
         p.clearAllWalletConnectSessions();
         p.setShowDynamicUserProfile(false);
@@ -145,12 +148,22 @@ const useHandleLogout = (params) => {
         resetPrimaryWalletId();
         p.removeConnectedNameService();
         p.removeSessionStorageSessionKeys();
-        yield Promise.all(activeConnectors.map((connector) => connector.endSession(reason)));
+        yield Promise.all(
+        // Narrow to the client-SDK LogoutReason at the connector boundary. SDK-invented
+        // reasons flow through untyped; connectors ignore values they don't recognize.
+        activeConnectors.map((connector) => connector.endSession(reason)));
     }), []);
-    const logout$1 = useCallback((reason) => __awaiter(void 0, void 0, void 0, function* () {
-        yield logout();
+    const handleLogOutWithReason = useCallback((reason) => __awaiter(void 0, void 0, void 0, function* () {
+        if (typeof reason !== 'string') {
+            throw new Error('Invalid reason');
+        }
+        // Cast to LogoutReason here — this is the one place unsound widening meets
+        // the client SDK's narrow union. The client SDK forwards the string to
+        // Datadog as-is; unknown values are logged, not parsed.
+        yield logoutWithReason({ reason: reason }, getDynamicClient());
         yield logoutReactSdk(reason);
     }), [logoutReactSdk]);
+    const handleLogOut = useCallback(() => handleLogOutWithReason(PUBLIC_LOGOUT_REASON), [handleLogOutWithReason]);
     useEffect(() => onEvent({
         event: 'logout',
         listener: (metadata) => {
@@ -159,15 +172,15 @@ const useHandleLogout = (params) => {
     }), [logoutReactSdk]);
     /** Trigger a logout when the SDK failed to load data from storage */
     useEffect(() => {
-        const handler = () => logout$1();
+        const handler = () => handleLogOutWithReason(STORAGE_PARSE_FAILURE_REASON);
         StorageService.events.on('parseFailure', handler);
         return () => {
             StorageService.events.off('parseFailure', handler);
         };
-    }, [logout$1]);
+    }, [handleLogOutWithReason]);
     /** Allows triggering a logout from anywhere in the code */
-    useInternalDynamicEvents('triggerLogout', () => logout$1());
-    return logout$1;
+    useInternalDynamicEvents('triggerLogout', (reason) => handleLogOutWithReason(reason));
+    return { handleLogOut, handleLogOutWithReason };
 };
 
 export { useHandleLogout };

package/src/lib/context/DynamicContext/hooks/useRemoveWallet/useRemoveWallet.cjs

@@ -33,7 +33,7 @@ var wallets = require('../../../../data/api/wallets/wallets.cjs');
 var authMode = require('../../../../store/state/authMode/authMode.cjs');
 var UserWalletsContext = require('../../../UserWalletsContext/UserWalletsContext.cjs');
 
-const useRemoveWallet = ({ secondaryWallets, handleLogOut, setPrimaryWallet, }) => {
+const useRemoveWallet = ({ secondaryWallets, handleLogOutWithReason, setPrimaryWallet, }) => {
     const { removedWalletsIds, userWallets } = UserWalletsContext.useInternalUserWallets();
     const connectedWalletsInfo$1 = connectedWalletsInfo.useConnectedWalletsInfo();
     const nextWalletId = React.useMemo(() => (secondaryWallets[0] ? secondaryWallets[0].id : undefined), [secondaryWallets]);
@@ -74,7 +74,7 @@ const useRemoveWallet = ({ secondaryWallets, handleLogOut, setPrimaryWallet, })
         }
         // If there are no wallets left and no user (connect-only), we need to log out
         if (!user && !nextWalletId) {
-            handleLogOut();
+            yield handleLogOutWithReason('last-wallet-removed');
             return;
         }
         const numberOfWalletsWithSameConnector = userWallets.filter(({ connector }) => connector.key === wallet.connector.key).length;
@@ -88,7 +88,7 @@ const useRemoveWallet = ({ secondaryWallets, handleLogOut, setPrimaryWallet, })
         nextWalletId,
         removedWalletsIds,
         setPrimaryWallet,
-        handleLogOut,
+        handleLogOutWithReason,
     ]);
     return callback;
 };

package/src/lib/context/DynamicContext/hooks/useRemoveWallet/useRemoveWallet.d.ts

@@ -1,7 +1,8 @@
 import { Wallet } from '../../../../shared/types/wallets';
+import { SdkLogoutReason } from '../useHandleLogout';
 export type UseRemoveWalletProps = {
     secondaryWallets: Wallet[];
-    handleLogOut: () => void;
+    handleLogOutWithReason: (reason: SdkLogoutReason) => Promise<void>;
     setPrimaryWallet: (walletId: string) => void;
 };
-export declare const useRemoveWallet: ({ secondaryWallets, handleLogOut, setPrimaryWallet, }: UseRemoveWalletProps) => (walletId: string, clearStackAndPushInitialView?: () => void) => Promise<void>;
+export declare const useRemoveWallet: ({ secondaryWallets, handleLogOutWithReason, setPrimaryWallet, }: UseRemoveWalletProps) => (walletId: string, clearStackAndPushInitialView?: () => void) => Promise<void>;

package/src/lib/context/DynamicContext/hooks/useRemoveWallet/useRemoveWallet.js

@@ -29,7 +29,7 @@ import { unlinkWallet } from '../../../../data/api/wallets/wallets.js';
 import { getAuthMode } from '../../../../store/state/authMode/authMode.js';
 import { useInternalUserWallets } from '../../../UserWalletsContext/UserWalletsContext.js';
 
-const useRemoveWallet = ({ secondaryWallets, handleLogOut, setPrimaryWallet, }) => {
+const useRemoveWallet = ({ secondaryWallets, handleLogOutWithReason, setPrimaryWallet, }) => {
     const { removedWalletsIds, userWallets } = useInternalUserWallets();
     const connectedWalletsInfo = useConnectedWalletsInfo();
     const nextWalletId = useMemo(() => (secondaryWallets[0] ? secondaryWallets[0].id : undefined), [secondaryWallets]);
@@ -70,7 +70,7 @@ const useRemoveWallet = ({ secondaryWallets, handleLogOut, setPrimaryWallet, })
         }
         // If there are no wallets left and no user (connect-only), we need to log out
         if (!user && !nextWalletId) {
-            handleLogOut();
+            yield handleLogOutWithReason('last-wallet-removed');
             return;
         }
         const numberOfWalletsWithSameConnector = userWallets.filter(({ connector }) => connector.key === wallet.connector.key).length;
@@ -84,7 +84,7 @@ const useRemoveWallet = ({ secondaryWallets, handleLogOut, setPrimaryWallet, })
         nextWalletId,
         removedWalletsIds,
         setPrimaryWallet,
-        handleLogOut,
+        handleLogOutWithReason,
     ]);
     return callback;
 };

package/src/lib/context/DynamicContext/types/IDynamicContext.d.ts

@@ -13,6 +13,7 @@ import { ConnectWalletOptions } from '../../../utils/hooks/useConnectWallet/useC
 import { ThemeData, ThemeSetting } from '../../ThemeContext';
 import { DisplayOrder, SetDisplayOrderPriority, SetShowAuthFlow } from '../hooks';
 import { SetCallbackType } from '../useCustomerCallbacks';
+import { SdkLogoutReason } from '../hooks/useHandleLogout/types';
 import { SetSelectedWalletConnectorKey } from '../hooks/useSelectedWalletConnector/SetSelectedWalletConnectorKey.type';
 import { SettingsOverrides } from './SettingsOverrides';
 import { SocialSettings } from './SocialSettings';
@@ -64,6 +65,7 @@ export interface IDynamicContext {
     getConnectedWalletById: (walletId: string) => Wallet | undefined;
     getNameService: (address?: string) => Promise<NameServiceData | undefined>;
     handleLogOut: () => Promise<void>;
+    handleLogOutWithReason: (reason: SdkLogoutReason) => Promise<void>;
     removeWallet: (walletId: string, clearStackAndPushInitialView?: () => void) => Promise<void>;
     handlers?: DynamicHandlers;
     isBridgeFlow: boolean;

package/src/lib/context/DynamicContext/types/IInternalDynamicContext.d.ts

@@ -1,9 +1,16 @@
+import { SdkLogoutReason } from '../hooks/useHandleLogout';
 import { IDynamicContext } from './IDynamicContext';
 /**
  * Allows deprecating specific methods that we should avoid using internally
  * without deprecating them publicly as well.
  */
-export type IInternalDynamicContext = Omit<IDynamicContext, 'user' | 'cspNonce' | 'cssOverrides' | 'accessDeniedButton' | 'accessDeniedMessagePrimary' | 'accessDeniedMessageSecondary' | 'appLogoUrl' | 'appName' | 'bridgeChains' | 'customPrivacyPolicy' | 'customTermsOfServices' | 'debugError' | 'defaultNumberOfWalletsToShow' | 'defaultPhoneInputIso2' | 'detectNewWalletsForLinking' | 'displaySiweStatement' | 'enableConnectOnlyFallback' | 'events' | 'handlers' | 'mobileExperience' | 'networkValidationMode' | 'newToWeb3WalletChainMap' | 'notInTheListImageUrl' | 'onboardingImageUrl' | 'overrides' | 'policiesConsentInnerComponent' | 'privacyPolicyUrl' | 'recommendedWallets' | 'redirectUrl' | 'shadowDOMEnabled' | 'showLockedWalletView' | 'siweStatement' | 'socialMediaIconUrl' | 'socialMediaLinkText' | 'socialMediaUrl' | 'socialProvidersFilter' | 'termsOfServiceUrl' | 'theme' | 'walletsFilter'> & {
+export type IInternalDynamicContext = Omit<IDynamicContext, 'handleLogOut' | 'user' | 'cspNonce' | 'cssOverrides' | 'accessDeniedButton' | 'accessDeniedMessagePrimary' | 'accessDeniedMessageSecondary' | 'appLogoUrl' | 'appName' | 'bridgeChains' | 'customPrivacyPolicy' | 'customTermsOfServices' | 'debugError' | 'defaultNumberOfWalletsToShow' | 'defaultPhoneInputIso2' | 'detectNewWalletsForLinking' | 'displaySiweStatement' | 'enableConnectOnlyFallback' | 'events' | 'handlers' | 'mobileExperience' | 'networkValidationMode' | 'newToWeb3WalletChainMap' | 'notInTheListImageUrl' | 'onboardingImageUrl' | 'overrides' | 'policiesConsentInnerComponent' | 'privacyPolicyUrl' | 'recommendedWallets' | 'redirectUrl' | 'shadowDOMEnabled' | 'showLockedWalletView' | 'siweStatement' | 'socialMediaIconUrl' | 'socialMediaLinkText' | 'socialMediaUrl' | 'socialProvidersFilter' | 'termsOfServiceUrl' | 'theme' | 'walletsFilter'> & {
+    /**
+     * Reason-tagged logout for internal SDK call sites. Every internal logout
+     * must carry a reason so Datadog can attribute it. The no-arg public
+     * `handleLogOut` is intentionally omitted from this view.
+     */
+    handleLogOutWithReason: (reason: SdkLogoutReason) => Promise<void>;
     /**
      * @deprecated please call useOnboardingCompleteUser() OR useUser() instead.
      * | `useOnboardingCompleteUser` only returns the user if it's not missing KYC or MFA.

package/src/lib/events/auth.d.ts

@@ -1,5 +1,6 @@
 import type { LogoutEventMetadata } from '@dynamic-labs-sdk/client';
 import { AuthEventPayload } from '@dynamic-labs/types';
+import { SdkLogoutReason } from '../context/DynamicContext/hooks/useHandleLogout';
 export type AuthEvents = {
     /**
      * Informs an auth attempt failed.
@@ -15,7 +16,7 @@ export type AuthEvents = {
     authInit: (method: AuthEventPayload) => void;
     logout: (metadata?: LogoutEventMetadata) => void;
     /** This event is used to trigger logout to be called, DO NOT listen to it. Listen to "logout" instead */
-    triggerLogout: () => void;
+    triggerLogout: (reason: SdkLogoutReason) => void;
     /**
      * Emitted when the user succesfully completes an MFA challenge
      */