belobog-stellar-grid 1.0.0

package/LICENSE_APACHE

@@ -0,0 +1,176 @@
+                              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

package/LICENSE_MIT

@@ -0,0 +1,25 @@
+Copyright (c) 2018 Kurisu <makise_kurisuu@outlook.jp>
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,413 @@
+<div align="center">
+
+  <h1><code>belobog-stellar-grid</code></h1>
+
+  <p><strong>🦀 现代化的 WebAssembly 表格导出库</strong></p>
+
+  <p>一个安全、高效、易用的 Rust WebAssembly 库，用于将 HTML 表格导出为 CSV 和 XLSX 文件</p>
+
+  <p>
+    <img src="https://img.shields.io/badge/version-1.0.0-blue.svg" alt="Version" />
+    <img src="https://img.shields.io/badge/rust-edition%202024-orange.svg" alt="Rust Edition" />
+    <img src="https://img.shields.io/badge/test_coverage-100%25-brightgreen.svg" alt="Test Coverage" />
+    <img src="https://img.shields.io/badge/license-MIT%2FApache--2.0-green.svg" alt="License" />
+    <a href="https://github.com/kurisu994/belobog-stellar-grid"><img src="https://img.shields.io/badge/github-belobog--stellar--grid-181717.svg?logo=github" alt="GitHub" /></a>
+  </p>
+
+<sub>Built with 🦀🕸 by <a href="https://rustwasm.github.io/">Rust and WebAssembly</a></sub>
+
+</div>
+
+---
+
+## 📋 项目简介
+
+`belobog-stellar-grid` 是一个高性能的 WebAssembly 库，让你可以轻松地在浏览器中将 HTML 表格导出为 CSV/XLSX 文件。项目采用模块化架构设计，包含完善的文件名验证、RAII 资源管理和分批异步处理机制。
+
+### 为什么选择这个库？
+
+- **🎯 零配置**：开箱即用，无需复杂的设置
+- **🚀 极致性能**：Rust 原生速度 + WebAssembly 优化
+- **🔒 企业级安全**：内置文件名验证，防止路径遍历攻击
+- **📦 轻量级**：约 117KB 的 WASM 文件（gzip 后约 40KB）
+- **✅ 100% 测试覆盖**：47 个单元测试确保代码质量
+- **🏗️ 模块化架构**：清晰的模块设计，易于维护和扩展
+- **🌍 国际化支持**：完美支持中文、日文、韩文等 Unicode 字符
+- **💾 多格式导出**：支持 CSV 和 XLSX (Excel) 两种格式
+
+### ✨ 核心特性
+
+#### 🛡️ 安全性
+
+- **RAII 资源管理**：`UrlGuard` 自动清理 Blob URL
+- **文件名安全验证**：阻止路径遍历、危险字符等 10+ 种威胁
+- **全面错误处理**：所有函数返回 `Result<T, JsValue>`
+- **内存安全保证**：得益于 Rust 的所有权系统
+- **中文错误消息**：用户友好的错误提示
+
+#### 🚀 性能优化
+
+- **零拷贝操作**：直接操作 DOM，参数使用 `&str` 引用
+- **分批异步处理**：支持百万级数据导出，避免页面卡死
+- **wee_alloc 优化**：使用轻量级分配器减小文件体积
+- **LTO 优化**：链接时优化减少最终 WASM 大小
+- **实时进度反馈**：支持大型表格的进度回调
+
+## 🚀 快速开始
+
+### 30 秒上手
+
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <script type="module">
+      import init, { export_table, ExportFormat } from "./pkg/belobog_stellar_grid.js";
+
+      // 1. 初始化（只需一次）
+      await init();
+
+      // 2. 导出为 CSV（默认）
+      document.getElementById("csv-btn").onclick = () => {
+        export_table("my-table", "数据.csv");
+      };
+
+      // 3. 导出为 Excel
+      document.getElementById("xlsx-btn").onclick = () => {
+        export_table("my-table", "数据.xlsx", ExportFormat.Xlsx);
+      };
+    </script>
+  </head>
+  <body>
+    <table id="my-table">
+      <tr>
+        <th>姓名</th>
+        <th>年龄</th>
+      </tr>
+      <tr>
+        <td>张三</td>
+        <td>25</td>
+      </tr>
+    </table>
+    <button id="csv-btn">导出 CSV</button>
+    <button id="xlsx-btn">导出 Excel</button>
+  </body>
+</html>
+```
+
+就是这么简单！ 🎉
+
+---
+
+### 📦 安装方式
+
+#### NPM 安装（推荐）
+
+```bash
+# pnpm（推荐）
+pnpm add belobog-stellar-grid
+
+# NPM
+npm install belobog-stellar-grid
+
+# Yarn
+yarn add belobog-stellar-grid
+```
+
+#### 从源码构建
+
+```bash
+git clone https://github.com/kurisu994/belobog-stellar-grid.git
+cd belobog-stellar-grid
+wasm-pack build --target web
+```
+
+---
+
+### 💻 基本用法
+
+#### 统一导出 API（推荐）
+
+```javascript
+import init, { export_table, ExportFormat } from "belobog-stellar-grid";
+
+// 初始化模块（只需执行一次）
+await init();
+
+// 导出为 CSV（默认）
+export_table("table-id");
+export_table("table-id", "销售报表_2024.csv");
+
+// 导出为 Excel
+export_table("table-id", "销售报表_2024.xlsx", ExportFormat.Xlsx);
+export_table("table-id", "销售报表_2024", ExportFormat.Xlsx); // 自动添加扩展名
+```
+
+#### 带进度条的导出
+
+```javascript
+import { export_table, ExportFormat } from "belobog-stellar-grid";
+
+// CSV 格式带进度
+export_table("large-table", "大数据.csv", ExportFormat.Csv, (progress) => {
+  console.log(`进度: ${Math.round(progress)}%`);
+  progressBar.style.width = `${progress}%`;
+});
+```
+
+#### 分批异步导出（大数据量）
+
+```javascript
+import { export_table_to_csv_batch } from "belobog-stellar-grid";
+
+// 基本用法 - 处理 10,000+ 行数据
+await export_table_to_csv_batch("huge-table", "大数据.csv");
+
+// 高级用法 - 自定义配置
+await export_table_to_csv_batch(
+  "huge-table",
+  "百万数据.csv",
+  1000, // 每批处理 1000 行
+  (progress) => {
+    console.log(`进度: ${Math.round(progress)}%`);
+  }
+);
+```
+
+#### 错误处理
+
+```javascript
+import { export_table, ExportFormat } from "belobog-stellar-grid";
+
+try {
+  export_table("table-id", "报表", ExportFormat.Xlsx);
+  alert("✅ 导出成功！");
+} catch (error) {
+  console.error("导出失败:", error);
+  alert("❌ 导出失败: " + error);
+}
+```
+
+---
+
+### 🎨 完整示例
+
+查看 [examples/](./examples/) 目录获取完整示例：
+
+| 示例                   | 难度                                                   | 描述         |
+| ---------------------- | ------------------------------------------------------ | ------------ |
+| basic-export.html      | ![简单](https://img.shields.io/badge/难度-简单-green)  | 基础导出示例 |
+| progress-export.html   | ![中等](https://img.shields.io/badge/难度-中等-yellow) | 进度显示示例 |
+| advanced-features.html | ![进阶](https://img.shields.io/badge/难度-进阶-orange) | 高级特性示例 |
+
+**运行示例**：
+
+```bash
+# 1. 构建项目
+wasm-pack build --target web
+
+# 2. 启动本地服务器
+cargo install basic-http-server
+basic-http-server .
+
+# 3. 访问 http://localhost:4000/examples/
+```
+
+---
+
+## 📚 API 参考
+
+### 核心函数
+
+#### `export_table(table_id, filename?, format?, progress_callback?)` ✅ 推荐
+
+统一的表格导出函数，支持 CSV 和 XLSX 格式。
+
+**参数**：
+
+- `table_id`: 表格元素的 ID
+- `filename`: 导出文件名（可选）
+- `format`: 导出格式（可选，默认 CSV）
+- `progress_callback`: 进度回调函数（可选）
+
+**示例**：
+
+```javascript
+import { export_table, ExportFormat } from "belobog-stellar-grid";
+
+// 最简单的用法
+export_table("my-table");
+
+// 指定文件名和格式
+export_table("my-table", "报表.xlsx", ExportFormat.Xlsx);
+
+// 带进度回调
+export_table("large-table", "大数据", ExportFormat.Csv, (progress) => {
+  console.log(`进度: ${progress.toFixed(1)}%`);
+});
+```
+
+---
+
+#### `export_table_to_csv_batch(table_id, tbody_id?, filename?, batch_size?, callback?)` 🔧 向后兼容
+
+分批异步导出函数，专为大数据量设计。
+
+**适用场景**：10,000+ 行数据
+
+**参数**：
+
+- `table_id`: 表格元素的 ID
+- `tbody_id`: 可选的数据表格体 ID
+- `filename`: 导出文件名（可选）
+- `batch_size`: 每批处理的行数（可选，默认 1000）
+- `callback`: 进度回调函数（可选）
+
+---
+
+### 文件名安全验证
+
+所有导出函数都会自动验证文件名安全性：
+
+| ✅ 允许              | ❌ 禁止          |
+| -------------------- | ---------------- |
+| `report_2024-12.csv` | `../etc/passwd`  |
+| `数据导出.csv`       | `file<name>.csv` |
+| `sales.data.csv`     | `CON.csv`        |
+| `测试-文件.xlsx`     | `.hidden`        |
+
+---
+
+## 🔧 开发指南
+
+### 环境要求
+
+| 工具      | 版本要求    |
+| --------- | ----------- |
+| Rust      | 1.82+       |
+| wasm-pack | latest      |
+| Node.js   | 16+（可选） |
+
+**安装工具**：
+
+```bash
+# 安装 Rust
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+
+# 安装 wasm-pack
+cargo install wasm-pack
+```
+
+---
+
+### 常用命令
+
+```bash
+# 构建项目
+wasm-pack build --target web
+
+# 运行测试
+cargo test
+
+# 代码检查
+cargo check
+cargo fmt
+cargo clippy
+
+# 运行示例
+basic-http-server .
+# 访问: http://localhost:4000/examples/
+```
+
+### 项目结构
+
+```
+belobog-stellar-grid/
+├── src/                    # 源代码
+│   ├── lib.rs             # 主入口
+│   ├── validation.rs      # 文件名验证
+│   ├── resource.rs        # RAII 资源管理
+│   ├── core/              # 核心导出模块组
+│   │   ├── mod.rs         # 统一 API 和协调
+│   │   ├── table_extractor.rs  # 表格数据提取
+│   │   ├── export_csv.rs  # CSV 导出
+│   │   └── export_xlsx.rs # XLSX 导出
+│   ├── batch_export.rs    # 异步分批导出
+│   └── utils.rs           # 调试工具
+├── tests/                 # 测试目录（47 个测试）
+│   ├── lib_tests.rs       # 基础功能测试（35 个）
+│   ├── test_resource.rs   # RAII 资源测试（8 个）
+│   └── test_unified_api.rs # 统一 API 测试（4 个）
+├── examples/              # 示例目录
+├── pkg/                   # WASM 包输出
+└── README.md             # 项目文档
+```
+
+---
+
+## 🚀 性能指标
+
+### 运行时性能
+
+| 数据量       | 同步导出     | 分批异步导出  | 页面响应性       |
+| ------------ | ------------ | ------------- | ---------------- |
+| 1,000 行     | <10ms        | <10ms         | 无明显差异       |
+| 10,000 行    | ~1s（卡顿）  | ~1.2s（流畅） | **大幅改善**     |
+| 100,000 行   | ~10s（卡死） | ~12s（流畅）  | **从卡死到可用** |
+| 1,000,000 行 | 崩溃         | ~120s（流畅） | **完全解决**     |
+
+### 文件大小
+
+- WASM 原始大小：约 117KB（优化后）
+- Gzip 压缩后：约 40KB
+- Brotli 压缩后：约 35KB
+
+---
+
+## 🤝 社区与支持
+
+### 获取帮助
+
+1. 📖 查看文档和示例
+2. 🔍 搜索 [Issues](https://github.com/kurisu994/belobog-stellar-grid/issues)
+3. 💬 加入 [讨论区](https://github.com/kurisu994/belobog-stellar-grid/discussions)
+4. 🐛 报告 [Bug](https://github.com/kurisu994/belobog-stellar-grid/issues/new)
+
+### 贡献方式
+
+我们欢迎各种形式的贡献：
+
+- 🐛 报告 Bug
+- 💡 提出新功能
+- 📖 改进文档
+- 🔧 提交代码
+- ⭐ Star 项目
+
+**代码规范**：
+
+- 遵循 Rust 编码规范（`cargo fmt`）
+- 通过 Clippy 检查（`cargo clippy`）
+- 为新功能添加测试
+
+---
+
+## 📄 许可证
+
+本项目采用双重许可证：
+
+- **[MIT License](LICENSE-MIT)** - 简单宽松
+- **[Apache License 2.0](LICENSE-APACHE)** - 更多法律保护
+
+---
+
+## 🙏 致谢
+
+感谢以下项目和社区：
+
+- [Rust](https://www.rust-lang.org/) - 强大的系统编程语言
+- [WebAssembly](https://webassembly.org/) - 革命性的 Web 技术
+- [wasm-bindgen](https://github.com/rustwasm/wasm-bindgen) - Rust 与 JS 的桥梁
+- [csv](https://github.com/BurntSushi/rust-csv) - 优秀的 CSV 处理库
+- 所有贡献者和使用者 ❤️
+
+---