|
| 1 | +# Changelog: Deepgram JavaScript SDK v5.0.0-alpha.1 to v5.0.0-alpha.2 |
| 2 | + |
| 3 | +This changelog covers all changes from `v5.0.0-alpha.1` to `v5.0.0-alpha.2`. |
| 4 | + |
| 5 | +## 🚀 Major Changes |
| 6 | + |
| 7 | +### Browser SDK Support |
| 8 | +- **Added**: Full browser SDK compilation and support |
| 9 | +- **Added**: Browser-compatible WebSocket implementation using custom client |
| 10 | +- **Added**: Browser testing infrastructure with comprehensive test suite |
| 11 | +- **Changed**: Migrated custom WebSocket logic to dedicated client implementation |
| 12 | + |
| 13 | +### Security Improvements |
| 14 | +- **Added**: `.npmrc` configuration for enhanced security |
| 15 | +- **Changed**: API keys are no longer stored in memory unnecessarily |
| 16 | + |
| 17 | +## ✨ New Features |
| 18 | + |
| 19 | +### Browser Support |
| 20 | +- **Added**: Browser SDK compilation that works without errors in examples |
| 21 | +- **Added**: WebSocket support for browser environments |
| 22 | + - Custom WebSocket client implementation |
| 23 | + - Proper protocol handling (using protocol instead of headers for WebSockets) |
| 24 | + - Audio handling fixes for browser WebSocket examples |
| 25 | +- **Added**: Browser testing infrastructure |
| 26 | + - Comprehensive browser test suite |
| 27 | + - Test helpers for browser environment |
| 28 | + - Examples can now run in browser context |
| 29 | + |
| 30 | +### Developer Experience |
| 31 | +- **Added**: Makefile for running examples (`make run-examples`) |
| 32 | +- **Added**: Improved Makefile with better help text and colors |
| 33 | +- **Added**: Script to update imports before running wire tests (`tools/update-imports.js`) |
| 34 | +- **Added**: Environment variable support for examples |
| 35 | + - Examples now use environment variables |
| 36 | + - CI environment configured to run examples |
| 37 | + |
| 38 | +### Infrastructure |
| 39 | +- **Added**: Custom WebSocket client migration |
| 40 | + - Migrated custom WebSocket logic to dedicated client |
| 41 | + - Improved WebSocket connection handling |
| 42 | + - Better separation of concerns |
| 43 | + |
| 44 | +## 🐛 Bug Fixes |
| 45 | + |
| 46 | +### API Fixes |
| 47 | +- **Fixed**: Support for keyterms with Flux models in `ListenLiveClient` (#449) |
| 48 | + - Previously, the SDK would throw an error when using keyterms with Flux models |
| 49 | + - Now supports both Nova-3 and Flux streaming models for keyterms |
| 50 | + - Preserves validation behavior for unsupported models (e.g., nova-2) |
| 51 | + - See: https://developers.deepgram.com/docs/keyterm |
| 52 | + |
| 53 | +### Browser Fixes |
| 54 | +- **Fixed**: Audio handling in browser WebSocket examples |
| 55 | + - Fixed issue where audio was incorrectly handled as a string |
| 56 | + - Proper audio data handling for browser environments |
| 57 | +- **Fixed**: Build order issues |
| 58 | + - Browser build was deleting other builds during compilation |
| 59 | + - Fixed build sequence to prevent conflicts |
| 60 | + |
| 61 | +### Tooling Fixes |
| 62 | +- **Fixed**: Makefile issues |
| 63 | + - Fixed broken Makefile commands |
| 64 | + - Updated to use `pnpm exec` for proper command execution |
| 65 | +- **Fixed**: CI configuration |
| 66 | + - Fixed CodeQL analysis to ignore examples (not production code) |
| 67 | + - Improved CI permissions handling |
| 68 | + |
| 69 | +## 🔧 Infrastructure & Tooling |
| 70 | + |
| 71 | +### Build System |
| 72 | +- **Improved**: Build order handling |
| 73 | +- **Improved**: Browser build process |
| 74 | +- **Added**: Proper example ignoring in build processes |
| 75 | + |
| 76 | +### CI/CD |
| 77 | +- **Updated**: CI to use Makefile for all commands |
| 78 | +- **Improved**: CI permissions handling |
| 79 | +- **Fixed**: CodeQL analysis configuration |
| 80 | + - Examples are now properly ignored in CodeQL scans |
| 81 | + - Added proper ignore patterns for non-production code |
| 82 | + |
| 83 | +### Development Tools |
| 84 | +- **Added**: Makefile improvements |
| 85 | + - Better help text with colors |
| 86 | + - Unified command execution via `pnpm exec` |
| 87 | + - Examples runner (`make run-examples`) |
| 88 | +- **Added**: Import update script for wire tests |
| 89 | + - Script to automatically update imports before running wire tests |
| 90 | + - Improves developer workflow |
| 91 | + |
| 92 | +### Configuration |
| 93 | +- **Added**: `.npmrc` for security |
| 94 | +- **Updated**: `.fernignore` patterns |
| 95 | + - Better ignore patterns for examples |
| 96 | + - Improved Fern configuration |
| 97 | + |
| 98 | +## 📚 Documentation & Examples |
| 99 | + |
| 100 | +### Examples |
| 101 | +- **Updated**: Examples now use environment variables |
| 102 | +- **Fixed**: Browser WebSocket examples with proper audio handling |
| 103 | +- **Added**: Makefile command to run examples easily |
| 104 | + |
| 105 | +### Code Quality |
| 106 | +- **Improved**: CodeQL analysis configuration |
| 107 | +- **Updated**: Fern ignore patterns for better code generation |
| 108 | + |
| 109 | +## 🔄 SDK Regeneration |
| 110 | + |
| 111 | +Multiple SDK regeneration commits were made during this period: |
| 112 | +- Several SDK regenerations by `fern-api[bot]` |
| 113 | +- Some regenerations were reverted and reapplied as part of the development process |
| 114 | +- Final regeneration included in release |
| 115 | + |
| 116 | +## 📦 Package Details |
| 117 | + |
| 118 | +- **Base Version**: 5.0.0-alpha.1 |
| 119 | +- **Current Commit**: e83f09a (v5.0.0-alpha.2) |
| 120 | +- **Date Range**: December 16-18, 2025 |
| 121 | + |
| 122 | +## 📝 Commits Summary |
| 123 | + |
| 124 | +### Features Added |
| 125 | +- Browser SDK compilation and examples support |
| 126 | +- Browser testing infrastructure |
| 127 | +- WebSocket support in browser |
| 128 | +- Custom WebSocket client migration |
| 129 | +- Makefile improvements |
| 130 | +- npmrc for security |
| 131 | +- Import update script for wire tests |
| 132 | +- Environment variable support for examples |
| 133 | +- Security improvement: don't store API keys unnecessarily |
| 134 | + |
| 135 | +### Bug Fixes |
| 136 | +- Keyterms support for Flux models in ListenLiveClient |
| 137 | +- Audio handling in browser WebSocket examples |
| 138 | +- Build order issues |
| 139 | +- Makefile command execution |
| 140 | +- CI CodeQL configuration |
| 141 | + |
| 142 | +### Chores |
| 143 | +- Multiple SDK regenerations |
| 144 | +- CI improvements |
| 145 | +- Fern ignore pattern updates |
| 146 | +- CodeQL analysis fixes |
| 147 | + |
| 148 | +## 🙏 Contributors |
| 149 | + |
| 150 | +- Naomi Carrigan |
| 151 | +- Adrian Martinez |
| 152 | +- fern-api[bot] |
| 153 | + |
| 154 | +--- |
| 155 | + |
| 156 | +For questions or issues, please visit: |
| 157 | +- [GitHub Issues](https://github.com/deepgram/deepgram-js-sdk/issues) |
| 158 | +- [Deepgram Documentation](https://developers.deepgram.com) |
| 159 | +- [API Reference](https://developers.deepgram.com/reference/deepgram-api-overview) |
| 160 | + |
0 commit comments