@envive-ai/react-hooks 0.1.0 → 0.1.1

package/dist/{homegrownCannabis-C-kw-74X.js → homegrownCannabis-BScZhy9v.js}

@@ -1,10 +1,10 @@
-import "./models-DHdb7QWn.js";
-import { ColorNames, CustomerServiceIntegrationMode, CustomerServiceType, OrgShortName, PageVariantTestType, WidgetType, colorVar } from "./types-CYNvLeSA.js";
+import { DOMInsertionType } from "./domInsertionService-BtzuH2Sc.js";
+import { ColorNames, CustomerServiceIntegrationMode, CustomerServiceType, OrgShortName, PageVariantTestType, WidgetType, colorVar } from "./types-DZzSQ5a6.js";
 import "./enviveConfigContext-CUGLpPGU.js";
-import { BOTTOM_REVIEWS_BAR_ID, BOTTOM_SUGGESTION_BAR_TESTID, CHAT_PREVIEW_CONTAINER_ID, CHAT_PREVIEW_TESTID, DOMInsertionType, TOP_SUGGESTION_BAR_PDP_ID, TOP_SUGGESTION_BAR_TESTID } from "./divIds-Bss-btao.js";
-import { ChatElementDisplayLocation, SuggestionBarLocationForMetrics } from "./suggestionBarV2-types-BllzwsBD.js";
-import { CdnService } from "./cdnService-zQfKk3Eb.js";
-import { defaultOrgUIConfig } from "./default-C2fEZKXk.js";
+import { BOTTOM_REVIEWS_BAR_ID, BOTTOM_SUGGESTION_BAR_TESTID, CHAT_PREVIEW_CONTAINER_ID, CHAT_PREVIEW_TESTID, TOP_SUGGESTION_BAR_PDP_ID, TOP_SUGGESTION_BAR_TESTID } from "./divIds-Cfp3v_rG.js";
+import { ChatElementDisplayLocation, SuggestionBarLocationForMetrics } from "./suggestionBarV2-types-aiQmVx5m.js";
+import { CdnService } from "./cdnService-CAyO3axV.js";
+import { defaultOrgUIConfig } from "./default-CL94oJfj.js";
 
 //#region src/merchants/homegrownCannabis/homegrownCannabis.ts
 const homegrownCannabisColors = {

package/dist/hooks/index.cjs

@@ -1,16 +1,28 @@
-require('../logger-Dln20ans.cjs');
-const require_contexts = require('../contexts-BYArqZtK.cjs');
-require('../models-ixxUsGL_.cjs');
-require('../types-C4T5UOIW.cjs');
+require('../GridInsertionService-CMJVhD6q.cjs');
+const require_contexts = require('../contexts-C4Iz162H.cjs');
+require('../domInsertionService-Cb9814oM.cjs');
+require('../types-QJObznro.cjs');
 require('../enviveConfigContext-Dfr2VH6u.cjs');
 
+exports.useBlockBackButton = require_contexts.useBlockBackButton;
 exports.useChatToggle = require_contexts.useChatToggle;
+exports.useCustomerSupportHandoff = require_contexts.useCustomerSupportHandoff;
+exports.useDebounce = require_contexts.useDebounce;
 exports.useDynamicVariants = require_contexts.useDynamicVariants;
 exports.useElementObserver = require_contexts.useElementObserver;
+exports.useFileUpload = require_contexts.useFileUpload;
+exports.useGrabAndScroll = require_contexts.useGrabAndScroll;
 exports.useHideElements = require_contexts.useHideElements;
+exports.useHorizontalScrollAnimation = require_contexts.useHorizontalScrollAnimation;
+exports.useImageResolver = require_contexts.useImageResolver;
 exports.useIntersection = require_contexts.useIntersection;
 exports.useIsSmallScreen = require_contexts.useIsSmallScreen;
 exports.useMessageFilter = require_contexts.useMessageFilter;
+exports.useMessageScrollObserver = require_contexts.useMessageScrollObserver;
+exports.useReducedMotionWithOverride = require_contexts.useReducedMotionWithOverride;
+exports.useSearch = require_contexts.useSearch;
+exports.useSnapCalculator = require_contexts.useSnapCalculator;
+exports.useSnapControl = require_contexts.useSnapControl;
 exports.useSystemSettingsContext = require_contexts.useSystemSettingsContext;
 exports.useTrackComponentVisibleEvent = require_contexts.useTrackComponentVisibleEvent;
 exports.useUpdateAnalyticsProps = require_contexts.useUpdateAnalyticsProps;

package/dist/hooks/index.d.cts

@@ -1,7 +1,10 @@
-import { CamelCasedPropertiesDeep, ChatElementDisplayLocation, GenerationParams as GenerationParams$1 } from "../chatElementDisplayLocation-CX8fuNao.cjs";
+import { CamelCasedPropertiesDeep, ChatElementDisplayLocation, GenerationParams as GenerationParams$1, ProductCardConfig } from "../types-DGoFEos_.cjs";
 import * as react1 from "react";
 import { ReactElement, RefObject } from "react";
-import { CustServiceAttachment, FormType, FulfillmentDisplayStatus, ProductSearchResponseAttributes, ResponseCategory, ResponseProductAttributes } from "@spiffy-ai/commerce-api-client";
+import { AttachmentRequest, CustServiceAttachment, FormType, FulfillmentDisplayStatus, ProductSearchResponseAttributes, ResponseCategory, ResponseProductAttributes, SearchResponseProduct } 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 {
@@ -200,33 +203,37 @@ type OrderMessageMetadata = {
   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/hooks/useDebounce.d.ts
+declare function useDebounce<T>(value: T, delay: number): T;
+//#endregion
+//#region src/hooks/useDynamicVariants.d.ts
+declare const useDynamicVariants: () => void;
+//#endregion
 //#region src/application/utils/mouseEventTypes.d.ts
 type MouseEventTypes = 'click' | 'dblclick' | 'mouseup' | 'mousedown';
 //#endregion
@@ -265,6 +272,230 @@ interface ElementObserverUtility {
 }
 declare const useElementObserver: (selector: NodeSelector) => ElementObserverUtility;
 //#endregion
+//#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
+/**
+ * This hook hides/shows elements that could overlap with the chat when the chat is opened/closed.
+ */
+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/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/application/models/api/search.d.ts
+interface SearchResult {
+  products: SearchResponseProduct[];
+  filters: string[];
+  generatedQuery?: string;
+  totalProductCount: number;
+  searchResponseId: string;
+}
+//#endregion
+//#region src/atoms/search/searchAPI.d.ts
+type SelectedFilterOption = {
+  id: string;
+  displayName: string;
+  filterId: string;
+  filterItemId: string;
+};
+//#endregion
+//#region src/types/search-filter-types.d.ts
+type SelectFilterItem = ({
+  filterId,
+  filterItemId,
+  isSelected,
+  displayName
+}: {
+  filterId: string;
+  filterItemId: string;
+  isSelected: boolean;
+  displayName: string;
+}) => void;
+type SearchFilter = {
+  filterId: string;
+  displayName: string;
+  items: SearchFilterItem[];
+};
+type SearchFilterItem = {
+  filterItemId: string;
+  displayName: string;
+  productCount: number;
+  isSelected: boolean;
+};
+//#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/application/models/spiffyWidgets.d.ts
 /**
  * Enum of all widget names. These are widgets that are rendered and integrated into
@@ -327,9 +558,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 +565,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 };