@senlinz/import-export 0.1.1 → 1.0.0

package/README.md

@@ -10,29 +10,14 @@ High-level browser API for Excel template generation, export, and import.
 pnpm add @senlinz/import-export
 ```
 
-## Choose your mode
+## WASM loading
 
-### Default mode (recommended)
-
-- No setup required.
-- `importExcel`, `importExcelDynamic`, `exportExcel`, `fromExcel`, `fromExcelDynamic`, `toExcel`, `downloadExcelTemplate`, and `generateExcelTemplate` automatically initialize the bundled WASM runtime.
-- Best for most browser applications.
-
-### Advanced mode
-
-- Call `initializeWasm(...)` yourself before using the Excel APIs.
-- Use this when you want custom WASM hosting, bundler control, or to reuse bytes/modules that you loaded elsewhere.
-- Supported manual inputs: `source`, `bytes`, or `module`.
-- `bundledWasmSource` is also exported for self-contained demos/tests that still want explicit manual initialization.
+- `importExcel`, `importExcelDynamic`, `exportExcel`, `fromExcel`, `fromExcelDynamic`, `toExcel`, `downloadExcelTemplate`, and `generateExcelTemplate` auto-load and initialize the bundled WASM asset on first use.
+- In Vite and other browser ESM bundlers, no manual `initializeWasm(...)` call or `?url` import is required when using the high-level core package.
+- If you need to manage the WASM module yourself, use `@senlinz/import-export-wasm` directly instead of this package.
 
 ```ts
-import { initializeWasm, toExcel } from '@senlinz/import-export';
-
-const wasmBytes = new Uint8Array(
-  await (await fetch('/assets/imexport_wasm_bg.wasm')).arrayBuffer()
-);
-
-initializeWasm({ bytes: wasmBytes });
+import { toExcel } from '@senlinz/import-export';
 
 const workbook = await toExcel({
   name: 'TomAndJerry',
@@ -40,8 +25,6 @@ const workbook = await toExcel({
 }, [{ name: 'Tom' }]);
 ```
 
-If you provide invalid manual input, `initializeWasm(...)` throws a clear error immediately.
-
 ## Supported API
 
 ### Stable definition fields
@@ -51,12 +34,14 @@ If you provide invalid manual input, `initializeWasm(...)` throws a clear error
 - `columns` - stable schema for headers, validation, and row mapping
 - `author` - optional workbook author metadata
 - `createTime` - optional workbook creation time as a `Date` or date string
+- `maxFileSizeBytes` - browser upload limit in bytes (default 25 MiB) enforced before reading a file
 - `title`, `titleHeight`, `titleFormat` - optional merged title row and its layout/format
 - `defaultRowHeight`, `headerRowHeight` - row heights for exported data rows and header rows
 - `dx`, `dy` - horizontal and vertical offsets before the header starts
 - `isHeaderFreeze` - freezes the header area so column labels stay visible while scrolling
 - `progressCallback` - progress hook for long-running import/export work
 - `imageFetcher` - required resolver for `image` columns during export
+- `escapeFormulas` - escapes formula-like text during export to block Excel formula injection (default: enabled)
 
 ### Schema-less import
 
@@ -91,6 +76,7 @@ console.log(result.rows);
 - `importExcelDynamic(...)` depends on DOM/browser file upload APIs.
 - `sheetName` is optional and falls back to the first worksheet when missing.
 - `headerRow` is optional, 1-based, and defaults to the first non-empty row in the selected sheet.
+- `maxFileSizeBytes` is optional and uses the same default 25 MiB browser upload limit as schema-based import.
 - The result shape is `{ sheetName, headers, rows }`.
 - Dynamic import requires non-empty, unique header names in the selected header row.
 
@@ -150,6 +136,7 @@ const rows = await importExcel(definition);
 - Empty imported `number` and `date` cells are returned as `null`.
 - Imported `date` values are returned as formatted strings.
 - Unknown or malformed schemas fail fast before any workbook operation starts.
+- Browser uploads enforce `maxFileSizeBytes` before reading the file (default 25 MiB).
 - Use `importExcelDynamic(...)` for browser uploads without a schema, or `fromExcelDynamic(...)` when you already have workbook bytes.
 
 ## Export behavior
@@ -157,6 +144,7 @@ const rows = await importExcel(definition);
 - `null` and `undefined` values are exported as blank cells.
 - Number columns reject non-finite values.
 - Date columns accept `Date` instances or parseable date strings.
+- Text columns escape values that look like formulas by default; set `escapeFormulas: false` to allow formulas intentionally.
 - Grouped export objects must use `{ value?, children: [...] }` for configured `dataGroup` columns.
 - Image columns require `imageFetcher`.
 
@@ -178,12 +166,11 @@ These advanced features are supported and considered part of the public API:
 - `downloadExcelTemplate`, `exportExcel`, `importExcel`, and `importExcelDynamic` require DOM/browser APIs.
 - `fromExcel`, `toExcel`, and `generateExcelTemplate` can be used in other runtimes when browser-compatible globals are available.
 - `fromExcelDynamic` can also be used in other runtimes when browser-compatible globals are available.
-- `initializeWasm` can be used to pre-initialize the runtime with caller-managed `source`, `bytes`, or `module`.
+- The core package initializes its emitted bundled WASM asset asynchronously before the first workbook operation.
 
 ## Examples
 
 - [Basic browser example](./examples/basic-browser.html)
-- [Manual WASM browser example](./examples/manual-wasm-browser.html)
 - [Grouped export example](./examples/grouped-export.html)
 - [Definition validation example](./examples/definition-errors.html)
 

package/README.zh.md

@@ -10,29 +10,14 @@
 pnpm add @senlinz/import-export
 ```
 
-## 选择使用模式
+## WASM 加载
 
-### 默认模式（推荐）
-
-- 无需额外初始化。
-- `importExcel`、`importExcelDynamic`、`exportExcel`、`fromExcel`、`fromExcelDynamic`、`toExcel`、`downloadExcelTemplate`、`generateExcelTemplate` 会自动初始化内置 WASM 运行时。
-- 适合绝大多数浏览器场景。
-
-### 高级模式
-
-- 在使用这些 Excel API 之前，先手动调用 `initializeWasm(...)`。
-- 适用于自定义 WASM 托管、需要自己控制 bundler 行为，或希望复用已加载 bytes / module 的场景。
-- 支持的手动输入：`source`、`bytes`、`module`。
-- 同时也导出了 `bundledWasmSource`，方便在自包含 demo / 测试中显式走手动初始化流程。
+- `importExcel`、`importExcelDynamic`、`exportExcel`、`fromExcel`、`fromExcelDynamic`、`toExcel`、`downloadExcelTemplate`、`generateExcelTemplate` 会在首次调用时自动加载并初始化内置 WASM 资源。
+- 在 Vite 和其他浏览器 ESM bundler 中，使用高阶 core 包时不再需要手动调用 `initializeWasm(...)` 或自己处理 `?url`。
+- 如果你需要自行管理 WASM 模块，请直接使用 `@senlinz/import-export-wasm`，而不是这个高阶包。
 
 ```ts
-import { initializeWasm, toExcel } from '@senlinz/import-export';
-
-const wasmBytes = new Uint8Array(
-  await (await fetch('/assets/imexport_wasm_bg.wasm')).arrayBuffer()
-);
-
-initializeWasm({ bytes: wasmBytes });
+import { toExcel } from '@senlinz/import-export';
 
 const workbook = await toExcel({
   name: 'TomAndJerry',
@@ -40,8 +25,6 @@ const workbook = await toExcel({
 }, [{ name: 'Tom' }]);
 ```
 
-如果手动传入的 WASM 输入无效，`initializeWasm(...)` 会立即抛出清晰的错误信息。
-
 ## 支持的 API
 
 ### 稳定的 definition 字段
@@ -51,12 +34,14 @@ const workbook = await toExcel({
 - `columns`：表头、校验和行映射使用的稳定列定义
 - `author`：可选的工作簿作者元数据
 - `createTime`：可选的工作簿创建时间，支持 `Date` 或日期字符串
+- `maxFileSizeBytes`：浏览器上传的字节大小上限（默认 25 MiB），在读取前先校验
 - `title`、`titleHeight`、`titleFormat`：可选的合并标题行及其高度、样式
 - `defaultRowHeight`、`headerRowHeight`：导出时数据行和表头行的行高
 - `dx`、`dy`：表头写入前的横向、纵向偏移量
 - `isHeaderFreeze`：冻结表头区域，滚动时仍保持列标题可见
 - `progressCallback`：长时间导入 / 导出过程中的进度回调
 - `imageFetcher`：导出 `image` 列时必需的图片数据解析回调
+- `escapeFormulas`：导出时自动转义类似公式的文本，默认开启，可显式关闭以允许公式
 
 ### 稳定的列字段
 
@@ -134,6 +119,7 @@ const result = await fromExcelDynamic(fileBytes, {
 - `importExcelDynamic(...)` 依赖 DOM / 浏览器文件上传 API。
 - `sheetName` 可选，未提供或不存在时会回退到第一个工作表。
 - `headerRow` 可选，使用从 `1` 开始的行号，默认会自动选择首个非空行。
+- `maxFileSizeBytes` 可选，与 schema 导入相同，默认 25 MiB。
 - 返回值结构为 `{ sheetName, headers, rows }`。
 
 ## 导入行为
@@ -143,6 +129,7 @@ const result = await fromExcelDynamic(fileBytes, {
 - 空的 `number` / `date` 单元格导入后返回 `null`。
 - `date` 列导入后返回格式化字符串。
 - 非法或不完整的 schema 会在读取工作簿前立即失败。
+- 浏览器上传会在读取前按 `maxFileSizeBytes` 校验文件大小（默认 25 MiB）。
 - 无 schema 导入时，可使用 `importExcelDynamic(...)`（浏览器上传）或 `fromExcelDynamic(...)`（字节缓冲）。
 
 ## 导出行为
@@ -150,6 +137,7 @@ const result = await fromExcelDynamic(fileBytes, {
 - `null` 和 `undefined` 会导出为空单元格。
 - 数字列会拒绝非有限值。
 - 日期列支持 `Date` 实例或日期字符串。
+- 文本列默认会转义看起来像公式的值；如需导出公式，可设置 `escapeFormulas: false`。
 - 分组导出对象必须使用 `{ value?, children: [...] }` 结构。
 - 图片列必须提供 `imageFetcher`。
 
@@ -170,12 +158,11 @@ const result = await fromExcelDynamic(fileBytes, {
 - 主要面向浏览器 ESM 运行时。
 - `downloadExcelTemplate`、`exportExcel`、`importExcel`、`importExcelDynamic` 依赖 DOM / 浏览器 API。
 - 当运行时提供兼容的浏览器全局对象时，也可以使用 `fromExcel`、`fromExcelDynamic`、`toExcel`、`generateExcelTemplate`。
-- `initializeWasm` 可用于使用调用方提供的 `source`、`bytes` 或 `module` 预初始化运行时。
+- core 包会在首次执行工作簿操作前，异步初始化构建产物中的内置 WASM 资源。
 
 ## 示例
 
 - [基础浏览器示例](./examples/basic-browser.html)
-- [手动初始化 WASM 的浏览器示例](./examples/manual-wasm-browser.html)
 - [分组导出示例](./examples/grouped-export.html)
 - [Definition 校验示例](./examples/definition-errors.html)