@clivly/chat-widget 0.3.0-next.6

package/dist/index.d.cts

@@ -0,0 +1,198 @@
+import { Root } from "react-dom/client";
+import { ReactElement } from "react";
+
+//#region src/types.d.ts
+type WidgetSenderType = "visitor" | "operator" | "system";
+interface WidgetConfig {
+  brandColor?: string | null;
+  greeting?: string | null;
+}
+interface WidgetConversation {
+  id: string;
+  status: string;
+}
+interface WidgetContact {
+  email: string;
+  id: string;
+  name: string;
+}
+interface WidgetSummary {
+  config: WidgetConfig;
+  name: string;
+  widgetId: string;
+}
+interface WidgetMessage {
+  author: string | null;
+  body: string;
+  createdAt: string;
+  id: string;
+  senderType: WidgetSenderType;
+}
+interface WidgetSessionPayload {
+  contact: WidgetContact;
+  conversation: WidgetConversation;
+  expiresAt: string;
+  messages: WidgetMessage[];
+  /** Absolute socket URL returned by Clivly's bootstrap. */
+  socketUrl?: string;
+  token: string;
+  visitorToken: string;
+  widget: WidgetSummary;
+}
+interface ChatWidgetVisitor {
+  email: string;
+  name: string;
+}
+interface GetSessionOptions {
+  visitor: ChatWidgetVisitor;
+  visitorToken?: string | null;
+  widgetId: string;
+}
+type GetSession = (options: GetSessionOptions) => Promise<WidgetSessionPayload>;
+interface WidgetClientCreateMessageEvent {
+  body: string;
+  id: string;
+  type: "message.create";
+}
+type WidgetClientEvent = WidgetClientCreateMessageEvent;
+interface WidgetSessionReadyEvent {
+  conversationId: string;
+  type: "session.ready";
+}
+interface WidgetConversationSnapshotEvent {
+  messages: WidgetMessage[];
+  type: "conversation.snapshot";
+}
+interface WidgetMessageCreatedEvent {
+  clientMessageId?: string;
+  message: WidgetMessage;
+  type: "message.created";
+}
+interface WidgetMessageAckEvent {
+  clientMessageId: string;
+  message: WidgetMessage;
+  type: "message.ack";
+}
+interface WidgetErrorEvent {
+  message: string;
+  type: "error";
+}
+type WidgetServerEvent = WidgetConversationSnapshotEvent | WidgetErrorEvent | WidgetMessageAckEvent | WidgetMessageCreatedEvent | WidgetSessionReadyEvent;
+//#endregion
+//#region src/transport.d.ts
+interface ChatTransportHandlers {
+  onClose: () => void;
+  onError: (error: Error) => void;
+  onEvent: (event: WidgetServerEvent) => void;
+  onOpen?: () => void;
+}
+interface ChatTransportConnection {
+  close: () => void;
+  sendMessage: (event: WidgetClientCreateMessageEvent) => void;
+}
+interface CreateChatTransportOptions {
+  handlers: ChatTransportHandlers;
+  session: WidgetSessionPayload;
+}
+type CreateChatTransport = (options: CreateChatTransportOptions) => ChatTransportConnection;
+interface CreateWebSocketTransportOptions {
+  createSocket?: (url: string, protocols?: string | string[]) => WebSocket;
+  getProtocols?: (session: WidgetSessionPayload) => string | string[] | undefined;
+  resolveUrl: (session: WidgetSessionPayload) => string;
+}
+declare function createWebSocketTransport({
+  createSocket,
+  getProtocols,
+  resolveUrl
+}: CreateWebSocketTransportOptions): CreateChatTransport;
+interface CreateLoopbackTransportOptions {
+  operatorName?: string;
+  operatorReply?: (body: string) => string | null;
+  replyDelayMs?: number;
+}
+declare function createLoopbackTransport({
+  operatorName,
+  operatorReply,
+  replyDelayMs
+}?: CreateLoopbackTransportOptions): CreateChatTransport;
+//#endregion
+//#region src/chat-widget.d.ts
+interface ChatWidgetProps {
+  className?: string;
+  createTransport?: CreateChatTransport;
+  getSession: GetSession;
+  initiallyOpen?: boolean;
+  launcherLabel?: string;
+  storage?: Pick<Storage, "getItem" | "setItem">;
+  widgetId: string;
+}
+declare function ChatWidget({
+  className,
+  createTransport,
+  getSession,
+  initiallyOpen,
+  launcherLabel,
+  storage,
+  widgetId
+}: ChatWidgetProps): ReactElement;
+declare function ChatLauncher(): null;
+declare function ChatPanel(): null;
+declare function MessageComposer(): null;
+declare function PreChatForm(): null;
+declare function ConversationView(): null;
+//#endregion
+//#region src/browser-mount.d.ts
+interface MountChatWidgetOptions$1 extends Omit<ChatWidgetProps, "getSession" | "widgetId"> {
+  container: Element | ShadowRoot;
+  sessionUrl: string;
+  socketUrlTemplate?: string;
+  widgetId: string;
+}
+declare function mountChatWidget$1({
+  container,
+  createTransport,
+  sessionUrl,
+  socketUrlTemplate,
+  widgetId,
+  ...props
+}: MountChatWidgetOptions$1): Root;
+interface ScriptMountResult$1 {
+  root: Root;
+  shadowRoot: ShadowRoot;
+}
+declare function mountChatWidgetScript$1(script?: HTMLScriptElement): ScriptMountResult$1;
+declare function autoMountChatWidgetScript$1(script?: HTMLScriptElement | null): ScriptMountResult$1 | null;
+//#endregion
+//#region src/clivly-transport.d.ts
+interface CreateClivlyTransportOptions$1 {
+  createSocket?: (url: string, protocols?: string | string[]) => WebSocket;
+}
+/**
+ * The transport a host app should use against a real Clivly backend.
+ *
+ * The URL comes from the bootstrap response rather than host configuration, so
+ * no host page hardcodes Clivly's hostname and a misconfigured template cannot
+ * produce a silently dead socket.
+ */
+declare function createClivlyTransport$1(options?: CreateClivlyTransportOptions$1): CreateChatTransport;
+//#endregion
+//#region src/session.d.ts
+interface CreateSessionFetcherOptions {
+  fetchImpl?: typeof fetch;
+  sessionUrl: string;
+}
+declare function createSessionFetcher({
+  fetchImpl,
+  sessionUrl
+}: CreateSessionFetcherOptions): GetSession;
+//#endregion
+//#region src/index.d.ts
+type MountChatWidgetOptions = MountChatWidgetOptions$1;
+type ScriptMountResult = ScriptMountResult$1;
+declare const autoMountChatWidgetScript: typeof autoMountChatWidgetScript$1;
+type CreateClivlyTransportOptions = CreateClivlyTransportOptions$1;
+declare const createClivlyTransport: typeof createClivlyTransport$1;
+declare const mountChatWidget: typeof mountChatWidget$1;
+declare const mountChatWidgetScript: typeof mountChatWidgetScript$1;
+//#endregion
+export { ChatLauncher, ChatPanel, type ChatTransportConnection, type ChatTransportHandlers, ChatWidget, type ChatWidgetVisitor, ConversationView, type CreateChatTransport, type CreateChatTransportOptions, CreateClivlyTransportOptions, type CreateLoopbackTransportOptions, type CreateWebSocketTransportOptions, type GetSession, type GetSessionOptions, MessageComposer, MountChatWidgetOptions, PreChatForm, ScriptMountResult, type WidgetClientCreateMessageEvent, type WidgetClientEvent, type WidgetConfig, type WidgetContact, type WidgetConversation, type WidgetConversationSnapshotEvent, type WidgetErrorEvent, type WidgetMessage, type WidgetMessageAckEvent, type WidgetMessageCreatedEvent, type WidgetSenderType, type WidgetServerEvent, type WidgetSessionPayload, type WidgetSessionReadyEvent, type WidgetSummary, autoMountChatWidgetScript, createClivlyTransport, createLoopbackTransport, createSessionFetcher, createWebSocketTransport, mountChatWidget, mountChatWidgetScript };

package/dist/index.d.mts

@@ -0,0 +1,198 @@
+import { Root } from "react-dom/client";
+import { ReactElement } from "react";
+
+//#region src/types.d.ts
+type WidgetSenderType = "visitor" | "operator" | "system";
+interface WidgetConfig {
+  brandColor?: string | null;
+  greeting?: string | null;
+}
+interface WidgetConversation {
+  id: string;
+  status: string;
+}
+interface WidgetContact {
+  email: string;
+  id: string;
+  name: string;
+}
+interface WidgetSummary {
+  config: WidgetConfig;
+  name: string;
+  widgetId: string;
+}
+interface WidgetMessage {
+  author: string | null;
+  body: string;
+  createdAt: string;
+  id: string;
+  senderType: WidgetSenderType;
+}
+interface WidgetSessionPayload {
+  contact: WidgetContact;
+  conversation: WidgetConversation;
+  expiresAt: string;
+  messages: WidgetMessage[];
+  /** Absolute socket URL returned by Clivly's bootstrap. */
+  socketUrl?: string;
+  token: string;
+  visitorToken: string;
+  widget: WidgetSummary;
+}
+interface ChatWidgetVisitor {
+  email: string;
+  name: string;
+}
+interface GetSessionOptions {
+  visitor: ChatWidgetVisitor;
+  visitorToken?: string | null;
+  widgetId: string;
+}
+type GetSession = (options: GetSessionOptions) => Promise<WidgetSessionPayload>;
+interface WidgetClientCreateMessageEvent {
+  body: string;
+  id: string;
+  type: "message.create";
+}
+type WidgetClientEvent = WidgetClientCreateMessageEvent;
+interface WidgetSessionReadyEvent {
+  conversationId: string;
+  type: "session.ready";
+}
+interface WidgetConversationSnapshotEvent {
+  messages: WidgetMessage[];
+  type: "conversation.snapshot";
+}
+interface WidgetMessageCreatedEvent {
+  clientMessageId?: string;
+  message: WidgetMessage;
+  type: "message.created";
+}
+interface WidgetMessageAckEvent {
+  clientMessageId: string;
+  message: WidgetMessage;
+  type: "message.ack";
+}
+interface WidgetErrorEvent {
+  message: string;
+  type: "error";
+}
+type WidgetServerEvent = WidgetConversationSnapshotEvent | WidgetErrorEvent | WidgetMessageAckEvent | WidgetMessageCreatedEvent | WidgetSessionReadyEvent;
+//#endregion
+//#region src/transport.d.ts
+interface ChatTransportHandlers {
+  onClose: () => void;
+  onError: (error: Error) => void;
+  onEvent: (event: WidgetServerEvent) => void;
+  onOpen?: () => void;
+}
+interface ChatTransportConnection {
+  close: () => void;
+  sendMessage: (event: WidgetClientCreateMessageEvent) => void;
+}
+interface CreateChatTransportOptions {
+  handlers: ChatTransportHandlers;
+  session: WidgetSessionPayload;
+}
+type CreateChatTransport = (options: CreateChatTransportOptions) => ChatTransportConnection;
+interface CreateWebSocketTransportOptions {
+  createSocket?: (url: string, protocols?: string | string[]) => WebSocket;
+  getProtocols?: (session: WidgetSessionPayload) => string | string[] | undefined;
+  resolveUrl: (session: WidgetSessionPayload) => string;
+}
+declare function createWebSocketTransport({
+  createSocket,
+  getProtocols,
+  resolveUrl
+}: CreateWebSocketTransportOptions): CreateChatTransport;
+interface CreateLoopbackTransportOptions {
+  operatorName?: string;
+  operatorReply?: (body: string) => string | null;
+  replyDelayMs?: number;
+}
+declare function createLoopbackTransport({
+  operatorName,
+  operatorReply,
+  replyDelayMs
+}?: CreateLoopbackTransportOptions): CreateChatTransport;
+//#endregion
+//#region src/chat-widget.d.ts
+interface ChatWidgetProps {
+  className?: string;
+  createTransport?: CreateChatTransport;
+  getSession: GetSession;
+  initiallyOpen?: boolean;
+  launcherLabel?: string;
+  storage?: Pick<Storage, "getItem" | "setItem">;
+  widgetId: string;
+}
+declare function ChatWidget({
+  className,
+  createTransport,
+  getSession,
+  initiallyOpen,
+  launcherLabel,
+  storage,
+  widgetId
+}: ChatWidgetProps): ReactElement;
+declare function ChatLauncher(): null;
+declare function ChatPanel(): null;
+declare function MessageComposer(): null;
+declare function PreChatForm(): null;
+declare function ConversationView(): null;
+//#endregion
+//#region src/browser-mount.d.ts
+interface MountChatWidgetOptions$1 extends Omit<ChatWidgetProps, "getSession" | "widgetId"> {
+  container: Element | ShadowRoot;
+  sessionUrl: string;
+  socketUrlTemplate?: string;
+  widgetId: string;
+}
+declare function mountChatWidget$1({
+  container,
+  createTransport,
+  sessionUrl,
+  socketUrlTemplate,
+  widgetId,
+  ...props
+}: MountChatWidgetOptions$1): Root;
+interface ScriptMountResult$1 {
+  root: Root;
+  shadowRoot: ShadowRoot;
+}
+declare function mountChatWidgetScript$1(script?: HTMLScriptElement): ScriptMountResult$1;
+declare function autoMountChatWidgetScript$1(script?: HTMLScriptElement | null): ScriptMountResult$1 | null;
+//#endregion
+//#region src/clivly-transport.d.ts
+interface CreateClivlyTransportOptions$1 {
+  createSocket?: (url: string, protocols?: string | string[]) => WebSocket;
+}
+/**
+ * The transport a host app should use against a real Clivly backend.
+ *
+ * The URL comes from the bootstrap response rather than host configuration, so
+ * no host page hardcodes Clivly's hostname and a misconfigured template cannot
+ * produce a silently dead socket.
+ */
+declare function createClivlyTransport$1(options?: CreateClivlyTransportOptions$1): CreateChatTransport;
+//#endregion
+//#region src/session.d.ts
+interface CreateSessionFetcherOptions {
+  fetchImpl?: typeof fetch;
+  sessionUrl: string;
+}
+declare function createSessionFetcher({
+  fetchImpl,
+  sessionUrl
+}: CreateSessionFetcherOptions): GetSession;
+//#endregion
+//#region src/index.d.ts
+type MountChatWidgetOptions = MountChatWidgetOptions$1;
+type ScriptMountResult = ScriptMountResult$1;
+declare const autoMountChatWidgetScript: typeof autoMountChatWidgetScript$1;
+type CreateClivlyTransportOptions = CreateClivlyTransportOptions$1;
+declare const createClivlyTransport: typeof createClivlyTransport$1;
+declare const mountChatWidget: typeof mountChatWidget$1;
+declare const mountChatWidgetScript: typeof mountChatWidgetScript$1;
+//#endregion
+export { ChatLauncher, ChatPanel, type ChatTransportConnection, type ChatTransportHandlers, ChatWidget, type ChatWidgetVisitor, ConversationView, type CreateChatTransport, type CreateChatTransportOptions, CreateClivlyTransportOptions, type CreateLoopbackTransportOptions, type CreateWebSocketTransportOptions, type GetSession, type GetSessionOptions, MessageComposer, MountChatWidgetOptions, PreChatForm, ScriptMountResult, type WidgetClientCreateMessageEvent, type WidgetClientEvent, type WidgetConfig, type WidgetContact, type WidgetConversation, type WidgetConversationSnapshotEvent, type WidgetErrorEvent, type WidgetMessage, type WidgetMessageAckEvent, type WidgetMessageCreatedEvent, type WidgetSenderType, type WidgetServerEvent, type WidgetSessionPayload, type WidgetSessionReadyEvent, type WidgetSummary, autoMountChatWidgetScript, createClivlyTransport, createLoopbackTransport, createSessionFetcher, createWebSocketTransport, mountChatWidget, mountChatWidgetScript };