@frankieai/react 0.1.1 → 0.1.5

package/dist/index.d.cts

@@ -30,6 +30,16 @@ interface FrankieClientOptions {
      * set false for an ephemeral chat that starts fresh every load.
      */
     persist?: boolean;
+    /** Override localStorage namespace for session and transcript. */
+    storageNamespace?: string;
+    /** Stable id for a server-backed conversation. */
+    conversationId?: string;
+}
+interface ChatConversation {
+    id: string;
+    title: string;
+    createdAt: number;
+    updatedAt: number;
 }
 declare class FrankieApiError extends Error {
     readonly status: number;
@@ -43,45 +53,39 @@ declare class FrankieClient {
     private session?;
     constructor(options: FrankieClientOptions);
     get sessionId(): string | undefined;
+    get conversationId(): string | undefined;
     /** Whether this client persists across reloads (browser only, opt-out via `persist:false`). */
     get persist(): boolean;
-    /** localStorage namespace for this tenant, shared with the chat hook. */
+    /** localStorage namespace for this tenant/conversation, shared with the chat hook. */
     get namespace(): string;
     private readStored;
     private writeStored;
     getConfig(signal?: AbortSignal): Promise<PublicWidgetConfig>;
-    /** Opens (or reuses) a chat session. */
     ensureSession(context?: PageContext): Promise<CreateSessionResponse>;
-    /** Forget the current session so the next send starts a fresh conversation. */
+    listConversations(): Promise<ChatConversation[]>;
+    resumeConversation(id?: string | undefined): Promise<{
+        messages: unknown[];
+        title: string;
+    } | undefined>;
+    syncConversation(messages: unknown[], title?: string): Promise<void>;
+    deleteConversation(id: string): Promise<void>;
+    private requireUserToken;
     resetSession(): void;
-    /**
-     * Sends a message and invokes `onEvent` for each server event as it arrives.
-     * Resolves when the turn ends.
-     */
     send(input: {
         message: string;
         context?: PageContext;
-        /** Model id chosen by the user, honoured only if the workspace allows it. */
         model?: string;
-        /** Files attached to this turn. */
         attachments?: ChatAttachment[];
         signal?: AbortSignal;
     }, onEvent: (event: FrankieServerEvent) => void): Promise<void>;
     private unwrap;
 }
-/** Parse the server's `data:`-only SSE stream into typed events. */
 declare function readEventStream(body: ReadableStream<Uint8Array>): AsyncGenerator<FrankieServerEvent>;
 
 interface FrankieProviderProps extends FrankieClientOptions {
     children: ReactNode;
-    /**
-     * Page context sent with every turn — current route, plan tier, whatever the
-     * agent should know. Treated as data by the server, never as instructions.
-     */
     context?: PageContext;
-    /** Overrides for the server-side theme, so a host can restyle without a redeploy. */
     theme?: WidgetTheme;
-    /** Skip the `/v1/config` fetch by supplying the config yourself. */
     config?: PublicWidgetConfig;
 }
 interface FrankieContextValue {
@@ -94,7 +98,6 @@ interface FrankieContextValue {
 }
 declare function FrankieProvider({ children, context, theme, config: providedConfig, ...clientOptions }: FrankieProviderProps): react.JSX.Element;
 declare function useFrankie(): FrankieContextValue;
-/** The theme actually in effect: provider override wins over server config. */
 declare function useFrankieTheme(): WidgetTheme | undefined;
 
 interface ToolActivity {
@@ -215,6 +218,17 @@ interface FrankieInlineProps extends ChatPanelProps {
  */
 declare function FrankieInline({ className, style, ...panelProps }: FrankieInlineProps): react.JSX.Element;
 
+interface FrankieChatPageProps extends Omit<FrankieProviderProps, "children">, Pick<ChatPanelProps, "header" | "footer" | "emptyState" | "renderMessage" | "renderTool" | "placeholder" | "autoFocus"> {
+    className?: string;
+    style?: CSSProperties;
+}
+/**
+ * A complete, polished chat route matching Frankie's own conversation canvas.
+ * The shell, header, empty state and composer are all scoped under
+ * `.frankie-root`, so host application styles remain untouched.
+ */
+declare function FrankieChatPage({ className, style, header, footer, emptyState, renderMessage, renderTool, placeholder, autoFocus, ...providerProps }: FrankieChatPageProps): react.JSX.Element;
+
 interface ComposerAttachmentsConfig {
     enabled: boolean;
     /** Accepted MIME patterns, e.g. "image/*". */
@@ -344,4 +358,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, Composer, FRANKIE_CLOUD_URL, FrankieApiError, 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, 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, Composer, 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, newAssistantMessage, newUserMessage, readEventStream, resolveMode, themeToCssVars, useFrankie, useFrankieChat, useFrankieTheme };

package/dist/index.d.ts

@@ -30,6 +30,16 @@ interface FrankieClientOptions {
      * set false for an ephemeral chat that starts fresh every load.
      */
     persist?: boolean;
+    /** Override localStorage namespace for session and transcript. */
+    storageNamespace?: string;
+    /** Stable id for a server-backed conversation. */
+    conversationId?: string;
+}
+interface ChatConversation {
+    id: string;
+    title: string;
+    createdAt: number;
+    updatedAt: number;
 }
 declare class FrankieApiError extends Error {
     readonly status: number;
@@ -43,45 +53,39 @@ declare class FrankieClient {
     private session?;
     constructor(options: FrankieClientOptions);
     get sessionId(): string | undefined;
+    get conversationId(): string | undefined;
     /** Whether this client persists across reloads (browser only, opt-out via `persist:false`). */
     get persist(): boolean;
-    /** localStorage namespace for this tenant, shared with the chat hook. */
+    /** localStorage namespace for this tenant/conversation, shared with the chat hook. */
     get namespace(): string;
     private readStored;
     private writeStored;
     getConfig(signal?: AbortSignal): Promise<PublicWidgetConfig>;
-    /** Opens (or reuses) a chat session. */
     ensureSession(context?: PageContext): Promise<CreateSessionResponse>;
-    /** Forget the current session so the next send starts a fresh conversation. */
+    listConversations(): Promise<ChatConversation[]>;
+    resumeConversation(id?: string | undefined): Promise<{
+        messages: unknown[];
+        title: string;
+    } | undefined>;
+    syncConversation(messages: unknown[], title?: string): Promise<void>;
+    deleteConversation(id: string): Promise<void>;
+    private requireUserToken;
     resetSession(): void;
-    /**
-     * Sends a message and invokes `onEvent` for each server event as it arrives.
-     * Resolves when the turn ends.
-     */
     send(input: {
         message: string;
         context?: PageContext;
-        /** Model id chosen by the user, honoured only if the workspace allows it. */
         model?: string;
-        /** Files attached to this turn. */
         attachments?: ChatAttachment[];
         signal?: AbortSignal;
     }, onEvent: (event: FrankieServerEvent) => void): Promise<void>;
     private unwrap;
 }
-/** Parse the server's `data:`-only SSE stream into typed events. */
 declare function readEventStream(body: ReadableStream<Uint8Array>): AsyncGenerator<FrankieServerEvent>;
 
 interface FrankieProviderProps extends FrankieClientOptions {
     children: ReactNode;
-    /**
-     * Page context sent with every turn — current route, plan tier, whatever the
-     * agent should know. Treated as data by the server, never as instructions.
-     */
     context?: PageContext;
-    /** Overrides for the server-side theme, so a host can restyle without a redeploy. */
     theme?: WidgetTheme;
-    /** Skip the `/v1/config` fetch by supplying the config yourself. */
     config?: PublicWidgetConfig;
 }
 interface FrankieContextValue {
@@ -94,7 +98,6 @@ interface FrankieContextValue {
 }
 declare function FrankieProvider({ children, context, theme, config: providedConfig, ...clientOptions }: FrankieProviderProps): react.JSX.Element;
 declare function useFrankie(): FrankieContextValue;
-/** The theme actually in effect: provider override wins over server config. */
 declare function useFrankieTheme(): WidgetTheme | undefined;
 
 interface ToolActivity {
@@ -215,6 +218,17 @@ interface FrankieInlineProps extends ChatPanelProps {
  */
 declare function FrankieInline({ className, style, ...panelProps }: FrankieInlineProps): react.JSX.Element;
 
+interface FrankieChatPageProps extends Omit<FrankieProviderProps, "children">, Pick<ChatPanelProps, "header" | "footer" | "emptyState" | "renderMessage" | "renderTool" | "placeholder" | "autoFocus"> {
+    className?: string;
+    style?: CSSProperties;
+}
+/**
+ * A complete, polished chat route matching Frankie's own conversation canvas.
+ * The shell, header, empty state and composer are all scoped under
+ * `.frankie-root`, so host application styles remain untouched.
+ */
+declare function FrankieChatPage({ className, style, header, footer, emptyState, renderMessage, renderTool, placeholder, autoFocus, ...providerProps }: FrankieChatPageProps): react.JSX.Element;
+
 interface ComposerAttachmentsConfig {
     enabled: boolean;
     /** Accepted MIME patterns, e.g. "image/*". */
@@ -344,4 +358,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, Composer, FRANKIE_CLOUD_URL, FrankieApiError, 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, 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, Composer, 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, newAssistantMessage, newUserMessage, readEventStream, resolveMode, themeToCssVars, useFrankie, useFrankieChat, useFrankieTheme };