@yiitap/vue 0.8.0 → 0.10.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@yiitap/vue",
   "description": "A WYSIWYG rich-text block-based editor built on top of tiptap.",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "private": false,
   "author": {
     "name": "Yiitap",
@@ -29,70 +29,71 @@
   "dependencies": {
     "@floating-ui/dom": "^1.7.4",
     "@mermaid-js/layout-elk": "^0.2.0",
-    "@tiptap/core": "^3.7.2",
-    "@tiptap/extension-blockquote": "^3.7.2",
-    "@tiptap/extension-bubble-menu": "^3.7.2",
-    "@tiptap/extension-code-block-lowlight": "^3.7.2",
-    "@tiptap/extension-details": "^3.7.2",
-    "@tiptap/extension-document": "^3.7.2",
-    "@tiptap/extension-font-family": "^3.7.2",
-    "@tiptap/extension-heading": "^3.7.2",
-    "@tiptap/extension-highlight": "^3.7.2",
-    "@tiptap/extension-horizontal-rule": "^3.7.2",
-    "@tiptap/extension-image": "^3.7.2",
-    "@tiptap/extension-link": "^3.7.2",
-    "@tiptap/extension-list": "^3.7.2",
-    "@tiptap/extension-mathematics": "^3.7.2",
-    "@tiptap/extension-mention": "^3.7.2",
-    "@tiptap/extension-paragraph": "^3.7.2",
-    "@tiptap/extension-subscript": "^3.7.2",
-    "@tiptap/extension-superscript": "^3.7.2",
-    "@tiptap/extension-table": "^3.7.2",
-    "@tiptap/extension-text": "^3.7.2",
-    "@tiptap/extension-text-align": "^3.7.2",
-    "@tiptap/extension-text-style": "^3.7.2",
-    "@tiptap/extension-typography": "^3.7.2",
-    "@tiptap/extension-underline": "^3.7.2",
-    "@tiptap/extensions": "^3.7.2",
-    "@tiptap/markdown": "^3.7.2",
-    "@tiptap/pm": "^3.7.2",
-    "@tiptap/starter-kit": "^3.7.2",
-    "@tiptap/suggestion": "^3.7.2",
-    "@tiptap/vue-3": "^3.7.2",
     "katex": "^0.16.25",
     "lowlight": "^3.3.0",
     "mermaid": "^11.12.0",
     "tippy.js": "^6.3.7",
-    "uuid": "^10.0.0",
-    "@yiitap/core": "0.8.0",
-    "@yiitap/extension-char-command": "0.8.0",
-    "@yiitap/extension-callout": "0.8.0",
-    "@yiitap/extension-color-highlighter": "0.8.0",
-    "@yiitap/extension-image": "0.8.0",
-    "@yiitap/extension-focus": "0.8.0",
-    "@yiitap/extension-ai-block": "0.8.0",
-    "@yiitap/extension-inline-placeholder": "0.8.0",
-    "@yiitap/extension-placeholder": "0.8.0",
-    "@yiitap/extension-selection-decoration": "0.8.0",
-    "@yiitap/extension-table": "0.8.0",
-    "@yiitap/extension-shortcut": "0.8.0",
-    "@yiitap/extension-table-wrapper": "0.8.0",
-    "@yiitap/extension-trailing-node": "0.8.0",
-    "@yiitap/extension-unique-id": "0.8.0",
-    "@yiitap/extension-video": "0.8.0",
-    "@yiitap/vue": "0.8.0",
-    "@yiitap/util-emoji": "0.8.0"
+    "uuid": "^10.0.0"
   },
   "peerDependencies": {
-    "@tiptap/extension-emoji": "3.7.2",
-    "@tiptap/extension-mathematics": "3.7.2",
+    "@tiptap/extension-emoji": "^3.16.0",
+    "@tiptap/extension-mathematics": "^3.16.0",
+    "@tiptap/core": "^3.16.0",
+    "@tiptap/extension-blockquote": "^3.16.0",
+    "@tiptap/extension-bubble-menu": "^3.16.0",
+    "@tiptap/extension-code-block-lowlight": "^3.16.0",
+    "@tiptap/extension-collaboration": "^3.16.0",
+    "@tiptap/extension-collaboration-caret": "^3.16.0",
+    "@tiptap/extension-details": "^3.16.0",
+    "@tiptap/extension-document": "^3.16.0",
+    "@tiptap/extension-font-family": "^3.16.0",
+    "@tiptap/extension-heading": "^3.16.0",
+    "@tiptap/extension-highlight": "^3.16.0",
+    "@tiptap/extension-horizontal-rule": "^3.16.0",
+    "@tiptap/extension-image": "^3.16.0",
+    "@tiptap/extension-link": "^3.16.0",
+    "@tiptap/extension-list": "^3.16.0",
+    "@tiptap/extension-mention": "^3.16.0",
+    "@tiptap/extension-paragraph": "^3.16.0",
+    "@tiptap/extension-subscript": "^3.16.0",
+    "@tiptap/extension-superscript": "^3.16.0",
+    "@tiptap/extension-table": "^3.16.0",
+    "@tiptap/extension-text": "^3.16.0",
+    "@tiptap/extension-text-align": "^3.16.0",
+    "@tiptap/extension-text-style": "^3.16.0",
+    "@tiptap/extension-typography": "^3.16.0",
+    "@tiptap/extension-underline": "^3.16.0",
+    "@tiptap/extension-unique-id": "^3.16.0",
+    "@tiptap/extensions": "^3.16.0",
+    "@tiptap/markdown": "^3.16.0",
+    "@tiptap/pm": "^3.16.0",
+    "@tiptap/starter-kit": "^3.16.0",
+    "@tiptap/suggestion": "^3.16.0",
+    "@tiptap/vue-3": "^3.16.0",
     "@types/uuid": "^10.0.0",
     "@mermaid-js/layout-elk": "^0.2.0",
     "katex": "^0.16.25",
     "markdown-it": "^14.1.0",
     "mermaid": "^11.12.0",
     "openai": "^4.88.0",
-    "vue": "^3.3.8"
+    "vue": "^3.3.8",
+    "@yiitap/core": "0.10.0",
+    "@yiitap/extension-ai-block": "0.10.0",
+    "@yiitap/extension-callout": "0.10.0",
+    "@yiitap/extension-char-command": "0.10.0",
+    "@yiitap/extension-color-highlighter": "0.10.0",
+    "@yiitap/extension-focus": "0.10.0",
+    "@yiitap/extension-image": "0.10.0",
+    "@yiitap/extension-inline-placeholder": "0.10.0",
+    "@yiitap/extension-placeholder": "0.10.0",
+    "@yiitap/extension-selection-decoration": "0.10.0",
+    "@yiitap/extension-shortcut": "0.10.0",
+    "@yiitap/extension-table": "0.10.0",
+    "@yiitap/extension-table-wrapper": "0.10.0",
+    "@yiitap/extension-task-item": "0.10.0",
+    "@yiitap/extension-video": "0.10.0",
+    "@yiitap/util-emoji": "0.10.0",
+    "@yiitap/vue": "0.10.0"
   },
   "devDependencies": {
     "rollup-plugin-visualizer": "^5.14.0",

package/types/components/YiiEditor.vue.d.ts

@@ -1,43 +1,25 @@
 import { type PropType } from 'vue';
 import type { FocusPosition } from '@tiptap/core';
-import { EditorContent } from '@tiptap/vue-3';
-import OMainMenu from './menus/OMainMenu.vue';
-import OBubbleMenu from './menus/OBubbleMenu.vue';
-import OFloatingMenu from './menus/OFloatingMenu.vue';
-import OSideMenu from './menus/OSideMenu.vue';
+import type { CollaborationOptions } from '@tiptap/extension-collaboration';
+import type { CollaborationCaretOptions } from '@tiptap/extension-collaboration-caret';
 import { Editor } from '@tiptap/core';
 type SideMenuAddType = 'menu' | 'empty';
 interface SideMenuConfig {
     show: boolean;
     add: SideMenuAddType;
 }
-declare const darkModeAlt: import("vue").Ref<boolean, boolean>;
-declare const editor: import("vue").ShallowRef<import("@tiptap/vue-3").Editor, import("@tiptap/vue-3").Editor>;
-declare const mainMenuOptions: import("vue").ComputedRef<{
-    editor: import("@tiptap/vue-3").Editor;
-    menu: string[];
-}>;
-declare const bubbleMenuOptions: import("vue").ComputedRef<{
-    editor: import("@tiptap/vue-3").Editor;
-    menu: string[];
-}>;
-declare const floatingMenuOptions: import("vue").ComputedRef<{
-    editor: import("@tiptap/vue-3").Editor;
-    menu: string[];
-}>;
-declare const sideMenuOptions: import("vue").ComputedRef<{
-    editor: import("@tiptap/vue-3").Editor;
-    add: SideMenuAddType;
-    menu: any[];
-}>;
-declare const __VLS_ctx: InstanceType<__VLS_PickNotAny<typeof __VLS_self, new () => {}>>;
+interface CollabConfig {
+    enabled: boolean;
+    collaboration: CollaborationOptions;
+    collaborationCaret: CollaborationCaretOptions;
+}
 declare var __VLS_4: {}, __VLS_6: {};
-type __VLS_Slots = __VLS_PrettifyGlobal<__VLS_OmitStringIndex<typeof __VLS_ctx.$slots> & {
+type __VLS_Slots = {} & {
     'toolbar-left'?: (props: typeof __VLS_4) => any;
 } & {
     'toolbar-right'?: (props: typeof __VLS_6) => any;
-}>;
-declare const __VLS_self: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+};
+declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     /**
      * Initial content. This can be HTML or JSON.
      */
@@ -177,335 +159,12 @@ declare const __VLS_self: import("vue").DefineComponent<import("vue").ExtractPro
         type: PropType<AiOption>;
         default: () => void;
     };
-}>, {
-    EditorContent: typeof EditorContent;
-    OMainMenu: typeof OMainMenu;
-    OBubbleMenu: typeof OBubbleMenu;
-    OFloatingMenu: typeof OFloatingMenu;
-    OSideMenu: typeof OSideMenu;
-    darkModeAlt: typeof darkModeAlt;
-    editor: typeof editor;
-    mainMenuOptions: typeof mainMenuOptions;
-    bubbleMenuOptions: typeof bubbleMenuOptions;
-    floatingMenuOptions: typeof floatingMenuOptions;
-    sideMenuOptions: typeof sideMenuOptions;
-}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
-    update: (payload: {
-        json: Object;
-        html: string;
-    }) => any;
-    transaction: (payload: {
-        editor: Editor;
-        transaction: Object;
-    }) => any;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    /**
-     * Initial content. This can be HTML or JSON.
-     */
-    content: {
-        type: (ObjectConstructor | StringConstructor)[];
-        default: string;
-    };
-    /**
-     * Set first block as title.
-     */
-    title: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Determines if users can write into the editor.
-     */
-    editable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Force the cursor to jump in the editor on initialization.
-     */
-    autofocus: {
-        type: PropType<FocusPosition>;
-        default: boolean;
-    };
     /**
-     * Set the locale of the editor
+     * Collab config.
      */
-    locale: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * By default, Yiitap is in light mode, you can set it to dark mode.
-     */
-    darkMode: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Show main menu or not.
-     */
-    showMainMenu: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Show bubble menu or not.
-     */
-    showBubbleMenu: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Show floating menu or not.
-     */
-    showFloatingMenu: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Side menu config
-     */
-    sideMenu: {
-        type: PropType<SideMenuConfig>;
-        default: () => SideMenuConfig;
-    };
-    /**
-     * Show side node or not.
-     */
-    showSideNode: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Configure the list of extensions you want to enable.
-     *
-     * By default, Yiitap enables
-     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/extensions/index.ts" target="_blank">BuiltinExtensions</a>.
-     */
-    extensions: {
-        type: () => string[];
-        default: () => any[];
-    };
-    /**
-     * Configure the list of menu items you want to enable in main menu.
-     *
-     * By default, Yiitap uses
-     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultMenu</a>.
-     */
-    mainMenu: {
-        type: () => string[];
-        default: () => any[];
-    };
-    /**
-     * Configure the list of menu items you want to enable in table menu.
-     *
-     * By default, Yiitap uses
-     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">TableMenu</a>.
-     */
-    tableMenu: {
-        type: () => string[];
-        default: () => any[];
-    };
-    /**
-     * Configure the list of menu items you want to enable in bubble menu.
-     *
-     * By default, Yiitap uses
-     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultBubble</a>.
-     */
-    bubbleMenu: {
-        type: () => string[];
-        default: () => any[];
-    };
-    /**
-     * Configure the list of menu items you want to enable in floating menu.
-     *
-     * By default, Yiitap uses
-     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultFloating</a>.
-     */
-    floatingMenu: {
-        type: () => string[];
-        default: () => any[];
-    };
-    /**
-     * Set the page view of the editor.
-     */
-    pageView: {
-        type: StringConstructor;
-        default: string;
-        validator: (value: string) => boolean;
-    };
-    aiOption: {
-        type: PropType<AiOption>;
-        default: () => void;
-    };
-}>> & Readonly<{
-    onUpdate?: (payload: {
-        json: Object;
-        html: string;
-    }) => any;
-    onTransaction?: (payload: {
-        editor: Editor;
-        transaction: Object;
-    }) => any;
-}>, {
-    locale: string;
-    content: string | Record<string, any>;
-    title: boolean;
-    extensions: string[];
-    autofocus: FocusPosition;
-    editable: boolean;
-    aiOption: AiOption;
-    darkMode: boolean;
-    bubbleMenu: string[];
-    floatingMenu: string[];
-    sideMenu: SideMenuConfig;
-    showMainMenu: boolean;
-    showBubbleMenu: boolean;
-    showFloatingMenu: boolean;
-    showSideNode: boolean;
-    mainMenu: string[];
-    tableMenu: string[];
-    pageView: string;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
-declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
-    /**
-     * Initial content. This can be HTML or JSON.
-     */
-    content: {
-        type: (ObjectConstructor | StringConstructor)[];
-        default: string;
-    };
-    /**
-     * Set first block as title.
-     */
-    title: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Determines if users can write into the editor.
-     */
-    editable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Force the cursor to jump in the editor on initialization.
-     */
-    autofocus: {
-        type: PropType<FocusPosition>;
-        default: boolean;
-    };
-    /**
-     * Set the locale of the editor
-     */
-    locale: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * By default, Yiitap is in light mode, you can set it to dark mode.
-     */
-    darkMode: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Show main menu or not.
-     */
-    showMainMenu: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Show bubble menu or not.
-     */
-    showBubbleMenu: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Show floating menu or not.
-     */
-    showFloatingMenu: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Side menu config
-     */
-    sideMenu: {
-        type: PropType<SideMenuConfig>;
-        default: () => SideMenuConfig;
-    };
-    /**
-     * Show side node or not.
-     */
-    showSideNode: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Configure the list of extensions you want to enable.
-     *
-     * By default, Yiitap enables
-     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/extensions/index.ts" target="_blank">BuiltinExtensions</a>.
-     */
-    extensions: {
-        type: () => string[];
-        default: () => any[];
-    };
-    /**
-     * Configure the list of menu items you want to enable in main menu.
-     *
-     * By default, Yiitap uses
-     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultMenu</a>.
-     */
-    mainMenu: {
-        type: () => string[];
-        default: () => any[];
-    };
-    /**
-     * Configure the list of menu items you want to enable in table menu.
-     *
-     * By default, Yiitap uses
-     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">TableMenu</a>.
-     */
-    tableMenu: {
-        type: () => string[];
-        default: () => any[];
-    };
-    /**
-     * Configure the list of menu items you want to enable in bubble menu.
-     *
-     * By default, Yiitap uses
-     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultBubble</a>.
-     */
-    bubbleMenu: {
-        type: () => string[];
-        default: () => any[];
-    };
-    /**
-     * Configure the list of menu items you want to enable in floating menu.
-     *
-     * By default, Yiitap uses
-     * <a href="https://github.com/yiitap/yiitap/blob/main/packages/vue/src/constants/menu.ts" target="_blank">DefaultFloating</a>.
-     */
-    floatingMenu: {
-        type: () => string[];
-        default: () => any[];
-    };
-    /**
-     * Set the page view of the editor.
-     */
-    pageView: {
-        type: StringConstructor;
-        default: string;
-        validator: (value: string) => boolean;
-    };
-    aiOption: {
-        type: PropType<AiOption>;
-        default: () => void;
+    collab: {
+        type: PropType<CollabConfig>;
+        default: () => CollabConfig;
     };
 }>, {
     /**
@@ -669,6 +328,13 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
         type: PropType<AiOption>;
         default: () => void;
     };
+    /**
+     * Collab config.
+     */
+    collab: {
+        type: PropType<CollabConfig>;
+        default: () => CollabConfig;
+    };
 }>> & Readonly<{
     onUpdate?: (payload: {
         json: Object;
@@ -681,6 +347,7 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
 }>, {
     locale: string;
     content: string | Record<string, any>;
+    floatingMenu: string[];
     title: boolean;
     extensions: string[];
     autofocus: FocusPosition;
@@ -688,7 +355,6 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
     aiOption: AiOption;
     darkMode: boolean;
     bubbleMenu: string[];
-    floatingMenu: string[];
     sideMenu: SideMenuConfig;
     showMainMenu: boolean;
     showBubbleMenu: boolean;
@@ -697,6 +363,7 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
     mainMenu: string[];
     tableMenu: string[];
     pageView: string;
+    collab: CollabConfig;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
 export default _default;

package/types/components/common/OBlockPlaceholder.vue.d.ts

@@ -17,7 +17,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         default: string;
     };
 }>> & Readonly<{}>, {
-    icon: string;
     placeholder: string;
+    icon: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export default _default;