vix-editor 0.0.1

package/lib/src/extensions/TextBubble/components/TextDropdown.vue.d.ts

@@ -0,0 +1,49 @@
+import { Editor } from '@tiptap/vue-3';
+
+interface Props {
+    editor: Editor;
+    disabled?: boolean;
+    color?: string;
+    maxHeight?: string | number;
+    icon?: any;
+    tooltip?: string;
+}
+declare const _default: import('vue').DefineComponent<globalThis.ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {
+    disabled: boolean;
+    color: undefined;
+    maxHeight: undefined;
+    icon: undefined;
+    tooltip: string;
+    items: () => never[];
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<globalThis.ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {
+    disabled: boolean;
+    color: undefined;
+    maxHeight: undefined;
+    icon: undefined;
+    tooltip: string;
+    items: () => never[];
+}>>> & Readonly<{}>, {
+    icon: any;
+    color: string;
+    disabled: boolean;
+    tooltip: string;
+    maxHeight: string | number;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/lib/src/extensions/TextBubble/index.d.ts

@@ -0,0 +1 @@
+export * from './TextBubble';

package/lib/src/extensions/TrailingNode/TrailingNode.d.ts

@@ -0,0 +1,12 @@
+import { Extension } from '@tiptap/core';
+
+/**
+ * Extension based on:
+ * - https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/extensions/TrailingNode.js
+ * - https://github.com/remirror/remirror/blob/e0f1bec4a1e8073ce8f5500d62193e52321155b9/packages/prosemirror-trailing-node/src/trailing-node-plugin.ts
+ */
+export interface TrailingNodeOptions {
+    node: string;
+    notAfter: string[];
+}
+export declare const TrailingNode: Extension<TrailingNodeOptions, any>;

package/lib/src/extensions/TrailingNode/index.d.ts

@@ -0,0 +1 @@
+export * from './TrailingNode';

package/lib/src/extensions/UnderLine/Underline.d.ts

@@ -0,0 +1,6 @@
+import { UnderlineOptions as TiptapUnderlineOptions } from '@tiptap/extension-underline';
+import { GeneralOptions } from '../../type';
+
+export interface UnderlineOptions extends TiptapUnderlineOptions, GeneralOptions<UnderlineOptions> {
+}
+export declare const Underline: import('@tiptap/core').Mark<UnderlineOptions, any>;

package/lib/src/extensions/UnderLine/index.d.ts

@@ -0,0 +1 @@
+export * from './Underline';

package/lib/src/extensions/Video/Video.d.ts

@@ -0,0 +1,55 @@
+import { Node } from '@tiptap/core';
+
+/**
+ * Represents the interface for video options, extending GeneralOptions.
+ */
+export interface VideoOptions {
+    /**
+     * Indicates whether fullscreen play is allowed
+     *
+     * @default true
+     */
+    allowFullscreen: boolean;
+    /**
+     * Indicates whether to display the frameborder
+     *
+     * @default false
+     */
+    frameborder: boolean;
+    /**
+     * Width of the video, can be a number or string
+     *
+     * @default VIDEO_SIZE['size-medium']
+     */
+    width: number | string;
+    /** HTML attributes object for passing additional attributes */
+    HTMLAttributes: {
+        [key: string]: any;
+    };
+    upload?: (file: File) => Promise<string>;
+}
+/**
+ * Represents the type for setting video options
+ */
+type SetVideoOptions = {
+    /** The source URL of the video */
+    src: string;
+    /** The width of the video */
+    width: string | number;
+};
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        video: {
+            /**
+             * Add an video
+             */
+            setVideo: (options: Partial<SetVideoOptions>) => ReturnType;
+            /**
+             * Update an video
+             */
+            updateVideo: (options: Partial<SetVideoOptions>) => ReturnType;
+        };
+    }
+}
+export declare const Video: Node<VideoOptions, any>;
+export {};

package/lib/src/extensions/Video/index.d.ts

@@ -0,0 +1 @@
+export * from './Video';

package/lib/src/extensions/VideoUpload/VideoUpload.d.ts

@@ -0,0 +1,14 @@
+import { Node } from '@tiptap/vue-3';
+
+export interface VideoOptions {
+    upload?: (files: File[]) => void;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        videoUpload: {
+            setVideoUpload: () => ReturnType;
+        };
+    }
+}
+export declare const VideoUpload: Node<VideoOptions, any>;
+export default VideoUpload;

package/lib/src/extensions/VideoUpload/components/VideoUploader.vue.d.ts

@@ -0,0 +1,92 @@
+declare const _default: import('vue').DefineComponent<globalThis.ExtractPropTypes<{
+    editor: {
+        type: PropType<import('@tiptap/core').NodeViewProps["editor"]>;
+        required: true;
+    };
+    node: {
+        type: PropType<import('@tiptap/core').NodeViewProps["node"]>;
+        required: true;
+    };
+    decorations: {
+        type: PropType<import('@tiptap/core').NodeViewProps["decorations"]>;
+        required: true;
+    };
+    selected: {
+        type: PropType<import('@tiptap/core').NodeViewProps["selected"]>;
+        required: true;
+    };
+    extension: {
+        type: PropType<import('@tiptap/core').NodeViewProps["extension"]>;
+        required: true;
+    };
+    getPos: {
+        type: PropType<import('@tiptap/core').NodeViewProps["getPos"]>;
+        required: true;
+    };
+    updateAttributes: {
+        type: PropType<import('@tiptap/core').NodeViewProps["updateAttributes"]>;
+        required: true;
+    };
+    deleteNode: {
+        type: PropType<import('@tiptap/core').NodeViewProps["deleteNode"]>;
+        required: true;
+    };
+    view: {
+        type: PropType<import('@tiptap/core').NodeViewProps["view"]>;
+        required: true;
+    };
+    innerDecorations: {
+        type: PropType<import('@tiptap/core').NodeViewProps["innerDecorations"]>;
+        required: true;
+    };
+    HTMLAttributes: {
+        type: PropType<import('@tiptap/core').NodeViewProps["HTMLAttributes"]>;
+        required: true;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<globalThis.ExtractPropTypes<{
+    editor: {
+        type: PropType<import('@tiptap/core').NodeViewProps["editor"]>;
+        required: true;
+    };
+    node: {
+        type: PropType<import('@tiptap/core').NodeViewProps["node"]>;
+        required: true;
+    };
+    decorations: {
+        type: PropType<import('@tiptap/core').NodeViewProps["decorations"]>;
+        required: true;
+    };
+    selected: {
+        type: PropType<import('@tiptap/core').NodeViewProps["selected"]>;
+        required: true;
+    };
+    extension: {
+        type: PropType<import('@tiptap/core').NodeViewProps["extension"]>;
+        required: true;
+    };
+    getPos: {
+        type: PropType<import('@tiptap/core').NodeViewProps["getPos"]>;
+        required: true;
+    };
+    updateAttributes: {
+        type: PropType<import('@tiptap/core').NodeViewProps["updateAttributes"]>;
+        required: true;
+    };
+    deleteNode: {
+        type: PropType<import('@tiptap/core').NodeViewProps["deleteNode"]>;
+        required: true;
+    };
+    view: {
+        type: PropType<import('@tiptap/core').NodeViewProps["view"]>;
+        required: true;
+    };
+    innerDecorations: {
+        type: PropType<import('@tiptap/core').NodeViewProps["innerDecorations"]>;
+        required: true;
+    };
+    HTMLAttributes: {
+        type: PropType<import('@tiptap/core').NodeViewProps["HTMLAttributes"]>;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/lib/src/extensions/VideoUpload/index.d.ts

@@ -0,0 +1 @@
+export * from './VideoUpload';

package/lib/src/extensions/index.d.ts

@@ -0,0 +1,80 @@
+export { Bold } from './Bold';
+export type { BoldOptions } from './Bold';
+export { Italic } from './Italic';
+export type { ItalicOptions } from './Italic';
+export { Underline } from './UnderLine';
+export type { UnderlineOptions } from './UnderLine';
+export { Strike } from './Strike';
+export type { StrikeOptions } from './Strike';
+export { Code } from './Code';
+export type { CodeOptions } from './Code';
+export { CodeBlock } from './CodeBlock';
+export type { CodeBlockOptions } from './CodeBlock';
+export { Heading } from './Heading';
+export type { HeadingOptions } from './Heading';
+export { TextAlign } from './TextAlign';
+export type { TextAlignOptions } from './TextAlign';
+export { FontSize } from './FontSize';
+export type { FontSizeOptions } from './FontSize';
+export { Color } from './Color';
+export type { ColorOptions } from './Color';
+export { Highlight } from './Highlight';
+export type { HighlightOptions } from './Highlight';
+export { BulletList } from './BulletList';
+export type { BulletListOptions } from './BulletList';
+export { Clear } from './Clear';
+export type { ClearOptions } from './Clear';
+export { OrderedList } from './OrderedList';
+export type { OrderedListOptions } from './OrderedList';
+export { TaskList } from './TaskList';
+export type { TaskListOptions } from './TaskList';
+export { Blockquote } from './Blockquote';
+export type { BlockquoteOptions } from './Blockquote';
+export { Link } from './Link';
+export type { LinkOptions } from './Link';
+export { HorizontalRule } from './HorizontalRule';
+export type { HorizontalRuleOptions } from './HorizontalRule';
+export { History } from './History';
+export type { HistoryOptions } from './History';
+export { Fullscreen } from './Fullscreen';
+export type { FullscreenOptions } from './Fullscreen';
+export { BaseKit } from './BaseKit';
+export type { BaseKitOptions } from './BaseKit';
+export { SubAndSuperScript } from './Subscript';
+export type { SubAndSuperScriptOptions } from './Subscript';
+export type { MoreMarkOptions } from './MoreMark';
+export { MoreMark } from './MoreMark';
+export { Indent } from './Indent';
+export type { IndentOptions } from './Indent';
+export { LineHeight } from './LineHeight';
+export type { LineHeightOptions } from './LineHeight';
+export { SlashCommand } from './SlashCommand';
+export { Image } from './Image';
+export type { SetImageAttrsOptions } from './Image';
+export { Video } from './Video/Video';
+export type { VideoOptions } from './Video';
+export { Table } from './Table';
+export type { TableOptions } from './Table';
+export { AI } from './AI';
+export { FormatPainter } from './FormatPainter';
+export type { FormatPainterOptions } from './FormatPainter';
+export { ImportWord } from './ImportWord';
+export type { ImportWordOptions } from './ImportWord';
+export { Columns } from './MultiColumn';
+export type { ColumnsOptions } from './MultiColumn';
+export { ImageUpload } from './ImageUpload';
+export type { ImageUploadOptions } from './ImageUpload';
+export { VideoUpload } from './VideoUpload';
+export { FontFamily } from './FontFamily';
+export type { FontFamilyOptions } from './FontFamily';
+export type { PreviewOptions } from './Preview';
+export { Preview } from './Preview';
+export { FindAndReplace } from './FindAndReplace';
+export { Printer } from './Printer';
+export type { PrinterOptions } from './Printer';
+export { Iframe } from './Iframe';
+export type { IframeOptions } from './Iframe';
+export { MentionCommand } from './Mention';
+export { Card } from './Card';
+export { ReferenceDot } from './ReferenceDot';
+export { EChartsView } from './EChartsView';

package/lib/src/hooks/index.d.ts

@@ -0,0 +1,4 @@
+export { createContext, useContext } from './useContext';
+export { useTiptapStore } from './useStore';
+export { useHotkeys } from './useHotkeys';
+export * from './useEditorFocus';

package/lib/src/hooks/useAIConversation.d.ts

@@ -0,0 +1,19 @@
+import { Editor } from '@tiptap/vue-3';
+
+export declare function useAIConversation(editor: Editor): {
+    result: globalThis.Ref<string, string>;
+    status: globalThis.Ref<"init" | "generating" | "completed", "init" | "generating" | "completed">;
+    conversationHistory: globalThis.Ref<{
+        role: string;
+        content: string;
+    }[], {
+        role: string;
+        content: string;
+    }[] | {
+        role: string;
+        content: string;
+    }[]>;
+    handleCompletion: (context: string, prompt: string) => Promise<string>;
+    resetConversation: () => void;
+    stopGeneration: () => void;
+};

package/lib/src/hooks/useContext.d.ts

@@ -0,0 +1,21 @@
+import { AnyExtension } from '@tiptap/core';
+
+interface Instance {
+    /**
+     * List of extensions
+     *
+     * @default []
+     */
+    extensions: AnyExtension[];
+    /**
+     * Default language setting
+     *
+     * @default DEFAULT_LANG_VALUE
+     */
+    defaultLang?: string;
+}
+export declare function createContext(instance: Partial<Instance>): void;
+export declare function useContext(): {
+    state: Instance;
+};
+export {};

package/lib/src/hooks/useEditorFocus.d.ts

@@ -0,0 +1,17 @@
+import { Editor } from '@tiptap/core';
+
+export interface UseEditorFocusOptions {
+    editor: Editor | null;
+    /**
+     * 更新聚焦状态的防抖等待时间（毫秒）
+     * @default 250
+     */
+    wait?: number;
+}
+/**
+ * 处理编辑器聚焦状态的 Hook
+ * 用于防止在操作工具栏等界面元素时出现边框闪烁的问题
+ */
+export declare function useEditorFocus({ editor, wait }: UseEditorFocusOptions): {
+    isFocused: globalThis.Ref<boolean, boolean>;
+};

package/lib/src/hooks/useHotkeys.d.ts

@@ -0,0 +1,4 @@
+export declare const useHotkeys: (keys: string, callback: CallableFunction) => {
+    bind: () => void;
+    unbind: () => void;
+};

package/lib/src/hooks/useStore.d.ts

@@ -0,0 +1,50 @@
+import { ComputedRef } from 'vue';
+import { AnyExtension } from '@tiptap/core';
+
+/**
+ * Interface representing an tiptap editor instance.
+ */
+interface Instance {
+    /**
+     * List of extensions
+     *
+     * @default []
+     */
+    extensions: AnyExtension[];
+    /**
+     * Default language setting
+     *
+     * @default DEFAULT_LANG_VALUE
+     */
+    defaultLang?: string;
+    /**
+     * Whether it is in fullscreen mode
+     *
+     * @default false
+     */
+    isFullscreen: boolean;
+    /** Text color */
+    color?: string;
+    /** Highlight color */
+    highlight?: string;
+    /** AI Menu visibility */
+    AIMenu: boolean;
+    /** Preview visibility */
+    showPreview: boolean;
+    /** SpellCheck */
+    spellCheck: boolean;
+    /** FindAndReplace */
+    findAndReplace: boolean;
+    /** Printer */
+    printer: boolean;
+}
+export declare const useTiptapStore: () => {
+    state: Instance;
+    isFullscreen: ComputedRef<boolean>;
+    toggleFullscreen: () => void;
+    togglePreview: () => void;
+    toggleSpellCheck: () => void;
+    toggleFindAndReplace: () => void;
+    togglePrinter: () => void;
+};
+export {};

package/lib/src/index.d.ts

@@ -0,0 +1,14 @@
+import { Plugin } from 'vue';
+import { default as EchoEditor } from './components/EchoEditor.vue';
+import { default as ActionButton } from './components/ActionButton.vue';
+import { default as locale, zh_CN, en_US } from './locales';
+
+declare const EchoEditorPlugin: Plugin;
+export { en_US, locale, zh_CN };
+export * from './extensions';
+export { useEditor } from '@tiptap/vue-3';
+export type * from './type';
+export { type Editor as EditorInstance, type JSONContent } from '@tiptap/core';
+export type { EchoEditorProps, EchoEditorEmits } from './type';
+export { EchoEditorPlugin, EchoEditor, ActionButton };
+export default EchoEditorPlugin;

package/lib/src/lib/utils.d.ts

@@ -0,0 +1,7 @@
+import { Ref } from 'vue';
+import { ClassValue } from 'clsx';
+
+type Updater<T> = any;
+export declare function cn(...inputs: ClassValue[]): string;
+export declare function valueUpdater<T extends Updater<any>>(updaterOrValue: T, ref: Ref): void;
+export {};

package/lib/src/locales/index.d.ts

@@ -0,0 +1,31 @@
+import { default as zh_CN } from './locales/zh';
+import { default as en_US } from './locales/en';
+
+interface LocaleInterface {
+    lang: string;
+    message: Record<string, Record<string, string>>;
+}
+export declare const DEFAULT_LOCALE: LocaleInterface;
+declare class Locale {
+    private emitter;
+    constructor();
+    get lang(): string;
+    set lang(lang: string);
+    get message(): Record<string, Record<string, string>>;
+    set message(message: Record<string, Record<string, string>>);
+    loadLangMessage(lang: string): Record<string, string>;
+    private isLangSupported;
+    setLang(lang: string): void;
+    registerWatchLang(hook: (lang: string) => void): {
+        unsubscribe: () => void;
+    };
+    setMessage(lang: string, message: Record<string, string>): void;
+    buildLocalesHandler(lang?: string): (path: string) => string;
+}
+declare const locale: Locale;
+declare const useLocale: () => {
+    lang: globalThis.Ref<string, string>;
+    t: globalThis.ComputedRef<(path: string) => string>;
+};
+export default locale;
+export { Locale, useLocale, zh_CN, en_US };

package/lib/src/locales/locales/en.d.ts

@@ -0,0 +1,2 @@
+declare const locale: Record<string, string>;
+export default locale;

package/lib/src/locales/locales/zh.d.ts

@@ -0,0 +1,2 @@
+declare const locale: Record<string, string>;
+export default locale;

package/lib/src/plugins/DragHandle/index.d.ts

@@ -0,0 +1,20 @@
+import { PluginKey, Plugin } from '@tiptap/pm/state';
+import { Editor } from '@tiptap/core';
+import { Node } from '@tiptap/pm/model';
+import { Props as TippyProps } from 'tippy.js';
+
+declare const dragHandlePluginDefaultKey: PluginKey<any>;
+declare const DragHandlePlugin: ({ pluginKey: customPluginKey, element: dragHandleElement, editor, tippyOptions, onNodeChange }: {
+    pluginKey?: PluginKey | string;
+    element: HTMLElement;
+    editor: Editor;
+    tippyOptions?: Partial<TippyProps>;
+    onNodeChange?: (data: {
+        editor: Editor;
+        node: Node | null;
+        pos: number;
+    }) => void;
+}) => Plugin<{
+    locked: boolean;
+}>;
+export { DragHandlePlugin, dragHandlePluginDefaultKey };

package/lib/src/plugins/DragHandle/range.d.ts

@@ -0,0 +1,32 @@
+import { Selection, SelectionRange } from '@tiptap/pm/state';
+import { ResolvedPos, Node as ProseMirrorNode } from '@tiptap/pm/model';
+import { Mapping, Mappable } from '@tiptap/pm/transform';
+
+export declare function getSelectionRanges(state: ResolvedPos, range: ResolvedPos, depth?: number): SelectionRange[];
+declare class NodeRangeBookmark {
+    anchor: number;
+    head: number;
+    constructor(anchor: number, head: number);
+    map(mapping: Mappable): NodeRangeBookmark;
+    resolve(doc: ProseMirrorNode): NodeRangeSelection;
+}
+export declare class NodeRangeSelection extends Selection {
+    depth: number | undefined;
+    constructor(from: ResolvedPos, to: ResolvedPos, depth?: number, bias?: number);
+    get $to(): ResolvedPos;
+    eq(other: Selection): boolean;
+    map(doc: ProseMirrorNode, mapping: Mapping): NodeRangeSelection;
+    toJSON(): {
+        type: string;
+        anchor: number;
+        head: number;
+    };
+    get isForwards(): boolean;
+    get isBackwards(): boolean;
+    extendBackwards(): NodeRangeSelection;
+    extendForwards(): NodeRangeSelection;
+    static fromJSON(doc: ProseMirrorNode, json: any): NodeRangeSelection;
+    static create(doc: ProseMirrorNode, anchor: number, head: number, depth?: number, bias?: number): NodeRangeSelection;
+    getBookmark(): NodeRangeBookmark;
+}
+export {};

package/lib/src/plugins/DragHandle/utils.d.ts

@@ -0,0 +1,17 @@
+import { Editor } from '@tiptap/core';
+
+export declare function cloneElement(node: HTMLElement): any;
+export declare function getComputedStyles(element: Element, styleProperty: any): string;
+export declare function minMax(value?: number, minimum?: number, maximum?: number): number;
+export declare function removeNode(node: HTMLElement): void;
+export type FindElementNextToCoords = {
+    x: number;
+    y: number;
+    direction?: 'left' | 'right';
+    editor: Editor;
+};
+export declare const findElementNextToCoords: (options: FindElementNextToCoords) => {
+    resultElement: any;
+    resultNode: any;
+    pos: any;
+};

package/lib/src/plugins/image-upload.d.ts

@@ -0,0 +1,12 @@
+import { Plugin } from '@tiptap/pm/state';
+import { DecorationSet, EditorView } from '@tiptap/pm/view';
+
+export declare const UploadImagesPlugin: () => Plugin<DecorationSet>;
+export interface ImageUploadOptions {
+    validateFn?: (file: File) => boolean;
+    onUpload: (file: File) => Promise<string | object>;
+}
+export type UploadFn = (files: File[], view: EditorView, pos: number) => void;
+export declare const createImageUpload: ({ validateFn, onUpload }: ImageUploadOptions) => UploadFn;
+export declare const handleImagePaste: (view: EditorView, event: ClipboardEvent, uploadFn: UploadFn) => boolean;
+export declare const handleImageDrop: (view: EditorView, event: DragEvent, moved: boolean, uploadFn: UploadFn) => boolean;