@ssml-builder-js/azure-tts-client 2.18.0 → 2.19.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { SsmlDiagnostic, AzureValidationOptions, SsmlTextRange, SsmlSourceTextSegment, SsmlSourceMarker } from '@ssml-builder-js/ssml-core';
+import { SsmlTextRange, SsmlSourceTextSegment, SsmlSourceMarker, SsmlDiagnostic, AzureValidationOptions } from '@ssml-builder-js/ssml-core';
 import * as SpeechSDK from 'microsoft-cognitiveservices-speech-sdk';
 
 declare const DEFAULT_OUTPUT_FORMAT = "audio-16khz-128kbitrate-mono-mp3";
@@ -46,7 +46,19 @@ declare const OUTPUT_FORMATS: {
 type AzureTtsOutputFormat = keyof typeof OUTPUT_FORMATS;
 declare function resolveMimeType(outputFormat: string): string;
 
-type SynthesisErrorKind = "validation-error" | "azure-api-error" | "merge-error" | "audio-format-mismatch" | "unsupported-format-error" | "cancelled" | "timeout";
+type SynthesisErrorKind = "validation-error" | "azure-api-error" | "merge-error" | "audio-format-mismatch" | "unsupported-format-error" | "cancelled" | "timeout" | "incomplete-chunk-set";
+type SerializedChunkErrorCode = "VALIDATION_ERROR" | "AZURE_API_ERROR" | "TIMEOUT" | "CANCELLED" | "MERGE_ERROR" | "FORMAT_MISMATCH";
+interface SerializedChunkError {
+    code: SerializedChunkErrorCode;
+    phase: "url-validation" | "synthesis" | "merge";
+    message: string;
+    isOriginalFailure: boolean;
+    isRetryable: boolean;
+    httpStatus?: number;
+    details?: Record<string, unknown>;
+}
+/** Backward-compatible name used by persisted execution-state consumers. */
+type SerializedExecutionError = SerializedChunkError;
 declare class AzureTtsError extends Error {
     readonly kind: "azure-api-error";
     readonly status: number;
@@ -70,6 +82,12 @@ declare class SynthesisTimeoutError extends Error {
     readonly kind: "timeout";
     constructor(message: string);
 }
+declare class IncompleteChunkSetError extends Error {
+    readonly kind: "incomplete-chunk-set";
+    readonly totalChunks: number;
+    readonly missingChunkIndices: readonly number[];
+    constructor(totalChunks: number, missingChunkIndices: readonly number[]);
+}
 declare class MergeError extends Error {
     readonly kind: "merge-error";
     readonly cause: unknown;
@@ -87,106 +105,8 @@ declare class UnsupportedMergeFormatError extends Error {
     readonly format: string;
     constructor(format: string);
 }
-type AzureTtsSynthesisError = AzureTtsError | MergeError | AudioFormatMismatchError | UnsupportedMergeFormatError | SynthesisCancelledError | SynthesisTimeoutError;
-
-declare class AzureTtsClient {
-    #private;
-    constructor(options: AzureTtsClientOptions);
-    synthesize(ssml: string): Promise<ArrayBuffer>;
-    synthesizeSsml(ssml: string, options?: Partial<TtsConfig>): Promise<SsmlSynthesisResult>;
-    synthesizeChunks(chunks: readonly (SsmlSynthesisChunk | string)[], options?: SynthesizeChunksOptions): Promise<SsmlSynthesisResult>;
-    synthesizeSsmlSafe(ssml: string, options?: SynthesizeSsmlSafeOptions): Promise<SsmlSynthesisSafeResult>;
-    synthesizeChunksSafe(chunks: readonly (SsmlSynthesisChunk | string)[], options?: SynthesizeSsmlChunksSafeOptions): Promise<SsmlSynthesisChunksSafeResult>;
-    synthesizeSsmlChunksSafe(chunks: readonly (SsmlSynthesisChunk | string)[], options?: SynthesizeSsmlChunksSafeOptions): Promise<SsmlSynthesisChunksSafeResult>;
-}
-
-interface SsmlValidationError {
-    readonly kind: "validation-error";
-    readonly message: string;
-    readonly diagnostics: readonly SsmlDiagnostic[];
-}
-type SsmlSynthesisError = SsmlValidationError | AzureTtsSynthesisError;
-declare class ChunkValidationError extends Error {
-    readonly kind: "validation-error";
-    readonly chunkIndex: number;
-    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;
-    readonly status: "success";
-    readonly value: T;
-} | (E extends {
-    readonly kind: infer Kind extends SynthesisErrorKind;
-} ? {
-    readonly ok: false;
-    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>, {
-    readonly ok: true;
-}>;
-type ValidationErrorResult = Extract<Result<never, SsmlValidationError>, {
-    readonly status: "validation-error";
-}>;
-type AzureApiErrorResult = Extract<Result<never, AzureTtsError>, {
-    readonly status: "azure-api-error";
-}>;
-type SsmlSynthesisSafeResult = Result<SsmlSynthesisResult, never> | Result<never, SsmlValidationError> | Result<never, SsmlSynthesisError>;
-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;
-    resumeValidation?: ResumeValidationMode;
-}
-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>;
-}
-/** Validates SSML before invoking Azure and converts validation/API failures to one result shape. */
-declare function synthesizeSsmlSafe(client: Pick<AzureTtsClient, "synthesizeSsml"> | SynthesisClient, ssml: string, options?: SynthesizeSsmlSafeOptions): Promise<SsmlSynthesisSafeResult>;
-/** Validates every chunk before synthesis and returns a chunk-addressable result. */
-declare function synthesizeSsmlChunksSafe(client: Pick<AzureTtsClient, "synthesizeSsml" | "synthesizeChunks"> | SynthesisClient, chunks: readonly (SsmlSynthesisChunk | string)[], options?: SynthesizeSsmlChunksSafeOptions): Promise<SsmlSynthesisChunksSafeResult>;
+type AzureTtsSynthesisError = AzureTtsError | MergeError | AudioFormatMismatchError | UnsupportedMergeFormatError | SynthesisCancelledError | SynthesisTimeoutError | IncompleteChunkSetError;
+declare function serializeChunkError(error: unknown, phase: SerializedChunkError["phase"], isOriginalFailure: boolean): SerializedChunkError;
 
 interface TtsConfig {
     signal?: AbortSignal;
@@ -196,6 +116,8 @@ interface TtsConfig {
     subscriptionKey: string;
     region: string;
     outputFormat?: string;
+    customHeaders?: Readonly<Record<string, string>>;
+    fingerprintSchemaVersion?: string;
     /** Original plain-text range represented by this synthesis request. */
     sourceTextRange?: {
         start: number;
@@ -331,6 +253,8 @@ interface SsmlSynthesisChunk {
 interface SynthesizeChunksOptions {
     onProgress?: (event: SynthesisProgressEvent) => void;
     outputFormat?: AzureTtsOutputFormat | string;
+    customHeaders?: Readonly<Record<string, string>>;
+    fingerprintSchemaVersion?: string;
     signal?: AbortSignal;
     timeoutMs?: number;
     timeouts?: SynthesisTimeouts;
@@ -362,7 +286,7 @@ type ChunkExecutionStatus = "succeeded" | "failed" | "cancelled" | "pending";
 interface ChunkExecutionState {
     chunkIndex: number;
     status: ChunkExecutionStatus;
-    error?: AzureTtsError | SsmlValidationError;
+    error?: SerializedChunkError;
     isOriginalFailure?: boolean;
     canResume: boolean;
     result?: SsmlSynthesisResult;
@@ -406,6 +330,8 @@ interface AzureTtsClientOptions {
     region: string;
     endpoint?: string;
     outputFormat?: string;
+    customHeaders?: Readonly<Record<string, string>>;
+    fingerprintSchemaVersion?: string;
     logger?: AzureTtsLogger;
     onProgress?: (event: SynthesisProgressEvent) => void;
     concurrency?: number;
@@ -417,6 +343,120 @@ interface AzureTtsClientOptions {
     resumeValidation?: ResumeValidationMode;
 }
 
+/** Coordinates one absolute deadline across validation, synthesis, retries, and merging. */
+declare class DeadlineController {
+    #private;
+    readonly deadlineAtMs: number | undefined;
+    readonly signal: AbortSignal;
+    constructor(totalJobMs: number | undefined, parent?: AbortSignal);
+    get timedOut(): boolean;
+    get remainingMs(): number;
+    throwIfExpired(): void;
+    abort(): void;
+    dispose(): void;
+}
+
+interface SsmlValidationError {
+    readonly kind: "validation-error";
+    readonly message: string;
+    readonly diagnostics: readonly SsmlDiagnostic[];
+}
+type SsmlSynthesisError = SsmlValidationError | AzureTtsSynthesisError;
+declare class ChunkValidationError extends Error {
+    readonly kind: "validation-error";
+    readonly chunkIndex: number;
+    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;
+    readonly status: "success";
+    readonly value: T;
+} | (E extends {
+    readonly kind: infer Kind extends SynthesisErrorKind;
+} ? {
+    readonly ok: false;
+    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>, {
+    readonly ok: true;
+}>;
+type ValidationErrorResult = Extract<Result<never, SsmlValidationError>, {
+    readonly status: "validation-error";
+}>;
+type AzureApiErrorResult = Extract<Result<never, AzureTtsError>, {
+    readonly status: "azure-api-error";
+}>;
+type SsmlSynthesisSafeResult = Result<SsmlSynthesisResult, never> | Result<never, SsmlValidationError> | Result<never, SsmlSynthesisError>;
+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;
+    customHeaders?: Readonly<Record<string, string>>;
+    fingerprintSchemaVersion?: 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;
+    resumeValidation?: ResumeValidationMode;
+}
+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>;
+}
+/** Validates SSML before invoking Azure and converts validation/API failures to one result shape. */
+declare function synthesizeSsmlSafe(client: Pick<AzureTtsClient, "synthesizeSsml"> | SynthesisClient, ssml: string, options?: SynthesizeSsmlSafeOptions): Promise<SsmlSynthesisSafeResult>;
+/** Validates every chunk before synthesis and returns a chunk-addressable result. */
+declare function synthesizeSsmlChunksSafe(client: Pick<AzureTtsClient, "synthesizeSsml" | "synthesizeChunks"> | SynthesisClient, chunks: readonly (SsmlSynthesisChunk | string)[], options?: SynthesizeSsmlChunksSafeOptions): Promise<SsmlSynthesisChunksSafeResult>;
+
+declare class AzureTtsClient {
+    #private;
+    constructor(options: AzureTtsClientOptions);
+    synthesize(ssml: string): Promise<ArrayBuffer>;
+    synthesizeSsml(ssml: string, options?: Partial<TtsConfig>): Promise<SsmlSynthesisResult>;
+    synthesizeChunks(chunks: readonly (SsmlSynthesisChunk | string)[], options?: SynthesizeChunksOptions): Promise<SsmlSynthesisResult>;
+    synthesizeSsmlSafe(ssml: string, options?: SynthesizeSsmlSafeOptions): Promise<SsmlSynthesisSafeResult>;
+    synthesizeChunksSafe(chunks: readonly (SsmlSynthesisChunk | string)[], options?: SynthesizeSsmlChunksSafeOptions): Promise<SsmlSynthesisChunksSafeResult>;
+    synthesizeSsmlChunksSafe(chunks: readonly (SsmlSynthesisChunk | string)[], options?: SynthesizeSsmlChunksSafeOptions): Promise<SsmlSynthesisChunksSafeResult>;
+}
+
 type MergeAudioFormat = "wav" | "mp3" | "raw";
 interface MergeAudioOptions {
     format: AzureTtsOutputFormat;
@@ -429,10 +469,21 @@ type InputAudioSpecs = AudioSpecification[];
  * The complete SSML is included so changes to voice, language, prosody, or text
  * invalidate a cached result even when those settings are nested in the markup.
  */
-declare function computeChunkFingerprint(ssml: string, outputFormat?: string): string;
+interface ChunkFingerprintOptions {
+    outputFormat?: string;
+    region?: string;
+    endpoint?: string;
+    voice?: string;
+    lang?: string;
+    schemaVersion?: string;
+    fingerprintSchemaVersion?: string;
+    customHeaders?: Readonly<Record<string, string>>;
+}
+declare function computeChunkFingerprint(ssml: string, outputFormat?: string, options?: Omit<ChunkFingerprintOptions, "outputFormat">): string;
 interface MergeSynthesisOptions extends MergeAudioOptions {
     customMerger?: CustomAudioMerger;
     postMergeValidator?: PostMergeValidator;
+    deadline?: DeadlineController;
 }
 type AsyncMergeSynthesisOptions = MergeSynthesisOptions & {
     customMerger: NonNullable<MergeSynthesisOptions["customMerger"]>;
@@ -484,4 +535,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 { 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, type ChunkExecutionState, type ChunkExecutionStatus, 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 ResumeValidationMode, 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, computeChunkFingerprint, fetchAzureVoiceCatalog, getRetryAfterDelayMs, inspectAudioSpecification, 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, type ChunkExecutionState, type ChunkExecutionStatus, type ChunkFingerprintOptions, ChunkValidationError, type CustomAudioMerger, type CustomMergerContext, DEFAULT_OUTPUT_FORMAT, DeadlineController, type FetchAzureVoiceCatalogOptions, type FetchedAzureVoiceCatalogMetadata, IncompleteChunkSetError, type InputAudioSpecs, type MappingStatus, type MergeAudioFormat, type MergeAudioOptions, MergeError, type MergeSynthesisOptions, type MergedSynthesisResult, type PartialChunkSynthesisResult, type PartialSynthesisResult, type PostMergeValidator, type Result, type ResumeValidationMode, type RetryOptions, type SerializedChunkError, type SerializedChunkErrorCode, type SerializedExecutionError, 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, computeChunkFingerprint, fetchAzureVoiceCatalog, getRetryAfterDelayMs, inspectAudioSpecification, mergeAudioBuffers, mergeSynthesisResults, resolveMergeAudioFormat, resolveMimeType, serializeChunkError, synthesizeSpeech, synthesizeSsml, synthesizeSsmlChunks, synthesizeSsmlChunksSafe, synthesizeSsmlSafe };