@loonylabs/tts-middleware 0.1.1

package/dist/middleware/shared/config/tts.config.d.ts

@@ -0,0 +1,147 @@
+/**
+ * TTS Middleware Configuration
+ *
+ * @description Central configuration for TTS middleware
+ * Manages environment variables, provider settings, and validation
+ *
+ * @critical Configuration errors can prevent synthesis - validate early
+ */
+import { TTSProvider } from '../../services/tts/types';
+/**
+ * Azure Speech Services Configuration
+ */
+export interface AzureConfig {
+    /**
+     * Azure Speech Services subscription key
+     * @env AZURE_SPEECH_KEY
+     * @required true
+     * @example 'abc123def456...'
+     */
+    KEY: string;
+    /**
+     * Azure region for Speech Services
+     * @env AZURE_SPEECH_REGION
+     * @required true
+     * @default 'germanywestcentral'
+     * @example 'germanywestcentral', 'westus', 'eastus'
+     */
+    REGION: string;
+    /**
+     * Custom Azure Speech endpoint (optional)
+     * @env AZURE_SPEECH_ENDPOINT
+     * @required false
+     * @example 'https://germanywestcentral.tts.speech.microsoft.com'
+     */
+    ENDPOINT?: string;
+    /**
+     * DSGVO/GDPR compliance flag
+     * @description When true, uses EU-based regions for data processing
+     * @default true (for German region)
+     */
+    DSGVO_COMPLIANT: boolean;
+    /**
+     * Free tier character limit per month
+     * @description Azure Free Tier: 500,000 characters/month
+     * @see https://azure.microsoft.com/en-us/pricing/details/cognitive-services/speech-services/
+     */
+    FREE_TIER_CHARS_PER_MONTH: number;
+}
+/**
+ * EdenAI Configuration
+ */
+export interface EdenAIConfig {
+    /**
+     * EdenAI API key
+     * @env EDENAI_API_KEY
+     * @required true
+     * @example 'edenai_xxx...'
+     */
+    API_KEY: string;
+}
+/**
+ * TTS Middleware Configuration Object
+ */
+export interface TTSConfig {
+    /**
+     * Default TTS provider
+     * @env TTS_DEFAULT_PROVIDER
+     * @default 'azure'
+     */
+    DEFAULT_PROVIDER: TTSProvider;
+    /**
+     * Azure Speech Services configuration
+     */
+    AZURE: AzureConfig;
+    /**
+     * EdenAI configuration
+     */
+    EDENAI: EdenAIConfig;
+    /**
+     * Enable debug logging
+     * @env TTS_DEBUG
+     * @default false
+     */
+    DEBUG: boolean;
+    /**
+     * Maximum text length per synthesis request
+     * @description Prevents excessive API costs
+     * @default 3000 (Azure limit)
+     */
+    MAX_TEXT_LENGTH: number;
+    /**
+     * Default audio format
+     * @default 'mp3'
+     */
+    DEFAULT_AUDIO_FORMAT: 'mp3' | 'wav' | 'opus';
+    /**
+     * Default sample rate in Hz
+     * @default 24000
+     */
+    DEFAULT_SAMPLE_RATE: number;
+}
+/**
+ * Load and validate TTS configuration from environment variables
+ *
+ * @returns {TTSConfig} Validated TTS configuration
+ * @throws {Error} If required environment variables are missing
+ *
+ * @example
+ * ```typescript
+ * const config = getTTSConfig();
+ * console.log(config.AZURE.REGION); // 'germanywestcentral'
+ * ```
+ */
+export declare function getTTSConfig(): TTSConfig;
+/**
+ * Validate TTS configuration
+ *
+ * @param {TTSConfig} config - Configuration to validate
+ * @throws {Error} If configuration is invalid
+ *
+ * @description
+ * Validates that all required configuration values are present and valid.
+ * Should be called before initializing TTS services.
+ *
+ * @example
+ * ```typescript
+ * const config = getTTSConfig();
+ * validateTTSConfig(config);
+ * // If validation passes, config is safe to use
+ * ```
+ */
+export declare function validateTTSConfig(config: TTSConfig): void;
+/**
+ * Singleton TTS configuration instance
+ *
+ * @description
+ * Pre-loaded and validated configuration for easy access across the application.
+ * Use this instead of calling getTTSConfig() multiple times.
+ *
+ * @example
+ * ```typescript
+ * import { TTS_CONFIG } from './tts.config';
+ * console.log(TTS_CONFIG.AZURE.REGION);
+ * ```
+ */
+export declare const TTS_CONFIG: TTSConfig;
+//# sourceMappingURL=tts.config.d.ts.map

package/dist/middleware/shared/config/tts.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tts.config.d.ts","sourceRoot":"","sources":["../../../../src/middleware/shared/config/tts.config.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,yBAAyB,EAAE,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,gBAAgB,EAAE,WAAW,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,WAAW,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;;OAIG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,oBAAoB,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAE7C;;;OAGG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,IAAI,SAAS,CAyCxC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CAyEzD;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,EAAE,SAA0B,CAAC"}

package/dist/middleware/shared/config/tts.config.js

@@ -0,0 +1,162 @@
+"use strict";
+/**
+ * TTS Middleware Configuration
+ *
+ * @description Central configuration for TTS middleware
+ * Manages environment variables, provider settings, and validation
+ *
+ * @critical Configuration errors can prevent synthesis - validate early
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TTS_CONFIG = void 0;
+exports.getTTSConfig = getTTSConfig;
+exports.validateTTSConfig = validateTTSConfig;
+const types_1 = require("../../services/tts/types");
+/**
+ * Load and validate TTS configuration from environment variables
+ *
+ * @returns {TTSConfig} Validated TTS configuration
+ * @throws {Error} If required environment variables are missing
+ *
+ * @example
+ * ```typescript
+ * const config = getTTSConfig();
+ * console.log(config.AZURE.REGION); // 'germanywestcentral'
+ * ```
+ */
+function getTTSConfig() {
+    // Read environment variables
+    const azureKey = process.env.AZURE_SPEECH_KEY || '';
+    const azureRegion = process.env.AZURE_SPEECH_REGION?.trim() || 'germanywestcentral';
+    const azureEndpoint = process.env.AZURE_SPEECH_ENDPOINT;
+    const edenaiApiKey = process.env.EDENAI_API_KEY || '';
+    const defaultProvider = process.env.TTS_DEFAULT_PROVIDER || types_1.TTSProvider.AZURE;
+    const debug = process.env.TTS_DEBUG === 'true';
+    // Determine DSGVO compliance based on region
+    const euRegions = [
+        'germanywestcentral',
+        'northeurope',
+        'westeurope',
+        'francecentral',
+        'switzerlandnorth',
+        'uksouth',
+    ];
+    const isDsgvoCompliant = euRegions.includes(azureRegion.toLowerCase());
+    // Build configuration object
+    const config = {
+        DEFAULT_PROVIDER: defaultProvider,
+        AZURE: {
+            KEY: azureKey,
+            REGION: azureRegion,
+            ENDPOINT: azureEndpoint,
+            DSGVO_COMPLIANT: isDsgvoCompliant,
+            FREE_TIER_CHARS_PER_MONTH: 500000,
+        },
+        EDENAI: {
+            API_KEY: edenaiApiKey,
+        },
+        DEBUG: debug,
+        MAX_TEXT_LENGTH: 3000,
+        DEFAULT_AUDIO_FORMAT: 'mp3',
+        DEFAULT_SAMPLE_RATE: 24000,
+    };
+    return config;
+}
+/**
+ * Validate TTS configuration
+ *
+ * @param {TTSConfig} config - Configuration to validate
+ * @throws {Error} If configuration is invalid
+ *
+ * @description
+ * Validates that all required configuration values are present and valid.
+ * Should be called before initializing TTS services.
+ *
+ * @example
+ * ```typescript
+ * const config = getTTSConfig();
+ * validateTTSConfig(config);
+ * // If validation passes, config is safe to use
+ * ```
+ */
+function validateTTSConfig(config) {
+    const errors = [];
+    // Validate default provider
+    if (!config.DEFAULT_PROVIDER) {
+        errors.push('DEFAULT_PROVIDER is required');
+    }
+    const validProviders = Object.values(types_1.TTSProvider);
+    if (!validProviders.includes(config.DEFAULT_PROVIDER)) {
+        errors.push(`DEFAULT_PROVIDER must be one of: ${validProviders.join(', ')}`);
+    }
+    // Validate Azure configuration (required for MVP)
+    if (config.DEFAULT_PROVIDER === types_1.TTSProvider.AZURE) {
+        if (!config.AZURE.KEY) {
+            errors.push('AZURE_SPEECH_KEY is required when using Azure provider (set in environment variable)');
+        }
+        if (!config.AZURE.REGION) {
+            errors.push('AZURE_SPEECH_REGION is required when using Azure provider (set in environment variable)');
+        }
+        // Validate region format (should be lowercase, no spaces)
+        if (config.AZURE.REGION && /\s/.test(config.AZURE.REGION)) {
+            errors.push('AZURE_SPEECH_REGION cannot contain spaces');
+        }
+        // Validate key format (should be alphanumeric, allow hyphens for testing)
+        if (config.AZURE.KEY &&
+            !/^[a-zA-Z0-9-]+$/.test(config.AZURE.KEY) &&
+            config.AZURE.KEY !== '') {
+            errors.push('AZURE_SPEECH_KEY should be alphanumeric');
+        }
+        // Validate endpoint format if provided
+        if (config.AZURE.ENDPOINT && !config.AZURE.ENDPOINT.startsWith('https://')) {
+            errors.push('AZURE_SPEECH_ENDPOINT must start with https://');
+        }
+    }
+    // Validate EdenAI configuration (if used as default provider)
+    if (config.DEFAULT_PROVIDER === types_1.TTSProvider.EDENAI) {
+        if (!config.EDENAI.API_KEY) {
+            errors.push('EDENAI_API_KEY is required when using EdenAI provider (set in environment variable)');
+        }
+    }
+    // Validate numeric values
+    if (config.MAX_TEXT_LENGTH <= 0) {
+        errors.push('MAX_TEXT_LENGTH must be greater than 0');
+    }
+    if (config.DEFAULT_SAMPLE_RATE <= 0) {
+        errors.push('DEFAULT_SAMPLE_RATE must be greater than 0');
+    }
+    // Throw if any errors
+    if (errors.length > 0) {
+        throw new Error(`TTS Configuration validation failed:\n- ${errors.join('\n- ')}`);
+    }
+}
+/**
+ * Singleton TTS configuration instance
+ *
+ * @description
+ * Pre-loaded and validated configuration for easy access across the application.
+ * Use this instead of calling getTTSConfig() multiple times.
+ *
+ * @example
+ * ```typescript
+ * import { TTS_CONFIG } from './tts.config';
+ * console.log(TTS_CONFIG.AZURE.REGION);
+ * ```
+ */
+exports.TTS_CONFIG = getTTSConfig();
+// Validate configuration on module load (fail fast)
+try {
+    validateTTSConfig(exports.TTS_CONFIG);
+}
+catch (error) {
+    if (exports.TTS_CONFIG.DEBUG) {
+        console.warn('[TTS Config] Validation failed:', error.message);
+    }
+    // Don't throw in tests or when key is not set (allows testing without credentials)
+    if (process.env.NODE_ENV !== 'test' &&
+        exports.TTS_CONFIG.DEFAULT_PROVIDER === types_1.TTSProvider.AZURE &&
+        exports.TTS_CONFIG.AZURE.KEY) {
+        throw error;
+    }
+}
+//# sourceMappingURL=tts.config.js.map

package/dist/middleware/shared/config/tts.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tts.config.js","sourceRoot":"","sources":["../../../../src/middleware/shared/config/tts.config.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAyHH,oCAyCC;AAmBD,8CAyEC;AA5PD,oDAAuD;AA2GvD;;;;;;;;;;;GAWG;AACH,SAAgB,YAAY;IAC1B,6BAA6B;IAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAC;IACpD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,EAAE,IAAI,oBAAoB,CAAC;IACpF,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;IACxD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,EAAE,CAAC;IACtD,MAAM,eAAe,GAClB,OAAO,CAAC,GAAG,CAAC,oBAAoC,IAAI,mBAAW,CAAC,KAAK,CAAC;IACzE,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,MAAM,CAAC;IAE/C,6CAA6C;IAC7C,MAAM,SAAS,GAAG;QAChB,oBAAoB;QACpB,aAAa;QACb,YAAY;QACZ,eAAe;QACf,kBAAkB;QAClB,SAAS;KACV,CAAC;IACF,MAAM,gBAAgB,GAAG,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC;IAEvE,6BAA6B;IAC7B,MAAM,MAAM,GAAc;QACxB,gBAAgB,EAAE,eAAe;QACjC,KAAK,EAAE;YACL,GAAG,EAAE,QAAQ;YACb,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,aAAa;YACvB,eAAe,EAAE,gBAAgB;YACjC,yBAAyB,EAAE,MAAO;SACnC;QACD,MAAM,EAAE;YACN,OAAO,EAAE,YAAY;SACtB;QACD,KAAK,EAAE,KAAK;QACZ,eAAe,EAAE,IAAI;QACrB,oBAAoB,EAAE,KAAK;QAC3B,mBAAmB,EAAE,KAAK;KAC3B,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,iBAAiB,CAAC,MAAiB;IACjD,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,4BAA4B;IAC5B,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,mBAAW,CAAC,CAAC;IAClD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACtD,MAAM,CAAC,IAAI,CACT,oCAAoC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAChE,CAAC;IACJ,CAAC;IAED,kDAAkD;IAClD,IAAI,MAAM,CAAC,gBAAgB,KAAK,mBAAW,CAAC,KAAK,EAAE,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACtB,MAAM,CAAC,IAAI,CACT,sFAAsF,CACvF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM,CAAC,IAAI,CACT,yFAAyF,CAC1F,CAAC;QACJ,CAAC;QAED,0DAA0D;QAC1D,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1D,MAAM,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;QAC3D,CAAC;QAED,0EAA0E;QAC1E,IACE,MAAM,CAAC,KAAK,CAAC,GAAG;YAChB,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;YACzC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE,EACvB,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;QACzD,CAAC;QAED,uCAAuC;QACvC,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC3E,MAAM,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAED,8DAA8D;IAC9D,IAAI,MAAM,CAAC,gBAAgB,KAAK,mBAAW,CAAC,MAAM,EAAE,CAAC;QACnD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CACT,qFAAqF,CACtF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,0BAA0B;IAC1B,IAAI,MAAM,CAAC,eAAe,IAAI,CAAC,EAAE,CAAC;QAChC,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,MAAM,CAAC,mBAAmB,IAAI,CAAC,EAAE,CAAC;QACpC,MAAM,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;IAC5D,CAAC;IAED,sBAAsB;IACtB,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CACb,2CAA2C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CACjE,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACU,QAAA,UAAU,GAAc,YAAY,EAAE,CAAC;AAEpD,oDAAoD;AACpD,IAAI,CAAC;IACH,iBAAiB,CAAC,kBAAU,CAAC,CAAC;AAChC,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,IAAI,kBAAU,CAAC,KAAK,EAAE,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAG,KAAe,CAAC,OAAO,CAAC,CAAC;IAC5E,CAAC;IACD,mFAAmF;IACnF,IACE,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM;QAC/B,kBAAU,CAAC,gBAAgB,KAAK,mBAAW,CAAC,KAAK;QACjD,kBAAU,CAAC,KAAK,CAAC,GAAG,EACpB,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@loonylabs/tts-middleware",
+  "version": "0.1.1",
+  "description": "Provider-agnostic Text-to-Speech middleware for Azure, OpenAI, ElevenLabs, Google Cloud, and Deepgram",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "test:ci": "jest --ci --coverage --maxWorkers=2",
+    "lint": "eslint src --ext .ts",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "clean": "rm -rf dist coverage",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run test:ci && npm run lint"
+  },
+  "keywords": [
+    "tts",
+    "text-to-speech",
+    "azure",
+    "openai",
+    "elevenlabs",
+    "google-cloud",
+    "deepgram",
+    "middleware",
+    "provider-agnostic",
+    "speech-synthesis",
+    "voice-generation",
+    "ai-speech"
+  ],
+  "author": "LoonyLabs Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/loonylabs-dev/tts-middleware.git"
+  },
+  "bugs": {
+    "url": "https://github.com/loonylabs-dev/tts-middleware/issues"
+  },
+  "homepage": "https://github.com/loonylabs-dev/tts-middleware#readme",
+  "dependencies": {
+    "microsoft-cognitiveservices-speech-sdk": "^1.38.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.8",
+    "@types/node": "^20.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.0",
+    "@typescript-eslint/parser": "^6.13.0",
+    "eslint": "^8.54.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.1.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.2"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "roots": [
+      "<rootDir>/src"
+    ],
+    "testMatch": [
+      "**/__tests__/**/*.test.ts"
+    ],
+    "collectCoverageFrom": [
+      "src/**/*.ts",
+      "!src/**/*.d.ts",
+      "!src/**/index.ts"
+    ],
+    "coverageDirectory": "coverage",
+    "coverageReporters": [
+      "text",
+      "html",
+      "lcov"
+    ],
+    "coverageThreshold": {
+      "global": {
+        "branches": 85,
+        "functions": 90,
+        "lines": 90,
+        "statements": 90
+      }
+    }
+  }
+}