@naersen/tts-rich-text 0.8.3 → 0.9.0

package/dist/components/tts-rich-text/editor/useRichTextEditor.d.ts

@@ -3,6 +3,7 @@ import { Editor, JSONContent } from '@tiptap/core';
 import { NotificationType, TtsEditorFeatures, TtsRichTextServices } from '../../../type';
 import { DriveModeEnum } from '../constants';
 import { CustomTagType } from '../../../core';
+import { ToolModalOpeners } from './type';
 export interface UseRichTextEditorOptions {
     content?: JSONContent;
     textLimitLength?: number;
@@ -93,6 +94,50 @@ export declare function useRichTextEditor(options?: UseRichTextEditorOptions): {
     replaceContentWithText: (text: string) => void;
     textLength: import('vue').ComputedRef<number>;
     voiceVersion: Ref<number, number>;
+    lockedTool: Ref<CustomTagType | null, CustomTagType | null>;
+    lockParams: Ref<{
+        replace?: Record<string, string | number> | undefined;
+        stop?: Record<string, string | number> | undefined;
+        ignore?: Record<string, string | number> | undefined;
+        customStop?: Record<string, string | number> | undefined;
+        continue?: Record<string, string | number> | undefined;
+        pinyin?: Record<string, string | number> | undefined;
+        language?: Record<string, string | number> | undefined;
+    }, Partial<Record<CustomTagType, Record<string, string | number>>> | {
+        replace?: Record<string, string | number> | undefined;
+        stop?: Record<string, string | number> | undefined;
+        ignore?: Record<string, string | number> | undefined;
+        customStop?: Record<string, string | number> | undefined;
+        continue?: Record<string, string | number> | undefined;
+        pinyin?: Record<string, string | number> | undefined;
+        language?: Record<string, string | number> | undefined;
+    }>;
+    toggleLockTool: (type: CustomTagType) => boolean;
+    unlockTool: () => void;
+    isToolLocked: (type: CustomTagType) => boolean;
+    rememberToolParams: (type: CustomTagType, payload: Record<string, string | number>) => void;
+    getLockedPayload: (type: CustomTagType) => Record<string, string | number>;
+    contextMenu: {
+        visible: boolean;
+        x: number;
+        y: number;
+        hasSelection: boolean;
+    };
+    closeContextMenu: () => void;
+    toolModalOpeners: Ref<{
+        pinyin: (text: string) => void;
+        replace: (text: string) => void;
+        formula: (text: string) => void;
+        aiRewrite: () => void;
+        upload: () => void;
+    } | null, ToolModalOpeners | {
+        pinyin: (text: string) => void;
+        replace: (text: string) => void;
+        formula: (text: string) => void;
+        aiRewrite: () => void;
+        upload: () => void;
+    } | null>;
+    registerToolModalOpeners: (openers: ToolModalOpeners) => void;
 };
 export type RichTextEditor = ReturnType<typeof useRichTextEditor>;
 export declare const useEditorProvider: (context: RichTextEditor) => void;
@@ -152,4 +197,48 @@ export declare const useEditorContext: () => {
     replaceContentWithText: (text: string) => void;
     textLength: import('vue').ComputedRef<number>;
     voiceVersion: Ref<number, number>;
+    lockedTool: Ref<CustomTagType | null, CustomTagType | null>;
+    lockParams: Ref<{
+        replace?: Record<string, string | number> | undefined;
+        stop?: Record<string, string | number> | undefined;
+        ignore?: Record<string, string | number> | undefined;
+        customStop?: Record<string, string | number> | undefined;
+        continue?: Record<string, string | number> | undefined;
+        pinyin?: Record<string, string | number> | undefined;
+        language?: Record<string, string | number> | undefined;
+    }, Partial<Record<CustomTagType, Record<string, string | number>>> | {
+        replace?: Record<string, string | number> | undefined;
+        stop?: Record<string, string | number> | undefined;
+        ignore?: Record<string, string | number> | undefined;
+        customStop?: Record<string, string | number> | undefined;
+        continue?: Record<string, string | number> | undefined;
+        pinyin?: Record<string, string | number> | undefined;
+        language?: Record<string, string | number> | undefined;
+    }>;
+    toggleLockTool: (type: CustomTagType) => boolean;
+    unlockTool: () => void;
+    isToolLocked: (type: CustomTagType) => boolean;
+    rememberToolParams: (type: CustomTagType, payload: Record<string, string | number>) => void;
+    getLockedPayload: (type: CustomTagType) => Record<string, string | number>;
+    contextMenu: {
+        visible: boolean;
+        x: number;
+        y: number;
+        hasSelection: boolean;
+    };
+    closeContextMenu: () => void;
+    toolModalOpeners: Ref<{
+        pinyin: (text: string) => void;
+        replace: (text: string) => void;
+        formula: (text: string) => void;
+        aiRewrite: () => void;
+        upload: () => void;
+    } | null, ToolModalOpeners | {
+        pinyin: (text: string) => void;
+        replace: (text: string) => void;
+        formula: (text: string) => void;
+        aiRewrite: () => void;
+        upload: () => void;
+    } | null>;
+    registerToolModalOpeners: (openers: ToolModalOpeners) => void;
 };

package/dist/components/tts-rich-text/index.d.ts

@@ -1,4 +1,5 @@
 export { default as TtsAiRewriteModal } from './components/ai-rewrite-modal.vue';
+export { default as TtsEditorContextMenu } from './components/editor-context-menu.vue';
 export { default as TtsEditorFooter } from './components/editor-footer.vue';
 export { default as TtsEditorToolbar } from './components/editor-toolbar.vue';
 export { default as TtsFormulaModal } from './components/formula-modal.vue';

package/dist/components/tts-rich-text-editor/index.vue.d.ts

@@ -104,6 +104,50 @@ declare function __VLS_template(): {
                 replaceContentWithText: (text: string) => void;
                 textLength: import('vue').ComputedRef<number>;
                 voiceVersion: import('vue').Ref<number, number>;
+                lockedTool: import('vue').Ref<import('../../core').CustomTagType | null, import('../../core').CustomTagType | null>;
+                lockParams: import('vue').Ref<{
+                    replace?: Record<string, string | number> | undefined;
+                    stop?: Record<string, string | number> | undefined;
+                    ignore?: Record<string, string | number> | undefined;
+                    customStop?: Record<string, string | number> | undefined;
+                    continue?: Record<string, string | number> | undefined;
+                    pinyin?: Record<string, string | number> | undefined;
+                    language?: Record<string, string | number> | undefined;
+                }, Partial<Record<import('../../core').CustomTagType, Record<string, string | number>>> | {
+                    replace?: Record<string, string | number> | undefined;
+                    stop?: Record<string, string | number> | undefined;
+                    ignore?: Record<string, string | number> | undefined;
+                    customStop?: Record<string, string | number> | undefined;
+                    continue?: Record<string, string | number> | undefined;
+                    pinyin?: Record<string, string | number> | undefined;
+                    language?: Record<string, string | number> | undefined;
+                }>;
+                toggleLockTool: (type: import('../../core').CustomTagType) => boolean;
+                unlockTool: () => void;
+                isToolLocked: (type: import('../../core').CustomTagType) => boolean;
+                rememberToolParams: (type: import('../../core').CustomTagType, payload: Record<string, string | number>) => void;
+                getLockedPayload: (type: import('../../core').CustomTagType) => Record<string, string | number>;
+                contextMenu: {
+                    visible: boolean;
+                    x: number;
+                    y: number;
+                    hasSelection: boolean;
+                };
+                closeContextMenu: () => void;
+                toolModalOpeners: import('vue').Ref<{
+                    pinyin: (text: string) => void;
+                    replace: (text: string) => void;
+                    formula: (text: string) => void;
+                    aiRewrite: () => void;
+                    upload: () => void;
+                } | null, import('../..').ToolModalOpeners | {
+                    pinyin: (text: string) => void;
+                    replace: (text: string) => void;
+                    formula: (text: string) => void;
+                    aiRewrite: () => void;
+                    upload: () => void;
+                } | null>;
+                registerToolModalOpeners: (openers: import('../..').ToolModalOpeners) => void;
             }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
                 change: () => any;
                 ready: (editor: Editor) => any;
@@ -148,7 +192,7 @@ declare function __VLS_template(): {
         }> & Omit<Readonly<import('../../type').TtsEditorRootProps> & Readonly<{
             onChange?: (() => any) | undefined;
             onReady?: ((editor: Editor) => any) | undefined;
-        }>, "clear" | "getPlaybackSpeed" | "editor" | "focus" | "textLimitLength" | "notify" | "getGenerateAudioParams" | "clearContent" | "setContent" | "insertToken" | "insertWrappedToken" | "getSelectedText" | "getSelectedJson" | "selectedText" | "hasSelectedText" | "isSelectedPureNumber" | "driveMode" | "getReferencedVirtualElement" | "replaceContentWithText" | "textLength" | "handleChangeVoice" | ("disabled" | "placeholder" | "textLimit" | "voiceVersion" | "features" | "services" | "showSelectionMenu" | "initialContent") | "getJson" | "getTtsData" | "replaceText"> & {
+        }>, "clear" | "getPlaybackSpeed" | "editor" | "focus" | "textLimitLength" | "notify" | "getGenerateAudioParams" | "clearContent" | "setContent" | "insertToken" | "insertWrappedToken" | "getSelectedText" | "getSelectedJson" | "selectedText" | "hasSelectedText" | "isSelectedPureNumber" | "replaceText" | "toolModalOpeners" | "rememberToolParams" | "driveMode" | "getReferencedVirtualElement" | "replaceContentWithText" | "textLength" | "lockedTool" | "lockParams" | "toggleLockTool" | "unlockTool" | "isToolLocked" | "getLockedPayload" | "contextMenu" | "closeContextMenu" | "registerToolModalOpeners" | "handleChangeVoice" | ("disabled" | "placeholder" | "textLimit" | "voiceVersion" | "features" | "services" | "showSelectionMenu" | "initialContent") | "getJson" | "getTtsData"> & {
             clear: () => void;
             focus: () => void;
             getJson: () => JSONContent;
@@ -198,6 +242,36 @@ declare function __VLS_template(): {
             replaceContentWithText: (text: string) => void;
             textLength: number;
             voiceVersion: number;
+            lockedTool: import('../../core').CustomTagType | null;
+            lockParams: {
+                replace?: Record<string, string | number> | undefined;
+                stop?: Record<string, string | number> | undefined;
+                ignore?: Record<string, string | number> | undefined;
+                customStop?: Record<string, string | number> | undefined;
+                continue?: Record<string, string | number> | undefined;
+                pinyin?: Record<string, string | number> | undefined;
+                language?: Record<string, string | number> | undefined;
+            };
+            toggleLockTool: (type: import('../../core').CustomTagType) => boolean;
+            unlockTool: () => void;
+            isToolLocked: (type: import('../../core').CustomTagType) => boolean;
+            rememberToolParams: (type: import('../../core').CustomTagType, payload: Record<string, string | number>) => void;
+            getLockedPayload: (type: import('../../core').CustomTagType) => Record<string, string | number>;
+            contextMenu: {
+                visible: boolean;
+                x: number;
+                y: number;
+                hasSelection: boolean;
+            };
+            closeContextMenu: () => void;
+            toolModalOpeners: {
+                pinyin: (text: string) => void;
+                replace: (text: string) => void;
+                formula: (text: string) => void;
+                aiRewrite: () => void;
+                upload: () => void;
+            } | null;
+            registerToolModalOpeners: (openers: import('../..').ToolModalOpeners) => void;
         } & {} & import('vue').ComponentCustomProperties & {} & {
             $slots: Readonly<{
                 default(): unknown;
@@ -317,6 +391,50 @@ declare const __VLS_component: import('vue').DefineComponent<TtsRichTextEditorPr
             replaceContentWithText: (text: string) => void;
             textLength: import('vue').ComputedRef<number>;
             voiceVersion: import('vue').Ref<number, number>;
+            lockedTool: import('vue').Ref<import('../../core').CustomTagType | null, import('../../core').CustomTagType | null>;
+            lockParams: import('vue').Ref<{
+                replace?: Record<string, string | number> | undefined;
+                stop?: Record<string, string | number> | undefined;
+                ignore?: Record<string, string | number> | undefined;
+                customStop?: Record<string, string | number> | undefined;
+                continue?: Record<string, string | number> | undefined;
+                pinyin?: Record<string, string | number> | undefined;
+                language?: Record<string, string | number> | undefined;
+            }, Partial<Record<import('../../core').CustomTagType, Record<string, string | number>>> | {
+                replace?: Record<string, string | number> | undefined;
+                stop?: Record<string, string | number> | undefined;
+                ignore?: Record<string, string | number> | undefined;
+                customStop?: Record<string, string | number> | undefined;
+                continue?: Record<string, string | number> | undefined;
+                pinyin?: Record<string, string | number> | undefined;
+                language?: Record<string, string | number> | undefined;
+            }>;
+            toggleLockTool: (type: import('../../core').CustomTagType) => boolean;
+            unlockTool: () => void;
+            isToolLocked: (type: import('../../core').CustomTagType) => boolean;
+            rememberToolParams: (type: import('../../core').CustomTagType, payload: Record<string, string | number>) => void;
+            getLockedPayload: (type: import('../../core').CustomTagType) => Record<string, string | number>;
+            contextMenu: {
+                visible: boolean;
+                x: number;
+                y: number;
+                hasSelection: boolean;
+            };
+            closeContextMenu: () => void;
+            toolModalOpeners: import('vue').Ref<{
+                pinyin: (text: string) => void;
+                replace: (text: string) => void;
+                formula: (text: string) => void;
+                aiRewrite: () => void;
+                upload: () => void;
+            } | null, import('../..').ToolModalOpeners | {
+                pinyin: (text: string) => void;
+                replace: (text: string) => void;
+                formula: (text: string) => void;
+                aiRewrite: () => void;
+                upload: () => void;
+            } | null>;
+            registerToolModalOpeners: (openers: import('../..').ToolModalOpeners) => void;
         }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
             change: () => any;
             ready: (editor: Editor) => any;
@@ -361,7 +479,7 @@ declare const __VLS_component: import('vue').DefineComponent<TtsRichTextEditorPr
     }> & Omit<Readonly<import('../../type').TtsEditorRootProps> & Readonly<{
         onChange?: (() => any) | undefined;
         onReady?: ((editor: Editor) => any) | undefined;
-    }>, "clear" | "getPlaybackSpeed" | "editor" | "focus" | "textLimitLength" | "notify" | "getGenerateAudioParams" | "clearContent" | "setContent" | "insertToken" | "insertWrappedToken" | "getSelectedText" | "getSelectedJson" | "selectedText" | "hasSelectedText" | "isSelectedPureNumber" | "driveMode" | "getReferencedVirtualElement" | "replaceContentWithText" | "textLength" | "handleChangeVoice" | ("disabled" | "placeholder" | "textLimit" | "voiceVersion" | "features" | "services" | "showSelectionMenu" | "initialContent") | "getJson" | "getTtsData" | "replaceText"> & {
+    }>, "clear" | "getPlaybackSpeed" | "editor" | "focus" | "textLimitLength" | "notify" | "getGenerateAudioParams" | "clearContent" | "setContent" | "insertToken" | "insertWrappedToken" | "getSelectedText" | "getSelectedJson" | "selectedText" | "hasSelectedText" | "isSelectedPureNumber" | "replaceText" | "toolModalOpeners" | "rememberToolParams" | "driveMode" | "getReferencedVirtualElement" | "replaceContentWithText" | "textLength" | "lockedTool" | "lockParams" | "toggleLockTool" | "unlockTool" | "isToolLocked" | "getLockedPayload" | "contextMenu" | "closeContextMenu" | "registerToolModalOpeners" | "handleChangeVoice" | ("disabled" | "placeholder" | "textLimit" | "voiceVersion" | "features" | "services" | "showSelectionMenu" | "initialContent") | "getJson" | "getTtsData"> & {
         clear: () => void;
         focus: () => void;
         getJson: () => JSONContent;
@@ -411,6 +529,36 @@ declare const __VLS_component: import('vue').DefineComponent<TtsRichTextEditorPr
         replaceContentWithText: (text: string) => void;
         textLength: number;
         voiceVersion: number;
+        lockedTool: import('../../core').CustomTagType | null;
+        lockParams: {
+            replace?: Record<string, string | number> | undefined;
+            stop?: Record<string, string | number> | undefined;
+            ignore?: Record<string, string | number> | undefined;
+            customStop?: Record<string, string | number> | undefined;
+            continue?: Record<string, string | number> | undefined;
+            pinyin?: Record<string, string | number> | undefined;
+            language?: Record<string, string | number> | undefined;
+        };
+        toggleLockTool: (type: import('../../core').CustomTagType) => boolean;
+        unlockTool: () => void;
+        isToolLocked: (type: import('../../core').CustomTagType) => boolean;
+        rememberToolParams: (type: import('../../core').CustomTagType, payload: Record<string, string | number>) => void;
+        getLockedPayload: (type: import('../../core').CustomTagType) => Record<string, string | number>;
+        contextMenu: {
+            visible: boolean;
+            x: number;
+            y: number;
+            hasSelection: boolean;
+        };
+        closeContextMenu: () => void;
+        toolModalOpeners: {
+            pinyin: (text: string) => void;
+            replace: (text: string) => void;
+            formula: (text: string) => void;
+            aiRewrite: () => void;
+            upload: () => void;
+        } | null;
+        registerToolModalOpeners: (openers: import('../..').ToolModalOpeners) => void;
     } & {} & import('vue').ComponentCustomProperties & {} & {
         $slots: Readonly<{
             default(): unknown;

package/dist/core/config.d.ts

@@ -78,6 +78,30 @@ export declare const StopOptions: readonly [{
     readonly label: "停顿 1 秒";
     readonly value: 1;
 }];
+/** 编辑器内部常量 */
+export declare const EditorConst: {
+    readonly SENTENCE: "sentence";
+    readonly CUSTOM_TAG: "customTag";
+    /**
+     * 选中文本时浮出的气泡菜单插件 key。
+     * 工具栏与右键面板都要用它来主动收起气泡，避免两个浮层叠在一起。
+     */
+    readonly BUBBLE_MENU_KEY: "ttsRichTextBubbleMenu";
+};
+/**
+ * 是否为「光标插入类」标签工具。
+ *
+ * 这类工具不包裹选中文本，而是在光标处插入一个独立标记（停顿 / 长停顿），
+ * 也是唯一支持长按锁定、锁定后在文本中点击即可重复插入的一类工具。
+ */
+export declare const isInsertTagType: (type: CustomTagType) => boolean;
+/**
+ * 锁定后插入时使用的默认参数。
+ * 用户在弹层里选过一次会被记住（见 useRichTextEditor 的 rememberToolParams），这里只是兜底。
+ */
+export declare const getDefaultLockPayload: (type: CustomTagType) => Record<string, string | number>;
+/** 锁定态按钮上展示的参数文案，例如「0.5 秒」 */
+export declare const getLockPayloadLabel: (type: CustomTagType, payload: Record<string, string | number>) => string;
 export declare const allToolTypes: TtsToolType[];
 export declare const resolveTtsEditorFeatures: (voiceVersion: number, overrides?: TtsEditorFeatures) => ResolvedTtsEditorFeatures;
 export declare const getInitContent: () => JSONContent;