@senlinz/import-export 0.1.0-beta.22 → 0.1.0-beta.24

package/dist/types/ExcelDefinition.d.ts

@@ -1,34 +1,86 @@
+/**
+ * Stable scalar cell types supported by the public API.
+ */
+type ExcelColumnDataType = "text" | "number" | "date" | "image";
+/**
+ * Runtime support:
+ * - Browser ESM environments with `Blob`, `FileReader`, `atob`, and `URL.createObjectURL`.
+ * - Node.js can use `fromExcel`, `toExcel`, and `generateExcelTemplate` when compatible browser globals are available.
+ *
+ * Known limitations:
+ * - Import validates headers strictly against `columns[].name` order and position.
+ * - Grouped export expects parent columns and data groups to be declared before children.
+ * - Image export requires `imageFetcher`.
+ */
 interface ExcelDefinition {
+    /** File name used for template/export downloads. */
     name: string;
+    /** Worksheet name used for export and preferred during import. */
     sheetName?: string;
+    /** Stable schema definition for worksheet columns. */
     columns: ExcelColumnDefinition[];
+    /** Optional workbook author metadata written into generated files. */
     author?: string;
+    /** Workbook creation time accepted as a `Date` or ISO-like string. */
     createTime?: Date | string;
+    /** Optional merged title row rendered above the header. */
     title?: string;
+    /** Height of the optional merged title row in worksheet units. */
     titleHeight?: number;
+    /** Format applied to the optional merged title row. */
     titleFormat?: ExcelCellFormatDefinition;
+    /** Default height used for data rows when exporting a worksheet. */
     defaultRowHeight?: number;
+    /** Height applied to header rows during template/export generation. */
     headerRowHeight?: number;
+    /** Horizontal column offset before writing the header. */
     dx?: number;
+    /** Vertical row offset before writing the header. */
     dy?: number;
+    /** Freezes the header area so column labels remain visible while scrolling. */
     isHeaderFreeze?: boolean;
+    /** Optional progress callback receiving values from `0` to `100` during long-running work. */
     progressCallback?: (progress: number) => void;
+    /**
+     * Required when any exported column uses `dataType: "image"`.
+     * The callback must resolve to image bytes for the provided URL or identifier.
+     */
     imageFetcher?: (url: string) => Promise<Uint8Array>;
 }
 interface ExcelColumnDefinition {
+    /** Stable programmatic key used to map row objects. Must be unique within a definition. */
     key: string;
+    /** Visible worksheet header label. */
     name: string;
+    /** Column width used for template/export rendering. */
     width?: number;
+    /** Excel note/comment attached to the header cell. */
     note?: string;
-    dataType?: "string" | "number" | "date" | "image";
+    /**
+     * Supported values:
+     * - `text`
+     * - `number`
+     * - `date`
+     * - `image`
+     */
+    dataType?: ExcelColumnDataType;
+    /** Drop-down allowed values used for template validation and import expectations. */
     allowedValues?: string[];
+    /** Parent header key for multi-row headers. Parent columns must be declared first. */
     parent?: string;
+    /** Header background color in a CSS-like hex string such as `#RRGGBB`. */
     backgroundColor?: string;
+    /** Header text color in a CSS-like hex string such as `#RRGGBB`. */
     color?: string;
+    /** Whether the header text should be rendered bold. */
     bold?: boolean;
+    /** Base format applied to cells in this column. */
     format?: ExcelCellFormatDefinition;
+    /** Conditional or direct format overrides applied to exported cell values. */
     valueFormat?: ExcelCellFormatDefinition[] | ExcelCellFormatDefinition;
+    /** Optional logical group identifier for nested export data. */
     dataGroup?: string;
+    /** Optional parent group identifier. Referenced groups must be declared first. */
     dataGroupParent?: string;
 }
 interface ExcelCellFormatDefinition {
@@ -43,7 +95,8 @@ interface ExcelCellFormatDefinition {
     backgroundColor?: string;
     align?: 'left' | 'center' | 'right';
     alignVertical?: 'top' | 'center' | 'bottom';
+    /** Excel-compatible number format string used for date display. */
     dateFormat?: string;
     borderColor?: string;
 }
-export { ExcelDefinition, ExcelColumnDefinition, ExcelCellFormatDefinition };
+export { ExcelDefinition, ExcelColumnDefinition, ExcelCellFormatDefinition, ExcelColumnDataType };

package/dist/types/index.d.ts

@@ -1,6 +1,8 @@
 export type * from './ExcelDefinition';
+export type { InitializeWasmOptions } from './runtime.js';
 import { ExcelDefinition } from './ExcelDefinition';
 import { importExcel, exportExcel, downloadExcelTemplate, fromExcel, toExcel, generateExcelTemplate } from './utils.js';
+import { bundledWasmSource, initializeWasm } from './runtime.js';
 declare function getUtils(): {
     importExcel: typeof importExcel;
     exportExcel: typeof exportExcel;
@@ -9,9 +11,10 @@ declare function getUtils(): {
     toExcel: typeof toExcel;
     generateExcelTemplate: typeof generateExcelTemplate;
 };
-declare function _importExcel<T>(defintion: ExcelDefinition): Promise<T[]>;
-declare function _exportExcel<T>(defintion: ExcelDefinition, data: T[]): Promise<void>;
+declare function _importExcel<T>(definition: ExcelDefinition): Promise<T[]>;
+declare function _exportExcel<T>(definition: ExcelDefinition, data: T[]): Promise<void>;
 declare function _fromExcel<T>(definition: ExcelDefinition, buffer: Uint8Array): Promise<T[]>;
 declare function _toExcel<T>(definition: ExcelDefinition, data: T[]): Promise<Uint8Array>;
-declare function _downloadExcelTemplate(defintion: ExcelDefinition): Promise<void>;
-export { getUtils, _importExcel as importExcel, _exportExcel as exportExcel, _fromExcel as fromExcel, _toExcel as toExcel, _downloadExcelTemplate as downloadExcelTemplate };
+declare function _downloadExcelTemplate(definition: ExcelDefinition): Promise<void>;
+declare function _generateExcelTemplate(definition: ExcelDefinition): Promise<Uint8Array>;
+export { bundledWasmSource, getUtils, initializeWasm, _importExcel as importExcel, _exportExcel as exportExcel, _fromExcel as fromExcel, _toExcel as toExcel, _downloadExcelTemplate as downloadExcelTemplate, _generateExcelTemplate as generateExcelTemplate, };

package/dist/types/runtime.d.ts

@@ -0,0 +1,20 @@
+type WasmInitializationInputKind = 'source' | 'bytes' | 'module';
+interface InitializeWasmOptions {
+    /**
+     * Gzipped base64-encoded WASM source text.
+     */
+    source?: string;
+    /**
+     * Raw WebAssembly bytes loaded by the caller.
+     */
+    bytes?: BufferSource;
+    /**
+     * A precompiled WebAssembly module loaded by the caller.
+     */
+    module?: WebAssembly.Module;
+}
+declare const bundledWasmSource: string;
+declare function ensureWasmInitialized(): void;
+declare function initializeWasm(options?: InitializeWasmOptions): void;
+export { bundledWasmSource, ensureWasmInitialized, initializeWasm, };
+export type { InitializeWasmOptions, WasmInitializationInputKind, };

package/dist/types/utils.d.ts

@@ -1,10 +1,9 @@
 import { ExcelDefinition } from './ExcelDefinition';
-declare function initializeWasm(): void;
 declare function _fromExcel<T>(definition: ExcelDefinition, buffer: Uint8Array): Promise<T[]>;
-declare function _toExcel<T>(definition: ExcelDefinition, data: T[]): Promise<any>;
+declare function _toExcel<T>(definition: ExcelDefinition, data: T[]): Promise<Uint8Array<ArrayBufferLike>>;
 declare function generateExcelTemplate(definition: ExcelDefinition): Promise<Uint8Array<ArrayBufferLike>>;
 declare function downloadExcelTemplate(definition: ExcelDefinition): Promise<void>;
 declare function download(data: Uint8Array | string, name: string, type?: string): void;
-declare function importExcel<T>(defintion: ExcelDefinition): Promise<T[]>;
+declare function importExcel<T>(definition: ExcelDefinition): Promise<T[]>;
 declare function exportExcel<T>(definition: ExcelDefinition, data: T[]): Promise<void>;
-export { importExcel, exportExcel, downloadExcelTemplate, _fromExcel as fromExcel, _toExcel as toExcel, generateExcelTemplate, initializeWasm, download };
+export { importExcel, exportExcel, downloadExcelTemplate, _fromExcel as fromExcel, _toExcel as toExcel, generateExcelTemplate, download };

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@senlinz/import-export",
-  "version": "0.1.0-beta.22",
+  "version": "0.1.0-beta.24",
   "description": "import/export excel core",
   "files": [
     "dist/**/*.js",
     "dist/**/*.d.ts",
-    "README.md"
+    "README.md",
+    "README.zh.md"
   ],
   "type": "module",
   "module": "dist/index.js",
@@ -38,7 +39,7 @@
   },
   "dependencies": {
     "fflate": "^0.8.2",
-    "@senlinz/import-export-wasm": "0.1.0-beta.22"
+    "@senlinz/import-export-wasm": "0.1.0-beta.24"
   },
   "keywords": [
     "rust",
@@ -56,7 +57,7 @@
   "scripts": {
     "build": "rollup -c",
     "dev": "rollup -c -w",
-    "test": "jest",
-    "e2e-serve": "serve dist"
+    "test": "playwright test -c playwright.config.ts",
+    "e2e-serve": "serve -l 8080 ."
   }
 }