@mantir/headless-view 0.1.10 → 0.1.13

package/README.md

@@ -76,14 +76,14 @@ function CustomExecutor({ workflow }) {
 
 ## Props / Hook Options
 
-- `apiEndpoint`: (string) The URL to post workflow execution requests to.
-- `workflow`: (Workflow) The JSON workflow definition.
-- `initialInput`: (string, optional) If provided, the workflow will automatically start on mount using this value.
-- `onResult`: (callback, optional) Called when the workflow produces a final JSON result.
-- `onDone`: (callback, optional) Called when the execution stream finishes completely.
-- `onMessage`: (callback, optional) Called for every message/trace event.
-- `onInterrupt`: (callback, optional) Called when the workflow requires user input.
-- `onError`: (callback, optional) Called if a network or execution error occurs.
+- **apiEndpoint**: `(string)` The URL to post workflow execution requests to.
+- **workflow**: `(Workflow, optional)` The JSON workflow definition. When provided with `initialInput`, enables auto-start.
+- **initialInput**: `(string, optional)` If provided, the workflow will automatically start on mount using this value.
+- **onResult**: `(callback, optional)` Called when the workflow produces a final JSON result.
+- **onDone**: `(callback, optional)` Called when the execution stream finishes completely.
+- **onMessage**: `(callback, optional)` Called for every message/trace event.
+- **onInterrupt**: `(callback, optional)` Called when the workflow requires user input.
+- **onError**: `(callback, optional)` Called if a network or execution error occurs.
 
 ## Configuration for Tailwind CSS Projects
 
@@ -111,3 +111,30 @@ module.exports = {
 
 - `react` >= 18
 - `react-dom` >= 18
+
+## API Reference
+
+### `useWorkflowExecution` Hook
+
+Returns an object with:
+
+- **messages**: `Message[]` - Array of all messages from the workflow execution
+- **isRunning**: `boolean` - Whether the workflow is currently executing
+- **error**: `Error | null` - Any error that occurred during execution
+- **pendingInterrupt**: `any | null` - Details of any pending user input request
+- **currentThreadId**: `string | undefined` - The current execution thread ID
+- **execute**: `(workflow: Workflow, input: string) => Promise<void>` - Programmatically start a workflow
+- **restart**: `(workflow: Workflow, input: string) => Promise<void>` - Restart the workflow from the beginning
+- **resume**: `(workflow: Workflow, value: any) => Promise<void>` - Resume after an interrupt
+- **runExecution**: Internal execution function (advanced use only)
+
+### Message Type
+
+```typescript
+interface Message {
+  id: string;
+  role: "user" | "assistant" | "system" | "trace";
+  content: string;
+  meta?: any;
+}
+```

package/dist/index.d.mts

@@ -153,9 +153,12 @@ interface HeadlessExecutorProps {
     workflow: Workflow;
     apiEndpoint?: string;
     className?: string;
+    initialInput?: string;
     onResult?: (result: any) => void;
     onDone?: () => void;
-    initialInput?: string;
+    onMessage?: (message: any) => void;
+    onInterrupt?: (interrupt: any) => void;
+    onError?: (error: Error) => void;
 }
 declare const HeadlessExecutor: React.FC<HeadlessExecutorProps>;
 
@@ -184,23 +187,23 @@ interface Message {
 }
 interface UseWorkflowExecutionOptions {
     apiEndpoint: string;
+    workflow?: Workflow;
+    initialInput?: string;
     onMessage?: (message: Message) => void;
     onInterrupt?: (payload: any) => void;
     onError?: (error: Error) => void;
     onDone?: () => void;
     onResult?: (result: any) => void;
-    initialInput?: string;
-    workflow?: Workflow;
 }
-declare function useWorkflowExecution({ apiEndpoint, onMessage, onInterrupt, onError, onDone, onResult, initialInput, workflow: hookWorkflow }: UseWorkflowExecutionOptions): {
+declare function useWorkflowExecution({ apiEndpoint, workflow, initialInput, onMessage, onInterrupt, onError, onDone, onResult }: UseWorkflowExecutionOptions): {
     messages: Message[];
     isRunning: boolean;
     error: Error | null;
     currentThreadId: string | undefined;
     pendingInterrupt: any;
+    execute: (workflow: Workflow, userInput: string) => Promise<void>;
     runExecution: (workflow: Workflow, userInput: string, existingThreadId?: string, resumeValue?: any) => Promise<void>;
     restart: (workflow: Workflow, userInput: string) => Promise<void>;
-    execute: (workflow: Workflow, userInput: string) => Promise<void>;
     resume: (workflow: Workflow, resumeValue: any) => Promise<void>;
 };
 

package/dist/index.d.ts

@@ -153,9 +153,12 @@ interface HeadlessExecutorProps {
     workflow: Workflow;
     apiEndpoint?: string;
     className?: string;
+    initialInput?: string;
     onResult?: (result: any) => void;
     onDone?: () => void;
-    initialInput?: string;
+    onMessage?: (message: any) => void;
+    onInterrupt?: (interrupt: any) => void;
+    onError?: (error: Error) => void;
 }
 declare const HeadlessExecutor: React.FC<HeadlessExecutorProps>;
 
@@ -184,23 +187,23 @@ interface Message {
 }
 interface UseWorkflowExecutionOptions {
     apiEndpoint: string;
+    workflow?: Workflow;
+    initialInput?: string;
     onMessage?: (message: Message) => void;
     onInterrupt?: (payload: any) => void;
     onError?: (error: Error) => void;
     onDone?: () => void;
     onResult?: (result: any) => void;
-    initialInput?: string;
-    workflow?: Workflow;
 }
-declare function useWorkflowExecution({ apiEndpoint, onMessage, onInterrupt, onError, onDone, onResult, initialInput, workflow: hookWorkflow }: UseWorkflowExecutionOptions): {
+declare function useWorkflowExecution({ apiEndpoint, workflow, initialInput, onMessage, onInterrupt, onError, onDone, onResult }: UseWorkflowExecutionOptions): {
     messages: Message[];
     isRunning: boolean;
     error: Error | null;
     currentThreadId: string | undefined;
     pendingInterrupt: any;
+    execute: (workflow: Workflow, userInput: string) => Promise<void>;
     runExecution: (workflow: Workflow, userInput: string, existingThreadId?: string, resumeValue?: any) => Promise<void>;
     restart: (workflow: Workflow, userInput: string) => Promise<void>;
-    execute: (workflow: Workflow, userInput: string) => Promise<void>;
     resume: (workflow: Workflow, resumeValue: any) => Promise<void>;
 };