@juspay/neurolink 8.16.0 → 8.17.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [8.17.0](https://github.com/juspay/neurolink/compare/v8.16.0...v8.17.0) (2025-12-16)
+
+### Features
+
+- **(tts):** Add TTS type integration to GenerateOptions, GenerateResult, and StreamChunk ([e290330](https://github.com/juspay/neurolink/commit/e290330e8fe22a4cd0427185cbddbb8856fbd5ca))
+
 ## [8.16.0](https://github.com/juspay/neurolink/compare/v8.15.0...v8.16.0) (2025-12-16)
 
 ### Features

package/dist/lib/types/generateTypes.d.ts

@@ -7,6 +7,7 @@ import type { ChatMessage, ConversationMemoryConfig } from "./conversation.js";
 import type { MiddlewareFactoryOptions } from "./middlewareTypes.js";
 import type { JsonValue } from "./common.js";
 import type { Content, ImageWithAltText } from "./content.js";
+import type { TTSOptions, TTSResult } from "./ttsTypes.js";
 /**
  * Generate function options type - Primary method for content generation
  * Supports multimodal content while maintaining backward compatibility
@@ -52,6 +53,39 @@ export type GenerateOptions = {
         format?: "jpeg" | "png";
         transcribeAudio?: boolean;
     };
+    /**
+     * Text-to-Speech (TTS) configuration
+     *
+     * Enable audio generation from the text response. The generated audio will be
+     * returned in the result's `audio` field as a TTSResult object.
+     *
+     * @example Basic TTS
+     * ```typescript
+     * const result = await neurolink.generate({
+     *   input: { text: "Tell me a story" },
+     *   provider: "google-ai",
+     *   tts: { enabled: true, voice: "en-US-Neural2-C" }
+     * });
+     * console.log(result.audio?.buffer); // Audio Buffer
+     * ```
+     *
+     * @example Advanced TTS with options
+     * ```typescript
+     * const result = await neurolink.generate({
+     *   input: { text: "Speak slowly and clearly" },
+     *   provider: "google-ai",
+     *   tts: {
+     *     enabled: true,
+     *     voice: "en-US-Neural2-D",
+     *     speed: 0.8,
+     *     pitch: 2.0,
+     *     format: "mp3",
+     *     quality: "standard"
+     *   }
+     * });
+     * ```
+     */
+    tts?: TTSOptions;
     provider?: AIProviderName | string;
     model?: string;
     region?: string;
@@ -144,6 +178,35 @@ export type GenerateResult = {
     outputs?: {
         text: string;
     };
+    /**
+     * Text-to-Speech audio result
+     *
+     * Contains the generated audio buffer and metadata when TTS is enabled.
+     * Generated by TTSProcessor.synthesize() using the specified provider.
+     *
+     * @example Accessing TTS audio
+     * ```typescript
+     * const result = await neurolink.generate({
+     *   input: { text: "Hello world" },
+     *   provider: "google-ai",
+     *   tts: { enabled: true, voice: "en-US-Neural2-C" }
+     * });
+     *
+     * if (result.audio) {
+     *   console.log(`Audio size: ${result.audio.size} bytes`);
+     *   console.log(`Format: ${result.audio.format}`);
+     *   if (result.audio.duration) {
+     *     console.log(`Duration: ${result.audio.duration}s`);
+     *   }
+     *   if (result.audio.voice) {
+     *     console.log(`Voice: ${result.audio.voice}`);
+     *   }
+     *   // Save or play the audio buffer
+     *   fs.writeFileSync('output.mp3', result.audio.buffer);
+     * }
+     * ```
+     */
+    audio?: TTSResult;
     provider?: string;
     model?: string;
     usage?: TokenUsage;

package/dist/lib/types/streamTypes.d.ts

@@ -9,6 +9,7 @@ import type { EvaluationData } from "../index.js";
 import type { UnknownRecord, JsonValue } from "./common.js";
 import type { MiddlewareFactoryOptions } from "../types/middlewareTypes.js";
 import type { ChatMessage } from "./conversation.js";
+import type { TTSOptions, TTSChunk } from "./ttsTypes.js";
 /**
  * Progress tracking and metadata for streaming operations
  */
@@ -121,6 +122,60 @@ export type AudioChunk = {
     channels: number;
     encoding: PCMEncoding;
 };
+/**
+ * Stream chunk type using discriminated union for type safety
+ *
+ * Used in streaming responses to deliver either text or TTS audio chunks.
+ * The discriminated union ensures type safety - only one variant can exist at a time.
+ *
+ * @example Processing text chunks
+ * ```typescript
+ * for await (const chunk of result.stream) {
+ *   if (chunk.type === "text") {
+ *     console.log(chunk.content); // TypeScript knows 'content' exists
+ *   }
+ * }
+ * ```
+ *
+ * @example Processing audio chunks
+ * ```typescript
+ * const audioBuffer: Buffer[] = [];
+ * for await (const chunk of result.stream) {
+ *   if (chunk.type === "audio") {
+ *     audioBuffer.push(chunk.audioChunk.data); // TypeScript knows 'audioChunk' exists
+ *     if (chunk.audioChunk.isFinal) {
+ *       const fullAudio = Buffer.concat(audioBuffer);
+ *       fs.writeFileSync('output.mp3', fullAudio);
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @example Processing both text and audio
+ * ```typescript
+ * for await (const chunk of result.stream) {
+ *   switch (chunk.type) {
+ *     case "text":
+ *       process.stdout.write(chunk.content);
+ *       break;
+ *     case "audio":
+ *       playAudioChunk(chunk.audioChunk.data);
+ *       break;
+ *   }
+ * }
+ * ```
+ */
+export type StreamChunk = {
+    /** Discriminator for text chunks */
+    type: "text";
+    /** Text content chunk */
+    content: string;
+} | {
+    /** Discriminator for audio chunks */
+    type: "audio";
+    /** TTS audio chunk data */
+    audioChunk: TTSChunk;
+};
 export type StreamOptions = {
     input: {
         text: string;
@@ -168,6 +223,46 @@ export type StreamOptions = {
         format?: "jpeg" | "png";
         transcribeAudio?: boolean;
     };
+    /**
+     * Text-to-Speech (TTS) configuration for streaming
+     *
+     * Enable audio generation from the streamed text response. Audio chunks will be
+     * delivered through the stream alongside text chunks as TTSChunk objects.
+     *
+     * @example Basic streaming TTS
+     * ```typescript
+     * const result = await neurolink.stream({
+     *   input: { text: "Tell me a story" },
+     *   provider: "google-ai",
+     *   tts: { enabled: true, voice: "en-US-Neural2-C" }
+     * });
+     *
+     * for await (const chunk of result.stream) {
+     *   if (chunk.type === "text") {
+     *     process.stdout.write(chunk.content);
+     *   } else if (chunk.type === "audio") {
+     *     // Handle audio chunk
+     *     playAudioChunk(chunk.audioChunk.data);
+     *   }
+     * }
+     * ```
+     *
+     * @example Advanced streaming TTS with audio buffer
+     * ```typescript
+     * const result = await neurolink.stream({
+     *   input: { text: "Speak slowly" },
+     *   provider: "google-ai",
+     *   tts: {
+     *     enabled: true,
+     *     voice: "en-US-Neural2-D",
+     *     speed: 0.8,
+     *     format: "mp3",
+     *     quality: "hd"
+     *   }
+     * });
+     * ```
+     */
+    tts?: TTSOptions;
     provider?: AIProviderName | string;
     model?: string;
     region?: string;

package/dist/lib/types/ttsTypes.d.ts

@@ -114,3 +114,27 @@ export declare function isTTSResult(value: unknown): value is TTSResult;
  * Type guard to check if TTSOptions are valid
  */
 export declare function isValidTTSOptions(options: unknown): options is TTSOptions;
+/**
+ * TTS audio chunk for streaming Text-to-Speech output
+ *
+ * Represents a chunk of audio data generated during streaming TTS.
+ * Used in StreamChunk type to deliver audio alongside text content.
+ */
+export type TTSChunk = {
+    /** Audio data chunk as Buffer */
+    data: Buffer;
+    /** Audio format of this chunk */
+    format: AudioFormat;
+    /** Chunk sequence number (0-indexed) */
+    index: number;
+    /** Whether this is the final audio chunk */
+    isFinal: boolean;
+    /** Cumulative audio size in bytes so far */
+    cumulativeSize?: number;
+    /** Estimated total duration in seconds (if available) */
+    estimatedDuration?: number;
+    /** Voice used for generation */
+    voice?: string;
+    /** Sample rate in Hz */
+    sampleRate?: number;
+};

package/dist/types/generateTypes.d.ts

@@ -7,6 +7,7 @@ import type { ChatMessage, ConversationMemoryConfig } from "./conversation.js";
 import type { MiddlewareFactoryOptions } from "./middlewareTypes.js";
 import type { JsonValue } from "./common.js";
 import type { Content, ImageWithAltText } from "./content.js";
+import type { TTSOptions, TTSResult } from "./ttsTypes.js";
 /**
  * Generate function options type - Primary method for content generation
  * Supports multimodal content while maintaining backward compatibility
@@ -52,6 +53,39 @@ export type GenerateOptions = {
         format?: "jpeg" | "png";
         transcribeAudio?: boolean;
     };
+    /**
+     * Text-to-Speech (TTS) configuration
+     *
+     * Enable audio generation from the text response. The generated audio will be
+     * returned in the result's `audio` field as a TTSResult object.
+     *
+     * @example Basic TTS
+     * ```typescript
+     * const result = await neurolink.generate({
+     *   input: { text: "Tell me a story" },
+     *   provider: "google-ai",
+     *   tts: { enabled: true, voice: "en-US-Neural2-C" }
+     * });
+     * console.log(result.audio?.buffer); // Audio Buffer
+     * ```
+     *
+     * @example Advanced TTS with options
+     * ```typescript
+     * const result = await neurolink.generate({
+     *   input: { text: "Speak slowly and clearly" },
+     *   provider: "google-ai",
+     *   tts: {
+     *     enabled: true,
+     *     voice: "en-US-Neural2-D",
+     *     speed: 0.8,
+     *     pitch: 2.0,
+     *     format: "mp3",
+     *     quality: "standard"
+     *   }
+     * });
+     * ```
+     */
+    tts?: TTSOptions;
     provider?: AIProviderName | string;
     model?: string;
     region?: string;
@@ -144,6 +178,35 @@ export type GenerateResult = {
     outputs?: {
         text: string;
     };
+    /**
+     * Text-to-Speech audio result
+     *
+     * Contains the generated audio buffer and metadata when TTS is enabled.
+     * Generated by TTSProcessor.synthesize() using the specified provider.
+     *
+     * @example Accessing TTS audio
+     * ```typescript
+     * const result = await neurolink.generate({
+     *   input: { text: "Hello world" },
+     *   provider: "google-ai",
+     *   tts: { enabled: true, voice: "en-US-Neural2-C" }
+     * });
+     *
+     * if (result.audio) {
+     *   console.log(`Audio size: ${result.audio.size} bytes`);
+     *   console.log(`Format: ${result.audio.format}`);
+     *   if (result.audio.duration) {
+     *     console.log(`Duration: ${result.audio.duration}s`);
+     *   }
+     *   if (result.audio.voice) {
+     *     console.log(`Voice: ${result.audio.voice}`);
+     *   }
+     *   // Save or play the audio buffer
+     *   fs.writeFileSync('output.mp3', result.audio.buffer);
+     * }
+     * ```
+     */
+    audio?: TTSResult;
     provider?: string;
     model?: string;
     usage?: TokenUsage;

package/dist/types/streamTypes.d.ts

@@ -9,6 +9,7 @@ import type { EvaluationData } from "../index.js";
 import type { UnknownRecord, JsonValue } from "./common.js";
 import type { MiddlewareFactoryOptions } from "../types/middlewareTypes.js";
 import type { ChatMessage } from "./conversation.js";
+import type { TTSOptions, TTSChunk } from "./ttsTypes.js";
 /**
  * Progress tracking and metadata for streaming operations
  */
@@ -121,6 +122,60 @@ export type AudioChunk = {
     channels: number;
     encoding: PCMEncoding;
 };
+/**
+ * Stream chunk type using discriminated union for type safety
+ *
+ * Used in streaming responses to deliver either text or TTS audio chunks.
+ * The discriminated union ensures type safety - only one variant can exist at a time.
+ *
+ * @example Processing text chunks
+ * ```typescript
+ * for await (const chunk of result.stream) {
+ *   if (chunk.type === "text") {
+ *     console.log(chunk.content); // TypeScript knows 'content' exists
+ *   }
+ * }
+ * ```
+ *
+ * @example Processing audio chunks
+ * ```typescript
+ * const audioBuffer: Buffer[] = [];
+ * for await (const chunk of result.stream) {
+ *   if (chunk.type === "audio") {
+ *     audioBuffer.push(chunk.audioChunk.data); // TypeScript knows 'audioChunk' exists
+ *     if (chunk.audioChunk.isFinal) {
+ *       const fullAudio = Buffer.concat(audioBuffer);
+ *       fs.writeFileSync('output.mp3', fullAudio);
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @example Processing both text and audio
+ * ```typescript
+ * for await (const chunk of result.stream) {
+ *   switch (chunk.type) {
+ *     case "text":
+ *       process.stdout.write(chunk.content);
+ *       break;
+ *     case "audio":
+ *       playAudioChunk(chunk.audioChunk.data);
+ *       break;
+ *   }
+ * }
+ * ```
+ */
+export type StreamChunk = {
+    /** Discriminator for text chunks */
+    type: "text";
+    /** Text content chunk */
+    content: string;
+} | {
+    /** Discriminator for audio chunks */
+    type: "audio";
+    /** TTS audio chunk data */
+    audioChunk: TTSChunk;
+};
 export type StreamOptions = {
     input: {
         text: string;
@@ -168,6 +223,46 @@ export type StreamOptions = {
         format?: "jpeg" | "png";
         transcribeAudio?: boolean;
     };
+    /**
+     * Text-to-Speech (TTS) configuration for streaming
+     *
+     * Enable audio generation from the streamed text response. Audio chunks will be
+     * delivered through the stream alongside text chunks as TTSChunk objects.
+     *
+     * @example Basic streaming TTS
+     * ```typescript
+     * const result = await neurolink.stream({
+     *   input: { text: "Tell me a story" },
+     *   provider: "google-ai",
+     *   tts: { enabled: true, voice: "en-US-Neural2-C" }
+     * });
+     *
+     * for await (const chunk of result.stream) {
+     *   if (chunk.type === "text") {
+     *     process.stdout.write(chunk.content);
+     *   } else if (chunk.type === "audio") {
+     *     // Handle audio chunk
+     *     playAudioChunk(chunk.audioChunk.data);
+     *   }
+     * }
+     * ```
+     *
+     * @example Advanced streaming TTS with audio buffer
+     * ```typescript
+     * const result = await neurolink.stream({
+     *   input: { text: "Speak slowly" },
+     *   provider: "google-ai",
+     *   tts: {
+     *     enabled: true,
+     *     voice: "en-US-Neural2-D",
+     *     speed: 0.8,
+     *     format: "mp3",
+     *     quality: "hd"
+     *   }
+     * });
+     * ```
+     */
+    tts?: TTSOptions;
     provider?: AIProviderName | string;
     model?: string;
     region?: string;

package/dist/types/ttsTypes.d.ts

@@ -114,3 +114,27 @@ export declare function isTTSResult(value: unknown): value is TTSResult;
  * Type guard to check if TTSOptions are valid
  */
 export declare function isValidTTSOptions(options: unknown): options is TTSOptions;
+/**
+ * TTS audio chunk for streaming Text-to-Speech output
+ *
+ * Represents a chunk of audio data generated during streaming TTS.
+ * Used in StreamChunk type to deliver audio alongside text content.
+ */
+export type TTSChunk = {
+    /** Audio data chunk as Buffer */
+    data: Buffer;
+    /** Audio format of this chunk */
+    format: AudioFormat;
+    /** Chunk sequence number (0-indexed) */
+    index: number;
+    /** Whether this is the final audio chunk */
+    isFinal: boolean;
+    /** Cumulative audio size in bytes so far */
+    cumulativeSize?: number;
+    /** Estimated total duration in seconds (if available) */
+    estimatedDuration?: number;
+    /** Voice used for generation */
+    voice?: string;
+    /** Sample rate in Hz */
+    sampleRate?: number;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juspay/neurolink",
-  "version": "8.16.0",
+  "version": "8.17.0",
   "description": "Universal AI Development Platform with working MCP integration, multi-provider support, and professional CLI. Built-in tools operational, 58+ external MCP servers discoverable. Connect to filesystem, GitHub, database operations, and more. Build, test, and deploy AI applications with 9 major providers: OpenAI, Anthropic, Google AI, AWS Bedrock, Azure, Hugging Face, Ollama, and Mistral AI.",
   "author": {
     "name": "Juspay Technologies",