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

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

@@ -0,0 +1,49 @@
+import { KEYBOARD_KEYS } from '../constants';
+/**
+ * 键盘按键类型
+ */
+export type KeyboardKey = keyof typeof KEYBOARD_KEYS;
+/**
+ * 检查是否按下指定按键
+ *
+ * @param event - 键盘事件
+ * @param key - 按键名称
+ * @returns 是否按下指定按键
+ *
+ * @example
+ * if (isKey(event, 'ENTER')) { ... }
+ * if (isKey(event, 'ARROW_UP')) { ... }
+ */
+export declare const isKey: (event: KeyboardEvent, key: KeyboardKey) => boolean;
+/**
+ * 检查是否按下多个按键中的任意一个
+ *
+ * @param event - 键盘事件
+ * @param keys - 按键名称数组
+ * @returns 是否按下指定按键之一
+ *
+ * @example
+ * if (isAnyKey(event, ['ARROW_UP', 'ARROW_DOWN'])) { ... }
+ * if (isAnyKey(event, ['ENTER', 'TAB'])) { ... }
+ */
+export declare const isAnyKey: (event: KeyboardEvent, keys: KeyboardKey[]) => boolean;
+/**
+ * 检查是否按下方向键
+ *
+ * @param event - 键盘事件
+ * @returns 是否按下方向键
+ *
+ * @example
+ * if (isArrowKey(event)) { ... }
+ */
+export declare const isArrowKey: (event: KeyboardEvent) => boolean;
+/**
+ * 检查是否按下删除键（Backspace 或 Delete）
+ *
+ * @param event - 键盘事件
+ * @returns 是否按下删除键
+ *
+ * @example
+ * if (isDeleteKey(event)) { ... }
+ */
+export declare const isDeleteKey: (event: KeyboardEvent) => boolean;

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

@@ -0,0 +1,25 @@
+import { Selection } from '@tiptap/pm/state';
+/**
+ * 查找触发字符的位置和查询文本
+ *
+ * 用于 mention 和 suggestion 扩展
+ *
+ * @param selection - 当前光标位置
+ * @param char - 触发字符
+ * @param allowSpaces - 是否允许空格
+ * @returns 触发范围和查询文本，未找到返回 null
+ *
+ * @example
+ * const result = findTextRange(selection, '@', false)
+ * if (result) {
+ *   console.log(result.range) // { from: 10, to: 20 }
+ *   console.log(result.query) // 'user'
+ * }
+ */
+export declare function findTextRange(selection: Selection, char: string, allowSpaces?: boolean): {
+    range: {
+        from: number;
+        to: number;
+    };
+    query: string;
+} | null;

package/dist/sender/index.d.ts

@@ -0,0 +1,139 @@
+import { App } from 'vue';
+import { mention, suggestion, template } from './extensions';
+declare const Sender: {
+    new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('./index.type').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;
+    }>, {
+        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;
+    }, import('vue').PublicProps, {
+        size: "normal" | "small";
+        placeholder: string;
+        mode: import('./index.type').InputMode;
+        enterkeyhint: import('./index.type').EnterKeyHint;
+        autoSize: import('./index.type').AutoSize;
+        hasExternalContent: boolean;
+        extensions: import('@tiptap/core').Extension[] | any[];
+        submitType: import('./index.type').SubmitTrigger;
+    }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, HTMLDivElement, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<import('./index.type').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;
+    }>, {
+        submit: () => void;
+        clear: () => void;
+        cancel: () => void;
+        focus: () => void;
+        blur: () => void;
+        setContent: (content: string) => void;
+        getContent: () => string;
+        editor: import('./index.type').SenderContext["editor"];
+    }, {}, {}, {}, {
+        size: "normal" | "small";
+        placeholder: string;
+        mode: import('./index.type').InputMode;
+        enterkeyhint: import('./index.type').EnterKeyHint;
+        autoSize: import('./index.type').AutoSize;
+        hasExternalContent: boolean;
+        extensions: import('@tiptap/core').Extension[] | any[];
+        submitType: import('./index.type').SubmitTrigger;
+    }>;
+    __isFragment?: never;
+    __isTeleport?: never;
+    __isSuspense?: never;
+} & import('vue').ComponentOptionsBase<Readonly<import('./index.type').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;
+}>, {
+    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, {
+    size: "normal" | "small";
+    placeholder: string;
+    mode: import('./index.type').InputMode;
+    enterkeyhint: import('./index.type').EnterKeyHint;
+    autoSize: import('./index.type').AutoSize;
+    hasExternalContent: boolean;
+    extensions: import('@tiptap/core').Extension[] | any[];
+    submitType: import('./index.type').SubmitTrigger;
+}, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
+    $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;
+    };
+}) & {
+    install: <T>(app: App<T>) => void;
+    Mention: import('@tiptap/core').Node<import('./extensions').MentionOptions, any>;
+    Suggestion: import('@tiptap/core').Extension<import('./index.type').SuggestionOptions, any>;
+    Template: import('@tiptap/core').Extension<import('./extensions').TemplateOptions, any>;
+    mention: typeof mention;
+    suggestion: typeof suggestion;
+    template: typeof template;
+};
+export default Sender;
+export type { SenderProps, SenderEmits, SenderSlots, SenderContext, UseEditorReturn, UseModeSwitchReturn, UseSuggestionReturn, UseKeyboardShortcutsReturn, TemplateItem, MentionItem, DefaultActions, } from './index.type';
+export { useSenderContext } from './context';
+export type { TemplateAttrs, TemplateOptions } from './extensions/template';
+export type { MentionAttrs, MentionOptions } from './extensions/mention';
+export type { SenderSuggestionItem, SuggestionOptions, SuggestionState, SuggestionTextPart, HighlightFunction, } from './extensions/suggestion';

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

@@ -0,0 +1,311 @@
+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;
+    /**
+     * 是否存在外部可提交内容
+     *
+     * 用于附件、图片、文件列表等不写入编辑器文本的内容场景。
+     * 当编辑器文本为空但该值为 true 时，Sender 仍会认为存在可提交内容。
+     *
+     * @default false
+     */
+    hasExternalContent?: 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,93 @@
+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 hasExternalContent: boolean;
+    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;
+    readonly hasExternalContent: 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;
+    hasExternalContent: boolean;
+    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;
+    };
+};