@envive-ai/react-hooks 0.3.7 → 0.3.9

package/src/mocks/salesAgentMockData.ts

@@ -0,0 +1,247 @@
+import { SuggestionCategory } from '@spiffy-ai/commerce-api-client';
+import { Message, MessageRole, MessageType, Suggestion } from 'src/application/models';
+import { MockSalesAgentData } from 'src/contexts/salesAgentContext/salesAgentContext';
+
+export const mockMessages: Message[][] = [
+  // Welcome message
+  [
+    {
+      id: 'welcome-msg-1',
+      role: MessageRole.Assistant,
+      type: MessageType.Text,
+      createdAt: new Date(Date.now() - 310000).toISOString(),
+      metadata: {
+        content: 'Hello! How can I assist you today?',
+      },
+    },
+  ],
+  // User message
+  [
+    {
+      id: 'user-msg-1',
+      role: MessageRole.User,
+      type: MessageType.QueryTyped,
+      createdAt: new Date(Date.now() - 300000).toISOString(),
+      metadata: {
+        content: 'What are your best products?',
+      },
+    },
+  ],
+
+  // Assistant text response
+  [
+    {
+      id: 'agent-msg-1',
+      role: MessageRole.Assistant,
+      type: MessageType.Text,
+      createdAt: new Date(Date.now() - 290000).toISOString(),
+      metadata: {
+        content: 'Here are some of our best-selling products that customers love!',
+      },
+    },
+  ],
+  // Product carousel
+  [
+    {
+      id: 'product-1',
+      role: MessageRole.Assistant,
+      type: MessageType.Product,
+      createdAt: new Date(Date.now() - 280000).toISOString(),
+      metadata: {
+        id: 'product-1',
+        title: 'Leather Tote Bag',
+        salePrice: 89.99,
+        originalPrice: 129.99,
+        averageRating: 4.7,
+        numberReviews: 127,
+        url: 'https://example.com/product/leather-tote',
+        imageUrl: 'https://picsum.photos/400/400?random=1',
+        isForGrid: false,
+      },
+    },
+    {
+      id: 'product-2',
+      role: MessageRole.Assistant,
+      type: MessageType.Product,
+      createdAt: new Date(Date.now() - 280000).toISOString(),
+      metadata: {
+        id: 'product-2',
+        title: 'Designer Handbag',
+        salePrice: 199.99,
+        originalPrice: 249.99,
+        averageRating: 4.5,
+        numberReviews: 89,
+        url: 'https://example.com/product/designer-handbag',
+        imageUrl: 'https://picsum.photos/400/400?random=2',
+        isForGrid: false,
+      },
+    },
+    {
+      id: 'product-3',
+      role: MessageRole.Assistant,
+      type: MessageType.Product,
+      createdAt: new Date(Date.now() - 280000).toISOString(),
+      metadata: {
+        id: 'product-3',
+        title: 'Classic Shoulder Bag',
+        salePrice: 125.0,
+        originalPrice: 150.0,
+        averageRating: 4.8,
+        numberReviews: 203,
+        url: 'https://example.com/product/shoulder-bag',
+        imageUrl: 'https://picsum.photos/400/400?random=3',
+        isForGrid: false,
+      },
+    },
+  ],
+  // User message asking about reviews
+  [
+    {
+      id: 'user-msg-2',
+      role: MessageRole.User,
+      type: MessageType.QueryTyped,
+      createdAt: new Date(Date.now() - 200000).toISOString(),
+      metadata: {
+        content: 'What do customers say about these products?',
+      },
+    },
+  ],
+  // Assistant text response
+  [
+    {
+      id: 'agent-msg-2',
+      role: MessageRole.Assistant,
+      type: MessageType.Text,
+      createdAt: new Date(Date.now() - 190000).toISOString(),
+      metadata: {
+        content: 'Here are some recent customer reviews:',
+      },
+    },
+  ],
+  // Review carousel
+  [
+    {
+      id: 'review-1',
+      role: MessageRole.Assistant,
+      type: MessageType.Review,
+      createdAt: new Date(Date.now() - 180000).toISOString(),
+      metadata: {
+        id: 'review-1',
+        productId: 'product-1',
+        reviewer: 'Sarah M.',
+        review:
+          'Absolutely love this bag! The quality is outstanding and it fits everything I need. Highly recommend!',
+        stars: 5,
+      },
+    },
+    {
+      id: 'review-2',
+      role: MessageRole.Assistant,
+      type: MessageType.Review,
+      createdAt: new Date(Date.now() - 180000).toISOString(),
+      metadata: {
+        id: 'review-2',
+        productId: 'product-2',
+        reviewer: 'Jessica K.',
+        review:
+          'Beautiful design and great craftsmanship. The leather feels premium and the bag is very spacious.',
+        stars: 5,
+      },
+    },
+    {
+      id: 'review-3',
+      role: MessageRole.Assistant,
+      type: MessageType.Review,
+      createdAt: new Date(Date.now() - 180000).toISOString(),
+      metadata: {
+        id: 'review-3',
+        productId: 'product-3',
+        reviewer: 'Emily R.',
+        review: 'Perfect size and style. I get compliments every time I use it. Worth every penny!',
+        stars: 5,
+      },
+    },
+  ],
+  // User message asking about help pages
+  [
+    {
+      id: 'user-msg-3',
+      role: MessageRole.User,
+      type: MessageType.QueryTyped,
+      createdAt: new Date(Date.now() - 100000).toISOString(),
+      metadata: {
+        content: 'How do I return an item?',
+      },
+    },
+  ],
+  // Assistant text response with link
+  [
+    {
+      id: 'agent-msg-3',
+      role: MessageRole.Assistant,
+      type: MessageType.Text,
+      createdAt: new Date(Date.now() - 90000).toISOString(),
+      metadata: {
+        content:
+          'You can return items within 30 days of purchase. Visit our returns page at [returns](https://example.com/returns) for more information.',
+      },
+    },
+  ],
+  // Page/document carousel
+  [
+    {
+      id: 'page-1',
+      role: MessageRole.Assistant,
+      type: MessageType.Page,
+      createdAt: new Date(Date.now() - 80000).toISOString(),
+      metadata: {
+        id: 'page-1',
+        title: 'Return Policy',
+        description:
+          'Learn about our return policy, including timeframes, conditions, and how to initiate a return.',
+        url: 'https://example.com/returns',
+      },
+    },
+    {
+      id: 'page-2',
+      role: MessageRole.Assistant,
+      type: MessageType.Page,
+      createdAt: new Date(Date.now() - 80000).toISOString(),
+      metadata: {
+        id: 'page-2',
+        title: 'Shipping Information',
+        description: 'Find out about shipping options, delivery times, and tracking your order.',
+        url: 'https://example.com/shipping',
+      },
+    },
+  ],
+];
+
+export const mockSuggestions: Suggestion[] = [
+  {
+    id: 'suggestion-1',
+    category: SuggestionCategory.ProductBased,
+    content: 'What are the best products for gifting?',
+    createdAt: new Date().toISOString(),
+    isAnswer: false,
+  },
+  {
+    id: 'suggestion-2',
+    category: SuggestionCategory.ProductBased,
+    content: 'Show me summer dresses',
+    createdAt: new Date().toISOString(),
+    isAnswer: false,
+  },
+  {
+    id: 'suggestion-3',
+    category: SuggestionCategory.ProductBased,
+    content: 'Do you have free shipping?',
+    createdAt: new Date().toISOString(),
+    isAnswer: false,
+  },
+];
+
+export const mockSalesAgentData: MockSalesAgentData = {
+  messages: mockMessages,
+  suggestions: mockSuggestions,
+};

package/src/services/amplitudeService/__tests__/amplitudeService.test.ts

@@ -74,6 +74,8 @@ describe('AmplitudeService', () => {
       amplitudeApiKey: 'test-api-key',
       dataResidency: 'US',
       env: 'test',
+      orgId: 'test-org-id',
+      show: true,
       contextSource: 'app',
       orgShortName: 'test-org',
       featureFlagService,
@@ -104,6 +106,9 @@ describe('AmplitudeService', () => {
         amplitudeApiKey: 'test-api-key',
         dataResidency: 'US',
         env: 'test',
+        orgId: 'test-org-id',
+        show: true,
+        getLocalStorageItem: mockGetLocalStorageItem,
         contextSource: 'app',
         orgShortName: 'test-org',
         featureFlagService,
@@ -118,6 +123,9 @@ describe('AmplitudeService', () => {
         amplitudeApiKey: '',
         dataResidency: 'US',
         env: 'test',
+        orgId: 'test-org-id',
+        show: true,
+        getLocalStorageItem: mockGetLocalStorageItem,
         contextSource: 'app',
         orgShortName: 'test-org',
         featureFlagService,
@@ -132,6 +140,9 @@ describe('AmplitudeService', () => {
         amplitudeApiKey: 'test-api-key',
         dataResidency: 'US',
         env: 'test',
+        orgId: 'test-org-id',
+        show: true,
+        getLocalStorageItem: mockGetLocalStorageItem,
         contextSource: 'app',
         orgShortName: 'test-org',
         featureFlagService: null as any,
@@ -238,6 +249,9 @@ describe('AmplitudeService', () => {
         amplitudeApiKey: 'test-api-key',
         dataResidency: 'US',
         env: 'test',
+        orgId: 'test-org-id',
+        show: true,
+        getLocalStorageItem: mockGetLocalStorageItem,
         contextSource: 'app',
         orgShortName: 'test-org',
         featureFlagService,
@@ -375,6 +389,9 @@ describe('AmplitudeService', () => {
         amplitudeApiKey: 'test-api-key',
         dataResidency: 'US',
         env: 'test',
+        orgId: 'test-org-id',
+        show: true,
+        getLocalStorageItem: null,
         contextSource: 'app',
         orgShortName: 'test-org',
         featureFlagService,

package/src/services/amplitudeService/amplitudeService.ts

@@ -9,9 +9,12 @@ import type {
   ServerZoneType,
 } from '@amplitude/analytics-types';
 import { FeatureFlagService } from 'src/contexts/featureFlagServiceContext/featureFlagServiceContext';
+import { WidgetTypeV3 } from 'src/contexts/typesV3';
+import { ChatElementDisplayLocationV3 } from 'src/application/models/chatElementDisplayLocationV3';
 
 export enum SpiffyMetricsEventName {
   BundleLoaded = 'Bundle Loaded',
+  EnvironmentInitialized = 'Environment Initialized',
   ChatLiveAgentBtnClick = 'Chat Live Agent Btn Click',
   ChatFloatingButtonVisible = 'Chat Floating Button Visible',
   ChatComponentVisible = 'Chat Component Visible',
@@ -57,10 +60,12 @@ export interface AmplitudeServiceConfig {
   env: string;
   contextSource: string;
   orgShortName: string;
+  orgId: string;
   featureFlagService: FeatureFlagService;
   orgGaConfig?: unknown;
-  show?: boolean;
-  getLocalStorageItem?: (key: string) => string | null;
+  show: boolean;
+  enabledFeatures?: Record<string, boolean>;
+  getLocalStorageItem: null | ((key: string) => string | null);
 }
 
 export class AmplitudeService {
@@ -123,6 +128,7 @@ export class AmplitudeService {
       chat_id: this.getLocalStorageItem(LocalStorageKeys.ChatId),
       env: this.config.env || 'unknown',
       app_source: this.config.contextSource,
+      org_id: this.config.orgId,
       'org.short_name': this.config.orgShortName,
       'user.id': this.config.userId,
       'cdp.user_id': null,
@@ -173,11 +179,11 @@ export class AmplitudeService {
           if (this.config.show != null) {
             globalProperties['globalProperties.show'] = String(this.config.show);
           }
+          globalProperties['globalProperties.env'] = String(this.config.env);
 
-          const enabledFeatures = this.config.featureFlagService.getFeatureFlags();
-          const enabledFeaturesProperties = Object.entries(enabledFeatures).reduce<
-            Record<string, string>
-          >(
+          const enabledFeaturesProperties = Object.entries(
+            this.config?.enabledFeatures ?? ({} as Record<string, boolean>),
+          ).reduce<Record<string, string>>(
             (acc, [key, value]) => ({
               ...acc,
               [`enabledFeatures.${key}`]: `${value}`,
@@ -251,6 +257,91 @@ export class AmplitudeService {
     }
   }
 
+  static mapWidgetTypeToChatComponent(widgetType: unknown): string {
+    switch (widgetType) {
+      case WidgetTypeV3.FloatingButtonV3:
+        return 'floating_button';
+      case WidgetTypeV3.ChatPreviewV3:
+      case WidgetTypeV3.SocialProofV3:
+        return 'embedded_widget';
+      case WidgetTypeV3.TitledPromptCarouselV3:
+      case WidgetTypeV3.PromptCarouselV3:
+        return 'suggestion_bar';
+      case WidgetTypeV3.ProductCardV3:
+        return 'image_prompt_card';
+      default:
+        return 'unknown';
+    }
+  }
+
+  static mapTriggerLocationToChatComponent(triggerLocation: unknown): string {
+    switch (triggerLocation) {
+      case ChatElementDisplayLocationV3.PRODUCT_CARD_PROMPT_BUTTON:
+      case ChatElementDisplayLocationV3.PRODUCT_CARD_TEXT_FIELD:
+        return 'prompt_card';
+      case ChatElementDisplayLocationV3.PROMPT_CAROUSEL:
+      case ChatElementDisplayLocationV3.TITLED_PROMPT_CAROUSEL:
+        return 'top_reviews_snippet';
+      case ChatElementDisplayLocationV3.TYPING_ANIMATION:
+      case ChatElementDisplayLocationV3.SOCIAL_PROOF_PRIMARY_BUTTON:
+      case ChatElementDisplayLocationV3.SOCIAL_PROOF_SECONDARY_BUTTON:
+      case ChatElementDisplayLocationV3.SOCIAL_PROOF_TEXT_FIELD:
+      case ChatElementDisplayLocationV3.CHAT_PREVIEW_COMPARISON_PROMPT_BUTTON:
+      case ChatElementDisplayLocationV3.CHAT_PREVIEW_COMPARISON_TEXT_FIELD:
+      case ChatElementDisplayLocationV3.CHAT_PREVIEW_PROMPT_BUTTON:
+      case ChatElementDisplayLocationV3.CHAT_PREVIEW_TEXT_FIELD:
+        return 'chat_preview';
+      case ChatElementDisplayLocationV3.FLOATING_CHAT_OVERLAY:
+      case ChatElementDisplayLocationV3.FLOATING_CHAT_CLOSE_BUTTON:
+        return 'in_chat';
+      default:
+        return triggerLocation as string;
+    }
+  }
+
+  // This allows us to map the event props to the correct format for the legacy amplitude events
+  static mapEventProps({ eventName, eventProps }: TrackEventParams): Record<string, unknown> {
+    const messageMetadata = eventProps?.message_metadata ?? {};
+    const triggerLocation =
+      messageMetadata !== null &&
+      typeof messageMetadata === 'object' &&
+      'trigger_location' in messageMetadata
+        ? messageMetadata.trigger_location
+        : undefined;
+
+    if (eventName === SpiffyMetricsEventName.ChatComponentExpanded) {
+      const mappedTriggerLoccation =
+        AmplitudeService.mapTriggerLocationToChatComponent(triggerLocation);
+      return {
+        ...eventProps,
+        message_metadata: {
+          ...messageMetadata,
+          trigger_location: mappedTriggerLoccation,
+          full_trigger_location: triggerLocation,
+        },
+      };
+    }
+
+    if (eventName === SpiffyMetricsEventName.ChatComponentVisible) {
+      const mappedWidgetType = AmplitudeService.mapWidgetTypeToChatComponent(
+        eventProps?.widget_type,
+      );
+      const mappedTriggerLoccation =
+        AmplitudeService.mapTriggerLocationToChatComponent(triggerLocation);
+      return {
+        ...eventProps,
+        message_metadata: {
+          ...messageMetadata,
+          trigger_location: mappedTriggerLoccation,
+          full_trigger_location: triggerLocation,
+        },
+        chat_component: mappedWidgetType,
+        'chat.component_visible': true,
+      };
+    }
+    return eventProps ?? {};
+  }
+
   async trackEvent({
     eventName,
     eventProps,
@@ -268,9 +359,11 @@ export class AmplitudeService {
         return;
       }
 
+      const mappedEventProps = AmplitudeService.mapEventProps({ eventName, eventProps });
+
       const eventData = JSON.stringify({
         eventName,
-        eventProps,
+        eventProps: mappedEventProps,
         created_at: new Date().toISOString(),
       });
       const encoder = new TextEncoder();
@@ -283,15 +376,17 @@ export class AmplitudeService {
 
       Logger.logDebug(`amplitude tracking ${decoratedEventName}`, null, {
         event_name: decoratedEventName,
-        props: eventProps,
+        props: mappedEventProps,
       });
 
       this.amplitudeClient.track(
         decoratedEventName,
         {
           ...this.getDefaultTrackingProps(),
-          ...eventProps,
-          ...(eventProps ? this.eventPropsToPrefixedEventProps(eventName, eventProps) : {}),
+          ...mappedEventProps,
+          ...(mappedEventProps
+            ? this.eventPropsToPrefixedEventProps(eventName, mappedEventProps)
+            : {}),
         },
         {
           ...eventGroups,
@@ -320,6 +415,6 @@ export class AmplitudeService {
 
   // Ensure that supplemental default props are merged with the existing props
   setSupplementalDefaultProps(props: Record<string, unknown>): void {
-    this.supplementalDefaultProps = { ...this.supplementalDefaultProps, ...props };
+    this.supplementalDefaultProps = props;
   }
 }

package/src/services/userIdentityService/index.ts

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

package/src/services/userIdentityService/userIdentityService.ts

@@ -0,0 +1,64 @@
+import { EnviveAnalytics } from '@envive-ai/analytics';
+import Logger from 'src/application/logging/logger';
+import { getAtomStore } from 'src/atoms/atomStore';
+import { userIdAtom } from 'src/atoms/app';
+import { ExecutionContext } from '@envive-ai/analytics/dist/analytics/EnviveAnalytics';
+
+type UserIdentityServiceProps = {
+  apiKey: string;
+};
+
+export class UserIdentityService {
+  private readonly apiKey: string;
+
+  private readonly USER_ID_OVERRIDE_KEY = 'v1-spiffy-user-id-override';
+
+  constructor({ apiKey }: UserIdentityServiceProps) {
+    this.apiKey = apiKey;
+  }
+
+  getUserIdOverrideFromLocalStorage(): string | undefined {
+    Logger.logDebug('[spiffy-ai] Getting userID from localStorage');
+    return localStorage.getItem(this.USER_ID_OVERRIDE_KEY) ?? undefined;
+  }
+
+  async getUserIdOrDefault(): Promise<string> {
+    const userIdOverride = this.getUserIdOverrideFromLocalStorage();
+    if (userIdOverride) {
+      return userIdOverride;
+    }
+
+    try {
+      Logger.logDebug('Getting userID via EnviveAnalytics in UserIdentityService');
+      const enviveAnalytics = new EnviveAnalytics({
+        apiKey: this.apiKey,
+        environmentInfo: { executionContext: ExecutionContext.EnviveReactComponentsV3 },
+      });
+      const enviveUserId = await enviveAnalytics.resolveEnviveUserId();
+
+      if (!enviveUserId) {
+        throw new Error(
+          '[spiffy-ai] EnviveAnalytics.resolveEnviveUserId() returned null/undefined',
+        );
+      }
+
+      return enviveUserId;
+    } catch (error: unknown) {
+      Logger.logError('[spiffy-ai] CRITICAL: Failed to get user ID:', error);
+      const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+      throw new Error(`[spiffy-ai] CRITICAL: User ID resolution failed: ${errorMessage}`);
+    }
+  }
+
+  async initializeUser(atomStore?: ReturnType<typeof getAtomStore>): Promise<void> {
+    try {
+      const userId = await this.getUserIdOrDefault();
+
+      const store = atomStore || getAtomStore();
+      store.set(userIdAtom, userId);
+    } catch (error) {
+      Logger.logError('[spiffy-ai] CRITICAL: Failed to initialize user ID:', error);
+      throw error;
+    }
+  }
+}

package/dist/_virtual/rolldown_runtime.js

@@ -1,29 +0,0 @@
-//#region rolldown:runtime
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __commonJSMin = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports, mod), mod.exports);
-var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") {
-		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-			key = keys[i];
-			if (!__hasOwnProp.call(to, key) && key !== except) {
-				__defProp(to, key, {
-					get: ((k) => from[k]).bind(null, key),
-					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-				});
-			}
-		}
-	}
-	return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-	value: mod,
-	enumerable: true
-}) : target, mod));
-
-//#endregion
-export { __commonJSMin, __toESM };