@askly/widget 2.8.0 → 2.10.0

package/dist/realtime.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Live event stream from the server (server-sent events), read with fetch().
+ *
+ * Why not EventSource: it cannot send an Authorization header, and the stream is authorised
+ * by the widget's session token. fetch() with a streamed body does the same job.
+ *
+ * The stream is a notification channel, not the record. Whoever uses it is expected to read
+ * the conversation again when it comes up (`onLive`), so nothing here replays missed events.
+ * When the stream cannot be had at all (an older server, no session) it reports "unsupported"
+ * and stops; when it merely fails it reports "down" and keeps retrying with backoff, so the
+ * caller can poll in the meantime and stop polling when it returns.
+ */
+export interface StreamEvent {
+    type: string;
+    id?: string;
+    data: any;
+}
+export interface EventStreamOptions {
+    /** Open the request. Resolves to null when there is no session to authorise it with. */
+    connect: (signal: AbortSignal) => Promise<Response | null>;
+    onEvent: (event: StreamEvent) => void;
+    /** The server confirmed the stream is up. */
+    onLive: () => void;
+    /** The stream is not delivering: "unsupported" is final, "down" will be retried. */
+    onDown: (reason: "unsupported" | "down") => void;
+}
+export interface EventStreamHandle {
+    close: () => void;
+    /** Drop the current connection and reconnect now (the network just changed). */
+    kick: () => void;
+}
+export declare function openEventStream(options: EventStreamOptions): EventStreamHandle;

package/dist/ui/ChatTerms.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+/** The terms and "Powered by" line under the composer. */
+export declare function ChatTerms(): React.JSX.Element;

package/dist/ui/Composer.d.ts

@@ -0,0 +1,28 @@
+import React from "react";
+export interface ComposerProps {
+    enableVoiceChat: boolean;
+    fileInputRef: React.RefObject<HTMLInputElement>;
+    handleEmojiClick: (emoji: string) => void;
+    handleFileChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    handleFileUploadClick: () => void;
+    input: string;
+    inputRef: React.RefObject<HTMLTextAreaElement>;
+    isListening: boolean;
+    isTyping: boolean;
+    leadRequired: boolean;
+    placeholderText: string;
+    readAloud: boolean;
+    sendMessage: (text?: string) => void | Promise<void>;
+    setInput: React.Dispatch<React.SetStateAction<string>>;
+    setShowEmojiPicker: (show: boolean) => void;
+    setTtsMuted: (muted: boolean) => void;
+    showEmojiPicker: boolean;
+    stopSpeaking: () => void;
+    toggleVoiceInput: () => void;
+    ttsMuted: boolean;
+    ttsMutedRef: React.MutableRefObject<boolean>;
+    turnstileBlocked: boolean;
+    uploadingFile: boolean;
+}
+/** The message box and its actions: attach, emoji, voice input, read-aloud and send. */
+export declare function Composer(props: ComposerProps): React.JSX.Element;

package/dist/ui/ConversationList.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import type { SavedConversation } from "../core/types";
+export interface ConversationListProps {
+    conversations: SavedConversation[];
+    setActiveChatId: (chatId: string | null) => void;
+    startNewChat: () => string;
+}
+/** The visitor's chats, newest first, with a button to start another. */
+export declare function ConversationList(props: ConversationListProps): React.JSX.Element;

package/dist/ui/ExploreTab.d.ts

@@ -0,0 +1,21 @@
+import React from "react";
+import type { WidgetTab, Faq, Article } from "../core/types";
+export interface ExploreTabProps {
+    allArticles: Article[];
+    articlesLoading: boolean;
+    expandedFaqIndex: number | null;
+    faqs: Faq[];
+    handleSearchChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    handleSelectArticle: (article: Article) => void;
+    organizationLogo: string | undefined;
+    organizationName: string;
+    searchError: string | null;
+    searchLoading: boolean;
+    searchQuery: string;
+    searchResults: Article[];
+    setActiveTab: (tab: WidgetTab) => void;
+    setExpandedFaqIndex: (index: number | null) => void;
+    setInput: React.Dispatch<React.SetStateAction<string>>;
+}
+/** The home screen: search, shortcuts, popular questions and recommended articles. */
+export declare function ExploreTab(props: ExploreTabProps): React.JSX.Element;

package/dist/ui/GreetingBubble.d.ts

@@ -0,0 +1,16 @@
+import React from "react";
+import type { Faq } from "../core/types";
+export interface GreetingBubbleProps {
+    accentVars: React.CSSProperties;
+    aiAnswering: boolean;
+    aiAvatarUrl: string | null;
+    dismissGreeting: () => void;
+    faqs: Faq[];
+    greetingText: string;
+    openFromGreeting: (question?: string) => void;
+    organizationLogo: string | undefined;
+    position: "left" | "right";
+    resolvedTheme: string;
+}
+/** The hello shown beside the closed launcher. A status region, so it is announced without taking focus. */
+export declare function GreetingBubble(props: GreetingBubbleProps): React.JSX.Element;

package/dist/ui/HelpTab.d.ts

@@ -0,0 +1,25 @@
+import React from "react";
+import type { WidgetTab, Article } from "../core/types";
+export interface HelpTabProps {
+    allArticles: Article[];
+    articleFeedback: Record<string, "yes" | "no" | "somewhat">;
+    articlesLoading: boolean;
+    handleSearchChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    handleSelectArticle: (article: Article) => void;
+    organizationLogo: string | undefined;
+    organizationName: string;
+    searchError: string | null;
+    searchLoading: boolean;
+    searchQuery: string;
+    searchResults: Article[];
+    selectedArticle: Article | null;
+    selectedCollection: string | null;
+    setActiveTab: (tab: WidgetTab) => void;
+    setArticleFeedback: React.Dispatch<React.SetStateAction<Record<string, "yes" | "no" | "somewhat">>>;
+    setInput: React.Dispatch<React.SetStateAction<string>>;
+    setSelectedArticle: (article: Article | null) => void;
+    setSelectedCollection: (collection: string | null) => void;
+    themeColor: string;
+}
+/** The help center: collections, article list and the article reader. */
+export declare function HelpTab(props: HelpTabProps): React.JSX.Element;

package/dist/ui/Launcher.d.ts

@@ -0,0 +1,16 @@
+import React from "react";
+import type { WidgetTab } from "../core/types";
+export interface LauncherProps {
+    open: boolean;
+    setOpen: (open: boolean) => void;
+    buttonIcon: string;
+    buttonShape: "round" | "square";
+    buttonStyle: React.CSSProperties;
+    launcherUnread: number;
+    resolvedTheme: string;
+    setActiveChatId: (chatId: string | null) => void;
+    setActiveTab: (tab: WidgetTab) => void;
+    unreadChatId: string | undefined;
+}
+/** The floating button that opens and closes the panel, with the unread badge. */
+export declare function Launcher(props: LauncherProps): React.JSX.Element;

package/dist/ui/MessageList.d.ts

@@ -0,0 +1,14 @@
+import React from "react";
+import type { Message } from "../core/types";
+export interface MessageListProps {
+    copiedMsgIndex: number | null;
+    messages: Message[];
+    msgReactions: Record<number, "up" | "down">;
+    setCopiedMsgIndex: React.Dispatch<React.SetStateAction<number | null>>;
+    setMsgReactions: React.Dispatch<React.SetStateAction<Record<number, "up" | "down">>>;
+    showTimestamp: boolean;
+}
+/** The messages of the chat on screen. */
+declare function MessageListView(props: MessageListProps): React.JSX.Element;
+export declare const MessageList: React.MemoExoticComponent<typeof MessageListView>;
+export {};

package/dist/ui/NavTabs.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import type { WidgetTab, Article } from "../core/types";
+export interface NavTabsProps {
+    activeTab: WidgetTab;
+    setActiveTab: (tab: WidgetTab) => void;
+    setSelectedArticle: (article: Article | null) => void;
+}
+/** The bottom navigation between Explore, Messages and Help. */
+export declare function NavTabs(props: NavTabsProps): React.JSX.Element;

package/dist/ui/PanelHeader.d.ts

@@ -0,0 +1,18 @@
+import React from "react";
+import type { WidgetTab } from "../core/types";
+export interface PanelHeaderProps {
+    activeChatId: string | null;
+    activeTab: WidgetTab;
+    aiAnswering: boolean;
+    aiAvatarUrl: string | null;
+    aiName: string | null;
+    headerStyle: React.CSSProperties;
+    isExpanded: boolean;
+    organizationLogo: string | undefined;
+    organizationName: string;
+    setActiveChatId: (chatId: string | null) => void;
+    setIsExpanded: (expanded: boolean) => void;
+    setOpen: (open: boolean) => void;
+}
+/** The panel's top bar, which changes with the section on screen. */
+export declare function PanelHeader(props: PanelHeaderProps): React.JSX.Element;

package/dist/widget.d.ts

@@ -1,41 +1,4 @@
 import React from "react";
+import type { ChatWidgetProps } from "./core/types";
 import "./styles.css";
-interface ChatWidgetProps {
-    orgId?: string;
-    organizationName?: string;
-    themeColor?: string;
-    theme?: "light" | "dark" | "auto";
-    position?: "left" | "right";
-    orgServerRoute: string;
-    enableVoiceChat?: boolean;
-    readAloud?: boolean;
-    welcomeMessage?: string;
-    placeholderText?: string;
-    organizationLogo?: string;
-    buttonIcon?: string;
-    buttonShape?: "round" | "square";
-    autoOpen?: boolean;
-    greeting?: boolean | {
-        message?: string;
-        delayMs?: number;
-    };
-    showTimestamp?: boolean;
-    soundEnabled?: boolean;
-    soundVolume?: number;
-    poweredBy?: string;
-    userId?: string;
-    timestamp?: number;
-    signature?: string;
-    turnstileSiteKey?: string;
-    excludePaths?: string[];
-    includePaths?: string[];
-    configOverride?: Record<string, any>;
-    resetGeneration?: number;
-    onMessageSent?: (message: string) => void;
-    onMessageReceived?: (reply: string) => void;
-    onChatOpened?: () => void;
-    onChatClosed?: () => void;
-    onEscalation?: (data: any) => void;
-}
 export declare const ChatWidget: ({ orgId, organizationName: initialOrganizationName, themeColor: initialThemeColor, theme: initialTheme, position, orgServerRoute, enableVoiceChat: initialEnableVoiceChat, readAloud: initialReadAloud, welcomeMessage: initialWelcomeMessage, placeholderText, organizationLogo: initialOrganizationLogo, buttonIcon, buttonShape: initialButtonShape, autoOpen, greeting, showTimestamp, soundEnabled, soundVolume, poweredBy, userId, timestamp, signature, turnstileSiteKey, excludePaths, includePaths, configOverride, resetGeneration: initResetGeneration, onMessageSent, onMessageReceived, onChatOpened, onChatClosed, onEscalation, }: ChatWidgetProps) => React.JSX.Element | null;
-export {};