@envive-ai/react-hooks 0.3.10 → 0.3.12

package/src/services/amplitudeService/amplitudeService.ts

@@ -46,8 +46,20 @@ export enum SpiffyMetricsEventName {
   SearchSortClicked = 'Search Sort Clicked',
 }
 
+export enum EnviveMetricsEventName {
+  WidgetRendered = 'Widget Rendered',
+  WidgetInteraction = 'Widget Interaction',
+  ChatRequest = 'Chat Request',
+  ChatResponse = 'Chat Response',
+  EnviveInitialized = 'Envive Initialized',
+  PageViewed = 'Page Viewed', // Will this be useful?
+  WidgetTextRequest = 'Widget Text Request',
+  WidgetTextResponse = 'Widget Text Response',
+  WidgetTextClicked = 'Widget Text Clicked',
+}
+
 export interface TrackEventParams {
-  eventName: SpiffyMetricsEventName;
+  eventName: SpiffyMetricsEventName | EnviveMetricsEventName;
   eventProps?: Record<string, unknown>;
   eventGroups?: Record<string, unknown>;
   alsoSendToGoogleAnalytics?: boolean;
@@ -64,6 +76,7 @@ export interface AmplitudeServiceConfig {
   featureFlagService: FeatureFlagService;
   orgGaConfig?: unknown;
   show: boolean;
+  enviveOn: boolean;
   enabledFeatures?: Record<string, boolean>;
   getLocalStorageItem: null | ((key: string) => string | null);
 }
@@ -101,7 +114,9 @@ export class AmplitudeService {
     return null;
   }
 
-  private getDefaultTrackingProps(): Record<string, unknown> {
+  private getDefaultTrackingProps(
+    eventName: SpiffyMetricsEventName | EnviveMetricsEventName,
+  ): Record<string, unknown> {
     const featureGates = Object.entries(this.config.featureFlagService.getFeatureFlags());
     const gatesProps =
       featureGates.length > 0
@@ -114,16 +129,32 @@ export class AmplitudeService {
         : {};
     const experimentProps = {}; // No direct equivalent for experiments in EnviveConfig yet
 
-    const orgLevelAmplitudeTrackingProps = {
-      ...gatesProps,
-      ...experimentProps,
+    const environmentProps = {
+      'environment.execution_context': 'bundle',
+      'environment.page_url': window.location.href,
+      'environment.envive_user_id': this.config.userId,
+      'environment.execution_environment': this.config.env || 'unknown',
+      'environment.context_source': this.config.contextSource,
+      'environment.sales_agent_enabled': this.config.enabledFeatures?.salesAgent ?? false,
+      'environment.search_enabled': this.config.enabledFeatures?.searchAgent ?? false,
+      'environment.envive_on_query_param': this.config.enviveOn,
+      'environment.window_show': this.config.show,
+      'environment.envive_enabled': this.config.enabledFeatures?.envive,
     };
 
+    const orgLevelAmplitudeTrackingProps = AmplitudeService.isEnviveEvent(eventName)
+      ? {
+          ...this.config.featureFlagService.getFullFlagValues(),
+          ...experimentProps,
+          ...environmentProps,
+        }
+      : {
+          ...gatesProps,
+          ...experimentProps,
+        };
     return {
       ...orgLevelAmplitudeTrackingProps,
       ...this.supplementalDefaultProps,
-      // TODO: org_id is not directly available in EnviveConfig. Need to find a new source or derive it.
-      // org_id: orgConfig?.org?.org?.id,
       app_id: 'commerce-chat-react-component',
       chat_id: this.getLocalStorageItem(LocalStorageKeys.ChatId),
       env: this.config.env || 'unknown',
@@ -143,7 +174,7 @@ export class AmplitudeService {
 
   // eslint-disable-next-line class-methods-use-this
   private eventPropsToPrefixedEventProps(
-    eventName: SpiffyMetricsEventName,
+    eventName: SpiffyMetricsEventName | EnviveMetricsEventName,
     eventProps: Record<string, unknown>,
   ): Record<string, unknown> {
     const prefix = eventName.toLowerCase().replace(/\s+/g, '_');
@@ -200,7 +231,9 @@ export class AmplitudeService {
             ...event,
             event_properties: {
               ...event.event_properties,
-              ...this.getDefaultTrackingProps(),
+              ...this.getDefaultTrackingProps(
+                event.event_type as SpiffyMetricsEventName | EnviveMetricsEventName,
+              ),
               ...globalProperties,
               ...enabledFeaturesProperties,
               ...timingProperties,
@@ -342,6 +375,17 @@ export class AmplitudeService {
     return eventProps ?? {};
   }
 
+  static isEnviveEvent(eventName: SpiffyMetricsEventName | EnviveMetricsEventName): boolean {
+    return Object.values(EnviveMetricsEventName).includes(eventName as EnviveMetricsEventName);
+  }
+
+  static decorateEventName(eventName: SpiffyMetricsEventName | EnviveMetricsEventName): string {
+    if (AmplitudeService.isEnviveEvent(eventName)) {
+      return `[Envive] ${eventName}`;
+    }
+    return `[Spiffy] ${eventName}`;
+  }
+
   async trackEvent({
     eventName,
     eventProps,
@@ -350,7 +394,7 @@ export class AmplitudeService {
   }: TrackEventParams): Promise<void> {
     Logger.logDebug('Submitting event', eventName);
     try {
-      const decoratedEventName = `[Spiffy] ${eventName}`;
+      const decoratedEventName = AmplitudeService.decorateEventName(eventName);
 
       if (!this.amplitudeClient) {
         Logger.logWarn('amplitude client undefined', undefined, {
@@ -382,7 +426,7 @@ export class AmplitudeService {
       this.amplitudeClient.track(
         decoratedEventName,
         {
-          ...this.getDefaultTrackingProps(),
+          ...this.getDefaultTrackingProps(eventName),
           ...mappedEventProps,
           ...(mappedEventProps
             ? this.eventPropsToPrefixedEventProps(eventName, mappedEventProps)

package/src/types/enviveConfig.ts

@@ -1,4 +1,6 @@
 import { FrontendConfigOverrides, VariantInfo } from 'src/application/models';
+import type { HardcopyResponse } from 'src/contexts/hardcopyContext/hardcopyContext';
+import type { WidgetTypeV3 } from 'src/contexts/typesV3';
 
 export interface EnviveConfig {
   publicKey?: string;
@@ -15,6 +17,7 @@ export interface EnviveConfig {
   initialOpenSearchOverlay?: boolean;
   WidgetMountingOverride?: Record<string, any>[];
   configChanges?: FrontendConfigOverrides[];
+  hardcopyOverride?: Partial<Record<WidgetTypeV3, HardcopyResponse>>;
 }
 
 declare global {