ssml-builder-js 2.11.0 → 2.13.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export { AudioElement, AzureDiagnosticCode, AzureLanguageNormalizationOptions, AzureSsmlValidationOptions, 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, SsmlAttributeValue, SsmlAttributes, SsmlBackgroundAudioNode, SsmlBreakElement, SsmlDiagnostic, SsmlDiagnosticSeverity, SsmlDiagnosticSource, SsmlDialogNode, SsmlDocument, SsmlElement, SsmlElementBase, SsmlEmbeddingNode, SsmlExpressAsElement, SsmlNode, SsmlPartialContext, SsmlPartialProsody, SsmlPartialVoice, SsmlPhonemeElement, SsmlProsodyElement, SsmlSayAsElement, SsmlStructureIntegrityResult, SsmlStructureMismatch, SsmlText, SsmlTextNodeContext, SsmlTtsEmbeddingNode, SsmlTurnNode, SsmlValidationError, SsmlVoiceConversionNode, SsmlVoiceElement, SubElement, VoiceElement, WordElement, areAzureLanguagesEquivalent, buildPartialSsml, buildSsml, extractSsmlText, extractSsmlTranslatableText, fromPlainTextToSsml, getAzureVoiceCatalogMetadata, getBuiltInVoiceCatalogMetadata, isValidAzureAudioDuration, mapSsmlTextNodes, normalizeAzureLanguage, parseSsml, validateAzureSsml, validateSsml, validateSsmlStructureIntegrity } from './core.js';
+export { AudioElement, AzureDiagnosticCode, AzureLanguageNormalizationOptions, AzureSsmlValidationOptions, AzureUrlValidationResult, 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, SsmlStructureIntegrityResult, SsmlStructureMismatch, SsmlText, SsmlTextNodeContext, SsmlTextRange, SsmlTtsEmbeddingNode, SsmlTurnNode, SsmlValidationError, SsmlVoiceConversionNode, SsmlVoiceElement, SubElement, VoiceElement, WordElement, areAzureLanguagesEquivalent, buildPartialSsml, buildSsml, extractSsmlText, extractSsmlTranslatableText, fromPlainTextToSsml, getAzureVoiceCatalogMetadata, getBuiltInVoiceCatalogMetadata, isValidAzureAudioDuration, mapSsmlTextNodes, normalizeAzureLanguage, parseSsml, splitSsmlDocument, validateAzureSsml, validateSsml, validateSsmlStructureIntegrity } from './core.js';
+import { S as SsmlDiagnostic, A as AzureValidationOptions } from './index.d-Xbr6ZWnK.js';
 
 interface TtsConfig {
     signal?: AbortSignal;
@@ -7,6 +8,79 @@ interface TtsConfig {
     subscriptionKey: string;
     region: string;
     outputFormat?: string;
+    /** Original plain-text range represented by this synthesis request. */
+    sourceTextRange?: {
+        start: number;
+        end: number;
+    };
+    /** Reports completion of a chunk when using synthesizeSsmlChunks. */
+    onProgress?: (event: {
+        currentChunk: number;
+        totalChunks: number;
+        percent: number;
+    }) => void;
+}
+interface SsmlSynthesisBoundary {
+    text: string;
+    audioOffsetMs: number;
+    durationMs: number;
+    textRange?: {
+        start: number;
+        end: number;
+    };
+    requestId?: string;
+}
+interface SsmlSynthesisViseme {
+    visemeId: number;
+    audioOffsetMs: number;
+    textRange?: {
+        start: number;
+        end: number;
+    };
+    requestId?: string;
+}
+interface SsmlSynthesisBookmark {
+    name: string;
+    audioOffsetMs: number;
+    textRange?: {
+        start: number;
+        end: number;
+    };
+    requestId?: string;
+}
+/** Audio and Azure Speech synchronization events emitted for one SSML request. */
+interface SsmlSynthesisResult {
+    audioData: ArrayBuffer;
+    durationMs: number;
+    boundaries?: SsmlSynthesisBoundary[];
+    /** Alias matching the Azure Speech event name. */
+    wordBoundary?: SsmlSynthesisBoundary[];
+    /** Alias for consumers that use Azure's word-boundary terminology. */
+    wordBoundaries?: SsmlSynthesisBoundary[];
+    visemes?: SsmlSynthesisViseme[];
+    bookmarks?: SsmlSynthesisBookmark[];
+    /** Request identifier returned by Azure Speech, when available. */
+    requestId?: string;
+    /** Original plain-text range represented by the result. */
+    textRange?: {
+        start: number;
+        end: number;
+    };
+}
+interface SsmlSynthesisChunk {
+    ssml: string;
+    originalTextRange?: {
+        start: number;
+        end: number;
+    };
+}
+interface SynthesizeChunksOptions {
+    onProgress?: (event: SynthesisProgressEvent) => void;
+}
+interface SynthesisProgressEvent {
+    currentChunk: number;
+    totalChunks: number;
+    percent: number;
 }
 interface AzureTtsLogger {
     debug?: (...args: unknown[]) => void;
@@ -22,6 +96,7 @@ interface AzureTtsClientOptions {
     endpoint?: string;
     outputFormat?: string;
     logger?: AzureTtsLogger;
+    onProgress?: (event: SynthesisProgressEvent) => void;
 }
 
 declare class AzureTtsError extends Error {
@@ -36,12 +111,58 @@ declare class AzureTtsSdkError extends AzureTtsError {
     constructor(errorDetails: string);
 }
 
+interface SsmlValidationError {
+    readonly kind: "validation";
+    readonly message: string;
+    readonly diagnostics: readonly SsmlDiagnostic[];
+}
+type Result<T, E> = {
+    readonly ok: true;
+    readonly success: true;
+    readonly status: "success";
+    readonly value: T;
+} | {
+    readonly ok: false;
+    readonly success: false;
+    readonly status: "validation-error" | "azure-api-error";
+    readonly error: E;
+};
+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, AzureTtsError>;
+interface SynthesizeSsmlSafeOptions extends AzureValidationOptions {
+    /** Optional nested form for callers that want to keep validation settings grouped. */
+    validation?: AzureValidationOptions;
+}
+interface SynthesisClient {
+    synthesizeSsml(ssml: string): 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>;
+
 declare class AzureTtsClient {
     #private;
     constructor(options: AzureTtsClientOptions);
     synthesize(ssml: string): Promise<ArrayBuffer>;
+    synthesizeSsml(ssml: string): Promise<SsmlSynthesisResult>;
+    synthesizeChunks(chunks: readonly (SsmlSynthesisChunk | string)[], options?: SynthesizeChunksOptions): Promise<SsmlSynthesisResult>;
+    synthesizeSsmlSafe(ssml: string, options?: SynthesizeSsmlSafeOptions): Promise<SsmlSynthesisSafeResult>;
 }
 
+declare function synthesizeSsml(ssml: string, config: TtsConfig): Promise<SsmlSynthesisResult>;
+/** Synthesizes chunks sequentially, annotates synchronization events, and merges the results. */
+declare function synthesizeSsmlChunks(chunks: readonly (SsmlSynthesisChunk | string)[], config: TtsConfig): Promise<SsmlSynthesisResult>;
+/** Concatenates audio buffers and shifts all synchronization events by prior chunk durations. */
+declare function mergeSynthesisResults(results: readonly SsmlSynthesisResult[]): SsmlSynthesisResult;
+/** Backward-compatible audio-only synthesis helper. */
 declare function synthesizeSpeech(ssml: string, config: TtsConfig): Promise<ArrayBuffer>;
 
 interface FetchAzureVoiceCatalogOptions {
@@ -69,4 +190,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 { AzureTtsClient, type AzureTtsClientOptions, AzureTtsError, type AzureTtsLogger, AzureTtsSdkError, type AzureVoiceCatalog, type AzureVoiceCatalogVoice, type FetchAzureVoiceCatalogOptions, type FetchedAzureVoiceCatalogMetadata, type TtsConfig, fetchAzureVoiceCatalog, synthesizeSpeech };
+export { type AzureApiErrorResult, type SsmlValidationError as AzureSsmlValidationError, AzureTtsClient, type AzureTtsClientOptions, AzureTtsError, type AzureTtsLogger, AzureTtsSdkError, type AzureVoiceCatalog, type AzureVoiceCatalogVoice, type FetchAzureVoiceCatalogOptions, type FetchedAzureVoiceCatalogMetadata, type Result, type SsmlSynthesisBookmark, type SsmlSynthesisBoundary, type SsmlSynthesisChunk, type SsmlSynthesisResult, type SsmlSynthesisSafeResult, type SsmlSynthesisViseme, type Success, type SynthesisProgressEvent, type SynthesisResult, type SynthesizeChunksOptions, type SynthesizeSsmlSafeOptions, type TtsConfig, type ValidationErrorResult, fetchAzureVoiceCatalog, mergeSynthesisResults, synthesizeSpeech, synthesizeSsml, synthesizeSsmlChunks, synthesizeSsmlSafe };