@ssml-builder-js/ssml-editor-react 2.10.0 → 2.12.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @ssml-builder-js/ssml-editor-react
 
+## 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
+
+- Release v2.11.0 with Azure voice catalog APIs and synchronization tools, expanded editor voice support, and stricter background audio validation.
+
+### Patch Changes
+
+- Updated dependencies
+  - @ssml-builder-js/ssml-core@2.11.0
+
 ## 2.10.0
 
 ### Minor Changes

package/dist/index.js

@@ -57,6 +57,7 @@ var ssmlPresets_exports = {};
 __export(ssmlPresets_exports, {
   AUDIO_DURATION_DESCRIPTIONS: () => AUDIO_DURATION_DESCRIPTIONS,
   AUDIO_DURATION_PRESETS: () => AUDIO_DURATION_PRESETS,
+  BACKGROUND_AUDIO_DURATION_PRESETS: () => BACKGROUND_AUDIO_DURATION_PRESETS,
   BREAK_STRENGTH_PRESETS: () => BREAK_STRENGTH_PRESETS,
   BREAK_TIME_DESCRIPTIONS: () => BREAK_TIME_DESCRIPTIONS,
   BREAK_TIME_PRESETS: () => BREAK_TIME_PRESETS,
@@ -138,6 +139,9 @@ var AZURE_VOICE_STYLE_MAP = {
   ],
   "es-ES-ElviraNeural": [],
   "fil-PH-AngeloNeural": [],
+  "fil-PH-Angelo:DragonHDLatestNeural": [],
+  "fil-PH-BlessicaNeural": [],
+  "fil-PH-Blessica:DragonHDLatestNeural": [],
   "fr-FR-DeniseNeural": ["cheerful", "sad"],
   "fr-FR-HenriNeural": ["cheerful", "sad"],
   "id-ID-GadisNeural": [],
@@ -415,6 +419,7 @@ var SAY_AS_PRESETS = [
 var LANGUAGE_PRESETS = ["ja-JP", "en-US", "de-DE", "fr-FR"];
 var SILENCE_VALUE_PRESETS = ["300ms", "500ms", "1s"];
 var AUDIO_DURATION_PRESETS = ["5s", "10s", "30s"];
+var BACKGROUND_AUDIO_DURATION_PRESETS = ["0", "500", "1000", "3000", "10000"];
 var SILENCE_TYPE_PRESETS = [
   "Leading",
   "Tailing",
@@ -476,8 +481,8 @@ var SSML_ATTRIBUTE_PRESETS = {
   },
   "mstts:backgroundaudio": {
     volume: PROSODY_VOLUME_PRESETS,
-    fadein: AUDIO_DURATION_PRESETS,
-    fadeout: AUDIO_DURATION_PRESETS
+    fadein: BACKGROUND_AUDIO_DURATION_PRESETS,
+    fadeout: BACKGROUND_AUDIO_DURATION_PRESETS
   },
   silence: {
     type: SILENCE_TYPE_PRESETS,
@@ -3326,7 +3331,7 @@ var SSML_COMPLETION_SNIPPETS = [
   },
   {
     label: "mstts:backgroundaudio",
-    insertText: `<mstts:backgroundaudio src="\${1:https://example.com/audio.mp3}" volume="\${2:-3dB}" />`
+    insertText: `<mstts:backgroundaudio src="\${1:https://example.com/audio.mp3}" volume="\${2:70}" fadein="\${3:1000}" fadeout="\${4:1000}" />`
   },
   {
     label: "mstts:ttsembedding",
@@ -4027,18 +4032,18 @@ var SSML_TAG_DEFINITIONS = [
       },
       {
         name: "volume",
-        description: "The background audio volume, for example `-3dB` or `medium`.",
-        example: "-3dB"
+        description: "The background audio volume from 0 to 100.",
+        example: "70"
       },
       {
         name: "fadein",
-        description: "The fade-in duration, for example `1s`.",
-        example: "1s"
+        description: "The fade-in duration in milliseconds from 0 to 10000.",
+        example: "1000"
       },
       {
         name: "fadeout",
-        description: "The fade-out duration, for example `500ms`.",
-        example: "500ms"
+        description: "The fade-out duration in milliseconds from 0 to 10000.",
+        example: "1000"
       }
     ]
   },
@@ -4694,6 +4699,181 @@ function updateNodesAtPath(nodes, path, update) {
 function updateTextAtPath(document2, path, value) {
   return { ...document2, children: updateNodesAtPath(document2.children ?? [], path, () => value) };
 }
+function getNodeAtPath(nodes, path) {
+  let current;
+  let currentNodes = nodes;
+  for (const index of path) {
+    current = currentNodes[index];
+    if (current === void 0) return void 0;
+    if (!isElement(current)) {
+      currentNodes = [];
+    } else {
+      currentNodes = current.children ?? [];
+    }
+  }
+  return current;
+}
+function updateElementAtPath(document2, path, update) {
+  return {
+    ...document2,
+    children: updateNodesAtPath(document2.children ?? [], path, (node) => isElement(node) ? update(node) : node)
+  };
+}
+function updateElementText(element, value) {
+  return { ...element, children: [value] };
+}
+function updateOptionalElementProperty(document2, path, property, value) {
+  return updateElementAtPath(document2, path, (element) => {
+    const next = { ...element };
+    if (value.trim()) next[property] = value;
+    else delete next[property];
+    return next;
+  });
+}
+var VISUAL_ELEMENT_FIELDS = {
+  voice: [
+    { key: "name", label: "Voice name" },
+    { key: "effect", label: "Effect" }
+  ],
+  prosody: [
+    { key: "rate", label: "Rate" },
+    { key: "pitch", label: "Pitch" },
+    { key: "volume", label: "Volume" },
+    { key: "contour", label: "Contour" },
+    { key: "range", label: "Range" }
+  ],
+  "express-as": [
+    { key: "style", label: "Style" },
+    { key: "styleDegree", label: "Style degree" },
+    { key: "role", label: "Role" }
+  ],
+  expressAs: [
+    { key: "style", label: "Style" },
+    { key: "styleDegree", label: "Style degree" },
+    { key: "role", label: "Role" }
+  ],
+  "mstts:express-as": [
+    { key: "style", label: "Style" },
+    { key: "styleDegree", label: "Style degree" },
+    { key: "role", label: "Role" }
+  ],
+  "say-as": [
+    { key: "interpretAs", label: "Interpret as" },
+    { key: "format", label: "Format" },
+    { key: "detail", label: "Detail" }
+  ],
+  sayAs: [
+    { key: "interpretAs", label: "Interpret as" },
+    { key: "format", label: "Format" },
+    { key: "detail", label: "Detail" }
+  ],
+  phoneme: [
+    { key: "alphabet", label: "Alphabet" },
+    { key: "ph", label: "Pronunciation" }
+  ],
+  emphasis: [{ key: "level", label: "Level" }],
+  audio: [
+    { key: "src", label: "Source URL" },
+    { key: "desc", label: "Description" },
+    { key: "clipBegin", label: "Clip begin" },
+    { key: "clipEnd", label: "Clip end" },
+    { key: "speed", label: "Speed" },
+    { key: "repeatCount", label: "Repeat count" },
+    { key: "repeatDuration", label: "Repeat duration" },
+    { key: "soundLevel", label: "Sound level" }
+  ],
+  mark: [{ key: "name", label: "Mark name" }],
+  bookmark: [{ key: "mark", label: "Bookmark name" }],
+  sub: [{ key: "alias", label: "Alias" }],
+  lang: [{ key: "lang", label: "Language" }],
+  lexicon: [{ key: "uri", label: "Lexicon URI" }],
+  "mstts:silence": [
+    { key: "typeValue", label: "Silence type" },
+    { key: "value", label: "Value" }
+  ],
+  silence: [
+    { key: "typeValue", label: "Silence type" },
+    { key: "value", label: "Value" }
+  ],
+  "mstts:audioduration": [{ key: "value", label: "Duration" }],
+  "mstts:ttsembedding": [{ key: "speakerProfileId", label: "Speaker profile ID" }],
+  "mstts:embedding": [
+    { key: "id", label: "Embedding ID" },
+    { key: "speakerProfileId", label: "Speaker profile ID" }
+  ],
+  "mstts:voiceconversion": [
+    { key: "url", label: "Source URL" },
+    { key: "profile", label: "Profile" },
+    { key: "speakerProfileId", label: "Speaker profile ID" }
+  ]
+};
+function getElementFields(element) {
+  return VISUAL_ELEMENT_FIELDS[elementLabel(element)] ?? [];
+}
+function VisualElementInspector({
+  document: document2,
+  element,
+  path,
+  readOnly,
+  commit
+}) {
+  const fields = getElementFields(element);
+  return /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("fieldset", { children: [
+    /* @__PURE__ */ (0, import_jsx_runtime6.jsx)("legend", { children: `<${elementLabel(element)}>` }),
+    fields.length === 0 ? /* @__PURE__ */ (0, import_jsx_runtime6.jsx)("p", { children: "This element is preserved in the visual tree. Edit its attributes in Code mode." }) : fields.map((field) => {
+      const value = element[field.key];
+      const inputValue = value === void 0 ? "" : String(value);
+      const inputId = `ssml-visual-${field.key}`;
+      return /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("label", { htmlFor: inputId, children: [
+        field.label,
+        field.multiline ? /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
+          "textarea",
+          {
+            id: inputId,
+            value: inputValue,
+            readOnly,
+            onChange: (event) => commit(updateOptionalElementProperty(document2, path, field.key, event.target.value))
+          }
+        ) : /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
+          "input",
+          {
+            id: inputId,
+            value: inputValue,
+            readOnly,
+            onChange: (event) => commit(updateOptionalElementProperty(document2, path, field.key, event.target.value))
+          }
+        )
+      ] }, field.key);
+    })
+  ] });
+}
+function getElementAncestors(nodes, path, ancestors = []) {
+  const [index, ...rest] = path;
+  const node = nodes[index];
+  if (!node || !isElement(node)) return ancestors;
+  if (rest.length === 0) return ancestors;
+  return getElementAncestors(node.children ?? [], rest, [...ancestors, node]);
+}
+function buildVisualPreview(document2, leaf, selection) {
+  const start = Math.max(0, Math.min(selection.start, leaf.value.length));
+  const end = Math.max(start, Math.min(selection.end, leaf.value.length));
+  const value = start === end ? leaf.value : leaf.value.slice(start, end);
+  const ancestors = getElementAncestors(document2.children ?? [], leaf.path);
+  const children = ancestors.reduceRight(
+    (current, ancestor) => [{ ...ancestor, children: current }],
+    [value]
+  );
+  return (0, import_ssml_core4.buildSsml)({ ...document2, children });
+}
+function addDialogTurn(document2, path) {
+  return updateElementAtPath(document2, path, (element) => ({
+    ...element,
+    children: [
+      ...element.children ?? [],
+      { type: "mstts:turn", voice: "en-US-JennyNeural", children: ["New dialog turn"] }
+    ]
+  }));
+}
 function wrapTextAtPath(document2, path, start, end, tag, attributes) {
   return {
     ...document2,
@@ -4748,6 +4928,7 @@ function VisualSsmlEditor({
   const [selection, setSelection] = (0, import_react3.useState)({ start: 0, end: 0 });
   const textLeaves = (0, import_react3.useMemo)(() => collectTextLeaves(document2.children ?? []), [document2]);
   const selectedLeaf = textLeaves.find((leaf) => leaf.path.join(".") === selectedPath?.join(".")) ?? textLeaves[0];
+  const selectedElement = selectedPath ? getNodeAtPath(document2.children ?? [], selectedPath) : void 0;
   const diagnostics = (0, import_react3.useMemo)(() => (0, import_ssml_core4.validateAzureSsml)((0, import_ssml_core4.buildSsml)(document2)), [document2]);
   const commit = (nextDocument) => onChange?.(nextDocument);
   const applyWrapper = (tag, attributes) => {
@@ -4782,7 +4963,115 @@ function VisualSsmlEditor({
           isElement(node) ? elementLabel(node) : JSON.stringify(node)
         )) })
       ] }),
-      /* @__PURE__ */ (0, import_jsx_runtime6.jsx)("div", { className: "ssml-editor-visual-form", children: selectedLeaf ? /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)(import_jsx_runtime6.Fragment, { children: [
+      /* @__PURE__ */ (0, import_jsx_runtime6.jsx)("div", { className: "ssml-editor-visual-form", children: selectedElement && isElement(selectedElement) && selectedElement.type === "mstts:dialog" ? /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("fieldset", { children: [
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsx)("legend", { children: "Dialog" }),
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsx)("p", { children: "Add and edit speaker turns in this dialog." }),
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
+          "button",
+          {
+            type: "button",
+            disabled: readOnly,
+            onClick: () => commit(addDialogTurn(document2, selectedPath ?? [])),
+            children: "Add turn"
+          }
+        )
+      ] }) : selectedElement && isElement(selectedElement) && selectedElement.type === "mstts:turn" ? /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("fieldset", { children: [
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsx)("legend", { children: "Dialog turn" }),
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("label", { children: [
+          "Voice",
+          /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
+            "input",
+            {
+              value: selectedElement.voice ?? "",
+              readOnly,
+              onChange: (event) => commit(updateOptionalElementProperty(document2, selectedPath ?? [], "voice", event.target.value))
+            }
+          )
+        ] }),
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("label", { children: [
+          "Speaker",
+          /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
+            "input",
+            {
+              value: selectedElement.speaker ?? "",
+              readOnly,
+              onChange: (event) => commit(updateOptionalElementProperty(document2, selectedPath ?? [], "speaker", event.target.value))
+            }
+          )
+        ] }),
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("label", { children: [
+          "Turn text",
+          /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
+            "textarea",
+            {
+              value: selectedElement.children?.filter((child) => typeof child === "string").join("") ?? "",
+              readOnly,
+              onChange: (event) => commit(
+                updateElementAtPath(
+                  document2,
+                  selectedPath ?? [],
+                  (element) => updateElementText(element, event.target.value)
+                )
+              )
+            }
+          )
+        ] })
+      ] }) : selectedElement && isElement(selectedElement) && selectedElement.type === "mstts:backgroundaudio" ? /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("fieldset", { children: [
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsx)("legend", { children: "Background audio" }),
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("label", { children: [
+          "Source URL",
+          /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
+            "input",
+            {
+              value: selectedElement.src ?? "",
+              readOnly,
+              onChange: (event) => commit(updateOptionalElementProperty(document2, selectedPath ?? [], "src", event.target.value))
+            }
+          )
+        ] }),
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("label", { children: [
+          "Volume",
+          /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
+            "input",
+            {
+              value: selectedElement.volume === void 0 ? "" : String(selectedElement.volume),
+              readOnly,
+              onChange: (event) => commit(updateOptionalElementProperty(document2, selectedPath ?? [], "volume", event.target.value))
+            }
+          )
+        ] }),
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("label", { children: [
+          "Fade in",
+          /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
+            "input",
+            {
+              value: selectedElement.fadeIn === void 0 ? "" : String(selectedElement.fadeIn),
+              readOnly,
+              onChange: (event) => commit(updateOptionalElementProperty(document2, selectedPath ?? [], "fadeIn", event.target.value))
+            }
+          )
+        ] }),
+        /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("label", { children: [
+          "Fade out",
+          /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
+            "input",
+            {
+              value: selectedElement.fadeOut === void 0 ? "" : String(selectedElement.fadeOut),
+              readOnly,
+              onChange: (event) => commit(updateOptionalElementProperty(document2, selectedPath ?? [], "fadeOut", event.target.value))
+            }
+          )
+        ] })
+      ] }) : selectedElement && isElement(selectedElement) ? /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
+        VisualElementInspector,
+        {
+          document: document2,
+          element: selectedElement,
+          path: selectedPath ?? [],
+          readOnly,
+          commit
+        }
+      ) : selectedLeaf ? /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)(import_jsx_runtime6.Fragment, { children: [
         /* @__PURE__ */ (0, import_jsx_runtime6.jsxs)("label", { children: [
           "Text",
           /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(
@@ -4822,7 +5111,7 @@ function VisualSsmlEditor({
             "button",
             {
               type: "button",
-              onClick: () => onPreviewSelection((0, import_ssml_core4.buildSsml)({ ...document2, children: [selectedLeaf.value] })),
+              onClick: () => onPreviewSelection(buildVisualPreview(document2, selectedLeaf, selection)),
               children: "Preview selection"
             }
           )