@envive-ai/react-widgets-v3 0.3.14 → 0.3.15-beta.0

package/dist/hocs/withBaseWidget/types.d.cts

@@ -1,7 +1,7 @@
+import { SpiffyMetricsEventName } from "../../hooks/dist/services/amplitudeService/eventNames.cjs";
+import { OrgUIConfigV3, WidgetConfigV3, WidgetTypeV3 } from "../../hooks/dist/contexts/typesV3.cjs";
+import { HardcopyResponse } from "../../hooks/dist/contexts/hardcopyContext/hardcopyContext.cjs";
 import { RefObject } from "react";
-import { SpiffyMetricsEventName } from "@envive-ai/react-hooks/contexts/amplitudeContext";
-import { HardcopyResponse } from "@envive-ai/react-hooks/contexts/hardcopyContext";
-import { OrgUIConfigV3, WidgetConfigV3, WidgetTypeV3 } from "@envive-ai/react-hooks/contexts/typesV3";
 
 //#region src/hocs/withBaseWidget/types.d.ts
 interface BaseWidgetProps {

package/dist/hocs/withBaseWidget/types.d.ts

@@ -1,7 +1,9 @@
+import { SpiffyMetricsEventName } from "../../packages/hooks/dist/services/amplitudeService/eventNames.js";
+import { OrgUIConfigV3, WidgetConfigV3, WidgetTypeV3 } from "../../packages/hooks/dist/contexts/typesV3.js";
+import { HardcopyResponse } from "../../packages/hooks/dist/contexts/hardcopyContext/hardcopyContext.js";
+import "../../packages/hooks/dist/contexts/amplitudeContext/index.js";
+import "../../packages/hooks/dist/contexts/hardcopyContext/index.js";
 import { RefObject } from "react";
-import { SpiffyMetricsEventName } from "@envive-ai/react-hooks/contexts/amplitudeContext";
-import { HardcopyResponse } from "@envive-ai/react-hooks/contexts/hardcopyContext";
-import { OrgUIConfigV3, WidgetConfigV3, WidgetTypeV3 } from "@envive-ai/react-hooks/contexts/typesV3";
 
 //#region src/hocs/withBaseWidget/types.d.ts
 interface BaseWidgetProps {

package/dist/hocs/withBaseWidget/withBaseWidget.d.cts

@@ -1,9 +1,9 @@
 import { BaseWidgetProps, WithBaseWidgetOptions } from "./types.cjs";
-import * as react_jsx_runtime7 from "react/jsx-runtime";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
 
 //#region src/hocs/withBaseWidget/withBaseWidget.d.ts
 declare function withBaseWidget<P extends BaseWidgetProps>(Widget: React.ComponentType<P>, options?: WithBaseWidgetOptions): {
-  (props: P): react_jsx_runtime7.JSX.Element;
+  (props: P): react_jsx_runtime0.JSX.Element;
   displayName: string;
 };
 //#endregion

package/dist/hocs/withBaseWidget/withBaseWidget.d.ts

@@ -1,9 +1,9 @@
 import { BaseWidgetProps, WithBaseWidgetOptions } from "./types.js";
-import * as react_jsx_runtime15 from "react/jsx-runtime";
+import * as react_jsx_runtime18 from "react/jsx-runtime";
 
 //#region src/hocs/withBaseWidget/withBaseWidget.d.ts
 declare function withBaseWidget<P extends BaseWidgetProps>(Widget: React.ComponentType<P>, options?: WithBaseWidgetOptions): {
-  (props: P): react_jsx_runtime15.JSX.Element;
+  (props: P): react_jsx_runtime18.JSX.Element;
   displayName: string;
 };
 //#endregion

package/dist/hooks/dist/application/models/api/widgetText.d.cts

@@ -0,0 +1,8 @@
+//#region ../hooks/dist/application/models/api/widgetText.d.ts
+//#region src/application/models/api/widgetText.d.ts
+type WidgetString = {
+  id: string;
+  value: string;
+};
+//#endregion
+export { WidgetString };

package/dist/hooks/dist/contexts/hardcopyContext/hardcopyContext.d.cts

@@ -0,0 +1,12 @@
+import { WidgetString } from "../../application/models/api/widgetText.cjs";
+
+//#region ../hooks/dist/contexts/hardcopyContext/hardcopyContext.d.ts
+
+type HardcopyResponse = {
+  responseId: string;
+  language: string;
+  rawValues?: Record<string, WidgetString | WidgetString[]>;
+  values: Record<string, string | string[]>;
+};
+//#endregion
+export { HardcopyResponse };

package/dist/hooks/dist/contexts/types.d.cts

@@ -0,0 +1,38 @@
+//#region ../hooks/dist/contexts/types.d.ts
+
+interface AlphabeticFilterSorting {
+  type: 'alphabetic';
+}
+interface ProductCountFilterSorting {
+  type: 'productCount';
+}
+interface CustomFilterSorting {
+  type: 'custom';
+  map: Record<string, number>;
+}
+type FilterSorting = AlphabeticFilterSorting | ProductCountFilterSorting | CustomFilterSorting;
+interface BaseFilterConfig {
+  filterId: string;
+  displayName: string;
+}
+interface DynamicFilterConfig extends BaseFilterConfig {
+  type: 'dynamic';
+  attribute: string;
+  sorting: FilterSorting;
+}
+interface PriceFilterConfig extends BaseFilterConfig {
+  type: 'price';
+  bucketSize: number;
+}
+type FilterAttribute = DynamicFilterConfig | PriceFilterConfig;
+interface SearchConfig {
+  enableGlobalSearch: boolean;
+  searchFilterConfig: FilterAttribute[];
+  searchOverlayHeading?: string;
+  redirectSearchResultsUrl?: string;
+  additiveDynamicFilters?: boolean;
+  recommendedProducts?: string[];
+  recommendedProductsHeading?: string;
+}
+//#endregion
+export { type SearchConfig };

package/dist/hooks/dist/contexts/typesV3.d.cts

@@ -0,0 +1,239 @@
+import { CustomerServiceType } from "../types/customerService.cjs";
+import { SearchConfig } from "./types.cjs";
+import { FloatingButtonLocation } from "@envive-ai/react-toolkit-v3/FloatingButton";
+import { ImageGalleryImage, ImageGalleryLayout } from "@envive-ai/react-toolkit-v3/ImageGallery";
+import { PromptButtonVariant } from "@envive-ai/react-toolkit-v3/PromptButton";
+import { AnimationSpeed, PromptCarouselRows } from "@envive-ai/react-toolkit-v3/PromptCarousel";
+import { DynamicLayout, WidgetKind } from "@envive-ai/react-toolkit-v3/SocialProof";
+import { Theme } from "@envive-ai/react-toolkit-v3/Tokens";
+import { SparkleIconColor } from "@envive-ai/react-toolkit-v3/WelcomeMessage";
+import { WidgetWrapperVariant } from "@envive-ai/react-toolkit-v3/WidgetWrapper";
+
+//#region ../hooks/dist/contexts/typesV3.d.ts
+
+type ImageAspectRatio = '1/1' | '3/4';
+type ButtonColors = {
+  lightButtonBackgroundColor: string;
+  lightButtonIconColor: string;
+  darkButtonBackgroundColor: string;
+  darkButtonIconColor: string;
+};
+type Typography = {
+  titleFontFamily: string;
+  headerFontFamily: string;
+  bodyFontFamily: string;
+  fontSize?: {
+    t1: string;
+    t2: string;
+    t3: string;
+    h1: string;
+    h2: string;
+    h3: string;
+    b1: string;
+    b2: string;
+    b3: string;
+    b4: string;
+    b5: string;
+    l1: string;
+    l2: string;
+  };
+  fontWeight?: {
+    rg: string;
+    md: string;
+    sb: string;
+  };
+  letterSpacing?: {
+    '0': string;
+    'wide-1': string;
+  };
+  lineHeight?: {
+    '124': number;
+    '120': number;
+    '118': number;
+    '116': number;
+    '114': number;
+    '148': number;
+    '140': number;
+    '128': number;
+    '130': number;
+    '133': number;
+  };
+};
+type LookAndFeelConfig = {
+  theme: Theme;
+  agentName: string;
+  chatHeaderLogoDarkSrc: string;
+  chatHeaderLogoLightSrc: string;
+  widgetLogoSrc: string;
+  hideWidgetLogo: boolean;
+  elementRadius: number;
+  imageAspectRatio: ImageAspectRatio;
+  buttonColors: ButtonColors;
+  typography: Typography;
+};
+declare enum ConfigVersionEnum {
+  V3 = "v3",
+  Deprecated = "deprecated",
+}
+type ConfigVersion = ConfigVersionEnum.V3 | ConfigVersionEnum.Deprecated | undefined;
+type Mode = 'dark' | 'light';
+type ShowOptions = 'always' | 'postInteraction' | 'none';
+type Style = 'attached' | 'detached';
+type FloatingButtonConfig = {
+  position: FloatingButtonLocation;
+  backgroundColor?: string;
+  mode: Mode;
+  showOption: ShowOptions;
+  iconSVGSrc?: string;
+  style: Style;
+};
+type ReferrerPopupTrigger = {
+  type: 'referrer';
+  referrers: string[];
+};
+type AutomaticPopupTrigger = {
+  type: 'automatic';
+};
+type PopupTrigger = ReferrerPopupTrigger | AutomaticPopupTrigger;
+type AutoPopupTrigger = {
+  delay: number;
+  trigger: PopupTrigger;
+};
+interface AutoPopupConfig {
+  triggers: AutoPopupTrigger[];
+}
+type PartialViewConfig = {
+  /**
+   * When true, only full-screen mode is supported (no partial/draggable middle state).
+   * Useful when partial view causes usability issues on mobile.
+   * Default: false (undefined and false = partial view enabled).
+   */
+  disabled?: boolean;
+};
+type FloatingChatConfig = {
+  headerBackgroundColor?: string;
+  headerMode: Mode;
+  welcomeMessageIconColor: SparkleIconColor;
+  showVerifiedBuyer: boolean;
+  userQueryInputEnabled: boolean;
+  showEnviveLogo: boolean;
+  ignoreFirstModelResponse?: boolean;
+  neverShowSingleProductCards?: boolean;
+  welcomeMessageTitle: string;
+  welcomeMessageText: string;
+  chatFooterTextFieldPlaceholderText: string;
+  autoPopupConfig?: AutoPopupConfig;
+  partialViewConfig?: PartialViewConfig;
+};
+type CustomerServiceIntegration = {
+  enabled: boolean;
+  provider: CustomerServiceType;
+  suppressMerchantButton?: boolean;
+};
+type SPASettings = {
+  enabled: boolean;
+  refreshInterval?: number;
+};
+type OrgUIConfigV3 = {
+  id?: string;
+  version: ConfigVersion;
+  shortName: string;
+  lookAndFeel: LookAndFeelConfig;
+  floatingButton: FloatingButtonConfig;
+  floatingChat: FloatingChatConfig;
+  merchantOverrideCss?: string;
+  customerServiceIntegration?: CustomerServiceIntegration;
+  singlePageApplicationSettings?: SPASettings;
+  searchConfig?: SearchConfig;
+};
+declare enum WidgetTypeV3 {
+  PromptCarouselV3 = "PromptCarouselV3",
+  TitledPromptCarouselV3 = "TitledPromptCarouselV3",
+  SocialProofV3 = "SocialProofV3",
+  TypingAnimationV3 = "TypingAnimationV3",
+  ChatPreviewV3 = "ChatPreviewV3",
+  ChatPreviewComparisonV3 = "ChatPreviewComparisonV3",
+  ChatPreviewLoadingV3 = "ChatPreviewLoadingV3",
+  ImagePromptCardV3 = "ImagePromptCardV3",
+  PromptButtonCarouselWithImageV3 = "PromptButtonCarouselWithImageV3",
+  ImageBannerV3 = "ImageBannerV3",
+  SingleImagePromptV3 = "SingleImagePromptV3",
+  FloatingChatV3 = "FloatingChatV3",
+  FloatingButtonV3 = "FloatingButtonV3",
+  ProductCardV3 = "ProductCardV3",
+  FullPageSalesAgentV3 = "FullPageSalesAgentV3",
+}
+interface BaseWidgetConfig<T extends WidgetTypeV3> {
+  widgetConfigId: string;
+  type: T;
+  contentId?: string;
+}
+interface PromptCarouselWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.PromptCarouselV3> {
+  promptButtonType?: PromptButtonVariant;
+  boldFirstButton?: boolean;
+  promptCarouselRows?: PromptCarouselRows;
+  animationSpeed?: AnimationSpeed;
+}
+interface TitledPromptCarouselWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.TitledPromptCarouselV3> {
+  promptButtonType?: PromptButtonVariant;
+  boldFirstButton?: boolean;
+  promptCarouselRows?: PromptCarouselRows;
+  animationSpeed?: AnimationSpeed;
+}
+interface SocialProofWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.SocialProofV3> {
+  kind: WidgetKind;
+  variant: WidgetWrapperVariant;
+  hexCardColor?: string;
+  promptCarouselRows: PromptCarouselRows;
+  hideImage?: boolean;
+  imageGalleryLayout: Exclude<ImageGalleryLayout, 'TWO_SIDE'>;
+  hideTextField?: boolean;
+  primaryButtonVariant: Exclude<PromptButtonVariant, 'suggestedResponse' | 'ghost'>;
+  secondaryButtonVariant: Exclude<PromptButtonVariant, 'suggestedResponse' | 'ghost'>;
+  dynamicLayout?: DynamicLayout;
+  images?: ImageGalleryImage[];
+}
+interface TypingAnimationWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.TypingAnimationV3> {
+  widgetVariant?: WidgetWrapperVariant;
+  cardColor?: string;
+  promptButtonType?: PromptButtonVariant;
+  promptCarouselRows?: PromptCarouselRows;
+  showTextField?: boolean;
+}
+interface ChatPreviewComparisonWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.ChatPreviewComparisonV3> {
+  variant: WidgetWrapperVariant;
+  hexCardColor?: string;
+  hideImage?: boolean;
+  hideTextField?: boolean;
+}
+interface ChatPreviewLoadingWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.ChatPreviewLoadingV3> {
+  variant: WidgetWrapperVariant;
+  hexCardColor?: string;
+  hideTextField?: boolean;
+}
+interface ChatPreviewWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.ChatPreviewV3> {
+  variant: WidgetWrapperVariant;
+  hexCardColor?: string;
+  hideTextField?: boolean;
+}
+interface PromptButtonCarouselWithImageWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.PromptButtonCarouselWithImageV3> {
+  promptButtonType?: PromptButtonVariant;
+  image?: ImageGalleryImage;
+  hideTextField?: boolean;
+  isDynamic?: boolean;
+}
+interface FloatingChatWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.FloatingChatV3> {}
+interface ProductCardWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.ProductCardV3> {
+  promptButtonType?: PromptButtonVariant;
+  italicizeHeadline?: boolean;
+  fallbackColor?: string;
+  imageSrc?: string;
+}
+interface FullPageSalesAgentWidgetV3Config extends BaseWidgetConfig<WidgetTypeV3.FullPageSalesAgentV3> {
+  headerContainer?: string;
+  autoHeight?: boolean;
+}
+type WidgetConfigV3 = PromptCarouselWidgetV3Config | SocialProofWidgetV3Config | TitledPromptCarouselWidgetV3Config | ChatPreviewComparisonWidgetV3Config | ChatPreviewLoadingWidgetV3Config | TypingAnimationWidgetV3Config | ChatPreviewWidgetV3Config | PromptButtonCarouselWithImageWidgetV3Config | FloatingChatWidgetV3Config | ProductCardWidgetV3Config | FullPageSalesAgentWidgetV3Config;
+//#endregion
+//#endregion
+export { type OrgUIConfigV3, type WidgetConfigV3, WidgetTypeV3 };

package/dist/hooks/dist/services/amplitudeService/eventNames.d.cts

@@ -0,0 +1,43 @@
+//#region ../hooks/dist/services/amplitudeService/eventNames.d.ts
+//#region src/services/amplitudeService/eventNames.d.ts
+/**
+ * Event name enums for Amplitude tracking.
+ *
+ * NOTE: This file exists separately to avoid circular dependency issues.
+ * The amplitudeService imports from ga4ProjectionService, which needs these enums.
+ * By keeping the enums in a separate file, ga4ProjectionService can import them
+ * without creating a circular dependency with amplitudeService.
+ */
+declare enum SpiffyMetricsEventName {
+  BundleLoaded = "Bundle Loaded",
+  EnvironmentInitialized = "Environment Initialized",
+  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",
+  SearchInputStarted = "Search Input Started",
+  SearchQuerySubmitted = "Search Query Submitted",
+  SearchResultsViewed = "Search Results Viewed",
+  SearchTimeToFirstClick = "Search Time to First Click",
+  SearchZeroResultsRate = "Search Zero Results Rate",
+  SearchFilterClicked = "Search Filter Clicked",
+  SearchSortClicked = "Search Sort Clicked",
+}
+//#endregion
+export { SpiffyMetricsEventName };

package/dist/hooks/dist/types/customerService.d.cts

@@ -0,0 +1,21 @@
+//#region ../hooks/dist/types/customerService.d.ts
+
+//#region src/types/customerService.d.ts
+declare enum CustomerServiceType {
+  shopify = "shopify",
+  gorgias = "gorgias",
+  kustomer = "kustomer",
+  groove = "groove",
+  tidio = "tidio",
+  zowie = "zowie",
+  redo = "redo",
+  gladly = "gladly",
+  richpanel = "richpanel",
+  zendesk = "zendesk",
+  helpscout = "helpscout",
+  talkdesk = "talkdesk",
+  eightByEight = "8x8",
+  unsupported = "unsupported",
+}
+//#endregion
+export { CustomerServiceType };

package/dist/packages/hooks/dist/application/models/api/orgConfigResults.d.ts

@@ -0,0 +1 @@
+import "../frontendConfig.js";

package/dist/packages/hooks/dist/application/models/api/widgetText.d.ts

@@ -0,0 +1,8 @@
+//#region ../hooks/dist/application/models/api/widgetText.d.ts
+//#region src/application/models/api/widgetText.d.ts
+type WidgetString = {
+  id: string;
+  value: string;
+};
+//#endregion
+export { WidgetString };

package/dist/packages/hooks/dist/application/models/frontendConfig.d.ts

@@ -0,0 +1 @@
+import "../../contexts/types.js";

package/dist/packages/hooks/dist/contexts/amplitudeContext/amplitudeContext.d.ts

@@ -0,0 +1,2 @@
+import "../../services/amplitudeService/amplitudeService.js";
+import React from "react";

package/dist/packages/hooks/dist/contexts/amplitudeContext/index.d.ts

@@ -0,0 +1,2 @@
+import { SpiffyMetricsEventName } from "../../services/amplitudeService/eventNames.js";
+import "./amplitudeContext.js";

package/dist/packages/hooks/dist/contexts/featureFlagServiceContext/featureFlagServiceContext.d.ts

@@ -0,0 +1,2 @@
+import "../../application/models/api/orgConfigResults.js";
+import React from "react";

package/dist/packages/hooks/dist/contexts/hardcopyContext/hardcopyContext.d.ts

@@ -0,0 +1,14 @@
+import "../typesV3.js";
+import { WidgetString } from "../../application/models/api/widgetText.js";
+import "react";
+
+//#region ../hooks/dist/contexts/hardcopyContext/hardcopyContext.d.ts
+
+type HardcopyResponse = {
+  responseId: string;
+  language: string;
+  rawValues?: Record<string, WidgetString | WidgetString[]>;
+  values: Record<string, string | string[]>;
+};
+//#endregion
+export { HardcopyResponse };

package/dist/packages/hooks/dist/contexts/hardcopyContext/index.d.ts

@@ -0,0 +1 @@
+import { HardcopyResponse } from "./hardcopyContext.js";

package/dist/packages/hooks/dist/contexts/types.d.ts

@@ -0,0 +1,42 @@
+import "./typesV3.js";
+import "./hardcopyContext/hardcopyContext.js";
+import "../application/models/api/orgConfigResults.js";
+
+//#region ../hooks/dist/contexts/types.d.ts
+
+interface AlphabeticFilterSorting {
+  type: 'alphabetic';
+}
+interface ProductCountFilterSorting {
+  type: 'productCount';
+}
+interface CustomFilterSorting {
+  type: 'custom';
+  map: Record<string, number>;
+}
+type FilterSorting = AlphabeticFilterSorting | ProductCountFilterSorting | CustomFilterSorting;
+interface BaseFilterConfig {
+  filterId: string;
+  displayName: string;
+}
+interface DynamicFilterConfig extends BaseFilterConfig {
+  type: 'dynamic';
+  attribute: string;
+  sorting: FilterSorting;
+}
+interface PriceFilterConfig extends BaseFilterConfig {
+  type: 'price';
+  bucketSize: number;
+}
+type FilterAttribute = DynamicFilterConfig | PriceFilterConfig;
+interface SearchConfig {
+  enableGlobalSearch: boolean;
+  searchFilterConfig: FilterAttribute[];
+  searchOverlayHeading?: string;
+  redirectSearchResultsUrl?: string;
+  additiveDynamicFilters?: boolean;
+  recommendedProducts?: string[];
+  recommendedProductsHeading?: string;
+}
+//#endregion
+export { type SearchConfig };