@runtypelabs/persona 3.35.0 → 3.36.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runtypelabs/persona",
-  "version": "3.35.0",
+  "version": "3.36.0",
   "description": "Themeable, pluggable streaming agent widget for websites, in plain JS with support for voice input and reasoning / tool output.",
   "type": "module",
   "main": "dist/index.cjs",

package/src/client.test.ts

@@ -2,6 +2,7 @@ import { describe, it, expect, beforeEach, vi } from 'vitest';
 import { AgentWidgetClient, preferFinalStructuredContent } from './client';
 import { AgentWidgetEvent, AgentWidgetMessage } from './types';
 import { createJsonStreamParser } from './utils/formatting';
+import { VERSION } from './version';
 
 describe('AgentWidgetClient - Empty Message Filtering', () => {
   let client: AgentWidgetClient;
@@ -4176,3 +4177,46 @@ describe('AgentWidgetClient - Feedback request builder', () => {
     expect(feedbackBodies[0].rating).toBe(5);
   });
 });
+
+describe('AgentWidgetClient - version header', () => {
+  function captureHeaders() {
+    const headers: Array<Record<string, string>> = [];
+    global.fetch = vi.fn().mockImplementation(async (_url: string, options: { headers: Record<string, string> }) => {
+      headers.push(options.headers);
+      const encoder = new TextEncoder();
+      const stream = new ReadableStream({
+        start(c) {
+          c.enqueue(encoder.encode('data: {"type":"flow_complete","success":true}\n\n'));
+          c.close();
+        },
+      });
+      return { ok: true, body: stream };
+    });
+    return headers;
+  }
+
+  const msg = () => ({
+    messages: [{ id: 'u1', role: 'user' as const, content: 'hi', createdAt: '2025-01-01T00:00:00.000Z' }],
+  });
+
+  it('broadcasts X-Persona-Version on the dispatch request', async () => {
+    const headers = captureHeaders();
+    const client = new AgentWidgetClient({ apiUrl: 'http://localhost:8000' });
+
+    await client.dispatch(msg(), () => undefined);
+
+    expect(headers[0]['X-Persona-Version']).toBe(VERSION);
+  });
+
+  it('lets an explicit config header override the version', async () => {
+    const headers = captureHeaders();
+    const client = new AgentWidgetClient({
+      apiUrl: 'http://localhost:8000',
+      headers: { 'X-Persona-Version': 'override' },
+    });
+
+    await client.dispatch(msg(), () => undefined);
+
+    expect(headers[0]['X-Persona-Version']).toBe('override');
+  });
+});

package/src/client.ts

@@ -33,6 +33,7 @@ import {
   createXmlParser
 } from "./utils/formatting";
 import { SequenceReorderBuffer } from "./utils/sequence-buffer";
+import { VERSION } from "./version";
 // artifactsSidebarEnabled is used in ui.ts to gate the sidebar pane rendering;
 // artifact events are always processed here regardless of config.
 
@@ -188,6 +189,7 @@ export class AgentWidgetClient {
     this.apiUrl = config.apiUrl ?? DEFAULT_ENDPOINT;
     this.headers = {
       "Content-Type": "application/json",
+      "X-Persona-Version": VERSION,
       ...config.headers
     };
     this.debug = Boolean(config.debug);
@@ -355,6 +357,7 @@ export class AgentWidgetClient {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
+        'X-Persona-Version': VERSION,
       },
       body: JSON.stringify(requestBody),
     });
@@ -495,6 +498,7 @@ export class AgentWidgetClient {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
+        'X-Persona-Version': VERSION,
       },
       body: JSON.stringify(requestBody),
     });
@@ -682,6 +686,7 @@ export class AgentWidgetClient {
           method: 'POST',
           headers: {
             'Content-Type': 'application/json',
+            'X-Persona-Version': VERSION,
           },
           body: JSON.stringify(chatRequest),
           signal: controller.signal,