@m6d/cortex-angular 0.14.0 → 0.15.0

package/README.md

@@ -25,7 +25,7 @@ export class MyComponent {
 The widget attaches its own stylesheet; add `@m6d/cortex-angular/theme.css` to
 your styles to override its tokens in one place (see Theming).
 
-`baseUrl` is the agent's URL: the engine's public origin (`ENGINE_PUBLIC_URL`) plus `/agents/<agent slug>`. Add the page's origin to `ENGINE_CORS_ORIGINS`, or proxy the engine under your own origin as the samples do. The WebSocket URL is `baseUrl` plus `/ws`; set `wsUrl` only to override it, and point it at that same agent-scoped path. The bearer is the end user's token, which Cortex verifies the way the agent's auth says: a JWKS, a shared secret, the agent's server, or nobody for an anonymous agent.
+`baseUrl` is the agent's URL: the engine's public origin (`ENGINE_PUBLIC_URL`) plus `/agents/<agent slug>`. Add the page's origin to `ENGINE_CORS_ORIGINS`, or proxy the engine under your own origin as the samples do. The WebSocket URL is `baseUrl` plus `/ws`; set `wsUrl` only to override it, and point it at that same agent-scoped path. The bearer is the end user's token, which Cortex verifies the way the agent's auth says: a JWKS, a shared secret, or the agent's server. For an anonymous agent, leave `getHeaders` out: the widget signs in as a visitor, and Cortex gives the browser an ID it keeps in local storage. When the agent checks visitors with reCAPTCHA Enterprise, the widget loads Google's script with the agent's site key and runs the check invisibly. The widget hides the badge Google draws for the agent's site key, and Google's terms then ask your page to show its reCAPTCHA attribution. A badge your page draws for its own key stays.
 
 No root-level providers are needed. Each widget is self-contained, so one page can render several widgets with different configs.
 
@@ -35,9 +35,9 @@ No root-level providers are needed. Each widget is self-contained, so one page c
 
 | Property                   | Type                                              | Description                                                                     |
 | -------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------- |
-| `locale`                   | `'en' \| 'ar'`                                    | Active locale (default: `'en'`)                                                 |
+| `locale`                   | `'en' \| 'ar'`                                    | Active locale; the widget lays out in its direction (default: `'en'`)           |
 | `transport.baseUrl`        | `string \| () => string`                          | The agent's URL, `<engine origin>/agents/<slug>`                                |
-| `transport.getHeaders`     | `() => Headers \| Promise<Headers>`               | Request headers provider; `Headers` is `Record<string, string>`                 |
+| `transport.getHeaders?`    | `() => Headers \| Promise<Headers>`               | Request headers provider; `Headers` is `Record<string, string>`                 |
 | `wsUrl`                    | `string \| false`                                 | WebSocket URL override; `false` disables the socket (optional)                  |
 | `viewMode`                 | `'helper' \| 'full'`                              | Compact panel or full layout with a sidebar (default: `'helper'`)               |
 | `theme`                    | `'light' \| 'dark' \| 'system'`                   | Color scheme (default: `'light'`)                                               |
@@ -206,7 +206,10 @@ That is how a tool of type `client` ("Answered by your app" in the console)
 works: return its output from `hooks.onToolCall` for that tool name, or draw it
 with a tool component. A `hooks.onToolCall` must return `undefined` for tool
 names it does not own, since answering an unknown pending call would settle an
-embedded flow before the user completes it.
+embedded flow before the user completes it. A tool component draws a pending
+call only once Cortex confirms the caller may send; until then, and always for
+an operator inspecting a thread, the call shows as the widget's own line, and
+the component draws it once it settles.
 
 ## Media blocks
 
@@ -240,8 +243,10 @@ well:
 ```
 
 `mediaRenderers` swaps a renderer or adds a fence tag of your own. A renderer
-draws a closed fence's source into the host element and returns its teardown;
-its context carries the widget's color `scheme` and `locale`:
+(`MediaRenderer`) draws a closed fence's source into the host element and
+returns its teardown; its context (`MediaRenderContext`) carries the widget's
+color `scheme` and `locale`. The field's map of tags to renderers is
+`MediaRenderers`. The package exports all three types:
 
 ```ts
 mediaRenderers: {
@@ -257,4 +262,4 @@ mediaRenderers: {
 ## Requirements
 
 - Angular 21.2 or 22
-- Peer dependencies: `@tanstack/ai`, `@tanstack/ai-angular`, `@tanstack/ai-client`, `marked`, `dompurify`, `highlight.js`, `rxjs`, plus the lazily loaded `mermaid`, `vega`, `vega-lite`, `vega-embed`, `leaflet`
+- Peer dependencies: `@tanstack/ai`, `@tanstack/ai-client`, `marked`, `dompurify`, `highlight.js`, plus the lazily loaded `mermaid`, `vega`, `vega-lite`, `vega-embed`, `leaflet`