@frankieai/react 0.2.19 → 0.2.21

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as react from 'react';
 import { ReactNode, CSSProperties, MutableRefObject, ButtonHTMLAttributes, HTMLAttributes, TextareaHTMLAttributes } from 'react';
-import { PublicWidgetConfig, CreateSessionResponse, ChatAttachment, FrankieServerEvent, WidgetTheme, LoadedSkill, ApiToolInventory } from '@frankieai/core';
+import { PublicWidgetConfig, CreateSessionResponse, ChatAttachment, ActionDecision, FrankieServerEvent, WidgetTheme, ActionPreview, LoadedSkill, ApiToolInventory } from '@frankieai/core';
 export { FrankieServerEvent, PublicWidgetConfig, WidgetTheme } from '@frankieai/core';
 import * as class_variance_authority_types from 'class-variance-authority/types';
 import { VariantProps } from 'class-variance-authority';
@@ -46,9 +46,9 @@ interface FrankieClientOptions {
     fetchImpl?: typeof fetch;
     /**
      * Reaches the host's own API for `execution: "client"` tool calls (see
-     * `HostApiClientOptions`). Required only for workspaces that use client-side
-     * execution; omit it and a client-mode tool reports that no host API is
-     * configured rather than calling anything.
+     * `HostApiClientOptions`). Defaults to the site the user is on, with the
+     * page's own cookies (`credentials: "same-origin"`): set it when your API
+     * lives on another origin or signs requests with a token.
      */
     api?: HostApiClientOptions;
     /**
@@ -80,6 +80,8 @@ declare class FrankieClient {
     private session?;
     /** Identity (JWT `sub`, else the raw token) the cached session was issued for. */
     private sessionUserKey?;
+    /** The host token fetched for the latest turn; sent with it so tools get a live one. */
+    private latestUserToken?;
     constructor(options: FrankieClientOptions);
     get sessionId(): string | undefined;
     get conversationId(): string | undefined;
@@ -114,6 +116,8 @@ declare class FrankieClient {
         context?: PageContext;
         model?: string;
         attachments?: ChatAttachment[];
+        /** The user's answer to the action the last reply paused for approval. */
+        confirm?: ActionDecision;
         signal?: AbortSignal;
     }, onEvent: (event: FrankieServerEvent) => void): Promise<void>;
     /**
@@ -184,6 +188,17 @@ interface UserChatMessage {
     attachments?: MessageAttachment[];
     createdAt: number;
 }
+/**
+ * An action that changes data, paused until the user approves it. `pending`
+ * shows Approve and Cancel; the other states record the answer.
+ */
+interface ActionRequest {
+    toolUseId: string;
+    name: string;
+    label: string;
+    preview: ActionPreview;
+    state: "pending" | "approved" | "cancelled";
+}
 interface AssistantChatMessage {
     id: string;
     role: "assistant";
@@ -193,6 +208,8 @@ interface AssistantChatMessage {
     status: "streaming" | "done" | "error";
     error?: string;
     createdAt: number;
+    /** An action this reply is waiting on the user to approve. */
+    action?: ActionRequest;
 }
 type ChatMessage = UserChatMessage | AssistantChatMessage;
 /**
@@ -209,6 +226,8 @@ declare function newUserMessage(id: string, text: string, attachments?: MessageA
 interface SendOptions {
     attachments?: ChatAttachment[];
     model?: string;
+    /** Answer the action the last reply paused for approval. */
+    confirm?: ActionDecision;
 }
 interface UseFrankieChatResult {
     loadedSkills: LoadedSkill[] | null;
@@ -221,6 +240,11 @@ interface UseFrankieChatResult {
     /** Set when the turn failed outright (network, auth, rate limit). */
     error?: string;
     send: (text: string, opts?: SendOptions) => Promise<void>;
+    /**
+     * Approve or cancel the action a reply paused (`message.action`). Approving
+     * runs exactly what the card shows; either way the assistant then replies.
+     */
+    answerAction: (toolUseId: string, approved: boolean) => Promise<void>;
     /** Abort the in-flight turn. The partial answer stays in the transcript. */
     stop: () => void;
     /** Clear the transcript and start a brand-new server session. */
@@ -276,6 +300,12 @@ interface FrankieWidgetProps extends ChatPanelProps {
      * cookie banner) instead of underneath them. Defaults to `true`.
      */
     avoidBottomBars?: boolean;
+    /**
+     * Close the open panel when the user clicks or taps anywhere outside the
+     * widget, like a popover. Defaults to `true`. Clicks on elements marked
+     * `data-frankie-open` (or `data-frankie-keep-open`) never close it.
+     */
+    closeOnOutsideClick?: boolean;
 }
 /**
  * The drop-in embed: a floating launcher plus the chat panel.
@@ -283,7 +313,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, launcher, avoidBottomBars, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
+declare function FrankieWidget({ position, offset, defaultOpen, zIndex, open: controlledOpen, onOpenChange, renderLauncher, launcher, avoidBottomBars, closeOnOutsideClick, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
 
 interface FrankieInlineProps extends ChatPanelProps {
     /** Extra styles on the filling wrapper — e.g. a `maxWidth` to centre the column. */
@@ -365,6 +395,8 @@ interface MessageBubbleProps {
     active?: boolean;
     /** A turn is in flight, so choices should be disabled. */
     busy?: boolean;
+    /** Approve or cancel an action this reply paused. */
+    onAction?: (toolUseId: string, approved: boolean) => void;
 }
 declare const MessageBubble: react.NamedExoticComponent<MessageBubbleProps>;
 declare function TypingDots(): react.JSX.Element;
@@ -407,6 +439,19 @@ declare function Choices({ options, onPick, onSomethingElse, disabled, }: {
     disabled?: boolean;
 }): react.JSX.Element | null;
 
+/**
+ * An action that changes data, shown before it runs. Nothing happens until
+ * the user presses Approve, and then exactly what is shown here runs — the
+ * assistant can't change the inputs in between.
+ */
+declare function ActionConfirm({ action, onAnswer, disabled, live, }: {
+    action: ActionRequest;
+    onAnswer?: (toolUseId: string, approved: boolean) => void;
+    disabled?: boolean;
+    /** False once the conversation has moved on without an answer. */
+    live: boolean;
+}): react.JSX.Element;
+
 declare function SuggestedPrompts({ prompts, onPick, disabled, }: {
     prompts: string[];
     onPick: (prompt: string) => void;
@@ -514,4 +559,4 @@ 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, useResolvedMode };
+export { ActionConfirm, type ActionRequest, 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

@@ -1,6 +1,6 @@
 import * as react from 'react';
 import { ReactNode, CSSProperties, MutableRefObject, ButtonHTMLAttributes, HTMLAttributes, TextareaHTMLAttributes } from 'react';
-import { PublicWidgetConfig, CreateSessionResponse, ChatAttachment, FrankieServerEvent, WidgetTheme, LoadedSkill, ApiToolInventory } from '@frankieai/core';
+import { PublicWidgetConfig, CreateSessionResponse, ChatAttachment, ActionDecision, FrankieServerEvent, WidgetTheme, ActionPreview, LoadedSkill, ApiToolInventory } from '@frankieai/core';
 export { FrankieServerEvent, PublicWidgetConfig, WidgetTheme } from '@frankieai/core';
 import * as class_variance_authority_types from 'class-variance-authority/types';
 import { VariantProps } from 'class-variance-authority';
@@ -46,9 +46,9 @@ interface FrankieClientOptions {
     fetchImpl?: typeof fetch;
     /**
      * Reaches the host's own API for `execution: "client"` tool calls (see
-     * `HostApiClientOptions`). Required only for workspaces that use client-side
-     * execution; omit it and a client-mode tool reports that no host API is
-     * configured rather than calling anything.
+     * `HostApiClientOptions`). Defaults to the site the user is on, with the
+     * page's own cookies (`credentials: "same-origin"`): set it when your API
+     * lives on another origin or signs requests with a token.
      */
     api?: HostApiClientOptions;
     /**
@@ -80,6 +80,8 @@ declare class FrankieClient {
     private session?;
     /** Identity (JWT `sub`, else the raw token) the cached session was issued for. */
     private sessionUserKey?;
+    /** The host token fetched for the latest turn; sent with it so tools get a live one. */
+    private latestUserToken?;
     constructor(options: FrankieClientOptions);
     get sessionId(): string | undefined;
     get conversationId(): string | undefined;
@@ -114,6 +116,8 @@ declare class FrankieClient {
         context?: PageContext;
         model?: string;
         attachments?: ChatAttachment[];
+        /** The user's answer to the action the last reply paused for approval. */
+        confirm?: ActionDecision;
         signal?: AbortSignal;
     }, onEvent: (event: FrankieServerEvent) => void): Promise<void>;
     /**
@@ -184,6 +188,17 @@ interface UserChatMessage {
     attachments?: MessageAttachment[];
     createdAt: number;
 }
+/**
+ * An action that changes data, paused until the user approves it. `pending`
+ * shows Approve and Cancel; the other states record the answer.
+ */
+interface ActionRequest {
+    toolUseId: string;
+    name: string;
+    label: string;
+    preview: ActionPreview;
+    state: "pending" | "approved" | "cancelled";
+}
 interface AssistantChatMessage {
     id: string;
     role: "assistant";
@@ -193,6 +208,8 @@ interface AssistantChatMessage {
     status: "streaming" | "done" | "error";
     error?: string;
     createdAt: number;
+    /** An action this reply is waiting on the user to approve. */
+    action?: ActionRequest;
 }
 type ChatMessage = UserChatMessage | AssistantChatMessage;
 /**
@@ -209,6 +226,8 @@ declare function newUserMessage(id: string, text: string, attachments?: MessageA
 interface SendOptions {
     attachments?: ChatAttachment[];
     model?: string;
+    /** Answer the action the last reply paused for approval. */
+    confirm?: ActionDecision;
 }
 interface UseFrankieChatResult {
     loadedSkills: LoadedSkill[] | null;
@@ -221,6 +240,11 @@ interface UseFrankieChatResult {
     /** Set when the turn failed outright (network, auth, rate limit). */
     error?: string;
     send: (text: string, opts?: SendOptions) => Promise<void>;
+    /**
+     * Approve or cancel the action a reply paused (`message.action`). Approving
+     * runs exactly what the card shows; either way the assistant then replies.
+     */
+    answerAction: (toolUseId: string, approved: boolean) => Promise<void>;
     /** Abort the in-flight turn. The partial answer stays in the transcript. */
     stop: () => void;
     /** Clear the transcript and start a brand-new server session. */
@@ -276,6 +300,12 @@ interface FrankieWidgetProps extends ChatPanelProps {
      * cookie banner) instead of underneath them. Defaults to `true`.
      */
     avoidBottomBars?: boolean;
+    /**
+     * Close the open panel when the user clicks or taps anywhere outside the
+     * widget, like a popover. Defaults to `true`. Clicks on elements marked
+     * `data-frankie-open` (or `data-frankie-keep-open`) never close it.
+     */
+    closeOnOutsideClick?: boolean;
 }
 /**
  * The drop-in embed: a floating launcher plus the chat panel.
@@ -283,7 +313,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, launcher, avoidBottomBars, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
+declare function FrankieWidget({ position, offset, defaultOpen, zIndex, open: controlledOpen, onOpenChange, renderLauncher, launcher, avoidBottomBars, closeOnOutsideClick, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
 
 interface FrankieInlineProps extends ChatPanelProps {
     /** Extra styles on the filling wrapper — e.g. a `maxWidth` to centre the column. */
@@ -365,6 +395,8 @@ interface MessageBubbleProps {
     active?: boolean;
     /** A turn is in flight, so choices should be disabled. */
     busy?: boolean;
+    /** Approve or cancel an action this reply paused. */
+    onAction?: (toolUseId: string, approved: boolean) => void;
 }
 declare const MessageBubble: react.NamedExoticComponent<MessageBubbleProps>;
 declare function TypingDots(): react.JSX.Element;
@@ -407,6 +439,19 @@ declare function Choices({ options, onPick, onSomethingElse, disabled, }: {
     disabled?: boolean;
 }): react.JSX.Element | null;
 
+/**
+ * An action that changes data, shown before it runs. Nothing happens until
+ * the user presses Approve, and then exactly what is shown here runs — the
+ * assistant can't change the inputs in between.
+ */
+declare function ActionConfirm({ action, onAnswer, disabled, live, }: {
+    action: ActionRequest;
+    onAnswer?: (toolUseId: string, approved: boolean) => void;
+    disabled?: boolean;
+    /** False once the conversation has moved on without an answer. */
+    live: boolean;
+}): react.JSX.Element;
+
 declare function SuggestedPrompts({ prompts, onPick, disabled, }: {
     prompts: string[];
     onPick: (prompt: string) => void;
@@ -514,4 +559,4 @@ 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, useResolvedMode };
+export { ActionConfirm, type ActionRequest, 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 };