@opentiny/tiny-robot 0.4.2-alpha.4 → 0.4.2-alpha.5

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

@@ -0,0 +1,6 @@
+import { Node } from '@tiptap/core';
+import { MentionOptions } from './types';
+/**
+ * Mention 扩展定义
+ */
+export declare const Mention: Node<MentionOptions, any>;

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

@@ -0,0 +1,22 @@
+import { Ref } from 'vue';
+import { MentionItem, MentionOptions } from './types';
+export { Mention } from './extension';
+export { MentionPluginKey } from './plugin';
+export { mentionCommands } from './commands';
+export * from './types';
+export * from './utils';
+/**
+ * 创建 Mention 扩展的便捷函数
+ *
+ * @param items - 提及项列表
+ * @param char - 触发字符，默认 '@'
+ * @param options - 其他配置项
+ *
+ * @example
+ * ```typescript
+ * const extensions = [mention(items)]
+ * const extensions = [mention(items, '#')]
+ * const extensions = [mention(items, '@', { allowSpaces: true })]
+ * ```
+ */
+export declare function mention(items: MentionItem[] | Ref<MentionItem[]>, char?: string, options?: Partial<Omit<MentionOptions, 'items' | 'char'>>): import('@tiptap/core').Node<MentionOptions, any>;

package/dist/sender/extensions/mention/plugin.d.ts

@@ -0,0 +1,16 @@
+import { Plugin, PluginKey } from '@tiptap/pm/state';
+import { Editor } from '@tiptap/core';
+import { Ref } from 'vue';
+import { MentionItem, MentionSuggestionState } from './types';
+export declare const MentionPluginKey: PluginKey<MentionSuggestionState>;
+interface PluginOptions {
+    editor: Editor;
+    char: string;
+    items: MentionItem[] | Ref<MentionItem[]>;
+    allowSpaces: boolean;
+}
+/**
+ * 创建 Suggestion 插件
+ */
+export declare function createSuggestionPlugin(options: PluginOptions): Plugin;
+export {};

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

@@ -0,0 +1,126 @@
+import { Ref } from 'vue';
+/**
+ * 提及项数据结构（用户侧）
+ *
+ * 用户传入的数据格式，id 可选，插件会自动生成
+ */
+export interface MentionItem {
+    /**
+     * 唯一标识（可选）
+     *
+     * 如果不提供，插件会自动生成
+     */
+    id?: string;
+    /**
+     * 显示名称，如 "小小画家"（必传）
+     */
+    label: string;
+    /**
+     * 关联值（必传）
+     *
+     * 可以是任意字符串值，如 AI 提示词、用户 ID、标签内容等
+     */
+    value: string;
+    /**
+     * 图标（可选）
+     */
+    icon?: string;
+}
+/**
+ * 结构化数据项（提交时返回）
+ *
+ * 用于表示文本和 mention 的混合结构
+ */
+export type MentionStructuredItem = {
+    type: 'text';
+    content: string;
+} | {
+    type: 'mention';
+    content: string;
+    value: string;
+};
+/**
+ * Mention 节点属性（内部使用）
+ *
+ * ProseMirror 节点的属性，id 必填（由插件保证）
+ */
+export interface MentionAttrs {
+    /**
+     * 唯一标识（必填）
+     *
+     * 由插件自动生成或使用用户提供的值
+     */
+    id: string;
+    /**
+     * 显示名称
+     */
+    label: string;
+    /**
+     * 关联值（可选）
+     */
+    value?: string;
+}
+/**
+ * Mention 配置选项
+ */
+export interface MentionOptions {
+    /**
+     * 提及项列表
+     */
+    items: MentionItem[] | Ref<MentionItem[]>;
+    /**
+     * 触发字符，默认 '@'
+     */
+    char: string;
+    /**
+     * 是否允许空格，默认 false
+     */
+    allowSpaces?: boolean;
+    /**
+     * HTML 属性
+     */
+    HTMLAttributes?: Record<string, unknown>;
+}
+/**
+ * Mention Suggestion 插件状态
+ */
+export interface MentionSuggestionState {
+    /**
+     * 是否激活
+     */
+    active: boolean;
+    /**
+     * 触发范围
+     */
+    range: {
+        from: number;
+        to: number;
+    } | null;
+    /**
+     * 查询文本
+     */
+    query: string;
+    /**
+     * 过滤后的提及项列表
+     */
+    filteredItems: MentionItem[];
+}
+/**
+ * 扩展 Tiptap Commands 接口
+ *
+ * 使 TypeScript 能够识别自定义命令
+ */
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        mention: {
+            /**
+             * 插入 mention 节点
+             */
+            insertMention: (attrs: Partial<MentionAttrs>) => ReturnType;
+            /**
+             * 删除 mention 节点
+             */
+            deleteMention: (id: string) => ReturnType;
+        };
+    }
+}

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

@@ -0,0 +1,34 @@
+import { Editor } from '@tiptap/core';
+import { MentionItem, MentionStructuredItem } from './types';
+/**
+ * 获取所有 mention 节点（辅助函数）
+ *
+ * 返回文档中所有的 mention 节点数据
+ */
+export declare function getMentions(editor: Editor): MentionItem[];
+/**
+ * 获取包含 mention 标签的完整文本
+ *
+ * 自动从编辑器中获取 mention 扩展的 char 配置
+ *
+ * @param editor - 编辑器实例
+ *
+ * @example
+ * getTextWithMentions(editor) // @代码分析 hello world @文本分析 12315
+ * // 如果配置了 char: '#'，则返回：#代码分析 hello world #文本分析 12315
+ */
+export declare function getTextWithMentions(editor: Editor): string;
+/**
+ * 获取结构化数据（包含文本和 mention 的混合结构）
+ *
+ * 返回按顺序排列的文本和 mention 节点，用于确认内容和顺序
+ *
+ * @example
+ * 输入：帮我分析 @张三 的周报（或 #标签 等，取决于 char 配置）
+ * 返回：[
+ *   { type: 'text', content: '帮我分析 ' },
+ *   { type: 'mention', content: '张三', value: '...' },
+ *   { type: 'text', content: ' 的周报' }
+ * ]
+ */
+export declare function getMentionStructuredData(editor: Editor): MentionStructuredItem[];

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

@@ -0,0 +1,8 @@
+import { Extension } from '@tiptap/core';
+import { SuggestionOptions } from './types';
+/**
+ * Suggestion 扩展定义
+ *
+ * 支持全局匹配模式的智能联想功能
+ */
+export declare const Suggestion: Extension<SuggestionOptions, any>;

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

@@ -0,0 +1,20 @@
+import { Ref } from 'vue';
+import { SenderSuggestionItem, SuggestionOptions } from './types';
+export { Suggestion } from './extension';
+export { SuggestionPluginKey } from './plugin';
+export * from './types';
+export { syncAutoComplete } from './utils/filter';
+export { processHighlights, highlightSuggestionText, convertHighlightsArrayToTextParts } from './utils/highlight';
+/**
+ * 创建 Suggestion 扩展的便捷函数
+ *
+ * @param items - 建议项列表
+ * @param options - 其他配置项
+ *
+ * @example
+ * ```typescript
+ * const extensions = [suggestion(suggestions)]
+ * const extensions = [suggestion(suggestions, { popupWidth: 500 })]
+ * ```
+ */
+export declare function suggestion(items: SenderSuggestionItem[] | Ref<SenderSuggestionItem[]>, options?: Partial<Omit<SuggestionOptions, 'items'>>): import('@tiptap/core').Extension<SuggestionOptions, any>;

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

@@ -0,0 +1,21 @@
+import { Plugin, PluginKey } from '@tiptap/pm/state';
+import { Editor } from '@tiptap/core';
+import { SuggestionOptions, SuggestionState } from './types';
+/**
+ * 插件 Key，用于访问插件状态
+ */
+export declare const SuggestionPluginKey: PluginKey<SuggestionState>;
+/**
+ * 插件配置接口
+ */
+interface PluginOptions extends SuggestionOptions {
+    editor: Editor;
+}
+/**
+ * 创建 Suggestion 插件
+ *
+ * @param options - 插件配置
+ * @returns ProseMirror 插件
+ */
+export declare function createSuggestionPlugin(options: PluginOptions): Plugin;
+export {};

package/dist/sender/extensions/suggestion/suggestion-list.vue.d.ts

@@ -0,0 +1,46 @@
+import { SenderSuggestionItem } from './types';
+/**
+ * 建议列表组件 Props
+ */
+export interface Props {
+    /**
+     * 是否显示
+     */
+    show: boolean;
+    /**
+     * 建议项列表
+     */
+    suggestions: SenderSuggestionItem[];
+    /**
+     * 弹窗样式
+     */
+    popupStyle: Record<string, string | number>;
+    /**
+     * 键盘选中的索引
+     */
+    activeKeyboardIndex: number;
+    /**
+     * 鼠标悬停的索引
+     */
+    activeMouseIndex: number;
+    /**
+     * 用户输入的文本
+     */
+    inputValue: string;
+    /**
+     * 选择回调函数
+     */
+    onSelect?: (item: SenderSuggestionItem) => void;
+    /**
+     * 鼠标进入回调函数
+     */
+    onMouseEnter?: (index: number) => void;
+    /**
+     * 鼠标离开回调函数
+     */
+    onMouseLeave?: () => void;
+}
+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, {
+    suggestionsListRef: HTMLDivElement;
+}, any>;
+export default _default;

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>;