ssml-builder-js 2.15.0 → 2.17.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { AudioElement, AzureDiagnosticCode, AzureLanguageNormalizationOptions, AzureSsmlValidationOptions, AzureUrlValidationResult, AzureUrlValidationRunnerOptions, AzureUrlValidator, AzureValidationOptions, AzureVoiceCatalogMetadata, AzureVoiceDefinition, AzureVoiceMetadata, BookmarkElement, BreakElement, BuildPartialSsmlOptions, CustomElement, EmphasisElement, ExpressAsElement, ExtractSsmlTranslatableTextOptions, FromPlainTextToSsmlOptions, LangElement, LexiconElement, MapSsmlTextNodesOptions, MarkElement, MsttsAudioDurationElement, MsttsEmbeddingElement, MsttsSilenceElement, MsttsTtsEmbeddingElement, MsttsVisemeElement, MsttsVoiceConversionElement, NamedElement, ParagraphElement, PhonemeElement, ProsodyElement, SayAsElement, SentenceElement, SplitSsmlOptions, SsmlAttributeValue, SsmlAttributes, SsmlBackgroundAudioNode, SsmlBreakElement, SsmlChunk, SsmlChunkContext, SsmlDiagnostic, SsmlDiagnosticSeverity, SsmlDiagnosticSource, SsmlDialogNode, SsmlDocument, SsmlElement, SsmlElementBase, SsmlEmbeddingNode, SsmlExpressAsElement, SsmlNode, SsmlPartialContext, SsmlPartialProsody, SsmlPartialVoice, SsmlPhonemeElement, SsmlProsodyElement, SsmlSayAsElement, SsmlSourceMap, SsmlSourceMarker, SsmlSourceTextSegment, SsmlStructureIntegrityResult, SsmlStructureMismatch, SsmlText, SsmlTextNodeContext, SsmlTextRange, SsmlTtsEmbeddingNode, SsmlTurnNode, SsmlValidationError, SsmlVoiceConversionNode, SsmlVoiceElement, SubElement, VoiceElement, WordElement, areAzureLanguagesEquivalent, buildPartialSsml, buildSsml, createAzureUrlValidatorRunner, extractSsmlText, extractSsmlTranslatableText, fromPlainTextToSsml, getAzureVoiceCatalogMetadata, getBuiltInVoiceCatalogMetadata, getSsmlSourceMap, isValidAzureAudioDuration, mapSsmlTextNodes, normalizeAzureLanguage, parseSsml, splitSsmlDocument, validateAzureSsml, validateSsml, validateSsmlStructureIntegrity } from './core.js';
-import { S as SsmlTextRange, a as SsmlSourceTextSegment, b as SsmlSourceMarker, c as SsmlDiagnostic, A as AzureValidationOptions } from './index.d-8BvkB9gz.js';
+export { AudioElement, AzureDiagnosticCode, AzureLanguageNormalizationOptions, AzureSsmlValidationOptions, AzureUrlValidationResult, AzureUrlValidationRunnerOptions, AzureUrlValidator, AzureValidationOptions, AzureVoiceCatalogMetadata, AzureVoiceDefinition, AzureVoiceMetadata, BookmarkElement, BreakElement, BuildPartialSsmlOptions, CustomElement, Diagnostic, EmphasisElement, ExpressAsElement, ExtractSsmlTranslatableTextOptions, FromPlainTextToSsmlOptions, LangElement, LexiconElement, MapSsmlTextNodesOptions, MarkElement, MsttsAudioDurationElement, MsttsEmbeddingElement, MsttsSilenceElement, MsttsTtsEmbeddingElement, MsttsVisemeElement, MsttsVoiceConversionElement, NamedElement, ParagraphElement, PhonemeElement, ProsodyElement, SayAsElement, SentenceElement, SplitSsmlOptions, SsmlAttributeValue, SsmlAttributes, SsmlBackgroundAudioNode, SsmlBreakElement, SsmlChunk, SsmlChunkContext, SsmlDiagnostic, SsmlDiagnosticSeverity, SsmlDiagnosticSource, SsmlDialogNode, SsmlDocument, SsmlElement, SsmlElementBase, SsmlEmbeddingNode, SsmlExpressAsElement, SsmlNode, SsmlPartialContext, SsmlPartialProsody, SsmlPartialVoice, SsmlPhonemeElement, SsmlProsodyElement, SsmlSayAsElement, SsmlSourceMap, SsmlSourceMarker, SsmlSourceTextSegment, SsmlStructureIntegrityResult, SsmlStructureMismatch, SsmlText, SsmlTextNodeContext, SsmlTextRange, SsmlTtsEmbeddingNode, SsmlTurnNode, SsmlValidationError, SsmlVoiceConversionNode, SsmlVoiceElement, SubElement, VoiceElement, WordElement, areAzureLanguagesEquivalent, buildPartialSsml, buildSsml, createAzureUrlValidatorRunner, extractSsmlText, extractSsmlTranslatableText, fromPlainTextToSsml, getAzureVoiceCatalogMetadata, getBuiltInVoiceCatalogMetadata, getSsmlSourceMap, isValidAzureAudioDuration, mapSsmlTextNodes, normalizeAzureLanguage, parseSsml, splitSsmlDocument, validateAzureSsml, validateAzureSsmlChunks, validateSsml, validateSsmlStructureIntegrity } from './core.js';
+import { S as SsmlTextRange, a as SsmlSourceTextSegment, b as SsmlSourceMarker, c as SsmlDiagnostic, A as AzureValidationOptions } from './index.d-tpKoP1jl.js';
 import * as SpeechSDK from 'microsoft-cognitiveservices-speech-sdk';
 
 declare const DEFAULT_OUTPUT_FORMAT = "audio-16khz-128kbitrate-mono-mp3";
@@ -50,6 +50,7 @@ declare function resolveMimeType(outputFormat: string): string;
 interface TtsConfig {
     signal?: AbortSignal;
     timeoutMs?: number;
+    timeouts?: SynthesisTimeouts;
     endpoint?: string;
     subscriptionKey: string;
     region: string;
@@ -67,6 +68,39 @@ interface TtsConfig {
     /** Exact source text segments used to map individual Azure events. */
     sourceTextSegments?: SsmlSourceTextSegment[];
     sourceMarkers?: SsmlSourceMarker[];
+    concurrency?: number;
+    retryOptions?: RetryOptions;
+    cancelOnFailure?: boolean;
+    resumeChunks?: readonly SynthesizedChunk[];
+    resumeChunkIndices?: readonly number[];
+    customMerger?: CustomAudioMerger;
+    outputMimeType?: string;
+    postMergeValidator?: PostMergeValidator;
+}
+type MappingStatus = "exact" | "fallback" | "unmapped";
+interface AudioSpecification {
+    format: string;
+    mimeType: string;
+    codec: "pcm" | "mp3" | "opus" | "silk" | "unknown";
+    sampleRate: number;
+    channels: number;
+    bitrate?: number;
+    bitDepth?: number;
+    container?: string;
+    isVbr?: boolean;
+    isCompressed: boolean;
+}
+interface SynthesisTimeouts {
+    urlValidationMs?: number;
+    perChunkMs?: number;
+    chunkWithRetriesMs?: number;
+    totalJobMs?: number;
+}
+interface RetryOptions {
+    maxRetries: number;
+    initialDelayMs: number;
+    maxDelayMs: number;
+    shouldRetry?: (error: unknown, attempt: number) => boolean;
 }
 type SynthesisChunkStatus = "pending" | "synthesizing" | "success" | "failed";
 interface SsmlSynthesisBoundary {
@@ -86,6 +120,7 @@ interface SsmlSynthesisBoundary {
     /** Audio offset within the originating chunk before merge. */
     chunkAudioOffsetMs?: number;
     requestId?: string;
+    mappingStatus: MappingStatus;
 }
 interface SsmlSynthesisViseme {
     visemeId: number;
@@ -99,6 +134,7 @@ interface SsmlSynthesisViseme {
     originalTextRange?: SsmlTextRange;
     chunkAudioOffsetMs?: number;
     requestId?: string;
+    mappingStatus: MappingStatus;
 }
 interface SsmlSynthesisBookmark {
     name: string;
@@ -112,6 +148,7 @@ interface SsmlSynthesisBookmark {
     originalTextRange?: SsmlTextRange;
     chunkAudioOffsetMs?: number;
     requestId?: string;
+    mappingStatus: MappingStatus;
 }
 /** Audio and Azure Speech synchronization events emitted for one SSML request. */
 interface SsmlSynthesisResult {
@@ -133,6 +170,7 @@ interface SsmlSynthesisResult {
     };
     /** MIME type of a result produced by an explicit merge operation. */
     mimeType?: string;
+    audioSpec?: AudioSpecification;
 }
 interface MergedSynthesisResult extends SsmlSynthesisResult {
     mimeType: string;
@@ -152,8 +190,37 @@ interface SynthesizeChunksOptions {
     outputFormat?: AzureTtsOutputFormat | string;
     signal?: AbortSignal;
     timeoutMs?: number;
+    timeouts?: SynthesisTimeouts;
     sourceNodePath?: string[];
+    concurrency?: number;
+    retryOptions?: RetryOptions;
+    cancelOnFailure?: boolean;
+    resumeChunks?: readonly SynthesizedChunk[];
+    resumeChunkIndices?: readonly number[];
+    customMerger?: CustomAudioMerger;
+    outputMimeType?: string;
+    postMergeValidator?: PostMergeValidator;
 }
+interface CustomMergerContext {
+    format: string;
+    outputMimeType: string;
+    inputSpecs: readonly AudioSpecification[];
+    signal: AbortSignal;
+}
+type CustomAudioMerger = (buffers: ArrayBuffer[], context: CustomMergerContext) => Promise<ArrayBuffer> | ArrayBuffer;
+type PostMergeValidator = (result: MergedSynthesisResult, context: CustomMergerContext) => boolean | undefined | Promise<boolean | undefined>;
+interface SynthesizedChunk extends SsmlSynthesisResult {
+    chunkIndex: number;
+}
+interface PartialChunkSynthesisResult {
+    synthesizedChunks: readonly SynthesizedChunk[];
+    completedChunks: readonly SynthesizedChunk[];
+    pendingChunkIndices: readonly number[];
+    failedChunkIndices: readonly number[];
+    totalChunks: number;
+}
+/** Alias for applications that use the shorter result name. */
+type PartialSynthesisResult = PartialChunkSynthesisResult;
 interface SynthesisProgressEvent {
     /** 1-based completed chunk count retained for backward compatibility. */
     currentChunk: number;
@@ -164,6 +231,9 @@ interface SynthesisProgressEvent {
     status: SynthesisChunkStatus;
     durationMs: number;
     error?: unknown;
+    retryAttempt?: number;
+    nextRetryDelayMs?: number;
+    isRetrying?: boolean;
 }
 interface AzureTtsLogger {
     debug?: (...args: unknown[]) => void;
@@ -174,23 +244,29 @@ interface AzureTtsLogger {
 interface AzureTtsClientOptions {
     signal?: AbortSignal;
     timeoutMs?: number;
+    timeouts?: SynthesisTimeouts;
     subscriptionKey: string;
     region: string;
     endpoint?: string;
     outputFormat?: string;
     logger?: AzureTtsLogger;
     onProgress?: (event: SynthesisProgressEvent) => void;
+    concurrency?: number;
+    retryOptions?: RetryOptions;
 }
 
-type SynthesisErrorKind = "validation-error" | "azure-api-error" | "merge-error" | "unsupported-format-error" | "cancelled" | "timeout";
+type SynthesisErrorKind = "validation-error" | "azure-api-error" | "merge-error" | "audio-format-mismatch" | "unsupported-format-error" | "cancelled" | "timeout";
 declare class AzureTtsError extends Error {
     readonly kind: "azure-api-error";
     readonly status: number;
     readonly statusText: string;
     readonly responseBody: string;
     readonly requestId: string | null;
-    constructor(status: number, statusText: string, responseBody: string, requestId: string | null);
+    readonly retryAfterMs?: number;
+    constructor(status: number, statusText: string, responseBody: string, requestId: string | null, responseHeaders?: Headers | Readonly<Record<string, string>>);
 }
+/** Reads Retry-After from an error-like value, returning milliseconds when present. */
+declare function getRetryAfterDelayMs(error: unknown): number | undefined;
 declare class AzureTtsSdkError extends AzureTtsError {
     readonly errorDetails: string;
     constructor(errorDetails: string);
@@ -208,13 +284,19 @@ declare class MergeError extends Error {
     readonly cause: unknown;
     constructor(message: string, cause?: unknown);
 }
+/** Thrown when chunk headers describe incompatible audio streams. */
+declare class AudioFormatMismatchError extends Error {
+    readonly kind: "audio-format-mismatch";
+    readonly inputSpecs: readonly AudioSpecification[];
+    constructor(message: string, inputSpecs?: readonly AudioSpecification[]);
+}
 /** Thrown when audio buffers require container re-multiplexing before they can be merged. */
 declare class UnsupportedMergeFormatError extends Error {
     readonly kind: "unsupported-format-error";
     readonly format: string;
     constructor(format: string);
 }
-type AzureTtsSynthesisError = AzureTtsError | MergeError | UnsupportedMergeFormatError | SynthesisCancelledError | SynthesisTimeoutError;
+type AzureTtsSynthesisError = AzureTtsError | MergeError | AudioFormatMismatchError | UnsupportedMergeFormatError | SynthesisCancelledError | SynthesisTimeoutError;
 
 interface SsmlValidationError {
     readonly kind: "validation-error";
@@ -228,6 +310,17 @@ declare class ChunkValidationError extends Error {
     readonly diagnostics: readonly SsmlDiagnostic[];
     constructor(chunkIndex: number, diagnostics: readonly SsmlDiagnostic[]);
 }
+interface ChunkDiagnostics {
+    readonly chunkIndex: number;
+    readonly diagnostics: readonly SsmlDiagnostic[];
+}
+declare class BatchChunkValidationError extends ChunkValidationError {
+    readonly chunkDiagnostics: readonly ChunkDiagnostics[];
+    readonly totalErrorCount: number;
+    readonly errorCount: number;
+    readonly totalErrors: number;
+    constructor(chunkDiagnostics: readonly ChunkDiagnostics[]);
+}
 type Result<T, E> = {
     readonly ok: true;
     readonly success: true;
@@ -240,11 +333,13 @@ type Result<T, E> = {
     readonly success: false;
     readonly status: Kind;
     readonly error: E;
+    readonly partialResult?: PartialChunkSynthesisResult;
 } : {
     readonly ok: false;
     readonly success: false;
     readonly status: SynthesisErrorKind;
     readonly error: E;
+    readonly partialResult?: PartialChunkSynthesisResult;
 });
 type SynthesisResult<T, E> = Result<T, E>;
 type Success<T> = Extract<Result<T, never>, {
@@ -261,16 +356,26 @@ interface SynthesizeSsmlSafeOptions extends AzureValidationOptions {
     /** Optional nested form for callers that want to keep validation settings grouped. */
     validation?: AzureValidationOptions;
     signal?: AbortSignal;
+    timeouts?: SynthesisTimeouts;
 }
 interface SynthesizeSsmlChunksSafeOptions extends AzureValidationOptions {
     validation?: AzureValidationOptions;
     outputFormat?: string;
     signal?: AbortSignal;
     timeoutMs?: number;
+    timeouts?: SynthesisTimeouts;
     sourceNodePath?: string[];
     onProgress?: (event: SynthesisProgressEvent) => void;
+    concurrency?: number;
+    retryOptions?: RetryOptions;
+    cancelOnFailure?: boolean;
+    resumeChunks?: readonly SynthesizedChunk[];
+    resumeChunkIndices?: readonly number[];
+    customMerger?: CustomAudioMerger;
+    outputMimeType?: string;
+    postMergeValidator?: PostMergeValidator;
 }
-type SsmlSynthesisChunksSafeResult = Result<SsmlSynthesisResult, never> | Result<never, ChunkValidationError> | Result<never, SsmlSynthesisError | ChunkValidationError>;
+type SsmlSynthesisChunksSafeResult = Result<SsmlSynthesisResult, never> | Result<never, ChunkValidationError> | Result<never, BatchChunkValidationError> | Result<never, SsmlSynthesisError | ChunkValidationError>;
 interface SynthesisClient {
     synthesizeSsml(ssml: string, options?: Partial<SynthesizeChunksOptions>): Promise<SsmlSynthesisResult>;
     synthesizeChunks?(chunks: readonly (SsmlSynthesisChunk | string)[], options?: SynthesizeChunksOptions): Promise<SsmlSynthesisResult>;
@@ -294,22 +399,29 @@ declare class AzureTtsClient {
 type MergeAudioFormat = "wav" | "mp3" | "raw";
 interface MergeAudioOptions {
     format: AzureTtsOutputFormat;
+    signal?: AbortSignal;
+    outputMimeType?: string;
 }
+type InputAudioSpecs = AudioSpecification[];
 interface MergeSynthesisOptions extends MergeAudioOptions {
-    customMerger?: (buffers: ArrayBuffer[], format: string) => Promise<ArrayBuffer> | ArrayBuffer;
+    customMerger?: CustomAudioMerger;
+    postMergeValidator?: PostMergeValidator;
 }
 type AsyncMergeSynthesisOptions = MergeSynthesisOptions & {
     customMerger: NonNullable<MergeSynthesisOptions["customMerger"]>;
 };
+/** Extracts the stream specification from a WAV/MP3 header and output-format fallback. */
+declare function inspectAudioSpecification(buffer: ArrayBuffer, format: string): AudioSpecification;
 /** Returns whether the named output format can be safely concatenated without re-multiplexing. */
 declare function resolveMergeAudioFormat(format: string): MergeAudioFormat | undefined;
 declare function canMergeAudioFormat(format: string): boolean;
 /** Merges audio buffers while preserving the invariants of supported containers. */
 declare function mergeAudioBuffers(buffers: readonly ArrayBuffer[], options: MergeAudioOptions): ArrayBuffer;
 declare function synthesizeSsml(ssml: string, config: TtsConfig): Promise<SsmlSynthesisResult>;
-/** Synthesizes chunks sequentially, annotates synchronization events, and merges the results. */
+/** Synthesizes chunks with bounded concurrency, retries transient failures, and merges in chunk order. */
 declare function synthesizeSsmlChunks(chunks: readonly (SsmlSynthesisChunk | string)[], config: TtsConfig): Promise<SsmlSynthesisResult>;
 declare function mergeSynthesisResults(results: readonly SsmlSynthesisResult[], options: AsyncMergeSynthesisOptions): Promise<MergedSynthesisResult>;
+declare function mergeSynthesisResults(results: readonly SsmlSynthesisResult[], options: MergeSynthesisOptions): MergedSynthesisResult | Promise<MergedSynthesisResult>;
 declare function mergeSynthesisResults(results: readonly SsmlSynthesisResult[], options: MergeAudioOptions): MergedSynthesisResult;
 /** Backward-compatible audio-only synthesis helper. */
 declare function synthesizeSpeech(ssml: string, config: TtsConfig): Promise<ArrayBuffer>;
@@ -334,6 +446,8 @@ interface FetchedAzureVoiceCatalogMetadata {
     generatedAt: string;
     apiVersion: string;
     regions: readonly string[];
+    expiresAt?: string;
+    regionDiffs?: Readonly<Record<string, readonly string[]>>;
 }
 interface AzureVoiceCatalog {
     voices: readonly AzureVoiceCatalogVoice[];
@@ -342,4 +456,4 @@ interface AzureVoiceCatalog {
 /** Fetches and deduplicates the current Azure Speech voice catalog for one or more regions. */
 declare function fetchAzureVoiceCatalog(options: FetchAzureVoiceCatalogOptions): Promise<AzureVoiceCatalog>;
 
-export { type AzureApiErrorResult, type SsmlValidationError as AzureSsmlValidationError, AzureTtsClient, type AzureTtsClientOptions, AzureTtsError, type AzureTtsLogger, type AzureTtsOutputFormat, AzureTtsSdkError, type AzureTtsSynthesisError, type AzureVoiceCatalog, type AzureVoiceCatalogVoice, ChunkValidationError, DEFAULT_OUTPUT_FORMAT, type FetchAzureVoiceCatalogOptions, type FetchedAzureVoiceCatalogMetadata, type MergeAudioFormat, type MergeAudioOptions, MergeError, type MergeSynthesisOptions, type MergedSynthesisResult, type Result, type SsmlSynthesisBookmark, type SsmlSynthesisBoundary, type SsmlSynthesisChunk, type SsmlSynthesisChunksSafeResult, type SsmlSynthesisError, type SsmlSynthesisResult, type SsmlSynthesisSafeResult, type SsmlSynthesisViseme, type Success, SynthesisCancelledError, type SynthesisChunkStatus, type SynthesisErrorKind, type SynthesisProgressEvent, type SynthesisResult, SynthesisTimeoutError, type SynthesizeChunksOptions, type SynthesizeSsmlChunksSafeOptions, type SynthesizeSsmlSafeOptions, type TtsConfig, UnsupportedMergeFormatError, type ValidationErrorResult, canMergeAudioFormat, fetchAzureVoiceCatalog, mergeAudioBuffers, mergeSynthesisResults, resolveMergeAudioFormat, resolveMimeType, synthesizeSpeech, synthesizeSsml, synthesizeSsmlChunks, synthesizeSsmlChunksSafe, synthesizeSsmlSafe };
+export { AudioFormatMismatchError, type AudioSpecification, type AzureApiErrorResult, type SsmlValidationError as AzureSsmlValidationError, AzureTtsClient, type AzureTtsClientOptions, AzureTtsError, type AzureTtsLogger, type AzureTtsOutputFormat, AzureTtsSdkError, type AzureTtsSynthesisError, type AzureVoiceCatalog, type AzureVoiceCatalogVoice, BatchChunkValidationError, type ChunkDiagnostics, ChunkValidationError, type CustomAudioMerger, type CustomMergerContext, DEFAULT_OUTPUT_FORMAT, type FetchAzureVoiceCatalogOptions, type FetchedAzureVoiceCatalogMetadata, type InputAudioSpecs, type MappingStatus, type MergeAudioFormat, type MergeAudioOptions, MergeError, type MergeSynthesisOptions, type MergedSynthesisResult, type PartialChunkSynthesisResult, type PartialSynthesisResult, type PostMergeValidator, type Result, type RetryOptions, type SsmlSynthesisBookmark, type SsmlSynthesisBoundary, type SsmlSynthesisChunk, type SsmlSynthesisChunksSafeResult, type SsmlSynthesisError, type SsmlSynthesisResult, type SsmlSynthesisSafeResult, type SsmlSynthesisViseme, type Success, SynthesisCancelledError, type SynthesisChunkStatus, type SynthesisErrorKind, type SynthesisProgressEvent, type SynthesisResult, SynthesisTimeoutError, type SynthesisTimeouts, type SynthesizeChunksOptions, type SynthesizeSsmlChunksSafeOptions, type SynthesizeSsmlSafeOptions, type SynthesizedChunk, type TtsConfig, UnsupportedMergeFormatError, type ValidationErrorResult, canMergeAudioFormat, fetchAzureVoiceCatalog, getRetryAfterDelayMs, inspectAudioSpecification, mergeAudioBuffers, mergeSynthesisResults, resolveMergeAudioFormat, resolveMimeType, synthesizeSpeech, synthesizeSsml, synthesizeSsmlChunks, synthesizeSsmlChunksSafe, synthesizeSsmlSafe };