@cimulate/copilot-widget 0.15.0 → 0.16.0

package/dist/cimulate-copilot-widget.d.ts

@@ -1,4 +1,5 @@
 import { ConnectAck } from '@cimulate/copilot-sdk';
+import { CopilotBrowseAck } from '@cimulate/copilot-sdk';
 import { CopilotBrowseSuggestion } from '@cimulate/copilot-sdk';
 import { CopilotError } from '@cimulate/copilot-sdk';
 import { CopilotEvent } from '@cimulate/copilot-sdk';
@@ -7,29 +8,55 @@ import { CopilotSearchSuggestion } from '@cimulate/copilot-sdk';
 import { DialogPosition } from './models';
 import { DisplayProducts } from '@cimulate/copilot-sdk';
 import { FacetedNavigationSuggestion } from '@cimulate/copilot-sdk';
-import { FacetFilters } from './models';
 import { FollowUp } from '@cimulate/copilot-sdk';
 import { Inquiry } from '@cimulate/copilot-sdk';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { PartialInquiry } from '@cimulate/copilot-sdk';
+import { ProductView } from '@cimulate/copilot-sdk';
+import { ProductViewAck } from '@cimulate/copilot-sdk';
 import { ProductViewSuggestion } from '@cimulate/copilot-sdk';
 import { Progress } from '@cimulate/copilot-sdk';
 import { ReactNode } from 'react';
 import { RefinedSearch } from '@cimulate/copilot-sdk';
 import { SearchParams } from '@cimulate/copilot-sdk';
-import { SearchPayload as SearchPayload_2 } from './models';
 import { SocketSdkContextType } from './SocketSdkContext';
 
 declare type AllCopilotEvents = {
     isUserAction?: boolean;
-    isInitialSearch?: boolean;
+    isInitial?: boolean;
     message: string;
     request?: CopilotSearch;
     searchParams?: SearchParams;
     suggestions?: Suggestion[];
+    eventSourceId?: string;
     toolName?: string;
     thought?: string;
-} & (CopilotEvent | Inquiry | DisplayProducts | FollowUp | PartialInquiry | RefinedSearch | Progress | CopilotError);
+} & (CopilotEvent | Inquiry | DisplayProducts | FollowUp | PartialInquiry | RefinedSearch | CopilotBrowseAck | Progress | ProductViewAck | CopilotError);
+
+declare namespace browse {
+    export {
+        setBrowseContext,
+        updateBrowseCategoryId,
+        updateFacetFilters_2 as updateFacetFilters,
+        updateFacetFilter_2 as updateFacetFilter,
+        updateRangeFilters_2 as updateRangeFilters,
+        updateRangeFilter_2 as updateRangeFilter,
+        updateCatalogSegment_2 as updateCatalogSegment,
+        updatePricebooks_2 as updatePricebooks
+    }
+}
+
+declare interface BrowsePayload {
+    userPrompt?: string;
+    browseParams: Omit<BrowseState, "page" | "pageSize" | "includeFacets"> & {
+        catalogSegment?: string;
+        pricebooks?: string[];
+    };
+}
+
+declare interface BrowseState extends CommonParams {
+    categoryId: string;
+}
 
 declare type CimCopilotSdkConfig = {
     apiKey?: string;
@@ -37,6 +64,16 @@ declare type CimCopilotSdkConfig = {
     baseUrl?: string;
 };
 
+declare interface CommonParams {
+    page?: number | null;
+    pageSize?: number | null;
+    includeFacets?: boolean;
+    facetFilters?: FacetFilters;
+    rangeFilters?: RangeFilters;
+    catalogSegment?: string | null;
+    pricebooks?: string[] | null;
+}
+
 export declare type ComponentType = "chat" | "dialog" | "modal";
 
 /**
@@ -80,21 +117,12 @@ export declare interface CopilotWidgetProps extends CimCopilotSdkConfig {
 }
 
 export declare const eventHandlers: {
-    search: {
-        setSearchContext: (context: SearchPayload_2["searchParams"]) => void;
-        updateSearchQuery: (query: string) => void;
-        updateFacetFilter: (field: string, value: string) => void;
-        updateFacetFilters: (facetFilters: FacetFilters) => void;
-        updateRangeFilter: ({ field, value }: {
-            field: string;
-            value: [number, number];
-        }) => void;
-        updateRangeFilters: (rangeFilters: {
-            field: string;
-            min: number;
-            max: number;
-        }[]) => void;
-        updateCatalogSegment: (segment: string | null) => void;
+    search: typeof search;
+    browse: typeof browse;
+    pdp: {
+        setPdpContext: (context: ProductView) => void;
+        updatePdpProductId: (pid: string) => void;
+        updatePdpLink: (link: string) => void;
     };
     components: {
         toggleWidgetOpen: (isOpen?: boolean) => void;
@@ -104,7 +132,7 @@ export declare const eventHandlers: {
     };
 };
 
-declare type FacetFilters_2 = Record<string, string[]>;
+declare type FacetFilters = Record<string, string[]>;
 
 export declare const injectCopilotWidget: ({ timeout, elementId, ...props }: CopilotWidgetProps & {
     timeout?: number;
@@ -117,6 +145,19 @@ declare type RangeFilters = Array<{
     max: number;
 }>;
 
+declare namespace search {
+    export {
+        setSearchContext,
+        updateSearchQuery,
+        updateFacetFilters,
+        updateFacetFilter,
+        updateRangeFilters,
+        updateRangeFilter,
+        updateCatalogSegment,
+        updatePricebooks
+    }
+}
+
 export declare interface SearchPayload {
     userPrompt?: string;
     searchParams: Omit<SearchState, "page" | "pageSize" | "includeFacets"> & {
@@ -125,17 +166,22 @@ export declare interface SearchPayload {
     };
 }
 
-declare interface SearchState {
+declare interface SearchState extends CommonParams {
     query: string;
-    page?: number | null;
-    pageSize?: number | null;
-    includeFacets?: boolean;
-    facetFilters?: FacetFilters_2;
-    rangeFilters?: RangeFilters;
-    catalogSegment?: string | null;
-    pricebooks?: string[] | null;
 }
 
+/**
+ * Performs a bulk update of user's browse context. This will override
+ * all existing browse parameters.
+ */
+declare const setBrowseContext: (context: BrowsePayload["browseParams"]) => void;
+
+/**
+ * Performs a bulk update of user's search context. This will override
+ * all existing search parameters.
+ */
+declare const setSearchContext: (context: SearchPayload["searchParams"]) => void;
+
 declare type Suggestion = CopilotSearchSuggestion | FacetedNavigationSuggestion | ProductViewSuggestion | CopilotBrowseSuggestion;
 
 declare interface ThemeConfig {
@@ -147,6 +193,48 @@ declare interface ThemeConfig {
     borderColor?: string;
 }
 
+declare const updateBrowseCategoryId: (categoryId: string) => void;
+
+declare const updateCatalogSegment: (segment: string | null) => void;
+
+declare const updateCatalogSegment_2: (segment: string | null) => void;
+
+declare const updateFacetFilter: (field: string, value: string) => void;
+
+declare const updateFacetFilter_2: (field: string, value: string) => void;
+
+declare const updateFacetFilters: (facetFilters: FacetFilters) => void;
+
+declare const updateFacetFilters_2: (facetFilters: FacetFilters) => void;
+
+declare const updatePricebooks: (pricebooks: string[] | null) => void;
+
+declare const updatePricebooks_2: (pricebooks: string[] | null) => void;
+
+declare const updateRangeFilter: ({ field, value }: {
+    field: string;
+    value: [number, number];
+}) => void;
+
+declare const updateRangeFilter_2: ({ field, value }: {
+    field: string;
+    value: [number, number];
+}) => void;
+
+declare const updateRangeFilters: (rangeFilters: {
+    field: string;
+    min: number;
+    max: number;
+}[]) => void;
+
+declare const updateRangeFilters_2: (rangeFilters: {
+    field: string;
+    min: number;
+    max: number;
+}[]) => void;
+
+declare const updateSearchQuery: (query: string) => void;
+
 export declare const useCopilot: () => SocketSdkContextType;
 
 /**