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

package/dist/sender/index.type.d.ts

@@ -0,0 +1,302 @@
+import { Extension } from '@tiptap/core';
+import { InputMode, SubmitTrigger, DefaultActions, AutoSize, StructuredData, EnterKeyHint } from './types/base';
+import { SenderSlotScope } from './types/slots';
+export * from './types/base';
+export * from './types/composables';
+export * from './types/components';
+export * from './types/context';
+export * from './types/slots';
+export type { MentionItem } from './extensions/mention';
+export type { SenderSuggestionItem, SuggestionOptions, SuggestionState, SuggestionTextPart, HighlightFunction, } from './extensions/suggestion';
+/**
+ * Sender 组件 Props
+ */
+export interface SenderProps {
+    /**
+     * 输入内容（双向绑定）
+     *
+     * 支持 v-model
+     */
+    modelValue?: string;
+    /**
+     * 默认值
+     *
+     * 仅在初始化时使用
+     */
+    defaultValue?: string;
+    /**
+     * 占位符文本
+     *
+     * @default '请输入内容...'
+     */
+    placeholder?: string;
+    /**
+     * 是否禁用
+     *
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * 是否加载中
+     *
+     * 加载状态下显示停止按钮
+     *
+     * @default false
+     */
+    loading?: boolean;
+    /**
+     * 是否自动聚焦
+     *
+     * @default false
+     */
+    autofocus?: boolean;
+    /**
+     * 移动端虚拟键盘回车键提示
+     *
+     * 用于自定义移动端虚拟键盘上回车键的显示文本或图标
+     *
+     * @default 'send'
+     */
+    enterkeyhint?: EnterKeyHint;
+    /**
+     * 输入模式
+     *
+     * - single: 单行模式
+     * - multiple: 多行模式
+     *
+     * @default 'single'
+     */
+    mode?: InputMode;
+    /**
+     * 自动调整高度
+     *
+     * - false: 不自动调整
+     * - true: 自动调整（默认 1-3 行）
+     * - { minRows, maxRows }: 自定义行数范围
+     *
+     * 仅在 mode === 'multiple' 时有效
+     *
+     * @default { minRows: 1, maxRows: 3 }
+     */
+    autoSize?: AutoSize;
+    /**
+     * 最大字符数
+     *
+     * @default Infinity
+     */
+    maxLength?: number;
+    /**
+     * 是否显示字数限制
+     *
+     * 仅在 maxLength 有值时有效
+     *
+     * @default false
+     */
+    showWordLimit?: boolean;
+    /**
+     * 是否显示清空按钮
+     *
+     * @default false
+     */
+    clearable?: boolean;
+    /**
+     * Tiptap 扩展配置
+     *
+     * 用于添加增强输入能力，如 Template、Mention、Suggestion 等
+     *
+     * @example 基础使用
+     * ```typescript
+     * import { Template } from '@tiny-robot/components/sender/extensions'
+     *
+     * <Sender :extensions="[Template]" />
+     * ```
+     *
+     * @example 带配置的扩展（响应式推荐）
+     * ```typescript
+     * import { Mention, Suggestion } from '@tiny-robot/components/sender/extensions'
+     *
+     * const mentions = ref([...])
+     * const suggestions = ref([...])
+     *
+     * const extensions = [
+     *   Mention.configure({ items: mentions }),
+     *   Suggestion.configure({ items: suggestions })
+     * ]
+     *
+     * <Sender :extensions="extensions" />
+     * ```
+     */
+    extensions?: Extension[] | any[];
+    /**
+     * 组件尺寸
+     *
+     * - normal: 正常尺寸（默认）
+     * - small: 紧凑模式，更小的字体、间距和图标
+     *
+     * @default 'normal'
+     */
+    size?: 'normal' | 'small';
+    /**
+     * 停止按钮文字
+     *
+     * @default '停止响应'
+     */
+    stopText?: string;
+    /**
+     * 默认操作按钮配置
+     *
+     * 用于统一配置默认按钮（Clear、Submit）的状态和提示
+     *
+     * @example 基础使用
+     * ```vue
+     * <Sender
+     *   :actions-config="{
+     *     submit: { disabled: !isValid, tooltip: '请完善表单' }
+     *   }"
+     * />
+     * ```
+     *
+     * @example 动态配置
+     * ```vue
+     * <script setup>
+     * const defaultActions = computed(() => ({
+     *   submit: {
+     *     disabled: !canSubmit.value,
+     *     tooltip: canSubmit.value ? '发送' : '请输入内容'
+     *   },
+     *   clear: { tooltip: '清空输入' }
+     * }))
+     * </script>
+     *
+     * <template>
+     *   <Sender :actions-config="defaultActions" />
+     * </template>
+     * ```
+     *
+     * @default undefined
+     */
+    defaultActions?: DefaultActions;
+    /**
+     * 提交触发方式
+     *
+     * @default 'enter'
+     */
+    submitType?: SubmitTrigger;
+}
+/**
+ * Sender 组件 Emits
+ */
+export interface SenderEmits {
+    /**
+     * 更新输入内容
+     *
+     * @param e - 事件名
+     * @param value - 新内容
+     */
+    (e: 'update:modelValue', value: string): void;
+    /**
+     * 提交内容（增强版）
+     *
+     * @param e - 事件名
+     * @param textContent - 提交的内容（纯文本，如 "帮我分析 @张三 的周报"）
+     * @param structuredData - 结构化数据（可选）
+     *
+     * @example
+     * ```typescript
+     * function handleSubmit(text: string, data?: StructuredData) {
+     *   console.log('纯文本:', text)
+     *
+     *   if (data?.template) {
+     *     // Template 场景
+     *     console.log('模板数据:', data.template)
+     *   }
+     *
+     *   if (data?.mentions) {
+     *     // Mention 场景
+     *     console.log('提及的人:', data.mentions)
+     *   }
+     * }
+     * ```
+     */
+    (e: 'submit', textContent: string, structuredData?: StructuredData): void;
+    /**
+     * 聚焦事件
+     *
+     * @param e - 事件名
+     * @param event - 原生事件
+     */
+    (e: 'focus', event: FocusEvent): void;
+    /**
+     * 失焦事件
+     *
+     * @param e - 事件名
+     * @param event - 原生事件
+     */
+    (e: 'blur', event: FocusEvent): void;
+    /**
+     * 清空事件
+     *
+     * @param e - 事件名
+     */
+    (e: 'clear'): void;
+    /**
+     * 取消事件
+     *
+     * 在 loading 状态下点击停止按钮时触发
+     * 用于取消正在进行的操作（如 AI 响应）
+     *
+     * @param e - 事件名
+     */
+    (e: 'cancel'): void;
+    /**
+     * 输入事件
+     *
+     * @param e - 事件名
+     * @param value - 当前内容
+     */
+    (e: 'input', value: string): void;
+}
+/**
+ * Sender 组件 Slots
+ */
+export interface SenderSlots {
+    /**
+     * 头部插槽
+     */
+    header?: () => unknown;
+    /**
+     * 前缀插槽
+     */
+    prefix?: () => unknown;
+    /**
+     * 内容插槽
+     *
+     * @param props - 插槽属性
+     * @param props.editor - 编辑器实例
+     */
+    content?: (props: {
+        editor: unknown;
+    }) => unknown;
+    /**
+     * 单行模式内联操作按钮插槽
+     *
+     * @example
+     * ```vue
+     * <sender>
+     *   <template #actions-inline="{ insert, focus, disabled }">
+     *     <voice-input @result="insert" :disabled="disabled" />
+     *     <file-upload @select="handleFiles" />
+     *   </template>
+     * </sender>
+     * ```
+     */
+    'actions-inline'?: (scope: SenderSlotScope) => unknown;
+    /**
+     * 底部插槽（多行模式）
+     */
+    footer?: (scope: SenderSlotScope) => unknown;
+    /**
+     * 底部右侧插槽（多行模式）
+     */
+    'footer-right'?: (scope: SenderSlotScope) => unknown;
+}

package/dist/sender/index.vue.d.ts

@@ -0,0 +1,90 @@
+import { SenderProps } from './index.type';
+declare const props: Readonly<{
+    modelValue: string;
+    defaultValue: string;
+    disabled: boolean;
+    loading: boolean;
+    autofocus: boolean;
+    maxLength: number;
+    showWordLimit: boolean;
+    clearable: boolean;
+    stopText: string;
+    defaultActions: import('./index.type').DefaultActions;
+}> & {
+    readonly placeholder: string;
+    readonly mode: import('./index.type').InputMode;
+    readonly size: "small" | "normal";
+    readonly submitType: import('./index.type').SubmitTrigger;
+    readonly enterkeyhint: import('./index.type').EnterKeyHint;
+    readonly extensions: any[] | import('@tiptap/core').Extension<any, any>[];
+    readonly autoSize: import('./index.type').AutoSize;
+} & {
+    readonly disabled: boolean;
+    readonly loading: boolean;
+    readonly autofocus: boolean;
+    readonly showWordLimit: boolean;
+    readonly clearable: boolean;
+};
+export type SenderPropsWithDefaults = typeof props;
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        header?(_: {}): any;
+        header?(_: {}): any;
+        prefix?(_: {}): any;
+        prefix?(_: {}): any;
+        content?(_: {
+            editor: import('@tiptap/vue-3').Editor | undefined;
+        }): any;
+        content?(_: {
+            editor: import('vue').Ref<import('@tiptap/vue-3').Editor | undefined, import('@tiptap/vue-3').Editor | undefined>;
+        }): any;
+        'actions-inline'?(_: {}): any;
+        footer?(_: {}): any;
+        'footer-right'?(_: {}): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<SenderProps, {
+    submit: () => void;
+    clear: () => void;
+    cancel: () => void;
+    focus: () => void;
+    blur: () => void;
+    setContent: (content: string) => void;
+    getContent: () => string;
+    editor: import('./index.type').SenderContext["editor"];
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    clear: () => any;
+    input: (value: string) => any;
+    blur: (event: FocusEvent) => any;
+    cancel: () => any;
+    focus: (event: FocusEvent) => any;
+    submit: (textContent: string, structuredData?: import('./index.type').StructuredData | undefined) => any;
+    "update:modelValue": (value: string) => any;
+}, string, import('vue').PublicProps, Readonly<SenderProps> & Readonly<{
+    onClear?: (() => any) | undefined;
+    onInput?: ((value: string) => any) | undefined;
+    onBlur?: ((event: FocusEvent) => any) | undefined;
+    onCancel?: (() => any) | undefined;
+    onFocus?: ((event: FocusEvent) => any) | undefined;
+    onSubmit?: ((textContent: string, structuredData?: import('./index.type').StructuredData | undefined) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: string) => any) | undefined;
+}>, {
+    size: "normal" | "small";
+    placeholder: string;
+    mode: import('./index.type').InputMode;
+    enterkeyhint: import('./index.type').EnterKeyHint;
+    autoSize: import('./index.type').AutoSize;
+    extensions: import('@tiptap/core').Extension[] | any[];
+    submitType: import('./index.type').SubmitTrigger;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/sender/types/base.d.ts

@@ -0,0 +1,239 @@
+import { TooltipContent, TooltipPlacement } from '../../sender-actions/types/common';
+import { MentionItem, MentionStructuredItem } from '../extensions/mention/types';
+/**
+ * 输入模式
+ * - single: 单行模式，适用于简短输入
+ * - multiple: 多行模式，适用于长文本输入
+ */
+export type InputMode = 'single' | 'multiple';
+/**
+ * 提交触发方式
+ * - enter: Enter 键提交
+ * - ctrlEnter: Ctrl+Enter 提交
+ * - shiftEnter: Shift+Enter 提交
+ */
+export type SubmitTrigger = 'enter' | 'ctrlEnter' | 'shiftEnter';
+/**
+ * 移动端虚拟键盘回车键提示
+ *
+ * 用于自定义移动端虚拟键盘上回车键的显示文本或图标
+ *
+ * - `enter`: 插入换行
+ * - `done`: 完成
+ * - `go`: 前往
+ * - `next`: 下一项
+ * - `previous`: 上一项
+ * - `search`: 搜索
+ * - `send`: 发送（推荐用于聊天场景）
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint
+ */
+export type EnterKeyHint = 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
+/**
+ * 选择器选项
+ */
+export interface SelectOption {
+    /**
+     * 显示文本
+     */
+    label: string;
+    /**
+     * 选择后的值
+     */
+    value: string;
+    /**
+     * 自定义数据（可选）
+     */
+    data?: string;
+}
+/**
+ * 模板项（用户侧）
+ *
+ * 用户传入的模板数据格式
+ * 组件内部会转换为 Tiptap 节点格式
+ */
+export type TemplateItem = {
+    /**
+     * 模板 ID，可选
+     * 如果不提供，组件会自动生成
+     */
+    id?: string;
+    /**
+     * 类型：普通文本
+     */
+    type: 'text';
+    /**
+     * 内容
+     */
+    content: string;
+} | {
+    /**
+     * 模板 ID，可选
+     * 如果不提供，组件会自动生成
+     */
+    id?: string;
+    /**
+     * 类型：模板块（可编辑）
+     */
+    type: 'block';
+    /**
+     * 内容
+     */
+    content: string;
+} | {
+    /**
+     * 模板 ID，可选
+     * 如果不提供，组件会自动生成
+     */
+    id?: string;
+    /**
+     * 类型：选择器
+     */
+    type: 'select';
+    /**
+     * 内容（选中的值）
+     */
+    content: string;
+    /**
+     * 占位文字（未选择时显示）
+     */
+    placeholder?: string;
+    /**
+     * 选项列表
+     */
+    options?: SelectOption[];
+    /**
+     * 当前选中的值
+     */
+    value?: string;
+};
+/**
+ * 提及项
+ *
+ * 用于 @ 提及功能的数据
+ *
+ * @deprecated 请从 extensions/mention 导入
+ * @see packages/components/src/sender/extensions/mention/types.ts
+ */
+export type { MentionItem };
+/**
+ * 结构化数据（联合类型）
+ *
+ * Submit 事件的第二个参数，根据使用的扩展直接返回对应的数据数组
+ *
+ * **设计理念**：
+ * - 第一个参数 `text`：纯文本内容，适用于简单场景
+ * - 第二个参数 `data`：结构化数据数组，直接使用无需解包
+ *
+ * **类型说明**：
+ * - `TemplateItem[]`: 使用 Template 扩展时返回（混合结构）
+ * - `MentionStructuredItem[]`: 使用 Mention 扩展时返回（混合结构）
+ *
+ * @example Template 场景
+ * ```typescript
+ * function handleSubmit(text: string, data?: StructuredData) {
+ *   // text: "帮我分析 的周报"
+ *   // data: [
+ *   //   { type: 'text', content: '帮我分析 ' },
+ *   //   { type: 'block', content: '张三' },
+ *   //   { type: 'text', content: ' 的周报' }
+ *   // ]
+ *
+ *   // 提取模板块（可编辑部分）
+ *   if (data && data.some(item => item.type === 'block')) {
+ *     const blocks = data.filter(item => item.type === 'block')
+ *     console.log('模板块:', blocks)
+ *   }
+ *
+ *   // 提取选择器
+ *   if (data && data.some(item => item.type === 'select')) {
+ *     const selects = data.filter(item => item.type === 'select')
+ *     console.log('选择器:', selects)
+ *   }
+ * }
+ * ```
+ *
+ * @example Mention 场景
+ * ```typescript
+ * function handleSubmit(text: string, data?: StructuredData) {
+ *   // text: "帮我分析 @张三 的周报"
+ *   // data: [
+ *   //   { type: 'text', content: '帮我分析 ' },
+ *   //   { type: 'mention', content: '张三', value: '...' },
+ *   //   { type: 'text', content: ' 的周报' }
+ *   // ]
+ *
+ *   // 统一使用 content 属性
+ *   const allContent = data?.map(item => item.content).join('')
+ *   console.log('完整内容:', allContent)
+ *
+ *   // 提取 mention（正确的类型守卫）
+ *   if (data && data.some(item => item.type === 'mention')) {
+ *     const mentions = data.filter(item => item.type === 'mention')
+ *     console.log('提及的人:', mentions.map(m => m.content))
+ *     console.log('关联值:', mentions.map(m => m.value))
+ *   }
+ * }
+ * ```
+ */
+export type StructuredData = TemplateItem[] | MentionStructuredItem[];
+/**
+ * 默认操作按钮配置
+ *
+ * 用于统一配置 Sender 的默认按钮（Clear、Submit）
+ *
+ * @example
+ * ```typescript
+ * const defaultActions = {
+ *   submit: { disabled: !isValid, tooltip: '请完善表单' },
+ *   clear: { tooltip: '清空内容' }
+ * }
+ * ```
+ */
+export interface DefaultActions {
+    /**
+     * 提交按钮配置
+     */
+    submit?: {
+        /**
+         * 是否禁用
+         */
+        disabled?: boolean;
+        /**
+         * 工具提示
+         * - string: 简单文本
+         * - () => string | VNode: 渲染函数，支持复杂内容
+         */
+        tooltip?: TooltipContent;
+        /**
+         * Tooltip 位置
+         */
+        tooltipPlacement?: TooltipPlacement;
+    };
+    /**
+     * 清空按钮配置
+     */
+    clear?: {
+        /**
+         * 是否禁用
+         */
+        disabled?: boolean;
+        /**
+         * 工具提示
+         * - string: 简单文本
+         * - () => string | VNode: 渲染函数，支持复杂内容
+         */
+        tooltip?: TooltipContent;
+        /**
+         * Tooltip 位置
+         */
+        tooltipPlacement?: TooltipPlacement;
+    };
+}
+/**
+ * 自动高度配置
+ */
+export type AutoSize = boolean | {
+    minRows: number;
+    maxRows: number;
+};

package/dist/sender/types/components.d.ts

@@ -0,0 +1,68 @@
+import { SenderSuggestionItem } from '../extensions/suggestion/types';
+/**
+ * WordCounter Props
+ */
+export interface WordCounterProps {
+    /**
+     * 当前字符数
+     */
+    current: number;
+    /**
+     * 最大字符数
+     */
+    max: number;
+    /**
+     * 是否超出限制
+     */
+    isOverLimit: boolean;
+}
+/**
+ * SuggestionList Props
+ */
+export interface SuggestionListProps {
+    /**
+     * 是否显示
+     */
+    show: boolean;
+    /**
+     * 建议列表
+     */
+    suggestions: SenderSuggestionItem[];
+    /**
+     * 键盘激活索引
+     */
+    activeKeyboardIndex: number;
+    /**
+     * 鼠标激活索引
+     */
+    activeMouseIndex: number;
+    /**
+     * 输入值
+     */
+    inputValue: string;
+    /**
+     * 弹窗样式
+     */
+    popupStyle?: Record<string, string | number>;
+}
+/**
+ * SuggestionList Emits
+ */
+export interface SuggestionListEmits {
+    /**
+     * 选择建议
+     *
+     * @param suggestion - 建议内容
+     */
+    (e: 'select', suggestion: string): void;
+    /**
+     * 鼠标进入
+     *
+     * @param index - 索引
+     */
+    (e: 'mouse-enter', index: number): void;
+    /**
+     * 鼠标离开
+     */
+    (e: 'mouse-leave'): void;
+}