@framers/agentos 0.1.107 → 0.1.109

package/dist/voice-pipeline/index.js

@@ -1,14 +1,54 @@
 /**
+ * @module @framers/agentos/voice-pipeline
+ *
  * Barrel exports for the AgentOS streaming voice pipeline.
  *
- * @module @framers/agentos/voice-pipeline
+ * This module provides all the building blocks needed to assemble a real-time
+ * voice conversation system:
+ *
+ * - **Types** -- All interfaces and type aliases defining the pipeline's contracts
+ *   ({@link AudioFrame}, {@link IStreamTransport}, {@link IEndpointDetector}, etc.).
+ *
+ * - **Orchestrator** -- {@link VoicePipelineOrchestrator} is the central state machine
+ *   that wires transport, STT, endpoint detection, TTS, and barge-in handling into
+ *   a coordinated conversation loop.
+ *
+ * - **Endpoint Detectors** -- Two strategies for detecting turn boundaries:
+ *   - {@link HeuristicEndpointDetector}: Rule-based (punctuation + silence timeout).
+ *   - {@link AcousticEndpointDetector}: Purely acoustic (silence-only, no transcript analysis).
+ *
+ * - **Barge-in Handlers** -- Two strategies for handling user interruptions:
+ *   - {@link HardCutBargeinHandler}: Immediate stop above a speech duration threshold.
+ *   - {@link SoftFadeBargeinHandler}: Three-tier (ignore/pause/cancel) with configurable fade.
+ *
+ * - **Transport** -- {@link WebSocketStreamTransport}: WebSocket-based bidirectional
+ *   audio/text transport implementing {@link IStreamTransport}.
+ *
+ * - **Error** -- {@link VoiceInterruptError}: Typed error for barge-in interruptions.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   VoicePipelineOrchestrator,
+ *   HeuristicEndpointDetector,
+ *   HardCutBargeinHandler,
+ *   WebSocketStreamTransport,
+ * } from '../voice-pipeline/index.js';
+ * ```
  */
+// Re-export all type definitions from the types module.
+// Consumers can import any interface or type alias directly from this barrel.
 export * from './types.js';
+// Concrete barge-in handler implementations
 export { HardCutBargeinHandler } from './HardCutBargeinHandler.js';
 export { SoftFadeBargeinHandler } from './SoftFadeBargeinHandler.js';
+// Concrete endpoint detector implementations
 export { HeuristicEndpointDetector } from './HeuristicEndpointDetector.js';
 export { AcousticEndpointDetector } from './AcousticEndpointDetector.js';
+// WebSocket-based transport implementation
 export { WebSocketStreamTransport } from './WebSocketStreamTransport.js';
+// Central pipeline orchestrator (state machine)
 export { VoicePipelineOrchestrator } from './VoicePipelineOrchestrator.js';
+// Typed error for barge-in interruptions
 export { VoiceInterruptError } from './VoiceInterruptError.js';
 //# sourceMappingURL=index.js.map

package/dist/voice-pipeline/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/voice-pipeline/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/voice-pipeline/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,wDAAwD;AACxD,8EAA8E;AAC9E,cAAc,YAAY,CAAC;AAE3B,4CAA4C;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE,6CAA6C;AAC7C,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE,2CAA2C;AAC3C,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE,gDAAgD;AAChD,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAE3E,yCAAyC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC"}