@frankieai/react 0.2.17 → 0.2.19

package/dist/index.d.cts

@@ -92,9 +92,18 @@ declare class FrankieClient {
     getConfig(signal?: AbortSignal): Promise<PublicWidgetConfig>;
     ensureSession(context?: PageContext): Promise<CreateSessionResponse>;
     listConversations(): Promise<ChatConversation[]>;
+    /** Whether a conversation can be reloaded from the server (a signed-in user and a conversation id). */
+    get canResume(): boolean;
+    /**
+     * Ask the server to stop the running turn. Closing the stream no longer
+     * stops it (a closed tab shouldn't lose the reply), so Stop says so
+     * explicitly. Best effort: the stream is closed right after either way.
+     */
+    stopTurn(): Promise<void>;
     resumeConversation(id?: string | undefined): Promise<{
         messages: unknown[];
         title: string;
+        busy: boolean;
     } | undefined>;
     syncConversation(messages: unknown[], title?: string): Promise<void>;
     deleteConversation(id: string): Promise<void>;
@@ -144,6 +153,13 @@ interface FrankieContextValue {
     injectStyles: boolean;
     /** The host page's colors, sampled once for "inherit my site's theme" (null: not inheriting, or unreadable). */
     hostTheme: Partial<WidgetTheme> | null;
+    /**
+     * True once the chat knows its colors: the config (or its error) has arrived
+     * and, when inheriting, the host page has been sampled. Until then the chat
+     * stays invisible, so a visitor in OS dark mode never sees a black flash on
+     * a light site before the real theme lands.
+     */
+    themeReady: boolean;
 }
 declare function FrankieProvider({ children, context, theme, config: providedConfig, injectStyles, ...clientOptions }: FrankieProviderProps): react.JSX.Element;
 declare function useFrankie(): FrankieContextValue;
@@ -249,6 +265,17 @@ interface FrankieWidgetProps extends ChatPanelProps {
         toggle: () => void;
         label: string;
     }) => React.ReactNode;
+    /**
+     * `false` hides the floating button, for apps with their own entry point:
+     * give any element `data-frankie-open` (a nav tab, a "Help" link) and a
+     * click on it opens the chat. Defaults to `true`.
+     */
+    launcher?: boolean;
+    /**
+     * Sit above fixed bars along the bottom of the page (a mobile tab bar, a
+     * cookie banner) instead of underneath them. Defaults to `true`.
+     */
+    avoidBottomBars?: boolean;
 }
 /**
  * The drop-in embed: a floating launcher plus the chat panel.
@@ -256,7 +283,7 @@ interface FrankieWidgetProps extends ChatPanelProps {
  * Renders `position: fixed` at the document level, so it does not care what
  * layout the host page uses.
  */
-declare function FrankieWidget({ position, offset, defaultOpen, zIndex, open: controlledOpen, onOpenChange, renderLauncher, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
+declare function FrankieWidget({ position, offset, defaultOpen, zIndex, open: controlledOpen, onOpenChange, renderLauncher, launcher, avoidBottomBars, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
 
 interface FrankieInlineProps extends ChatPanelProps {
     /** Extra styles on the filling wrapper — e.g. a `maxWidth` to centre the column. */
@@ -280,9 +307,15 @@ interface FrankieChatPageProps extends Omit<FrankieProviderProps, "children">, P
     showHistory?: boolean;
     /** Optional host navigation, e.g. a Back to dashboard link. */
     navigation?: React.ReactNode;
+    /**
+     * Grow to fill the screen from where the chat starts down to the bottom
+     * edge, or to the top of a fixed bottom bar. Defaults to true; set false
+     * when a sized parent should decide the height.
+     */
+    fillViewport?: boolean;
 }
 /** Reusable product chat with one shared conversation state and scoped styling. */
-declare function FrankieChatPage({ className, style, header, footer, emptyState, renderMessage, renderTool, placeholder, autoFocus, showHistory, navigation, ...provider }: FrankieChatPageProps): react.JSX.Element;
+declare function FrankieChatPage({ className, style, header, footer, emptyState, renderMessage, renderTool, placeholder, autoFocus, showHistory, navigation, fillViewport, ...provider }: FrankieChatPageProps): react.JSX.Element;
 
 interface ComposerAttachmentsConfig {
     enabled: boolean;
@@ -340,7 +373,9 @@ declare function TypingDots(): react.JSX.Element;
  * the first words, or during the pause after a tool result while the model
  * composes its answer — so those gaps read as "loading" rather than frozen.
  */
-declare function Thinking(): react.JSX.Element;
+declare function Thinking({ delayed }: {
+    delayed?: boolean;
+}): react.JSX.Element;
 
 /**
  * A deliberately small Markdown subset — headings, paragraphs, lists, fenced
@@ -467,8 +502,16 @@ declare function extractChoices(text: string): ExtractedChoices;
 declare function themeToCssVars(theme: WidgetTheme | undefined): CSSProperties;
 /** Resolve `mode: "system"` against the browser, so the widget can hard-set a class. */
 declare function resolveMode(mode: WidgetTheme["mode"]): "light" | "dark";
+/**
+ * `resolveMode` as a hook. Server-rendered pages can't know the visitor's
+ * scheme, and a hydrated attribute that differs from the server's is never
+ * patched, so a plain `resolveMode` call could leave "system" stuck on light.
+ * This renders light on the server and during hydration, then the visitor's
+ * scheme, and follows it when they switch.
+ */
+declare function useResolvedMode(mode: WidgetTheme["mode"]): "light" | "dark";
 
 /** shadcn/ui's class helper: conditional classes with Tailwind conflict resolution. */
 declare function cn(...inputs: ClassValue[]): string;
 
-export { type AssistantChatMessage, Avatar, Badge, Button, type ButtonProps, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, type ChatMessage, ChatPanel, type ChatPanelProps, Choices, Composer, type ExtractedChoices, FRANKIE_CLOUD_URL, FrankieApiError, FrankieChatPage, type FrankieChatPageProps, FrankieClient, type FrankieClientOptions, FrankieInline, type FrankieInlineProps, FrankieProvider, type FrankieProviderProps, FrankieWidget, type FrankieWidgetProps, Markdown, type MessageAttachment, MessageBubble, type PageContext, ScrollArea, type SendOptions, Separator, SuggestedPrompts, Textarea, Thinking, type ToolActivity, ToolActivityList, ToolActivityRow, TypingDots, type UseFrankieChatResult, type UserChatMessage, applyEvent, buttonVariants, cn, extractChoices, newAssistantMessage, newUserMessage, readEventStream, resolveMode, themeToCssVars, useFrankie, useFrankieChat, useFrankieTheme };
+export { type AssistantChatMessage, Avatar, Badge, Button, type ButtonProps, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, type ChatMessage, ChatPanel, type ChatPanelProps, Choices, Composer, type ExtractedChoices, FRANKIE_CLOUD_URL, FrankieApiError, FrankieChatPage, type FrankieChatPageProps, FrankieClient, type FrankieClientOptions, FrankieInline, type FrankieInlineProps, FrankieProvider, type FrankieProviderProps, FrankieWidget, type FrankieWidgetProps, Markdown, type MessageAttachment, MessageBubble, type PageContext, ScrollArea, type SendOptions, Separator, SuggestedPrompts, Textarea, Thinking, type ToolActivity, ToolActivityList, ToolActivityRow, TypingDots, type UseFrankieChatResult, type UserChatMessage, applyEvent, buttonVariants, cn, extractChoices, newAssistantMessage, newUserMessage, readEventStream, resolveMode, themeToCssVars, useFrankie, useFrankieChat, useFrankieTheme, useResolvedMode };

package/dist/index.d.ts

@@ -92,9 +92,18 @@ declare class FrankieClient {
     getConfig(signal?: AbortSignal): Promise<PublicWidgetConfig>;
     ensureSession(context?: PageContext): Promise<CreateSessionResponse>;
     listConversations(): Promise<ChatConversation[]>;
+    /** Whether a conversation can be reloaded from the server (a signed-in user and a conversation id). */
+    get canResume(): boolean;
+    /**
+     * Ask the server to stop the running turn. Closing the stream no longer
+     * stops it (a closed tab shouldn't lose the reply), so Stop says so
+     * explicitly. Best effort: the stream is closed right after either way.
+     */
+    stopTurn(): Promise<void>;
     resumeConversation(id?: string | undefined): Promise<{
         messages: unknown[];
         title: string;
+        busy: boolean;
     } | undefined>;
     syncConversation(messages: unknown[], title?: string): Promise<void>;
     deleteConversation(id: string): Promise<void>;
@@ -144,6 +153,13 @@ interface FrankieContextValue {
     injectStyles: boolean;
     /** The host page's colors, sampled once for "inherit my site's theme" (null: not inheriting, or unreadable). */
     hostTheme: Partial<WidgetTheme> | null;
+    /**
+     * True once the chat knows its colors: the config (or its error) has arrived
+     * and, when inheriting, the host page has been sampled. Until then the chat
+     * stays invisible, so a visitor in OS dark mode never sees a black flash on
+     * a light site before the real theme lands.
+     */
+    themeReady: boolean;
 }
 declare function FrankieProvider({ children, context, theme, config: providedConfig, injectStyles, ...clientOptions }: FrankieProviderProps): react.JSX.Element;
 declare function useFrankie(): FrankieContextValue;
@@ -249,6 +265,17 @@ interface FrankieWidgetProps extends ChatPanelProps {
         toggle: () => void;
         label: string;
     }) => React.ReactNode;
+    /**
+     * `false` hides the floating button, for apps with their own entry point:
+     * give any element `data-frankie-open` (a nav tab, a "Help" link) and a
+     * click on it opens the chat. Defaults to `true`.
+     */
+    launcher?: boolean;
+    /**
+     * Sit above fixed bars along the bottom of the page (a mobile tab bar, a
+     * cookie banner) instead of underneath them. Defaults to `true`.
+     */
+    avoidBottomBars?: boolean;
 }
 /**
  * The drop-in embed: a floating launcher plus the chat panel.
@@ -256,7 +283,7 @@ interface FrankieWidgetProps extends ChatPanelProps {
  * Renders `position: fixed` at the document level, so it does not care what
  * layout the host page uses.
  */
-declare function FrankieWidget({ position, offset, defaultOpen, zIndex, open: controlledOpen, onOpenChange, renderLauncher, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
+declare function FrankieWidget({ position, offset, defaultOpen, zIndex, open: controlledOpen, onOpenChange, renderLauncher, launcher, avoidBottomBars, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
 
 interface FrankieInlineProps extends ChatPanelProps {
     /** Extra styles on the filling wrapper — e.g. a `maxWidth` to centre the column. */
@@ -280,9 +307,15 @@ interface FrankieChatPageProps extends Omit<FrankieProviderProps, "children">, P
     showHistory?: boolean;
     /** Optional host navigation, e.g. a Back to dashboard link. */
     navigation?: React.ReactNode;
+    /**
+     * Grow to fill the screen from where the chat starts down to the bottom
+     * edge, or to the top of a fixed bottom bar. Defaults to true; set false
+     * when a sized parent should decide the height.
+     */
+    fillViewport?: boolean;
 }
 /** Reusable product chat with one shared conversation state and scoped styling. */
-declare function FrankieChatPage({ className, style, header, footer, emptyState, renderMessage, renderTool, placeholder, autoFocus, showHistory, navigation, ...provider }: FrankieChatPageProps): react.JSX.Element;
+declare function FrankieChatPage({ className, style, header, footer, emptyState, renderMessage, renderTool, placeholder, autoFocus, showHistory, navigation, fillViewport, ...provider }: FrankieChatPageProps): react.JSX.Element;
 
 interface ComposerAttachmentsConfig {
     enabled: boolean;
@@ -340,7 +373,9 @@ declare function TypingDots(): react.JSX.Element;
  * the first words, or during the pause after a tool result while the model
  * composes its answer — so those gaps read as "loading" rather than frozen.
  */
-declare function Thinking(): react.JSX.Element;
+declare function Thinking({ delayed }: {
+    delayed?: boolean;
+}): react.JSX.Element;
 
 /**
  * A deliberately small Markdown subset — headings, paragraphs, lists, fenced
@@ -467,8 +502,16 @@ declare function extractChoices(text: string): ExtractedChoices;
 declare function themeToCssVars(theme: WidgetTheme | undefined): CSSProperties;
 /** Resolve `mode: "system"` against the browser, so the widget can hard-set a class. */
 declare function resolveMode(mode: WidgetTheme["mode"]): "light" | "dark";
+/**
+ * `resolveMode` as a hook. Server-rendered pages can't know the visitor's
+ * scheme, and a hydrated attribute that differs from the server's is never
+ * patched, so a plain `resolveMode` call could leave "system" stuck on light.
+ * This renders light on the server and during hydration, then the visitor's
+ * scheme, and follows it when they switch.
+ */
+declare function useResolvedMode(mode: WidgetTheme["mode"]): "light" | "dark";
 
 /** shadcn/ui's class helper: conditional classes with Tailwind conflict resolution. */
 declare function cn(...inputs: ClassValue[]): string;
 
-export { type AssistantChatMessage, Avatar, Badge, Button, type ButtonProps, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, type ChatMessage, ChatPanel, type ChatPanelProps, Choices, Composer, type ExtractedChoices, FRANKIE_CLOUD_URL, FrankieApiError, FrankieChatPage, type FrankieChatPageProps, FrankieClient, type FrankieClientOptions, FrankieInline, type FrankieInlineProps, FrankieProvider, type FrankieProviderProps, FrankieWidget, type FrankieWidgetProps, Markdown, type MessageAttachment, MessageBubble, type PageContext, ScrollArea, type SendOptions, Separator, SuggestedPrompts, Textarea, Thinking, type ToolActivity, ToolActivityList, ToolActivityRow, TypingDots, type UseFrankieChatResult, type UserChatMessage, applyEvent, buttonVariants, cn, extractChoices, newAssistantMessage, newUserMessage, readEventStream, resolveMode, themeToCssVars, useFrankie, useFrankieChat, useFrankieTheme };
+export { type AssistantChatMessage, Avatar, Badge, Button, type ButtonProps, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, type ChatMessage, ChatPanel, type ChatPanelProps, Choices, Composer, type ExtractedChoices, FRANKIE_CLOUD_URL, FrankieApiError, FrankieChatPage, type FrankieChatPageProps, FrankieClient, type FrankieClientOptions, FrankieInline, type FrankieInlineProps, FrankieProvider, type FrankieProviderProps, FrankieWidget, type FrankieWidgetProps, Markdown, type MessageAttachment, MessageBubble, type PageContext, ScrollArea, type SendOptions, Separator, SuggestedPrompts, Textarea, Thinking, type ToolActivity, ToolActivityList, ToolActivityRow, TypingDots, type UseFrankieChatResult, type UserChatMessage, applyEvent, buttonVariants, cn, extractChoices, newAssistantMessage, newUserMessage, readEventStream, resolveMode, themeToCssVars, useFrankie, useFrankieChat, useFrankieTheme, useResolvedMode };