@envive-ai/react-hooks 0.3.32 → 0.3.33

package/src/services/hardcopyService/hardcopyService.ts

@@ -0,0 +1,271 @@
+import { v4 as uuid } from 'uuid';
+import CommerceApiClient from 'src/application/commerce-api';
+import { WidgetString, WidgetText } from 'src/application/models/api/widgetText';
+import { WidgetTextRequest } from 'src/application/models/api/widgetTextRequest';
+import { toCamelCase } from 'src/application/models/utils/snakeToCamelTransformer';
+import { getQueryParam } from 'src/application/utils';
+import { UserEvent } from 'src/application/models';
+import Logger from 'src/application/logging/logger';
+import { AppDetails } from 'src/atoms/app';
+import { WidgetTypeV3 } from 'src/contexts/typesV3';
+import { EnviveMetricsEventName, TrackEventParams } from '../amplitudeService';
+
+const logger = new Logger('hardcopyService');
+
+export interface HardcopyRequest {
+  widgetType: WidgetTypeV3;
+  userEvent: UserEvent;
+}
+
+export type HardcopyResponse = {
+  responseId: string;
+  language: string;
+  rawValues?: Record<string, WidgetString | WidgetString[]>;
+  values: Record<string, string | string[]>;
+};
+
+export interface IHardcopyService {
+  getHardcopy(request: HardcopyRequest): Promise<HardcopyResponse>;
+}
+
+export interface HardcopyServiceConfig {
+  getAppDetails: () => AppDetails;
+  getFeatureFlags: () => Record<string, boolean>;
+  trackEvent?: (params: TrackEventParams) => Promise<void>;
+}
+
+// Sample responses used both as fallback when the backend fails and by MockHardcopyService.
+export const MOCK_HARDCOPY_RESPONSE: Partial<Record<WidgetTypeV3, HardcopyResponse>> = {
+  [WidgetTypeV3.PromptCarouselV3]: {
+    responseId: uuid(),
+    language: 'en',
+    values: {
+      promptButtonTexts: [
+        'What are your best sellers?',
+        'Show me summer dresses',
+        'Do you have free shipping?',
+        'What sizes are available?',
+        'Can I return items?',
+      ],
+    },
+  },
+  [WidgetTypeV3.TitledPromptCarouselV3]: {
+    responseId: 'mock-response-id',
+    language: 'en',
+    values: {
+      titleLabel: 'Need some help?',
+      promptButtonTexts: [
+        'What are your best sellers?',
+        'Show me summer dresses',
+        'Do you have free shipping?',
+        'What sizes are available?',
+        'Can I return items?',
+      ],
+    },
+  },
+  [WidgetTypeV3.SocialProofV3]: {
+    responseId: 'mock-response-id',
+    language: 'en',
+    values: {
+      titleLabel: 'Shopping Assistant',
+      numberOfCustomersText: '123 customers',
+      customerQueryText: 'found what they were looking for...',
+      primaryButtonText: 'Start shopping',
+      secondaryButtonTitleText: 'Popular searches',
+      secondaryButtonTexts: [
+        'Why should I buy from you?',
+        'How do I return an item?',
+        'New arrivals',
+        'Sale items',
+        'Popular items',
+      ],
+      textFieldPlaceholderText: 'Ask me anything...',
+    },
+  },
+  [WidgetTypeV3.TypingAnimationV3]: {
+    responseId: 'mock-response-id',
+    language: 'en',
+    values: {
+      titleLabel: 'Shopping Assistant',
+      headlineText: 'Need help finding',
+      animatedTextSequence: [
+        'the perfect gift for your loved ones?',
+        'something special for the holidays?',
+        'the ideal present for someone special?',
+      ],
+      hintText: 'Ask me anything',
+      promptButtonTexts: [
+        'What are your best sellers?',
+        'Show me summer dresses',
+        'Do you have free shipping?',
+        'What sizes are available?',
+      ],
+      textFieldAriaLabel: 'Ask me anything',
+    },
+  },
+  [WidgetTypeV3.ChatPreviewComparisonV3]: {
+    responseId: 'mock-response-id',
+    language: 'en',
+    values: {
+      titleLabel: 'Shopping Assistant',
+      headlineText: 'Need help comparing?',
+      textFieldPlaceholderText: 'Ask me anything...',
+    },
+  },
+  [WidgetTypeV3.ChatPreviewLoadingV3]: {
+    responseId: 'mock-response-id',
+    language: 'en',
+    values: {
+      titleLabel: 'Shopping Assistant',
+      textFieldPlaceholderText: 'Ask me anything...',
+    },
+  },
+  [WidgetTypeV3.ChatPreviewV3]: {
+    responseId: 'mock-response-id',
+    language: 'en',
+    values: {
+      titleLabel: 'Shopping Assistant',
+      textFieldPlaceholderText: 'Ask me anything...',
+    },
+  },
+  [WidgetTypeV3.PromptButtonCarouselWithImageV3]: {
+    responseId: 'mock-response-id',
+    language: 'en',
+    values: {
+      titleLabel: 'Need some help?',
+      promptButtonsTexts: ['Help me find a product', "What's on your mind?", 'Talk to a human'],
+      textFieldPlaceholderText: 'Ask me anything...',
+    },
+  },
+  [WidgetTypeV3.ProductCardV3]: {
+    responseId: 'mock-response-id',
+    language: 'en',
+    values: {
+      headline: 'Discover Your Perfect Style',
+      animatedText: [
+        'the perfect outfit for any occasion',
+        'trending fashion that fits your lifestyle',
+        'quality pieces that last',
+      ],
+      prompts: [
+        'What are your best sellers?',
+        'Show me summer dresses',
+        'Do you have free shipping?',
+        'What sizes are available?',
+        'Can I return items?',
+      ],
+      placeholder: 'Ask me anything...',
+    },
+  },
+  [WidgetTypeV3.FloatingChatV3]: {
+    responseId: 'mock-response-id',
+    language: 'en',
+    values: {
+      welcomeMessageTitle: 'Welcome to Envive AI',
+      welcomeMessageText:
+        'Your personal shopper trained on the collective knowledge of thousands of real experts!',
+      chatFooterTextFieldPlaceholderText: 'Ask me anything...',
+      disclaimerText: 'This is a disclaimer...',
+      leftToggleLabel: 'Shop with AI',
+      rightToggleLabel: 'Live support',
+    },
+  },
+  [WidgetTypeV3.FullPageSalesAgentV3]: {
+    responseId: 'mock-response-id',
+    language: 'en',
+    values: {
+      welcomeMessageTitle: 'Welcome to Envive AI',
+      welcomeMessageText:
+        'Your personal shopper trained on the collective knowledge of thousands of real experts!',
+      chatFooterTextFieldPlaceholderText: 'Ask me anything...',
+      disclaimerText: 'This is a disclaimer...',
+    },
+  },
+};
+
+const convertToHardcopyResponse = (response: WidgetText): HardcopyResponse => ({
+  responseId: response.responseId,
+  language: response.language,
+  rawValues: response.values,
+  values: Object.fromEntries(
+    Object.entries(response.values).map(([key, value]) => [
+      toCamelCase(key),
+      value.length === 1 ? value[0].value : value.map(v => v.value),
+    ]),
+  ),
+});
+
+export class HardcopyService implements IHardcopyService {
+  constructor(private config: HardcopyServiceConfig) {}
+
+  async getHardcopy(request: HardcopyRequest): Promise<HardcopyResponse> {
+    const overrideConfigVersion =
+      getQueryParam('spiffy_config_version') || getQueryParam('envive_config_version') || undefined;
+
+    const widgetTextRequest: WidgetTextRequest = {
+      requestId: uuid(),
+      widgetType: request.widgetType,
+      context: this.config.getAppDetails(),
+      featureFlags: this.config.getFeatureFlags(),
+      language: navigator.languages[0] || 'en',
+      overrideConfigVersion,
+      url: window.location.href,
+    };
+
+    this.config.trackEvent?.({
+      eventName: EnviveMetricsEventName.WidgetTextRequest,
+      eventProps: {
+        widget_type: request.widgetType,
+        request_id: widgetTextRequest.requestId,
+      },
+    });
+
+    try {
+      const response = await CommerceApiClient.getHardcopy(widgetTextRequest);
+      if (response) {
+        const convertedResponse = convertToHardcopyResponse(response);
+        logger.logDebug('converted response', convertedResponse);
+        this.config.trackEvent?.({
+          eventName: EnviveMetricsEventName.WidgetTextResponse,
+          eventProps: {
+            widget_type: request.widgetType,
+            response_id: response.responseId,
+            widget_text: response.values,
+            request_id: widgetTextRequest.requestId,
+          },
+        });
+        return convertedResponse;
+      }
+    } catch (error) {
+      logger.logError('error getting hardcopy from backend', error);
+    }
+
+    const mockResponse = MOCK_HARDCOPY_RESPONSE[request.widgetType];
+    if (mockResponse) {
+      logger.logDebug('no real response, using mock', mockResponse);
+      return mockResponse;
+    }
+    throw new Error(`No hardcopy response found for widget type: ${request.widgetType}`);
+  }
+}
+
+export class MockHardcopyService implements IHardcopyService {
+  constructor(private overrides: Partial<Record<WidgetTypeV3, HardcopyResponse>> = {}) {}
+
+  async getHardcopy(request: HardcopyRequest): Promise<HardcopyResponse> {
+    const fallbackWidgetType =
+      request.widgetType === WidgetTypeV3.ProductCardV3
+        ? WidgetTypeV3.ImagePromptCardV3
+        : request.widgetType;
+
+    const response =
+      this.overrides[request.widgetType] ??
+      this.overrides[fallbackWidgetType] ??
+      MOCK_HARDCOPY_RESPONSE[request.widgetType];
+
+    if (!response) {
+      throw new Error(`No hardcopy response found for widget type: ${request.widgetType}`);
+    }
+    return response;
+  }
+}

package/src/services/hardcopyService/index.ts

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

package/src/services/userIdentityService/userIdentityService.ts

@@ -6,6 +6,11 @@ import { ExecutionContext } from '@envive-ai/analytics/dist/analytics/EnviveAnal
 
 const logger = new Logger('userIdentityService');
 
+export interface IUserIdentityService {
+  getUserIdOrDefault(): Promise<string>;
+  initializeUser(atomStore?: ReturnType<typeof getAtomStore>): Promise<void>;
+}
+
 type UserIdentityServiceProps = {
   apiKey: string;
 };
@@ -62,3 +67,16 @@ export class UserIdentityService {
     }
   }
 }
+
+export class MockUserIdentityService {
+  constructor(private readonly userId: string = 'mock-user-id') {}
+
+  async getUserIdOrDefault(): Promise<string> {
+    return this.userId;
+  }
+
+  async initializeUser(atomStore?: ReturnType<typeof getAtomStore>): Promise<void> {
+    const store = atomStore || getAtomStore();
+    store.set(userIdAtom, this.userId);
+  }
+}