@opentiny/tiny-robot 0.5.0 → 0.5.1-alpha.2

package/dist/sender/extensions/suggestion/types.d.ts

@@ -0,0 +1,254 @@
+import { Ref } from 'vue';
+/**
+ * Suggestion 插件类型定义
+ *
+ * 包含建议项、高亮、插件配置和状态等类型定义
+ */
+/**
+ * 高亮文本片段
+ */
+export interface SuggestionTextPart {
+    text: string;
+    isMatch: boolean;
+}
+/**
+ * 高亮函数类型
+ *
+ * @param suggestionText - 建议项文本
+ * @param inputText - 用户输入文本
+ * @returns 包含文本片段和匹配状态的数组
+ */
+export type HighlightFunction = (suggestionText: string, inputText: string) => SuggestionTextPart[];
+/**
+ * 建议项类型
+ *
+ * @example
+ * ```typescript
+ * // 自动匹配
+ * { content: 'ECS-云服务器' }
+ *
+ * // 精确指定高亮
+ * {
+ *   content: 'ECS-云服务器',
+ *   highlights: ['ECS', '云服务器']
+ * }
+ *
+ * // 自定义高亮函数
+ * {
+ *   content: 'ECS-云服务器',
+ *   highlights: (text, query) => [
+ *     { text: 'ECS', isMatch: true },
+ *     { text: '-云服务器', isMatch: false }
+ *   ]
+ * }
+ * ```
+ */
+export interface SenderSuggestionItem {
+    /**
+     * 建议项内容（必填）
+     */
+    content: string;
+    /**
+     * 显示标签（可选）
+     *
+     * 默认使用 content
+     */
+    label?: string;
+    /**
+     * 高亮方式（可选）
+     *
+     * - undefined: 自动匹配（默认）
+     * - string[]: 精确指定高亮片段
+     * - function: 自定义高亮逻辑
+     */
+    highlights?: string[] | HighlightFunction;
+    /**
+     * 自定义数据（可选）
+     *
+     * 用于扩展功能
+     */
+    data?: Record<string, unknown>;
+}
+/**
+ * 插件状态
+ *
+ * 管理建议列表的显示、过滤、选中等状态
+ */
+export interface SuggestionState {
+    /**
+     * 是否激活（有匹配的建议项）
+     */
+    active: boolean;
+    /**
+     * 匹配范围
+     *
+     * 全局模式：整个文档范围
+     * 字符模式：触发字符到光标的范围
+     */
+    range: {
+        from: number;
+        to: number;
+    } | null;
+    /**
+     * 查询文本
+     *
+     * 全局模式：整个输入内容
+     * 字符模式：触发字符后的文本
+     */
+    query: string;
+    /**
+     * 过滤后的建议项
+     */
+    filteredSuggestions: SenderSuggestionItem[];
+    /**
+     * 当前选中的建议项索引
+     *
+     * -1 表示未选中
+     */
+    selectedIndex: number;
+    /**
+     * 自动补全文本
+     *
+     * 选中项的剩余部分
+     */
+    autoCompleteText: string;
+    /**
+     * 是否显示 Tab 提示
+     */
+    showTabIndicator: boolean;
+}
+/**
+ * 插件配置选项
+ */
+export interface SuggestionOptions {
+    /**
+     * 建议项列表（可选）
+     *
+     * 不传或传空数组时，建议功能不会显示
+     *
+     * @default []
+     *
+     * @example
+     * ```typescript
+     * const items = ref([
+     *   { content: 'ECS-云服务器' },
+     *   { content: 'RDS-数据库' }
+     * ])
+     * ```
+     */
+    items?: SenderSuggestionItem[] | Ref<SenderSuggestionItem[]>;
+    /**
+     * 自定义过滤函数（可选）
+     *
+     * - 不传：不过滤，直接显示所有项
+     * - 传入：使用自定义过滤逻辑
+     *
+     * @default undefined（不过滤）
+     *
+     * @example 模糊匹配过滤
+     * ```typescript
+     * filterFn: (items, query) => {
+     *   return items.filter(item =>
+     *     item.content.toLowerCase().includes(query.toLowerCase())
+     *   )
+     * }
+     * ```
+     *
+     * @example 前缀匹配过滤
+     * ```typescript
+     * filterFn: (items, query) => {
+     *   return items.filter(item =>
+     *     item.content.toLowerCase().startsWith(query.toLowerCase())
+     *   )
+     * }
+     * ```
+     */
+    filterFn?: (suggestions: SenderSuggestionItem[], query: string) => SenderSuggestionItem[];
+    /**
+     * 选中建议项的按键
+     *
+     * 注意：Tab 键用于自动补全，不受此配置控制
+     *
+     * @default ['Enter']
+     *
+     * @example 只允许 Enter 选中
+     * ```typescript
+     * activeSuggestionKeys: ['Enter']
+     * ```
+     *
+     * @example 允许 Enter 和 Space 选中
+     * ```typescript
+     * activeSuggestionKeys: ['Enter', ' ']  // 注意：空格键是 ' '
+     * ```
+     *
+     * @example 禁用所有选中按键（只能点击）
+     * ```typescript
+     * activeSuggestionKeys: []
+     * ```
+     */
+    activeSuggestionKeys?: string[];
+    /**
+     * 弹窗宽度
+     *
+     * @default 400
+     */
+    popupWidth?: number | string;
+    /**
+     * 是否显示自动补全提示
+     *
+     * @default true
+     */
+    showAutoComplete?: boolean;
+    /**
+     * 选中建议项的回调
+     *
+     * @param item - 选中的建议项（包含完整的 SenderSuggestionItem 信息）
+     * @returns 返回 false 可阻止默认回填行为
+     *
+     * @example 默认行为（自动回填）
+     * ```typescript
+     * onSelect: (item) => {
+     *   console.log('Selected:', item)
+     *   // 不返回 false，内容会自动回填
+     * }
+     * ```
+     *
+     * @example 阻止默认行为并自定义回填
+     * ```typescript
+     * onSelect: (item) => {
+     *   editor.commands.setContent(`前缀-${item.content}-后缀`)
+     *   return false // 阻止默认回填
+     * }
+     * ```
+     *
+     * @example 条件性阻止
+     * ```typescript
+     * onSelect: (item) => {
+     *   if (item.data?.needsValidation) {
+     *     validateAndFill(item)
+     *     return false
+     *   }
+     *   // 否则使用默认回填
+     * }
+     * ```
+     */
+    onSelect?: (item: SenderSuggestionItem) => void | false;
+}
+/**
+ * 插件 Key 类型
+ *
+ * 用于访问插件状态
+ */
+export interface SuggestionPluginKeyType {
+    getState: (state: EditorState) => SuggestionState | undefined;
+}
+/**
+ * EditorState 类型（来自 @tiptap/pm/state）
+ */
+export interface EditorState {
+    doc: unknown;
+    selection: unknown;
+    storedMarks: unknown;
+    schema: unknown;
+    [key: string]: unknown;
+}

package/dist/sender/extensions/suggestion/utils/filter.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 计算自动补全文本
+ *
+ * 检查选中项是否以输入内容开头，如果是则返回剩余部分
+ *
+ * @param selectedSuggestion - 选中的建议项内容
+ * @param inputText - 用户输入的文本
+ * @returns 补全信息
+ *
+ * @example
+ * ```typescript
+ * // 有补全文本
+ * syncAutoComplete('ECS-云服务器', 'ECS')
+ * // { text: '-云服务器', show: true, showTab: true }
+ *
+ * // 无补全文本（输入完整）
+ * syncAutoComplete('ECS', 'ECS')
+ * // { text: '', show: false, showTab: false }
+ *
+ * // 不匹配
+ * syncAutoComplete('ECS-云服务器', 'CDN')
+ * // { text: '', show: false, showTab: false }
+ * ```
+ */
+export declare const syncAutoComplete: (selectedSuggestion: string, inputText: string) => {
+    text: string;
+    show: boolean;
+    showTab: boolean;
+};

package/dist/sender/extensions/suggestion/utils/highlight.d.ts

@@ -0,0 +1,73 @@
+import { SenderSuggestionItem, SuggestionTextPart } from '../types';
+/**
+ * 将预定义的高亮字符串数组转换为文本片段
+ *
+ * @param content - 完整的建议文本
+ * @param highlights - 需要高亮的文本片段数组
+ * @returns 包含文本片段和匹配状态的数组
+ *
+ * @example
+ * ```typescript
+ * const result = convertHighlightsArrayToTextParts('ECS-云服务器', ['ECS', '云服务器'])
+ * // [
+ * //   { text: 'ECS', isMatch: true },
+ * //   { text: '-', isMatch: false },
+ * //   { text: '云服务器', isMatch: true }
+ * // ]
+ * ```
+ */
+export declare const convertHighlightsArrayToTextParts: (content: string, highlights: string[]) => SuggestionTextPart[];
+/**
+ * 处理建议项文本高亮（自动匹配模式）
+ *
+ * @param suggestionText - 建议文本
+ * @param inputText - 输入文本
+ * @returns 包含文本片段和匹配状态的数组
+ *
+ * @example
+ * ```typescript
+ * const result = highlightSuggestionText('ECS-云服务器', 'ECS')
+ * // [
+ * //   { text: 'ECS', isMatch: true },
+ * //   { text: '-云服务器', isMatch: false }
+ * // ]
+ * ```
+ */
+export declare const highlightSuggestionText: (suggestionText: string, inputText: string) => SuggestionTextPart[];
+/**
+ * 处理建议项的高亮
+ *
+ * 支持三种高亮模式：
+ * 1. 自动匹配：根据输入内容自动高亮
+ * 2. 精确指定：通过数组指定要高亮的文本片段
+ * 3. 自定义函数：完全自定义高亮逻辑
+ *
+ * @param item - 建议项
+ * @param inputText - 用户输入文本
+ * @returns 包含文本片段和匹配状态的数组
+ *
+ * @example
+ * ```typescript
+ * // 自动匹配
+ * processHighlights({ content: 'ECS-云服务器' }, 'ECS')
+ *
+ * // 精确指定
+ * processHighlights(
+ *   { content: 'ECS-云服务器', highlights: ['ECS', '云服务器'] },
+ *   'ECS'
+ * )
+ *
+ * // 自定义函数
+ * processHighlights(
+ *   {
+ *     content: 'ECS-云服务器',
+ *     highlights: (text, query) => [
+ *       { text: 'ECS', isMatch: true },
+ *       { text: '-云服务器', isMatch: false }
+ *     ]
+ *   },
+ *   'ECS'
+ * )
+ * ```
+ */
+export declare const processHighlights: (item: SenderSuggestionItem, inputText: string) => SuggestionTextPart[];

package/dist/sender/extensions/template/block/extension.d.ts

@@ -0,0 +1,6 @@
+import { Node } from '@tiptap/core';
+import { TemplateOptions } from '../types';
+/**
+ * TemplateBlock 节点定义（可编辑块）
+ */
+export declare const TemplateBlock: Node<TemplateOptions, any>;

package/dist/sender/extensions/template/block/plugins.d.ts

@@ -0,0 +1,13 @@
+import { Plugin } from '@tiptap/pm/state';
+/**
+ * 零宽字符管理插件
+ */
+export declare function ensureZeroWidthChars(): Plugin<any>;
+/**
+ * 键盘导航插件
+ */
+export declare function keyboardNavigationPlugin(): Plugin<any>;
+/**
+ * 粘贴处理插件
+ */
+export declare function pasteHandlerPlugin(): Plugin<any>;

package/dist/sender/extensions/template/block/template-block-view.vue.d.ts

@@ -0,0 +1,14 @@
+interface NodeAttrs {
+    id: string;
+    content: string;
+    [key: string]: unknown;
+}
+interface Props {
+    node: {
+        attrs: NodeAttrs;
+        textContent?: string;
+        [key: string]: unknown;
+    };
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/sender/extensions/template/commands.d.ts

@@ -0,0 +1,31 @@
+import { Editor } from '@tiptap/core';
+import { TemplateItem, TemplateAttrs, TemplateSelectAttrs } from './types';
+/**
+ * Template 命令集合
+ */
+export declare const templateCommands: {
+    /**
+     * 设置模板数据（批量）
+     */
+    setTemplateData: (items: TemplateItem[]) => ({ commands }: {
+        commands: Editor["commands"];
+    }) => boolean;
+    /**
+     * 插入模板块
+     */
+    insertTemplate: (attrs: Partial<TemplateAttrs>) => ({ commands }: {
+        commands: Editor["commands"];
+    }) => boolean;
+    /**
+     * 聚焦到第一个模板块
+     */
+    focusFirstTemplate: () => ({ editor }: {
+        editor: Editor;
+    }) => boolean;
+    /**
+     * 插入选择器
+     */
+    insertTemplateSelect: (attrs: Partial<TemplateSelectAttrs>) => ({ commands }: {
+        commands: Editor["commands"];
+    }) => boolean;
+};

package/dist/sender/extensions/template/extension.d.ts

@@ -0,0 +1,6 @@
+import { Extension } from '@tiptap/core';
+import { TemplateOptions } from './types';
+/**
+ * Template 扩展（统一入口，包含 TemplateBlock 和 TemplateSelect）
+ */
+export declare const Template: Extension<TemplateOptions, any>;

package/dist/sender/extensions/template/index.d.ts

@@ -0,0 +1,21 @@
+import { Ref } from 'vue';
+import { TemplateItem, TemplateOptions } from './types';
+export { Template } from './extension';
+export { TemplateSelect } from './select/extension';
+export { templateCommands } from './commands';
+export * from './types';
+export { getTextWithTemplates, getTemplateStructuredData } from './utils';
+export { TemplateSelectDropdownPluginKey } from './select/plugins';
+/**
+ * 创建 Template 扩展的便捷函数
+ *
+ * @param items - 模板项列表
+ * @param options - 其他配置项
+ *
+ * @example
+ * ```typescript
+ * const extensions = [template(templates)]
+ * const extensions = [template(templates, { HTMLAttributes: { class: 'custom' } })]
+ * ```
+ */
+export declare function template(items: TemplateItem[] | Ref<TemplateItem[]>, options?: Partial<Omit<TemplateOptions, 'items'>>): import('@tiptap/core').Extension<TemplateOptions, any>;

package/dist/sender/extensions/template/select/dropdown-manager.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 下拉菜单管理器（单例模式）
+ */
+/**
+ * 打开下拉菜单
+ */
+export declare function openDropdown(selectId: string): void;
+/**
+ * 关闭下拉菜单
+ */
+export declare function closeDropdown(selectId: string): void;
+/**
+ * 获取当前打开的下拉菜单 ID
+ */
+export declare function getCurrentOpenDropdown(): string | null;
+/**
+ * 关闭所有下拉菜单
+ */
+export declare function closeAllDropdowns(): void;
+/**
+ * 设置点击外部关闭监听
+ */
+export declare function setupClickOutside(selectElement: HTMLElement, dropdownElement: HTMLElement, onClose: () => void): () => void;

package/dist/sender/extensions/template/select/extension.d.ts

@@ -0,0 +1,5 @@
+import { Node } from '@tiptap/core';
+/**
+ * TemplateSelect 节点定义
+ */
+export declare const TemplateSelect: Node<Record<string, unknown>, any>;

package/dist/sender/extensions/template/select/plugins.d.ts

@@ -0,0 +1,34 @@
+import { Plugin, PluginKey } from '@tiptap/pm/state';
+/**
+ * Template Select 下拉菜单状态
+ */
+interface TemplateSelectDropdownState {
+    /**
+     * 是否有下拉菜单打开
+     */
+    isOpen: boolean;
+    /**
+     * 当前打开的下拉菜单 ID
+     */
+    selectId: string | null;
+}
+/**
+ * Template Select 下拉菜单状态插件 Key
+ */
+export declare const TemplateSelectDropdownPluginKey: PluginKey<TemplateSelectDropdownState>;
+/**
+ * 下拉菜单状态管理插件
+ * 用于在 ProseMirror 插件状态中跟踪下拉菜单的打开/关闭状态
+ */
+export declare function selectDropdownStatePlugin(): Plugin<TemplateSelectDropdownState>;
+/**
+ * 零宽字符管理插件
+ * 注意：零宽字符现在由 Vue 组件直接渲染，不需要插件动态插入
+ * 这个插件保留用于清理孤立的零宽字符
+ */
+export declare function selectZeroWidthPlugin(): Plugin<any>;
+/**
+ * 键盘导航插件
+ */
+export declare function selectKeyboardPlugin(): Plugin<any>;
+export {};

package/dist/sender/extensions/template/select/template-select-view.vue.d.ts

@@ -0,0 +1,20 @@
+import { Editor } from '@tiptap/core';
+import { SelectOption } from '../types';
+interface NodeAttrs {
+    id: string;
+    placeholder: string;
+    options: SelectOption[];
+    value?: string;
+}
+interface Props {
+    node: {
+        attrs: NodeAttrs;
+    };
+    updateAttributes: (attrs: Record<string, unknown>) => void;
+    editor: Editor;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    triggerRef: HTMLSpanElement;
+    dropdownRef: HTMLDivElement;
+}, any>;
+export default _default;

package/dist/sender/extensions/template/types.d.ts

@@ -0,0 +1,100 @@
+import { Ref } from 'vue';
+import { TemplateItem, SelectOption } from '../../index.type';
+export type { TemplateItem, SelectOption };
+/**
+ * TemplateSelect 节点属性
+ */
+export interface TemplateSelectAttrs {
+    /**
+     * 唯一标识
+     */
+    id: string;
+    /**
+     * 占位文字（未选择时显示）
+     */
+    placeholder: string;
+    /**
+     * 选项列表
+     */
+    options: SelectOption[];
+    /**
+     * 当前选中的值（可选）
+     */
+    value?: string;
+}
+/**
+ * Template 节点属性
+ */
+export interface TemplateAttrs {
+    /**
+     * 模板块 ID
+     */
+    id: string;
+    /**
+     * 模板块内容
+     */
+    content: string;
+}
+/**
+ * Template 配置选项
+ */
+export interface TemplateOptions {
+    /**
+     * 模板数据列表（推荐使用 ref 实现响应式）
+     *
+     * 支持两种配置方式：
+     * 1. 传入 ref（推荐）：自动双向绑定，解决时序问题
+     * 2. 传入数组：仅用于静态初始化
+     *
+     * @example 响应式配置（推荐）
+     * ```typescript
+     * const items = ref<TemplateItem[]>([
+     *   { type: 'text', content: '帮我分析' },
+     *   { type: 'template', content: '' }
+     * ])
+     * Template.configure({ items })  // 传入 ref，自动双向绑定
+     * ```
+     *
+     * @example 静态配置
+     * ```typescript
+     * Template.configure({
+     *   items: [
+     *     { type: 'text', content: '帮我分析' },
+     *     { type: 'template', content: '' }
+     *   ]
+     * })
+     * ```
+     */
+    items?: TemplateItem[] | Ref<TemplateItem[]>;
+    /**
+     * HTML 属性
+     */
+    HTMLAttributes?: Record<string, unknown>;
+}
+/**
+ * 扩展 Tiptap Commands 接口
+ *
+ * 使 TypeScript 能够识别自定义命令
+ */
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        template: {
+            /**
+             * 设置模板数据（批量）
+             */
+            setTemplateData: (items: TemplateItem[]) => ReturnType;
+            /**
+             * 插入模板块
+             */
+            insertTemplate: (attrs: Partial<TemplateAttrs>) => ReturnType;
+            /**
+             * 聚焦到第一个模板块
+             */
+            focusFirstTemplate: () => ReturnType;
+            /**
+             * 插入选择器
+             */
+            insertTemplateSelect: (attrs: Partial<TemplateSelectAttrs>) => ReturnType;
+        };
+    }
+}

package/dist/sender/extensions/template/utils.d.ts

@@ -0,0 +1,20 @@
+import { Editor } from '@tiptap/core';
+import { TemplateItem } from '../../index.type';
+/**
+ * 零宽字符常量
+ * Unicode: U+200B (Zero Width Space)
+ * HTML Entity: ​
+ */
+export declare const ZERO_WIDTH_CHAR = "\u200B";
+/**
+ * 获取包含 template 的完整文本
+ *
+ * 例如：请帮我分析 [模板内容1] 和 [模板内容2]
+ */
+export declare function getTextWithTemplates(editor: Editor): string;
+/**
+ * 获取结构化数据（辅助函数）
+ *
+ * 返回包含文本和模板块的结构化数组
+ */
+export declare function getTemplateStructuredData(editor: Editor): TemplateItem[];

package/dist/sender/extensions/utils/id-generator.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 生成唯一 ID
+ *
+ * 用于所有扩展生成唯一标识符
+ */
+/**
+ * 生成唯一 ID
+ *
+ * @param prefix - ID 前缀
+ * @returns 唯一 ID 字符串
+ *
+ * @example
+ * generateId('mention') // mention_1701234567890_abc123def
+ * generateId('template') // template_1701234567890_xyz789uvw
+ */
+export declare function generateId(prefix: string): string;

package/dist/sender/extensions/utils/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 共享工具函数统一导出
+ */
+export { generateId } from './id-generator';
+export { findTextRange } from './position';
+export { isKey, isAnyKey, isArrowKey, isDeleteKey } from './keyboard';
+export type { KeyboardKey } from './keyboard';