@icanbwell/baileyai-chat-ui 1.0.17 → 1.0.18

package/README.md

@@ -181,6 +181,15 @@ const history = useBaileyConversations({ client }); // conversations, loadMore,
   state (the partial text stays visible, `onAssistantMessageComplete` does not fire). A custom
   transport should set `interrupted: true` in that case, and must resolve `streamChat` only when the
   response body has closed.
+  When no response arrives (`fetch` rejects, or `getHeaders` throws) `streamChat` still resolves with
+  `status: undefined` and the fixed `errorMessage: 'Request failed'`, and now also sets `errorKind: 'network'`
+  so a host can choose its own copy. `errorCause` carries the error `fetch` threw; it is not set when
+  `getHeaders` threw (it can carry auth detail). Both fields are optional and additive, and
+  `useBaileyChat`'s copy is unchanged. A caller abort and the idle timeout still reject with the abort
+  reason (`TimeoutError` for the idle timeout), and a mid-stream drop still resolves `interrupted: true`
+  without `errorKind`. Browsers do not distinguish CORS, DNS or offline, so do not show `errorCause.message`
+  to users without review and do not log the request URL.
+  A multi-byte character cut off at the end of the stream is flushed as a final `onChunk`.
 - Every call has a timeout (`requestTimeoutMs`, default 30s; the stream uses an idle timeout,
   `idleTimeoutMs`). A failed best-effort cleanup is reported through `onCleanupError` and never thrown.
 - **Nothing is logged** by the client or the hooks, and request/response bodies are never placed in
@@ -218,13 +227,23 @@ const history = useBaileyConversations({ client }); // conversations, loadMore,
   (`X-Conversation-Id`) or one you seed. Without `sub` the stored id is held unvalidated; after a
   shared-browser user switch the server rejects the foreign id and the library adopts the
   server-reported one, so the worst case is a lost first-turn context.
-- **Lost server context is surfaced.** When a turn that sent a held id comes back with no id, or a
-  different one, the server did not continue that conversation (persistence off, an id it does not
-  know, or history it could not load). The hook drops the held id and its stored value, sets
-  `contextLost: true` until the next turn, and calls `onContextLoss({ sentId, reportedId })`; the next
-  turn sends the full transcript. A turn that fails outright (4xx/5xx) is reported as an error as
-  before. A history load that fails while the server still reports the same id is not detectable
-  yet (it needs a server signal).
+- **Lost server context is surfaced.** A turn that sent a held id signals context loss when the
+  server did not continue that conversation, for one of two reasons. `reason: 'id'`: it came back
+  with no id, or a different one (persistence off, an id it does not know). `reason: 'history'`: it
+  reported the same id but `conversation.history_status` on `response.created` / `response.completed`
+  (the last one the turn carries wins) is `'failed'` or `'empty'`, meaning the stored history was not
+  loaded. In both cases the hook drops the held id and its stored value, clears the paging state, sets
+  `contextLost: true` until the next turn, and calls `onContextLoss({ sentId, reportedId, reason })`
+  (the library always sets `reason`, though it is optional in the type; `reportedId` is absent when the server reported none); the next turn sends
+  the full transcript. `'loaded'`, an absent field and any unrecognised value change nothing, and a
+  first turn (no id sent) never signals loss. A host-seeded id whose turn reports `'empty'` also
+  signals loss: a seeded id is only valid for resuming a stored conversation. The backend also sends
+  `history_loaded` (number of prior messages loaded); the library does not read it, it is for host
+  diagnostics. A turn that fails outright (4xx/5xx) is reported as an error as before. Older backends
+  do not send `history_status`, so for them only `reason: 'id'` can occur and a history load that
+  fails while the server reports the same id is still not detectable. Residual risk until the backend
+  change (baileyai PR #554, language-model-common PR #136) is deployed and released: the `'history'`
+  path is inert.
 - **Persistence off on the server.** Stable conversation ids only help where the server persists
   conversations (the conversation routes return 503 when persistence is off). The library does not
   probe for this: enable stable ids (pass a `client` and keep the default storage) only in environments