@lautmaler/jovo-platform-aiflow 0.2.2 → 0.2.3

package/README.md

@@ -273,8 +273,9 @@ LAUNCH() {
 interface SipgateAiflowConfig {
   apiKey?: string;              // Sipgate API key (optional)
   debug?: boolean;              // Enable debug logging
-  provider?: TtsProviderConfig; // Default TTS provider settings
+  tts?: TtsConfig;              // Default TTS provider settings
   bargeIn?: BargeInConfig;      // Default barge-in configuration
+  asyncOutput?: boolean;        // Enable/disable async output (auto-detects by default)
   plugins?: Plugin[];           // Additional platform-specific plugins
 }
 ```
@@ -318,6 +319,72 @@ new SipgateAiflowPlatform({
 })
 ```
 
+## Async Output (WebSocket)
+
+When using a WebSocket connection, the platform supports **async output mode** where each `$send()` call delivers the response immediately over the WebSocket, instead of batching all outputs into a single HTTP response.
+
+### How It Works
+
+- In **sync mode** (default for HTTP): All `$send()` calls are collected and returned as a single response at the end of the handler.
+- In **async mode** (default for WebSocket): Each `$send()` call immediately sends its output over the WebSocket connection. The final HTTP response is suppressed to avoid duplicate delivery.
+
+This is useful for scenarios like sending a speak action followed by a hangup, where each action should be delivered to Sipgate AI Flow as soon as it's ready.
+
+### Configuration
+
+Async output is controlled via the `asyncOutput` config option:
+
+```typescript
+new SipgateAiflowPlatform({
+  asyncOutput: true,  // Force enable async output
+  // asyncOutput: false, // Force disable async output
+  // asyncOutput: undefined, // Auto-detect (default)
+})
+```
+
+| Value | Behavior |
+|-------|----------|
+| `undefined` (default) | Auto-detect: enabled when using `WebSocketServer`, disabled for HTTP servers |
+| `true` | Force enable async output regardless of server type |
+| `false` | Force disable async output, even when using WebSocket |
+
+### Example: Multiple Outputs with WebSocket
+
+```typescript
+@Intents('EndConversationIntent')
+async endConversation() {
+  const sessionId = (this.$session as any).sessionInfo?.id;
+
+  // With async mode, this is sent immediately over WebSocket
+  await this.$send(SpeakOutput, {
+    message: 'Goodbye!',
+    sessionId,
+  });
+
+  // This is also sent immediately, right after the speak
+  return this.$send(HangupOutput, { sessionId });
+}
+```
+
+### WebSocket Server Setup
+
+To use async output with the built-in `WebSocketServer`:
+
+```typescript
+import { WebSocketServer } from '@lautmaler/jovo-platform-aiflow';
+import WebSocket from 'ws';
+
+const wss = new WebSocket.Server({ port: 3000 });
+
+wss.on('connection', (ws) => {
+  ws.on('message', async (data) => {
+    await app.handle(new WebSocketServer(ws, data));
+  });
+});
+```
+
+When `WebSocketServer` is used, async output is enabled automatically — no additional configuration needed.
+
 ## Server Integration
 
 The platform works with Jovo's standard Express.js server adapter:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lautmaler/jovo-platform-aiflow",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Sipgate AI Flow integration for Jovo Framework",
   "main": "dist/cjs/index.js",
   "module": "dist/esm5/index.js",