@epicbagel/saas-kit 1.20.0 → 1.21.0

package/README.md

@@ -60,6 +60,45 @@ does not import a voice provider. Stop and release audio tracks before setting
 }} />
 ```
 
+## Workflow assistant
+
+`primitives/workflow-assistant` exports `WorkflowAssistant`, a controlled
+conversation panel beside a working list. It uses `ChatThread`, `ChatInput`
+and the same `voiceSession` contract as Chat. The panel is non-modal: it
+leaves the page interactive, does not trap focus, and keeps the current
+`context` visible in its header. On short screens the panel can scroll while
+the header stays reachable.
+
+Opening the launcher starts an inactive voice session. Minimizing preserves
+the session, transcript and host-owned draft; the minimized launcher reports
+the current voice state and keeps End available. `disabled`, `pending` or
+`voiceSession.disabled` prevent a new call but never prevent reopening or
+ending an active call. Activation moves keyboard focus to the panel heading;
+minimizing returns it to the launcher. A host-driven open or scope update
+does not move focus away from the page.
+
+```tsx
+import { WorkflowAssistant } from "@epicbagel/saas-kit/primitives/workflow-assistant";
+
+<WorkflowAssistant
+  open={open} onOpenChange={setOpen}
+  expanded={expanded} onExpandedChange={setExpanded}
+  title="Voice review" context={`Current list · ${items.length} items`}
+  messages={messages} value={draft} onChange={setDraft} onSend={sendRequest}
+  pending={pending} error={error}
+  voiceSession={{ state, muted, onMutedChange: setMuted,
+    onStart: startVoice, onEnd: endVoice }}
+/>
+```
+
+The host owns authorization, list scope, messages, draft clearing, audio and
+connection cleanup. When scope changes, the host must cancel or replace any
+session that still refers to the previous list. Omit `voiceSession` for a
+text-only conversation, omit `onExpandedChange` to hide the expand control,
+and use `besideCornerAction` to leave space for an existing corner action.
+Override panel actions with `labels`; minimized session status and End also
+honor `voiceSession.labels`.
+
 ## API dictation
 
 Wrap the application in `DictationProvider` to use an authenticated transcription