@envive-ai/react-hooks 0.1.0

package/dist/hooks/index.d.cts

@@ -0,0 +1,357 @@
+import { CamelCasedPropertiesDeep, ChatElementDisplayLocation, GenerationParams as GenerationParams$1 } from "../chatElementDisplayLocation-CX8fuNao.cjs";
+import * as react1 from "react";
+import { ReactElement, RefObject } from "react";
+import { CustServiceAttachment, FormType, FulfillmentDisplayStatus, ProductSearchResponseAttributes, ResponseCategory, ResponseProductAttributes } from "@spiffy-ai/commerce-api-client";
+
+//#region src/application/models/api/responseGenerics.d.ts
+interface ApiReviewRichInformation {
+  cons?: string[];
+  pros?: string[];
+  review_date?: string;
+  reviewer_title?: string;
+  product_familiarity?: 'IVE_TESTED_IT' | 'I_OWN_IT';
+}
+interface ApiTextResponseAttributes {
+  content: string;
+}
+interface ApiSearchResponseAttributes {
+  search_term: string;
+  selected_filters?: string[];
+  filters?: {
+    [key: string]: string[];
+  };
+}
+interface ApiProductSearchFilterResponseAttributes {
+  filter_name: string;
+}
+interface ApiReviewResponseAttributes {
+  id?: string;
+  product_id?: string;
+  title?: string;
+  reviewer?: string;
+  review?: string;
+  stars?: number;
+  rich_information?: ApiReviewRichInformation;
+  onClick?: () => void;
+}
+interface ApiPageResponseAttributes {
+  id?: string;
+  title?: string;
+  description?: string;
+  url?: string;
+}
+//#endregion
+//#region src/application/models/api/response.d.ts
+type AcceptableFormFieldType = 'string' | 'number' | 'boolean' | 'object' | 'array';
+interface OrderItemInfo {
+  itemTitle: string;
+  itemPrice: number;
+  itemQuantity: number;
+  orderItemId: string;
+  image?: string;
+  inTransitAt?: string;
+  deliveredAt?: string;
+  estimatedDeliveryAt?: string;
+  fulfillmentDisplayStatus?: FulfillmentDisplayStatus;
+  trackingUrl?: string;
+}
+interface OrderResponseAttributes {
+  category: ResponseCategory.Order;
+  attributes: {
+    orderId: string;
+    orderNumber: string;
+    createdAt: string;
+    latestEventDate: string;
+    lineItems: OrderItemInfo[];
+  };
+}
+interface TextResponseAttributes {
+  category: ResponseCategory.Text;
+  attributes: CamelCasedPropertiesDeep<ApiTextResponseAttributes>;
+}
+interface ProductResponseAttributes {
+  category: ResponseCategory.Product;
+  attributes: CamelCasedPropertiesDeep<ResponseProductAttributes & {
+    filters?: {
+      [key: string]: string[];
+    };
+  }>;
+}
+interface SearchResponseAttributes {
+  category: ResponseCategory.Text;
+  attributes: CamelCasedPropertiesDeep<ApiSearchResponseAttributes>;
+}
+interface SearchProductResponseAttributes {
+  category: ResponseCategory.ProductSearch;
+  attributes: CamelCasedPropertiesDeep<ProductSearchResponseAttributes>;
+}
+interface SearchProductFilterAttributes {
+  category: ResponseCategory.ProductSearchFilter;
+  attributes: CamelCasedPropertiesDeep<ApiProductSearchFilterResponseAttributes>;
+}
+interface ReviewResponseAttributes {
+  category: ResponseCategory.Review;
+  attributes: CamelCasedPropertiesDeep<ApiReviewResponseAttributes>;
+}
+interface PageResponseAttributes {
+  category: ResponseCategory.Page;
+  attributes: CamelCasedPropertiesDeep<ApiPageResponseAttributes>;
+}
+//#endregion
+//#region src/application/models/message.d.ts
+declare enum MessageRole {
+  User = "user",
+  Assistant = "assistant",
+}
+declare enum MessageType {
+  Text = "text",
+  SuggestionClicked = "suggestion_clicked",
+  Product = "product",
+  ProductSearch = "product_search",
+  Review = "review",
+  QueryTyped = "query_typed",
+  Separator = "separator",
+  Page = "page",
+  Search = "search",
+  Attachment = "attachment",
+  CXAgentResponse = "cx_agent_response",
+  Form = "form",
+  Order = "order",
+  ProductSearchFilter = "product_search_filter",
+}
+type Message = {
+  id: string;
+  role: MessageRole;
+  createdAt: string;
+} & (TextMessageMetadata | QueryTypedMetadata | SuggestionMessageMetadata | ProductMessageMetadata | ProductSearchMessageMetadata | ReviewMessageMetadata | SeparatorMessageMetadata | PageMessageMetadata | SearchMessageMetadata | AttachmentMetadata | CXAgentResponseMetadata | FormMessageMetadata | OrderMessageMetadata | ProductSearchFilterMetadata);
+type AttachmentMetadata = {
+  type: MessageType.Attachment;
+  metadata: {
+    message?: string;
+    attachment: CustServiceAttachment[];
+  };
+};
+type CXAgentResponseMetadata = {
+  type: MessageType.CXAgentResponse;
+  metadata: {
+    message: string;
+    agentName: string;
+  };
+};
+type TextMessageMetadata = {
+  type: MessageType.Text;
+  metadata: TextResponseAttributes['attributes'];
+};
+type QueryTypedMetadata = {
+  type: MessageType.QueryTyped;
+  metadata: TextResponseAttributes['attributes'];
+};
+type SuggestionMessageMetadata = {
+  type: MessageType.SuggestionClicked;
+  metadata: {
+    suggestionId: string;
+    suggestionContent: string;
+  };
+};
+type ProductMessageMetadata = {
+  type: MessageType.Product;
+  metadata: ProductResponseAttributes['attributes'];
+};
+type ProductSearchMessageMetadata = {
+  type: MessageType.ProductSearch;
+  metadata: SearchProductResponseAttributes['attributes'];
+};
+type ReviewMessageMetadata = {
+  type: MessageType.Review;
+  metadata: ReviewResponseAttributes['attributes'];
+};
+type SeparatorMessageMetadata = {
+  type: MessageType.Separator;
+};
+type PageMessageMetadata = {
+  type: MessageType.Page;
+  metadata: PageResponseAttributes['attributes'];
+};
+type SearchMessageMetadata = {
+  type: MessageType.Search;
+  metadata: SearchResponseAttributes['attributes'];
+};
+type ProductSearchFilterMetadata = {
+  type: MessageType.ProductSearchFilter;
+  metadata: SearchProductFilterAttributes['attributes'];
+};
+type FormField = {
+  key: string;
+  title: string;
+  type: AcceptableFormFieldType;
+  required: boolean;
+  format?: 'email';
+  value?: string;
+};
+type FormMessageMetadata = {
+  type: MessageType.Form;
+  metadata: {
+    formType?: FormType;
+    fields: FormField[];
+  };
+};
+type OrderMessageMetadata = {
+  type: MessageType.Order;
+  metadata: OrderResponseAttributes['attributes'];
+};
+//#endregion
+//#region src/hooks/useIsSmallScreen.d.ts
+declare const useIsSmallScreen: () => boolean;
+//#endregion
+//#region src/hooks/useSystemSettingsContext.d.ts
+declare const useSystemSettingsContext: () => {
+  generationParams?: GenerationParams$1;
+  showDebugBar?: boolean;
+  endpointURL?: string;
+  setGenerationParams: react1.Dispatch<react1.SetStateAction<GenerationParams$1 | undefined>>;
+};
+//#endregion
+//#region src/hooks/useMessageFilter.d.ts
+type MessageFinder = {
+  msgs: Message[][];
+  type?: MessageType;
+  role?: MessageRole;
+};
+declare const useMessageFilter: () => {
+  findMessageIndex: ({
+    msgs,
+    type,
+    role
+  }: MessageFinder) => number;
+  removePreviousDiscussions: (msgs: Message[][], index: number) => Message[][];
+  getFilteredMessages: (msgs: Message[][], skipFilter?: boolean) => Message[][];
+};
+//#endregion
+//#region src/application/utils/mouseEventTypes.d.ts
+type MouseEventTypes = 'click' | 'dblclick' | 'mouseup' | 'mousedown';
+//#endregion
+//#region src/application/utils/nodeSelector.d.ts
+declare abstract class NodeSelector {
+  private pattern;
+  private root;
+  constructor(pattern: string);
+  getPattern(): string;
+  setRoot(root: Document): void;
+  getRoot(): Document;
+  abstract parse(): Node | null;
+}
+//#endregion
+//#region src/hooks/useElementObserver.d.ts
+interface ElementObserverUtility {
+  onChange: (fn: (el: HTMLElement | null) => void) => void;
+  onAdd: (fn: (el: HTMLElement | null) => void) => void;
+  onRemove: (fn: (el: HTMLElement | null) => void) => void;
+  onClassChange: (fn: (classes?: DOMTokenList) => void) => void;
+  onClassAdded: (className: string, fn: () => void) => void;
+  onClassRemoved: (className: string, fn: () => void) => void;
+  onAddChild: (fn: (nodes?: DOMTokenList) => void) => void;
+  onRemoveChild: (fn: (nodes?: DOMTokenList) => void) => void;
+  onEvent: <K extends keyof HTMLElementEventMap>(event: K, fn: EventListenerOrEventListenerObject) => void;
+  blockRendering: () => void;
+  unblockRendering: () => void;
+  exists: () => boolean;
+  isRendered: () => boolean;
+  render: (fn: () => ReactElement) => ReactElement | undefined;
+  fire: (event: MouseEventTypes) => void;
+  show: () => void;
+  hide: () => void;
+  applyStyle: (styles: React.CSSProperties) => void;
+  targetNode: HTMLElement | null;
+}
+declare const useElementObserver: (selector: NodeSelector) => ElementObserverUtility;
+//#endregion
+//#region src/application/models/spiffyWidgets.d.ts
+/**
+ * Enum of all widget names. These are widgets that are rendered and integrated into
+ * a merchant's website.
+ */
+declare enum SpiffyWidgets {
+  ImageBanner = "image_banner",
+  ImagePromptCard = "image_prompt_card",
+  SingleImagePrompt = "single_image_prompt",
+  EmbeddedWidget = "embedded_widget",
+  FloatingButton = "floating_button",
+  SuggestionBar = "suggestion_bar",
+  SearchPrompt = "search_prompt",
+  GlobalSearch = "global_search",
+  SearchResults = "search_results",
+  GlobalSearchEntryPoint = "global_search_entry_point",
+}
+//#endregion
+//#region src/adapters/amplitude/amplitudeAdapter.d.ts
+declare 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",
+  GlobalSearchPromptClicked = "Global Search Prompt Clicked",
+  // This is the scrolling list of suggestion buttons in global search
+  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
+//#region src/hooks/useTrackComponentVisibleEvent.d.ts
+/**
+ * Tracks a component and logs an event to Amplitude when the component is visible.
+ *
+ * @param component - The component to track.
+ * @param element - The element to track visibility of.
+ * @param eventProps - Additional properties to include with the event.
+ * @param eventName - The Amplitude event name to track (defaults to ChatComponentVisible).
+ */
+declare const useTrackComponentVisibleEvent: (component: SpiffyWidgets, element: RefObject<HTMLElement>, eventProps?: Record<string, unknown>, eventName?: SpiffyMetricsEventName) => void;
+//#endregion
+//#region src/hooks/useIntersection.d.ts
+declare const useIntersection: (element: RefObject<HTMLElement>, rootMargin: string) => boolean;
+//#endregion
+//#region src/hooks/useUpdateAnalyticsProps.d.ts
+/**
+ * Updates the default analytics properties whenever the variant info changes. This hook also
+ * triggers any events that should be sent once per page visit.
+ */
+declare const useUpdateAnalyticsProps: () => void;
+//#endregion
+//#region src/hooks/useChatToggle.d.ts
+declare const useChatToggle: () => {
+  toggle: (triggerLocation: ChatElementDisplayLocation, triggerId?: string) => void;
+  isOpen: boolean;
+  openChat: (triggerLocation: ChatElementDisplayLocation, triggerId?: string) => void;
+  closeChat: (triggerLocation: ChatElementDisplayLocation, triggerId?: string) => void;
+};
+//#endregion
+//#region src/hooks/useDynamicVariants.d.ts
+declare const useDynamicVariants: () => void;
+//#endregion
+//#region src/hooks/useHideElements.d.ts
+/**
+ * This hook hides/shows elements that could overlap with the chat when the chat is opened/closed.
+ */
+declare const useHideElements: () => void;
+//#endregion
+export { ElementObserverUtility, useChatToggle, useDynamicVariants, useElementObserver, useHideElements, useIntersection, useIsSmallScreen, useMessageFilter, useSystemSettingsContext, useTrackComponentVisibleEvent, useUpdateAnalyticsProps };