@ticatec/batch-data-uploader 0.0.2 → 0.0.4

package/README.md

@@ -29,10 +29,10 @@ npm i @ticatec/batch-data-uploader
 Extend `BaseTemplate`, provide field definitions and upload logic, and optionally override `consolidateData` to process data.
 
 ```ts
-import BaseTemplate from '$lib/BaseTemplate';
-import type DataColumn from './DataColumn';
+import BaseUploadTemplate from '@ticatec/batch-data-uploader/BaseUploadTemplate';
+import type DataColumn from '@ticatec/batch-data-uploader/DataColumn';
 
-class MyDataTemplate extends BaseTemplate {
+class MyDataTemplate extends BaseUploadTemplate {
   constructor(uploadFun: UploadFun) {
     const columns: DataColumn[] = [
       { text: 'Name', field: 'name', pos: 0 },

package/dist/BaseLoadTemplate.d.ts

@@ -0,0 +1,18 @@
+import BaseTemplate from "./BaseTemplate";
+import type DataColumn from "./DataColumn";
+export type DataFetcher = (rows: Array<any>) => Promise<Array<any>>;
+export type CheckMatch = (o1: any, o2: any) => boolean;
+/**
+ * 用于前台数据和服务器端的数据整合
+ */
+export default abstract class BaseLoadTemplate extends BaseTemplate {
+    protected fetcher: DataFetcher;
+    protected isMatch: CheckMatch;
+    protected constructor(columns: Array<DataColumn>, fetcher: DataFetcher, checkMatch: CheckMatch, rowOffset?: number);
+    /**
+     * 从服务器抓取数据，然后根据主键进行数据合并
+     * @param rows
+     * @protected
+     */
+    protected consolidateData(rows: Array<any>): Promise<Array<any>>;
+}

package/dist/BaseLoadTemplate.js

@@ -0,0 +1,25 @@
+import BaseTemplate from "./BaseTemplate";
+/**
+ * 用于前台数据和服务器端的数据整合
+ */
+export default class BaseLoadTemplate extends BaseTemplate {
+    fetcher;
+    isMatch;
+    constructor(columns, fetcher, checkMatch, rowOffset = 1) {
+        super(columns, rowOffset);
+        this.fetcher = fetcher;
+        this.isMatch = checkMatch;
+    }
+    /**
+     * 从服务器抓取数据，然后根据主键进行数据合并
+     * @param rows
+     * @protected
+     */
+    async consolidateData(rows) {
+        let data = await this.fetcher?.(rows);
+        return rows.map(row => {
+            let item = data.find(el => this.isMatch(row, el));
+            return [...row, ...item];
+        });
+    }
+}

package/dist/BaseTemplate.d.ts

@@ -1,28 +1,16 @@
 import type DataColumn from "./DataColumn";
 import type { DataColumn as TableColumn } from "@ticatec/uniface-element/DataTable";
-export type UploadFun = (arr: Array<any>) => Promise<void>;
-export type UpdateProgressStatus = () => void;
 export default abstract class BaseTemplate {
     protected readonly _columns: Array<DataColumn>;
     protected readonly rowOffset: number;
     protected _list: Array<any>;
-    protected uploadFun: UploadFun;
-    protected batchSize: number;
-    protected updateProgressStatus: UpdateProgressStatus | null;
     /**
      *
      * @param columns
-     * @param uploadFun
-     * @param batchSize
      * @param rowOffset
      * @protected
      */
-    protected constructor(columns: Array<DataColumn>, uploadFun: UploadFun, batchSize?: number, rowOffset?: number);
-    /**
-     * 状态更新的监听器
-     * @param value
-     */
-    setProgressStatusListener(value: UpdateProgressStatus): void;
+    protected constructor(columns: Array<DataColumn>, rowOffset?: number);
     /**
      * 整理数据，在子类可以通过重载完成数据的二次处理
      * @param rows
@@ -35,9 +23,11 @@ export default abstract class BaseTemplate {
      */
     parseExcelFile(file: File): Promise<void>;
     /**
-     * 上传数据
+     * 包裹数据
+     * @param data
+     * @protected
      */
-    upload(): Promise<void>;
+    protected wrapData(data: any): any;
     /**
      * 获取表格的列定义
      */
@@ -46,9 +36,4 @@ export default abstract class BaseTemplate {
      * 获取数据
      */
     get list(): Array<any>;
-    /**
-     * 导出处理异常的数据
-     * @param filename
-     */
-    exportErrorRowsToExcel(filename: string): void;
 }

package/dist/BaseTemplate.js

@@ -1,55 +1,18 @@
 import * as XLSX from 'xlsx';
 import utils from "./utils";
-import { getI18nText } from "@ticatec/i18n";
-import i18nKeys from "./i18n_resources/i18nKeys";
-const statusColumn = {
-    text: "status",
-    width: 150,
-    resizable: true,
-    formatter: row => {
-        if (row.status == 'P') {
-            return getI18nText(i18nKeys.status.pending);
-        }
-        else if (row.status == 'U') {
-            return getI18nText(i18nKeys.status.uploading);
-        }
-        else {
-            if (row.error) {
-                return row.errorText;
-            }
-            else {
-                return getI18nText(i18nKeys.status.successful);
-            }
-        }
-    }
-};
 export default class BaseTemplate {
     _columns;
     rowOffset;
     _list = [];
-    uploadFun;
-    batchSize;
-    updateProgressStatus = null;
     /**
      *
      * @param columns
-     * @param uploadFun
-     * @param batchSize
      * @param rowOffset
      * @protected
      */
-    constructor(columns, uploadFun, batchSize = 50, rowOffset = 1) {
+    constructor(columns, rowOffset = 1) {
         this._columns = columns;
         this.rowOffset = rowOffset;
-        this.uploadFun = uploadFun;
-        this.batchSize = batchSize;
-    }
-    /**
-     * 状态更新的监听器
-     * @param value
-     */
-    setProgressStatusListener(value) {
-        this.updateProgressStatus = value;
     }
     /**
      * 整理数据，在子类可以通过重载完成数据的二次处理
@@ -69,7 +32,7 @@ export default class BaseTemplate {
         const sheet = workbook.Sheets[workbook.SheetNames[0]];
         const range = XLSX.utils.decode_range(sheet['!ref'] || ''); // 获取范围
         const rows = [];
-        for (let rowIndex = range.s.r + 1 + this.rowOffset; rowIndex <= range.e.r; rowIndex++) {
+        for (let rowIndex = range.s.r + this.rowOffset; rowIndex <= range.e.r; rowIndex++) {
             const rowObject = {};
             for (const colDef of this._columns) {
                 const cellAddress = { r: rowIndex, c: colDef.pos };
@@ -79,29 +42,23 @@ export default class BaseTemplate {
                 const formattedValue = colDef.parser ? colDef.parser(rawValue) : rawValue;
                 utils.setNestedValue(rowObject, colDef.field, formattedValue);
             }
-            rows.push({ data: rowObject, status: 'P' });
+            rows.push(this.wrapData(rowObject));
         }
         this._list = await this.consolidateData(rows);
     }
     /**
-     * 上传数据
+     * 包裹数据
+     * @param data
+     * @protected
      */
-    async upload() {
-        for (let i = 0; i < this.list.length; i += this.batchSize) {
-            const chunk = this.list.slice(i, i + this.batchSize);
-            chunk.forEach(item => item.status = 'U');
-            this.updateProgressStatus?.();
-            await this.uploadFun(chunk);
-            chunk.forEach(item => item.status = 'D');
-            this.updateProgressStatus?.();
-        }
+    wrapData(data) {
+        return data;
     }
     /**
      * 获取表格的列定义
      */
     get columns() {
-        let columns = this._columns.map(col => ({ ...col, field: `data.${col.field}` }));
-        return [...columns, statusColumn];
+        return this._columns.map(col => ({ ...col }));
     }
     /**
      * 获取数据
@@ -109,41 +66,4 @@ export default class BaseTemplate {
     get list() {
         return [...this._list];
     }
-    /**
-     * 导出处理异常的数据
-     * @param filename
-     */
-    exportErrorRowsToExcel(filename) {
-        // 筛选出有错误的行
-        const errorRows = this._list.filter(row => row.error != null);
-        // 生成 Excel 数据（第一行为标题）
-        const header = [...this._columns.map(col => col.text), getI18nText(i18nKeys.errorTitle)];
-        const data = errorRows.map(row => {
-            const values = this._columns.map(col => {
-                return utils.getNestedValue(row.data, col.field);
-            });
-            return [...values, row.error];
-        });
-        const worksheetData = [header, ...data];
-        const worksheet = XLSX.utils.aoa_to_sheet(worksheetData);
-        const workbook = XLSX.utils.book_new();
-        XLSX.utils.book_append_sheet(workbook, worksheet, getI18nText(i18nKeys.sheetName));
-        const wbout = XLSX.write(workbook, {
-            bookType: 'xlsx',
-            type: 'array'
-        });
-        // 创建 Blob 并触发下载
-        const blob = new Blob([wbout], {
-            type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
-        });
-        const url = URL.createObjectURL(blob);
-        const a = document.createElement('a');
-        a.href = url;
-        a.download = filename;
-        a.style.display = 'none';
-        document.body.appendChild(a);
-        a.click();
-        document.body.removeChild(a);
-        URL.revokeObjectURL(url);
-    }
 }

package/dist/BaseUploadTemplate.d.ts

@@ -0,0 +1,35 @@
+import BaseTemplate from "./BaseTemplate";
+import type { DataColumn as TableColumn } from "@ticatec/uniface-element/DataTable";
+import type DataColumn from "./DataColumn";
+export type UploadFun = (arr: Array<any>) => Promise<void>;
+export type UpdateProgressStatus = () => void;
+export default abstract class BaseUploadTemplate extends BaseTemplate {
+    protected uploadFun: UploadFun;
+    protected batchSize: number;
+    protected updateProgressStatus: UpdateProgressStatus | null;
+    protected constructor(columns: Array<DataColumn>, uploadFun: UploadFun, batchSize?: number, rowOffset?: number);
+    /**
+     * 状态更新的监听器
+     * @param value
+     */
+    setProgressStatusListener(value: UpdateProgressStatus): void;
+    /**
+     * 上传数据
+     */
+    upload(): Promise<void>;
+    /**
+     * 将数据包裹着一个对象里面
+     * @param data
+     * @protected
+     */
+    protected wrapData(data: any): any;
+    /**
+     * 获取表格的列定义
+     */
+    get columns(): Array<TableColumn>;
+    /**
+     * 导出处理异常的数据
+     * @param filename
+     */
+    exportErrorRowsToExcel(filename: string): void;
+}

package/dist/BaseUploadTemplate.js

@@ -0,0 +1,108 @@
+import BaseTemplate from "./BaseTemplate";
+import { getI18nText } from "@ticatec/i18n";
+import i18nKeys from "./i18n_resources/i18nKeys";
+import utils from "./utils";
+import * as XLSX from 'xlsx';
+const statusColumn = {
+    text: "status",
+    width: 150,
+    resizable: true,
+    formatter: row => {
+        if (row.status == 'P') {
+            return getI18nText(i18nKeys.status.pending);
+        }
+        else if (row.status == 'U') {
+            return getI18nText(i18nKeys.status.uploading);
+        }
+        else {
+            if (row.error) {
+                return row.errorText;
+            }
+            else {
+                return getI18nText(i18nKeys.status.successful);
+            }
+        }
+    }
+};
+export default class BaseUploadTemplate extends BaseTemplate {
+    uploadFun;
+    batchSize;
+    updateProgressStatus = null;
+    constructor(columns, uploadFun, batchSize = 50, rowOffset = 1) {
+        super(columns, rowOffset);
+        ;
+        this.uploadFun = uploadFun;
+        this.batchSize = batchSize;
+    }
+    /**
+     * 状态更新的监听器
+     * @param value
+     */
+    setProgressStatusListener(value) {
+        this.updateProgressStatus = value;
+    }
+    /**
+     * 上传数据
+     */
+    async upload() {
+        for (let i = 0; i < this.list.length; i += this.batchSize) {
+            const chunk = this.list.slice(i, i + this.batchSize);
+            chunk.forEach(item => item.status = 'U');
+            this.updateProgressStatus?.();
+            await this.uploadFun(chunk);
+            chunk.forEach(item => item.status = 'D');
+            this.updateProgressStatus?.();
+        }
+    }
+    /**
+     * 将数据包裹着一个对象里面
+     * @param data
+     * @protected
+     */
+    wrapData(data) {
+        return { data, status: 'P' };
+    }
+    /**
+     * 获取表格的列定义
+     */
+    get columns() {
+        return [...this._columns.map(col => ({ ...col, field: `data.${col.field}` })), statusColumn];
+    }
+    /**
+     * 导出处理异常的数据
+     * @param filename
+     */
+    exportErrorRowsToExcel(filename) {
+        // 筛选出有错误的行
+        const errorRows = this._list.filter(row => row.error != null);
+        // 生成 Excel 数据（第一行为标题）
+        const header = [...this._columns.map(col => col.text), getI18nText(i18nKeys.errorTitle)];
+        const data = errorRows.map(row => {
+            const values = this._columns.map(col => {
+                return utils.getNestedValue(row.data, col.field);
+            });
+            return [...values, row.error];
+        });
+        const worksheetData = [header, ...data];
+        const worksheet = XLSX.utils.aoa_to_sheet(worksheetData);
+        const workbook = XLSX.utils.book_new();
+        XLSX.utils.book_append_sheet(workbook, worksheet, getI18nText(i18nKeys.sheetName));
+        const wbout = XLSX.write(workbook, {
+            bookType: 'xlsx',
+            type: 'array'
+        });
+        // 创建 Blob 并触发下载
+        const blob = new Blob([wbout], {
+            type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+        });
+        const url = URL.createObjectURL(blob);
+        const a = document.createElement('a');
+        a.href = url;
+        a.download = filename;
+        a.style.display = 'none';
+        document.body.appendChild(a);
+        a.click();
+        document.body.removeChild(a);
+        URL.revokeObjectURL(url);
+    }
+}

package/dist/FileUploadWizard.svelte

@@ -8,6 +8,7 @@
     import type BaseTemplate from "./BaseTemplate";
     import type DataColumn from "@ticatec/uniface-element/DataTable";
     import i18nKeys from "./i18n_resources/i18nKeys";
+    import type BaseUploadTemplate from "./BaseUploadTemplate.js";
 
     export let title: string;
 
@@ -15,7 +16,7 @@
     export let height: string = "600px"
 
     export let closeHandler: any;
-    export let template: BaseTemplate;
+    export let template: BaseUploadTemplate;
 
     type ProcessStatus = 'Init' | 'Pending' | 'Uploading' | 'Done';  //初始状态，待上传，上传中，处理完成
 

package/dist/FileUploadWizard.svelte.d.ts

@@ -1,4 +1,4 @@
-import type BaseTemplate from "./BaseTemplate";
+import type BaseUploadTemplate from "./BaseUploadTemplate.js";
 interface $$__sveltets_2_IsomorphicComponent<Props extends Record<string, any> = any, Events extends Record<string, any> = any, Slots extends Record<string, any> = any, Exports = {}, Bindings = string> {
     new (options: import('svelte').ComponentConstructorOptions<Props>): import('svelte').SvelteComponent<Props, Events, Slots> & {
         $$bindings?: Bindings;
@@ -17,7 +17,7 @@ declare const FileUploadWizard: $$__sveltets_2_IsomorphicComponent<{
     width?: string;
     height?: string;
     closeHandler: any;
-    template: BaseTemplate;
+    template: BaseUploadTemplate;
 }, {
     [evt: string]: CustomEvent<any>;
 }, {}, {}, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ticatec/batch-data-uploader",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "A reusable Svelte component for batch uploading Excel data with support for error handling, multi-language, and preprocessing.",
   "scripts": {
     "dev": "vite dev",
@@ -42,6 +42,14 @@
       "types": "./dist/BaseTemplate.d.ts",
       "import": "./dist/BaseTemplate.js"
     },
+    "./BaseUploadTemplate": {
+      "types": "./dist/BaseUploadTemplate.d.ts",
+      "import": "./dist/BaseUploadTemplate.js"
+    },
+    "./BaseLoadTemplate": {
+      "types": "./dist/BaseLoadTemplate.d.ts",
+      "import": "./dist/BaseLoadTemplate.js"
+    },
     "./DataColumn": {
       "types": "./dist/DataColumn.d.ts",
       "import": "./dist/DataColumn.js"