bg-editor 0.0.1

package/package.json

@@ -0,0 +1,200 @@
+{
+  "name": "bg-editor",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "open-source document editor based on Vue3 and Tiptap. 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": [
+    "document editor",
+    "docs editor",
+    "word editor",
+    "office edtior",
+    "web editor",
+    "richtext editor",
+    "wysiwyg editor",
+    "vue editor",
+    "vue3 editor",
+    "ai editor",
+    "editor",
+    "web office",
+    "online office",
+    "tiptap"
+  ],
+  "license": "MIT",
+  "files": [
+    "dist",
+    "types/index.d.ts",
+    "types/src/*"
+  ],
+  "main": "./dist/umo-editor.js",
+  "module": "./dist/umo-editor.js",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/umo-editor.js",
+      "default": "./dist/umo-editor.js"
+    },
+    "./style": {
+      "import": "./dist/style.css",
+      "default": "./dist/style.css"
+    }
+  },
+  "types": "./types/index.d.ts",
+  "dependencies": {
+    "@eslint/object-schema": "^2.1.4",
+    "@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.5",
+    "@tiptap/extension-code-block-lowlight": "2.11.5",
+    "@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-history": "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": "^9.0.0",
+    "@umoteam/viewer": "^0.3.0",
+    "@vueuse/core": "^11.0.3",
+    "buffer-image-size": "^0.6.4",
+    "dom-to-image-more": "^3.4.3",
+    "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",
+    "prosemirror-transform": "^1.10.0",
+    "pure-svg-code": "^1.0.6",
+    "sign-canvas-plus": "^2.0.3",
+    "smooth-signature": "^1.0.15",
+    "svg64": "^2.0.0",
+    "tippy.js": "^6.3.7",
+    "vue-i18n": "^10.0.0",
+    "y-prosemirror": "^1.2.15",
+    "y-protocols": "^1.0.6",
+    "yjs": "^13.6.23"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.10.0",
+    "@intlify/unplugin-vue-i18n": "^5.0.0",
+    "@sereneinserenade/tiptap-search-and-replace": "^0.1.1",
+    "@testing-library/vue": "^8.1.0",
+    "@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",
+    "@typescript-eslint/eslint-plugin": "^8.5.0",
+    "@typescript-eslint/parser": "^8.5.0",
+    "@vitejs/plugin-vue": "^4.6.2",
+    "@vue-macros/reactivity-transform": "^1.0.4",
+    "@vue-macros/volar": "^0.29.1",
+    "@vue/eslint-config-prettier": "^9.0.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",
+    "eslint-plugin-unused-imports": "^4.1.3",
+    "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",
+    "lint-staged": "^15.2.10",
+    "postcss": "^8.3.3",
+    "postcss-html": "^1.7.0",
+    "prettier": "^3.3.3",
+    "stylelint": "^16.9.0",
+    "stylelint-config-recommended-less": "^3.0.1",
+    "stylelint-config-recommended-vue": "^1.5.0",
+    "stylelint-less": "^3.0.1",
+    "tdesign-vue-next": "1.9.8",
+    "typescript": "5.5.4",
+    "typescript-eslint": "^8.5.0",
+    "unplugin-auto-import": "^0.18.2",
+    "unplugin-vue": "^5.1.5",
+    "unplugin-vue-components": "^0.27.4",
+    "unplugin-vue-macros": "^2.11.11",
+    "vite": "^5.0.0",
+    "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",
+    "vitest": "^2.0.5",
+    "vue": "^3.0.11",
+    "vue-tsc": "^2.1.6"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "lint-staged": {
+    "*.{js,jsx,mjs,cjs,ts,tsx,mts,cts,vue,less,css,yml,yaml,json,md,html}": [
+      "prettier --write src"
+    ],
+    "*.{css,less,vue}": [
+      "stylelint --write src/**/*.{css,less,vue}"
+    ],
+    "*.{js,jsx,mjs,cjs,ts,tsx,mts,cts,vue}": [
+      "eslint --fix src"
+    ]
+  },
+  "scripts": {
+    "build": "vue-tsc --noEmit && vite build",
+    "dev": "vite --port 9000 --open --force",
+    "format": "prettier --write .",
+    "check:code": "eslint --cache src",
+    "check:style": "stylelint src/**/*.{css,less,vue}",
+    "check:types": "vue-tsc --noEmit",
+    "lint:code": "eslint --cache --fix src",
+    "lint:style": "stylelint --fix src/**/*.{css,less,vue}",
+    "test": "NODE_NO_WARNINGS=1 vitest",
+    "test:coverage": "npm run test --coverage",
+    "test:watch": "npm run test --watch --coverage",
+    "push": "pnpm build && pnpm publish --no-git-checks --registry https://registry.npmjs.org/"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,277 @@
+import type { Extension, HTMLContent, JSONContent } from '@tiptap/core'
+import type { FocusPosition } from '@tiptap/core'
+import { Fragment, Node as ProseMirrorNode } from '@tiptap/pm/model'
+
+export type SupportedLocale = 'en-US' | 'zh-CN'
+export type LayoutOption = 'web' | 'page'
+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 {
+  layouts: LayoutOption[]
+  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 {
+  showSaveLabel?: boolean
+  defaultMode?: 'classic' | 'ribbon'
+  menus?: ToolbarMenu[]
+}
+
+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 {
+  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
+  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 }
+
+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[]
+  showDefaultCommands?: boolean
+  onMessage?: (
+    payload: AssistantPayload,
+    content: AssistantContent,
+  ) => Promise<ReadableStream | string>
+}
+
+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
+  icon?: string
+  autoSend?: boolean
+  children?: CommandItem[]
+}
+
+export interface AssistantPayload {
+  lang?: string
+  input?: string
+  command?: string
+  output?: string
+}
+
+export interface AssistantContent {
+  html: HTMLContent
+  json: JSONContent
+  text: string
+}
+export interface AssistantResult {
+  prompt?: string
+  content?: string
+  error?: boolean
+  command?: string
+}
+
+export interface FileOptions {
+  allowedMimeTypes?: string[]
+  maxSize?: number
+  preview?: {
+    extensions?: string[]
+    url?: string
+  }[]
+}
+
+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>
+
+type DeleteFileType = 'image' | 'video' | 'audio' | 'file' | 'inlineImage'
+
+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>
+  importWord?: ImportWordOptions
+  file?: FileOptions
+  user?: Record<string, unknown>
+  users?: UserItem[]
+  extensions?: Extension[]
+  disableExtensions?: string[]
+  translations?: Record<string, unknown>
+  onSave?: OnSaveFunction
+  onFileUpload?: (file: File) => Promise<{ id: string; url: string }>
+  onFileDelete?: (id: string, url: string, type?: DeleteFileType) => void
+}
+
+// 组件类型声明
+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?: Partial<UmoEditorOptions>) => void;
+};
+export { UmoEditor as default, UmoDialog, UmoEditor, UmoMenuButton, UmoTooltip, useUmoEditor, };