@envive-ai/react-hooks 0.1.0 → 0.1.2

package/dist/hooks/index.d.cts

@@ -1,245 +1,54 @@
-import { CamelCasedPropertiesDeep, ChatElementDisplayLocation, GenerationParams as GenerationParams$1 } from "../chatElementDisplayLocation-CX8fuNao.cjs";
+import "../featureGates-N_gyHCTn.cjs";
+import "../featureFlagService-CroFRxvD.cjs";
+import { SpiffyMetricsEventName } from "../index-JClBRnSX.cjs";
+import "../index-DtoVXd6O.cjs";
+import "../index-Cn1SeI5y.cjs";
+import "../index-C4zjAR1c.cjs";
+import { GenerationParams as GenerationParams$1, Message, MessageRole, MessageType, SearchResult, SpiffyWidgets } from "../index-DbWWcYax.cjs";
+import { ChatElementDisplayLocation, ProductCardConfig } from "../frontendConfig-KeNqU1wa.cjs";
+import "../types-BE4faOO_.cjs";
+import "../test-types-CpKCxk8U.cjs";
+import "../index-hdbCEjYy.cjs";
+import { MouseEventTypes, NodeSelector } from "../nodeSelector-vKB44CDB.cjs";
+import { SelectedFilterOption } from "../index-BkhvV8RZ.cjs";
+import { SearchFilter, SelectFilterItem } from "../search-filter-types-CqaGK3nM.cjs";
+import { AttachmentRequest, SearchResponseProduct } from "@spiffy-ai/commerce-api-client";
 import * as react1 from "react";
 import { ReactElement, RefObject } from "react";
-import { CustServiceAttachment, FormType, FulfillmentDisplayStatus, ProductSearchResponseAttributes, ResponseCategory, ResponseProductAttributes } from "@spiffy-ai/commerce-api-client";
+import * as motion_dom0 from "motion-dom";
+import * as framer_motion0 from "framer-motion";
+import { MotionValue, ValueAnimationTransition } from "framer-motion";
 
-//#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;
+//#region src/hooks/useBlockBackButton.d.ts
+declare const useBlockBackButton: (enabled: boolean, callback: () => void) => void;
 //#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>>;
+//#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/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[][];
+//#region src/hooks/useCustomerSupportHandoff.d.ts
+/**
+ * Hook to call the `click` method of the merchant's customer support chat widget.
+ *
+ * @param onSwitchToAgent a function to override the function returned by the hook. This is mainly to
+ * preserve backward compatibility for merchants not using Kustomer and will be removed when all
+ * CS integrations are handled.
+ *
+ * @returns a function that searches for the customer support chat widget and calls the `click` method.
+ */
+declare const useCustomerSupportHandoff: (onSwitchToAgent?: () => void) => {
+  onSwitch: () => void;
 };
 //#endregion
-//#region src/application/utils/mouseEventTypes.d.ts
-type MouseEventTypes = 'click' | 'dblclick' | 'mouseup' | 'mousedown';
+//#region src/hooks/useDebounce.d.ts
+declare function useDebounce<T>(value: T, delay: number): T;
 //#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;
-}
+//#region src/hooks/useDynamicVariants.d.ts
+declare const useDynamicVariants: () => void;
 //#endregion
 //#region src/hooks/useElementObserver.d.ts
 interface ElementObserverUtility {
@@ -265,57 +74,189 @@ interface ElementObserverUtility {
 }
 declare const useElementObserver: (selector: NodeSelector) => ElementObserverUtility;
 //#endregion
-//#region src/application/models/spiffyWidgets.d.ts
+//#region src/hooks/useFileUpload.d.ts
+declare const useFileUpload: () => {
+  error: string;
+  fileInputRef: react1.MutableRefObject<null>;
+  attachment: AttachmentRequest | undefined;
+  handleFileSelect: (event: React.ChangeEvent<HTMLInputElement>) => void;
+  handleFileRemove: () => void;
+  prepareAttachment: () => AttachmentRequest | undefined;
+};
+//#endregion
+//#region src/hooks/useGrabAndScroll.d.ts
+declare const useGrabAndScroll: (enabled: boolean, chunkWidth: number, speed?: number, offset?: number) => {
+  containerRef: react1.RefObject<HTMLDivElement>;
+  leftArrow: boolean;
+  rightArrow: boolean;
+  animationTrigger: () => void;
+  onNext: (cardsToSlide: number) => void;
+  onPrevious: (cardsToSlide: number) => void;
+};
+//#endregion
+//#region src/hooks/useHideElements.d.ts
 /**
- * Enum of all widget names. These are widgets that are rendered and integrated into
- * a merchant's website.
+ * This hook hides/shows elements that could overlap with the chat when the chat is opened/closed.
  */
-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",
+declare const useHideElements: () => void;
+//#endregion
+//#region src/hooks/useHorizontalScrollAnimation.d.ts
+interface UseHorizontalScrollAnimationOptions {
+  scrollContainerRef: RefObject<HTMLDivElement>;
+  animationSpeed?: 'standard' | 'slow' | 'none';
 }
+declare function useHorizontalScrollAnimation({
+  scrollContainerRef,
+  animationSpeed
+}: UseHorizontalScrollAnimationOptions): void;
 //#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",
+//#region src/hooks/useImageResolver.d.ts
+declare const useImageResolver: () => {
+  resolve: (image?: string, size?: number) => string | undefined;
+};
+//#endregion
+//#region src/hooks/useIntersection.d.ts
+declare const useIntersection: (element: RefObject<HTMLElement>, rootMargin: string) => boolean;
+//#endregion
+//#region src/hooks/useIsSmallScreen.d.ts
+declare const useIsSmallScreen: () => boolean;
+//#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/hooks/useMessageScrollObserver.d.ts
+declare const useMessageScrollObserver: (boxRef: React.RefObject<HTMLDivElement>, scrollRef: React.RefObject<HTMLDivElement>, onScrollChange: (position: number) => void) => void;
+//#endregion
+//#region src/hooks/useReducedMotionWithOverride.d.ts
+declare const useReducedMotionWithOverride: () => any;
+//#endregion
+//#region src/hooks/utils.d.ts
+declare const enum SearchResultsState {
+  Loading = 0,
+  Results = 1,
+  NoResults = 2,
 }
 //#endregion
+//#region src/hooks/useSearch.d.ts
+interface SearchResultsHocProps {
+  searchData: SearchResult | null;
+  searchResponseId: string;
+  merchantShortName: string;
+  productCardConfig: ProductCardConfig;
+  productList: SearchResponseProduct[];
+  autocompleteResults: string[];
+  searchFilters: SearchFilter[];
+  availableDynamicFilters: {
+    name: string;
+    displayName: string;
+  }[];
+  selectedFilterOptions: SelectedFilterOption[];
+  searchText: string;
+  searchResultsState: SearchResultsState;
+  isLoadingAutocomplete: boolean;
+  isLoadingSearch: boolean;
+  isFilterOpen: boolean;
+  isDirty: boolean;
+  focusedIndex: number;
+  focusedOptionId: string | undefined;
+  filterButtonText: string;
+  onSearchInputChange: (value: string) => void;
+  onSubmitSearch: () => void;
+  onAutocompleteSelect: (suggestion: string) => void;
+  onKeyDown: (event: React.KeyboardEvent<HTMLInputElement>) => void;
+  onToggleDynamicFilter: ({
+    filter,
+    dynamicFilterDisplayName
+  }: {
+    filter: string;
+    dynamicFilterDisplayName: string;
+  }) => void;
+  onSelectFilterItem: SelectFilterItem;
+  onRemoveFilter: (filter: SelectedFilterOption) => void;
+  onClearAllFilters: () => void;
+  setIsFilterOpen: (isFilterOpen: boolean) => void;
+  searchResultsRef: React.RefObject<HTMLDivElement>;
+}
+declare const useSearch: () => SearchResultsHocProps;
+//#endregion
+//#region src/hooks/useSnapCalculator.d.ts
+type Unit = 'percent' | 'pixel';
+declare const useSnapCalculator: (snaps: number[], maxHeight: number, unit: Unit) => {
+  viewportHeightPx: number;
+  snapsToPixels: number[];
+  swipeviewHeightPx: number;
+  getPixelToSnap: (pixels: number) => number;
+  getSnapToPixel: (snap: number) => number;
+};
+//#endregion
+//#region src/hooks/useSnapControl.d.ts
+type SnapControl = {
+  animationKey?: MotionValue;
+  animation: ValueAnimationTransition;
+  height: number;
+  unit: Unit;
+  snaps: number[];
+  initSnap: number;
+  threshold?: number;
+  overlayOpacity: number;
+  onSnapComplete: (currentSnap: number, nextSnap: number, collapsed: boolean) => void;
+};
+declare const useSnapControl: ({
+  animationKey,
+  animation,
+  height,
+  unit,
+  snaps,
+  initSnap,
+  onSnapComplete,
+  overlayOpacity
+}: SnapControl) => {
+  scope: motion_dom0.AnimationScope<any>;
+  animatedY: MotionValue<any> | MotionValue<number>;
+  animate: {
+    (sequence: framer_motion0.AnimationSequence, options?: framer_motion0.SequenceOptions | undefined): motion_dom0.AnimationPlaybackControlsWithThen;
+    (value: string | MotionValue<string>, keyframes: string | motion_dom0.UnresolvedValueKeyframe<string>[], options?: ValueAnimationTransition<string> | undefined): motion_dom0.AnimationPlaybackControlsWithThen;
+    (value: number | MotionValue<number>, keyframes: number | motion_dom0.UnresolvedValueKeyframe<number>[], options?: ValueAnimationTransition<number> | undefined): motion_dom0.AnimationPlaybackControlsWithThen;
+    <V extends string | number>(value: V | MotionValue<V>, keyframes: V | motion_dom0.UnresolvedValueKeyframe<V>[], options?: ValueAnimationTransition<V> | undefined): motion_dom0.AnimationPlaybackControlsWithThen;
+    (element: motion_dom0.ElementOrSelector, keyframes: motion_dom0.DOMKeyframesDefinition, options?: motion_dom0.AnimationOptions | undefined): motion_dom0.AnimationPlaybackControlsWithThen;
+    <O extends {}>(object: O | O[], keyframes: framer_motion0.ObjectTarget<O>, options?: motion_dom0.AnimationOptions | undefined): motion_dom0.AnimationPlaybackControlsWithThen;
+  };
+  swipeviewHeightPx: number;
+  initSnapInPixels: number;
+  contentHeight: MotionValue<number>;
+  currentSnap: number;
+  displayOverlay: MotionValue<string>;
+  opacityOverlay: MotionValue<number>;
+  getSnapToPixel: (snap: number) => number;
+  jumpTo: (snapPx: number) => {
+    nextSnap: number;
+    collapsed: boolean;
+  };
+  defineNextSnapByPosition: () => number;
+  resetControls: () => number;
+};
+//#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/useTrackComponentVisibleEvent.d.ts
 /**
  * Tracks a component and logs an event to Amplitude when the component is visible.
@@ -327,9 +268,6 @@ declare enum SpiffyMetricsEventName {
  */
 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
@@ -337,21 +275,4 @@ declare const useIntersection: (element: RefObject<HTMLElement>, rootMargin: str
  */
 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 };
+export { ElementObserverUtility, SearchResultsHocProps, Unit, useBlockBackButton, useChatToggle, useCustomerSupportHandoff, useDebounce, useDynamicVariants, useElementObserver, useFileUpload, useGrabAndScroll, useHideElements, useHorizontalScrollAnimation, useImageResolver, useIntersection, useIsSmallScreen, useMessageFilter, useMessageScrollObserver, useReducedMotionWithOverride, useSearch, useSnapCalculator, useSnapControl, useSystemSettingsContext, useTrackComponentVisibleEvent, useUpdateAnalyticsProps };