@senlinz/import-export 0.1.0 → 0.1.2

package/README.md

@@ -15,7 +15,7 @@ pnpm add @senlinz/import-export
 ### Default mode (recommended)
 
 - No setup required.
-- `importExcel`, `exportExcel`, `fromExcel`, `toExcel`, `downloadExcelTemplate`, and `generateExcelTemplate` automatically initialize the bundled WASM runtime.
+- `importExcel`, `importExcelDynamic`, `exportExcel`, `fromExcel`, `fromExcelDynamic`, `toExcel`, `downloadExcelTemplate`, and `generateExcelTemplate` automatically initialize the bundled WASM runtime.
 - Best for most browser applications.
 
 ### Advanced mode
@@ -51,12 +51,51 @@ 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
+
+Use `importExcelDynamic(options?)` when you want to open the browser file picker without defining `columns` ahead of time.
+
+```ts
+import { importExcelDynamic } from '@senlinz/import-export';
+
+const result = await importExcelDynamic({
+  sheetName: 'sheet1',
+  headerRow: 1,
+});
+
+console.log(result.headers);
+console.log(result.rows);
+```
+
+Use `fromExcelDynamic(buffer, options?)` when you want to read caller-provided workbook bytes without defining `columns` ahead of time.
+
+```ts
+import { fromExcelDynamic } from '@senlinz/import-export';
+
+const result = await fromExcelDynamic(fileBytes, {
+  sheetName: 'sheet1',
+  headerRow: 1,
+});
+
+console.log(result.headers);
+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.
 
 ### Stable column fields
 
@@ -114,12 +153,15 @@ 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
 
 - `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`.
 
@@ -138,8 +180,9 @@ These advanced features are supported and considered part of the public API:
 ## Browser/runtime support
 
 - Browser ESM runtimes are the primary target.
-- `downloadExcelTemplate`, `exportExcel`, and `importExcel` require DOM/browser APIs.
+- `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`.
 
 ## Examples

package/README.zh.md

@@ -15,7 +15,7 @@ pnpm add @senlinz/import-export
 ### 默认模式（推荐）
 
 - 无需额外初始化。
-- `importExcel`、`exportExcel`、`fromExcel`、`toExcel`、`downloadExcelTemplate`、`generateExcelTemplate` 会自动初始化内置 WASM 运行时。
+- `importExcel`、`importExcelDynamic`、`exportExcel`、`fromExcel`、`fromExcelDynamic`、`toExcel`、`downloadExcelTemplate`、`generateExcelTemplate` 会自动初始化内置 WASM 运行时。
 - 适合绝大多数浏览器场景。
 
 ### 高级模式
@@ -51,12 +51,14 @@ const workbook = await toExcel({
 - `columns`：表头、校验和行映射使用的稳定列定义
 - `author`：可选的工作簿作者元数据
 - `createTime`：可选的工作簿创建时间，支持 `Date` 或日期字符串
+- `maxFileSizeBytes`：浏览器上传的字节大小上限（默认 25 MiB），在读取前先校验
 - `title`、`titleHeight`、`titleFormat`：可选的合并标题行及其高度、样式
 - `defaultRowHeight`、`headerRowHeight`：导出时数据行和表头行的行高
 - `dx`、`dy`：表头写入前的横向、纵向偏移量
 - `isHeaderFreeze`：冻结表头区域，滚动时仍保持列标题可见
 - `progressCallback`：长时间导入 / 导出过程中的进度回调
 - `imageFetcher`：导出 `image` 列时必需的图片数据解析回调
+- `escapeFormulas`：导出时自动转义类似公式的文本，默认开启，可显式关闭以允许公式
 
 ### 稳定的列字段
 
@@ -107,6 +109,36 @@ await exportExcel(definition, [
 const rows = await importExcel(definition);
 ```
 
+## 动态导入
+
+当你不想预先定义 `columns`，并希望直接使用浏览器文件选择框时，可使用 `importExcelDynamic(options?)`。
+
+```ts
+import { importExcelDynamic } from '@senlinz/import-export';
+
+const result = await importExcelDynamic({
+  sheetName: 'sheet1',
+  headerRow: 1,
+});
+```
+
+当你已经拿到工作簿字节数据时，可继续使用 `fromExcelDynamic(buffer, options?)`。
+
+```ts
+import { fromExcelDynamic } from '@senlinz/import-export';
+
+const result = await fromExcelDynamic(fileBytes, {
+  sheetName: 'sheet1',
+  headerRow: 1,
+});
+```
+
+- `importExcelDynamic(...)` 依赖 DOM / 浏览器文件上传 API。
+- `sheetName` 可选，未提供或不存在时会回退到第一个工作表。
+- `headerRow` 可选，使用从 `1` 开始的行号，默认会自动选择首个非空行。
+- `maxFileSizeBytes` 可选，与 schema 导入相同，默认 25 MiB。
+- 返回值结构为 `{ sheetName, headers, rows }`。
+
 ## 导入行为
 
 - 表头必须与 `columns[].name` 完全一致。
@@ -114,12 +146,15 @@ const rows = await importExcel(definition);
 - 空的 `number` / `date` 单元格导入后返回 `null`。
 - `date` 列导入后返回格式化字符串。
 - 非法或不完整的 schema 会在读取工作簿前立即失败。
+- 浏览器上传会在读取前按 `maxFileSizeBytes` 校验文件大小（默认 25 MiB）。
+- 无 schema 导入时，可使用 `importExcelDynamic(...)`（浏览器上传）或 `fromExcelDynamic(...)`（字节缓冲）。
 
 ## 导出行为
 
 - `null` 和 `undefined` 会导出为空单元格。
 - 数字列会拒绝非有限值。
 - 日期列支持 `Date` 实例或日期字符串。
+- 文本列默认会转义看起来像公式的值；如需导出公式，可设置 `escapeFormulas: false`。
 - 分组导出对象必须使用 `{ value?, children: [...] }` 结构。
 - 图片列必须提供 `imageFetcher`。
 
@@ -138,8 +173,8 @@ const rows = await importExcel(definition);
 ## 浏览器 / 运行时支持
 
 - 主要面向浏览器 ESM 运行时。
-- `downloadExcelTemplate`、`exportExcel`、`importExcel` 依赖 DOM / 浏览器 API。
-- 当运行时提供兼容的浏览器全局对象时，也可以使用 `fromExcel`、`toExcel`、`generateExcelTemplate`。
+- `downloadExcelTemplate`、`exportExcel`、`importExcel`、`importExcelDynamic` 依赖 DOM / 浏览器 API。
+- 当运行时提供兼容的浏览器全局对象时，也可以使用 `fromExcel`、`fromExcelDynamic`、`toExcel`、`generateExcelTemplate`。
 - `initializeWasm` 可用于使用调用方提供的 `source`、`bytes` 或 `module` 预初始化运行时。
 
 ## 示例