@envive-ai/react-widgets-v3 0.3.13 → 0.3.14

package/src/widgets/SocialProofWidget/__tests__/SocialProofWidget.test.tsx

@@ -0,0 +1,184 @@
+import { render, screen, waitFor } from '@testing-library/react';
+import {
+  EnviveMetricsEventName,
+  SpiffyMetricsEventName,
+} from '@envive-ai/react-hooks/contexts/amplitudeContext';
+import { WidgetTypeV3 } from '@envive-ai/react-hooks/contexts/typesV3';
+import { UserEvent, UserEventCategory } from '@spiffy-ai/commerce-api-client';
+import { SocialProofWidget } from '../SocialProofWidget';
+
+const mockTrackEvent = vi.fn();
+const mockGetHardcopy = vi.fn();
+
+vi.mock('@envive-ai/react-toolkit-v3/SocialProof', async importOriginal => {
+  const actual = await importOriginal();
+  const MockSocialProof = ({
+    widgetContentProps,
+    widgetEventProps,
+  }: {
+    widgetContentProps: { primaryButtonText?: string };
+    widgetEventProps: { handlePrimaryButtonClick: (text: string) => void };
+  }) => (
+    <div data-testid="social-proof-mock">
+      <button
+        type="button"
+        onClick={() =>
+          widgetEventProps.handlePrimaryButtonClick(
+            widgetContentProps.primaryButtonText || 'Primary',
+          )
+        }
+      >
+        {widgetContentProps.primaryButtonText || 'Primary'}
+      </button>
+    </div>
+  );
+  return {
+    ...actual,
+    SocialProof: MockSocialProof,
+  };
+});
+
+vi.mock('@envive-ai/react-hooks/contexts/amplitudeContext', () => ({
+  useAmplitude: () => ({
+    trackEvent: mockTrackEvent,
+    isReady: true,
+  }),
+  SpiffyMetricsEventName: {
+    ChatComponentVisible: 'Chat Component Visible',
+    SearchComponentVisible: 'Search Component Visible',
+  },
+  EnviveMetricsEventName: {
+    WidgetTextClicked: 'Widget Text Clicked',
+  },
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/hardcopyContext', () => ({
+  useHardcopy: () => ({
+    getHardcopy: mockGetHardcopy,
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/pageContext', () => ({
+  usePage: () => ({
+    userEvent: {
+      id: 'test-user-event-id',
+      category: UserEventCategory.PageVisit,
+      created_at: '2025-01-01T00:00:00Z',
+      event_id: 'test-event-id',
+    } as UserEvent,
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/widgetConfigContext', () => ({
+  useWidgetConfig: () => ({
+    getWidgetConfig: vi.fn().mockResolvedValue({}),
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/uiConfigContext', () => ({
+  useUiConfig: () => ({
+    getUiConfig: vi.fn().mockResolvedValue({}),
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/salesAgentContext', () => ({
+  useSalesAgent: () => ({
+    onTypedMessageSubmitted: vi.fn(),
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/hooks/ChatToggle', () => ({
+  useChatToggle: () => ({
+    openChat: vi.fn(),
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/atoms/chat', () => ({
+  lastAssistantMessageAtom: {},
+}));
+
+vi.mock('@envive-ai/react-hooks/atoms/app', () => ({
+  variantInfoAtom: {},
+}));
+
+vi.mock('@envive-ai/react-hooks/atoms/widget', () => ({
+  chatPreviewLoadingDataAtom: {},
+}));
+
+vi.mock('jotai', async importOriginal => {
+  const actual = await importOriginal();
+  const variantInfo = {
+    variant: 'PageVisit',
+    productId: undefined,
+    plpId: undefined,
+    url: '',
+    pageVisitCategory: '',
+  };
+  const useAtomValueMock = vi.fn();
+  useAtomValueMock.mockReturnValueOnce([]).mockReturnValueOnce(variantInfo).mockReturnValue([]);
+  return {
+    ...actual,
+    useAtomValue: useAtomValueMock,
+    useSetAtom: vi.fn(() => vi.fn()),
+  };
+});
+
+describe('SocialProofWidget analytics', () => {
+  const defaultHardcopy = {
+    responseId: 'test-response-id',
+    language: 'en',
+    values: {
+      primaryButtonText: 'Primary Button',
+      titleLabel: 'Title',
+    },
+    rawValues: {
+      primaryButtonText: { id: 'id-1', value: 'Primary Button' },
+    },
+  };
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+    mockGetHardcopy.mockResolvedValue(defaultHardcopy);
+  });
+
+  it('should track ChatComponentVisible when widget mounts', async () => {
+    render(<SocialProofWidget widgetConfigId="test-config-1" />);
+
+    await waitFor(
+      () => {
+        expect(mockTrackEvent).toHaveBeenCalledWith({
+          eventName: SpiffyMetricsEventName.ChatComponentVisible,
+          eventProps: {
+            widget_config_id: 'test-config-1',
+            widget_type: WidgetTypeV3.SocialProofV3,
+          },
+        });
+      },
+      { timeout: 3000 },
+    );
+  }, 5000);
+
+  it('should track WidgetTextClicked when primary button is clicked', async () => {
+    render(<SocialProofWidget widgetConfigId="test-config-2" />);
+
+    await waitFor(
+      () => {
+        expect(screen.getByText('Primary Button')).toBeInTheDocument();
+      },
+      { timeout: 3000 },
+    );
+
+    mockTrackEvent.mockClear();
+
+    screen.getByText('Primary Button').click();
+
+    expect(mockTrackEvent).toHaveBeenCalledWith({
+      eventName: EnviveMetricsEventName.WidgetTextClicked,
+      eventProps: {
+        response_id: 'test-response-id',
+        string_id: 'id-1',
+        text: 'Primary Button',
+      },
+    });
+  }, 5000);
+});

package/src/widgets/TitledPromptCarouselWidget/TitledPromptCarouselWidget.tsx

@@ -7,6 +7,7 @@ import { ChatElementDisplayLocationV3 } from '@envive-ai/react-hooks/application
 import { useSalesAgent } from '@envive-ai/react-hooks/contexts/salesAgentContext';
 import { useCallback, useEffect } from 'react';
 import {
+  EnviveMetricsEventName,
   SpiffyMetricsEventName,
   useAmplitude,
 } from '@envive-ai/react-hooks/contexts/amplitudeContext';
@@ -15,6 +16,7 @@ import { useChatToggle } from '@envive-ai/react-hooks/hooks/ChatToggle';
 import { TitledPromptCarousel } from '@envive-ai/react-toolkit-v3/TitledPromptCarousel';
 import { AnimationSpeed, PromptCarouselRows } from '@envive-ai/react-toolkit-v3/PromptCarousel';
 import { BaseWidgetProps, withBaseWidget } from '../../hocs/withBaseWidget';
+import { RawValues, getStringIdForText } from '../utils/functions';
 
 const mockButtonTexts = [
   'Loading button 1',
@@ -67,6 +69,16 @@ const TitledPromptCarouselWidgetHandler = (props: BaseWidgetProps) => {
 
   const handleButtonClick = useCallback(
     (text: string) => {
+      const rawValues = (hardcopyContent as { rawValues?: RawValues } | undefined)?.rawValues;
+      const stringId = getStringIdForText(rawValues, text);
+      trackEvent({
+        eventName: EnviveMetricsEventName.WidgetTextClicked,
+        eventProps: {
+          response_id: hardcopyContent?.responseId,
+          string_id: stringId,
+          text,
+        },
+      });
       onTypedMessageSubmitted({
         query: text,
         userTyped: false,

package/src/widgets/TitledPromptCarouselWidget/__tests__/TitledPromptCarouselWidget.test.tsx

@@ -0,0 +1,150 @@
+import { render, screen, waitFor } from '@testing-library/react';
+import {
+  EnviveMetricsEventName,
+  SpiffyMetricsEventName,
+} from '@envive-ai/react-hooks/contexts/amplitudeContext';
+import { WidgetTypeV3 } from '@envive-ai/react-hooks/contexts/typesV3';
+import { UserEvent, UserEventCategory } from '@spiffy-ai/commerce-api-client';
+import { TitledPromptCarouselWidget } from '../TitledPromptCarouselWidget';
+
+const mockTrackEvent = vi.fn();
+const mockGetHardcopy = vi.fn();
+
+vi.mock('@envive-ai/react-toolkit-v3/TitledPromptCarousel', () => ({
+  TitledPromptCarousel: ({
+    promptButtonTexts,
+    handleButtonClick,
+  }: {
+    promptButtonTexts: string[];
+    handleButtonClick: (text: string) => void;
+  }) => (
+    <div data-testid="titled-prompt-carousel-mock">
+      {promptButtonTexts.map(text => (
+        <button
+          key={text}
+          type="button"
+          onClick={() => handleButtonClick(text)}
+        >
+          {text}
+        </button>
+      ))}
+    </div>
+  ),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/amplitudeContext', () => ({
+  useAmplitude: () => ({
+    trackEvent: mockTrackEvent,
+    isReady: true,
+  }),
+  SpiffyMetricsEventName: {
+    ChatComponentVisible: 'Chat Component Visible',
+    SearchComponentVisible: 'Search Component Visible',
+  },
+  EnviveMetricsEventName: {
+    WidgetTextClicked: 'Widget Text Clicked',
+  },
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/hardcopyContext', () => ({
+  useHardcopy: () => ({
+    getHardcopy: mockGetHardcopy,
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/pageContext', () => ({
+  usePage: () => ({
+    userEvent: {
+      id: 'test-user-event-id',
+      category: UserEventCategory.PageVisit,
+      created_at: '2025-01-01T00:00:00Z',
+      event_id: 'test-event-id',
+    } as UserEvent,
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/widgetConfigContext', () => ({
+  useWidgetConfig: () => ({
+    getWidgetConfig: vi.fn().mockResolvedValue({}),
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/uiConfigContext', () => ({
+  useUiConfig: () => ({
+    getUiConfig: vi.fn().mockResolvedValue({}),
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/salesAgentContext', () => ({
+  useSalesAgent: () => ({
+    onTypedMessageSubmitted: vi.fn(),
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/hooks/ChatToggle', () => ({
+  useChatToggle: () => ({
+    openChat: vi.fn(),
+  }),
+}));
+
+describe('TitledPromptCarouselWidget analytics', () => {
+  const defaultHardcopy = {
+    responseId: 'test-response-id',
+    language: 'en',
+    values: {
+      promptButtonTexts: ['Button 1', 'Button 2', 'Button 3'],
+    },
+    rawValues: {
+      promptButtonTexts: [
+        { id: 'id-1', value: 'Button 1' },
+        { id: 'id-2', value: 'Button 2' },
+      ],
+    },
+  };
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+    mockGetHardcopy.mockResolvedValue(defaultHardcopy);
+  });
+
+  it('should track ChatComponentVisible when widget mounts', async () => {
+    render(<TitledPromptCarouselWidget widgetConfigId="test-config-1" />);
+
+    await waitFor(
+      () => {
+        expect(mockTrackEvent).toHaveBeenCalledWith({
+          eventName: SpiffyMetricsEventName.ChatComponentVisible,
+          eventProps: {
+            widget_config_id: 'test-config-1',
+            widget_type: WidgetTypeV3.TitledPromptCarouselV3,
+          },
+        });
+      },
+      { timeout: 3000 },
+    );
+  }, 5000);
+
+  it('should track WidgetTextClicked when button is clicked', async () => {
+    render(<TitledPromptCarouselWidget widgetConfigId="test-config-2" />);
+
+    await waitFor(
+      () => {
+        expect(screen.getByText('Button 1')).toBeInTheDocument();
+      },
+      { timeout: 3000 },
+    );
+
+    mockTrackEvent.mockClear();
+
+    screen.getByText('Button 1').click();
+
+    expect(mockTrackEvent).toHaveBeenCalledWith({
+      eventName: EnviveMetricsEventName.WidgetTextClicked,
+      eventProps: {
+        response_id: 'test-response-id',
+        string_id: 'id-1',
+        text: 'Button 1',
+      },
+    });
+  }, 5000);
+});

package/src/widgets/TypingAnimationWidget/TypingAnimationWidget.tsx

@@ -7,6 +7,7 @@ import { WidgetWrapperVariant } from '@envive-ai/react-toolkit-v3/WidgetWrapper'
 import { useCallback, useEffect } from 'react';
 import { ChatElementDisplayLocationV3 } from '@envive-ai/react-hooks/application/models';
 import {
+  EnviveMetricsEventName,
   SpiffyMetricsEventName,
   useAmplitude,
 } from '@envive-ai/react-hooks/contexts/amplitudeContext';
@@ -16,6 +17,7 @@ import { chatOnToggleAtom } from '@envive-ai/react-hooks/atoms/chat/chatState';
 import { PromptCarouselRows } from '@envive-ai/react-toolkit-v3/PromptCarousel';
 import { TypingAnimation } from '@envive-ai/react-toolkit-v3/TypingAnimation';
 import { BaseWidgetProps, withBaseWidget } from '../../hocs/withBaseWidget';
+import { RawValues, getStringIdForText } from '../utils/functions';
 
 const mockButtonTexts = [
   'Loading button 1',
@@ -33,7 +35,7 @@ const TypingAnimationWidgetHandler = (props: BaseWidgetProps) => {
   const { onTypedMessageSubmitted } = useSalesAgent();
   const onToggle = useSetAtom(chatOnToggleAtom);
 
-  const { hardcopyContent, widgetConfig, isLoading, widgetConfigId } = props;
+  const { hardcopyContent, widgetConfig, uiConfig, isLoading, widgetConfigId } = props;
 
   const titleLabel = (hardcopyContent?.values?.titleLabel as string | undefined) || '';
   const headlineText = (hardcopyContent?.values?.headlineText as string | undefined) || '';
@@ -58,6 +60,9 @@ const TypingAnimationWidgetHandler = (props: BaseWidgetProps) => {
     typingAnimationWidgetConfig?.promptCarouselRows || PromptCarouselRows.ALWAYS_ONE;
   const showTextField = typingAnimationWidgetConfig?.showTextField !== false; // Default: true
 
+  const logoSrc = uiConfig?.lookAndFeel?.widgetLogoSrc;
+  const hideLogo = uiConfig?.lookAndFeel?.hideWidgetLogo;
+
   const { trackEvent } = useAmplitude();
 
   useEffect(() => {
@@ -72,6 +77,16 @@ const TypingAnimationWidgetHandler = (props: BaseWidgetProps) => {
 
   const handleButtonClick = useCallback(
     (text: string) => {
+      const rawValues = (hardcopyContent as { rawValues?: RawValues } | undefined)?.rawValues;
+      const stringId = getStringIdForText(rawValues, text);
+      trackEvent({
+        eventName: EnviveMetricsEventName.WidgetTextClicked,
+        eventProps: {
+          response_id: hardcopyContent?.responseId,
+          string_id: stringId,
+          text,
+        },
+      });
       onTypedMessageSubmitted({
         query: text,
         userTyped: false,
@@ -79,7 +94,7 @@ const TypingAnimationWidgetHandler = (props: BaseWidgetProps) => {
       });
       onToggle(ChatElementDisplayLocationV3.TYPING_ANIMATION);
     },
-    [onTypedMessageSubmitted, onToggle],
+    [hardcopyContent, trackEvent, onTypedMessageSubmitted, onToggle],
   );
 
   const handleTextFieldClick = useCallback(() => {
@@ -98,6 +113,8 @@ const TypingAnimationWidgetHandler = (props: BaseWidgetProps) => {
         promptButtonTexts: buttonTexts,
         hintText: isLoading ? mockHintText : hintText,
         textFieldAriaLabel,
+        logoSrc: logoSrc ?? undefined,
+        hideLogo: hideLogo ?? false,
       }}
       widgetStyleProps={{
         widgetVariant,

package/src/widgets/TypingAnimationWidget/__tests__/TypingAnimationWidget.test.tsx

@@ -0,0 +1,163 @@
+import { render, screen, waitFor } from '@testing-library/react';
+import { atom } from 'jotai';
+import {
+  EnviveMetricsEventName,
+  SpiffyMetricsEventName,
+} from '@envive-ai/react-hooks/contexts/amplitudeContext';
+import { WidgetTypeV3 } from '@envive-ai/react-hooks/contexts/typesV3';
+import { UserEvent, UserEventCategory } from '@spiffy-ai/commerce-api-client';
+import { TypingAnimationWidget } from '../TypingAnimationWidget';
+
+const mockTrackEvent = vi.fn();
+
+vi.mock('@envive-ai/react-toolkit-v3/TypingAnimation', () => ({
+  TypingAnimation: ({
+    widgetContentProps,
+    widgetEventProps,
+  }: {
+    widgetContentProps: { promptButtonTexts: string[] };
+    widgetEventProps: { handleButtonClick: (text: string) => void };
+  }) => (
+    <div data-testid="typing-animation-mock">
+      {widgetContentProps.promptButtonTexts.map(text => (
+        <button
+          key={text}
+          type="button"
+          onClick={() => widgetEventProps.handleButtonClick(text)}
+        >
+          {text}
+        </button>
+      ))}
+    </div>
+  ),
+}));
+const mockGetHardcopy = vi.fn();
+const mockOnTypedMessageSubmitted = vi.fn();
+const mockOpenChat = vi.fn();
+const mockSetAtom = vi.fn();
+
+vi.mock('@envive-ai/react-hooks/contexts/amplitudeContext', () => ({
+  useAmplitude: () => ({
+    trackEvent: mockTrackEvent,
+    isReady: true,
+  }),
+  SpiffyMetricsEventName: {
+    ChatComponentVisible: 'Chat Component Visible',
+    SearchComponentVisible: 'Search Component Visible',
+  },
+  EnviveMetricsEventName: {
+    WidgetTextClicked: 'Widget Text Clicked',
+  },
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/hardcopyContext', () => ({
+  useHardcopy: () => ({
+    getHardcopy: mockGetHardcopy,
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/pageContext', () => ({
+  usePage: () => ({
+    userEvent: {
+      id: 'test-user-event-id',
+      category: UserEventCategory.PageVisit,
+      created_at: '2025-01-01T00:00:00Z',
+      event_id: 'test-event-id',
+    } as UserEvent,
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/widgetConfigContext', () => ({
+  useWidgetConfig: () => ({
+    getWidgetConfig: vi.fn().mockResolvedValue({}),
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/uiConfigContext', () => ({
+  useUiConfig: () => ({
+    getUiConfig: vi.fn().mockResolvedValue({}),
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/contexts/salesAgentContext', () => ({
+  useSalesAgent: () => ({
+    onTypedMessageSubmitted: mockOnTypedMessageSubmitted,
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/hooks/ChatToggle', () => ({
+  useChatToggle: () => ({
+    openChat: mockOpenChat,
+  }),
+}));
+
+vi.mock('@envive-ai/react-hooks/atoms/chat/chatState', () => ({
+  chatOnToggleAtom: atom(null),
+}));
+
+describe('TypingAnimationWidget analytics', () => {
+  const defaultHardcopy = {
+    responseId: 'test-response-id',
+    language: 'en',
+    values: {
+      promptButtonTexts: ['Button 1', 'Button 2', 'Button 3'],
+      titleLabel: 'Test Title',
+      headlineText: 'Headline',
+      animatedTextSequence: ['...'],
+      hintText: 'Ask me anything',
+    },
+    rawValues: {
+      promptButtonTexts: [
+        { id: 'id-1', value: 'Button 1' },
+        { id: 'id-2', value: 'Button 2' },
+      ],
+    },
+  };
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+    mockGetHardcopy.mockResolvedValue(defaultHardcopy);
+  });
+
+  it('should track ChatComponentVisible when widget mounts', async () => {
+    render(<TypingAnimationWidget widgetConfigId="test-config-1" />);
+
+    await waitFor(
+      () => {
+        expect(mockTrackEvent).toHaveBeenCalledWith({
+          eventName: SpiffyMetricsEventName.ChatComponentVisible,
+          eventProps: {
+            widget_config_id: 'test-config-1',
+            widget_type: WidgetTypeV3.TypingAnimationV3,
+          },
+        });
+      },
+      { timeout: 3000 },
+    );
+  }, 5000);
+
+  it('should track WidgetTextClicked when button is clicked', async () => {
+    render(<TypingAnimationWidget widgetConfigId="test-config-2" />);
+
+    await waitFor(
+      () => {
+        expect(screen.getByText('Button 1')).toBeInTheDocument();
+      },
+      { timeout: 3000 },
+    );
+
+    mockTrackEvent.mockClear();
+
+    const button = screen.getByText('Button 1');
+    button.click();
+
+    expect(mockTrackEvent).toHaveBeenCalledWith({
+      eventName: EnviveMetricsEventName.WidgetTextClicked,
+      eventProps: {
+        response_id: 'test-response-id',
+        string_id: 'id-1',
+        text: 'Button 1',
+      },
+    });
+  }, 5000);
+});

package/src/widgets/__tests__/testUtils.tsx

@@ -0,0 +1,63 @@
+import { RenderOptions, render } from '@testing-library/react';
+import { ReactElement } from 'react';
+import { UserEvent, UserEventCategory } from '@spiffy-ai/commerce-api-client';
+import {
+  EnviveMetricsEventName,
+  SpiffyMetricsEventName,
+} from '@envive-ai/react-hooks/contexts/amplitudeContext';
+
+export const mockTrackEvent = vi.fn();
+
+export const defaultHardcopyResponse = {
+  responseId: 'test-response-id',
+  language: 'en',
+  values: {
+    promptButtonTexts: ['Button 1', 'Button 2', 'Button 3'],
+    titleLabel: 'Test Title',
+    headlineText: 'Headline',
+    headline: 'Product Headline',
+    animatedTextSequence: ['...'],
+    hintText: 'Ask me anything',
+    prompts: ['Prompt 1', 'Prompt 2'],
+    primaryButtonText: 'Primary',
+    secondaryButtonTexts: ['Secondary 1'],
+    promptButtonsTexts: ['Prompt A', 'Prompt B'],
+  },
+  rawValues: {
+    promptButtonTexts: [
+      { id: 'id-1', value: 'Button 1' },
+      { id: 'id-2', value: 'Button 2' },
+    ],
+  },
+};
+
+export const defaultUserEvent = {
+  id: 'test-user-event-id',
+  category: UserEventCategory.PageVisit,
+  created_at: '2025-01-01T00:00:00Z',
+  event_id: 'test-event-id',
+} as UserEvent;
+
+export function createWidgetTestMocks(overrides?: {
+  trackEvent?: ReturnType<typeof vi.fn>;
+  hardcopy?: Partial<typeof defaultHardcopyResponse>;
+}) {
+  const trackEvent = overrides?.trackEvent ?? mockTrackEvent;
+  const hardcopy = { ...defaultHardcopyResponse, ...overrides?.hardcopy };
+
+  return {
+    trackEvent,
+    hardcopy,
+    getHardcopy: vi.fn().mockResolvedValue(hardcopy),
+    userEvent: defaultUserEvent,
+  };
+}
+
+export function renderWithWidgetProviders(
+  ui: ReactElement,
+  options?: Omit<RenderOptions, 'wrapper'>,
+) {
+  return render(ui, options);
+}
+
+export { EnviveMetricsEventName, SpiffyMetricsEventName };