voice-router-dev 0.8.1 → 0.8.3

package/dist/webhooks.d.ts

@@ -1,7 +1,237 @@
-import { fo as TranscriptionStatus, fl as Speaker, fm as Word, fn as Utterance, Q as CallbackTranscriptionSuccessPayload, J as CallbackTranscriptionErrorPayload, cf as TranscriptWebhookNotification, d2 as ListenV1Response } from './transcriptWebhookNotification-BJk1CEF5.js';
-import { T as TranscriptionProvider } from './provider-metadata-DbsSGAO7.js';
+import { gH as TranscriptionStatus, gE as Speaker, gF as Word, gG as Utterance, Q as CallbackTranscriptionSuccessPayload, J as CallbackTranscriptionErrorPayload, cf as TranscriptWebhookNotification, d2 as ListenV1Response, eR as RetrieveTranscriptResponse, fr as SpeechToTextChunkResponseModel } from './speechToTextChunkResponseModel-DjL2ncnf.js';
+import { T as TranscriptionProvider } from './provider-metadata-_gUWlRXS.js';
 import './constants.js';
 
+/**
+ * Base webhook handler interface
+ * All provider-specific webhook handlers must implement this
+ */
+
+/**
+ * Abstract base class for webhook handlers
+ *
+ * Each provider implements this to parse and normalize their webhook payloads
+ */
+declare abstract class BaseWebhookHandler {
+    /** Provider name */
+    abstract readonly provider: TranscriptionProvider;
+    /**
+     * Check if this payload matches this provider's webhook format
+     *
+     * Used for auto-detection of webhook provider
+     *
+     * @param payload - Raw webhook payload
+     * @param options - Optional context (query params, headers, etc.)
+     * @returns true if this handler can process the payload
+     *
+     * @example
+     * ```typescript
+     * matches(payload, options) {
+     *   return typeof payload === 'object' &&
+     *          'event' in payload &&
+     *          'payload' in payload
+     * }
+     * ```
+     */
+    abstract matches(payload: unknown, options?: {
+        queryParams?: Record<string, string>;
+        userAgent?: string;
+    }): boolean;
+    /**
+     * Parse and normalize webhook payload
+     *
+     * Converts provider-specific webhook format to UnifiedWebhookEvent
+     *
+     * @param payload - Raw webhook payload
+     * @param options - Optional context (query params, headers, etc.)
+     * @returns Normalized webhook event
+     * @throws Error if payload cannot be parsed
+     *
+     * @example
+     * ```typescript
+     * parse(payload, options) {
+     *   const typed = payload as ProviderWebhookPayload
+     *   return {
+     *     success: true,
+     *     provider: this.provider,
+     *     eventType: 'transcription.completed',
+     *     data: { id: typed.job_id, ... },
+     *     timestamp: new Date().toISOString(),
+     *     raw: payload
+     *   }
+     * }
+     * ```
+     */
+    abstract parse(payload: unknown, options?: {
+        queryParams?: Record<string, string>;
+    }): UnifiedWebhookEvent;
+    /**
+     * Verify webhook signature (if provider supports it)
+     *
+     * Optional method - implement if provider supports webhook signature verification
+     *
+     * @param payload - Raw webhook payload
+     * @param options - Verification options (signature, secret, etc.)
+     * @returns true if signature is valid
+     *
+     * @example
+     * ```typescript
+     * verify(payload, options) {
+     *   if (!options.signature || !options.secret) return false
+     *
+     *   const computed = crypto
+     *     .createHmac('sha256', options.secret)
+     *     .update(JSON.stringify(payload))
+     *     .digest('hex')
+     *
+     *   return computed === options.signature
+     * }
+     * ```
+     */
+    verify?(payload: unknown, options: WebhookVerificationOptions): boolean;
+    /**
+     * Validate webhook payload structure
+     *
+     * Checks if payload has required fields and correct types
+     *
+     * @param payload - Raw webhook payload
+     * @param options - Optional context (query params, headers, etc.)
+     * @returns Validation result with details
+     */
+    validate(payload: unknown, options?: {
+        queryParams?: Record<string, string>;
+        userAgent?: string;
+    }): WebhookValidation;
+    /**
+     * Helper method to create error response
+     */
+    protected createErrorEvent(payload: unknown, errorMessage: string): UnifiedWebhookEvent;
+}
+
+/**
+ * Azure Speech-to-Text webhook handler
+ * Parses and normalizes Azure STT webhook callbacks
+ */
+
+/**
+ * Azure webhook event payload structure
+ * Based on Azure Speech Services v3.1 webhook format
+ */
+interface AzureWebhookPayload {
+    /** Event action (e.g., "TranscriptionCreated", "TranscriptionSucceeded", "TranscriptionFailed") */
+    action: string;
+    /** Timestamp of the event */
+    timestamp: string;
+    /** Self-link to the resource */
+    self?: string;
+    /** Additional properties */
+    properties?: Record<string, unknown>;
+    /** Error details (for failed events) */
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+/**
+ * Azure webhook handler
+ *
+ * Handles webhook callbacks from Azure Speech Services API:
+ * - TranscriptionCreated - Transcription job created
+ * - TranscriptionRunning - Transcription is processing
+ * - TranscriptionSucceeded - Transcription completed successfully
+ * - TranscriptionFailed - Transcription failed with error
+ *
+ * Azure supports optional webhook signature verification using a shared secret.
+ *
+ * @example Basic usage
+ * ```typescript
+ * import { AzureWebhookHandler } from '@meeting-baas/sdk';
+ *
+ * const handler = new AzureWebhookHandler();
+ *
+ * // Validate webhook
+ * const validation = handler.validate(req.body);
+ * if (!validation.valid) {
+ *   return res.status(400).json({ error: validation.error });
+ * }
+ *
+ * // Parse webhook
+ * const event = handler.parse(req.body);
+ * console.log('Event type:', event.eventType);
+ * console.log('Action:', event.raw.action);
+ * ```
+ *
+ * @example With signature verification
+ * ```typescript
+ * // Verify webhook signature (if configured in Azure)
+ * const isValid = handler.verify(req.body, {
+ *   signature: req.headers['x-azure-signature'],
+ *   secret: process.env.AZURE_WEBHOOK_SECRET,
+ *   rawBody: req.rawBody
+ * });
+ *
+ * if (!isValid) {
+ *   return res.status(401).json({ error: 'Invalid signature' });
+ * }
+ * ```
+ *
+ * @example Processing completed transcription
+ * ```typescript
+ * const event = handler.parse(req.body);
+ *
+ * if (event.eventType === 'transcription.completed') {
+ *   // Extract transcription ID from self link
+ *   const transcriptionId = event.data?.id;
+ *
+ *   // Fetch full transcript using AzureAdapter.getTranscript(transcriptionId)
+ *   console.log('Transcription completed:', transcriptionId);
+ * }
+ * ```
+ */
+declare class AzureWebhookHandler extends BaseWebhookHandler {
+    readonly provider: TranscriptionProvider;
+    /**
+     * Check if payload matches Azure webhook format
+     */
+    matches(payload: unknown, _options?: {
+        queryParams?: Record<string, string>;
+        userAgent?: string;
+    }): boolean;
+    /**
+     * Parse Azure webhook payload to unified format
+     */
+    parse(payload: unknown, _options?: {
+        queryParams?: Record<string, string>;
+    }): UnifiedWebhookEvent;
+    /**
+     * Verify Azure webhook signature
+     *
+     * Azure can optionally sign webhooks using HMAC-SHA256.
+     * The signature is sent in the X-Azure-Signature header.
+     *
+     * Note: Signature verification is optional in Azure and must be
+     * configured when creating the webhook.
+     *
+     * @param payload - Webhook payload
+     * @param options - Verification options with signature and secret
+     * @returns true if signature is valid or no signature provided
+     *
+     * @example
+     * ```typescript
+     * const isValid = handler.verify(req.body, {
+     *   signature: req.headers['x-azure-signature'],
+     *   secret: process.env.AZURE_WEBHOOK_SECRET,
+     *   rawBody: req.rawBody
+     * });
+     * ```
+     */
+    verify(payload: unknown, options: WebhookVerificationOptions): boolean;
+}
+/**
+ * Factory function to create an Azure webhook handler
+ */
+declare function createAzureWebhookHandler(): AzureWebhookHandler;
+
 /**
  * Unified webhook types for transcription providers
  * Normalizes webhook callbacks from different providers to a common format
@@ -18,9 +248,10 @@ type ProviderWebhookPayloadMap = {
     gladia: GladiaWebhookPayload;
     assemblyai: TranscriptWebhookNotification;
     deepgram: ListenV1Response;
-    "azure-stt": unknown;
+    "azure-stt": AzureWebhookPayload;
     "openai-whisper": never;
-    speechmatics: unknown;
+    speechmatics: RetrieveTranscriptResponse;
+    elevenlabs: SpeechToTextChunkResponseModel;
 };
 /**
  * Unified webhook event types
@@ -122,112 +353,6 @@ interface WebhookVerificationOptions {
     headers?: Record<string, string>;
 }
 
-/**
- * Base webhook handler interface
- * All provider-specific webhook handlers must implement this
- */
-
-/**
- * Abstract base class for webhook handlers
- *
- * Each provider implements this to parse and normalize their webhook payloads
- */
-declare abstract class BaseWebhookHandler {
-    /** Provider name */
-    abstract readonly provider: TranscriptionProvider;
-    /**
-     * Check if this payload matches this provider's webhook format
-     *
-     * Used for auto-detection of webhook provider
-     *
-     * @param payload - Raw webhook payload
-     * @param options - Optional context (query params, headers, etc.)
-     * @returns true if this handler can process the payload
-     *
-     * @example
-     * ```typescript
-     * matches(payload, options) {
-     *   return typeof payload === 'object' &&
-     *          'event' in payload &&
-     *          'payload' in payload
-     * }
-     * ```
-     */
-    abstract matches(payload: unknown, options?: {
-        queryParams?: Record<string, string>;
-        userAgent?: string;
-    }): boolean;
-    /**
-     * Parse and normalize webhook payload
-     *
-     * Converts provider-specific webhook format to UnifiedWebhookEvent
-     *
-     * @param payload - Raw webhook payload
-     * @param options - Optional context (query params, headers, etc.)
-     * @returns Normalized webhook event
-     * @throws Error if payload cannot be parsed
-     *
-     * @example
-     * ```typescript
-     * parse(payload, options) {
-     *   const typed = payload as ProviderWebhookPayload
-     *   return {
-     *     success: true,
-     *     provider: this.provider,
-     *     eventType: 'transcription.completed',
-     *     data: { id: typed.job_id, ... },
-     *     timestamp: new Date().toISOString(),
-     *     raw: payload
-     *   }
-     * }
-     * ```
-     */
-    abstract parse(payload: unknown, options?: {
-        queryParams?: Record<string, string>;
-    }): UnifiedWebhookEvent;
-    /**
-     * Verify webhook signature (if provider supports it)
-     *
-     * Optional method - implement if provider supports webhook signature verification
-     *
-     * @param payload - Raw webhook payload
-     * @param options - Verification options (signature, secret, etc.)
-     * @returns true if signature is valid
-     *
-     * @example
-     * ```typescript
-     * verify(payload, options) {
-     *   if (!options.signature || !options.secret) return false
-     *
-     *   const computed = crypto
-     *     .createHmac('sha256', options.secret)
-     *     .update(JSON.stringify(payload))
-     *     .digest('hex')
-     *
-     *   return computed === options.signature
-     * }
-     * ```
-     */
-    verify?(payload: unknown, options: WebhookVerificationOptions): boolean;
-    /**
-     * Validate webhook payload structure
-     *
-     * Checks if payload has required fields and correct types
-     *
-     * @param payload - Raw webhook payload
-     * @param options - Optional context (query params, headers, etc.)
-     * @returns Validation result with details
-     */
-    validate(payload: unknown, options?: {
-        queryParams?: Record<string, string>;
-        userAgent?: string;
-    }): WebhookValidation;
-    /**
-     * Helper method to create error response
-     */
-    protected createErrorEvent(payload: unknown, errorMessage: string): UnifiedWebhookEvent;
-}
-
 /**
  * Gladia webhook handler
  * Parses and normalizes Gladia webhook callbacks
@@ -513,111 +638,6 @@ declare class DeepgramWebhookHandler extends BaseWebhookHandler {
  */
 declare function createDeepgramWebhookHandler(): DeepgramWebhookHandler;
 
-/**
- * Azure Speech-to-Text webhook handler
- * Parses and normalizes Azure STT webhook callbacks
- */
-
-/**
- * Azure webhook handler
- *
- * Handles webhook callbacks from Azure Speech Services API:
- * - TranscriptionCreated - Transcription job created
- * - TranscriptionRunning - Transcription is processing
- * - TranscriptionSucceeded - Transcription completed successfully
- * - TranscriptionFailed - Transcription failed with error
- *
- * Azure supports optional webhook signature verification using a shared secret.
- *
- * @example Basic usage
- * ```typescript
- * import { AzureWebhookHandler } from '@meeting-baas/sdk';
- *
- * const handler = new AzureWebhookHandler();
- *
- * // Validate webhook
- * const validation = handler.validate(req.body);
- * if (!validation.valid) {
- *   return res.status(400).json({ error: validation.error });
- * }
- *
- * // Parse webhook
- * const event = handler.parse(req.body);
- * console.log('Event type:', event.eventType);
- * console.log('Action:', event.raw.action);
- * ```
- *
- * @example With signature verification
- * ```typescript
- * // Verify webhook signature (if configured in Azure)
- * const isValid = handler.verify(req.body, {
- *   signature: req.headers['x-azure-signature'],
- *   secret: process.env.AZURE_WEBHOOK_SECRET,
- *   rawBody: req.rawBody
- * });
- *
- * if (!isValid) {
- *   return res.status(401).json({ error: 'Invalid signature' });
- * }
- * ```
- *
- * @example Processing completed transcription
- * ```typescript
- * const event = handler.parse(req.body);
- *
- * if (event.eventType === 'transcription.completed') {
- *   // Extract transcription ID from self link
- *   const transcriptionId = event.data?.id;
- *
- *   // Fetch full transcript using AzureAdapter.getTranscript(transcriptionId)
- *   console.log('Transcription completed:', transcriptionId);
- * }
- * ```
- */
-declare class AzureWebhookHandler extends BaseWebhookHandler {
-    readonly provider: TranscriptionProvider;
-    /**
-     * Check if payload matches Azure webhook format
-     */
-    matches(payload: unknown, _options?: {
-        queryParams?: Record<string, string>;
-        userAgent?: string;
-    }): boolean;
-    /**
-     * Parse Azure webhook payload to unified format
-     */
-    parse(payload: unknown, _options?: {
-        queryParams?: Record<string, string>;
-    }): UnifiedWebhookEvent;
-    /**
-     * Verify Azure webhook signature
-     *
-     * Azure can optionally sign webhooks using HMAC-SHA256.
-     * The signature is sent in the X-Azure-Signature header.
-     *
-     * Note: Signature verification is optional in Azure and must be
-     * configured when creating the webhook.
-     *
-     * @param payload - Webhook payload
-     * @param options - Verification options with signature and secret
-     * @returns true if signature is valid or no signature provided
-     *
-     * @example
-     * ```typescript
-     * const isValid = handler.verify(req.body, {
-     *   signature: req.headers['x-azure-signature'],
-     *   secret: process.env.AZURE_WEBHOOK_SECRET,
-     *   rawBody: req.rawBody
-     * });
-     * ```
-     */
-    verify(payload: unknown, options: WebhookVerificationOptions): boolean;
-}
-/**
- * Factory function to create an Azure webhook handler
- */
-declare function createAzureWebhookHandler(): AzureWebhookHandler;
-
 /**
  * Speechmatics webhook handler
  * Parses and normalizes Speechmatics webhook callbacks

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "voice-router-dev",
-  "version": "0.8.1",
+  "version": "0.8.3",
   "description": "Universal speech-to-text router for Gladia, AssemblyAI, Deepgram, Azure, OpenAI Whisper, Speechmatics, Soniox, and ElevenLabs",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -197,7 +197,7 @@
     "openapi:diagram": "node scripts/generate-pipeline-diagram.js",
     "openapi:rebuild": "pnpm openapi:sync && pnpm openapi:generate && pnpm build",
     "docs:clean": "rm -rf docs/generated",
-    "docs:generate": "pnpm docs:clean && pnpm docs:generate:router && pnpm docs:generate:webhooks && pnpm docs:generate:gladia && pnpm docs:generate:assemblyai && pnpm docs:generate:deepgram && pnpm docs:generate:azure && pnpm docs:generate:openai && pnpm docs:generate:speechmatics && pnpm docs:field-equivalences",
+    "docs:generate": "pnpm docs:clean && pnpm docs:generate:router && pnpm docs:generate:webhooks && pnpm docs:generate:gladia && pnpm docs:generate:assemblyai && pnpm docs:generate:deepgram && pnpm docs:generate:azure && pnpm docs:generate:openai && pnpm docs:generate:speechmatics && pnpm docs:generate:soniox && pnpm docs:generate:elevenlabs && pnpm docs:field-equivalences",
     "docs:generate:router": "typedoc --options typedoc.router.config.mjs",
     "docs:generate:webhooks": "typedoc --options typedoc.webhooks.config.mjs",
     "docs:generate:gladia": "typedoc --options typedoc.gladia.config.mjs",
@@ -206,6 +206,8 @@
     "docs:generate:azure": "typedoc --options typedoc.azure.config.mjs",
     "docs:generate:openai": "typedoc --options typedoc.openai.config.mjs",
     "docs:generate:speechmatics": "typedoc --options typedoc.speechmatics.config.mjs",
+    "docs:generate:soniox": "typedoc --options typedoc.soniox.config.mjs",
+    "docs:generate:elevenlabs": "typedoc --options typedoc.elevenlabs.config.mjs",
     "docs:field-equivalences": "node scripts/generate-field-equivalences.js",
     "prebuild": "pnpm openapi:fix-specs && pnpm openapi:fix && pnpm openapi:sync-soniox-languages && pnpm openapi:sync-soniox-models && pnpm openapi:sync-speechmatics-languages && pnpm openapi:sync-azure-locales && pnpm openapi:sync-deepgram-languages && pnpm openapi:sync-deepgram-models && pnpm openapi:sync-openai-models && pnpm openapi:sync-elevenlabs-languages && pnpm openapi:sync-elevenlabs-models"
   }