@filigran/chatbot 3.9.1 → 3.11.0

package/README.md

@@ -71,7 +71,9 @@ import { ChatPanel } from '@filigran/chatbot';
 | `apiBaseUrl`        | `string`                                  | **required** | Base URL for chat API endpoints                                  |
 | `user`              | `{ firstName: string }`                   | **required** | Current user info                                                |
 | `topOffset`         | `number`                                  | `0`          | Top offset in pixels (for sidebar/fullscreen with fixed headers) |
-| `agentDashboardUrl` | `string`                                  | —            | URL for "Browse agents" / "Create agent" links                   |
+| `agentDashboardUrl` | `string`                                  | —            | XTM One URL for the "Browse agents" / "Create agent" links and the waiting panel's "Play Space Invaders in XTM One" link (`{url}/chat?arcade=play`, http(s) only) |
+| `miniGameEnabled`   | `boolean`                                 | `true`       | Show the waiting panel during longer waits: rotating messages and the invitation to play XTM One's arcade (the package ships no game of its own) |
+| `onPlayWaitingGame` | `() => void`                              | —            | Open the arcade in place instead of linking to XTM One, for a host that runs it itself (the XTM One floating assistant) |
 | `t`                 | `(key: string) => string`                 | identity     | Translation function for i18n                                    |
 | `accentColor`       | `string`                                  | `'#7b5cff'`  | Primary accent color (hex)                                       |
 | `logoIcon`          | `React.ReactNode`                         | default icon | Custom logo/icon for the assistant                               |
@@ -86,6 +88,10 @@ import { ChatPanel } from '@filigran/chatbot';
 | `contextUsageEnabled` | `boolean`                               | `true`       | Show how full the model's context window is for the current conversation (ring + percentage in the composer toolbar). Data-driven, so it stays absent until the backend reports occupancy — see [Context usage](#context-usage). |
 | `composerToolbar`   | `React.ReactNode`                         | —            | Extra controls appended to the composer toolbar. The escape hatch for host-specific affordances (XTM One's session-tool picker) — the package never learns what they are. Pass nothing and the toolbar simply has none. |
 
+Plain-data props (`requestHeaders`, `apiEndpoints`, `pageContext`, `promptSuggestions`) are compared by content and callback props are called
+through a stable wrapper, so building them inline is fine. `t` and `logoIcon` are used as given: keep them stable (`useCallback` / `useMemo`),
+or every render of the host re-renders every message in the thread.
+
 #### Resizable Sidebar Example
 
 ```tsx
@@ -708,19 +714,19 @@ Every key the package can ask for, grouped by where it appears:
 - `'the agent'`
 - `'{tool} (+{count} more)…'`
 
-**Waiting mini-game**
+**Waiting panel**
 
 - `'Almost there'`
 - `'Analyzing the details'`
 - `'Connecting the dots'`
 - `'Consulting the sources'`
 - `'Crunching the data'`
+- `'Play Space Invaders'`
+- `'Play Space Invaders in XTM One'`
 - `'Polishing the answer'`
 - `'Putting it together'`
 - `'Reticulating splines'`
 - `'Thinking it through'`
-- `'Turn off the waiting mini-game'`
-- `'Turn on the waiting mini-game'`
 - `'Wrapping things up'`
 
 **Reasoning details**
@@ -945,6 +951,11 @@ returned byte-identical.
 - `remark-breaks` >= 4
 - `remark-gfm` >= 4
 
+## Dependencies
+
+- `unified` ^11 and `remark-parse` ^11 — the ranges react-markdown 10 depends on, so a host resolves them to the copies it already has. The panel
+  uses them to find the top-level blocks of a streaming answer, and re-renders only the blocks that can still change.
+
 ---
 
 ## Development
@@ -962,6 +973,12 @@ To build:
 yarn build
 ```
 
+To run the unit tests (Node's built-in test runner, which runs TypeScript natively from Node 22.18 / 23.6):
+
+```bash
+yarn test
+```
+
 To publish:
 
 ```bash

package/dist/index.d.ts

@@ -245,6 +245,11 @@ interface ChatPanelProps {
     apiBaseUrl: string;
     /** Custom API endpoint configuration. */
     apiEndpoints?: ApiEndpoints;
+    /**
+     * The XTM One URL: the header's "Browse agents" / "Create agent" links, and
+     * the waiting panel's invitation to play the arcade there
+     * (`{agentDashboardUrl}/chat?arcade=play`). Only an http(s) URL is linked.
+     */
     agentDashboardUrl?: string;
     user: {
         firstName: string;
@@ -314,12 +319,17 @@ interface ChatPanelProps {
      */
     backendType?: BackendType;
     /**
-     * Show the waiting experience during longer waits: dynamic rotating status
-     * messages plus an optional Space Invader mini-game that shoots the message
-     * letters away one by one. Users can still toggle the game off per browser
-     * from the panel; this prop is a host-level master switch. Default: true.
+     * Show the waiting panel during longer waits: rotating status messages and
+     * an invitation to play XTM One's Space Invaders arcade, in a new tab
+     * through `agentDashboardUrl` or in place through `onPlayWaitingGame`. The
+     * package ships no game of its own. Host-level master switch. Default: true.
      */
     miniGameEnabled?: boolean;
+    /**
+     * Opens the arcade in place instead of linking to XTM One, for a host that
+     * runs it itself (the XTM One floating assistant). Wins over the link.
+     */
+    onPlayWaitingGame?: () => void;
     /**
      * Notify the user when a long-running turn finishes while they are not
      * watching the chat — away (tab hidden / another window) via a document-title