@athenaintel/react 0.11.2 → 0.12.0

package/README.md

@@ -56,19 +56,32 @@ If `config.appUrl` is omitted, the provider resolves it from the parent bridge o
 
 Use `trustedParentOrigins` when the SDK runs inside an iframe on a private-cloud or custom parent domain and you want to explicitly allow postMessage auth/config from that parent.
 
-## Statewire Transport (opt-in)
+## Statewire Transport (default as of 0.12.0)
 
-The default chat transport is the legacy Iris `/api/chat` stream. Pass
-`transport: 'statewire'` to attach to the deep-agent statewire sync host
-instead — the thread is hosted server-side and replicated live, so history,
-reconnect, and run scheduling come from the server snapshot:
+Statewire is the default chat transport: the SDK attaches to the deep-agent
+statewire sync host, so the thread is hosted server-side and replicated live —
+history, reconnect, run scheduling, mid-run queueing, HITL approvals, and
+client tools (for recognized SDK hosts, e.g. computer-asset `app_id`s) all
+come from the server snapshot. Pass `transport: 'legacy'` to opt a deployment
+back onto the legacy Iris `/api/chat` stream:
 
 ```tsx
-<AthenaProvider config={{ environment: 'staging', transport: 'statewire' }}>
+<AthenaProvider config={{ environment: 'staging', transport: 'legacy' }}>
   <AthenaChat />
 </AthenaProvider>
 ```
 
+**Migrating from ≤0.11.x (legacy default):**
+
+- Threads are transport-scoped: conversations created on the legacy transport
+  are read-only from statewire (and vice versa). Users keep their history but
+  continue in new threads.
+- The statewire runtime applies the deep-agent model default when no `model`
+  prop is set; pin `model` explicitly if you depended on the legacy default.
+- The `agent` prop's legacy agent names are not honored on statewire; use
+  `collab_agent:<id>` refs (with `transport: 'statewire'` semantics) or the
+  default agent.
+
 The sync endpoint defaults to the effective `apiUrl` host + `/v2/threads`
 (e.g. staging resolves to `https://iris.stg.athenaintel.com/v2/threads`, the
 same statewire base the mobile app and Chrome extension ship); pass