@frankieai/react 0.1.4 → 0.2.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as react from 'react';
 import { ReactNode, CSSProperties, ButtonHTMLAttributes, HTMLAttributes, TextareaHTMLAttributes } from 'react';
-import { PublicWidgetConfig, CreateSessionResponse, ChatAttachment, FrankieServerEvent, WidgetTheme } from '@frankieai/core';
+import { PublicWidgetConfig, CreateSessionResponse, ChatAttachment, FrankieServerEvent, WidgetTheme, LoadedSkill } 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';
@@ -19,15 +19,15 @@ interface FrankieClientOptions {
     publishableKey: string;
     /**
      * Fetches a short-lived JWT for the signed-in user from the host's own
-     * backend. Called once per session, and again when a session expires.
+     * backend. Called before each turn; return undefined after sign-out.
      * Omit only for tenants that allow anonymous chat.
      */
     getUserToken?: () => Promise<string | undefined> | string | undefined;
     fetchImpl?: typeof fetch;
     /**
      * Remember the session (and, in the hook, the transcript) in localStorage so a
-     * page reload resumes the same conversation. On by default in the browser;
-     * set false for an ephemeral chat that starts fresh every load.
+     * page reload resumes the same anonymous conversation. Authenticated chat
+     * never writes tokens or transcripts to localStorage; it uses server history.
      */
     persist?: boolean;
     /** Override localStorage namespace for session and transcript. */
@@ -51,6 +51,7 @@ declare class FrankieClient {
     private readonly baseUrl;
     private readonly doFetch;
     private session?;
+    private sessionUserToken?;
     constructor(options: FrankieClientOptions);
     get sessionId(): string | undefined;
     get conversationId(): string | undefined;
@@ -146,6 +147,8 @@ interface SendOptions {
     model?: string;
 }
 interface UseFrankieChatResult {
+    loadedSkills: LoadedSkill[] | null;
+    restoring: boolean;
     messages: ChatMessage[];
     /** True from the moment a message is sent until the turn ends. */
     busy: boolean;
@@ -185,6 +188,8 @@ interface FrankieWidgetProps extends ChatPanelProps {
     /** Distance from the viewport edges, in pixels. */
     offset?: number;
     defaultOpen?: boolean;
+    /** Host overlays should sit above the assistant. Override for your layer system. */
+    zIndex?: number;
     /** Controlled mode: pass both to drive open state from the host app. */
     open?: boolean;
     onOpenChange?: (open: boolean) => void;
@@ -201,7 +206,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, open: controlledOpen, onOpenChange, renderLauncher, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
+declare function FrankieWidget({ position, offset, defaultOpen, zIndex, open: controlledOpen, onOpenChange, renderLauncher, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
 
 interface FrankieInlineProps extends ChatPanelProps {
     /** Extra styles on the filling wrapper — e.g. a `maxWidth` to centre the column. */
@@ -218,15 +223,16 @@ interface FrankieInlineProps extends ChatPanelProps {
  */
 declare function FrankieInline({ className, style, ...panelProps }: FrankieInlineProps): react.JSX.Element;
 
-/**
- * A complete chat route in one component. This is the simplest way to add a
- * dedicated /chat page to an app while keeping the existing floating widget.
- */
 interface FrankieChatPageProps extends Omit<FrankieProviderProps, "children">, Pick<ChatPanelProps, "header" | "footer" | "emptyState" | "renderMessage" | "renderTool" | "placeholder" | "autoFocus"> {
     className?: string;
     style?: CSSProperties;
+    /** Include the built-in conversation sidebar. Defaults to true. */
+    showHistory?: boolean;
+    /** Optional host navigation, e.g. a Back to dashboard link. */
+    navigation?: React.ReactNode;
 }
-declare function FrankieChatPage({ className, style, header, footer, emptyState, renderMessage, renderTool, placeholder, autoFocus, ...providerProps }: FrankieChatPageProps): react.JSX.Element;
+/** 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;
 
 interface ComposerAttachmentsConfig {
     enabled: boolean;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react from 'react';
 import { ReactNode, CSSProperties, ButtonHTMLAttributes, HTMLAttributes, TextareaHTMLAttributes } from 'react';
-import { PublicWidgetConfig, CreateSessionResponse, ChatAttachment, FrankieServerEvent, WidgetTheme } from '@frankieai/core';
+import { PublicWidgetConfig, CreateSessionResponse, ChatAttachment, FrankieServerEvent, WidgetTheme, LoadedSkill } 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';
@@ -19,15 +19,15 @@ interface FrankieClientOptions {
     publishableKey: string;
     /**
      * Fetches a short-lived JWT for the signed-in user from the host's own
-     * backend. Called once per session, and again when a session expires.
+     * backend. Called before each turn; return undefined after sign-out.
      * Omit only for tenants that allow anonymous chat.
      */
     getUserToken?: () => Promise<string | undefined> | string | undefined;
     fetchImpl?: typeof fetch;
     /**
      * Remember the session (and, in the hook, the transcript) in localStorage so a
-     * page reload resumes the same conversation. On by default in the browser;
-     * set false for an ephemeral chat that starts fresh every load.
+     * page reload resumes the same anonymous conversation. Authenticated chat
+     * never writes tokens or transcripts to localStorage; it uses server history.
      */
     persist?: boolean;
     /** Override localStorage namespace for session and transcript. */
@@ -51,6 +51,7 @@ declare class FrankieClient {
     private readonly baseUrl;
     private readonly doFetch;
     private session?;
+    private sessionUserToken?;
     constructor(options: FrankieClientOptions);
     get sessionId(): string | undefined;
     get conversationId(): string | undefined;
@@ -146,6 +147,8 @@ interface SendOptions {
     model?: string;
 }
 interface UseFrankieChatResult {
+    loadedSkills: LoadedSkill[] | null;
+    restoring: boolean;
     messages: ChatMessage[];
     /** True from the moment a message is sent until the turn ends. */
     busy: boolean;
@@ -185,6 +188,8 @@ interface FrankieWidgetProps extends ChatPanelProps {
     /** Distance from the viewport edges, in pixels. */
     offset?: number;
     defaultOpen?: boolean;
+    /** Host overlays should sit above the assistant. Override for your layer system. */
+    zIndex?: number;
     /** Controlled mode: pass both to drive open state from the host app. */
     open?: boolean;
     onOpenChange?: (open: boolean) => void;
@@ -201,7 +206,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, open: controlledOpen, onOpenChange, renderLauncher, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
+declare function FrankieWidget({ position, offset, defaultOpen, zIndex, open: controlledOpen, onOpenChange, renderLauncher, ...panelProps }: FrankieWidgetProps): react.JSX.Element;
 
 interface FrankieInlineProps extends ChatPanelProps {
     /** Extra styles on the filling wrapper — e.g. a `maxWidth` to centre the column. */
@@ -218,15 +223,16 @@ interface FrankieInlineProps extends ChatPanelProps {
  */
 declare function FrankieInline({ className, style, ...panelProps }: FrankieInlineProps): react.JSX.Element;
 
-/**
- * A complete chat route in one component. This is the simplest way to add a
- * dedicated /chat page to an app while keeping the existing floating widget.
- */
 interface FrankieChatPageProps extends Omit<FrankieProviderProps, "children">, Pick<ChatPanelProps, "header" | "footer" | "emptyState" | "renderMessage" | "renderTool" | "placeholder" | "autoFocus"> {
     className?: string;
     style?: CSSProperties;
+    /** Include the built-in conversation sidebar. Defaults to true. */
+    showHistory?: boolean;
+    /** Optional host navigation, e.g. a Back to dashboard link. */
+    navigation?: React.ReactNode;
 }
-declare function FrankieChatPage({ className, style, header, footer, emptyState, renderMessage, renderTool, placeholder, autoFocus, ...providerProps }: FrankieChatPageProps): react.JSX.Element;
+/** 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;
 
 interface ComposerAttachmentsConfig {
     enabled: boolean;