@envive-ai/react-hooks 0.3.7 → 0.3.9

package/src/contexts/typesV3.ts

@@ -3,12 +3,12 @@ import { ImageGalleryImage, ImageGalleryLayout } from '@envive-ai/react-toolkit-
 import { PromptButtonVariant } from '@envive-ai/react-toolkit-v3/PromptButton';
 import { WidgetWrapperVariant } from '@envive-ai/react-toolkit-v3/WidgetWrapper';
 import { Theme } from '@envive-ai/react-toolkit-v3/Tokens';
-import { DynamicLayout } from '@envive-ai/react-toolkit-v3/SocialProof';
+import { DynamicLayout, WidgetKind } from '@envive-ai/react-toolkit-v3/SocialProof';
 import { SparkleIconColor } from '@envive-ai/react-toolkit-v3/WelcomeMessage';
 import { FloatingButtonLocation } from '@envive-ai/react-toolkit-v3/FloatingButton';
 import { ColorNames } from '../application/models/colorsConfigV3';
 import { CustomerServiceType } from '../types/customerService';
-import type { MerchantVariantSettings, SearchConfig } from './types';
+import type { SearchConfig } from './types';
 
 export enum LetterSpacingCSSVar {
   Tight0 = 'envive-typography-letter-spacing-tight-0',
@@ -204,6 +204,11 @@ type CustomerServiceIntegration = {
   suppressMerchantButton?: boolean;
 };
 
+type SPASettings = {
+  enabled: boolean;
+  refreshInterval?: number;
+};
+
 type OrgUIConfigV3 = {
   id?: string;
 
@@ -221,7 +226,7 @@ type OrgUIConfigV3 = {
 
   customerServiceIntegration?: CustomerServiceIntegration;
 
-  merchantVariantSettings?: MerchantVariantSettings;
+  singlePageApplicationSettings?: SPASettings;
 
   searchConfig?: SearchConfig;
 };
@@ -240,6 +245,7 @@ export enum WidgetTypeV3 {
   SingleImagePromptV3 = 'SingleImagePromptV3',
   FloatingChatV3 = 'FloatingChatV3',
   FloatingButtonV3 = 'FloatingButtonV3',
+  ProductCardV3 = 'ProductCardV3',
 }
 
 interface BaseWidgetConfig<T extends WidgetTypeV3> {
@@ -261,13 +267,8 @@ interface TitledPromptCarouselWidgetV3Config extends BaseWidgetConfig<WidgetType
   promptCarouselRows?: PromptCarouselRows;
   animationSpeed?: AnimationSpeed;
 }
-
-enum SocialProofWidgetKind {
-  STATIC = 'static',
-  DYNAMIC = 'dynamic',
-}
 interface SocialProofWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.SocialProofV3> {
-  kind: SocialProofWidgetKind;
+  kind: WidgetKind;
   variant: WidgetWrapperVariant;
   hexCardColor?: string;
   promptCarouselRows: PromptCarouselRows;
@@ -311,10 +312,18 @@ interface PromptButtonCarouselWithImageWidgetV3Config extends BaseWidgetConfig<W
   promptButtonType?: PromptButtonVariant;
   image?: ImageGalleryImage;
   hideTextField?: boolean;
+  isDynamic?: boolean;
 }
 
 interface FloatingChatWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.FloatingChatV3> {}
 
+interface ProductCardWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.ProductCardV3> {
+  promptButtonType?: PromptButtonVariant;
+  italicizeHeadline?: boolean;
+  fallbackColor?: string;
+  imageSrc?: string;
+}
+
 type WidgetConfigV3 =
   | PromptCarouselWidgetV3Config
   | SocialProofWidgetV3Config
@@ -324,7 +333,8 @@ type WidgetConfigV3 =
   | TypingAnimationWidgetV3Config
   | ChatPreviewWidgetV3Config
   | PromptButtonCarouselWithImageWidgetV3Config
-  | FloatingChatWidgetV3Config;
+  | FloatingChatWidgetV3Config
+  | ProductCardWidgetV3Config;
 
 export type {
   OrgUIConfigV3,
@@ -339,9 +349,9 @@ export type {
   TypingAnimationWidgetV3Config,
   PromptButtonCarouselWithImageWidgetV3Config,
   FloatingChatWidgetV3Config,
+  ProductCardWidgetV3Config,
   FloatingChatConfig,
   FloatingButtonConfig,
   CustomerServiceIntegration,
+  SPASettings,
 };
-
-export { SocialProofWidgetKind };

package/src/contexts/userIdentityContext/__tests__/userIdentityContext.test.tsx

@@ -5,6 +5,7 @@ import { userIdAtom } from 'src/atoms/app';
 import { LocalStorageProvider } from 'src/contexts/localStorageContext';
 import Logger from 'src/application/logging/logger';
 import CommerceApiClient from 'src/application/commerce-api';
+import { UserIdentityService } from 'src/services/userIdentityService';
 import { UserIdentityProvider, useUserIdentity } from '../userIdentityContext';
 
 // Mock the Logger to avoid console output in tests
@@ -24,20 +25,32 @@ vi.mock('uuid', () => ({
   v4: vi.fn(() => 'test-uuid-12345'),
 }));
 
+// Mock userIdService
+const mockGetUserId = vi.fn().mockResolvedValue('spiffy-user-id-test-user-id');
+const mockInitializeUser = vi.fn().mockResolvedValue(undefined);
+
+const testUserIdService = {
+  getUserIdOrDefault: mockGetUserId,
+  initializeUser: mockInitializeUser,
+  getUserIdOverrideFromLocalStorage: vi.fn().mockReturnValue(undefined),
+} as unknown as UserIdentityService;
+
 // Component that uses the useUserIdentity hook
 const MockComponent: React.FC = () => {
   const context = useUserIdentity();
+  const [userId, setUserId] = React.useState<string>('');
+
+  React.useEffect(() => {
+    context.getUserIdOrDefault().then(setUserId);
+  }, [context]);
 
   return (
     <div data-testid="mock-component">
-      <div data-testid="user-id">{context.getUserIdOrDefault()}</div>
+      <div data-testid="user-id">{userId}</div>
       <div data-testid="is-ready">{context.isReady.toString()}</div>
       <div data-testid="user-id-override">
         {context.getUserIdOverrideFromLocalStorage() || 'none'}
       </div>
-      <div data-testid="user-id-default">
-        {context.getUserIdDefaultFromLocalStorage() || 'none'}
-      </div>
     </div>
   );
 };
@@ -122,7 +135,7 @@ describe('UserIdentityProvider', () => {
     return render(
       <Provider>
         <LocalStorageProvider>
-          <UserIdentityProvider>{children}</UserIdentityProvider>
+          <UserIdentityProvider userIdService={testUserIdService}>{children}</UserIdentityProvider>
         </LocalStorageProvider>
       </Provider>,
     );
@@ -220,50 +233,6 @@ describe('UserIdentityProvider', () => {
 
       consoleSpy.mockRestore();
     });
-
-    it('should set userIdAtom correctly when multiple components use useUserIdentity', async () => {
-      // Component that sets override - the atom will be set by useUserIdentity
-      const ComponentWithActions: React.FC = () => {
-        const context = useUserIdentity();
-
-        React.useEffect(() => {
-          // Set override on mount
-          context.setUserIdOverrideInLocalStorage('multi-component-override');
-        }, [context]);
-
-        // Get userId from context instead of atom directly
-        const userId = context.getUserIdOrDefault();
-
-        return (
-          <div>
-            <div data-testid="current-user-id">{userId}</div>
-          </div>
-        );
-      };
-
-      renderWithProviders(
-        <>
-          <ComponentWithActions />
-          <AtomReaderComponent />
-        </>,
-      );
-
-      // Wait for the atom to be set
-      await waitFor(() => {
-        const atomValue = screen.getByTestId('atom-reader').textContent;
-        expect(atomValue).not.toBe('not-set');
-      });
-
-      // Both components should see the same atom value
-      // Note: The atom is set by useUserIdentity's useEffect, which runs after
-      // the override is set in localStorage, so it should reflect the override
-      await waitFor(() => {
-        const atomValue = screen.getByTestId('atom-reader').textContent;
-        // The atom should be set to the override value since it was set before
-        // the component mounted, or it will be the generated default
-        expect(atomValue).toBeTruthy();
-      });
-    });
   });
 
   describe('getUserIdOrDefault', () => {
@@ -276,40 +245,6 @@ describe('UserIdentityProvider', () => {
         expect(screen.getByTestId('user-id').textContent).toBe('override-123');
       });
     });
-
-    it('should return default userId if override does not exist', async () => {
-      localStorage.setItem('v1-spiffy-user-id-default', 'default-456');
-
-      renderWithProviders(<MockComponent />);
-
-      await waitFor(() => {
-        expect(screen.getByTestId('user-id').textContent).toBe('default-456');
-      });
-    });
-
-    it('should generate and store new userId if neither exists', async () => {
-      renderWithProviders(<MockComponent />);
-
-      await waitFor(() => {
-        const userId = screen.getByTestId('user-id').textContent;
-        expect(userId).toContain('spiffy-user-id-');
-        expect(userId).toContain('test-uuid-12345');
-      });
-
-      // Verify it was stored in localStorage
-      expect(localStorage.getItem('v1-spiffy-user-id-default')).toContain('spiffy-user-id-');
-    });
-
-    it('should prioritize override over default', async () => {
-      localStorage.setItem('v1-spiffy-user-id-override', 'override-789');
-      localStorage.setItem('v1-spiffy-user-id-default', 'default-012');
-
-      renderWithProviders(<MockComponent />);
-
-      await waitFor(() => {
-        expect(screen.getByTestId('user-id').textContent).toBe('override-789');
-      });
-    });
   });
 
   describe('LocalStorage Operations', () => {
@@ -323,33 +258,6 @@ describe('UserIdentityProvider', () => {
       });
     });
 
-    it('should get userId default from localStorage', async () => {
-      localStorage.setItem('v1-spiffy-user-id-default', 'test-default');
-
-      renderWithProviders(<MockComponent />);
-
-      await waitFor(() => {
-        expect(screen.getByTestId('user-id-default').textContent).toBe('test-default');
-      });
-    });
-
-    it('should set userId default in localStorage', async () => {
-      const ComponentWithSet: React.FC = () => {
-        const context = useUserIdentity();
-        React.useEffect(() => {
-          context.setUserIdDefaultInLocalStorage('new-default-id');
-        }, [context]);
-
-        return <div data-testid="set-component">Set</div>;
-      };
-
-      renderWithProviders(<ComponentWithSet />);
-
-      await waitFor(() => {
-        expect(localStorage.getItem('v1-spiffy-user-id-default')).toBe('new-default-id');
-      });
-    });
-
     it('should set userId override in localStorage', async () => {
       const ComponentWithSet: React.FC = () => {
         const context = useUserIdentity();
@@ -386,27 +294,6 @@ describe('UserIdentityProvider', () => {
       });
     });
 
-    it('should log info when setting userId default', async () => {
-      const logSpy = vi.spyOn(Logger, 'logInfo');
-
-      const ComponentWithSet: React.FC = () => {
-        const context = useUserIdentity();
-        React.useEffect(() => {
-          context.setUserIdDefaultInLocalStorage('logged-default-id');
-        }, [context]);
-
-        return <div>Set</div>;
-      };
-
-      renderWithProviders(<ComponentWithSet />);
-
-      await waitFor(() => {
-        expect(logSpy).toHaveBeenCalledWith(
-          'setUserIdDefaultInLocalStorage - Setting user_id=logged-default-id',
-        );
-      });
-    });
-
     it('should log info when setting userId override', async () => {
       const logSpy = vi.spyOn(Logger, 'logInfo');
 

package/src/contexts/userIdentityContext/userIdentityContext.tsx

@@ -1,12 +1,20 @@
-import React, { createContext, useCallback, useContext, useEffect, useMemo, useState } from 'react';
+import React, {
+  ReactNode,
+  createContext,
+  useCallback,
+  useContext,
+  useEffect,
+  useMemo,
+  useState,
+} from 'react';
 import UAParser from 'ua-parser-js';
 import Logger from 'src/application/logging/logger';
 import CommerceApiClient from 'src/application/commerce-api';
-import { v4 as uuid } from 'uuid';
 import { ClientDetails } from 'src/application/models/clientDetails';
 import { useLocalStorage } from 'src/contexts/localStorageContext';
 import { useSetAtom } from 'jotai';
 import { userIdAtom } from 'src/atoms/app';
+import { UserIdentityService } from 'src/services/userIdentityService';
 
 // Helper function from the original service
 const getUserAgentDetails = (): ClientDetails => {
@@ -27,10 +35,8 @@ const getUserAgentDetails = (): ClientDetails => {
 
 export interface UserIdentityContextType {
   identifyUser: () => Promise<void>;
-  getUserIdOrDefault: () => string;
+  getUserIdOrDefault: () => Promise<string>;
   getUserIdOverrideFromLocalStorage: () => string | undefined;
-  getUserIdDefaultFromLocalStorage: () => string | undefined;
-  setUserIdDefaultInLocalStorage: (userId: string) => string;
   setUserIdOverrideInLocalStorage: (userId: string) => string;
   clearUserIdOverrideInLocalStorage: () => void;
   isReady: boolean;
@@ -38,7 +44,15 @@ export interface UserIdentityContextType {
 
 const UserIdentityContext = createContext<UserIdentityContextType | undefined>(undefined);
 
-export const UserIdentityProvider: React.FC<{ children: React.ReactNode }> = ({ children }) => {
+interface UserIdentityProviderProps {
+  userIdService: UserIdentityService;
+  children: ReactNode;
+}
+
+export const UserIdentityProvider: React.FC<UserIdentityProviderProps> = ({
+  userIdService: inputService,
+  children,
+}) => {
   const [localUserId, setLocalUserId] = useState<string | undefined>(undefined);
   const setUserId = useSetAtom(userIdAtom);
   const { getItem, setItem, isAvailable: localStorageIsReady } = useLocalStorage();
@@ -52,26 +66,12 @@ export const UserIdentityProvider: React.FC<{ children: React.ReactNode }> = ({
   }, [localStorageIsReady]);
 
   const USER_ID_OVERRIDE_KEY = 'v1-spiffy-user-id-override';
-  const USER_ID_DEFAULT_KEY = 'v1-spiffy-user-id-default';
 
+  // @deprecated
   const getUserIdOverrideFromLocalStorage = useCallback((): string | undefined => {
     return getItem(USER_ID_OVERRIDE_KEY) ?? undefined;
   }, [getItem]);
 
-  const getUserIdDefaultFromLocalStorage = useCallback((): string | undefined => {
-    return getItem(USER_ID_DEFAULT_KEY) ?? undefined;
-  }, [getItem]);
-
-  const setUserIdDefaultInLocalStorage = useCallback(
-    (userId: string): string => {
-      Logger.logInfo(`setUserIdDefaultInLocalStorage - Setting user_id=${userId}`);
-      setItem(USER_ID_DEFAULT_KEY, userId);
-      // window.dispatchEvent is handled by useLocalStorage now
-      return userId;
-    },
-    [setItem, USER_ID_DEFAULT_KEY],
-  );
-
   const setUserIdOverrideInLocalStorage = useCallback(
     (userId: string): string => {
       Logger.logInfo(`setUserIdOverrideInLocalStorage - Setting user_id=${userId}`);
@@ -89,23 +89,29 @@ export const UserIdentityProvider: React.FC<{ children: React.ReactNode }> = ({
     setItem(USER_ID_OVERRIDE_KEY, ''); // Set to empty string to clear
   }, [setItem, USER_ID_OVERRIDE_KEY]);
 
-  const getUserIdOrDefault = useCallback((): string => {
+  const getUserIdOrDefault = useCallback(async (): Promise<string> => {
     const userIdOverride = getUserIdOverrideFromLocalStorage();
     if (userIdOverride) {
       return userIdOverride;
     }
 
-    const defaultUserId = getUserIdDefaultFromLocalStorage();
-    if (defaultUserId) {
-      return defaultUserId;
-    }
+    try {
+      // NOTE: This uses EnviveAnalytics under the hood to determine the userID
+      const enviveUserId = await inputService.getUserIdOrDefault();
 
-    return setUserIdDefaultInLocalStorage(`spiffy-user-id-${uuid()}`);
-  }, [
-    getUserIdOverrideFromLocalStorage,
-    getUserIdDefaultFromLocalStorage,
-    setUserIdDefaultInLocalStorage,
-  ]);
+      if (!enviveUserId) {
+        throw new Error(
+          '[spiffy-ai] EnviveAnalytics.resolveEnviveUserId() returned null/undefined - this should never happen',
+        );
+      }
+
+      return enviveUserId;
+    } catch (error: unknown) {
+      Logger.logError('[spiffy-ai] CRITICAL: Failed to get user ID from EnviveAnalytics', error);
+      const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+      throw new Error(`[spiffy-ai] CRITICAL: User ID resolution failed: ${errorMessage}`);
+    }
+  }, [getUserIdOverrideFromLocalStorage]);
 
   const identifyUser = useCallback(async (): Promise<void> => {
     if (!isReady) {
@@ -117,7 +123,7 @@ export const UserIdentityProvider: React.FC<{ children: React.ReactNode }> = ({
       // Temporarily commented out until WindowDataLayerService is resolved
       // const cdpUserId = WindowDataLayerService.getGoogleAnalyticsClientId();
       const cdpUserId = 'UNKNOWN_CDP_USER_ID'; // Placeholder
-      const userId = getUserIdOrDefault();
+      const userId = await getUserIdOrDefault();
       const userAgentDetails = getUserAgentDetails();
 
       if (!cdpUserId) {
@@ -136,8 +142,6 @@ export const UserIdentityProvider: React.FC<{ children: React.ReactNode }> = ({
       identifyUser,
       getUserIdOrDefault,
       getUserIdOverrideFromLocalStorage,
-      getUserIdDefaultFromLocalStorage,
-      setUserIdDefaultInLocalStorage,
       setUserIdOverrideInLocalStorage,
       clearUserIdOverrideInLocalStorage,
       isReady,
@@ -146,8 +150,6 @@ export const UserIdentityProvider: React.FC<{ children: React.ReactNode }> = ({
       identifyUser,
       getUserIdOrDefault,
       getUserIdOverrideFromLocalStorage,
-      getUserIdDefaultFromLocalStorage,
-      setUserIdDefaultInLocalStorage,
       setUserIdOverrideInLocalStorage,
       clearUserIdOverrideInLocalStorage,
       isReady,
@@ -155,11 +157,15 @@ export const UserIdentityProvider: React.FC<{ children: React.ReactNode }> = ({
   );
   useEffect(() => {
     if (isReady && !localUserId) {
-      const newUserId = getUserIdOrDefault();
-      setLocalUserId(newUserId);
-      setUserId(newUserId);
+      const setUserIdStates = async () => {
+        const newUserId = await getUserIdOrDefault();
+        console.log('useUserIdentity useEffect - setting localUserId', newUserId);
+        setLocalUserId(newUserId);
+        setUserId(newUserId);
+      };
+      setUserIdStates();
     }
-  }, [isReady, localUserId, setUserId]);
+  }, [getUserIdOrDefault, isReady, localUserId, setUserId]);
 
   if (!localUserId) {
     return null;

package/src/contexts/widgetConfigContext/widgetConfigContext.tsx

@@ -35,6 +35,10 @@ export const WidgetConfigProvider: React.FC<{ children: ReactNode }> = ({ childr
       const response = frontendConfig?.widgetConfigs?.[widgetConfigId];
       Logger.logInfo('widgetConfigContext | returning widget config response', response);
 
+      if (widgetConfigId === 'fake-widget-config-id') {
+        return {} as WidgetConfigV3;
+      }
+
       if (
         [
           WidgetTypeV3.SocialProofV3,

package/src/hooks/ElementObserver/useElementObserver.ts

@@ -51,8 +51,9 @@ export interface ElementObserverUtility {
  */
 export const useElementObserver = (selector: NodeSelector): ElementObserverUtility => {
   const INITIAL_RENDER_STATE = true;
-  const eoRef = useRef<ElementObserver>(DOMObserver.add(selector));
+  const eoRef = useRef<ElementObserver | null>(null);
   const [renderBlocked, setRenderBlocked] = useState(INITIAL_RENDER_STATE);
+  eoRef.current = DOMObserver.add(selector);
 
   /**
    * Fired every time the HTML element changes.

package/src/hooks/Search/__tests__/useSearch.test.tsx

@@ -25,6 +25,7 @@ import { ProductSorting } from 'src/atoms/search/types';
 import { SearchResult } from 'src/application/models/api/search';
 import { SearchResultsState } from 'src/hooks/utils';
 import { SearchResponseProduct } from '@spiffy-ai/commerce-api-client';
+import { UserIdentityService } from 'src/services/userIdentityService';
 import { useSearch } from '../useSearch';
 
 // Mock dependencies
@@ -171,6 +172,15 @@ vi.mock('src/events', () => ({
   },
 }));
 
+const mockGetUserId = vi.fn().mockResolvedValue('test-user-id');
+const mockInitializeUser = vi.fn().mockResolvedValue(undefined);
+
+const testUserIdService = {
+  getUserIdOrDefault: mockGetUserId,
+  initializeUser: mockInitializeUser,
+  getUserIdOverrideFromLocalStorage: vi.fn().mockReturnValue(undefined),
+} as unknown as UserIdentityService;
+
 // FeatureFlagService
 const testFeatureFlagService = new FeatureFlagService([]);
 
@@ -398,7 +408,7 @@ const TestWrapper: React.FC<{
       >
         <LocalStorageProvider>
           <GraphQLProvider>
-            <UserIdentityProvider>
+            <UserIdentityProvider userIdService={testUserIdService}>
               <FeatureFlagServiceProvider featureFlagService={testFeatureFlagService}>
                 <AmplitudeProvider>
                   <NewOrgConfigProvider>

package/src/mocks/index.ts

@@ -0,0 +1 @@
+export * from './salesAgentMockData';