@envive-ai/react-hooks 0.2.10 → 0.2.11

package/src/contexts/amplitudeContext/amplitudeContext.tsx

@@ -1,71 +1,60 @@
-import React, {
-  createContext,
-  useContext,
-  useCallback,
-  useMemo,
-  useEffect,
-} from "react";
-import { useAtomValue } from "jotai";
-import { createInstance } from "@amplitude/analytics-browser";
-import { FeatureGates } from "src/application/models/featureGates";
-import { OrgShortName } from "src/application/models";
-import { EventsDispatcher, SpiffyEvent } from "src/events";
+import React, { createContext, useContext, useCallback, useMemo, useEffect } from 'react';
+import { useAtomValue } from 'jotai';
+import { createInstance } from '@amplitude/analytics-browser';
+import { FeatureGates } from 'src/application/models/featureGates';
+import { OrgShortName } from 'src/application/models';
+import { EventsDispatcher, SpiffyEvent } from 'src/events';
 import {
   amplitudeApiKeyAtom,
   contextSourceAtom,
   dataResidencyAtom,
   identifyingPrefixAtom,
-} from "src/atoms/envive/enviveConfig";
-import {
-  LocalStorageKeys,
-  useLocalStorage,
-} from "src/contexts/localStorageContext";
-import { orgAnalyticsGoogleAnalyticsConfigAtom } from "src/atoms/org/orgAnalyticsConfig";
-import { userIdAtom } from "src/atoms/app";
-import { envAtom } from "src/atoms/envive/enviveConfig";
-import Logger from "src/application/logging/logger";
+} from 'src/atoms/envive/enviveConfig';
+import { LocalStorageKeys, useLocalStorage } from 'src/contexts/localStorageContext';
+import { orgAnalyticsGoogleAnalyticsConfigAtom } from 'src/atoms/org/orgAnalyticsConfig';
+import { userIdAtom } from 'src/atoms/app';
+import { envAtom } from 'src/atoms/envive/enviveConfig';
+import Logger from 'src/application/logging/logger';
 import type {
   BrowserClient,
   EnrichmentPlugin,
   Event,
   ServerZoneType,
-} from "@amplitude/analytics-types";
-import { useEnviveConfig } from "src/contexts/enviveConfigContext/enviveConfigContext";
-import {
-  useFeatureFlagService,
-} from "src/contexts/featureFlagServiceContext/featureFlagServiceContext";
+} from '@amplitude/analytics-types';
+import { useEnviveConfig } from 'src/contexts/enviveConfigContext/enviveConfigContext';
+import { useFeatureFlagService } from 'src/contexts/featureFlagServiceContext/featureFlagServiceContext';
 
 export enum SpiffyMetricsEventName {
-  BundleLoaded = "Bundle Loaded",
-  ChatLiveAgentBtnClick = "Chat Live Agent Btn Click",
-  ChatFloatingButtonVisible = "Chat Floating Button Visible",
-  ChatComponentVisible = "Chat Component Visible",
-  ChatComponentExpanded = "Chat Component Expanded",
-  ChatComponentCollapsed = "Chat Component Collapsed",
-  ChatUserMessageInput = "Chat User Message Input",
-  ChatSuggestionClicked = "Chat Suggestion Clicked",
-  ChatAssistantResponse = "Chat Assistant Response",
-  ProductCardClicked = "Product Card Clicked",
-  ProductReviewCardClicked = "Product Review Card Clicked",
-  AddToCartClicked = "Add to Cart Clicked",
-  PromptCardClicked = "Prompt Card Clicked",
-  SupportedEvent = "Supported Event",
-  SearchBackToResponseClicked = "Search Back to Response Clicked",
-  PerformanceMetrics = "Performance Metrics",
-  SearchBarClicked = "Search Bar Clicked",
-  OrderLookupStarted = "Order Lookup Started",
-  OrderLookupFormSubmitted = "Order Lookup Form Submitted",
-  SearchComponentVisible = "Search Component Visible",
-  SearchZeroStateSuggestionClicked = "Search Zero State Suggestion Clicked", // This is the scrolling list of suggestion buttons in global search
-  SearchInputStarted = "Search Input Started",
-  SearchQuerySubmitted = "Search Query Submitted",
+  BundleLoaded = 'Bundle Loaded',
+  ChatLiveAgentBtnClick = 'Chat Live Agent Btn Click',
+  ChatFloatingButtonVisible = 'Chat Floating Button Visible',
+  ChatComponentVisible = 'Chat Component Visible',
+  ChatComponentExpanded = 'Chat Component Expanded',
+  ChatComponentCollapsed = 'Chat Component Collapsed',
+  ChatUserMessageInput = 'Chat User Message Input',
+  ChatSuggestionClicked = 'Chat Suggestion Clicked',
+  ChatAssistantResponse = 'Chat Assistant Response',
+  ProductCardClicked = 'Product Card Clicked',
+  ProductReviewCardClicked = 'Product Review Card Clicked',
+  AddToCartClicked = 'Add to Cart Clicked',
+  PromptCardClicked = 'Prompt Card Clicked',
+  SupportedEvent = 'Supported Event',
+  SearchBackToResponseClicked = 'Search Back to Response Clicked',
+  PerformanceMetrics = 'Performance Metrics',
+  SearchBarClicked = 'Search Bar Clicked',
+  OrderLookupStarted = 'Order Lookup Started',
+  OrderLookupFormSubmitted = 'Order Lookup Form Submitted',
+  SearchComponentVisible = 'Search Component Visible',
+  SearchZeroStateSuggestionClicked = 'Search Zero State Suggestion Clicked', // This is the scrolling list of suggestion buttons in global search
+  SearchInputStarted = 'Search Input Started',
+  SearchQuerySubmitted = 'Search Query Submitted',
   // SearchAutocompleteViewed = 'Search Autocomplete Viewed', // TODO: add this when autocomplete is added
   // SearchAutocompleteClicked = 'Search Autocomplete Clicked', // TODO: add this when autocomplete is added
-  SearchResultsViewed = "Search Results Viewed",
-  SearchTimeToFirstClick = "Search Time to First Click",
-  SearchZeroResultsRate = "Search Zero Results Rate",
-  SearchFilterClicked = "Search Filter Clicked",
-  SearchSortClicked = "Search Sort Clicked",
+  SearchResultsViewed = 'Search Results Viewed',
+  SearchTimeToFirstClick = 'Search Time to First Click',
+  SearchZeroResultsRate = 'Search Zero Results Rate',
+  SearchFilterClicked = 'Search Filter Clicked',
+  SearchSortClicked = 'Search Sort Clicked',
 }
 
 interface TrackEventParams {
@@ -83,9 +72,7 @@ interface AmplitudeContextType {
 
 const AmplitudeContext = createContext<AmplitudeContextType | null>(null);
 
-export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
-  children,
-}) => {
+export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({ children }) => {
   const userId = useAtomValue(userIdAtom);
   const amplitudeApiKey = useAtomValue(amplitudeApiKeyAtom);
   const dataResidency = useAtomValue(dataResidencyAtom);
@@ -106,17 +93,17 @@ export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
 
   const { featureFlagService } = useFeatureFlagService();
 
-  const [amplitudeClient, setAmplitudeClient] = React.useState<
-    BrowserClient | undefined
+  const [amplitudeClient, setAmplitudeClient] = React.useState<BrowserClient | undefined>(
+    undefined,
+  );
+  const [internalEventTrackingEnrichment, setInternalEventTrackingEnrichment] = React.useState<
+    EnrichmentPlugin | undefined
   >(undefined);
-  const [internalEventTrackingEnrichment, setInternalEventTrackingEnrichment] =
-    React.useState<EnrichmentPlugin | undefined>(undefined);
-  const [supplementalDefaultProps, setSupplementalDefaultProps] =
-    React.useState<Record<string, unknown>>({});
+  const [supplementalDefaultProps, setSupplementalDefaultProps] = React.useState<
+    Record<string, unknown>
+  >({});
 
-  const isReady = Boolean(
-    userId && featureFlagService && amplitudeApiKey
-  );
+  const isReady = Boolean(userId && featureFlagService && amplitudeApiKey);
 
   const getDefaultTrackingProps = useCallback((): Record<string, unknown> => {
     const gatesProps = featureGates
@@ -139,56 +126,50 @@ export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
       ...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",
+      app_id: 'commerce-chat-react-component',
       chat_id: getItem(LocalStorageKeys.ChatId),
-      env: env || "unknown",
+      env: env || 'unknown',
       app_source: contextSource,
-      "org.short_name": orgShortName,
-      "user.id": userId,
-      "cdp.user_id": null,
-      "cdp.provider": null,
-      "event.source": "web-browser",
-      "event.type": "user-activity",
-      "event.id": null,
-      "event.channel": "web",
-      "event.timestamp": null,
+      'org.short_name': orgShortName,
+      'user.id': userId,
+      'cdp.user_id': null,
+      'cdp.provider': null,
+      'event.source': 'web-browser',
+      'event.type': 'user-activity',
+      'event.id': null,
+      'event.channel': 'web',
+      'event.timestamp': null,
     };
-  }, [
-    featureGates,
-    supplementalDefaultProps,
-    env,
-    contextSource,
-    orgShortName,
-    userId,
-  ]);
+  }, [featureGates, supplementalDefaultProps, env, contextSource, orgShortName, userId]);
 
   const eventPropsToPrefixedEventProps = useCallback(
     (
       eventName: SpiffyMetricsEventName,
-      eventProps: Record<string, unknown>
+      eventProps: Record<string, unknown>,
     ): Record<string, unknown> => {
-      const prefix = eventName.toLowerCase().replace(/\s+/g, "_");
-      return Object.entries(eventProps).reduce((acc, [key, value]) => {
-        acc[`${prefix}.${key}`] = value;
-        return acc;
-      }, {} as Record<string, unknown>);
+      const prefix = eventName.toLowerCase().replace(/\s+/g, '_');
+      return Object.entries(eventProps).reduce(
+        (acc, [key, value]) => {
+          acc[`${prefix}.${key}`] = value;
+          return acc;
+        },
+        {} as Record<string, unknown>,
+      );
     },
-    []
+    [],
   );
 
   const amplitudeSessionReplayInit = useCallback((): boolean => {
     const isEnabled = Boolean(
       orgShortName === OrgShortName.UniqueVintage &&
         featureFlagService?.isClientSessionEnabled() &&
-        featureFlagService?.isFeatureGateEnabled(
-          FeatureGates.IsNewFeatureEnabled
-        )
+        featureFlagService?.isFeatureGateEnabled(FeatureGates.IsNewFeatureEnabled),
     );
     const sampleRate = 1;
 
     try {
       Logger.logDebug(
-        `[spiffy-ai] amplitude session-replay initializing isEnabled=${isEnabled} sampleRate=${sampleRate}`
+        `[spiffy-ai] amplitude session-replay initializing isEnabled=${isEnabled} sampleRate=${sampleRate}`,
       );
 
       if (!isEnabled) {
@@ -199,10 +180,7 @@ export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
 
       return isEnabled;
     } catch (e) {
-      Logger.logError(
-        "[spiffy-ai] Error initializing amplitude session-replay",
-        e
-      );
+      Logger.logError('[spiffy-ai] Error initializing amplitude session-replay', e);
       return false;
     }
   }, [orgShortName, featureFlagService]);
@@ -213,14 +191,14 @@ export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
     }
 
     const enrichment: EnrichmentPlugin = {
-      name: "page-view-tracking-enrichment",
-      type: "enrichment",
+      name: 'page-view-tracking-enrichment',
+      type: 'enrichment',
       setup: async () => undefined,
       execute: async (event: Event): Promise<Event> => {
         let enrichedEvent: Event;
 
         const eventsToEnrich = [
-          "[Amplitude] Page Viewed",
+          '[Amplitude] Page Viewed',
           `[Spiffy] ${SpiffyMetricsEventName.BundleLoaded}`,
         ];
 
@@ -228,39 +206,37 @@ export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
           const globalProperties: Record<string, string> = {};
 
           if (publicKey) {
-            globalProperties["globalProperties.publicKey"] = publicKey;
+            globalProperties['globalProperties.publicKey'] = publicKey;
           }
           if (featureOverrides) {
             Object.entries(featureOverrides).forEach(([key, value]) => {
-              globalProperties[`globalProperties.featureOverrides.${key}`] =
-                String(value);
+              globalProperties[`globalProperties.featureOverrides.${key}`] = String(value);
             });
           }
           if (variantUrlOverride) {
-            globalProperties["globalProperties.variantUrlOverride"] =
-              variantUrlOverride;
+            globalProperties['globalProperties.variantUrlOverride'] = variantUrlOverride;
           }
           if (variantInfoOverride) {
-            globalProperties["globalProperties.variantInfoOverride"] =
+            globalProperties['globalProperties.variantInfoOverride'] =
               JSON.stringify(variantInfoOverride);
           }
           if (show != null) {
-            globalProperties["globalProperties.show"] = String(show);
+            globalProperties['globalProperties.show'] = String(show);
           }
 
           const enabledFeatures = featureFlagService!.getFeatureFlags();
-          const enabledFeaturesProperties = Object.entries(
-            enabledFeatures
-          ).reduce<Record<string, string>>(
+          const enabledFeaturesProperties = Object.entries(enabledFeatures).reduce<
+            Record<string, string>
+          >(
             (acc, [key, value]) => ({
               ...acc,
               [`enabledFeatures.${key}`]: `${value}`,
             }),
-            {}
+            {},
           );
 
           const timingProperties = {
-            "timing.enriched_at_ms": window.performance?.now(),
+            'timing.enriched_at_ms': window.performance?.now(),
           };
 
           enrichedEvent = {
@@ -308,7 +284,7 @@ export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
         autocapture: {
           attribution: true,
           pageViews: {
-            trackHistoryChanges: "pathOnly",
+            trackHistoryChanges: 'pathOnly',
           },
           sessions: isSessionsEnabled,
           formInteractions: false,
@@ -334,12 +310,12 @@ export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
       eventGroups,
       alsoSendToGoogleAnalytics = false,
     }: TrackEventParams): Promise<void> => {
-      Logger.logDebug("Submitting event", eventName);
+      Logger.logDebug('Submitting event', eventName);
       try {
         const decoratedEventName = `[Spiffy] ${eventName}`;
 
         if (!amplitudeClient) {
-          Logger.logWarn("amplitude client undefined", undefined, {
+          Logger.logWarn('amplitude client undefined', undefined, {
             event_name: decoratedEventName,
           });
           return;
@@ -352,13 +328,11 @@ export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
         });
         const encoder = new TextEncoder();
         const data = encoder.encode(eventData);
-         // calculate a hash of the event properties to use as the insert_id so that duplicate events
+        // calculate a hash of the event properties to use as the insert_id so that duplicate events
         // are automatically dropped by Amplitude
-        const hashBuffer = await crypto.subtle.digest("SHA-256", data);
+        const hashBuffer = await crypto.subtle.digest('SHA-256', data);
         const hashArray = Array.from(new Uint8Array(hashBuffer));
-        const currentInsertId = hashArray
-          .map((b) => b.toString(16).padStart(2, "0"))
-          .join("");
+        const currentInsertId = hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
 
         Logger.logDebug(`amplitude tracking ${decoratedEventName}`, null, {
           event_name: decoratedEventName,
@@ -370,19 +344,17 @@ export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
           {
             ...getDefaultTrackingProps(),
             ...eventProps,
-            ...(eventProps
-              ? eventPropsToPrefixedEventProps(eventName, eventProps)
-              : {}),
+            ...(eventProps ? eventPropsToPrefixedEventProps(eventName, eventProps) : {}),
           },
           {
             ...eventGroups,
             insert_id: currentInsertId,
-          }
+          },
         );
 
         if (alsoSendToGoogleAnalytics && orgGaConfig) {
           // TODO: Add in windowDataLayerService or context alternative and hook it up here
-          Logger.logDebug("[spiffy-ai] GA tracking", decoratedEventName);
+          Logger.logDebug('[spiffy-ai] GA tracking', decoratedEventName);
           if (window.dataLayer) {
             (window.dataLayer as any[]).push({
               event: decoratedEventName,
@@ -391,18 +363,13 @@ export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
           }
         }
       } catch (err) {
-        Logger.logError("[spiffy-ai] Error tracking event", err, {
+        Logger.logError('[spiffy-ai] Error tracking event', err, {
           eventName,
           eventProps,
         });
       }
     },
-    [
-      amplitudeClient,
-      getDefaultTrackingProps,
-      eventPropsToPrefixedEventProps,
-      orgGaConfig,
-    ]
+    [amplitudeClient, getDefaultTrackingProps, eventPropsToPrefixedEventProps, orgGaConfig],
   );
 
   const value = useMemo(
@@ -412,25 +379,27 @@ export const AmplitudeProvider: React.FC<{ children: React.ReactNode }> = ({
       setSupplementalDefaultProps: (props: Record<string, unknown>) =>
         setSupplementalDefaultProps(props),
     }),
-    [trackEvent, isReady, setSupplementalDefaultProps]
+    [trackEvent, isReady, setSupplementalDefaultProps],
   );
 
   if (!isReady) {
-    console.log("AmplitudeProvider is not ready", isReady, userId, featureFlagService, amplitudeApiKey);
+    console.log(
+      'AmplitudeProvider is not ready',
+      isReady,
+      userId,
+      featureFlagService,
+      amplitudeApiKey,
+    );
     return null;
   }
 
-  return (
-    <AmplitudeContext.Provider value={value}>
-      {children}
-    </AmplitudeContext.Provider>
-  );
+  return <AmplitudeContext.Provider value={value}>{children}</AmplitudeContext.Provider>;
 };
 
 export const useAmplitude = () => {
   const context = useContext(AmplitudeContext);
   if (!context) {
-    throw new Error("useAmplitude must be used within AmplitudeProvider");
+    throw new Error('useAmplitude must be used within AmplitudeProvider');
   }
   return context;
 };

package/src/contexts/amplitudeContext/index.ts

@@ -1 +1 @@
-export * from "./amplitudeContext";
+export * from './amplitudeContext';

package/src/contexts/cdnContext/cdnContext.tsx

@@ -1,6 +1,6 @@
-import React, { createContext, useContext, useCallback, useMemo } from "react";
-import { useAtomValue } from "jotai";
-import { cdnUrlAtom } from "../../atoms/envive/enviveConfig";
+import React, { createContext, useContext, useCallback, useMemo } from 'react';
+import { useAtomValue } from 'jotai';
+import { cdnUrlAtom } from '../../atoms/envive/enviveConfig';
 
 interface CdnContextType {
   cdnUrl: string;
@@ -10,11 +10,9 @@ interface CdnContextType {
 
 const CdnContext = createContext<CdnContextType | null>(null);
 
-export const CdnProvider: React.FC<{ children: React.ReactNode }> = ({
-  children,
-}) => {
+export const CdnProvider: React.FC<{ children: React.ReactNode }> = ({ children }) => {
   const cdnUrlAtomValue = useAtomValue(cdnUrlAtom);
-  const cdnUrl = cdnUrlAtomValue || "https://cdn.spiffy.ai/other";
+  const cdnUrl = cdnUrlAtomValue || 'https://cdn.spiffy.ai/other';
 
   const getCdnBasePath = useCallback(() => {
     return cdnUrl;
@@ -24,7 +22,7 @@ export const CdnProvider: React.FC<{ children: React.ReactNode }> = ({
     (assetName: string, orgShortName: string) => {
       return `${getCdnBasePath()}/assets/${orgShortName}/${assetName}`;
     },
-    [getCdnBasePath]
+    [getCdnBasePath],
   );
 
   const value = useMemo(
@@ -33,7 +31,7 @@ export const CdnProvider: React.FC<{ children: React.ReactNode }> = ({
       getCdnBasePath,
       getAssetURL,
     }),
-    [cdnUrl, getCdnBasePath, getAssetURL]
+    [cdnUrl, getCdnBasePath, getAssetURL],
   );
 
   return <CdnContext.Provider value={value}>{children}</CdnContext.Provider>;
@@ -42,7 +40,7 @@ export const CdnProvider: React.FC<{ children: React.ReactNode }> = ({
 export const useCdn = () => {
   const context = useContext(CdnContext);
   if (!context) {
-    throw new Error("useCdn must be used within a CdnProvider");
+    throw new Error('useCdn must be used within a CdnProvider');
   }
   return context;
 };

package/src/contexts/cdnContext/index.ts

@@ -1 +1 @@
-export * from "./cdnContext";
+export * from './cdnContext';