@umoteam/editor 7.0.0 → 8.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umoteam/editor",
-  "version": "7.0.0",
+  "version": "8.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": [
@@ -27,7 +27,7 @@
     "url": "https://www.umodoc.com"
   },
   "license": "MIT",
-  "homepage": "https://editor.umodoc.com/en/docs",
+  "homepage": "https://www.umodoc.com",
   "repository": {
     "type": "git",
     "url": "https://github.com/umodoc/editor.git"
@@ -38,7 +38,8 @@
   },
   "files": [
     "dist",
-    "types/index.d.ts"
+    "types/index.d.ts",
+    "types/src/*"
   ],
   "exports": {
     ".": {
@@ -109,6 +110,7 @@
     "@tool-belt/type-predicates": "^1.3.0",
     "@types/svg64": "^1.1.2",
     "@umoteam/editor-external": "6.1.0",
+    "@umoteam/viewer": "^0.1.8",
     "@vueuse/core": "^11.0.3",
     "buffer-image-size": "^0.6.4",
     "dom-to-image-more": "^3.4.3",
@@ -186,6 +188,7 @@
     "unplugin-vue-components": "^0.27.4",
     "unplugin-vue-macros": "^2.11.11",
     "vite": "^4.5.3",
+    "vite-plugin-dts": "^4.5.4",
     "vite-plugin-inspect": "^0.8.7",
     "vite-plugin-svg-icons": "^2.0.1",
     "vite-tsconfig-paths": "^5.0.1",

package/types/index.d.ts

@@ -1,7 +1,10 @@
-import type { Extension } from '@tiptap/core'
+import type { Extension, HTMLContent, JSONContent } from '@tiptap/core'
+import type { FocusPosition } from '@tiptap/core'
+import { Fragment, Node as ProseMirrorNode } from '@tiptap/pm/model'
 import type { AsyncFunction } from '@tool-belt/type-predicates'
 
-export type SupportedLocale = 'en-US' | 'zh-CN' | 'ru-RU'
+export type SupportedLocale = 'en-US' | 'zh-CN'
+export type LayoutOption = 'web' | 'page'
 export interface MarginOption {
   left: number
   right: number
@@ -18,6 +21,7 @@ export interface WatermarkOption {
   text?: string
 }
 export interface PageOption {
+  layouts: LayoutOption[]
   defaultMargin?: MarginOption
   defaultOrientation?: string
   defaultBackground?: string
@@ -64,19 +68,19 @@ export type ToolbarMenu =
 export interface ToolbarOptions {
   defaultMode?: 'classic' | 'ribbon'
   menus?: ToolbarMenu[]
-  disableMenuItems?: string[]
-  importWord?: {
-    enabled?: boolean
-    maxSize?: number
-    options?: unknown
-    useCustomMethod?: boolean
-    onCustomImportMethod?: (file: File) => Promise<{
-      id: string
-      url: string
-      value: string
-      messages: { type: string; message: string }
-    }>
-  }
+}
+
+export interface ImportWordOptions {
+  enabled?: boolean
+  maxSize?: number
+  options?: unknown
+  useCustomMethod?: boolean
+  onCustomImportMethod?: (file: File) => Promise<{
+    id: string
+    url: string
+    value: string
+    messages: { type: string; message: string }
+  }>
 }
 
 export interface AutoSaveOptions {
@@ -102,9 +106,7 @@ export interface DocumentOptions {
   autoSave?: AutoSaveOptions
 }
 
-export type LocaleLabel =
-  | string
-  | { en_US: string; zh_CN: string; ru_RU: string }
+export type LocaleLabel = string | { en_US: string; zh_CN: string }
 
 export interface PageSize {
   label: LocaleLabel
@@ -202,6 +204,29 @@ export interface FileOptions {
   }[]
 }
 
+export type InsterContentType = string | Fragment | ProseMirrorNode
+
+export interface SetContentOptions {
+  emitUpdate: boolean
+  focusPosition: FocusPosition
+  focusOptions: { scrollIntoView: boolean }
+}
+export type InsterContentOptions = Omit<SetContentOptions, 'emitUpdate'> & {
+  updateSelection: boolean
+}
+
+export type SetContentType = InsterContentType | JSONContent | JSONContent[]
+
+type OnSaveFunction = (
+  content: {
+    html: HTMLContent
+    json: JSONContent
+    text: string
+  },
+  page: PageOption,
+  document: DocumentOptions,
+) => Promise<unknown>
+
 export interface UmoEditorOptions {
   editorKey?: string
   locale?: SupportedLocale
@@ -228,15 +253,17 @@ export interface UmoEditorOptions {
   cdnUrl?: string
   shareUrl?: string
   diagrams?: Record<string, unknown>
+  importWord?: ImportWordOptions
   file?: FileOptions
   user?: Record<string, unknown>
   users?: UserItem[]
   extensions?: Extension[]
+  disableExtensions?: string[]
   translations?: Record<string, unknown>
-  onSave?: AsyncFunction
+  onSave?: OnSaveFunction
   onFileUpload?: (file: File) => Promise<{ id: string; url: string }>
   onFileDelete?: CallableFunction
 }
 
 // 组件类型声明
-export * from '../dist/umo-editor'
+export * from './src/components'

package/types/src/components/index.d.ts

@@ -0,0 +1,9 @@
+import { UmoEditorOptions } from '../../../types';
+import { default as UmoEditor } from './index.vue';
+import { default as UmoMenuButton } from './menus/button.vue';
+import { default as UmoDialog } from './modal.vue';
+import { default as UmoTooltip } from './tooltip.vue';
+declare const useUmoEditor: {
+    install: (app: any, options: UmoEditorOptions) => void;
+};
+export { UmoEditor as default, UmoDialog, UmoEditor, UmoMenuButton, UmoTooltip, useUmoEditor, };