@senlinz/import-export 0.1.1 → 1.0.0

package/dist/types/ExcelDefinition.d.ts

@@ -4,7 +4,7 @@
 type ExcelColumnDataType = "text" | "number" | "date" | "image";
 /**
  * Runtime support:
- * - Browser ESM environments with `Blob`, `FileReader`, `atob`, and `URL.createObjectURL`.
+ * - Browser ESM environments with `Blob`, `FileReader`, `fetch`, and `URL.createObjectURL`.
  * - Node.js can use `fromExcel`, `toExcel`, and `generateExcelTemplate` when compatible browser globals are available.
  *
  * Known limitations:
@@ -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. */
@@ -104,6 +108,8 @@ interface DynamicExcelImportOptions {
     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. */

package/dist/types/index.d.ts

@@ -1,19 +1,7 @@
 export type * from './ExcelDefinition';
-export type { InitializeWasmOptions } from './runtime.js';
 import { ExcelDefinition } from './ExcelDefinition';
 import type { DynamicExcelImportOptions, DynamicExcelImportResult } from './ExcelDefinition';
-import { importExcel, importExcelDynamic, exportExcel, downloadExcelTemplate, fromExcel, fromExcelDynamic, toExcel, generateExcelTemplate } 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;
-};
+import { testUtils } from './utils.js';
 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>;
@@ -22,4 +10,4 @@ declare function _fromExcelDynamic(buffer: Uint8Array, options?: DynamicExcelImp
 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, _importExcelDynamic as importExcelDynamic, _exportExcel as exportExcel, _fromExcel as fromExcel, _fromExcelDynamic as fromExcelDynamic, _toExcel as toExcel, _downloadExcelTemplate as downloadExcelTemplate, _generateExcelTemplate as generateExcelTemplate, };
+export { _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,4 +1,24 @@
-import { ExcelDefinition, DynamicExcelImportOptions, DynamicExcelImportResult } 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>>;
@@ -8,4 +28,4 @@ declare function download(data: Uint8Array | string, name: string, type?: string
 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, importExcelDynamic, exportExcel, downloadExcelTemplate, _fromExcel as fromExcel, _fromExcelDynamic as fromExcelDynamic, _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,10 +1,11 @@
 {
   "name": "@senlinz/import-export",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "description": "import/export excel core",
   "files": [
     "dist/**/*.js",
     "dist/**/*.d.ts",
+    "dist/**/*.wasm",
     "README.md",
     "README.zh.md"
   ],
@@ -24,10 +25,10 @@
     "@rollup/plugin-typescript": "^12.1.2",
     "@types/jest": "^29.5.6",
     "@types/node": "^16.18.108",
+    "fflate": "^0.8.2",
     "jest": "^29.7.0",
     "jest-cli": "^29.7.0",
-    "rollup": "^4.39.0",
-    "rollup-plugin-terser": "^7.0.2",
+    "rollup": "^4.60.2",
     "tslib": "^2.8.1",
     "typescript": "^5.8.2"
   },
@@ -38,8 +39,7 @@
     "url": "git+https://github.com/gui-xie/import-export.git"
   },
   "dependencies": {
-    "fflate": "^0.8.2",
-    "@senlinz/import-export-wasm": "0.1.1"
+    "@senlinz/import-export-wasm": "1.0.0"
   },
   "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 ."
   }

package/dist/types/runtime.d.ts

@@ -1,20 +0,0 @@
-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, };