ssml-builder-js 2.12.0 → 2.13.0

package/dist/react.d.ts

@@ -1,160 +1,8 @@
 import * as react from 'react';
-import { ReactNode, CSSProperties, ReactElement } from 'react';
+import { ReactNode, ReactElement, CSSProperties } from 'react';
+import { a as SsmlDocument, b as SsmlElement } from './index.d-Xbr6ZWnK.js';
 import { OnMount, Monaco } from '@monaco-editor/react';
 
-type SsmlAttributeValue = string | number;
-type SsmlAttributes = Record<string, SsmlAttributeValue>;
-interface SsmlText {
-    type: "text";
-    value: string;
-}
-type SsmlNode = string | SsmlText | SsmlElement;
-interface SsmlElementBase {
-    children?: SsmlNode[];
-    attributes?: SsmlAttributes;
-}
-interface VoiceElement extends SsmlElementBase {
-    type: "voice";
-    name?: string;
-    effect?: string;
-}
-interface ProsodyElement extends SsmlElementBase {
-    type: "prosody";
-    rate?: SsmlAttributeValue;
-    pitch?: SsmlAttributeValue;
-    volume?: SsmlAttributeValue;
-    contour?: string;
-    range?: SsmlAttributeValue;
-}
-interface BreakElement extends SsmlElementBase {
-    type: "break";
-    time?: SsmlAttributeValue;
-    strength?: string;
-}
-interface ExpressAsElement extends SsmlElementBase {
-    type: "express-as" | "expressAs" | "mstts:express-as";
-    style?: string;
-    styleDegree?: SsmlAttributeValue;
-    role?: string;
-}
-interface SayAsElement extends SsmlElementBase {
-    type: "say-as" | "sayAs";
-    interpretAs?: string;
-    format?: string;
-    detail?: string;
-}
-interface PhonemeElement extends SsmlElementBase {
-    type: "phoneme";
-    alphabet?: string;
-    ph?: string;
-}
-interface EmphasisElement extends SsmlElementBase {
-    type: "emphasis";
-    level?: string;
-}
-interface AudioElement extends SsmlElementBase {
-    type: "audio";
-    src?: string;
-    desc?: string;
-    clipBegin?: SsmlAttributeValue;
-    clipEnd?: SsmlAttributeValue;
-    speed?: SsmlAttributeValue;
-    repeatCount?: SsmlAttributeValue;
-    repeatDuration?: SsmlAttributeValue;
-    soundLevel?: SsmlAttributeValue;
-}
-interface SubElement extends SsmlElementBase {
-    type: "sub";
-    alias?: string;
-}
-interface LangElement extends SsmlElementBase {
-    type: "lang";
-    lang?: string;
-}
-interface MarkElement extends SsmlElementBase {
-    type: "mark";
-    name?: string;
-}
-interface BookmarkElement extends SsmlElementBase {
-    type: "bookmark";
-    mark?: string;
-}
-interface LexiconElement extends SsmlElementBase {
-    type: "lexicon";
-    uri?: string;
-}
-interface ParagraphElement extends SsmlElementBase {
-    type: "p";
-}
-interface SentenceElement extends SsmlElementBase {
-    type: "s";
-}
-interface WordElement extends SsmlElementBase {
-    type: "w";
-}
-interface MsttsSilenceElement extends SsmlElementBase {
-    type: "mstts:silence" | "silence";
-    typeValue?: string;
-    silenceType?: string;
-    value?: SsmlAttributeValue;
-}
-interface MsttsVisemeElement extends SsmlElementBase {
-    type: "mstts:viseme" | "viseme";
-    typeValue?: string;
-    visemeType?: string;
-}
-interface MsttsAudioDurationElement extends SsmlElementBase {
-    type: "mstts:audioduration";
-    value?: SsmlAttributeValue;
-}
-interface SsmlDialogNode extends SsmlElementBase {
-    type: "mstts:dialog";
-}
-interface SsmlTurnNode extends SsmlElementBase {
-    type: "mstts:turn";
-    voice?: string;
-    speaker?: string;
-}
-interface SsmlBackgroundAudioNode extends SsmlElementBase {
-    type: "mstts:backgroundaudio";
-    src?: string;
-    volume?: SsmlAttributeValue;
-    fadeIn?: SsmlAttributeValue;
-    fadeOut?: SsmlAttributeValue;
-    /** XML spelling aliases retained for ergonomic object construction. */
-    fadein?: SsmlAttributeValue;
-    fadeout?: SsmlAttributeValue;
-}
-interface MsttsTtsEmbeddingElement extends SsmlElementBase {
-    type: "mstts:ttsembedding";
-    speakerProfileId?: string;
-}
-interface MsttsEmbeddingElement extends SsmlElementBase {
-    type: "mstts:embedding";
-    id?: string;
-    speakerProfileId?: string;
-}
-interface MsttsVoiceConversionElement extends SsmlElementBase {
-    type: "mstts:voiceconversion";
-    url?: string;
-    profile?: string;
-    speakerProfileId?: string;
-}
-interface CustomElement extends SsmlElementBase {
-    type: "custom" | "element";
-    name: string;
-}
-type SsmlElement = VoiceElement | ProsodyElement | BreakElement | ExpressAsElement | SayAsElement | PhonemeElement | EmphasisElement | AudioElement | SubElement | LangElement | MarkElement | BookmarkElement | LexiconElement | ParagraphElement | SentenceElement | WordElement | MsttsSilenceElement | MsttsVisemeElement | MsttsAudioDurationElement | SsmlDialogNode | SsmlTurnNode | SsmlBackgroundAudioNode | MsttsTtsEmbeddingElement | MsttsEmbeddingElement | MsttsVoiceConversionElement | CustomElement;
-interface SsmlDocument {
-    type?: "speak";
-    version: string;
-    lang: string;
-    children?: SsmlNode[];
-    /** @deprecated Use children to represent the document body. */
-    content?: string;
-    attributes?: SsmlAttributes;
-}
-
 type SsmlEditorInsertionButton = "break" | "emphasis" | "rate" | "pitch" | "volume" | "emotion" | "say-as" | "phoneme" | "audio" | "sub" | "lang" | "mark" | "bookmark" | "mstts:silence" | "mstts:audioduration" | "mstts:viseme" | (string & {});
 type SsmlEditorButton = "help" | SsmlEditorInsertionButton | "undo" | "redo" | "clearAll" | "format" | "decorations" | (string & {});
 type SsmlEditorButtonVisibility = Readonly<Partial<Record<string, boolean>>>;
@@ -215,10 +63,56 @@ interface SsmlHoverLocale {
     noParameters: string;
     tags: Readonly<Record<string, SsmlHoverTagCopy>>;
 }
+interface SsmlElementLocaleCopy {
+    label: string;
+    description: string;
+    validationErrors: Readonly<Record<string, string>>;
+}
+/** Localized labels and validation copy for Azure extension elements. */
+declare const SSML_ELEMENT_COPY: Readonly<Record<SsmlEditorLocale, Readonly<Record<string, SsmlElementLocaleCopy>>>>;
 declare const EDITOR_COPY: Readonly<Record<SsmlEditorLocale, EditorCopy>>;
 declare const INLINE_BADGE_COPY: Readonly<Record<SsmlEditorLocale, InlineBadgeCopy>>;
 declare const SSML_HOVER_COPY: Readonly<Record<SsmlEditorLocale, SsmlHoverLocale>>;
 
+interface VisualVoiceCatalogEntry {
+    name: string;
+    locale: string;
+    region?: string;
+    styles?: readonly string[];
+    preview?: boolean;
+    status?: "ga" | "preview" | "deprecated";
+}
+interface VoiceSelectorRenderProps {
+    value: string;
+    voices: readonly VisualVoiceCatalogEntry[];
+    readOnly: boolean;
+    locale: SsmlEditorLocale;
+    onChange: (voice: string) => void;
+}
+interface VisualInspectorRenderProps {
+    document: SsmlDocument;
+    element: SsmlElement;
+    path: number[];
+    readOnly: boolean;
+    onChange: (document: SsmlDocument) => void;
+    locale: SsmlEditorLocale;
+}
+type VisualInspectorRenderer = (props: VisualInspectorRenderProps) => ReactNode;
+interface VisualSsmlEditorProps {
+    document: SsmlDocument;
+    readOnly?: boolean;
+    onChange?: (document: SsmlDocument) => void;
+    onPreviewSelection?: (ssml: string) => void;
+    locale?: SsmlEditorLocale;
+    customInspectors?: Readonly<Record<string, VisualInspectorRenderer>>;
+    renderVoiceSelector?: (props: VoiceSelectorRenderProps) => ReactNode;
+    voiceCatalog?: readonly VisualVoiceCatalogEntry[];
+    voiceLocale?: string;
+    voiceRegion?: string;
+    voiceStyle?: string;
+}
+declare function VisualSsmlEditor({ document, readOnly, onChange, onPreviewSelection, locale, customInspectors, renderVoiceSelector, voiceCatalog, voiceLocale, voiceRegion, voiceStyle, }: VisualSsmlEditorProps): ReactElement;
+
 type SsmlEditorInsertionMode = "insert" | "wrap";
 interface SsmlEditorInsertionOption {
     value: string;
@@ -391,6 +285,18 @@ interface SsmlEditorProps {
     customInsertions?: SsmlEditorCustomInsertionCollection;
     /** Adds insertion definitions without replacing built-in definitions. */
     additionalInsertions?: SsmlEditorCustomInsertionCollection;
+    /** Replaces the visual inspector for an element type or serialized tag name. */
+    customInspectors?: Readonly<Record<string, VisualInspectorRenderer>>;
+    /** Replaces the built-in voice catalog selector in visual mode. */
+    renderVoiceSelector?: (props: VoiceSelectorRenderProps) => ReactNode;
+    /** Voice metadata used by the visual selector. */
+    voiceCatalog?: readonly VisualVoiceCatalogEntry[];
+    /** Optional locale filter for the visual voice selector. */
+    voiceLocale?: string;
+    /** Optional region filter for the visual voice selector. */
+    voiceRegion?: string;
+    /** Optional style filter for the visual voice selector. */
+    voiceStyle?: string;
     /** Candidate style values shown by the built-in emotion insertion. */
     emotionStyles?: readonly string[];
     /** Class name applied to the editor container. */
@@ -419,14 +325,6 @@ interface SsmlEditorRef {
 }
 declare const SsmlEditor: react.ForwardRefExoticComponent<SsmlEditorProps & react.RefAttributes<SsmlEditorRef>>;
 
-interface VisualSsmlEditorProps {
-    document: SsmlDocument;
-    readOnly?: boolean;
-    onChange?: (document: SsmlDocument) => void;
-    onPreviewSelection?: (ssml: string) => void;
-}
-declare function VisualSsmlEditor({ document, readOnly, onChange, onPreviewSelection, }: VisualSsmlEditorProps): ReactElement;
-
 type MonacoEditor = Parameters<OnMount>[0];
 
 interface SsmlTagRange {
@@ -448,4 +346,4 @@ type SsmlCodeLensAction = {
 type SsmlCodeLensCallback = (action: SsmlCodeLensAction) => void;
 declare function registerSsmlCodeLens(monaco: Monaco, editor: MonacoEditor, onOpenPopover: SsmlCodeLensCallback): ReturnType<Monaco["languages"]["registerCodeLensProvider"]>;
 
-export { EDITOR_COPY, type EditorCopy, INLINE_BADGE_COPY, type InlineBadgeCopy, SSML_HOVER_COPY, SSML_INSERTIONS, type SelectionInfo, type SsmlCodeLensAction, type SsmlCodeLensCallback, SsmlEditor, type SsmlEditorButton, type SsmlEditorButtonVisibility, type SsmlEditorCustomInsertion, type SsmlEditorCustomInsertionCollection, type SsmlEditorCustomInsertionDefinition, type SsmlEditorEditMode, type SsmlEditorInsertionButton, type SsmlEditorInsertionDefinition, type SsmlEditorInsertionGroup, type SsmlEditorInsertionMode, type SsmlEditorInsertionOption, type SsmlEditorInsertionTemplate, type SsmlEditorLanguage, type SsmlEditorLineNumbers, type SsmlEditorLocale, type SsmlEditorLocalizedText, type SsmlEditorOptions, type SsmlEditorProps, type SsmlEditorRef, type SsmlEditorTheme, type SsmlEditorToolbarGroup, type SsmlEditorWordWrap, type SsmlHoverLocale, type SsmlHoverParameterCopy, type SsmlHoverTagCopy, type SsmlInsertionDefinition, type SsmlInsertionOption, type SsmlInsertionTemplate, type SsmlTagRange, VisualSsmlEditor, type VisualSsmlEditorProps, createSsmlEditorInsertionDefinition, registerSsmlCodeLens, updateTagAttribute };
+export { EDITOR_COPY, type EditorCopy, INLINE_BADGE_COPY, type InlineBadgeCopy, SSML_ELEMENT_COPY, SSML_HOVER_COPY, SSML_INSERTIONS, type SelectionInfo, type SsmlCodeLensAction, type SsmlCodeLensCallback, SsmlEditor, type SsmlEditorButton, type SsmlEditorButtonVisibility, type SsmlEditorCustomInsertion, type SsmlEditorCustomInsertionCollection, type SsmlEditorCustomInsertionDefinition, type SsmlEditorEditMode, type SsmlEditorInsertionButton, type SsmlEditorInsertionDefinition, type SsmlEditorInsertionGroup, type SsmlEditorInsertionMode, type SsmlEditorInsertionOption, type SsmlEditorInsertionTemplate, type SsmlEditorLanguage, type SsmlEditorLineNumbers, type SsmlEditorLocale, type SsmlEditorLocalizedText, type SsmlEditorOptions, type SsmlEditorProps, type SsmlEditorRef, type SsmlEditorTheme, type SsmlEditorToolbarGroup, type SsmlEditorWordWrap, type SsmlElementLocaleCopy, type SsmlHoverLocale, type SsmlHoverParameterCopy, type SsmlHoverTagCopy, type SsmlInsertionDefinition, type SsmlInsertionOption, type SsmlInsertionTemplate, type SsmlTagRange, type VisualInspectorRenderProps, type VisualInspectorRenderer, VisualSsmlEditor, type VisualSsmlEditorProps, type VisualVoiceCatalogEntry, type VoiceSelectorRenderProps, createSsmlEditorInsertionDefinition, registerSsmlCodeLens, updateTagAttribute };