@senlinz/import-export 0.1.0 → 0.1.2

package/dist/types/ExcelDefinition.d.ts

@@ -8,7 +8,7 @@ type ExcelColumnDataType = "text" | "number" | "date" | "image";
  * - 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.
+ * - Schema-based 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`.
  */
@@ -29,6 +29,8 @@ interface ExcelDefinition {
     titleHeight?: number;
     /** Format applied to the optional merged title row. */
     titleFormat?: ExcelCellFormatDefinition;
+    /** Maximum upload size (in bytes) enforced for browser-based imports. Defaults to 25 MiB when omitted. */
+    maxFileSizeBytes?: number;
     /** Default height used for data rows when exporting a worksheet. */
     defaultRowHeight?: number;
     /** Height applied to header rows during template/export generation. */
@@ -46,6 +48,8 @@ interface ExcelDefinition {
      * The callback must resolve to image bytes for the provided URL or identifier.
      */
     imageFetcher?: (url: string) => Promise<Uint8Array>;
+    /** Escapes text cells that look like formulas to prevent Excel formula injection. Enabled by default. */
+    escapeFormulas?: boolean;
 }
 interface ExcelColumnDefinition {
     /** Stable programmatic key used to map row objects. Must be unique within a definition. */
@@ -99,4 +103,20 @@ interface ExcelCellFormatDefinition {
     dateFormat?: string;
     borderColor?: string;
 }
-export { ExcelDefinition, ExcelColumnDefinition, ExcelCellFormatDefinition, ExcelColumnDataType };
+interface DynamicExcelImportOptions {
+    /** Preferred worksheet name. Falls back to the first sheet when omitted or missing. */
+    sheetName?: string;
+    /** 1-based worksheet row number to use as the header row. Defaults to the first non-empty row. */
+    headerRow?: number;
+    /** Maximum upload size (in bytes) enforced for browser-based dynamic imports. Defaults to 25 MiB when omitted. */
+    maxFileSizeBytes?: number;
+}
+interface DynamicExcelImportResult {
+    /** Actual worksheet name that was imported. */
+    sheetName: string;
+    /** Header labels read from the worksheet in left-to-right order. */
+    headers: string[];
+    /** Row data keyed by the imported header labels. */
+    rows: Record<string, string>[];
+}
+export { ExcelDefinition, ExcelColumnDefinition, ExcelCellFormatDefinition, ExcelColumnDataType, DynamicExcelImportOptions, DynamicExcelImportResult };

package/dist/types/index.d.ts

@@ -1,20 +1,25 @@
 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 type { DynamicExcelImportOptions, DynamicExcelImportResult } from './ExcelDefinition';
+import { importExcel, importExcelDynamic, exportExcel, downloadExcelTemplate, fromExcel, fromExcelDynamic, toExcel, generateExcelTemplate, testUtils } from './utils.js';
 import { bundledWasmSource, initializeWasm } from './runtime.js';
 declare function getUtils(): {
     importExcel: typeof importExcel;
+    importExcelDynamic: typeof importExcelDynamic;
     exportExcel: typeof exportExcel;
     downloadExcelTemplate: typeof downloadExcelTemplate;
     fromExcel: typeof fromExcel;
+    fromExcelDynamic: typeof fromExcelDynamic;
     toExcel: typeof toExcel;
     generateExcelTemplate: typeof generateExcelTemplate;
 };
 declare function _importExcel<T>(definition: ExcelDefinition): Promise<T[]>;
+declare function _importExcelDynamic(options?: DynamicExcelImportOptions): Promise<DynamicExcelImportResult>;
 declare function _exportExcel<T>(definition: ExcelDefinition, data: T[]): Promise<void>;
 declare function _fromExcel<T>(definition: ExcelDefinition, buffer: Uint8Array): Promise<T[]>;
+declare function _fromExcelDynamic(buffer: Uint8Array, options?: DynamicExcelImportOptions): Promise<DynamicExcelImportResult>;
 declare function _toExcel<T>(definition: ExcelDefinition, data: T[]): Promise<Uint8Array>;
 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, };
+export { bundledWasmSource, getUtils, initializeWasm, _importExcel as importExcel, _importExcelDynamic as importExcelDynamic, _exportExcel as exportExcel, _fromExcel as fromExcel, _fromExcelDynamic as fromExcelDynamic, _toExcel as toExcel, _downloadExcelTemplate as downloadExcelTemplate, _generateExcelTemplate as generateExcelTemplate, testUtils, };

package/dist/types/utils.d.ts

@@ -1,9 +1,31 @@
-import { ExcelDefinition } from './ExcelDefinition';
+import { ExcelColumnDefinition, ExcelDefinition, DynamicExcelImportOptions, DynamicExcelImportResult } from './ExcelDefinition';
+declare const SUPPORTED_DATA_TYPES: readonly ["text", "number", "date", "image"];
+type NormalizedDataType = typeof SUPPORTED_DATA_TYPES[number];
+type NormalizedExcelColumnDefinition = Omit<ExcelColumnDefinition, 'dataType'> & {
+    dataType?: NormalizedDataType;
+};
+type NormalizedExcelDefinition = Omit<ExcelDefinition, 'columns'> & {
+    columns: NormalizedExcelColumnDefinition[];
+    maxFileSizeBytes: number;
+    escapeFormulas: boolean;
+};
+type NormalizedDynamicImportOptions = DynamicExcelImportOptions & {
+    maxFileSizeBytes: number;
+};
+type TestingUtils = {
+    normalizeDefinition(definition: ExcelDefinition): NormalizedExcelDefinition;
+    normalizeDynamicImportOptions(options?: DynamicExcelImportOptions): NormalizedDynamicImportOptions;
+    sanitizeTextCellValue(value: string, escapeFormulas?: boolean): string;
+    defaultMaxFileSizeBytes: number;
+};
+declare const testUtils: TestingUtils;
 declare function _fromExcel<T>(definition: ExcelDefinition, buffer: Uint8Array): Promise<T[]>;
+declare function _fromExcelDynamic(buffer: Uint8Array, options?: DynamicExcelImportOptions): Promise<DynamicExcelImportResult>;
 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>(definition: ExcelDefinition): Promise<T[]>;
+declare function importExcelDynamic(options?: DynamicExcelImportOptions): Promise<DynamicExcelImportResult>;
 declare function exportExcel<T>(definition: ExcelDefinition, data: T[]): Promise<void>;
-export { importExcel, exportExcel, downloadExcelTemplate, _fromExcel as fromExcel, _toExcel as toExcel, generateExcelTemplate, download };
+export { importExcel, importExcelDynamic, exportExcel, downloadExcelTemplate, _fromExcel as fromExcel, _fromExcelDynamic as fromExcelDynamic, _toExcel as toExcel, generateExcelTemplate, download, testUtils };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@senlinz/import-export",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "import/export excel core",
   "files": [
     "dist/**/*.js",
@@ -39,7 +39,7 @@
   },
   "dependencies": {
     "fflate": "^0.8.2",
-    "@senlinz/import-export-wasm": "0.1.0"
+    "@senlinz/import-export-wasm": "0.1.2"
   },
   "keywords": [
     "rust",
@@ -57,6 +57,7 @@
   "scripts": {
     "build": "rollup -c",
     "dev": "rollup -c -w",
+    "test:unit": "npm run build && node --experimental-vm-modules ./node_modules/jest/bin/jest.js --config jest.config.mjs --runInBand",
     "test": "playwright test -c playwright.config.ts",
     "e2e-serve": "serve -l 8080 ."
   }