@helpway/react 0.8.3 → 0.10.0

package/dist/index.d.ts

@@ -246,6 +246,26 @@ declare function useUnread(): {
  */
 declare function useRealtime(handler: (event: RealtimeEvent) => void): void;
 
+/**
+ * WidgetLogo — chat-header avatar. Renders WHO is talking to the
+ * visitor right now. Resolution chain:
+ *   1. Active conversation's assigned support user (assigneeName +
+ *      assigneeImage from the widget API). When a human takes over a
+ *      conversation the visitor sees that human, not the AI agent.
+ *   2. Agent uploaded image (agentConfig.avatarUrl)
+ *   3. Agent icon preset (avatarPreset + brandColor)
+ *   4. Website logo (website.logoUrl)
+ *   5. Helpway brand mark (octagonal) as the true last-resort fallback
+ *
+ * The `forceAgent` escape hatch skips the assignee lookup — used by
+ * surfaces that mean "the agent" specifically (welcome card, conversation
+ * list rows where we want the persistent brand, etc.) rather than "the
+ * person currently helping you".
+ */
+declare function WidgetLogo({ className, forceAgent, }: {
+    className?: string;
+    forceAgent?: boolean;
+}): react_jsx_runtime.JSX.Element;
 /**
  * Unified support widget — Intercom-style with tab navigation.
  * Two tabs: Home + Messages. Sub-views: conversation + new conversation.
@@ -273,6 +293,7 @@ interface MessageListProps {
     visitorName?: string;
     isTyping?: boolean;
     isAiProcessing?: boolean;
+    streamingText?: string;
     hasMore?: boolean;
     isLoadingMore?: boolean;
     onLoadMore?: () => void;
@@ -280,7 +301,7 @@ interface MessageListProps {
     renderAfterMessages?: react__default.ReactNode;
 }
 /** Timeline with date separators, typing indicator, infinite scroll, and AI processing state */
-declare function MessageList({ items, visitorName, isTyping, isAiProcessing, hasMore, isLoadingMore, onLoadMore, renderAfterMessages, }: MessageListProps): react_jsx_runtime.JSX.Element;
+declare function MessageList({ items, visitorName, isTyping, isAiProcessing, streamingText, hasMore, isLoadingMore, onLoadMore, renderAfterMessages, }: MessageListProps): react_jsx_runtime.JSX.Element;
 
 interface ComposerProps {
     text: string;
@@ -303,6 +324,57 @@ interface ComposerProps {
 /** Widget composer — auto-resize, Enter-to-send, paste/drop attachments */
 declare function Composer({ text, onTextChange, onSubmit, onTyping, isSubmitting, placeholder, compact, attachments, onAddFiles, onRemoveAttachment, disabled, }: ComposerProps): react_jsx_runtime.JSX.Element;
 
+/** Where the preview is anchored — controls only the outer positioning. */
+type MessagePreviewPlacement = "launcher" | "anchored";
+interface MessagePreviewProps {
+    /** Called when the visitor taps the preview (or a quick reply). The
+     *  active conversation is already switched to the one that pinged —
+     *  the consumer just has to reveal the chat surface. */
+    onOpen: () => void;
+    /**
+     * The avatar node shown in the header. Injected by the consumer so
+     * this component stays decoupled from avatar resolution — the default
+     * widget passes `<WidgetLogo />`; a custom surface can pass its own.
+     */
+    avatar: ReactNode;
+    /**
+     * Outer positioning mode. `"launcher"` (default) keeps the original
+     * absolute placement above the floating bubble — DefaultWidget relies
+     * on this, so the default is unchanged. `"anchored"` drops the
+     * absolute/bottom/right rules (via `hw-preview--anchored`) so a
+     * consumer can pin it to their own trigger (e.g. a sidebar item).
+     */
+    placement?: MessagePreviewPlacement;
+    /**
+     * Auto-dismiss delay in ms. Default `8000` (the launcher behaviour).
+     * Pass `null` (or `0`) to keep the preview until the visitor acts on
+     * it — useful for an anchored surface where it isn't competing with
+     * page content for attention. Quick-reply previews never auto-dismiss
+     * regardless, since the visitor needs time to choose.
+     */
+    autoDismissMs?: number | null;
+    /**
+     * Optional caption rendered as a separated footer beneath the message
+     * (e.g. a source label like "via Helpway"). Omitted for the launcher
+     * so its visual stays byte-identical to the original.
+     */
+    footer?: ReactNode;
+}
+/**
+ * `<MessagePreview>` — the proactive incoming-message bubble shown while
+ * the chat surface is closed. Reads `incomingPreview` from the widget
+ * store, auto-dismisses after 8s (unless quick replies are present), and
+ * on tap switches to the pinging conversation before calling `onOpen`.
+ *
+ * Extracted from the default widget so `hideLauncher` integrations can
+ * surface the *exact same* preview next to their own UI instead of the
+ * floating launcher. Visual/markup is byte-identical to the launcher
+ * version — only the outer positioning is parameterised via `placement`.
+ *
+ * Must be rendered inside `<SupportProvider>`.
+ */
+declare function MessagePreview({ onOpen, avatar, placement, autoDismissMs, footer, }: MessagePreviewProps): react_jsx_runtime.JSX.Element | null;
+
 /**
  * Lightweight Markdown → HTML renderer.
  * Zero dependencies. Handles common patterns:
@@ -331,4 +403,4 @@ declare function MarkdownContent({ bodyHtml, bodyMarkdown, className, }: {
     className?: string;
 }): react_jsx_runtime.JSX.Element | null;
 
-export { Composer, DefaultWidget, type HelpwayPublicAPI, HelpwayWidget, type HelpwayWidgetProps, type IdentifyData, MarkdownContent, MessageBubble, MessageList, SupportProvider, linkifyText, renderMarkdown, useComposer, useConversations, useIdentify, usePresence, useRealtime, useTimeline, useUnread, useWidget, useWidgetStore };
+export { Composer, DefaultWidget, type HelpwayPublicAPI, HelpwayWidget, type HelpwayWidgetProps, type IdentifyData, MarkdownContent, MessageBubble, MessageList, MessagePreview, type MessagePreviewPlacement, type MessagePreviewProps, SupportProvider, WidgetLogo, linkifyText, renderMarkdown, useComposer, useConversations, useIdentify, usePresence, useRealtime, useTimeline, useUnread, useWidget, useWidgetStore };