excel-csv-handler 1.1.0 → 1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "excel-csv-handler",
-	"version": "1.1.0",
+	"version": "1.1.1",
 	"description": "A Node.js utility to read/write Excel and CSV files with GBK encoding support",
 	"main": "src/index.js",
 	"types": "src/excel-csv-handler.d.ts",

package/src/excel-csv-handler.d.ts

@@ -59,4 +59,60 @@ export default class ExcelCsvHandler {
 	 * ```
 	 */
 	static getAbsolutePath(importMetaUrl: string, relativePath: string): string;
+
+	/**
+	 * 自动分页请求并汇总所有数据
+	 * @param requestFn - 请求函数，接收一个参数对象，如 { pageNum: 1, pageSize: 50 }
+	 * @param config - 配置对象
+	 * @returns 完整的列表数据
+	 * 
+	 * @example
+	 * ```ts
+	 * // 基本用法（使用默认的 pageNum 和 pageSize）
+	 * const data = await ExcelCsvHandler.getPagination(fetchFn, {
+	 *     listPath: 'data.list',
+	 *     totalPath: 'data.total',
+	 *     pageSize: 50
+	 * });
+	 * 
+	 * // 自定义页码字段名
+	 * const data = await ExcelCsvHandler.getPagination(fetchFn, {
+	 *     listPath: 'result.items',
+	 *     totalPath: 'result.count',
+	 *     pageSize: 100,
+	 *     pageNumKey: 'page',      // 使用 page 而不是 pageNum
+	 *     pageSizeKey: 'size'      // 使用 size 而不是 pageSize
+	 * });
+	 * ```
+	 */
+	static getPagination<T = any>(
+		requestFn: (params: Record<string, any>) => Promise<any>,
+		config: PaginationConfig
+	): Promise<T[]>;
+}
+
+/**
+ * 分页请求配置对象
+ */
+export interface PaginationConfig {
+	/**
+	 * 列表数据的属性路径，如 'data.pageData.list'
+	 */
+	listPath: string;
+	/**
+	 * 总数量的属性路径，如 'data.pageData.count'
+	 */
+	totalPath: string;
+	/**
+	 * 每页大小
+	 */
+	pageSize: number;
+	/**
+	 * 请求参数中页码的字段名，默认 'pageNum'
+	 */
+	pageNumKey?: string;
+	/**
+	 * 请求参数中每页大小的字段名，默认 'pageSize'
+	 */
+	pageSizeKey?: string;
 }

package/src/index.js

@@ -277,6 +277,149 @@ ExcelCsvHandler.getAbsolutePath = function (importMetaUrl, relativePath) {
     return path.join(__dirname, cleanPath);
 };
 
+/**
+ * 自动分页请求并汇总所有数据
+ * @param {Function} requestFn - 请求函数，接收一个参数对象，如 { pageNum: 1, pageSize: 50 }
+ * @param {Object} config - 配置对象
+ * @param {string} config.listPath - 列表数据的属性路径，如 'data.pageData.list'
+ * @param {string} config.totalPath - 总数量的属性路径，如 'data.pageData.count'
+ * @param {number} config.pageSize - 每页大小
+ * @param {string} [config.pageNumKey='pageNum'] - 请求参数中页码的字段名，默认 'pageNum'
+ * @param {string} [config.pageSizeKey='pageSize'] - 请求参数中每页大小的字段名，默认 'pageSize'
+ * @returns {Promise<Array>} 完整的列表数据
+ * 
+ * @example
+ * // 基本用法（使用默认的 pageNum 和 pageSize）
+ * const data = await ExcelCsvHandler.getPagination(fetchFn, {
+ *     listPath: 'data.list',
+ *     totalPath: 'data.total',
+ *     pageSize: 50
+ * });
+ * 
+ * @example
+ * // 自定义页码字段名
+ * const data = await ExcelCsvHandler.getPagination(fetchFn, {
+ *     listPath: 'result.items',
+ *     totalPath: 'result.count',
+ *     pageSize: 100,
+ *     pageNumKey: 'page',      // 使用 page 而不是 pageNum
+ *     pageSizeKey: 'size'      // 使用 size 而不是 pageSize
+ * });
+ */
+ExcelCsvHandler.getPagination = async function (requestFn, config) {
+    // 参数校验
+    if (typeof requestFn !== 'function') {
+        throw new Error('请求函数必须是一个函数');
+    }
+    if (!config || typeof config !== 'object') {
+        throw new Error('配置参数必须是一个对象');
+    }
+
+    const {
+        listPath,
+        totalPath,
+        pageSize,
+        pageNumKey = 'pageNum',
+        pageSizeKey = 'pageSize'
+    } = config;
+
+    if (!listPath || typeof listPath !== 'string') {
+        throw new Error('列表路径(listPath)必须是一个字符串');
+    }
+    if (!totalPath || typeof totalPath !== 'string') {
+        throw new Error('总数量路径(totalPath)必须是一个字符串');
+    }
+    if (!pageSize || pageSize <= 0) {
+        throw new Error('每页大小(pageSize)必须大于0');
+    }
+
+    /**
+     * 根据路径获取对象属性值
+     * @param {Object} obj - 源对象
+     * @param {string} path - 属性路径，如 'data.pageData.list'
+     */
+    function getValueByPath(obj, path) {
+        return path.split('.').reduce((current, key) => current?.[key], obj);
+    }
+
+    try {
+        // 第一次请求，获取总数量和第一页数据
+        console.log(`开始分页请求，每页 ${pageSize} 条...`);
+        console.log(`使用参数名: ${pageNumKey}(页码), ${pageSizeKey}(每页大小)`);
+
+        const firstPageParams = {
+            [pageNumKey]: 1,
+            [pageSizeKey]: pageSize
+        };
+        const firstResponse = await requestFn(firstPageParams);
+
+        // 获取第一页数据和总数量
+        const firstPageList = getValueByPath(firstResponse, listPath);
+        const total = getValueByPath(firstResponse, totalPath);
+
+        if (!Array.isArray(firstPageList)) {
+            throw new Error(`无法从响应中获取列表数据，路径: ${listPath}`);
+        }
+        if (typeof total !== 'number') {
+            throw new Error(`无法从响应中获取总数量，路径: ${totalPath}`);
+        }
+
+        console.log(`总计 ${total} 条数据`);
+
+        // 如果总数量为 0 或第一页已经包含所有数据，直接返回
+        if (total === 0) {
+            console.log('没有数据');
+            return [];
+        }
+        if (total <= pageSize) {
+            console.log('所有数据已在第一页');
+            return firstPageList;
+        }
+
+        // 计算总页数
+        const totalPages = Math.ceil(total / pageSize);
+        console.log(`需要请求 ${totalPages} 页`);
+
+        // 初始化结果数组，先放入第一页数据
+        const allData = [...firstPageList];
+
+        // 请求剩余的页面
+        const requests = [];
+        for (let page = 2; page <= totalPages; page++) {
+            const pageParams = {
+                [pageNumKey]: page,
+                [pageSizeKey]: pageSize
+            };
+            requests.push(
+                requestFn(pageParams).then(response => {
+                    const pageList = getValueByPath(response, listPath);
+                    if (!Array.isArray(pageList)) {
+                        console.warn(`第 ${page} 页数据格式错误`);
+                        return [];
+                    }
+                    console.log(`第 ${page}/${totalPages} 页请求完成，获取 ${pageList.length} 条数据`);
+                    return pageList;
+                })
+            );
+        }
+
+        // 并发请求所有剩余页面
+        const remainingPages = await Promise.all(requests);
+
+        // 合并所有数据
+        remainingPages.forEach(pageData => {
+            allData.push(...pageData);
+        });
+
+        console.log(`分页请求完成，共获取 ${allData.length} 条数据`);
+        return allData;
+
+    } catch (error) {
+        console.error('分页请求失败:', error.message);
+        throw error;
+    }
+};
+
 export default ExcelCsvHandler;
 
 // 示例用法（取消注释可测试）