@mantir/headless-view 0.1.8 → 0.1.10

package/README.md

@@ -35,6 +35,9 @@ function App() {
       <HeadlessExecutor 
         workflow={workflow} 
         apiEndpoint="/api/execute" 
+        onResult={(result) => console.log('Final workflow result:', result)}
+        onDone={() => console.log('Execution finished')}
+        initialInput="Programmatic input value"
       />
     </div>
   );
@@ -53,10 +56,14 @@ function CustomExecutor({ workflow }) {
     messages, 
     isRunning, 
     pendingInterrupt, 
-    restart, 
+    execute, // Programmatic trigger
     resume 
   } = useWorkflowExecution({
-    apiEndpoint: "/api/execute"
+    apiEndpoint: "/api/execute",
+    workflow: workflow, // Pass to enable initialInput auto-start
+    initialInput: "Hello world",
+    onResult: (data) => console.log(data),
+    onDone: () => console.log("Done")
   });
 
   return (
@@ -67,6 +74,17 @@ 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.
+
 ## Configuration for Tailwind CSS Projects
 
 If your project already uses Tailwind CSS (v3 or v4) and you want to use your project's theme and styles, you should add the package to your Tailwind configuration instead of importing the CSS file.

package/dist/index.d.mts

@@ -154,6 +154,7 @@ interface HeadlessExecutorProps {
     apiEndpoint?: string;
     className?: string;
     onResult?: (result: any) => void;
+    onDone?: () => void;
     initialInput?: string;
 }
 declare const HeadlessExecutor: React.FC<HeadlessExecutorProps>;

package/dist/index.d.ts

@@ -154,6 +154,7 @@ interface HeadlessExecutorProps {
     apiEndpoint?: string;
     className?: string;
     onResult?: (result: any) => void;
+    onDone?: () => void;
     initialInput?: string;
 }
 declare const HeadlessExecutor: React.FC<HeadlessExecutorProps>;