ssml-builder-js 1.0.0

package/dist/react.d.mts

@@ -0,0 +1,373 @@
+import * as react from 'react';
+import { ReactNode, CSSProperties } from '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 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 | 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:viseme" | (string & {});
+type SsmlEditorButton = "help" | SsmlEditorInsertionButton | "undo" | "redo" | "clearAll" | "format" | "decorations" | (string & {});
+type SsmlEditorButtonVisibility = Readonly<Partial<Record<string, boolean>>>;
+
+type SsmlEditorLocale = "ja" | "en";
+type SsmlEditorLanguage = SsmlEditorLocale;
+type SsmlEditorLocalizedText = Readonly<Record<SsmlEditorLocale, string>>;
+interface EditorCopy {
+    editorAriaLabel: string;
+    toolbarAriaLabel: string;
+    undo: string;
+    undoTitle: string;
+    redo: string;
+    redoTitle: string;
+    clearAll: string;
+    clearAllTitle: string;
+    help: string;
+    helpTitle: string;
+    helpHeading: string;
+    helpDescription: string;
+    parameters: string;
+    format: string;
+    formatTitle: string;
+    decorations: string;
+    decorationsShowTitle: string;
+    decorationsHideTitle: string;
+    syntaxError: string;
+    selectionActions: string;
+    selectionCountSuffix: string;
+    previewSelection: string;
+    previewSelectionTitle: string;
+}
+interface InlineBadgeCopy {
+    pause: string;
+    pitch: string;
+    prosody: string;
+}
+interface SsmlHoverParameterCopy {
+    title: string;
+    description: string;
+}
+interface SsmlHoverTagCopy {
+    title: string;
+    description: string;
+    parameters: Readonly<Record<string, SsmlHoverParameterCopy>>;
+}
+interface SsmlHoverLocale {
+    parameterHeading: string;
+    parametersHeading: string;
+    allowedValues: string;
+    example: string;
+    noParameters: string;
+    tags: Readonly<Record<string, SsmlHoverTagCopy>>;
+}
+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>>;
+
+type SsmlEditorInsertionMode = "insert" | "wrap";
+interface SsmlEditorInsertionOption {
+    value: string;
+    labels: SsmlEditorLocalizedText;
+    descriptions?: SsmlEditorLocalizedText;
+}
+interface SsmlEditorInsertionTemplate {
+    prefix: string;
+    suffix: string;
+    mode: SsmlEditorInsertionMode;
+}
+interface SsmlEditorInsertionDefinition {
+    id: string;
+    icon: string;
+    tagName?: string;
+    selfClosing?: boolean;
+    labels: SsmlEditorLocalizedText;
+    titles?: SsmlEditorLocalizedText;
+    descriptions: SsmlEditorLocalizedText;
+    parameterDescription: SsmlEditorLocalizedText;
+    options: readonly SsmlEditorInsertionOption[];
+    createTemplate: (value: string) => SsmlEditorInsertionTemplate;
+}
+interface SsmlEditorCustomInsertionDefinition {
+    id: string;
+    tagName: string;
+    attribute?: string;
+    icon?: string;
+    labels: SsmlEditorLocalizedText;
+    titles?: SsmlEditorLocalizedText;
+    descriptions?: SsmlEditorLocalizedText;
+    parameterDescription?: SsmlEditorLocalizedText;
+    options: readonly SsmlEditorInsertionOption[];
+    mode?: SsmlEditorInsertionMode;
+}
+type SsmlEditorCustomInsertion = SsmlEditorInsertionDefinition | SsmlEditorCustomInsertionDefinition;
+type SsmlEditorCustomInsertionCollection = readonly SsmlEditorCustomInsertion[] | Readonly<Record<string, SsmlEditorCustomInsertion | undefined>>;
+interface SsmlEditorInsertionGroup {
+    id: string;
+    labels: SsmlEditorLocalizedText;
+    insertionIds: readonly string[];
+}
+interface SsmlEditorToolbarGroup {
+    id: string;
+    buttonIds: readonly string[];
+}
+type SsmlEditorTheme = "system" | "light" | "dark";
+type SsmlEditorWordWrap = "off" | "on" | "wordWrapColumn" | "bounded";
+type SsmlEditorLineNumbers = "on" | "off" | "relative" | "interval";
+interface SsmlEditorOptions {
+    height?: string | number;
+    minHeight?: string | number;
+    readOnly?: boolean;
+    theme?: SsmlEditorTheme;
+    fontSize?: number;
+    wordWrap?: SsmlEditorWordWrap;
+    lineNumbers?: SsmlEditorLineNumbers;
+    minimap?: boolean;
+    automaticLayout?: boolean;
+}
+type SsmlInsertionOption = SsmlEditorInsertionOption;
+type SsmlInsertionTemplate = SsmlEditorInsertionTemplate;
+type SsmlInsertionDefinition = SsmlEditorInsertionDefinition;
+declare function createSsmlEditorInsertionDefinition(definition: SsmlEditorCustomInsertionDefinition): SsmlEditorInsertionDefinition;
+declare const SSML_INSERTIONS: ({
+    id: string;
+    icon: string;
+    tagName: string;
+    selfClosing: true;
+    labels: {
+        ja: string;
+        en: string;
+    };
+    descriptions: {
+        ja: string;
+        en: string;
+    };
+    parameterDescription: {
+        ja: string;
+        en: string;
+    };
+    options: readonly SsmlEditorInsertionOption[];
+    createTemplate: (value: string) => {
+        prefix: string;
+        suffix: string;
+        mode: "insert";
+    };
+} | {
+    id: string;
+    icon: string;
+    tagName: string;
+    labels: {
+        ja: string;
+        en: string;
+    };
+    descriptions: {
+        ja: string;
+        en: string;
+    };
+    parameterDescription: {
+        ja: string;
+        en: string;
+    };
+    options: readonly SsmlEditorInsertionOption[];
+    createTemplate: (value: string) => {
+        prefix: string;
+        suffix: string;
+        mode: "wrap";
+    };
+    selfClosing?: undefined;
+})[];
+interface SsmlEditorProps {
+    document: SsmlDocument;
+    onChange?: (document: SsmlDocument) => void;
+    onSsmlChange?: (xml: string) => void;
+    onSelectionChange?: (info: SelectionInfo) => void;
+    /** Called with the selected partial SSML when the selection preview action is used. The action is disabled when omitted. */
+    onPreviewSelection?: (ssml: string) => void;
+    /** UI language. Japanese is used when omitted. */
+    language?: SsmlEditorLanguage;
+    /** UI locale. Japanese is used when omitted; takes precedence over the legacy language prop. */
+    locale?: SsmlEditorLocale;
+    /** Whether the toolbar is displayed. */
+    showToolbar?: boolean;
+    /** Whether toolbar action icons are displayed. */
+    showToolbarIcons?: boolean;
+    /** Whether toolbar action text labels are displayed. */
+    showToolbarLabels?: boolean;
+    /** Whether inline SSML decorations are displayed. The toolbar switch can change this at runtime. */
+    showDecorations?: boolean;
+    /** Controls which editor action buttons are displayed. Unspecified buttons are shown. */
+    buttonVisibility?: SsmlEditorButtonVisibility;
+    /** Monaco editor settings. */
+    editorOptions?: SsmlEditorOptions;
+    /** Alias for editorOptions. */
+    settings?: SsmlEditorOptions;
+    /** Fallback UI displayed while Monaco is loading. */
+    loadingFallback?: ReactNode;
+    /** Height of the Monaco editor. */
+    height?: string | number;
+    /** Minimum height of the Monaco editor container. */
+    minHeight?: string | number;
+    /** Whether the Monaco editor is read-only. */
+    readOnly?: boolean;
+    /** Monaco theme mode. */
+    theme?: SsmlEditorTheme;
+    /** Monaco editor font size. */
+    fontSize?: number;
+    /** Monaco editor word wrapping mode. */
+    wordWrap?: SsmlEditorWordWrap;
+    /** Monaco editor line number mode. */
+    lineNumbers?: SsmlEditorLineNumbers;
+    /** Whether the Monaco minimap is displayed. */
+    minimap?: boolean;
+    /** Whether Monaco automatically lays out when its container changes size. */
+    automaticLayout?: boolean;
+    /** Reorders all toolbar controls. Unlisted controls follow. */
+    toolbarOrder?: readonly SsmlEditorButton[];
+    /** Adds vertical separators between configured toolbar groups. */
+    toolbarGroups?: readonly SsmlEditorToolbarGroup[];
+    /** Reorders built-in and custom insertion menus. Unlisted insertions follow. */
+    insertionOrder?: readonly string[];
+    /** Visually groups insertion menus when toolbarGroups is not supplied. */
+    insertionGroups?: readonly SsmlEditorInsertionGroup[];
+    /** Replaces built-in insertion definitions with custom definitions by ID. */
+    customInsertions?: SsmlEditorCustomInsertionCollection;
+    /** Adds insertion definitions without replacing built-in definitions. */
+    additionalInsertions?: SsmlEditorCustomInsertionCollection;
+    /** Candidate style values shown by the built-in emotion insertion. */
+    emotionStyles?: readonly string[];
+    /** Class name applied to the editor container. */
+    className?: string;
+    /** Inline styles applied to the editor container. */
+    style?: CSSProperties;
+    /** Class name applied to the toolbar. */
+    toolbarClassName?: string;
+    /** Inline styles applied to the toolbar. */
+    toolbarStyle?: CSSProperties;
+    /** Class name applied to the editor display area. */
+    displayClassName?: string;
+    /** Inline styles applied to the editor display area. */
+    displayStyle?: CSSProperties;
+}
+interface SelectionInfo {
+    selectedText: string;
+    characterCount: number;
+    hasSelection: boolean;
+}
+interface SsmlEditorRef {
+    getSelectedSsml(): string | null;
+    getCurrentLineSsml(): string | null;
+    getFullSsml(): string;
+}
+declare const SsmlEditor: react.ForwardRefExoticComponent<SsmlEditorProps & react.RefAttributes<SsmlEditorRef>>;
+
+export { EDITOR_COPY, type EditorCopy, INLINE_BADGE_COPY, type InlineBadgeCopy, SSML_HOVER_COPY, SSML_INSERTIONS, type SelectionInfo, SsmlEditor, type SsmlEditorButton, type SsmlEditorButtonVisibility, type SsmlEditorCustomInsertion, type SsmlEditorCustomInsertionCollection, type SsmlEditorCustomInsertionDefinition, 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, createSsmlEditorInsertionDefinition };