@apollo-design/docx-preview 0.6.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2016-2023 Volodymyr Baydalka
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,6 @@
+@apollo-design/docx-preview
+Copyright apollocmh
+
+This product includes software developed by Volodymyr Baydalka
+(docxjs, https://github.com/VolodymyrBaydalka/docxjs),
+licensed under the Apache License 2.0.

package/README.md

@@ -0,0 +1,155 @@
+# @apollo-design/docx-preview
+
+将 DOCX 文档渲染为保留语义的 HTML，并附带一个可 iframe 嵌入的独立预览器。
+
+> Based on [docxjs](https://github.com/VolodymyrBaydalka/docxjs) by Volodymyr Baydalka (Apache License 2.0) — see [Credits](#credits).
+
+## 目标
+
+尽可能保持 HTML 语义地把 DOCX 渲染/转换为 HTML。库的能力受 HTML 本身限制（例如 Google Docs 是把文档绘制成 canvas 图像）。在此之上，本项目的重点是**公文级版式保真**：字体分 script 级联解析、按行重排分页、页眉页脚页码字段、浮动表格置底、Word 2003 兼容两端对齐等。
+
+## 三个使用入口
+
+### 1. npm 包（Vite / Vue / React 等工程）
+
+```bash
+pnpm add @apollo-design/docx-preview
+```
+
+```ts
+import { renderAsync } from '@apollo-design/docx-preview';
+
+await renderAsync(docData, document.getElementById('container'));
+```
+
+也支持传统 script 标签方式（UMD 产物通过全局 `docx` 暴露，jszip 需自行引入为全局 `JSZip`）：
+
+```html
+<script src="https://unpkg.com/jszip/dist/jszip.min.js"></script>
+<script src="node_modules/@apollo-design/docx-preview/dist/docx-preview.min.js"></script>
+<script>
+    docx.renderAsync(docData, document.getElementById("container"));
+</script>
+```
+
+### 2. 在线预览器（GitHub Pages）
+
+```
+https://apollocmh.github.io/docx-preview/
+```
+
+通过 URL 参数加载文档：
+
+```
+https://apollocmh.github.io/docx-preview/?file=https://example.com/test.docx
+```
+
+### 3. 独立预览器（自行部署）
+
+从 [GitHub Releases](https://github.com/apollocmh/docx-preview/releases) 下载：
+
+```
+docx-preview-viewer-{version}.zip
+```
+
+解压后部署到任意静态服务器即可——不依赖 npm、不需要构建工具、无第三方 CDN，通过 iframe 或浏览器直接使用：
+
+```html
+<iframe src="/viewer.html?file=https://example.com/document.docx"></iframe>
+<!-- 可选初始缩放: 适应宽度(默认) / 自然尺寸百分比 -->
+<iframe src="/viewer.html?file=...&scale=fit | 75 | 0.75"></iframe>
+<!-- 可选初始缩略图侧栏: 显示(默认) / 隐藏 -->
+<iframe src="/viewer.html?file=...&thumbs=1 | 0"></iframe>
+<!-- 可选显式文档名(下载文件名 + 标题),用于媒体库等不透明地址 -->
+<iframe src="/viewer.html?file=...&filename=report.docx"></iframe>
+```
+
+**CORS 注意**：预览器在浏览器内通过 `fetch` 加载 DOCX URL，文件服务器必须允许跨域请求（`Access-Control-Allow-Origin`），或把预览器与文件放在同一来源下。
+
+旧式二进制文档（老 `.doc`，以及 `.wps`——即便新版 WPS Office 默认仍保存为 OLE2 二进制）会被预先识别并给出"另存为 .docx"的明确提示；只有 OOXML 包可以渲染。
+
+预览器会把文档重排为真实分页。字体按三级解析：.docx 内嵌字体 → viewer.html 旁的 `fonts.json` 清单 → 系统字体。清单是注入为 `@font-face` 的 webfont 定义数组：
+
+```json
+[
+  { "name": "SimSun", "src": "url(fonts/simsun.woff2) format(\"woff2\")" },
+  { "name": "宋体", "src": "url(fonts/simsun.woff2) format(\"woff2\")" }
+]
+```
+
+注意 `name` 必须与文档内部使用的字体族名一致（中文文档常直接引用中文族名，如 `宋体`/`黑体`），别名需列为单独条目。`fonts.json` 缺失或无效时静默忽略。
+
+## API
+
+```ts
+// 渲染文档到指定元素
+renderAsync(
+    document: Blob | ArrayBuffer | Uint8Array, // JSZip.loadAsync 支持的任意类型
+    bodyContainer: HTMLElement, // 渲染文档内容的元素
+    styleContainer: HTMLElement, // 渲染样式/编号/字体的元素,为 null 时用 bodyContainer
+    options: {
+        className: string = "docx", // 默认样式与文档样式类的类名/前缀
+        inWrapper: boolean = true, // 在文档内容外渲染 wrapper
+        hideWrapperOnPrint: boolean = false, // 打印时禁用 wrapper 样式
+        ignoreWidth: boolean = false, // 禁用页面宽度渲染
+        ignoreHeight: boolean = false, // 禁用页面高度渲染
+        ignoreFonts: boolean = false, // 禁用字体渲染
+        breakPages: boolean = true, // 在分页符处分页
+        paginate: boolean = false, // 渲染后把内容重排进页面尺寸的 section(表格按行、段落按行拆分);测量前会等待 webfont 就绪
+        fonts: [{ name: string, src: string, weight?: string|number, style?: string }], // 渲染前注入为 @font-face 的外部 webfont
+        ignoreLastRenderedPageBreak: boolean = true, // 禁用 lastRenderedPageBreak 元素分页
+        experimental: boolean = false, // 启用实验特性(制表位计算)
+        trimXmlDeclaration: boolean = true, // 解析前移除 xml 声明
+        useBase64URL: boolean = false, // 图片/字体等转为 base64 URL,否则用 URL.createObjectURL
+        renderChanges: false, // 实验性渲染文档修订(插入/删除)
+        renderHeaders: true, // 渲染页眉
+        renderFooters: true, // 渲染页脚
+        renderFootnotes: true, // 渲染脚注
+        renderEndnotes: true, // 渲染尾注
+        renderComments: false, // 实验性渲染批注
+        renderAltChunks: true, // 渲染 altChunks(html 部件)
+        debug: boolean = false, // 额外日志
+        h: ({ ns, tagName, className, style, children, ...props } | Node | string): Node, // 实验性 HTML 渲染钩子,默认实现见 defaultOptions.h
+    }): Promise<WordDocument>
+
+defaultOptions: Options; // 默认选项
+
+/// ==== 实验性 / 内部 API ====
+// 可用于渲染前修改文档;renderAsync = parseAsync + renderDocument
+
+// 解析文档,返回内部文档对象
+parseAsync(
+    document: Blob | ArrayBuffer | Uint8Array,
+    options: Options
+): Promise<WordDocument>
+
+// 渲染内部文档对象,返回节点列表
+renderDocument(
+    wordDocument: WordDocument,
+    options: Options
+): Promise<Node[]>
+```
+
+## 分页说明
+
+库在以下情况分页：
+
+- 用户手动插入分页符 `<w:br w:type="page"/>`
+- 编辑器应用（如 MS Word）插入的 `<w:lastRenderedPageBreak/>`（需把 `ignoreLastRenderedPageBreak` 设为 `false`）
+- 段落页面设置变化（如纵向改横向）
+
+`paginate: true` 则在渲染后按真实版式重排分页（预览器默认启用）。
+
+## 稳定性
+
+只有 **renderAsync** 是稳定 API，定义不会变更。解析与渲染的内部实现随时可能调整。
+
+## Credits
+
+This project is a heavily modified fork of [docxjs](https://github.com/VolodymyrBaydalka/docxjs) by **Volodymyr Baydalka**, licensed under the Apache License 2.0. Thanks to the original author for the excellent foundation.
+
+Subsequent development (pagination engine, per-script font cascade, floating-table anchoring, and the standalone viewer) by **apollocmh**.
+
+## License
+
+[Apache License 2.0](LICENSE) — 原始出处声明见 [NOTICE](NOTICE)。