@halo-dev/richtext-editor 2.21.0 → 2.22.0

package/dist/utils/upload.d.ts

@@ -0,0 +1,67 @@
+import { Editor, PMNode } from '../tiptap';
+import { Attachment } from '@halo-dev/api-client';
+import { AxiosRequestConfig } from 'axios';
+export interface FileProps {
+    file: File;
+    editor: Editor;
+}
+/**
+ * Handles file events, determining if the file is an image and triggering the appropriate upload process.
+ *
+ * @param {FileProps} { file, editor } - File and editor instances
+ * @returns {boolean} - True if a file is handled, otherwise false
+ */
+export declare const handleFileEvent: ({ file, editor }: FileProps) => boolean;
+/**
+ * Uploads an image file and inserts it into the editor.
+ *
+ * @param {FileProps} { file, editor } - File to be uploaded and the editor instance
+ */
+export declare const uploadImage: ({ file, editor }: FileProps) => void;
+/**
+ * Uploads a video file and inserts it into the editor.
+ *
+ * @param {FileProps} { file, editor } - File to be uploaded and the editor instance
+ */
+export declare const uploadVideo: ({ file, editor }: FileProps) => void;
+/**
+ * Uploads an audio file and inserts it into the editor.
+ *
+ * @param {FileProps} { file, editor } - File to be uploaded and the editor instance
+ */
+export declare const uploadAudio: ({ file, editor }: FileProps) => void;
+export interface UploadFetchResponse {
+    controller: AbortController;
+    onUploadProgress: (progress: number) => void;
+    onFinish: (attachment?: Attachment) => void;
+    onError: (error: Error) => void;
+}
+/**
+ * Uploads a file with progress monitoring, cancellation support, and callbacks for completion and errors.
+ *
+ * @param {File} file - File to be uploaded
+ * @param {Function} upload - Function to handle the file upload, should return a Promise
+ * @returns {Promise<UploadFetchResponse>} - Returns an object with control and callback methods
+ */
+export declare const uploadFile: (file: File, upload: (file: File, options?: AxiosRequestConfig) => Promise<Attachment>, uploadResponse: UploadFetchResponse) => Promise<void>;
+/**
+ * Converts a file to a Base64 string.
+ *
+ * @param {File} file - File to be converted
+ * @returns {Promise<string>} - A promise that resolves with the Base64 string
+ */
+export declare function fileToBase64(file: File): Promise<string>;
+export declare function containsFileClipboardIdentifier(types: readonly string[]): boolean;
+export declare function batchUploadExternalLink(editor: Editor, nodes: {
+    node: PMNode;
+    pos: number;
+    index: number;
+    parent: PMNode | null;
+}[]): Promise<void>;
+export declare function uploadExternalLink(editor: Editor, nodeWithPos: {
+    node: PMNode;
+    pos: number;
+    index: number;
+    parent: PMNode | null;
+}): Promise<void>;
+export declare function isExternalAsset(src: string): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halo-dev/richtext-editor",
-  "version": "2.21.0",
+  "version": "2.22.0",
   "description": "Default editor for Halo",
   "homepage": "https://github.com/halo-dev/halo/tree/main/ui/packages/editor#readme",
   "bugs": {
@@ -13,83 +13,71 @@
   },
   "license": "GPL-3.0",
   "author": "@halo-dev",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/rich-text-editor.es.js"
+      "import": "./dist/index.es.js"
     },
     "./dist/style.css": "./dist/style.css"
   },
-  "main": "./dist/rich-text-editor.iife.js",
-  "jsdelivr": "./dist/rich-text-editor.iife.js",
-  "unpkg": "./dist/rich-text-editor.iife.js",
-  "module": "./dist/rich-text-editor.es.js",
+  "main": "./dist/index.iife.js",
+  "jsdelivr": "./dist/index.iife.js",
+  "unpkg": "./dist/index.iife.js",
+  "module": "./dist/index.es.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@ckpack/vue-color": "^1.5.0",
-    "@tiptap/core": "^2.11.2",
-    "@tiptap/extension-blockquote": "^2.11.2",
-    "@tiptap/extension-bold": "^2.11.2",
-    "@tiptap/extension-bullet-list": "^2.11.2",
-    "@tiptap/extension-code": "^2.11.2",
-    "@tiptap/extension-code-block": "^2.11.2",
-    "@tiptap/extension-color": "^2.11.2",
-    "@tiptap/extension-document": "^2.11.2",
-    "@tiptap/extension-dropcursor": "^2.11.2",
-    "@tiptap/extension-hard-break": "^2.11.2",
-    "@tiptap/extension-heading": "^2.11.2",
-    "@tiptap/extension-highlight": "^2.11.2",
-    "@tiptap/extension-history": "^2.11.2",
-    "@tiptap/extension-horizontal-rule": "^2.11.2",
-    "@tiptap/extension-image": "^2.11.2",
-    "@tiptap/extension-italic": "^2.11.2",
-    "@tiptap/extension-link": "^2.11.2",
-    "@tiptap/extension-list-item": "^2.11.2",
-    "@tiptap/extension-list-keymap": "^2.11.2",
-    "@tiptap/extension-ordered-list": "^2.11.2",
-    "@tiptap/extension-paragraph": "^2.11.2",
-    "@tiptap/extension-placeholder": "^2.11.2",
-    "@tiptap/extension-strike": "^2.11.2",
-    "@tiptap/extension-subscript": "^2.11.2",
-    "@tiptap/extension-superscript": "^2.11.2",
-    "@tiptap/extension-table": "^2.11.2",
-    "@tiptap/extension-table-row": "^2.11.2",
-    "@tiptap/extension-task-item": "^2.11.2",
-    "@tiptap/extension-task-list": "^2.11.2",
-    "@tiptap/extension-text": "^2.11.2",
-    "@tiptap/extension-text-align": "^2.11.2",
-    "@tiptap/extension-text-style": "^2.11.2",
-    "@tiptap/extension-underline": "^2.11.2",
-    "@tiptap/pm": "^2.11.2",
-    "@tiptap/suggestion": "^2.11.2",
-    "@tiptap/vue-3": "^2.11.2",
-    "floating-vue": "^5.2.2",
+    "@floating-ui/dom": "^1.7.4",
+    "@tiptap/core": "^3.11.0",
+    "@tiptap/extension-blockquote": "^3.11.0",
+    "@tiptap/extension-bold": "^3.11.0",
+    "@tiptap/extension-code": "^3.11.0",
+    "@tiptap/extension-code-block": "^3.11.0",
+    "@tiptap/extension-color": "^3.11.0",
+    "@tiptap/extension-details": "^3.11.0",
+    "@tiptap/extension-document": "^3.11.0",
+    "@tiptap/extension-drag-handle": "^3.11.0",
+    "@tiptap/extension-drag-handle-vue-3": "^3.11.0",
+    "@tiptap/extension-hard-break": "^3.11.0",
+    "@tiptap/extension-heading": "^3.11.0",
+    "@tiptap/extension-highlight": "^3.11.0",
+    "@tiptap/extension-horizontal-rule": "^3.11.0",
+    "@tiptap/extension-image": "^3.11.0",
+    "@tiptap/extension-italic": "^3.11.0",
+    "@tiptap/extension-link": "^3.11.0",
+    "@tiptap/extension-list": "^3.11.0",
+    "@tiptap/extension-paragraph": "^3.11.0",
+    "@tiptap/extension-strike": "^3.11.0",
+    "@tiptap/extension-subscript": "^3.11.0",
+    "@tiptap/extension-superscript": "^3.11.0",
+    "@tiptap/extension-table": "^3.11.0",
+    "@tiptap/extension-text": "^3.11.0",
+    "@tiptap/extension-text-align": "^3.11.0",
+    "@tiptap/extension-text-style": "^3.11.0",
+    "@tiptap/extension-underline": "^3.11.0",
+    "@tiptap/extensions": "^3.11.0",
+    "@tiptap/pm": "^3.11.0",
+    "@tiptap/suggestion": "^3.11.0",
+    "@tiptap/vue-3": "^3.11.0",
     "github-markdown-css": "^5.2.0",
     "linkifyjs": "^4.1.3",
     "scroll-into-view-if-needed": "^3.1.0",
-    "tippy.js": "^6.3.7"
+    "@halo-dev/components": "2.22.0",
+    "@halo-dev/ui-shared": "2.22.0",
+    "@halo-dev/api-client": "2.22.0"
   },
   "devDependencies": {
-    "@iconify/json": "^2.2.117",
-    "@types/linkifyjs": "^2.1.7",
-    "release-it": "^16.1.5",
-    "vite-plugin-dts": "^4.2.2"
+    "@types/linkifyjs": "^2.1.7"
   },
   "peerDependencies": {
-    "vue": "^3.5.16"
+    "vue": "^3.5.x"
   },
   "scripts": {
-    "build": "vite build --config ./vite.lib.config.ts",
-    "dev": "vite",
-    "lint": "eslint ./src --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts",
-    "prettier": "prettier --write './src/**/*.{vue,js,jsx,ts,tsx,css,scss,json,yml,yaml,html}'",
-    "release": "release-it",
-    "test:unit:coverage": "vitest run --environment jsdom --coverage",
-    "test:unit:ui": "vitest --environment jsdom --watch --ui",
-    "test:unit:watch": "vitest --environment jsdom --watch",
+    "build": "vite build",
+    "dev": "vite build --watch --mode development",
     "typecheck": "vue-tsc --noEmit -p tsconfig.app.json --composite false"
   }
 }

package/dist/components/block/BlockActionInput.vue.d.ts

@@ -1,15 +0,0 @@
-declare const _default: import('vue').DefineComponent<{
-    tooltip?: string;
-    modelValue?: string;
-}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
-    "update:modelValue": (value: string) => any;
-}, string, import('vue').PublicProps, Readonly<{
-    tooltip?: string;
-    modelValue?: string;
-}> & Readonly<{
-    "onUpdate:modelValue"?: ((value: string) => any) | undefined;
-}>, {
-    tooltip: string;
-    modelValue: string;
-}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-export default _default;

package/dist/components/block/BlockCard.vue.d.ts

@@ -1,30 +0,0 @@
-import { Editor } from '../../tiptap/vue-3';
-declare function __VLS_template(): {
-    slots: {
-        content?(_: {}): any;
-        actions?(_: {}): any;
-    };
-    refs: {};
-    attrs: Partial<{}>;
-};
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<{
-    selected: boolean;
-    editor: Editor;
-    getPos: () => number;
-    deleteNode: () => void;
-}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
-    selected: boolean;
-    editor: Editor;
-    getPos: () => number;
-    deleteNode: () => void;
-}> & Readonly<{}>, {
-    selected: boolean;
-}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-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/components/bubble/BubbleMenu.vue.d.ts

@@ -1,84 +0,0 @@
-import { PropType } from 'vue';
-import { BubbleMenuPluginProps } from './BubbleMenuPlugin';
-declare function __VLS_template(): {
-    slots: {
-        default?(_: {}): any;
-    };
-    refs: {
-        root: HTMLDivElement;
-    };
-    attrs: Partial<{}>;
-};
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
-    pluginKey: {
-        type: PropType<BubbleMenuPluginProps["pluginKey"]>;
-        default: string;
-    };
-    editor: {
-        type: PropType<BubbleMenuPluginProps["editor"]>;
-        required: true;
-    };
-    tippyOptions: {
-        type: PropType<BubbleMenuPluginProps["tippyOptions"]>;
-        default: () => {};
-    };
-    shouldShow: {
-        type: PropType<Exclude<Required<BubbleMenuPluginProps>["shouldShow"], null>>;
-        default: null;
-    };
-    getRenderContainer: {
-        type: PropType<Exclude<Required<BubbleMenuPluginProps>["getRenderContainer"], null>>;
-        default: null;
-    };
-    defaultAnimation: {
-        type: PropType<BubbleMenuPluginProps["defaultAnimation"]>;
-        default: boolean;
-    };
-}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
-    pluginKey: {
-        type: PropType<BubbleMenuPluginProps["pluginKey"]>;
-        default: string;
-    };
-    editor: {
-        type: PropType<BubbleMenuPluginProps["editor"]>;
-        required: true;
-    };
-    tippyOptions: {
-        type: PropType<BubbleMenuPluginProps["tippyOptions"]>;
-        default: () => {};
-    };
-    shouldShow: {
-        type: PropType<Exclude<Required<BubbleMenuPluginProps>["shouldShow"], null>>;
-        default: null;
-    };
-    getRenderContainer: {
-        type: PropType<Exclude<Required<BubbleMenuPluginProps>["getRenderContainer"], null>>;
-        default: null;
-    };
-    defaultAnimation: {
-        type: PropType<BubbleMenuPluginProps["defaultAnimation"]>;
-        default: boolean;
-    };
-}>> & Readonly<{}>, {
-    getRenderContainer: (node: HTMLElement) => HTMLElement;
-    defaultAnimation: boolean | undefined;
-    shouldShow: (props: {
-        editor: import('@tiptap/vue-3').Editor;
-        state: import('../../tiptap').EditorState;
-        node?: HTMLElement;
-        view?: import('../../tiptap').EditorView;
-        oldState?: import('../../tiptap').EditorState;
-        from?: number;
-        to?: number;
-    }) => boolean;
-    tippyOptions: Partial<import('./BubbleMenuPlugin').TippyOptionProps> | undefined;
-    pluginKey: string | import('../../tiptap').PluginKey<any>;
-}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
-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/components/bubble/BubbleMenuPlugin.d.ts

@@ -1,52 +0,0 @@
-import { EditorView, EditorState, Plugin, PluginKey } from '../../tiptap/pm';
-import { Editor } from '../../tiptap/vue-3';
-import { Instance, Props } from 'tippy.js';
-export interface TippyOptionProps extends Props {
-    fixed?: boolean;
-}
-export interface BubbleMenuPluginProps {
-    pluginKey: PluginKey | string;
-    editor: Editor;
-    element: HTMLElement;
-    tippyOptions?: Partial<TippyOptionProps>;
-    updateDelay?: number;
-    shouldShow?: ((props: {
-        editor: Editor;
-        state: EditorState;
-        node?: HTMLElement;
-        view?: EditorView;
-        oldState?: EditorState;
-        from?: number;
-        to?: number;
-    }) => boolean) | null;
-    getRenderContainer?: (node: HTMLElement) => HTMLElement;
-    defaultAnimation?: boolean;
-}
-export type BubbleMenuViewProps = BubbleMenuPluginProps & {
-    view: EditorView;
-};
-export declare class BubbleMenuView {
-    editor: Editor;
-    element: HTMLElement;
-    view: EditorView;
-    preventHide: boolean;
-    tippy: Instance<TippyOptionProps> | undefined;
-    tippyOptions?: Partial<TippyOptionProps>;
-    getRenderContainer?: BubbleMenuPluginProps["getRenderContainer"];
-    defaultAnimation?: BubbleMenuPluginProps["defaultAnimation"];
-    shouldShow: Exclude<BubbleMenuPluginProps["shouldShow"], null>;
-    constructor({ editor, element, view, tippyOptions, shouldShow, getRenderContainer, defaultAnimation, }: BubbleMenuViewProps);
-    mousedownHandler: () => void;
-    dragstartHandler: () => void;
-    blurHandler: ({ event }: {
-        event: FocusEvent;
-    }) => void;
-    createTooltip(): void;
-    update(view: EditorView, oldState?: EditorState): void;
-    addActiveBubbleMenu: () => void;
-    removeActiveBubbleMenu: () => void;
-    show(): void;
-    hide(): void;
-    destroy(): void;
-}
-export declare const BubbleMenuPlugin: (options: BubbleMenuPluginProps) => Plugin<any>;

package/dist/dev/main.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/extensions/draggable/index.d.ts

@@ -1,13 +0,0 @@
-import { EditorView, Node, ResolvedPos } from '../../tiptap/pm';
-import { Extension } from '../../tiptap/vue-3';
-export interface ActiveNode {
-    $pos: ResolvedPos;
-    node: Node;
-    el: HTMLElement;
-    offset: number;
-    domOffsetLeft: number;
-    domOffsetTop: number;
-}
-export declare const selectAncestorNodeByDom: (dom: HTMLElement, view: EditorView) => ActiveNode | null;
-declare const Draggable: Extension<any, any>;
-export default Draggable;