@wix/legends-platform-sdk 1.14.0 → 1.15.0

package/README.md

@@ -109,7 +109,7 @@ const { status, join, leave } = useConversation({
 |--------|------|-------------|
 | `status` | `'pending' \| 'created' \| 'destroying' \| 'destroyed' \| 'exceeded' \| 'inactivity-timeout' \| 'voice-not-found' \| 'initialization-error' \| 'error'` | Current conversation state |
 | `join()` | `() => void` | Start the conversation |
-| `leave()` | `(reason?) => void` | End the conversation |
+| `leave()` | `(destroy?: boolean) => Promise<void>` | End the conversation |
 
 #### `useMicrophone()`
 
@@ -153,29 +153,60 @@ const status = useConversationStatus();
 const { elapsed, remaining } = useConversationTimer();
 ```
 
-#### `useTools(registry)`
+#### `useTools()`
 
-Register custom tool handlers for function calling.
+Read the list of tool calls executed by the SDK. To register tool handlers, pass a `tools` registry to `LegendsPlatform`.
 
 ```tsx
-import { useTools } from '@wix/legends-platform-sdk';
-
-const tools = useTools({
-  get_weather: {
-    handler: async ({ city }) => {
-      const data = await fetchWeather(city);
-      return { temperature: data.temp };
-    },
+import { LegendsPlatform, useTools, type ToolsRegistry } from '@wix/legends-platform-sdk';
+
+const tools: ToolsRegistry = {
+  get_weather: async ({ city }) => {
+    const data = await fetchWeather(city as string);
+    return { temperature: data.temp };
   },
-});
+};
+
+function ToolLog() {
+  const calls = useTools(); // returns ToolCallSnapshot[]
+  return <pre>{JSON.stringify(calls, null, 2)}</pre>;
+}
 
 return (
   <LegendsPlatform ... tools={tools}>
-    ...
+    <ToolLog />
   </LegendsPlatform>
 );
 ```
 
+#### `useTextChatStream(options)`
+
+Streaming counterpart to `useTextChat`. Sends messages over SSE and drips the assistant reply into `streamingText` at a steady rate via `requestAnimationFrame`.
+
+```tsx
+const { messages, send } = useTextChatStream({
+  streamUrl: '/api/chat/stream',
+  onError: (err) => console.error(err),
+});
+
+// messages[n].streamStatus === 'streaming' while the reply is in-flight
+await send({ message: 'Hello' });
+```
+
+#### `useSpeechActivityDetector(options)`
+
+Acoustic speech onset/offset detector driven by `AudioWorkletNode`. Useful for measuring end-to-end latency or building custom VAD UI.
+
+```tsx
+useSpeechActivityDetector({
+  source: 'user',
+  thresholdRms: 0.015,
+  hangoverMs: 300,
+  onSpeechStart: (timestampMs) => console.log('started', timestampMs),
+  onSpeechEnd: (timestampMs) => console.log('ended', timestampMs),
+});
+```
+
 ---
 
 ## Advanced: Custom Service

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.14.0",
+  "version": "1.15.0",
   "name": "@wix/legends-platform-sdk",
   "license": "MIT",
   "author": {
@@ -103,5 +103,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "39a885b1b2fc1889cfc0cb3701e0ece68ad5da768eb647b0b9970e23"
+  "falconPackageHash": "15066ab5e2566736853757bb8084e283c4d4d3c86998579c919f5c4c"
 }