@cimulate/copilot-widget 1.29.1 → 1.30.0

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

@@ -47,6 +47,8 @@ declare type AllCopilotEvents = {
     bypassHandlers?: boolean;
 } & (AskCimAck | CopilotEvent | ConversationResetAck | Inquiry | DisplayProducts | FollowUp | PartialInquiry | RefinedSearch | RefinedBrowse | CopilotBrowseAck | Progress | ProductViewAck | CopilotError);
 
+declare type AskCimEntryParams = Record<string, never>;
+
 declare interface BaseSearchParams {
     facetFilters?: Record<string, string[]>;
     catalogSegment?: string | null;
@@ -67,6 +69,8 @@ declare namespace browse {
     }
 }
 
+declare type BrowseEntryParams = BrowsePayload["browseParams"];
+
 declare interface BrowsePayload extends CopilotBrowse {
     browseParams: Omit<BrowseState, "page" | "pageSize" | "includeFacets"> & {
         catalogSegment?: string;
@@ -142,6 +146,8 @@ declare namespace copilot {
         state,
         injectCopilotWidget,
         CopilotWidgetProps,
+        EntryType,
+        InitialEntry,
         ComponentType,
         SearchPayload,
         WidgetMode
@@ -197,7 +203,11 @@ declare interface CopilotWidgetProps extends CimCopilotSdkConfig {
     showProductDescription?: boolean;
     theme?: ThemeConfig;
     openLinksInNewTab?: boolean;
+    /**
+     * @deprecated This setting has been moved to the initialEntry object. Please use initialEntry.type instead.
+     */
     entryType?: EntryType;
+    initialEntry?: InitialEntry;
     entryMessage?: string;
     disclaimerText?: string;
     disclaimerMarkdown?: string;
@@ -278,15 +288,15 @@ declare const CopilotWidgetProvider: ({ mode, apiKey, apiToken, baseUrl, custome
 
 declare type DialogPosition = "top" | "top-left" | "top-right" | "bottom" | "bottom-left" | "bottom-right" | "left" | "right" | "center";
 
-declare type EntryType = "search" | "browse" | "pdp" | "ask_cim";
+declare const ENTRY_TYPES: readonly ["ask_cim", "search", "browse", "pdp"];
+
+declare type EntryType = (typeof ENTRY_TYPES)[number];
 
 declare const eventHandlers: {
     search: typeof search;
     browse: typeof browse;
     pdp: {
-        setPdpContext: (context: ProductView & {
-            productName?: string;
-        }) => void;
+        setPdpContext: (context: PdpEntryParams) => void;
         updatePdpProductId: (pid: string) => void;
         updatePdpLink: (link: string) => void;
     };
@@ -333,6 +343,20 @@ declare interface HeaderConfig {
     headerTextTextAlign?: "left" | "center" | "right";
 }
 
+declare type InitialEntry = {
+    type: "search";
+    params: SearchEntryParams;
+} | {
+    type: "browse";
+    params: BrowseEntryParams;
+} | {
+    type: "pdp";
+    params: PdpEntryParams;
+} | {
+    type: "ask_cim";
+    params?: AskCimEntryParams;
+};
+
 declare const injectCopilotWidget: ({ timeout, elementId, ...props }: CopilotWidgetProps & {
     timeout?: number;
     elementId: string;
@@ -400,6 +424,10 @@ declare interface MessagingModeConfig {
  */
 declare type OverrideTagName = string;
 
+declare type PdpEntryParams = ProductView & {
+    productName?: string;
+};
+
 declare interface ProductResultDetail {
     agentSessionId: string;
     kind: "search" | "detail";
@@ -453,6 +481,8 @@ declare namespace search {
     }
 }
 
+declare type SearchEntryParams = SearchPayload["searchParams"];
+
 declare interface SearchPayload extends CopilotSearch {
     searchParams: Omit<SearchState, "page" | "pageSize" | "includeFacets"> & {
         catalogSegment?: string;
@@ -477,13 +507,13 @@ declare namespace session {
  * Performs a bulk update of user's browse context. This will override
  * all existing browse parameters.
  */
-declare const setBrowseContext: (context: BrowsePayload["browseParams"]) => void;
+declare const setBrowseContext: (context: BrowseEntryParams) => 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 const setSearchContext: (context: SearchEntryParams) => void;
 
 declare interface SocketSdkContextType {
     copilot: CimulateCopilot | null;
@@ -520,12 +550,10 @@ declare interface SocketSdkContextType {
 declare const state: () => Readonly<{
     search: Readonly<SearchState>;
     browse: Readonly<BrowseState>;
-    pdp: Readonly<ProductView & {
-        productName?: string;
-    }>;
+    pdp: Readonly<PdpEntryParams>;
     isConnected: boolean;
     isOpen: boolean;
-    entryType: EntryType;
+    entryType: "ask_cim" | "search" | "browse" | "pdp";
 }>;
 
 declare type StaticQuestionsStrategy = "override" | "append" | "prepend";