@cimulate/copilot-widget 1.22.1 → 1.24.0

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

@@ -20,7 +20,7 @@ import { DisplayProducts } from '@cimulate/copilot-sdk';
 import { FacetedNavigationSuggestion } from '@cimulate/copilot-sdk';
 import { FollowUp } from '@cimulate/copilot-sdk';
 import { Inquiry } from '@cimulate/copilot-sdk';
-import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { JSX as JSX_2 } from 'react';
 import { PartialInquiry } from '@cimulate/copilot-sdk';
 import { ProductView } from '@cimulate/copilot-sdk';
 import { ProductViewAck } from '@cimulate/copilot-sdk';
@@ -101,6 +101,28 @@ declare interface CommonParams {
     pricebooks?: string[] | null;
 }
 
+/**
+ * One flat map from override key to custom-element tag name.
+ *
+ * `ProductTile` and `ProductCarousel` are the only keys the widget consults for
+ * its built-in product UI: register one and the widget mounts your element in
+ * place of the default tile/carousel (leave it unset and the built-in renders).
+ * Every other key is matched against a `type:"tool_results"` block's top-level
+ * `output_name` (never a field inside the arbitrary `data` payload); an unmatched
+ * block renders nothing. All of them receive the same `OverrideProps`.
+ *
+ *   { ProductTile: "cx-product-card", recentOrders: "cx-recent-orders" }
+ *
+ * Widget chrome (header, search bar, follow-up suggestions) is intentionally NOT
+ * overridable: those keys are accepted by the open index signature but have no
+ * render path, so they are silently ignored.
+ */
+declare interface ComponentOverrides {
+    ProductTile?: OverrideTagName;
+    ProductCarousel?: OverrideTagName;
+    [key: string]: OverrideTagName | undefined;
+}
+
 declare type ComponentType = "chat" | "dialog" | "modal";
 
 declare namespace copilot {
@@ -167,6 +189,7 @@ declare interface CopilotWidgetProps extends CimCopilotSdkConfig {
     suggestionButtonConfig?: SuggestionButtonConfig;
     messageAlignment?: MessageAlignment;
     autoScroll?: boolean;
+    showProductDescription?: boolean;
     theme?: ThemeConfig;
     openLinksInNewTab?: boolean;
     entryType?: EntryType;
@@ -220,6 +243,9 @@ declare interface CopilotWidgetProps extends CimCopilotSdkConfig {
      * Configuration for messaging mode. Required when mode is 'messaging'.
      */
     messagingConfig?: MessagingModeConfig;
+    overrides?: ComponentOverrides;
+    overridesUrl?: string;
+    inlineOverrides?: ComponentOverrides;
     /**
      *
      * Enables features not yet released. They may require additional backend support and are subject to change.
@@ -323,13 +349,9 @@ declare type MessageAlignment = "start" | "end";
  * Configuration for messaging mode (SCRT2 Agentforce).
  */
 declare interface MessagingModeConfig {
-    /** SCRT2 instance URL (e.g. "https://xyz.salesforce-scrt.com") */
     scrt2Url: string;
-    /** Salesforce Organization ID */
     orgId: string;
-    /** Embedded Service developer name */
     esDeveloperName: string;
-    /** Optional routing attributes for the conversation */
     routingAttributes?: Record<string, string>;
     /**
      * Capabilities version for the SCRT2 token request. Required (>= "63", i.e.
@@ -339,20 +361,30 @@ declare interface MessagingModeConfig {
      */
     capabilitiesVersion?: string;
     /**
-     * Shows a "Download transcript" option in the widget's overflow menu that
-     * saves the current conversation as a PDF. Defaults to true; set to false to
-     * hide it. Requires the org's messaging channel to allow transcript download.
+     * Requires the org's messaging channel to allow transcript download.
      */
     enableDownloadTranscript?: boolean;
     /**
-     * Shows a "Connect to a human agent" button in the messaging search bar that
-     * asks the Agentforce agent to escalate the conversation to a human. Defaults
-     * to false; set to true to show it. Requires the org's Agentforce agent to be
+     * Requires the org's Agentforce agent to be
      * configured with an escalation path/topic, otherwise the button is a no-op.
      */
     enableEscalationToAgent?: boolean;
+    showProductCaptions?: boolean;
 }
 
+/**
+ * A component override is the tag name of a pre-registered custom element
+ * (e.g. "product-card"). The widget creates the element via
+ * document.createElement(tagName) and assigns `OverrideProps` to its `props`
+ * setter. The element must be registered with customElements.define before the
+ * widget renders.
+ *
+ * The name must be a valid custom element name — it has to contain a hyphen and
+ * be all lowercase. Anything else (e.g. "ProductTile" or "div") is rejected with
+ * a console error and the slot renders blank.
+ */
+declare type OverrideTagName = string;
+
 declare type PromptsDisplay = "input" | "buttons" | "both";
 
 declare type PromptsExtensionConfig = Omit<PromptsExtensionState, "isInitialized" | "activePromptsId" | "userPrompt" | "promptsMessage" | "responseMessage" | "isResponseLoading" | "placeholder" | "askElseButtonLabel" | "entryType" | "params" | "promptsDisplay" | "disableAskElseButton"> & Partial<Pick<PromptsExtensionState, "placeholder" | "askElseButtonLabel" | "entryType" | "params" | "promptsDisplay" | "disableAskElseButton">>;