@agilehub/docx-converter 0.0.0-stage → 0.1.1

package/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# 开发与模块维护
+
+本项目同时交付 npm 库和浏览器示例，使用一个 package.json 和锁文件管理依赖。阅读 [架构说明](docs/architecture.md) 后再新增跨模块依赖。
+
+## 功能改在哪里
+
+| 变更 | 主要位置 | 验证重点 |
+| --- | --- | --- |
+| 对外选项 / 返回字段 | src/contracts/conversion.ts、src/index.ts | 类型兼容、默认值、README 使用示例 |
+| 转换阶段 / 资源限制 | src/application | 错误码、取消、阶段事件、限制生效 |
+| ZIP / 包关系 / XML | src/infrastructure | 越界关系、损坏输入、解压限制、XML 约束 |
+| 段落 / 表格 / 绘图 | src/modules/document | 最小 OOXML fixture 和最终 HTML 结构 |
+| 字体 / 样式 / 编号 | src/modules/styles、numbering | 继承优先级、明确 false、续号及嵌套 |
+| OMML 公式 | src/modules/math | MathML、LaTeX、未知结构降级诊断 |
+| 图片格式 / 地址 | src/modules/images | 字节识别、异步策略、取消、URL 校验 |
+| HTML / CSS / 图表注 | src/rendering/html | 手写模型单测及转换集成测试 |
+| Node 文件入口 | src/adapters/node | 文件大小预检查及公共 API 行为 |
+| 页面交互 / Worker | apps/playground | 任务替换、取消、错误展示、导出与浏览器回归 |
+
+不要直接给模块增加文件系统、DOM 或网络副作用；先确认是否属于 Node 适配器、应用 UI 或显式图片回调。渲染层新增所需数据时，应由解析层写入模型或通过最小端口提供，不能反向读取解析器。
+
+## 日常检查
+
+```sh
+npm ci
+npm run dev
+npm run check                 # 架构 + 库/页面/Worker/工具类型 + Vitest
+npm run build                 # ESM/CJS/UMD、声明文件、演示应用
+npm run test:e2e              # 对构建产物执行浏览器验证
+npm run verify               # 合并以上检查，适合作为 CI 入口
+npm pack                     # 自动构建后生成本地可安装 tarball
+```
+
+首次运行浏览器测试前执行 `npx playwright install chromium`，或把 `DOCX_TEST_BROWSER` 设置为本地 Chrome/Edge 可执行文件绝对路径。测试服务器监听 4173；开发服务器默认 5173。CI 环境会启动新的测试服务器，不复用已有进程。
+
+Windows 受限环境可以在项目内创建 `.tmp` 并设置 `TEMP`、`TMP` 后运行 Vitest。测试截图、下载文件、依赖、构建产物和 tarball 已加入 .gitignore。不要把 Java 参考项目中的实际文档提交为公共样例。
+
+## 修改与交付约定
+
+1. 明确功能所属模块；跨层变更先更新架构约束和文档，不能仅为消除检查错误放开规则。
+2. 用 `tests/fixtures/docx.ts` 构造可分发的最小复现；转换能力放 integration，端口/生命周期放 unit，浏览器交互放 e2e。测试面向行为和故障边界，不绑定私有方法。
+3. 新增能力同时覆盖正常路径、缺失或不支持内容的诊断；修改异步逻辑时覆盖取消或旧结果覆盖。
+4. 公共 API 的兼容性以 `src/index.ts`、`src/node.ts` 为准。内部路径不承诺兼容，不增加面向消费者的深层导出。
+5. 提交前运行 `npm run verify`；涉及包入口时额外在独立目录安装 tarball，检查 ESM、CommonJS 和 NodeNext 类型解析。预打包检查不替代完整验收。
+6. 更新 README 的支持范围与示例。版本按公共 API 的影响决定；只有获得明确发布授权后再执行 npm publish。
+
+当前仓库不绑定远程 CI 平台；接入 CI 时使用 Node 24、`npm ci`、安装 Playwright 浏览器后运行 `npm run verify` 即可复用本地检查。

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 [yyyy] [name of copyright owner]
+
+   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.