@mnykj/alleditor-vue 0.0.0-stage → 1.3.1

package/README.md

@@ -1,3 +1,52 @@
-# Temporary Holding Version
+# @mnykj/alleditor-vue
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+AllEditor 桌面 Web 壳（wang + UE）。与 `@mnykj/alleditor@1.3.0` **同版本锁步**（本包 `dependencies` 为精确版本，不是 `^`）。
+
+## 安装
+
+```bash
+npm i @mnykj/alleditor-vue
+```
+
+会自动装上匹配的 `@mnykj/alleditor` 与 `@mnykj/alleditor-for-vue`。
+
+> 说明：npm 上历史包名 `@mnykj/alleditor-core` 是旧 slate 内核，已在本仓库改名为 `@mnykj/alleditor-core`。消费侧「引擎」请用 `@mnykj/alleditor`。
+
+## Nuxt
+
+```ts
+export default defineNuxtConfig({
+  modules: ['@mnykj/alleditor-vue/nuxt'],
+})
+```
+
+若应用已有精确路由 `/ueditor`（演示页），不要挂本模块；改用 Nitro server 路由托管包内 `ueditor/`，避免 `publicAssets` 抢路由。
+
+## Vite
+
+```ts
+import { alleditorUeditor } from '@mnykj/alleditor-vue/vite'
+plugins: [alleditorUeditor()]
+```
+
+## 用法
+
+```vue
+<script setup>
+import { AllEditor } from '@mnykj/alleditor-vue'
+import '@mnykj/alleditor/dist/css/style.css'
+</script>
+
+<template>
+  <AllEditor v-model="html" style="height: 500px" />
+</template>
+```
+
+`DualEditor` 仍可作为别名导入，但请迁移到 `AllEditor`。
+
+插槽（工作台等场景）：
+
+- `#aside`：侧栏大纲
+- `#main-before` / `#main-after`：主栏前后（打开目录按钮、右键菜单等）
+
+属性：`showToolbar`、`showWorkarea`、`mainClass`。

package/nuxt.ts

@@ -0,0 +1,67 @@
+/**
+ * Nuxt 模块：自动把包内 ueditor 挂到 /ueditor/（开发 + 生产 publicAssets）。
+ *
+ * // nuxt.config.ts
+ * export default defineNuxtConfig({
+ *   modules: ['@mnykj/alleditor-vue/nuxt'],
+ * })
+ *
+ * 注意：若应用已有精确路由 `/ueditor`（如演示页），请勿用本模块，
+ * 改用 server 路由托管包内静态资源，避免 publicAssets 抢路由。
+ *
+ * `@nuxt/kit` 从消费方项目解析（file: 联接时本包目录下没有该依赖）。
+ */
+import { createRequire } from 'node:module'
+import { existsSync } from 'node:fs'
+import { join } from 'node:path'
+import { DEFAULT_UEDITOR_PUBLIC_BASE, getUeditorPackageDir } from './src/ueditorPaths'
+
+const requireFromApp = createRequire(join(process.cwd(), 'package.json'))
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { defineNuxtModule } = requireFromApp('@nuxt/kit') as typeof import('@nuxt/kit')
+
+export interface ModuleOptions {
+  /** 浏览器访问前缀，默认 /ueditor */
+  baseURL?: string
+  /** 是否启用，默认 true */
+  enabled?: boolean
+}
+
+export default defineNuxtModule<ModuleOptions>({
+  meta: {
+    name: '@mnykj/alleditor-vue',
+    configKey: 'alleditorVue',
+  },
+  defaults: {
+    baseURL: 'ueditor',
+    enabled: true,
+  },
+  setup(options, nuxt) {
+    if (options.enabled === false) return
+    const dir = getUeditorPackageDir()
+    if (!existsSync(join(dir, 'ueditor.all.min.js'))) {
+      console.warn('[alleditor-vue] 包内缺少 ueditor 资源:', dir)
+      return
+    }
+    const baseURL = String(options.baseURL || 'ueditor').replace(/^\/+|\/+$/g, '')
+    nuxt.options.nitro = nuxt.options.nitro || {}
+    nuxt.options.nitro.publicAssets = nuxt.options.nitro.publicAssets || []
+    nuxt.options.nitro.publicAssets.push({
+      baseURL,
+      dir,
+      maxAge: 60 * 60 * 24 * 7,
+    })
+    nuxt.options.vite = nuxt.options.vite || {}
+    nuxt.options.vite.server = nuxt.options.vite.server || {}
+    nuxt.options.vite.server.fs = nuxt.options.vite.server.fs || {}
+    const allow = new Set([
+      ...((nuxt.options.vite.server.fs.allow as string[]) || []),
+      dir,
+    ])
+    nuxt.options.vite.server.fs.allow = [...allow]
+
+    nuxt.options.runtimeConfig.public = nuxt.options.runtimeConfig.public || {}
+    ;(nuxt.options.runtimeConfig.public as any).alleditorUeditorBase =
+      `/${baseURL}/` || DEFAULT_UEDITOR_PUBLIC_BASE
+  },
+})

package/package.json

@@ -1,6 +1,64 @@
 {
   "name": "@mnykj/alleditor-vue",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.3.1",
+  "description": "AllEditor Vue3 desktop shell (wang + UE). Lockstep with @mnykj/alleditor.",
+  "author": "mnykj",
+  "license": "MIT",
+  "type": "module",
+  "main": "./src/index.ts",
+  "module": "./src/index.ts",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts",
+    "./UeHtmlEngine.vue": "./src/UeHtmlEngine.vue",
+    "./AllEditor.vue": "./src/AllEditor.vue",
+    "./DualEditor.vue": "./src/AllEditor.vue",
+    "./vite": "./vite.ts",
+    "./nuxt": "./nuxt.ts",
+    "./ueditor/*": "./ueditor/*",
+    "./iconfont.css": "./src/assets/iconfont/iconfont.css"
+  },
+  "files": [
+    "src",
+    "ueditor",
+    "vite.ts",
+    "nuxt.ts",
+    "README.md",
+    "scripts"
+  ],
+  "keywords": [
+    "AllEditor",
+    "alleditor",
+    "alleditor-vue",
+    "ueditor",
+    "vue3",
+    "mnykj"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@mnykj/alleditor": "1.3.1",
+    "@mnykj/alleditor-for-vue": "1.3.1",
+    "markdown-it": "^14.3.3"
+  },
+  "peerDependencies": {
+    "@nuxt/kit": ">=3",
+    "vite": ">=4",
+    "vue": "^3.0.5"
+  },
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    },
+    "@nuxt/kit": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "sync:ueditor": "node ./scripts/sync-ueditor.mjs",
+    "prepack": "node ./scripts/sync-ueditor.mjs",
+    "build": "node -e \"console.log('@mnykj/alleditor-vue ships Vue/TS source + ueditor assets; no bundle step')\""
+  }
+}

package/scripts/sync-ueditor.mjs

@@ -0,0 +1,28 @@
+/**
+ * 从 monorepo 的 other_editor/ueditor 构建产物同步到本包 ueditor/，便于发 npm。
+ * 若源不存在但包内已有资源，则跳过（方便纯发包场景）。
+ */
+import { cpSync, existsSync, mkdirSync, rmSync } from 'node:fs'
+import { dirname, join, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const dualRoot = resolve(dirname(fileURLToPath(import.meta.url)), '..')
+const dest = join(dualRoot, 'ueditor')
+const src = resolve(dualRoot, '../../../other_editor/ueditor/dist/utf8-php')
+const destOk = existsSync(join(dest, 'ueditor.all.min.js'))
+const srcOk = existsSync(join(src, 'ueditor.all.min.js'))
+
+if (!srcOk) {
+  if (destOk) {
+    console.log('[sync-ueditor] 源不存在，保留包内已有 ueditor/', dest)
+    process.exit(0)
+  }
+  console.error('[sync-ueditor] 未找到源产物且包内无资源')
+  console.error('  源:', join(src, 'ueditor.all.min.js'))
+  process.exit(1)
+}
+
+rmSync(dest, { recursive: true, force: true })
+mkdirSync(dest, { recursive: true })
+cpSync(src, dest, { recursive: true })
+console.log('[sync-ueditor] synced ->', dest)