autoui-react 0.0.3-alpha → 0.0.5-alpha

package/dist/index.d.ts

@@ -4,88 +4,85 @@ import React from 'react';
 /**
  * Event types that can be triggered by UI elements
  */
-declare const uiEventType: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
+declare const uiEventType: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
 type UIEventType = z.infer<typeof uiEventType>;
 /**
  * Event payload schema
  */
 declare const uiEvent: z.ZodObject<{
-    type: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
+    type: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
     nodeId: z.ZodString;
-    timestamp: z.ZodOptional<z.ZodNumber>;
-    payload: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    timestamp: z.ZodNullable<z.ZodNumber>;
+    payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, "strip", z.ZodTypeAny, {
-    type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
+    type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
     nodeId: string;
-    timestamp?: number | undefined;
-    payload?: Record<string, any> | undefined;
+    timestamp: number | null;
+    payload: Record<string, unknown> | null;
 }, {
-    type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
+    type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
     nodeId: string;
-    timestamp?: number | undefined;
-    payload?: Record<string, any> | undefined;
+    timestamp: number | null;
+    payload: Record<string, unknown> | null;
 }>;
 type UIEvent = z.infer<typeof uiEvent>;
-/**
- * Core UI specification node
- * Represents a single element in the UI tree
- */
-declare const uiSpecNode: z.ZodType<UISpecNode>;
-type UISpecNode = {
+interface UISpecNodeInterface {
     id: string;
-    type: string;
-    props?: Record<string, any> | undefined;
-    bindings?: Record<string, any> | undefined;
-    events?: Record<string, {
+    node_type: string;
+    props: Record<string, any> | null;
+    bindings: Record<string, any> | null;
+    events: Record<string, {
         action: string;
-        target?: string | undefined;
-        payload?: Record<string, any> | undefined;
-    }> | undefined;
-    children?: UISpecNode[] | undefined;
-};
+        target: string;
+        payload: Record<string, any> | null;
+    }> | null;
+    children: UISpecNodeInterface[] | null;
+}
+declare const uiSpecNode: z.ZodType<UISpecNodeInterface>;
+type UISpecNode = z.infer<typeof uiSpecNode>;
 /**
  * Application state for the UI engine
  */
 declare const uiState: z.ZodObject<{
-    layout: z.ZodOptional<z.ZodType<UISpecNode, z.ZodTypeDef, UISpecNode>>;
+    layout: z.ZodNullable<z.ZodType<UISpecNodeInterface, z.ZodTypeDef, UISpecNodeInterface>>;
     loading: z.ZodBoolean;
     history: z.ZodArray<z.ZodObject<{
-        type: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
+        type: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
         nodeId: z.ZodString;
-        timestamp: z.ZodOptional<z.ZodNumber>;
-        payload: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        timestamp: z.ZodNullable<z.ZodNumber>;
+        payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     }, "strip", z.ZodTypeAny, {
-        type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
+        type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
         nodeId: string;
-        timestamp?: number | undefined;
-        payload?: Record<string, any> | undefined;
+        timestamp: number | null;
+        payload: Record<string, unknown> | null;
     }, {
-        type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
+        type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
         nodeId: string;
-        timestamp?: number | undefined;
-        payload?: Record<string, any> | undefined;
+        timestamp: number | null;
+        payload: Record<string, unknown> | null;
     }>, "many">;
-    error: z.ZodOptional<z.ZodString>;
+    error: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
+    layout: UISpecNodeInterface | null;
     loading: boolean;
     history: {
-        type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
+        type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
         nodeId: string;
-        timestamp?: number | undefined;
-        payload?: Record<string, any> | undefined;
+        timestamp: number | null;
+        payload: Record<string, unknown> | null;
     }[];
-    layout?: UISpecNode | undefined;
-    error?: string | undefined;
+    error: string | null;
 }, {
+    layout: UISpecNodeInterface | null;
     loading: boolean;
     history: {
-        type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
+        type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
         nodeId: string;
-        timestamp?: number | undefined;
-        payload?: Record<string, any> | undefined;
+        timestamp: number | null;
+        payload: Record<string, unknown> | null;
     }[];
-    layout?: UISpecNode | undefined;
-    error?: string | undefined;
+    error: string | null;
 }>;
 type UIState = z.infer<typeof uiState>;
 /**
@@ -94,43 +91,43 @@ type UIState = z.infer<typeof uiState>;
 declare const plannerInput: z.ZodObject<{
     schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     goal: z.ZodString;
-    history: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        type: z.ZodEnum<["CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
+    history: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<["INIT", "CLICK", "CHANGE", "SUBMIT", "MOUSEOVER", "MOUSEOUT", "FOCUS", "BLUR"]>;
         nodeId: z.ZodString;
-        timestamp: z.ZodOptional<z.ZodNumber>;
-        payload: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        timestamp: z.ZodNullable<z.ZodNumber>;
+        payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     }, "strip", z.ZodTypeAny, {
-        type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
+        type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
         nodeId: string;
-        timestamp?: number | undefined;
-        payload?: Record<string, any> | undefined;
+        timestamp: number | null;
+        payload: Record<string, unknown> | null;
     }, {
-        type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
+        type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
         nodeId: string;
-        timestamp?: number | undefined;
-        payload?: Record<string, any> | undefined;
+        timestamp: number | null;
+        payload: Record<string, unknown> | null;
     }>, "many">>;
-    userContext: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    userContext: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
 }, "strip", z.ZodTypeAny, {
+    history: {
+        type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
+        nodeId: string;
+        timestamp: number | null;
+        payload: Record<string, unknown> | null;
+    }[] | null;
     schema: Record<string, unknown>;
     goal: string;
-    history?: {
-        type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
-        nodeId: string;
-        timestamp?: number | undefined;
-        payload?: Record<string, any> | undefined;
-    }[] | undefined;
-    userContext?: Record<string, unknown> | undefined;
+    userContext?: Record<string, unknown> | null | undefined;
 }, {
+    history: {
+        type: "INIT" | "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
+        nodeId: string;
+        timestamp: number | null;
+        payload: Record<string, unknown> | null;
+    }[] | null;
     schema: Record<string, unknown>;
     goal: string;
-    history?: {
-        type: "CLICK" | "CHANGE" | "SUBMIT" | "MOUSEOVER" | "MOUSEOUT" | "FOCUS" | "BLUR";
-        nodeId: string;
-        timestamp?: number | undefined;
-        payload?: Record<string, any> | undefined;
-    }[] | undefined;
-    userContext?: Record<string, unknown> | undefined;
+    userContext?: Record<string, unknown> | null | undefined;
 }>;
 type PlannerInput = z.infer<typeof plannerInput>;
 
@@ -146,7 +143,7 @@ interface DataContext {
  */
 declare enum ActionType {
     FULL_REFRESH = "FULL_REFRESH",// Generate a completely new UI
-    UPDATE_NODE = "UPDATE_NODE",// Update a specific node
+    UPDATE_NODE = "UPDATE_NODE",// Update a specific node, potentially with new children
     ADD_DROPDOWN = "ADD_DROPDOWN",// Add a dropdown to a specific node
     SHOW_DETAIL = "SHOW_DETAIL",// Show a detail view
     HIDE_DETAIL = "HIDE_DETAIL",// Hide a detail view
@@ -159,8 +156,8 @@ declare enum ActionType {
  */
 interface ActionRouteConfig {
     actionType: ActionType;
-    targetNodeId: string;
-    promptTemplate: string;
+    targetNodeId?: string;
+    promptTemplate?: string;
     contextKeys?: string[];
 }
 /**
@@ -190,7 +187,7 @@ declare class ActionRouter {
      * @param dataContext - Current data context
      * @returns Route resolution or null if no match
      */
-    resolveRoute(event: UIEvent, schema: Record<string, unknown>, layout: UISpecNode | undefined, dataContext: DataContext, goal: string, userContext?: Record<string, unknown>): RouteResolution | null;
+    resolveRoute(event: UIEvent, schema: Record<string, unknown>, layout: UISpecNode | null, dataContext: DataContext, goal: string, userContext?: Record<string, unknown>): RouteResolution | null;
     /**
      * Process a prompt template with variables
      * @param template - Template string with ${var} placeholders
@@ -201,6 +198,22 @@ declare class ActionRouter {
 }
 declare function createDefaultRouter(): ActionRouter;
 
+interface UseUIStateEngineOptions {
+    schema: Record<string, unknown>;
+    goal: string;
+    openaiApiKey?: string | undefined;
+    userContext?: Record<string, unknown> | undefined;
+    mockMode?: boolean | undefined;
+    planningConfig?: {
+        prefetchDepth?: number;
+        temperature?: number;
+        streaming?: boolean;
+    } | undefined;
+    router?: ActionRouter | undefined;
+    dataContext?: Record<string, unknown> | undefined;
+    enablePartialUpdates?: boolean | undefined;
+}
+
 interface EventHookOptions {
     preventDefault?: boolean;
     stopPropagation?: boolean;
@@ -229,7 +242,7 @@ type EventHook = (context: EventHookContext) => void | Promise<void>;
  * });
  * ```
  */
-declare function createEventHook(eventTypes: UIEventType[] | 'all', hook: EventHook, options?: EventHookOptions): EventHook;
+declare function createEventHook(eventTypes: UIEventType[] | "all", hook: EventHook, options?: EventHookOptions): EventHook;
 
 /**
  * System event types that represent the internal AutoUI lifecycle
@@ -370,7 +383,7 @@ declare const systemEvents: SystemEventManager;
  */
 declare function createSystemEvent<T extends SystemEventType>(type: T, data: Omit<Extract<AnySystemEvent, {
     type: T;
-}>, 'type' | 'timestamp'>): Extract<AnySystemEvent, {
+}>, "type" | "timestamp">): Extract<AnySystemEvent, {
     type: T;
 }>;
 
@@ -453,10 +466,10 @@ interface SchemaAdapter {
  * Schema adapter options union type
  */
 type SchemaAdapterOptions = {
-    type: 'drizzle';
+    type: "drizzle";
     options: DrizzleAdapterOptions$1;
 } | {
-    type: 'custom';
+    type: "custom";
     adapter: SchemaAdapter;
 };
 /**
@@ -467,16 +480,16 @@ declare function createSchemaAdapter(options: SchemaAdapterOptions): SchemaAdapt
 interface DrizzleAdapterOptions {
     schema: Record<string, unknown>;
 }
-interface AutoUIProps {
+interface AutoUIProps extends Omit<UseUIStateEngineOptions, "router" | "dataContext"> {
     schema: Record<string, unknown> | {
-        type: 'drizzle';
+        type: "drizzle";
         options: DrizzleAdapterOptions;
     } | {
-        type: 'custom';
+        type: "custom";
         adapter: SchemaAdapter;
     };
     goal: string;
-    componentAdapter?: 'shadcn';
+    componentAdapter?: "shadcn";
     userContext?: Record<string, unknown>;
     onEvent?: (evt: UIEvent) => void;
     eventHooks?: {
@@ -494,13 +507,13 @@ interface AutoUIProps {
         enableFormNavigation?: boolean;
     };
     integration?: {
-        mode?: 'standalone' | 'component';
+        mode?: "standalone" | "component";
         className?: string;
         style?: React.CSSProperties;
         id?: string;
     };
     scope?: {
-        type?: 'form' | 'list' | 'detail' | 'dashboard' | 'full-page' | 'card';
+        type?: "form" | "list" | "detail" | "dashboard" | "full-page" | "card";
         focus?: string;
     };
     debugMode?: boolean;
@@ -511,6 +524,7 @@ interface AutoUIProps {
         temperature?: number;
         streaming?: boolean;
     };
+    openaiApiKey?: string;
 }
 /**
  * AutoUI - Main component for generating goal-oriented UIs
@@ -533,14 +547,42 @@ interface AutoUIProps {
 declare const AutoUI: React.FC<AutoUIProps>;
 
 /**
- * Example function to generate text using the AI SDK
- *
- * Note: You need to set OPENAI_API_KEY environment variable
- * or use another supported provider
+ * AI Utilities for AutoUI React
+ * Provides AI-powered UI generation functionality
+ */
+/**
+ * Generates a component using AI
+ */
+declare const generateComponent: (prompt: string) => Promise<string>;
+/**
+ * Generates a UI description using AI
+ */
+declare const generateUIDescription: (prompt: string) => Promise<string>;
+/**
+ * Generates a UI component using AI
  */
-declare function generateComponent(schema: any): Promise<string>;
+declare const generateUIComponent: (prompt: string) => Promise<string>;
 
-declare function generateUIDescription(schema: any): Promise<string>;
-declare function generateUIComponent(schema: any): Promise<string>;
+interface UsePlannerOptions {
+    goal: string;
+    schema: Record<string, unknown>;
+    openaiApiKey?: string;
+    userContext?: Record<string, unknown>;
+    router?: ActionRouter;
+    modelProvider?: unknown;
+    initialLayout?: UISpecNode;
+    mockMode?: boolean;
+}
+interface UsePlannerResult {
+    layout: UISpecNode | undefined;
+    loading: boolean;
+    error: Error | null;
+    handleEvent: (event: UIEvent) => Promise<void>;
+    generateInitialLayout: () => Promise<void>;
+}
+/**
+ * React hook for utilizing the AI planner functionality
+ */
+declare function usePlanner(options: UsePlannerOptions): UsePlannerResult;
 
-export { ActionRouteConfig, ActionRouter, ActionType, AnySystemEvent, AutoUI, AutoUIProps, DrizzleAdapter, DrizzleAdapterOptions$1 as DrizzleAdapterOptions, EventHook, EventHookContext, EventHookOptions, PlannerInput, SchemaAdapter, SchemaAdapterOptions, SystemEventHook, SystemEventType, UIEvent, UIEventType, UISpecNode, UIState, createDefaultRouter, createEventHook, createSchemaAdapter, createSystemEvent, generateComponent, generateUIComponent, generateUIDescription, systemEvents, uiEvent, uiEventType, uiSpecNode };
+export { ActionRouteConfig, ActionRouter, ActionType, AnySystemEvent, AutoUI, AutoUIProps, DrizzleAdapter, DrizzleAdapterOptions$1 as DrizzleAdapterOptions, EventHook, EventHookContext, EventHookOptions, PlannerInput, SchemaAdapter, SchemaAdapterOptions, SystemEventHook, SystemEventType, UIEvent, UIEventType, UISpecNode, UIState, createDefaultRouter, createEventHook, createSchemaAdapter, createSystemEvent, generateComponent, generateUIComponent, generateUIDescription, systemEvents, uiEvent, uiEventType, uiSpecNode, usePlanner };