@frankieai/react 0.2.9 → 0.2.11

package/dist/index.d.cts

@@ -7,6 +7,26 @@ import { VariantProps } from 'class-variance-authority';
 import { ClassValue } from 'clsx';
 
 type PageContext = Record<string, string | number | boolean | null>;
+/**
+ * How the widget reaches the host's own API for client-side tool execution.
+ *
+ * When a workspace marks an API source `execution: "client"`, Frankie asks the
+ * browser to make the call itself — from the user's existing session — instead
+ * of calling the API from Frankie's servers. This says where that API lives and
+ * how the browser authenticates to it: normally the app's own cookies
+ * (`credentials: "include"` on a same-origin or CORS-allowed API), or a bearer
+ * token the app already holds, added via `headers`. Frankie sends no credential
+ * of its own; the host API authorizes the call exactly as it would any request
+ * from the host's frontend.
+ */
+interface HostApiClientOptions {
+    /** Base URL that operation paths resolve against, e.g. "/api" or "https://api.acme.com". */
+    baseUrl: string;
+    /** fetch credentials mode. "include" sends the app's cookies. Defaults to "same-origin". */
+    credentials?: RequestCredentials;
+    /** Extra headers for every host call (e.g. an app access token). Awaited per call. */
+    headers?: () => Promise<Record<string, string>> | Record<string, string>;
+}
 /**
  * The hosted Frankie data plane. Embedding needs only a publishable key, so
  * `baseUrl` defaults here — override it only when self-hosting the server.
@@ -24,6 +44,13 @@ interface FrankieClientOptions {
      */
     getUserToken?: () => Promise<string | undefined> | string | undefined;
     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.
+     */
+    api?: HostApiClientOptions;
     /**
      * Remember the session (and, in the hook, the transcript) in localStorage so a
      * page reload resumes the same anonymous conversation. Authenticated chat
@@ -51,7 +78,8 @@ declare class FrankieClient {
     private readonly baseUrl;
     private readonly doFetch;
     private session?;
-    private sessionUserToken?;
+    /** Identity (JWT `sub`, else the raw token) the cached session was issued for. */
+    private sessionUserKey?;
     constructor(options: FrankieClientOptions);
     get sessionId(): string | undefined;
     get conversationId(): string | undefined;
@@ -79,6 +107,14 @@ declare class FrankieClient {
         attachments?: ChatAttachment[];
         signal?: AbortSignal;
     }, onEvent: (event: FrankieServerEvent) => void): Promise<void>;
+    /**
+     * Execute one host API call in the browser and report the outcome back to the
+     * server. Never throws: a transport failure or a missing `api` client becomes
+     * a result the model can see and explain, exactly like a non-2xx status.
+     */
+    private runClientTool;
+    private callHostApi;
+    private postToolResult;
     private unwrap;
 }
 declare function readEventStream(body: ReadableStream<Uint8Array>): AsyncGenerator<FrankieServerEvent>;
@@ -88,6 +124,15 @@ interface FrankieProviderProps extends FrankieClientOptions {
     context?: PageContext;
     theme?: WidgetTheme;
     config?: PublicWidgetConfig;
+    /**
+     * Set to `false` if the host compiles Frankie's classes itself instead of
+     * loading `@frankieai/react/styles.css` — e.g. a Tailwind v4 host that
+     * `@source`s this package — so it isn't given a second, independently-themed
+     * copy of the stylesheet when its own build never sets the styles-ready
+     * sentinel. Defaults to `true`: a host that simply forgot the import, or
+     * whose CSS chunk hasn't landed yet, still gets a correctly-styled widget.
+     */
+    injectStyles?: boolean;
 }
 interface FrankieContextValue {
     client: FrankieClient;
@@ -96,8 +141,9 @@ interface FrankieContextValue {
     loading: boolean;
     context?: PageContext;
     theme?: WidgetTheme;
+    injectStyles: boolean;
 }
-declare function FrankieProvider({ children, context, theme, config: providedConfig, ...clientOptions }: FrankieProviderProps): react.JSX.Element;
+declare function FrankieProvider({ children, context, theme, config: providedConfig, injectStyles, ...clientOptions }: FrankieProviderProps): react.JSX.Element;
 declare function useFrankie(): FrankieContextValue;
 declare function useFrankieTheme(): WidgetTheme | undefined;
 
@@ -287,6 +333,12 @@ interface MessageBubbleProps {
 }
 declare const MessageBubble: react.NamedExoticComponent<MessageBubbleProps>;
 declare function TypingDots(): react.JSX.Element;
+/**
+ * A shimmering skeleton shown while the reply is still being produced — before
+ * 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;
 
 /**
  * A deliberately small Markdown subset — headings, paragraphs, lists, fenced
@@ -417,4 +469,4 @@ declare function resolveMode(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, 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 };

package/dist/index.d.ts

@@ -7,6 +7,26 @@ import { VariantProps } from 'class-variance-authority';
 import { ClassValue } from 'clsx';
 
 type PageContext = Record<string, string | number | boolean | null>;
+/**
+ * How the widget reaches the host's own API for client-side tool execution.
+ *
+ * When a workspace marks an API source `execution: "client"`, Frankie asks the
+ * browser to make the call itself — from the user's existing session — instead
+ * of calling the API from Frankie's servers. This says where that API lives and
+ * how the browser authenticates to it: normally the app's own cookies
+ * (`credentials: "include"` on a same-origin or CORS-allowed API), or a bearer
+ * token the app already holds, added via `headers`. Frankie sends no credential
+ * of its own; the host API authorizes the call exactly as it would any request
+ * from the host's frontend.
+ */
+interface HostApiClientOptions {
+    /** Base URL that operation paths resolve against, e.g. "/api" or "https://api.acme.com". */
+    baseUrl: string;
+    /** fetch credentials mode. "include" sends the app's cookies. Defaults to "same-origin". */
+    credentials?: RequestCredentials;
+    /** Extra headers for every host call (e.g. an app access token). Awaited per call. */
+    headers?: () => Promise<Record<string, string>> | Record<string, string>;
+}
 /**
  * The hosted Frankie data plane. Embedding needs only a publishable key, so
  * `baseUrl` defaults here — override it only when self-hosting the server.
@@ -24,6 +44,13 @@ interface FrankieClientOptions {
      */
     getUserToken?: () => Promise<string | undefined> | string | undefined;
     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.
+     */
+    api?: HostApiClientOptions;
     /**
      * Remember the session (and, in the hook, the transcript) in localStorage so a
      * page reload resumes the same anonymous conversation. Authenticated chat
@@ -51,7 +78,8 @@ declare class FrankieClient {
     private readonly baseUrl;
     private readonly doFetch;
     private session?;
-    private sessionUserToken?;
+    /** Identity (JWT `sub`, else the raw token) the cached session was issued for. */
+    private sessionUserKey?;
     constructor(options: FrankieClientOptions);
     get sessionId(): string | undefined;
     get conversationId(): string | undefined;
@@ -79,6 +107,14 @@ declare class FrankieClient {
         attachments?: ChatAttachment[];
         signal?: AbortSignal;
     }, onEvent: (event: FrankieServerEvent) => void): Promise<void>;
+    /**
+     * Execute one host API call in the browser and report the outcome back to the
+     * server. Never throws: a transport failure or a missing `api` client becomes
+     * a result the model can see and explain, exactly like a non-2xx status.
+     */
+    private runClientTool;
+    private callHostApi;
+    private postToolResult;
     private unwrap;
 }
 declare function readEventStream(body: ReadableStream<Uint8Array>): AsyncGenerator<FrankieServerEvent>;
@@ -88,6 +124,15 @@ interface FrankieProviderProps extends FrankieClientOptions {
     context?: PageContext;
     theme?: WidgetTheme;
     config?: PublicWidgetConfig;
+    /**
+     * Set to `false` if the host compiles Frankie's classes itself instead of
+     * loading `@frankieai/react/styles.css` — e.g. a Tailwind v4 host that
+     * `@source`s this package — so it isn't given a second, independently-themed
+     * copy of the stylesheet when its own build never sets the styles-ready
+     * sentinel. Defaults to `true`: a host that simply forgot the import, or
+     * whose CSS chunk hasn't landed yet, still gets a correctly-styled widget.
+     */
+    injectStyles?: boolean;
 }
 interface FrankieContextValue {
     client: FrankieClient;
@@ -96,8 +141,9 @@ interface FrankieContextValue {
     loading: boolean;
     context?: PageContext;
     theme?: WidgetTheme;
+    injectStyles: boolean;
 }
-declare function FrankieProvider({ children, context, theme, config: providedConfig, ...clientOptions }: FrankieProviderProps): react.JSX.Element;
+declare function FrankieProvider({ children, context, theme, config: providedConfig, injectStyles, ...clientOptions }: FrankieProviderProps): react.JSX.Element;
 declare function useFrankie(): FrankieContextValue;
 declare function useFrankieTheme(): WidgetTheme | undefined;
 
@@ -287,6 +333,12 @@ interface MessageBubbleProps {
 }
 declare const MessageBubble: react.NamedExoticComponent<MessageBubbleProps>;
 declare function TypingDots(): react.JSX.Element;
+/**
+ * A shimmering skeleton shown while the reply is still being produced — before
+ * 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;
 
 /**
  * A deliberately small Markdown subset — headings, paragraphs, lists, fenced
@@ -417,4 +469,4 @@ declare function resolveMode(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, 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 };