@4399ywkf/editor 0.1.0

package/README.md

@@ -0,0 +1,114 @@
+# @4399ywkf/editor
+
+4399 多格式文档编辑器。一个包覆盖 **doc / sheet / pdf**，引擎按需下载。
+
+```bash
+pnpm add @4399ywkf/editor
+```
+
+```tsx
+import { DocumentView, detectFormat } from "@4399ywkf/editor"
+import "@4399ywkf/editor/styles"
+
+<DocumentView format={detectFormat("年度报告.docx")} content={html} />
+```
+
+## 格式与能力
+
+| 格式 | 引擎 | 编辑 | AI 可操作 | 协同 | 依赖 |
+|---|---|---|---|---|---|
+| **doc**（含云文档） | tiptap | ✅ | ✅ | ✅ | 内置 |
+| **sheet** | Univer OSS 核心 | ✅ | ✅ | ✕ | 可选 peer `@univerjs/presets` |
+| **pdf** | pdf.js | ✕ 只读 | ✕ | ✕ | 可选 peer `pdfjs-dist` |
+| **pptx** | — | — | — | — | 需宿主自行注册（见下） |
+
+云文档与本地 doc 是**同一套 tiptap**，不做区分。
+
+## 为什么引擎是懒加载的
+
+主入口只有 **3KB**（格式路由），tiptap 的 698KB 在独立 chunk 里，Univer / pdf.js 是可选 peer。
+`import "@4399ywkf/editor"` 不会把任何引擎拉进你的主包 —— 只有真的渲染到某种格式时才下载。
+
+Univer sheets 核心 gzip 后 871KB；无条件打进主包会直接毁掉阅读侧首屏。
+
+## 子路径
+
+```ts
+import { NotionEditor, ArticleViewer } from "@4399ywkf/editor/doc"
+import { ImportDocx, ExportDocx } from "@4399ywkf/editor/docx"
+import { SheetView } from "@4399ywkf/editor/sheet"
+import { PdfView } from "@4399ywkf/editor/pdf"
+import "@4399ywkf/editor/styles"
+```
+
+## docx 导入导出
+
+API 形态对齐 `@tiptap-pro/extension-import-docx` / `-export-docx`，但**在本地解析**，
+文档不出内网，不需要 `token` / `endpoint`。
+
+```tsx
+import { ImportDocx, ExportDocx } from "@4399ywkf/editor/docx"
+
+new Editor({ extensions: [StarterKit, ImportDocx, ExportDocx] })
+
+editor.chain().importDocx({ file, onImport(ctx) { ctx.setEditorContent(ctx.content) } }).run()
+editor.chain().exportDocx({ onCompleteExport: (blob) => save(blob) }).run()
+```
+
+相对官方能力矩阵的增量 —— 这几项官方明确标 ✕：
+
+| | 官方 | 本包 |
+|---|---|---|
+| 域（SEQ / TOC / PAGE） | ✕ 只留静态文字 | ✅ 保代码 + 缓存值，可往返 |
+| 墨迹手写 | ✕ | ✅ 保矢量 XML + 位图回退 |
+| 浮动 / 环绕定位 | ~ | ✅ `wrapNone` 绝对定位、不占布局 |
+| 样式定义里的字符格式 | ✅ | ✅ 含 `w:basedOn` 继承链 |
+| 文档不出内网 | ✕ | ✅ |
+
+已知缺口：`fldChar` 复杂域、修订痕迹、页眉页脚 / 脚注、超链接导出未建外部关系。
+
+## 注册自有格式
+
+pptx 刻意不内置 —— Univer Slides 官方标注「请勿用于生产环境」，开源世界没有第二个
+可用的前端 pptx 引擎；真要做只有 OnlyOffice / Collabora 那一档（AGPL，需法务口径）。
+与其假装支持，不如把口子留给宿主：
+
+```ts
+import { registerFormat } from "@4399ywkf/editor"
+
+registerFormat({
+  format: "pptx",
+  label: "演示文稿",
+  extensions: [".ppt", ".pptx"],
+  capabilities: {
+    editable: false, aiOperable: false, collaborative: false,
+    importExtensions: [], exportFormats: [],
+  },
+  load: () => import("./MyOnlyOfficeSlideView"),
+})
+```
+
+## 样式
+
+必须显式引入一次：
+
+```ts
+import "@4399ywkf/editor/styles"   // dist/style.css，168KB
+```
+
+包内 55 个 scss 在构建期编译并拼成单文件，JS 产物里**不残留任何 scss 导入** ——
+消费方无需配置 sass loader，SSR 也不会因为 `import "x.scss"` 报错。
+
+## 协同
+
+`doc` 走 yjs。注入扩展时注意：**所有客户端必须注入同一组扩展**，
+schema 不一致时一端产生的节点到另一端会被 y-prosemirror 当非法内容静默丢弃。
+
+## 开发
+
+```bash
+pnpm install
+pnpm build        # tsup + 样式编译
+pnpm test         # 38 个用例
+pnpm typecheck
+```

package/dist/DocView-5KS7B4DA.js

@@ -0,0 +1,18 @@
+import { EditorConfigProvider, NotionEditor } from './chunk-G6WM2PSU.js';
+import { jsx } from 'react/jsx-runtime';
+
+function DocView({ content, readOnly, room, className, onReady }) {
+  return /* @__PURE__ */ jsx("div", { className, children: /* @__PURE__ */ jsx(EditorConfigProvider, { config: {}, children: /* @__PURE__ */ jsx(
+    NotionEditor,
+    {
+      room: room ?? "default",
+      content,
+      readOnly,
+      onEditorReady: (editor) => onReady?.(editor)
+    }
+  ) }) });
+}
+
+export { DocView as default };
+//# sourceMappingURL=DocView-5KS7B4DA.js.map
+//# sourceMappingURL=DocView-5KS7B4DA.js.map

package/dist/DocView-5KS7B4DA.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/views/DocView.tsx"],"names":[],"mappings":";;;AAMe,SAAR,QAAyB,EAAE,OAAA,EAAS,UAAU,IAAA,EAAM,SAAA,EAAW,SAAQ,EAAsB;AAClG,EAAA,2BACG,KAAA,EAAA,EAAI,SAAA,EACH,8BAAC,oBAAA,EAAA,EAAqB,MAAA,EAAQ,EAAC,EAC7B,QAAA,kBAAA,GAAA;AAAA,IAAC,YAAA;AAAA,IAAA;AAAA,MACC,MAAM,IAAA,IAAQ,SAAA;AAAA,MACd,OAAA;AAAA,MACA,QAAA;AAAA,MACA,aAAA,EAAe,CAAC,MAAA,KAAmB,OAAA,GAAU,MAAM;AAAA;AAAA,KAEvD,CAAA,EACF,CAAA;AAEJ","file":"DocView-5KS7B4DA.js","sourcesContent":["import type { Editor } from \"@tiptap/react\"\nimport { EditorConfigProvider } from \"../contexts/editor-config-context\"\nimport { NotionEditor } from \"../components/tiptap-templates/notion-like/notion-like-editor\"\nimport type { DocumentViewProps } from \"../registry\"\n\n/** doc 通道：云文档与本地 doc 是同一套 tiptap，不做区分 */\nexport default function DocView({ content, readOnly, room, className, onReady }: DocumentViewProps) {\n  return (\n    <div className={className}>\n      <EditorConfigProvider config={{}}>\n        <NotionEditor\n          room={room ?? \"default\"}\n          content={content as string}\n          readOnly={readOnly}\n          onEditorReady={(editor: Editor) => onReady?.(editor)}\n        />\n      </EditorConfigProvider>\n    </div>\n  )\n}\n"]}

package/dist/PdfView-JDCHTG7Y.js

@@ -0,0 +1,3 @@
+export { PdfView as default } from './chunk-IRALXCLP.js';
+//# sourceMappingURL=PdfView-JDCHTG7Y.js.map
+//# sourceMappingURL=PdfView-JDCHTG7Y.js.map

package/dist/PdfView-JDCHTG7Y.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"PdfView-JDCHTG7Y.js"}

package/dist/SheetView-2EID6B2I.js

@@ -0,0 +1,3 @@
+export { SheetView as default } from './chunk-RJUDOUEZ.js';
+//# sourceMappingURL=SheetView-2EID6B2I.js.map
+//# sourceMappingURL=SheetView-2EID6B2I.js.map

package/dist/SheetView-2EID6B2I.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"SheetView-2EID6B2I.js"}