@cimulate/copilot-widget 1.29.1 → 1.30.0

package/dist/messaging.d.ts

@@ -62,7 +62,7 @@ export declare const AgentForceWidget: (props: CopilotWidgetProps) => JSX_2.Elem
  * UIStateContext >
  * MessagingProvider (Agentforce/SCRT2 SDK)
  */
-export declare const AgentforceWidgetProvider: ({ mode, apiKey, apiToken, baseUrl, logoUrl, headerText, headerConfig, theme, openLinksInNewTab, globalClassName, isDevelopment, componentType, componentConfig, entryType, entryMessage, disclaimerText, disclaimerMarkdown, clientContext, searchPlaceholder, searchButtonLabel, searchConfig, suggestionButtonConfig, messageAlignment, autoScroll, promptsConfig, showProductDescription, resetConversationMessage, conversationHistory, messagingConfig, overrides, overridesUrl, inlineOverrides, __features, children, }: CopilotWidgetProps & {
+export declare const AgentforceWidgetProvider: ({ mode, apiKey, apiToken, baseUrl, logoUrl, headerText, headerConfig, theme, openLinksInNewTab, globalClassName, isDevelopment, componentType, componentConfig, entryType, initialEntry, entryMessage, disclaimerText, disclaimerMarkdown, clientContext, searchPlaceholder, searchButtonLabel, searchConfig, suggestionButtonConfig, messageAlignment, autoScroll, promptsConfig, showProductDescription, resetConversationMessage, conversationHistory, messagingConfig, overrides, overridesUrl, inlineOverrides, __features, children, }: CopilotWidgetProps & {
     overridesUrl?: string;
     inlineOverrides?: ComponentOverrides;
     children: ReactNode;
@@ -82,6 +82,22 @@ 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 type BrowseEntryParams = BrowsePayload["browseParams"];
+
+declare interface BrowsePayload extends CopilotBrowse {
+    browseParams: Omit<BrowseState, "page" | "pageSize" | "includeFacets"> & {
+        catalogSegment?: string;
+        pricebooks?: string[];
+    };
+}
+
+declare interface BrowseState extends CommonParams {
+    categoryId: string;
+    categoryName?: string;
+}
+
 declare type CartDetails = {
     id: string;
     currencyCode: string;
@@ -168,6 +184,16 @@ declare interface ClientContext {
     [key: string]: string | number;
 }
 
+declare interface CommonParams {
+    page?: number | null;
+    pageSize?: number | null;
+    includeFacets?: boolean;
+    facetFilters?: FacetFilters;
+    rangeFilters?: RangeFilters;
+    catalogSegment?: string | null;
+    pricebooks?: string[] | null;
+}
+
 declare type ComparisonTableRow = {
     row_name: string;
     values: string[];
@@ -224,7 +250,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;
@@ -287,7 +317,9 @@ declare interface CopilotWidgetProps extends CimCopilotSdkConfig {
 
 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"];
+
+export declare type EntryType = (typeof ENTRY_TYPES)[number];
 
 export declare const eventHandlers: {
     components: {
@@ -307,6 +339,8 @@ export declare const eventHandlers: {
     };
 };
 
+declare type FacetFilters = Record<string, string[]>;
+
 declare interface HeaderConfig {
     logoUrl?: string;
     headerText?: string;
@@ -318,6 +352,20 @@ declare interface HeaderConfig {
     headerTextTextAlign?: "left" | "center" | "right";
 }
 
+export declare type InitialEntry = {
+    type: "search";
+    params: SearchEntryParams;
+} | {
+    type: "browse";
+    params: BrowseEntryParams;
+} | {
+    type: "pdp";
+    params: PdpEntryParams;
+} | {
+    type: "ask_cim";
+    params?: AskCimEntryParams;
+};
+
 export declare const injectMessagingWidget: ({ timeout, elementId, overridesUrl, overrides: inlineOverrides, ...props }: InjectMessagingWidgetOptions) => void;
 
 declare interface InjectMessagingWidgetOptions extends Omit<CopilotWidgetProps, "apiKey" | "apiToken" | "baseUrl" | "mode"> {
@@ -364,16 +412,13 @@ export declare interface MessagingContextType {
     isAgentTyping: boolean;
     conversationId: string | null;
     messages: MessagingMessage[];
-    /** In-progress response blocks streamed before the final message arrives. */
     streamingBlocks: ResponseItem[];
     /**
      * Loading text for the action the agent is currently executing, from the
      * agent action's `progress_indicator_message`. Empty when none is active.
      */
     progressMessage: string;
-    /** Accumulating list of progress step messages for the current turn. */
     progressSteps: string[];
-    /** Whether the messaging is currently loading */
     loading: boolean;
     /**
      * True while a silent cart update is in flight. Silent sends leave `loading`
@@ -383,22 +428,12 @@ export declare interface MessagingContextType {
     cartUpdating: boolean;
     error: string | null;
     sendError: SendError | null;
-    /**
-     * True when an idle session expired in the background and its restart was
-     * deferred until the user interacts. The composer stays enabled in this
-     * state so the next message can trigger a fresh session.
-     */
     sessionExpired: boolean;
     sendMessage: SendMessage;
     addToCart: (params: AddToCartParams) => void;
     resetConversation: () => void;
     retryLastMessage: () => ReturnType<SendMessage> | undefined;
     retryConnection: () => void;
-    /**
-     * Download the current conversation's transcript as a PDF. Resolves once the
-     * browser download has been triggered; rejects if no conversation is active
-     * or the request fails.
-     */
     downloadTranscript: () => Promise<void>;
 }
 
@@ -433,7 +468,6 @@ export declare interface MessagingMessage {
         role: string;
         name?: string;
     };
-    /** The raw event data for advanced consumers */
     raw?: AgentforceMessageEvent;
 }
 
@@ -706,6 +740,10 @@ declare interface OverrideSendMessageOptions {
  */
 export declare type OverrideTagName = string;
 
+declare type PdpEntryParams = ProductView & {
+    productName?: string;
+};
+
 declare type PriceBreakdown = {
     original?: PriceBucket | null;
     sales?: PriceBucket | null;
@@ -856,8 +894,27 @@ declare type PromptsExtensionState = {
 
 declare type PromptsParams = AskCimSuggestions | CopilotSearchSuggestions | CopilotBrowseSuggestions | ProductViewSuggestions;
 
+declare type RangeFilters = Array<{
+    field: string;
+    min: number;
+    max: number;
+}>;
+
 declare type ResponseItem = MarkdownResponse | ProductCarouselResponse | ProductTileResponse | ProductComparisonResponse | SuggestionsResponse | CartResponse | OrderConfirmationResponse | ToolResultsResponse;
 
+declare type SearchEntryParams = SearchPayload["searchParams"];
+
+declare interface SearchPayload extends CopilotSearch {
+    searchParams: Omit<SearchState, "page" | "pageSize" | "includeFacets"> & {
+        catalogSegment?: string;
+        pricebooks?: string[];
+    };
+}
+
+declare interface SearchState extends CommonParams {
+    query: string;
+}
+
 /**
  * A retryable message-send failure: the connection is live but the send itself
  * failed (5xx / network / timeout, not a session expiry). Holds what's needed
@@ -876,6 +933,7 @@ export declare type SendMessage = (text: string, options?: SendMessageOptions) =
 export declare interface SendMessageOptions {
     silent?: boolean;
     reconcileMessageId?: string;
+    displayContent?: string;
 }
 
 export declare type SendMessageResult = {