@data-netmonk/mona-chat-widget 2.6.3 → 2.6.5

package/README.md

@@ -8,9 +8,15 @@ Chat widget package developed by Netmonk data & solution team to be imported in
 
 ---
 
-**Latest Version Changes (`v2.6.1`):**
+**Latest Version Changes (`v2.6.5`):**
 
-✅ **Non-breaking Changes:**
+✅ **Patch Updates:**
+1. **Voice mode now fully controls TTS playback** - Disabling voice mode clears queued audio and stops active playback cleanly
+2. **Library build now resolves phoneme assets correctly** - Avatar viseme images are bundled through module URLs so published packages can load them reliably
+3. **Message rendering is more stable** - Messages now receive deterministic IDs and React keys to avoid collisions during history load and streaming updates
+4. **Streaming flow is more consistent** - Mock responses, webhook responses, and TTS playback now use the same streaming helper to keep text timing aligned
+
+✅ **Previous Non-breaking Changes (`v2.6.1`):**
 1. **Built-in voice mode button** - Chat widget now includes a microphone button to toggle voice mode directly from the input area
 2. **Speech-to-text flow for voice mode** - Recorded user audio is sent to the configured `VITE_STT_ENDPOINT`, then the transcription is forwarded as a normal chat message
 3. **Phoneme-driven avatar animation** - The widget can animate Mona's avatar during TTS playback based on phoneme/viseme IDs returned by the backend
@@ -133,6 +139,24 @@ Chat widget package developed by Netmonk data & solution team to be imported in
   The widget expects the TTS response body to contain raw audio binary such as `audio/wav`, and reads lip-sync metadata from `x-tts-visemes-b64`, `x-tts-phonemes-b64`, and `x-tts-phoneme-timeline-b64` response headers.
   If your TTS endpoint is called cross-origin, the server must expose those headers with `Access-Control-Expose-Headers`.
   If your TTS service uses a different header such as `x-api-key`, set `VITE_TTS_API_KEY_HEADER=x-api-key` and leave the prefix empty.
+  If you are consuming the published package inside another project, prefer passing these values via the `voiceConfig` prop because the host app `.env` is not injected into an already-built library bundle.
+  Example:
+  ```jsx
+  <ChatWidget
+    sourceId="source456"
+    webhookUrl="https://api.example.com/webhook"
+    voiceConfig={{
+      sttEndpoint: "https://voice.netmonk-ai.tech/stt",
+      sttApiKey: "your-key",
+      sttApiKeyHeader: "x-api-key",
+      sttApiKeyPrefix: "",
+      ttsEndpoint: "https://voice.example.com/tts",
+      ttsApiKey: "your-key",
+      ttsApiKeyHeader: "Authorization",
+      ttsApiKeyPrefix: "Bearer",
+    }}
+  />
+  ```
 5. Optional TTS debug logging
    
   To inspect TTS queue and playback lifecycle in browser console, set `VITE_DEBUG_TTS=true` in your `.env` file.