sentifyd-bot 1.2.0 → 1.3.1

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.3.1] - 2025-12-18
+
+### Changed
+- **Documentation**: Updated README with changelog and corrected dependencies information.
+
+## [1.3.0] - 2025-12-18
+
+### Added
+- **Vite Plugin**: Introduced `sentifydBotPlugin` to handle 3D avatar assets and audio worklets automatically. This is now required for Vite-based projects.
+- **Documentation**: Updated README with instructions for configuring the new Vite plugin.
+
+### Changed
+- **Dependency Management**: The 3D avatar engine (`@met4citizen/talkinghead`) is now an external dependency managed by the package, reducing the bundle size of the main application.
+- **Performance**: Improved asset loading strategy for 3D models and lip-sync modules.
+
+### Removed
+- Removed direct dependency on `three.js` (now handled internally by the avatar engine).
+
+## [1.2.0] - 2025-12-17
+
+### Added
+- **UX Improvements**: Various user experience enhancements for smoother interactions.
+- **Conversation Resume**: Enhanced handling of resuming conversations, ensuring context is preserved across sessions.
+
+## [1.1.x] - 2025-12-07
+
+### Added
+- Initial release of the Sentifyd Bot npm package.
+- Support for React, Vue, and Vanilla JS.
+- Core conversational AI features with 3D avatar integration.

package/README.md

@@ -23,6 +23,25 @@ or
 yarn add sentifyd-bot
 ```
 
+## Vite Configuration (Required)
+
+This package requires a Vite plugin to correctly handle the 3D avatar's assets and audio worklets. Add the plugin to your `vite.config.js`:
+
+```javascript
+import { defineConfig } from 'vite';
+import { sentifydBotPlugin } from 'sentifyd-bot/vite-plugin';
+
+export default defineConfig({
+  plugins: [
+    sentifydBotPlugin()
+  ]
+});
+```
+
+This plugin ensures that:
+1. Audio worklets for lip-sync are correctly served.
+2. Dynamic modules from the underlying 3D engine are properly handled.
+
 ## Quick Start
 
 ### React
@@ -140,8 +159,7 @@ export default function Home() {
 
 ## Package Details
 
-- **Size**: 578 KB compressed, 2.7 MB unpacked
-- **Dependencies**: All bundled (Three.js, Azure Speech SDK, Lit)
+- **Dependencies**: Lit, Azure Speech SDK, Socket.IO Client, TalkingHead, XState, and utilities (installed automatically)
 - **Peer Dependencies**: React (optional for non-React users)
 - **Exports**: ESM module with tree-shakable exports
 
@@ -207,3 +225,38 @@ Configure custom storage (for mobile apps or special use cases).
 Proprietary - See [LICENSE.md](LICENSE.md) for details.
 
 Free to use in commercial and non-commercial projects. Modification and redistribution of source code prohibited without permission.
+
+## Changelog
+
+All notable changes to this project will be documented in this file.
+
+### [1.3.1] - 2025-12-18
+
+#### Changed
+- **Documentation**: Updated README with changelog and corrected dependencies information.
+
+### [1.3.0] - 2025-12-18
+
+#### Added
+- **Vite Plugin**: Introduced `sentifydBotPlugin` to handle 3D avatar assets and audio worklets automatically. This is now required for Vite-based projects.
+- **Documentation**: Updated README with instructions for configuring the new Vite plugin.
+
+#### Changed
+- **Dependency Management**: The 3D avatar engine (`@met4citizen/talkinghead`) is now an external dependency managed by the package, reducing the bundle size of the main application.
+- **Performance**: Improved asset loading strategy for 3D models and lip-sync modules.
+
+#### Removed
+- Removed direct dependency on `three.js` (now handled internally by the avatar engine).
+
+### [1.2.0] - 2025-12-17
+
+#### Added
+- **UX Improvements**: Various user experience enhancements for smoother interactions.
+- **Conversation Resume**: Enhanced handling of resuming conversations, ensuring context is preserved across sessions.
+
+### [1.1.x] - 2025-12-07
+
+#### Added
+- Initial release of the Sentifyd Bot npm package.
+- Support for React, Vue, and Vanilla JS.
+- Core conversational AI features with 3D avatar integration.