@ssml-builder-js/ssml-editor-react 2.11.0 → 2.13.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @ssml-builder-js/ssml-editor-react
 
+## 2.13.0
+
+### Minor Changes
+
+- Add structured SSML chunk metadata and background-audio replication policies, merged synthesis synchronization offsets, safe preflight synthesis with custom URL validation, chunk progress reporting, source tracking, and extensible Japanese-localized Visual Editor controls.
+
+### Patch Changes
+
+- Updated dependencies
+  - @ssml-builder-js/ssml-core@2.13.0
+
+## 2.12.0
+
+### Minor Changes
+
+- Add Visual Editor forms for the supported SSML and Azure extension elements and preserve parent context during selection preview.
+
 ## 2.11.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import * as react from 'react';
-import { ReactNode, CSSProperties, ReactElement } from 'react';
-import { SsmlDocument } from '@ssml-builder-js/ssml-core';
+import { ReactNode, ReactElement, CSSProperties } from 'react';
+import { SsmlDocument, SsmlElement } from '@ssml-builder-js/ssml-core';
 import { OnMount, Monaco } from '@monaco-editor/react';
 
 type SsmlEditorInsertionButton = "break" | "emphasis" | "rate" | "pitch" | "volume" | "emotion" | "say-as" | "phoneme" | "audio" | "sub" | "lang" | "mark" | "bookmark" | "mstts:silence" | "mstts:audioduration" | "mstts:viseme" | (string & {});
@@ -63,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;
@@ -239,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. */
@@ -267,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 {
@@ -296,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 };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react from 'react';
-import { ReactNode, CSSProperties, ReactElement } from 'react';
-import { SsmlDocument } from '@ssml-builder-js/ssml-core';
+import { ReactNode, ReactElement, CSSProperties } from 'react';
+import { SsmlDocument, SsmlElement } from '@ssml-builder-js/ssml-core';
 import { OnMount, Monaco } from '@monaco-editor/react';
 
 type SsmlEditorInsertionButton = "break" | "emphasis" | "rate" | "pitch" | "volume" | "emotion" | "say-as" | "phoneme" | "audio" | "sub" | "lang" | "mark" | "bookmark" | "mstts:silence" | "mstts:audioduration" | "mstts:viseme" | (string & {});
@@ -63,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;
@@ -239,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. */
@@ -267,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 {
@@ -296,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 };