@clivly/chat-widget 0.18.0 → 0.19.0

package/dist/index.d.cts

@@ -62,7 +62,18 @@ interface WidgetSummary {
   name: string;
   widgetId: string;
 }
+/** A file on a message. Its bytes are fetched with the attachment token. */
+interface WidgetAttachment {
+  contentType: string;
+  filename: string;
+  id: string;
+  /** How to show it: an image or an audio player in place, else a file card. */
+  kind: "image" | "audio" | "document";
+  sizeBytes: number;
+}
 interface WidgetMessage {
+  /** Present only when the message carries files. */
+  attachments?: WidgetAttachment[];
   author: string | null;
   /**
    * Set on messages the support assistant wrote (`greeting`, `topic`,
@@ -85,10 +96,30 @@ interface WidgetSupportTopic {
 /** Guided support for one conversation. Answers stay on the server. */
 interface WidgetSupport {
   mode: "human" | "guided" | "ai";
+  /** The reply time the team promises, if any ("We usually reply within a day."). */
+  responseTime?: string;
   state: WidgetSupportState | null;
   topics: WidgetSupportTopic[];
 }
+/**
+ * How this conversation takes files, from the server. Absent (older server)
+ * or null (no storage configured) means the widget offers no attach button.
+ */
+interface WidgetAttachmentsConfig {
+  /** File picker `accept`: `.png,.jpg,…`. */
+  accept: string;
+  expiresAt: string;
+  /** Shown before a file is picked: what may be sent, and how big. */
+  hint: string;
+  maxFileBytes: number;
+  maxFiles: number;
+  /** Bearer token for the file routes only; it cannot chat. */
+  token: string;
+  /** POST files here; GET or DELETE `<url>/<id>`. */
+  url: string;
+}
 interface WidgetSessionPayload {
+  attachments?: WidgetAttachmentsConfig | null;
   contact: WidgetContact | null;
   conversation: WidgetConversation;
   expiresAt: string;
@@ -112,6 +143,8 @@ interface GetSessionOptions {
 }
 type GetSession = (options: GetSessionOptions) => Promise<WidgetSessionPayload>;
 interface WidgetClientCreateMessageEvent {
+  /** Uploaded files to send with the message (`body` may then be empty). */
+  attachmentIds?: string[];
   body: string;
   id: string;
   type: "message.create";
@@ -155,6 +188,9 @@ interface WidgetAssistantStatusEvent {
   type: "assistant.status";
 }
 interface WidgetErrorEvent {
+  /** The send this refuses, when it refused one in particular. */
+  clientMessageId?: string;
+  code?: string;
   message: string;
   type: "error";
 }
@@ -320,4 +356,4 @@ export type CreateClivlyTransportOptions = CreateClivlyTransportOptions$1;
 export declare const createClivlyTransport: typeof createClivlyTransport$1;
 export declare const mountChatWidget: typeof mountChatWidget$1;
 export declare const mountChatWidgetScript: typeof mountChatWidgetScript$1;
-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 };
+export type { ChatTransportConnection, ChatTransportHandlers, ChatWidgetLauncher, ChatWidgetPlacement, ChatWidgetProps, ChatWidgetTheme, ChatWidgetVisitor, CreateChatTransport, CreateChatTransportOptions, CreateLoopbackTransportOptions, CreateWebSocketTransportOptions, GetSession, GetSessionOptions, ResolvedTheme, WidgetAssistantStatusEvent, WidgetAttachment, WidgetAttachmentsConfig, 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

@@ -62,7 +62,18 @@ interface WidgetSummary {
   name: string;
   widgetId: string;
 }
+/** A file on a message. Its bytes are fetched with the attachment token. */
+interface WidgetAttachment {
+  contentType: string;
+  filename: string;
+  id: string;
+  /** How to show it: an image or an audio player in place, else a file card. */
+  kind: "image" | "audio" | "document";
+  sizeBytes: number;
+}
 interface WidgetMessage {
+  /** Present only when the message carries files. */
+  attachments?: WidgetAttachment[];
   author: string | null;
   /**
    * Set on messages the support assistant wrote (`greeting`, `topic`,
@@ -85,10 +96,30 @@ interface WidgetSupportTopic {
 /** Guided support for one conversation. Answers stay on the server. */
 interface WidgetSupport {
   mode: "human" | "guided" | "ai";
+  /** The reply time the team promises, if any ("We usually reply within a day."). */
+  responseTime?: string;
   state: WidgetSupportState | null;
   topics: WidgetSupportTopic[];
 }
+/**
+ * How this conversation takes files, from the server. Absent (older server)
+ * or null (no storage configured) means the widget offers no attach button.
+ */
+interface WidgetAttachmentsConfig {
+  /** File picker `accept`: `.png,.jpg,…`. */
+  accept: string;
+  expiresAt: string;
+  /** Shown before a file is picked: what may be sent, and how big. */
+  hint: string;
+  maxFileBytes: number;
+  maxFiles: number;
+  /** Bearer token for the file routes only; it cannot chat. */
+  token: string;
+  /** POST files here; GET or DELETE `<url>/<id>`. */
+  url: string;
+}
 interface WidgetSessionPayload {
+  attachments?: WidgetAttachmentsConfig | null;
   contact: WidgetContact | null;
   conversation: WidgetConversation;
   expiresAt: string;
@@ -112,6 +143,8 @@ interface GetSessionOptions {
 }
 type GetSession = (options: GetSessionOptions) => Promise<WidgetSessionPayload>;
 interface WidgetClientCreateMessageEvent {
+  /** Uploaded files to send with the message (`body` may then be empty). */
+  attachmentIds?: string[];
   body: string;
   id: string;
   type: "message.create";
@@ -155,6 +188,9 @@ interface WidgetAssistantStatusEvent {
   type: "assistant.status";
 }
 interface WidgetErrorEvent {
+  /** The send this refuses, when it refused one in particular. */
+  clientMessageId?: string;
+  code?: string;
   message: string;
   type: "error";
 }
@@ -320,4 +356,4 @@ export type CreateClivlyTransportOptions = CreateClivlyTransportOptions$1;
 export declare const createClivlyTransport: typeof createClivlyTransport$1;
 export declare const mountChatWidget: typeof mountChatWidget$1;
 export declare const mountChatWidgetScript: typeof mountChatWidgetScript$1;
-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 };
+export type { ChatTransportConnection, ChatTransportHandlers, ChatWidgetLauncher, ChatWidgetPlacement, ChatWidgetProps, ChatWidgetTheme, ChatWidgetVisitor, CreateChatTransport, CreateChatTransportOptions, CreateLoopbackTransportOptions, CreateWebSocketTransportOptions, GetSession, GetSessionOptions, ResolvedTheme, WidgetAssistantStatusEvent, WidgetAttachment, WidgetAttachmentsConfig, WidgetClientCreateMessageEvent, WidgetClientEvent, WidgetClientReadEvent, WidgetClientTopicEvent, WidgetConfig, WidgetContact, WidgetConversation, WidgetConversationSnapshotEvent, WidgetErrorEvent, WidgetMessage, WidgetMessageAckEvent, WidgetMessageCreatedEvent, WidgetSenderType, WidgetServerEvent, WidgetSessionPayload, WidgetSessionReadyEvent, WidgetSummary, WidgetSupport, WidgetSupportState, WidgetSupportStateEvent, WidgetSupportTopic };