@clivly/chat-widget 0.14.1 → 0.16.0

package/dist/index.d.cts

@@ -1,5 +1,26 @@
 import { Root } from "react-dom/client";
 import { CSSProperties, ReactElement } from "react";
+//#region src/layout.d.ts
+/**
+ * Where the widget sits on the host page, and what its launcher looks like.
+ *
+ * Until 0.16 the widget rendered in normal flow wherever it was mounted — the
+ * script tag inserted it directly after itself, so most embeds showed a
+ * full-width-label pill at the end of the page rather than a floating button.
+ * Floating in a corner is now the default; `"inline"` keeps the old behaviour
+ * for a host that positions the widget itself.
+ */
+type ChatWidgetPlacement = "bottom-left" | "bottom-right" | "inline";
+/**
+ * - `"auto"` (default): the labelled pill on wide screens, a 48px icon-only
+ *   button below 48rem, where a pill covers the host's own controls.
+ * - `"pill"`: always the labelled pill.
+ * - `"icon"`: always the icon-only button.
+ *
+ * The label stays the button's accessible name in every variant.
+ */
+type ChatWidgetLauncher = "auto" | "icon" | "pill";
+//#endregion
 //#region src/theme.d.ts
 /**
  * Theme resolution for the widget.
@@ -48,11 +69,30 @@ interface WidgetSummary {
 }
 interface WidgetMessage {
   author: string | null;
+  /**
+   * Set on messages the support assistant wrote (`greeting`, `topic`,
+   * `handoff`, `ai`, `ai_clarify`) and on a visitor's topic click
+   * (`topic_choice`). Absent or null on everything a person typed, and on
+   * every message from a server that predates the assistant.
+   */
+  automation?: string | null;
   body: string;
   createdAt: string;
   id: string;
   senderType: WidgetSenderType;
 }
+type WidgetSupportState = "automated" | "handoff" | "human";
+interface WidgetSupportTopic {
+  action: "answer" | "ask" | "link" | "human";
+  id: string;
+  label: string;
+}
+/** Guided support for one conversation. Answers stay on the server. */
+interface WidgetSupport {
+  mode: "human" | "guided" | "ai";
+  state: WidgetSupportState | null;
+  topics: WidgetSupportTopic[];
+}
 interface WidgetSessionPayload {
   contact: WidgetContact | null;
   conversation: WidgetConversation;
@@ -60,6 +100,8 @@ interface WidgetSessionPayload {
   messages: WidgetMessage[];
   /** Absolute socket URL returned by Clivly's bootstrap. */
   socketUrl?: string;
+  /** Absent or null when the widget has no guided support configured. */
+  support?: WidgetSupport | null;
   token: string;
   visitorToken: string;
   widget: WidgetSummary;
@@ -83,7 +125,13 @@ interface WidgetClientCreateMessageEvent {
 interface WidgetClientReadEvent {
   type: "conversation.read";
 }
-type WidgetClientEvent = WidgetClientCreateMessageEvent | WidgetClientReadEvent;
+/** The visitor picked a guided topic (see `ChatTransportConnection.selectTopic`). */
+interface WidgetClientTopicEvent {
+  id: string;
+  topicId: string;
+  type: "topic.select";
+}
+type WidgetClientEvent = WidgetClientCreateMessageEvent | WidgetClientReadEvent | WidgetClientTopicEvent;
 interface WidgetSessionReadyEvent {
   conversationId: string;
   type: "session.ready";
@@ -102,11 +150,20 @@ interface WidgetMessageAckEvent {
   message: WidgetMessage;
   type: "message.ack";
 }
+interface WidgetSupportStateEvent {
+  state: WidgetSupportState;
+  type: "support.state";
+}
+/** The assistant is preparing an answer (`thinking`) or has finished (`idle`). */
+interface WidgetAssistantStatusEvent {
+  status: "thinking" | "idle";
+  type: "assistant.status";
+}
 interface WidgetErrorEvent {
   message: string;
   type: "error";
 }
-type WidgetServerEvent = WidgetConversationSnapshotEvent | WidgetErrorEvent | WidgetMessageAckEvent | WidgetMessageCreatedEvent | WidgetSessionReadyEvent;
+type WidgetServerEvent = WidgetAssistantStatusEvent | WidgetConversationSnapshotEvent | WidgetErrorEvent | WidgetMessageAckEvent | WidgetMessageCreatedEvent | WidgetSessionReadyEvent | WidgetSupportStateEvent;
 //#endregion
 //#region src/transport.d.ts
 interface ChatTransportHandlers {
@@ -123,6 +180,11 @@ interface ChatTransportConnection {
    * without it still works, its visitors are just emailed replies they saw.
    */
   markRead?: () => void;
+  /**
+   * Send a guided-topic click. Optional: without it the widget sends the
+   * topic's label as an ordinary message, so a custom transport still works.
+   */
+  selectTopic?: (event: WidgetClientTopicEvent) => void;
   sendMessage: (event: WidgetClientCreateMessageEvent) => void;
 }
 interface CreateChatTransportOptions {
@@ -167,7 +229,17 @@ interface ChatWidgetProps {
   defaultVisitor?: Partial<ChatWidgetVisitor>;
   getSession: GetSession;
   initiallyOpen?: boolean;
+  /** Launcher shape; see {@link ChatWidgetLauncher}. Defaults to `"auto"`. */
+  launcher?: ChatWidgetLauncher;
+  /** The launcher's visible text, and always its accessible name. */
   launcherLabel?: string;
+  /**
+   * Where the widget sits; see {@link ChatWidgetPlacement}. Defaults to
+   * `"bottom-right"`, floating clear of the device's safe-area insets. Stacks
+   * at `--clivly-chat-z-index` (default 2147483000) — lower it through
+   * `style` to sit beneath the host's own dialogs.
+   */
+  placement?: ChatWidgetPlacement;
   storage?: Pick<Storage, "getItem" | "setItem">;
   /**
    * Inline styles on the widget root. The intended use is overriding palette
@@ -183,7 +255,7 @@ interface ChatWidgetProps {
   theme?: ChatWidgetTheme;
   widgetId: string;
 }
-export declare function ChatWidget({ className, createTransport, defaultVisitor, getSession, initiallyOpen, launcherLabel, storage, style, theme, widgetId }: ChatWidgetProps): ReactElement;
+export declare function ChatWidget({ className, createTransport, defaultVisitor, getSession, initiallyOpen, launcher, launcherLabel, placement, storage, style, theme, widgetId }: ChatWidgetProps): ReactElement;
 export declare function ChatLauncher(): null;
 export declare function ChatPanel(): null;
 export declare function MessageComposer(): null;
@@ -246,4 +318,4 @@ export declare const createClivlyTransport: typeof createClivlyTransport$1;
 export declare const mountChatWidget: typeof mountChatWidget$1;
 export declare const mountChatWidgetScript: typeof mountChatWidgetScript$1;
 //#endregion
-export type { ChatTransportConnection, ChatTransportHandlers, ChatWidgetProps, ChatWidgetTheme, ChatWidgetVisitor, CreateChatTransport, CreateChatTransportOptions, CreateLoopbackTransportOptions, CreateWebSocketTransportOptions, GetSession, GetSessionOptions, ResolvedTheme, WidgetClientCreateMessageEvent, WidgetClientEvent, WidgetClientReadEvent, WidgetConfig, WidgetContact, WidgetConversation, WidgetConversationSnapshotEvent, WidgetErrorEvent, WidgetMessage, WidgetMessageAckEvent, WidgetMessageCreatedEvent, WidgetSenderType, WidgetServerEvent, WidgetSessionPayload, WidgetSessionReadyEvent, WidgetSummary };
+export type { ChatTransportConnection, ChatTransportHandlers, ChatWidgetLauncher, ChatWidgetPlacement, ChatWidgetProps, ChatWidgetTheme, ChatWidgetVisitor, CreateChatTransport, CreateChatTransportOptions, CreateLoopbackTransportOptions, CreateWebSocketTransportOptions, GetSession, GetSessionOptions, ResolvedTheme, WidgetAssistantStatusEvent, WidgetClientCreateMessageEvent, WidgetClientEvent, WidgetClientReadEvent, WidgetClientTopicEvent, WidgetConfig, WidgetContact, WidgetConversation, WidgetConversationSnapshotEvent, WidgetErrorEvent, WidgetMessage, WidgetMessageAckEvent, WidgetMessageCreatedEvent, WidgetSenderType, WidgetServerEvent, WidgetSessionPayload, WidgetSessionReadyEvent, WidgetSummary, WidgetSupport, WidgetSupportState, WidgetSupportStateEvent, WidgetSupportTopic };

package/dist/index.d.mts

@@ -1,5 +1,26 @@
 import { Root } from "react-dom/client";
 import { CSSProperties, ReactElement } from "react";
+//#region src/layout.d.ts
+/**
+ * Where the widget sits on the host page, and what its launcher looks like.
+ *
+ * Until 0.16 the widget rendered in normal flow wherever it was mounted — the
+ * script tag inserted it directly after itself, so most embeds showed a
+ * full-width-label pill at the end of the page rather than a floating button.
+ * Floating in a corner is now the default; `"inline"` keeps the old behaviour
+ * for a host that positions the widget itself.
+ */
+type ChatWidgetPlacement = "bottom-left" | "bottom-right" | "inline";
+/**
+ * - `"auto"` (default): the labelled pill on wide screens, a 48px icon-only
+ *   button below 48rem, where a pill covers the host's own controls.
+ * - `"pill"`: always the labelled pill.
+ * - `"icon"`: always the icon-only button.
+ *
+ * The label stays the button's accessible name in every variant.
+ */
+type ChatWidgetLauncher = "auto" | "icon" | "pill";
+//#endregion
 //#region src/theme.d.ts
 /**
  * Theme resolution for the widget.
@@ -48,11 +69,30 @@ interface WidgetSummary {
 }
 interface WidgetMessage {
   author: string | null;
+  /**
+   * Set on messages the support assistant wrote (`greeting`, `topic`,
+   * `handoff`, `ai`, `ai_clarify`) and on a visitor's topic click
+   * (`topic_choice`). Absent or null on everything a person typed, and on
+   * every message from a server that predates the assistant.
+   */
+  automation?: string | null;
   body: string;
   createdAt: string;
   id: string;
   senderType: WidgetSenderType;
 }
+type WidgetSupportState = "automated" | "handoff" | "human";
+interface WidgetSupportTopic {
+  action: "answer" | "ask" | "link" | "human";
+  id: string;
+  label: string;
+}
+/** Guided support for one conversation. Answers stay on the server. */
+interface WidgetSupport {
+  mode: "human" | "guided" | "ai";
+  state: WidgetSupportState | null;
+  topics: WidgetSupportTopic[];
+}
 interface WidgetSessionPayload {
   contact: WidgetContact | null;
   conversation: WidgetConversation;
@@ -60,6 +100,8 @@ interface WidgetSessionPayload {
   messages: WidgetMessage[];
   /** Absolute socket URL returned by Clivly's bootstrap. */
   socketUrl?: string;
+  /** Absent or null when the widget has no guided support configured. */
+  support?: WidgetSupport | null;
   token: string;
   visitorToken: string;
   widget: WidgetSummary;
@@ -83,7 +125,13 @@ interface WidgetClientCreateMessageEvent {
 interface WidgetClientReadEvent {
   type: "conversation.read";
 }
-type WidgetClientEvent = WidgetClientCreateMessageEvent | WidgetClientReadEvent;
+/** The visitor picked a guided topic (see `ChatTransportConnection.selectTopic`). */
+interface WidgetClientTopicEvent {
+  id: string;
+  topicId: string;
+  type: "topic.select";
+}
+type WidgetClientEvent = WidgetClientCreateMessageEvent | WidgetClientReadEvent | WidgetClientTopicEvent;
 interface WidgetSessionReadyEvent {
   conversationId: string;
   type: "session.ready";
@@ -102,11 +150,20 @@ interface WidgetMessageAckEvent {
   message: WidgetMessage;
   type: "message.ack";
 }
+interface WidgetSupportStateEvent {
+  state: WidgetSupportState;
+  type: "support.state";
+}
+/** The assistant is preparing an answer (`thinking`) or has finished (`idle`). */
+interface WidgetAssistantStatusEvent {
+  status: "thinking" | "idle";
+  type: "assistant.status";
+}
 interface WidgetErrorEvent {
   message: string;
   type: "error";
 }
-type WidgetServerEvent = WidgetConversationSnapshotEvent | WidgetErrorEvent | WidgetMessageAckEvent | WidgetMessageCreatedEvent | WidgetSessionReadyEvent;
+type WidgetServerEvent = WidgetAssistantStatusEvent | WidgetConversationSnapshotEvent | WidgetErrorEvent | WidgetMessageAckEvent | WidgetMessageCreatedEvent | WidgetSessionReadyEvent | WidgetSupportStateEvent;
 //#endregion
 //#region src/transport.d.ts
 interface ChatTransportHandlers {
@@ -123,6 +180,11 @@ interface ChatTransportConnection {
    * without it still works, its visitors are just emailed replies they saw.
    */
   markRead?: () => void;
+  /**
+   * Send a guided-topic click. Optional: without it the widget sends the
+   * topic's label as an ordinary message, so a custom transport still works.
+   */
+  selectTopic?: (event: WidgetClientTopicEvent) => void;
   sendMessage: (event: WidgetClientCreateMessageEvent) => void;
 }
 interface CreateChatTransportOptions {
@@ -167,7 +229,17 @@ interface ChatWidgetProps {
   defaultVisitor?: Partial<ChatWidgetVisitor>;
   getSession: GetSession;
   initiallyOpen?: boolean;
+  /** Launcher shape; see {@link ChatWidgetLauncher}. Defaults to `"auto"`. */
+  launcher?: ChatWidgetLauncher;
+  /** The launcher's visible text, and always its accessible name. */
   launcherLabel?: string;
+  /**
+   * Where the widget sits; see {@link ChatWidgetPlacement}. Defaults to
+   * `"bottom-right"`, floating clear of the device's safe-area insets. Stacks
+   * at `--clivly-chat-z-index` (default 2147483000) — lower it through
+   * `style` to sit beneath the host's own dialogs.
+   */
+  placement?: ChatWidgetPlacement;
   storage?: Pick<Storage, "getItem" | "setItem">;
   /**
    * Inline styles on the widget root. The intended use is overriding palette
@@ -183,7 +255,7 @@ interface ChatWidgetProps {
   theme?: ChatWidgetTheme;
   widgetId: string;
 }
-export declare function ChatWidget({ className, createTransport, defaultVisitor, getSession, initiallyOpen, launcherLabel, storage, style, theme, widgetId }: ChatWidgetProps): ReactElement;
+export declare function ChatWidget({ className, createTransport, defaultVisitor, getSession, initiallyOpen, launcher, launcherLabel, placement, storage, style, theme, widgetId }: ChatWidgetProps): ReactElement;
 export declare function ChatLauncher(): null;
 export declare function ChatPanel(): null;
 export declare function MessageComposer(): null;
@@ -246,4 +318,4 @@ export declare const createClivlyTransport: typeof createClivlyTransport$1;
 export declare const mountChatWidget: typeof mountChatWidget$1;
 export declare const mountChatWidgetScript: typeof mountChatWidgetScript$1;
 //#endregion
-export type { ChatTransportConnection, ChatTransportHandlers, ChatWidgetProps, ChatWidgetTheme, ChatWidgetVisitor, CreateChatTransport, CreateChatTransportOptions, CreateLoopbackTransportOptions, CreateWebSocketTransportOptions, GetSession, GetSessionOptions, ResolvedTheme, WidgetClientCreateMessageEvent, WidgetClientEvent, WidgetClientReadEvent, WidgetConfig, WidgetContact, WidgetConversation, WidgetConversationSnapshotEvent, WidgetErrorEvent, WidgetMessage, WidgetMessageAckEvent, WidgetMessageCreatedEvent, WidgetSenderType, WidgetServerEvent, WidgetSessionPayload, WidgetSessionReadyEvent, WidgetSummary };
+export type { ChatTransportConnection, ChatTransportHandlers, ChatWidgetLauncher, ChatWidgetPlacement, ChatWidgetProps, ChatWidgetTheme, ChatWidgetVisitor, CreateChatTransport, CreateChatTransportOptions, CreateLoopbackTransportOptions, CreateWebSocketTransportOptions, GetSession, GetSessionOptions, ResolvedTheme, WidgetAssistantStatusEvent, WidgetClientCreateMessageEvent, WidgetClientEvent, WidgetClientReadEvent, WidgetClientTopicEvent, WidgetConfig, WidgetContact, WidgetConversation, WidgetConversationSnapshotEvent, WidgetErrorEvent, WidgetMessage, WidgetMessageAckEvent, WidgetMessageCreatedEvent, WidgetSenderType, WidgetServerEvent, WidgetSessionPayload, WidgetSessionReadyEvent, WidgetSummary, WidgetSupport, WidgetSupportState, WidgetSupportStateEvent, WidgetSupportTopic };