@factorialco/f0-react 1.412.0 → 1.413.1

package/dist/f0.d.ts

@@ -313,6 +313,11 @@ declare type AiChatDisclaimer = {
     linkText?: string;
 };
 
+/**
+ * Interaction mode for the AI chat
+ */
+export declare type AiChatMode = "chat" | "voice";
+
 /**
  * Props for the AiChatProvider component
  */
@@ -349,6 +354,10 @@ export declare type AiChatProviderProps = {
      * Optional footer content rendered below the textarea
      */
     footer?: React.ReactNode;
+    /**
+     * Optional component rendered in place of the chat UI when voice mode is active.
+     */
+    VoiceMode?: React.ComponentType;
     /**
      * Async resolver functions for entity references in markdown.
      * Used to fetch profile data for inline entity mentions (hover cards).
@@ -442,6 +451,14 @@ declare type AiChatProviderReturnValue = {
      * Set the visualization mode
      */
     setVisualizationMode: React.Dispatch<React.SetStateAction<VisualizationMode>>;
+    /**
+     * The current interaction mode
+     */
+    mode: AiChatMode;
+    /**
+     * Set the interaction mode
+     */
+    setMode: React.Dispatch<React.SetStateAction<AiChatMode>>;
     /**
      * When true, prevents switching between visualization modes
      */
@@ -451,6 +468,10 @@ declare type AiChatProviderReturnValue = {
      * Optional footer content rendered below the textarea
      */
     footer?: React.ReactNode;
+    /**
+     * Optional component rendered when voice mode is active.
+     */
+    VoiceMode?: React.ComponentType;
     /**
      * Set the footer content. Use this to update the footer from outside the provider (e.g. per page/route).
      */
@@ -458,8 +479,6 @@ declare type AiChatProviderReturnValue = {
 } & Pick<AiChatState, "greeting" | "agent" | "disclaimer" | "resizable" | "entityResolvers" | "toolHints"> & {
     /** The current canvas content, or null when canvas is closed */
     canvasContent: CanvasContent | null;
-    /** The dashboard config from the current canvas content, or null */
-    canvasDashboard: ChatDashboardConfig | null;
     /** Open the canvas panel with the given content */
     openCanvas: (content: CanvasContent) => void;
     /** Close the canvas panel and restore the previous visualization mode */
@@ -468,10 +487,6 @@ declare type AiChatProviderReturnValue = {
     activeToolHint: AiChatToolHint | null;
     /** Set the active tool hint (pass null to clear) */
     setActiveToolHint: React.Dispatch<React.SetStateAction<AiChatToolHint | null>>;
-    /** Get a saved dashboard config by toolCallId (returns updated config after user edits) */
-    getSavedDashboardConfig: (toolCallId: string) => ChatDashboardConfig | undefined;
-    /** Save an updated dashboard config keyed by toolCallId */
-    updateDashboardConfig: (toolCallId: string, config: ChatDashboardConfig) => void;
 };
 
 /**
@@ -489,6 +504,7 @@ declare interface AiChatState {
     lockVisualizationMode?: boolean;
     historyEnabled?: boolean;
     footer?: React.ReactNode;
+    VoiceMode?: React.ComponentType;
     entityResolvers?: EntityResolvers;
     toolHints?: AiChatToolHint[];
     placeholders?: string[];
@@ -1308,19 +1324,54 @@ declare type CalendarView = "day" | "month" | "year" | "week" | "quarter" | "hal
 
 /**
  * Discriminated union for canvas panel content.
- * Expand this union to support new content types in the canvas.
+ * Add new entity types to this union as they are implemented.
  */
-export declare type CanvasContent = {
-    type: "dashboard";
+export declare type CanvasContent = DashboardCanvasContent;
+
+/**
+ * Base shape shared by all canvas content types.
+ * Every entity adds its own fields on top of this.
+ */
+export declare type CanvasContentBase = {
+    type: string;
     title: string;
-    config: ChatDashboardConfig;
-    apiConfig: {
-        baseUrl: string;
-        headers: Record<string, string>;
-    };
     toolCallId?: string;
 };
 
+/**
+ * Contract for a canvas entity type.
+ *
+ * Each entity (dashboard, survey, goal, job-posting…) implements this
+ * interface and registers itself via `registerCanvasEntity()`.
+ *
+ * To add a new entity type:
+ * 1. Create a folder in `canvas/entities/<your-entity>/`
+ * 2. Define a type extending `CanvasContentBase` in `types.ts`
+ * 3. Implement `CanvasEntityDefinition` in `index.ts`
+ * 4. Import the entity module in `canvas/index.ts`
+ */
+export declare type CanvasEntityDefinition<T extends CanvasContentBase = CanvasContentBase> = {
+    /** Must match the `type` discriminant on the content object */
+    type: T["type"];
+    /** Renders the main body of the canvas panel */
+    renderContent: (props: {
+        content: T;
+        refreshKey: number;
+    }) => ReactNode;
+    /** Renders header actions (placed before the close button) */
+    renderHeaderActions: (props: {
+        content: T;
+    }) => ReactNode;
+    /**
+     * Optional wrapper providing entity-scoped context around
+     * both header actions and body (e.g. shared edit-mode state).
+     */
+    wrapper?: (props: {
+        content: T;
+        children: ReactNode;
+    }) => ReactNode;
+};
+
 declare type CardAvatarVariant = AvatarVariant | {
     type: "emoji";
     emoji: string;
@@ -2043,6 +2094,29 @@ declare interface CustomFieldRenderPropsBase {
 
 export declare const Dashboard: WithDataTestIdReturnType_3<ComponentType<DashboardProps_2> & PageLayoutGroupComponent_2>;
 
+/**
+ * Dashboard canvas content — renders an analytics dashboard.
+ */
+export declare type DashboardCanvasContent = CanvasContentBase & {
+    type: "dashboard";
+    config: ChatDashboardConfig;
+    apiConfig: {
+        baseUrl: string;
+        headers: Record<string, string>;
+    };
+};
+
+/**
+ * Dashboard-specific card that wraps CanvasCard with config-store
+ * subscription logic. Re-renders when the user edits and saves
+ * the dashboard layout.
+ */
+declare function DashboardCard({ config: originalConfig, onView, toolCallId, }: F0ChatReportCardProps): JSX_2.Element;
+
+declare namespace DashboardCard {
+    var displayName: string;
+}
+
 /**
  * Chart display configuration — discriminated on `type`.
  * This object is JSON-serializable (no functions, except optional formatters).
@@ -3571,7 +3645,7 @@ export declare const F0AiChat: () => JSX_2.Element | null;
 /**
  * @experimental This is an experimental component use it at your own risk
  */
-export declare const F0AiChatProvider: ({ enabled, greeting, initialMessage, welcomeScreenSuggestions, disclaimer, resizable, defaultVisualizationMode, lockVisualizationMode, historyEnabled, footer, entityResolvers, toolHints, onThumbsUp, onThumbsDown, children, agent, tracking, ...copilotKitProps }: AiChatProviderProps) => JSX_2.Element;
+export declare const F0AiChatProvider: ({ enabled, greeting, initialMessage, welcomeScreenSuggestions, disclaimer, resizable, defaultVisualizationMode, lockVisualizationMode, historyEnabled, footer, VoiceMode, entityResolvers, toolHints, onThumbsUp, onThumbsDown, children, agent, tracking, ...copilotKitProps }: AiChatProviderProps) => JSX_2.Element;
 
 export declare const F0AiChatTextArea: ({ submitLabel, inProgress, onSend, onStop, placeholders, defaultPlaceholder, autoFocus, entityResolvers, toolHints, activeToolHint, onActiveToolHintChange, }: F0AiChatTextAreaProps) => JSX_2.Element;
 
@@ -4268,29 +4342,19 @@ compact?: boolean;
 export declare type F0CardProps = Omit<CardInternalProps, (typeof privateProps_3)[number]>;
 
 /**
- * Compact card shown inline in the AI chat to represent a generated
- * dashboard report. Uses F0Card with an icon avatar, the dashboard
- * title/description, and an item summary in metadata. Clicking the
- * card triggers `onView` to open the canvas panel.
- *
- * Subscribes to the external `savedDashboardConfigStore` via
- * `useSyncExternalStore` so it re-renders when the user edits the
- * dashboard layout and saves — independently of React context.
+ * @deprecated Use `DashboardCard` from `canvas/entities/dashboard` directly.
+ * This re-export exists for backwards compatibility.
  */
-export declare function F0ChatReportCard({ config: originalConfig, onView, toolCallId, }: F0ChatReportCardProps): JSX_2.Element;
+export declare const F0ChatReportCard: typeof DashboardCard;
 
-export declare namespace F0ChatReportCard {
-    var displayName: string;
-}
-
-export declare interface F0ChatReportCardProps {
+export declare type F0ChatReportCardProps = {
     /** The original dashboard config from the agent */
     config: ChatDashboardConfig;
     /** Callback when the user clicks the card to view the report */
     onView: (config: ChatDashboardConfig) => void;
     /** Tool call ID used to look up saved (edited) dashboard configs */
     toolCallId?: string;
-}
+};
 
 /**
  * @experimental This is an experimental component use it at your own risk
@@ -6707,6 +6771,12 @@ export declare const getAnimationVariants: (options?: AnimationVariantsOptions)
     };
 };
 
+/**
+ * Look up a registered entity definition by content type.
+ * Returns `undefined` if the type hasn't been registered.
+ */
+export declare function getCanvasEntity(type: string): CanvasEntityDefinition<any> | undefined;
+
 /**
  * Get the pagination type of a data adapter
  * @param dataAdapter - The data adapter to get the pagination type of
@@ -8508,6 +8578,12 @@ export declare type RecordType = Record<string, unknown>;
 
 declare type ReferenceType = "none" | "striped";
 
+/**
+ * Register a canvas entity definition.
+ * Called as a side-effect when each entity module is imported.
+ */
+export declare function registerCanvasEntity<T extends CanvasContentBase>(definition: CanvasEntityDefinition<T>): void;
+
 declare type RegularAction = BaseAction & {
     type: "regular";
     variant: ButtonVariant;