@loonylabs/tts-middleware 0.1.1

package/dist/middleware/services/tts/types/common.types.d.ts

@@ -0,0 +1,303 @@
+/**
+ * Common types and interfaces for TTS Middleware
+ *
+ * These types form the contract between the TTS middleware and consuming applications.
+ * All provider parameters are pre-typed to prevent breaking API changes when adding new providers.
+ */
+/**
+ * Supported TTS providers
+ *
+ * @MVP ✅ AZURE - Microsoft Azure Speech Services (EU-compliant, free tier)
+ * @Current ✅ EDENAI - EdenAI multi-provider aggregator
+ * @Future 🔮 OPENAI - OpenAI TTS API
+ * @Future 🔮 ELEVENLABS - ElevenLabs TTS API
+ * @Future 🔮 GOOGLE - Google Cloud Text-to-Speech
+ * @Future 🔮 DEEPGRAM - Deepgram TTS API
+ */
+export declare enum TTSProvider {
+    AZURE = "azure",
+    EDENAI = "edenai",
+    OPENAI = "openai",
+    ELEVENLABS = "elevenlabs",
+    GOOGLE = "google",
+    DEEPGRAM = "deepgram"
+}
+/**
+ * Audio format options supported across providers
+ *
+ * @MVP ✅ mp3, wav, opus - Supported by Azure
+ * @Future 🔮 aac, flac - Additional formats for other providers
+ */
+export type AudioFormat = 'mp3' | 'wav' | 'opus' | 'aac' | 'flac';
+/**
+ * Audio configuration options
+ */
+export interface AudioOptions {
+    /**
+     * Audio output format
+     * @MVP ✅ Implemented: mp3, wav, opus
+     * @Future 🔮 aac, flac
+     * @default 'mp3'
+     */
+    format?: AudioFormat;
+    /**
+     * Speech speed multiplier
+     * @MVP ✅ Implemented (Azure)
+     * @range 0.5 - 2.0
+     * @default 1.0
+     * @providers All providers support this
+     */
+    speed?: number;
+    /**
+     * Pitch adjustment in semitones
+     * @Future 🔮 Google, Azure
+     * @range -20 to 20
+     * @default 0
+     */
+    pitch?: number;
+    /**
+     * Volume gain in decibels
+     * @Future 🔮 Google
+     * @range -96 to 16
+     * @default 0
+     */
+    volumeGainDb?: number;
+    /**
+     * Audio sample rate in Hz
+     * @MVP ✅ Implemented (Azure)
+     * @options 8000, 16000, 24000, 48000
+     * @default 24000
+     */
+    sampleRate?: number;
+}
+/**
+ * Voice configuration
+ */
+export interface VoiceConfig {
+    /**
+     * Voice identifier (provider-specific)
+     * @MVP ✅ Implemented
+     * @example Azure: 'de-DE-KatjaNeural', 'en-US-JennyNeural'
+     * @example OpenAI: 'alloy', 'echo', 'fable', 'onyx', 'nova', 'shimmer'
+     * @example ElevenLabs: 'voice_xyz123'
+     */
+    id: string;
+}
+/**
+ * TTS synthesis request
+ *
+ * @description Request object for converting text to speech
+ *
+ * @example
+ * ```typescript
+ * const request: TTSSynthesizeRequest = {
+ *   text: "Hello, how are you?",
+ *   provider: TTSProvider.AZURE,
+ *   voice: { id: 'en-US-JennyNeural' },
+ *   audio: { speed: 1.0, format: 'mp3' }
+ * };
+ * ```
+ */
+export interface TTSSynthesizeRequest {
+    /**
+     * Input text to synthesize
+     * @MVP ✅ Implemented
+     * @example "Hello, how are you?"
+     */
+    text: string;
+    /**
+     * TTS provider to use
+     * @MVP ✅ Implemented
+     * @optional Uses default provider if not specified
+     * @default TTSProvider.AZURE
+     */
+    provider?: TTSProvider;
+    /**
+     * Voice configuration
+     * @MVP ✅ Implemented
+     */
+    voice: VoiceConfig;
+    /**
+     * Audio output options
+     * @MVP ✅ Implemented (Azure supports format, speed, sampleRate)
+     * @Future 🔮 pitch, volumeGainDb
+     */
+    audio?: AudioOptions;
+    /**
+     * Provider-specific options
+     * @MVP ✅ Implemented (Azure: emotion, style)
+     * @Future 🔮 OpenAI, ElevenLabs, Google, Deepgram options
+     *
+     * @description Use this for provider-specific parameters that don't fit
+     * into the universal interface. See provider-options.types.ts for
+     * typed options per provider.
+     *
+     * @example Azure
+     * ```typescript
+     * providerOptions: { emotion: 'cheerful', style: 'chat' }
+     * ```
+     *
+     * @example ElevenLabs
+     * ```typescript
+     * providerOptions: { stability: 0.5, similarity_boost: 0.75 }
+     * ```
+     */
+    providerOptions?: Record<string, unknown>;
+}
+/**
+ * TTS response metadata
+ */
+export interface TTSResponseMetadata {
+    /**
+     * Provider that generated the audio
+     * @MVP ✅ Implemented
+     */
+    provider: string;
+    /**
+     * Voice ID that was used
+     * @MVP ✅ Implemented
+     */
+    voice: string;
+    /**
+     * Audio duration in milliseconds
+     * @MVP ✅ Implemented
+     */
+    duration: number;
+    /**
+     * Audio format of the output
+     * @MVP ✅ Implemented
+     */
+    audioFormat: string;
+    /**
+     * Sample rate in Hz
+     * @MVP ✅ Implemented
+     */
+    sampleRate: number;
+}
+/**
+ * Billing information for the TTS request
+ *
+ * @description Consumer application uses this to calculate costs based on
+ * their provider rates. Middleware does not calculate costs.
+ */
+export interface TTSBillingInfo {
+    /**
+     * Number of characters in the input text
+     * @MVP ✅ Implemented
+     *
+     * @description This count excludes SSML markup (for providers that use SSML internally).
+     * The count includes spaces, punctuation, and newlines.
+     *
+     * Consumer apps calculate cost as:
+     * - Azure: (characters / 1_000_000) * $16
+     * - OpenAI: (characters / 1_000_000) * $15
+     * - ElevenLabs: (characters / 1_000_000) * $150-200
+     */
+    characters: number;
+    /**
+     * Number of tokens used (for token-based providers)
+     * @Future 🔮 OpenAI gpt-4o-mini-tts
+     *
+     * @description Only populated for token-based providers like OpenAI's newer models.
+     * Most providers use character-based billing, so this will be undefined.
+     */
+    tokensUsed?: number;
+}
+/**
+ * TTS synthesis response
+ *
+ * @description Response from TTS synthesis containing audio data,
+ * metadata, and billing information
+ */
+export interface TTSResponse {
+    /**
+     * Raw audio data as Buffer
+     * @MVP ✅ Implemented
+     *
+     * @description Binary audio data in the requested format (MP3, WAV, etc.)
+     *
+     * @example
+     * ```typescript
+     * import fs from 'fs';
+     * fs.writeFileSync('output.mp3', response.audio);
+     * ```
+     */
+    audio: Buffer;
+    /**
+     * Metadata about the synthesis
+     * @MVP ✅ Implemented
+     */
+    metadata: TTSResponseMetadata;
+    /**
+     * Billing information for cost calculation
+     * @MVP ✅ Implemented
+     */
+    billing: TTSBillingInfo;
+}
+/**
+ * Voice information (for future voice catalog feature)
+ *
+ * @Future 🔮 Not implemented in MVP - used for listVoices() API
+ */
+export interface TTSVoice {
+    /**
+     * Unique voice identifier
+     */
+    id: string;
+    /**
+     * Human-readable voice name
+     */
+    name: string;
+    /**
+     * Language code (e.g., 'en-US', 'de-DE')
+     */
+    language: string;
+    /**
+     * Voice gender
+     */
+    gender: 'male' | 'female' | 'neutral';
+    /**
+     * Provider that offers this voice
+     */
+    provider: TTSProvider;
+    /**
+     * Additional provider-specific metadata
+     */
+    metadata?: TTSVoiceMetadata;
+}
+/**
+ * Provider-specific voice metadata
+ *
+ * @Future 🔮 Not implemented in MVP
+ */
+export interface TTSVoiceMetadata {
+    /**
+     * Voice quality/tier (e.g., 'standard', 'neural', 'premium')
+     */
+    quality?: string;
+    /**
+     * Supported styles (Azure-specific)
+     */
+    styles?: string[];
+    /**
+     * Supported emotions (Azure-specific)
+     */
+    emotions?: string[];
+    /**
+     * Additional properties
+     */
+    [key: string]: unknown;
+}
+/**
+ * Error codes for TTS operations
+ */
+export declare enum TTSErrorCode {
+    INVALID_CONFIG = "INVALID_CONFIG",
+    INVALID_VOICE = "INVALID_VOICE",
+    QUOTA_EXCEEDED = "QUOTA_EXCEEDED",
+    PROVIDER_UNAVAILABLE = "PROVIDER_UNAVAILABLE",
+    SYNTHESIS_FAILED = "SYNTHESIS_FAILED",
+    NETWORK_ERROR = "NETWORK_ERROR",
+    UNKNOWN_ERROR = "UNKNOWN_ERROR"
+}
+//# sourceMappingURL=common.types.d.ts.map

package/dist/middleware/services/tts/types/common.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.types.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/services/tts/types/common.types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;;;GASG;AACH,oBAAY,WAAW;IACrB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB;AAED;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB;;;OAGG;IACH,KAAK,EAAE,WAAW,CAAC;IAEnB;;;;OAIG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IAErB;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,QAAQ,EAAE,mBAAmB,CAAC;IAE9B;;;OAGG;IACH,OAAO,EAAE,cAAc,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,oBAAY,YAAY;IACtB,cAAc,mBAAmB;IACjC,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;IACjC,oBAAoB,yBAAyB;IAC7C,gBAAgB,qBAAqB;IACrC,aAAa,kBAAkB;IAC/B,aAAa,kBAAkB;CAChC"}

package/dist/middleware/services/tts/types/common.types.js

@@ -0,0 +1,42 @@
+"use strict";
+/**
+ * Common types and interfaces for TTS Middleware
+ *
+ * These types form the contract between the TTS middleware and consuming applications.
+ * All provider parameters are pre-typed to prevent breaking API changes when adding new providers.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TTSErrorCode = exports.TTSProvider = void 0;
+/**
+ * Supported TTS providers
+ *
+ * @MVP ✅ AZURE - Microsoft Azure Speech Services (EU-compliant, free tier)
+ * @Current ✅ EDENAI - EdenAI multi-provider aggregator
+ * @Future 🔮 OPENAI - OpenAI TTS API
+ * @Future 🔮 ELEVENLABS - ElevenLabs TTS API
+ * @Future 🔮 GOOGLE - Google Cloud Text-to-Speech
+ * @Future 🔮 DEEPGRAM - Deepgram TTS API
+ */
+var TTSProvider;
+(function (TTSProvider) {
+    TTSProvider["AZURE"] = "azure";
+    TTSProvider["EDENAI"] = "edenai";
+    TTSProvider["OPENAI"] = "openai";
+    TTSProvider["ELEVENLABS"] = "elevenlabs";
+    TTSProvider["GOOGLE"] = "google";
+    TTSProvider["DEEPGRAM"] = "deepgram";
+})(TTSProvider || (exports.TTSProvider = TTSProvider = {}));
+/**
+ * Error codes for TTS operations
+ */
+var TTSErrorCode;
+(function (TTSErrorCode) {
+    TTSErrorCode["INVALID_CONFIG"] = "INVALID_CONFIG";
+    TTSErrorCode["INVALID_VOICE"] = "INVALID_VOICE";
+    TTSErrorCode["QUOTA_EXCEEDED"] = "QUOTA_EXCEEDED";
+    TTSErrorCode["PROVIDER_UNAVAILABLE"] = "PROVIDER_UNAVAILABLE";
+    TTSErrorCode["SYNTHESIS_FAILED"] = "SYNTHESIS_FAILED";
+    TTSErrorCode["NETWORK_ERROR"] = "NETWORK_ERROR";
+    TTSErrorCode["UNKNOWN_ERROR"] = "UNKNOWN_ERROR";
+})(TTSErrorCode || (exports.TTSErrorCode = TTSErrorCode = {}));
+//# sourceMappingURL=common.types.js.map

package/dist/middleware/services/tts/types/common.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.types.js","sourceRoot":"","sources":["../../../../../src/middleware/services/tts/types/common.types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH;;;;;;;;;GASG;AACH,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,gCAAiB,CAAA;IACjB,gCAAiB,CAAA;IACjB,wCAAyB,CAAA;IACzB,gCAAiB,CAAA;IACjB,oCAAqB,CAAA;AACvB,CAAC,EAPW,WAAW,2BAAX,WAAW,QAOtB;AA4SD;;GAEG;AACH,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,+CAA+B,CAAA;IAC/B,iDAAiC,CAAA;IACjC,6DAA6C,CAAA;IAC7C,qDAAqC,CAAA;IACrC,+CAA+B,CAAA;IAC/B,+CAA+B,CAAA;AACjC,CAAC,EARW,YAAY,4BAAZ,YAAY,QAQvB"}

package/dist/middleware/services/tts/types/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * TTS Middleware Types
+ *
+ * Public API exports for all TTS types and interfaces.
+ *
+ * @module @loonylabs/tts-middleware/types
+ */
+export { TTSProvider, TTSErrorCode, AudioFormat, } from './common.types';
+export type { AudioOptions, VoiceConfig, TTSSynthesizeRequest, TTSResponse, TTSResponseMetadata, TTSBillingInfo, TTSVoice, TTSVoiceMetadata, } from './common.types';
+export type { AzureProviderOptions, OpenAIProviderOptions, ElevenLabsProviderOptions, GoogleCloudProviderOptions, DeepgramProviderOptions, EdenAIProviderOptions, ProviderOptions, } from './provider-options.types';
+export { isAzureOptions, isOpenAIOptions, isElevenLabsOptions, isGoogleCloudOptions, isDeepgramOptions, isEdenAIOptions, } from './provider-options.types';
+/**
+ * Re-export all types for convenience
+ *
+ * @example
+ * ```typescript
+ * import type * as TTSTypes from '@loonylabs/tts-middleware/types';
+ * ```
+ */
+export * from './common.types';
+export * from './provider-options.types';
+//# sourceMappingURL=index.d.ts.map

package/dist/middleware/services/tts/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/services/tts/types/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EACL,WAAW,EACX,YAAY,EACZ,WAAW,GACZ,MAAM,gBAAgB,CAAC;AAExB,YAAY,EACV,YAAY,EACZ,WAAW,EACX,oBAAoB,EACpB,WAAW,EACX,mBAAmB,EACnB,cAAc,EACd,QAAQ,EACR,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AAGxB,YAAY,EACV,oBAAoB,EACpB,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,EAC1B,uBAAuB,EACvB,qBAAqB,EACrB,eAAe,GAChB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EACL,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,eAAe,GAChB,MAAM,0BAA0B,CAAC;AAElC;;;;;;;GAOG;AACH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC"}

package/dist/middleware/services/tts/types/index.js

@@ -0,0 +1,46 @@
+"use strict";
+/**
+ * TTS Middleware Types
+ *
+ * Public API exports for all TTS types and interfaces.
+ *
+ * @module @loonylabs/tts-middleware/types
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEdenAIOptions = exports.isDeepgramOptions = exports.isGoogleCloudOptions = exports.isElevenLabsOptions = exports.isOpenAIOptions = exports.isAzureOptions = exports.TTSErrorCode = exports.TTSProvider = void 0;
+// ===== Common Types (Universal) =====
+var common_types_1 = require("./common.types");
+Object.defineProperty(exports, "TTSProvider", { enumerable: true, get: function () { return common_types_1.TTSProvider; } });
+Object.defineProperty(exports, "TTSErrorCode", { enumerable: true, get: function () { return common_types_1.TTSErrorCode; } });
+var provider_options_types_1 = require("./provider-options.types");
+Object.defineProperty(exports, "isAzureOptions", { enumerable: true, get: function () { return provider_options_types_1.isAzureOptions; } });
+Object.defineProperty(exports, "isOpenAIOptions", { enumerable: true, get: function () { return provider_options_types_1.isOpenAIOptions; } });
+Object.defineProperty(exports, "isElevenLabsOptions", { enumerable: true, get: function () { return provider_options_types_1.isElevenLabsOptions; } });
+Object.defineProperty(exports, "isGoogleCloudOptions", { enumerable: true, get: function () { return provider_options_types_1.isGoogleCloudOptions; } });
+Object.defineProperty(exports, "isDeepgramOptions", { enumerable: true, get: function () { return provider_options_types_1.isDeepgramOptions; } });
+Object.defineProperty(exports, "isEdenAIOptions", { enumerable: true, get: function () { return provider_options_types_1.isEdenAIOptions; } });
+/**
+ * Re-export all types for convenience
+ *
+ * @example
+ * ```typescript
+ * import type * as TTSTypes from '@loonylabs/tts-middleware/types';
+ * ```
+ */
+__exportStar(require("./common.types"), exports);
+__exportStar(require("./provider-options.types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/middleware/services/tts/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/middleware/services/tts/types/index.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;;;;;;;;;;;;;;;AAEH,uCAAuC;AACvC,+CAIwB;AAHtB,2GAAA,WAAW,OAAA;AACX,4GAAA,YAAY,OAAA;AA0Bd,mEAOkC;AANhC,wHAAA,cAAc,OAAA;AACd,yHAAA,eAAe,OAAA;AACf,6HAAA,mBAAmB,OAAA;AACnB,8HAAA,oBAAoB,OAAA;AACpB,2HAAA,iBAAiB,OAAA;AACjB,yHAAA,eAAe,OAAA;AAGjB;;;;;;;GAOG;AACH,iDAA+B;AAC/B,2DAAyC"}