@umoteam/editor 5.0.0 → 6.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umoteam/editor",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "type": "module",
   "description": "Umo Editor is open-source document editor based on Vue3 and Tiptap. Umo Editor provides comprehensive document editing capabilities and AI creation features, supports pagination, supports Markdown syntax, offers basic rich text editing functions, allows for the insertion of various node types in multiple formats, provides a variety of practical tools, and supports setting page styles. It also supports exporting in various formats, printing and print preview, block-level document editing, adding custom extensions, multi-language settings, and a dark theme.",
   "keywords": [
@@ -33,7 +33,8 @@
     "email": "support@umodoc.com"
   },
   "files": [
-    "dist"
+    "dist",
+    "types/index.d.ts"
   ],
   "exports": {
     ".": {
@@ -62,68 +63,72 @@
   "dependencies": {
     "@eslint/object-schema": "^2.1.4",
     "@imgly/background-removal": "1.5.5",
-    "@tiptap/core": "^2.6.6",
-    "@tiptap/extension-bold": "^2.6.6",
-    "@tiptap/extension-bubble-menu": "^2.6.6",
-    "@tiptap/extension-bullet-list": "^2.6.6",
-    "@tiptap/extension-character-count": "^2.6.6",
-    "@tiptap/extension-color": "^2.6.6",
-    "@tiptap/extension-document": "^2.6.6",
-    "@tiptap/extension-dropcursor": "^2.6.6",
-    "@tiptap/extension-focus": "^2.6.6",
-    "@tiptap/extension-font-family": "^2.6.6",
-    "@tiptap/extension-heading": "^2.6.6",
-    "@tiptap/extension-highlight": "^2.6.6",
-    "@tiptap/extension-horizontal-rule": "^2.6.6",
-    "@tiptap/extension-image": "^2.6.6",
-    "@tiptap/extension-link": "^2.6.6",
-    "@tiptap/extension-ordered-list": "^2.6.6",
-    "@tiptap/extension-placeholder": "^2.6.6",
-    "@tiptap/extension-subscript": "^2.6.6",
-    "@tiptap/extension-superscript": "^2.6.6",
-    "@tiptap/extension-table": "^2.6.6",
-    "@tiptap/extension-table-cell": "^2.6.6",
-    "@tiptap/extension-table-header": "^2.6.6",
-    "@tiptap/extension-table-row": "^2.6.6",
-    "@tiptap/extension-task-item": "^2.6.6",
-    "@tiptap/extension-task-list": "^2.6.6",
-    "@tiptap/extension-text-align": "^2.6.6",
-    "@tiptap/extension-text-style": "^2.6.6",
-    "@tiptap/extension-typography": "^2.6.6",
-    "@tiptap/extension-underline": "^2.6.6",
-    "@tiptap/pm": "^2.6.6",
-    "@tiptap/starter-kit": "^2.6.6",
-    "@tiptap/vue-3": "^2.6.6",
+    "@tiptap-extend/columns": "^2.1.6",
+    "@tiptap/core": "2.11.5",
+    "@tiptap/extension-bold": "2.11.5",
+    "@tiptap/extension-bubble-menu": "2.11.5",
+    "@tiptap/extension-bullet-list": "2.11.5",
+    "@tiptap/extension-character-count": "2.11.5",
+    "@tiptap/extension-code-block": "^2.11.7",
+    "@tiptap/extension-code-block-lowlight": "^2.11.7",
+    "@tiptap/extension-collaboration": "^2.11.5",
+    "@tiptap/extension-color": "2.11.5",
+    "@tiptap/extension-document": "2.11.5",
+    "@tiptap/extension-dropcursor": "2.11.5",
+    "@tiptap/extension-focus": "2.11.5",
+    "@tiptap/extension-font-family": "2.11.5",
+    "@tiptap/extension-heading": "2.11.5",
+    "@tiptap/extension-highlight": "2.11.5",
+    "@tiptap/extension-horizontal-rule": "2.11.5",
+    "@tiptap/extension-image": "2.11.5",
+    "@tiptap/extension-link": "2.11.5",
+    "@tiptap/extension-mention": "2.11.5",
+    "@tiptap/extension-ordered-list": "2.11.5",
+    "@tiptap/extension-placeholder": "2.11.5",
+    "@tiptap/extension-subscript": "2.11.5",
+    "@tiptap/extension-superscript": "2.11.5",
+    "@tiptap/extension-table": "2.11.5",
+    "@tiptap/extension-table-cell": "2.11.5",
+    "@tiptap/extension-table-header": "2.11.5",
+    "@tiptap/extension-table-row": "2.11.5",
+    "@tiptap/extension-task-item": "2.11.5",
+    "@tiptap/extension-task-list": "2.11.5",
+    "@tiptap/extension-text-align": "2.11.5",
+    "@tiptap/extension-text-style": "2.11.5",
+    "@tiptap/extension-typography": "2.11.5",
+    "@tiptap/extension-underline": "2.11.5",
+    "@tiptap/pm": "2.11.5",
+    "@tiptap/starter-kit": "2.11.5",
+    "@tiptap/suggestion": "2.11.5",
+    "@tiptap/vue-3": "2.11.5",
     "@tool-belt/type-predicates": "^1.3.0",
     "@types/svg64": "^1.1.2",
-    "@umoteam/editor-external": "4.5.0",
-    "@vue-monaco/editor": "^0.0.6",
+    "@umoteam/editor-external": "5.0.0",
     "@vueuse/core": "^11.0.3",
     "buffer-image-size": "^0.6.4",
-    "docx": "^8.5.0",
     "dom-to-image-more": "^3.4.3",
-    "es-drager": "^1.2.11",
+    "es-drager": "1.2.11",
     "file-saver": "^2.0.5",
     "file64": "^1.0.4",
+    "highlight.js": "^11.11.1",
     "hotkeys-js": "^3.13.7",
     "jsbarcode": "^3.11.6",
     "katex": "^0.16.11",
+    "lowlight": "^3.3.0",
     "mermaid": "^11.2.0",
     "nzh": "^1.0.13",
     "plyr": "^3.7.8",
     "pretty-bytes": "^6.1.1",
-    "prism-code-editor": "^3.4.0",
-    "prismjs": "^1.29.0",
-    "prosemirror-docx": "^0.2.0",
     "prosemirror-transform": "^1.10.0",
     "qrcode-svg": "^1.1.0",
     "sign-canvas-plus": "^2.0.3",
     "smooth-signature": "^1.0.15",
     "svg64": "^2.0.0",
     "tippy.js": "^6.3.7",
-    "ts-deepmerge": "^7.0.1",
     "vue-i18n": "^10.0.0",
-    "zeed-dom": "^0.14.0"
+    "y-prosemirror": "^1.2.15",
+    "y-protocols": "^1.0.6",
+    "yjs": "^13.6.23"
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.1.0",
@@ -131,10 +136,14 @@
     "@intlify/unplugin-vue-i18n": "^5.0.0",
     "@sereneinserenade/tiptap-search-and-replace": "^0.1.1",
     "@testing-library/vue": "^8.1.0",
-    "@tiptap-pro/extension-invisible-characters": "^2.11.2",
-    "@tiptap-pro/extension-mathematics": "^2.11.2",
-    "@tiptap-pro/extension-table-of-contents": "^2.11.2",
+    "@tiptap-pro/extension-drag-handle": "2.17.5",
+    "@tiptap-pro/extension-drag-handle-vue-3": "2.17.5",
+    "@tiptap-pro/extension-invisible-characters": "2.17.5",
+    "@tiptap-pro/extension-mathematics": "2.17.5",
+    "@tiptap-pro/extension-node-range": "2.17.5",
+    "@tiptap-pro/extension-table-of-contents": "2.17.5",
     "@types/dom-to-image": "^2.6.7",
+    "@types/eslint-config-prettier": "^6.11.3",
     "@types/file-saver": "^2.0.7",
     "@types/node": "^22.5.4",
     "@types/qrcode-svg": "^1.1.5",
@@ -144,7 +153,7 @@
     "@vue-macros/reactivity-transform": "^1.0.4",
     "@vue-macros/volar": "^0.29.1",
     "@vue/eslint-config-prettier": "^9.0.0",
-    "eslint": "^8.57.0",
+    "eslint": "^9.21.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-functional": "^5.0.8",
     "eslint-plugin-simple-import-sort": "^12.1.1",
@@ -152,6 +161,7 @@
     "eslint-plugin-vue": "^9.28.0",
     "globals": "^15.9.0",
     "husky": "^9.1.5",
+    "jiti": "^2.4.2",
     "jsdom": "^25.0.0",
     "less": "^4.2.0",
     "less-loader": "^12.2.0",
@@ -163,7 +173,7 @@
     "stylelint-config-recommended-less": "^3.0.1",
     "stylelint-config-recommended-vue": "^1.5.0",
     "stylelint-less": "^3.0.1",
-    "tdesign-vue-next": "^1.10.0",
+    "tdesign-vue-next": "1.9.8",
     "typescript": "5.5.4",
     "typescript-eslint": "^8.5.0",
     "unplugin-auto-import": "^0.18.2",

package/types/index.d.ts

@@ -0,0 +1,239 @@
+import type { Extension } from '@tiptap/core'
+import type { AsyncFunction } from '@tool-belt/type-predicates'
+
+export type SupportedLocale = 'en-US' | 'zh-CN' | 'ru-RU'
+export interface MarginOption {
+  left: number
+  right: number
+  top: number
+  bottom: number
+}
+export interface WatermarkOption {
+  type: string
+  alpha: number
+  fontColor: string
+  fontSize: number
+  fontFamily: string
+  fontWeight: string
+  text: string
+}
+export interface PageOption {
+  defaultMargin?: MarginOption
+  defaultOrientation?: string
+  defaultBackground?: string
+  showBreakMarks?: boolean
+  showBookmark?: boolean
+  watermark?: WatermarkOption
+  size?: {
+    width: number
+    height: number
+    label?: LocaleLabel
+  }
+  margin?: {
+    right: number
+    left: number
+    bottom: number
+    top: number
+    layout?: 'narrow' | 'moderate' | 'wide' | 'custom'
+  }
+  orientation?: string
+  background?: string
+  header?: boolean
+  footer?: boolean
+  showLineNumber?: boolean
+  showToc?: boolean
+  zoomLevel?: number
+  bodyHeight?: number
+  autoWidth?: boolean
+  preview?: {
+    enabled?: boolean
+    laserPointer?: boolean
+  }
+}
+
+export type ToolbarMenu =
+  | 'base'
+  | 'insert'
+  | 'table'
+  | 'tools'
+  | 'page'
+  | 'export'
+  | 'advanced'
+  | 'custom'
+
+export interface ToolbarOptions {
+  defaultMode: 'classic' | 'ribbon'
+  menus: ToolbarMenu[]
+  disableMenuItems: string[]
+  importWord: {
+    enabled: boolean
+    options: unknown
+    useCustomMethod?: boolean
+    onCustomImportMethod?: (file: File) => Promise<{
+      id: string
+      url: string
+      value: string
+      messages: { type: string; message: string }
+    }>
+  }
+}
+
+export interface AutoSaveOptions {
+  enabled: boolean
+  interval: number
+}
+
+export interface DocumentOptions {
+  id?: string
+  title: string
+  content: string
+  placeholder?: Record<string, string>
+  enableSpellcheck?: boolean
+  enableMarkdown?: boolean
+  enableBubbleMenu?: boolean
+  enableBlockMenu?: boolean
+  // enableComment?: boolean
+  readOnly?: boolean
+  autofocus?: 'start' | 'end' | 'all' | number | boolean | null
+  characterLimit?: number
+  typographyRules?: Record<string, unknown>
+  editorProps?: Record<string, unknown>
+  parseOptions?: Record<string, unknown>
+  autoSave?: AutoSaveOptions
+}
+
+export type LocaleLabel =
+  | string
+  | { en_US: string; zh_CN: string; ru_RU: string }
+
+export interface PageSize {
+  label: LocaleLabel
+  width: number
+  height: number
+  default?: boolean
+}
+
+export interface Font {
+  label: LocaleLabel
+  value: string | null
+}
+
+export interface LineHeight {
+  label: LocaleLabel
+  value: number
+  default?: boolean
+}
+
+export interface GraphicSymbol {
+  label: LocaleLabel
+  items: string
+}
+
+export interface Emoji {
+  label: LocaleLabel
+  items: string
+}
+
+export interface Template {
+  title: string
+  content: string
+  description?: string
+  value: string
+  divider?: boolean
+}
+
+export interface AssistantOptions {
+  enabled: boolean
+  maxlength: number
+  commands: CommandItem[]
+  onMessage?: AsyncFunction
+}
+
+export interface EchartsOptions {
+  mode: number
+  renderImage: boolean
+  onCustomSettings?: CallableFunction
+}
+
+export interface UserItem {
+  id: string
+  label: string
+  avatar?: string
+}
+
+export interface WebPageItem {
+  label: LocaleLabel
+  icon: string
+  validate(url: string): boolean
+  transformURL?(url: string): string
+}
+
+export interface CommandItem {
+  label: LocaleLabel
+  value: LocaleLabel
+  autoSend?: boolean
+}
+
+export interface AssistantPayload {
+  lang: string
+  input: string
+  command: string
+  output: string
+}
+
+export interface AssistantContent {
+  html: string
+  text: string
+  json: unknown
+}
+export interface AssistantResult {
+  prompt: string
+  content: string
+  error: boolean
+  command?: string
+}
+
+export interface FileOptions {
+  allowedMimeTypes: string[]
+  maxSize: number
+  preview: {
+    extensions?: string[]
+    url: string
+  }[]
+}
+
+export interface UmoEditorOptions {
+  editorKey: string
+  locale: SupportedLocale
+  theme: 'light' | 'dark'
+  height: string
+  fullscreenZIndex: number
+  dicts?: {
+    pageSizes: PageSize[]
+    fonts: Font[]
+    colors: string[]
+    lineHeights: LineHeight[]
+    symbols: GraphicSymbol[]
+    emojis: Emoji[]
+  }
+  toolbar?: ToolbarOptions
+  page: PageOption
+  document?: DocumentOptions
+  ai?: {
+    assistant: AssistantOptions
+  }
+  echarts?: EchartsOptions
+  webPages?: WebPageItem[]
+  templates?: Template[]
+  cdnUrl?: string
+  shareUrl?: string
+  diagrams?: Record<string, unknown>
+  file?: FileOptions
+  user?: Record<string, unknown>
+  users?: UserItem[]
+  extensions?: Extension[]
+  translations?: Record<string, unknown>
+  onSave?: AsyncFunction
+  onFileUpload?: (file: File) => Promise<{ id: string; url: string }>
+  onFileDelete?: CallableFunction
+}