@arbidocs/react 0.4.2 → 0.4.4

package/README.md

@@ -93,6 +93,8 @@ That's it — three hooks and you have a streaming RAG chat.
 |------|---------|-------------------|
 | `useArbi()` | `Arbi` instance | Always |
 | `useWorkspaces()` | User's workspaces | Logged in |
+| `useArbiShellWorkspaces(options)` | Workspaces as shell/gallery view models, the active one, `open(workspace)` (select, then `onOpened`) | Logged in |
+| `useShellWorkspaces(options)` | Same, over a list and `select` you supply (no provider needed) | Always |
 | `useDocuments(workspaceId)` | Workspace documents | Workspace selected |
 | `useConversations(workspaceId)` | Workspace conversations | Workspace selected |
 | `useTags(workspaceId)` | Workspace tags | Workspace selected |
@@ -124,3 +126,25 @@ queryClient.invalidateQueries({ queryKey: arbiQueryKeys.documents(workspaceId) }
 ## Peer dependencies
 
 - `react` >= 18
+
+
+## Tasks, agents, skills, contacts and credits
+
+Hooks for an "AI workforce" and a messages screen. Writes invalidate through `arbiQueryKeys`, so
+`useTasks`, `useAgents`, `useConfigs` and `useDirectMessages` refresh by themselves.
+
+```tsx
+const create = useCreateTask()          // mutateAsync(CreateTaskRequest) -> TaskResponse
+const run = useRunTask()                // approves a run parked for access (temporary grant), then runs
+const runs = useTaskRuns(taskId)        // polls while a run is in flight
+const save = useSaveAgentConfig()       // { agentExtId, sections: { Agents: { PERSONA, ... } } }
+const grant = useGrantAgentAccess()     // { agentExtId, workspaceId, mode?: { kind: 'standing' | 'temporary' } }
+const contacts = usePendingContacts()   // + useAddContacts(), useRemoveContacts()
+```
+
+Form-to-request mappings (`taskComposerToCreateRequest`, `composePersona`, ...) are in
+`@arbidocs/blocks/agents`. Usage is reported in **credits**, not dollars: use
+`formatCredits(n)`, `creditsToUsd(n)` and the `metered` flag on `useProjectUsage` /
+`useProjectsUsage` (`false` = this deployment does not record usage). `DirectMessages` takes
+`listHeader`, `listLead`, `startByEmail` and `hideOwnContact`. See `docs/design/blocks-package.md`
+("Hooks and mappings a host should not rewrite").