voice-router-dev 0.6.5 → 0.6.6

package/CHANGELOG.md

@@ -5,6 +5,73 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.6] - 2026-01-14
+
+### Added
+
+#### Lightweight Field Metadata Export (solves 2.8MB type bundle OOM issue)
+
+### Fixed
+
+#### Encoding Format Documentation Clarification
+
+Fixed misleading documentation that showed provider-specific encoding formats instead of unified SDK format:
+
+| Provider | SDK Unified Format | Provider API Format |
+|----------|-------------------|---------------------|
+| Gladia | `linear16` | `wav/pcm` |
+| Gladia | `mulaw` | `wav/ulaw` |
+| Gladia | `alaw` | `wav/alaw` |
+| AssemblyAI | `linear16` | `pcm_s16le` |
+| Deepgram | `linear16` | `linear16` |
+
+**When using VoiceRouter or adapters**, always use the unified format (`linear16`, `mulaw`, `alaw`). The SDK handles translation to provider-specific formats automatically.
+
+**Field-configs** show provider-native values (what the API expects). These are correct for direct API usage but different from VoiceRouter unified format.
+
+---
+
+#### Lightweight Field Metadata Export (solves 2.8MB type bundle OOM issue)
+
+New `voice-router-dev/field-metadata` export provides pre-computed field metadata **without** the heavy Zod schema types:
+
+- **156 KB** types vs **2.8 MB** for `field-configs`
+- **18x reduction** in type declaration size
+- **No Zod dependency** - plain TypeScript const arrays
+- Same field information: name, type, required, description, options, min/max, etc.
+
+```typescript
+// Lightweight import - 156KB types (was 2.8MB OOM-inducing)
+import {
+  GLADIA_STREAMING_FIELDS,
+  GladiaStreamingFieldName,
+  PROVIDER_FIELDS,
+  FieldMetadata
+} from 'voice-router-dev/field-metadata'
+
+// Use for UI rendering without loading heavy Zod schemas
+GLADIA_STREAMING_FIELDS.forEach(field => {
+  if (field.type === 'select' && field.options) {
+    renderDropdown(field.name, field.options)
+  }
+})
+
+// Type-safe field names still work
+const fieldName: GladiaStreamingFieldName = 'encoding' // ✓
+// const bad: GladiaStreamingFieldName = 'typo' // ✗ TypeScript error
+```
+
+**When to use which:**
+
+| Use Case | Import |
+|----------|--------|
+| UI form generation (no validation) | `voice-router-dev/field-metadata` (156KB) |
+| Runtime Zod validation needed | `voice-router-dev/field-configs` (2.8MB) |
+
+Generated by new build script: `pnpm openapi:generate-field-metadata`
+
+---
+
 ## [0.6.5] - 2026-01-13
 
 ### Added

package/README.md

@@ -484,11 +484,11 @@ const session = await router.transcribeStream({
   sampleRate: 16000
 });
 
-// Type-safe Gladia encoding
+// Type-safe Gladia encoding - use unified format
 const gladiaSession = await router.transcribeStream({
   provider: 'gladia',
-  encoding: StreamingSupportedEncodingEnum['wav/pcm'],
-  sampleRate: StreamingSupportedSampleRateEnum['16000']
+  encoding: 'linear16', // Unified format - mapped to Gladia's 'wav/pcm'
+  sampleRate: 16000
 });
 ```
 
@@ -509,7 +509,7 @@ const deepgramSession = await router.transcribeStream({
 // Gladia streaming - with typed gladiaStreaming options
 const gladiaSession = await router.transcribeStream({
   provider: 'gladia',
-  encoding: 'wav/pcm',
+  encoding: 'linear16', // Unified format - mapped to Gladia's 'wav/pcm'
   sampleRate: 16000,
   gladiaStreaming: {
     realtime_processing: { words_accurate_timestamps: true },
@@ -567,6 +567,34 @@ type EncodingOptions = GladiaStreamingConfig['encoding']
 - `GladiaStreamingConfig`, `DeepgramTranscriptionConfig`, `AzureTranscriptionConfig`, etc.
 - `GladiaStreamingSchema`, `DeepgramTranscriptionSchema`, etc. (Zod schemas for advanced extraction)
 
+### Lightweight Field Metadata (Performance-Optimized)
+
+For UI form generation without heavy Zod schema types (156KB vs 2.8MB):
+
+```typescript
+// Lightweight import - 156KB types instead of 2.8MB
+import {
+  GLADIA_STREAMING_FIELDS,
+  GladiaStreamingFieldName,
+  PROVIDER_FIELDS,
+  FieldMetadata
+} from 'voice-router-dev/field-metadata'
+
+// Pre-computed field metadata - no Zod at runtime
+GLADIA_STREAMING_FIELDS.forEach(field => {
+  if (field.type === 'select' && field.options) {
+    renderDropdown(field.name, field.options)
+  }
+})
+```
+
+**When to use which:**
+
+| Use Case | Import | Types Size |
+|----------|--------|------------|
+| UI form generation (no validation) | `field-metadata` | 156 KB |
+| Runtime Zod validation needed | `field-configs` | 2.8 MB |
+
 ## Requirements
 
 - **Node.js**: 20.0.0 or higher