@qingwu-ui/ai-editor 0.9.0-beta.20 → 0.9.0-beta.25

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -11,14 +11,15 @@
11
11
  - **智能辅助写作** - 续写、润色、精简、扩写、修正、翻译、自定义指令,基于 Vercel AI SDK 统一接口
12
12
  - **AI 替换保护** - 选中 / 全文 AI 替换前弹确认弹窗列出将被移除的媒体;替换后孤儿媒体延迟 30s 删除,期间 `Ctrl+Z` 还原 URL 即取消,避免 undo 后资源 404
13
13
  - **丰富的媒体嵌入** - 图片、视频(B站 / 直链 / 小红书)、音频、附件(支持 206+ 格式在线预览)
14
- - **Markdown 粘贴** - Obsidian 风格的 `[[链接]]` 和 `![[图片]]` 语法支持;粘贴外部 Markdown(Obsidian / Typora)时自动检测本地相对路径图片/附件,匹配剪贴板文件上传换链,找不到时引导文件夹选择 / 拖拽补救
14
+ - **Markdown 粘贴** - Obsidian 风格的 `[[链接]]` 和 `![[图片]]` 语法支持;手写 `` `代码` `` 行内代码在行首 / 行中 / 行尾均能即时识别;粘贴外部 Markdown(Obsidian / Typora)时自动检测本地相对路径图片/附件,匹配剪贴板文件上传换链,找不到时引导文件夹选择 / 拖拽补救
15
+ - **气泡菜单** - 选中文字弹出快捷格式条;「高亮 / 链接」二级面板自动避让视口边缘,下方空间不足时翻转到选区上方,滚动页面自动收起
15
16
  - **文档目录(TOC)** - 宽屏桌面侧栏 + 移动端抽屉 + 只读态悬浮球入口;滚动自动跟踪当前章节并高亮,点击目录平滑跳转,悬浮框滚到顶/底后滚轮接力滚动正文
16
17
  - **多存储后端** - 本地存储 / 阿里云 OSS / 腾讯云 COS / S3 兼容存储,配置持久化
17
18
  - **中英双语** - 运行时可切换,无需刷新页面
18
19
  - **斜杠命令** - `/` 快速插入标题、列表、图片、视频等
19
20
  - **代码块** - 30+ 语言语法高亮(lowlight)、行号列、折叠/展开、语言图标,兼容 Obsidian 逐行 div 导出格式;Mermaid 图表渲染
20
21
  - **视频播放** - [xgplayer](https://h5player.bytedance.com/)
21
- - **文件预览** - 基于 @file-viewer/react-full,支持 Office / PDF / CAD / 压缩包等 206+ 格式
22
+ - **文件预览** - 基于 @file-viewer,支持 PDF / Word / Excel / PPT / 压缩包 / 文本等格式,渲染器随包自动安装、按需懒加载(静态资源通过 `copy-assets` 命令一键准备)
22
23
  - **导出** - HTML / Markdown / JSON / 纯文本 / PDF
23
24
  - **可编辑** - readonly 模式用于纯展示场景
24
25
 
@@ -97,29 +98,45 @@ export default function Page() {
97
98
  }
98
99
  ```
99
100
 
100
- ### Peer 依赖
101
+ ### 依赖说明
101
102
 
102
- 依赖按角色分层:内部实现库(dompurify、lowlight、xgplayer、cmdk 等)声明在 `dependencies`,安装本包时自动带入;与宿主共享实例的库声明为 peerDependencies(npm 7+ 会自动安装必需项)。
103
+ 安装本包时,`dependencies` 会自动带入,**你不需要再手动安装 Tiptap 或文件预览相关的包**:
104
+
105
+ - **Tiptap 全套**(`@tiptap/core`、`@tiptap/react` 及各扩展,锁定 `^3.28.0`)——编辑器内核,已由本包统一管理版本,避免你逐个安装、版本错配。
106
+ - **文件预览全套**(`@file-viewer/react` 及 pdf / word / spreadsheet / presentation / archive / text 各渲染器,锁定 `2.2.2`)——附件在线预览能力,且全部按需懒加载,不点开附件不会下载。
107
+ - 其余内部实现库(dompurify、lowlight、xgplayer、cmdk、beautiful-mermaid 等)同样自动带入。
108
+
109
+ 你只需保证宿主已有的 **peer 依赖**:
103
110
 
104
111
  **必需**(不装无法运行):
105
112
 
106
113
  - `react` / `react-dom` `^19`
107
- - `@tiptap/*` `^3.28.0`
108
114
  - `ai` `^7`
109
115
 
110
- > 若项目已直接使用 @tiptap,请确保版本落在上述范围内,避免多份实例导致 `Adding different instances of a keyed plugin` 冲突。
111
-
112
- **可选**(`peerDependenciesMeta` 已标记 optional,不装不影响其他功能):
116
+ **可选**(已标记 optional,不装不影响其他功能):
113
117
 
114
118
  | 依赖 | 影响的功能 | 不装时的行为 |
115
119
  |---|---|---|
116
120
  | `@ai-sdk/openai` | `createAILanguageModelProvider()` 默认 provider | 调用该函数时报错并提示安装;用 `setAIProvider()` 自定义 provider 则完全不需要 |
117
- | `@file-viewer/react`、`@file-viewer/preset-office`、`@file-viewer/renderer-archive`、`@file-viewer/renderer-text` | 附件在线预览(206+ 格式) | 附件块无法预览(需同时配置 worker/wasm 资源,见下节) |
118
121
  | `devicon` | 代码块语言图标 | 图标位留空,语言选择与高亮正常 |
119
122
 
120
- ### 附件预览资源
123
+ > **想自己写 Tiptap 自定义扩展?** 本包不再把 Tiptap 暴露为 peer。高阶用户可在项目中自行安装对应版本的 `@tiptap/*`(与本包同范围 `^3.28.0`),包管理器会将其提升为同一份实例,自定义扩展即可正常注册。
124
+
125
+ ### 附件预览资源(一条命令)
126
+
127
+ 附件预览(PDF / Word / Excel / PPT / 压缩包等)运行时还需要一批 worker / wasm / 字体**静态文件**。这些不是普通 JS 模块,不会随 `npm install` 自动进入静态目录,所以请在**项目根目录**执行一次本包提供的命令:
128
+
129
+ ```bash
130
+ npx @qingwu-ui/ai-editor copy-assets
131
+ ```
132
+
133
+ 它会把所需资源从已安装的 `@file-viewer` 包中抽到 `public/file-viewer/`,与编辑器内默认配置(`FILE_VIEWER_OPTIONS`,期望 `/file-viewer/vendor/...`)对齐。部署后只要该路径可访问即可。如需改输出位置:
134
+
135
+ ```bash
136
+ npx @qingwu-ui/ai-editor copy-assets --out static/file-viewer
137
+ ```
121
138
 
122
- 附件预览(PDF / Word / Excel / 压缩包等)依赖 `@file-viewer` 的 worker / wasm 资源,需保证 `/file-viewer/vendor/...` 路径可访问(默认配置见 `FILE_VIEWER_OPTIONS`)。Vite 项目可用 `@file-viewer/vite-plugin` 的 `copyAssets: { mode: "dev", baseDir: "file-viewer" }` 自动生成;其他环境需手动将资源放置到静态目录。
139
+ > 升级本包后建议重跑一次该命令,以同步可能更新的 worker / wasm。
123
140
 
124
141
  ### 配置写作助手服务
125
142
 
@@ -0,0 +1,8 @@
1
+ import { type FC } from "react";
2
+ interface Props {
3
+ open: boolean;
4
+ onClose: () => void;
5
+ }
6
+ export declare const ReleaseNotesDialog: FC<Props>;
7
+ export {};
8
+ //# sourceMappingURL=release-notes-dialog.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"release-notes-dialog.d.ts","sourceRoot":"","sources":["../../src/components/release-notes-dialog.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,OAAO,CAAC;AAEhC,UAAU,KAAK;IACb,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAoDD,eAAO,MAAM,kBAAkB,EAAE,EAAE,CAAC,KAAK,CA8CxC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"ai-editor.d.ts","sourceRoot":"","sources":["../../src/editor/ai-editor.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAK3C,OAAO,EACL,KAAK,EAAE,EASR,MAAM,OAAO,CAAC;AAGf,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AA4JnE,MAAM,WAAW,mBAAmB;IAClC,2EAA2E;IAC3E,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC,aAAa;IACb,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAChD,qBAAqB;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qBAAqB;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qCAAqC;IACrC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,YAAY;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0BAA0B;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC5B,8BAA8B;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uDAAuD;IACvD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4DAA4D;IAC5D,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,oEAAoE;IACpE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;CAC9E;AAED,eAAO,MAAM,cAAc,EAAE,EAAE,CAAC,mBAAmB,CA+uClD,CAAC"}
1
+ {"version":3,"file":"ai-editor.d.ts","sourceRoot":"","sources":["../../src/editor/ai-editor.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAK3C,OAAO,EACL,KAAK,EAAE,EASR,MAAM,OAAO,CAAC;AAGf,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AA4JnE,MAAM,WAAW,mBAAmB;IAClC,2EAA2E;IAC3E,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC,aAAa;IACb,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAChD,qBAAqB;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qBAAqB;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qCAAqC;IACrC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,YAAY;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0BAA0B;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC5B,8BAA8B;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uDAAuD;IACvD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4DAA4D;IAC5D,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,oEAAoE;IACpE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;CAC9E;AAED,eAAO,MAAM,cAAc,EAAE,EAAE,CAAC,mBAAmB,CA2yClD,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/editor/extensions/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAwCjD,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAKvD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,2BAA2B,EAA2B,MAAM,iBAAiB,CAAC;AAEvF,OAAO,EACL,eAAe,EACf,UAAU,EACV,SAAS,EACT,2BAA2B,EAC3B,WAAW,EACX,gBAAgB,EAChB,QAAQ,EACR,aAAa,EACb,eAAe,EACf,KAAK,EACL,SAAS,EACT,WAAW,EACX,QAAQ,EACR,UAAU,GACX,CAAC;AAEF,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,+BAA+B;IAC/B,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,iDAAiD;AACjD,wBAAgB,mBAAmB,CAAC,MAAM,GAAE,sBAA2B,GAAG,YAAY,EAAE,CAsDvF"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/editor/extensions/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAwCjD,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAKvD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,2BAA2B,EAA2B,MAAM,iBAAiB,CAAC;AAEvF,OAAO,EACL,eAAe,EACf,UAAU,EACV,SAAS,EACT,2BAA2B,EAC3B,WAAW,EACX,gBAAgB,EAChB,QAAQ,EACR,aAAa,EACb,eAAe,EACf,KAAK,EACL,SAAS,EACT,WAAW,EACX,QAAQ,EACR,UAAU,GACX,CAAC;AAEF,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,+BAA+B;IAC/B,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,iDAAiD;AACjD,wBAAgB,mBAAmB,CAAC,MAAM,GAAE,sBAA2B,GAAG,YAAY,EAAE,CAuDvF"}
@@ -0,0 +1,9 @@
1
+ import { Extension } from "@tiptap/core";
2
+ /**
3
+ * 手写 `` `code` `` 行内代码:ProseMirror 自带的 codeInRule 正则带 `(?=.)` 前瞻,
4
+ * 要求闭合反引号后还有一个字符,导致在行尾(无后续字符)敲完闭合反引号不触发,
5
+ * 用户常见的「敲 `xxx` 后直接回车」场景得不到行内代码。
6
+ * 此处补一个去掉前瞻的规则:闭合反引号位于文本块结尾也能转换。
7
+ */
8
+ export declare const InlineCodeEnd: Extension<any, any>;
9
+ //# sourceMappingURL=inline-code-end.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"inline-code-end.d.ts","sourceRoot":"","sources":["../../../src/editor/extensions/inline-code-end.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAiB,MAAM,cAAc,CAAC;AAExD;;;;;GAKG;AACH,eAAO,MAAM,aAAa,qBAOxB,CAAC"}