@nocobase/plugin-action-export 1.0.0-alpha.9 → 1.0.1-alpha.2

package/dist/node_modules/xlsx/xlsxworker.js

@@ -0,0 +1,14 @@
+/* xlsx.js (C) 2013-present SheetJS -- http://sheetjs.com */
+importScripts('dist/shim.min.js');
+/* uncomment the next line for encoding support */
+importScripts('dist/cpexcel.js');
+importScripts('xlsx.js');
+postMessage({t:"ready"});
+
+onmessage = function (evt) {
+  var v;
+  try {
+    v = XLSX.read(evt.data.d, {type: evt.data.b, codepage: evt.data.c});
+postMessage({t:"xlsx", d:JSON.stringify(v)});
+  } catch(e) { postMessage({t:"e",d:e.stack||e}); }
+};

package/dist/server/actions/export-xlsx.js

@@ -39,10 +39,11 @@ __export(export_xlsx_exports, {
   exportXlsx: () => exportXlsx
 });
 module.exports = __toCommonJS(export_xlsx_exports);
-var import_node_xlsx = __toESM(require("node-xlsx"));
-var import_renders = __toESM(require("../renders"));
-var import_utils = require("../utils");
-async function exportXlsx(ctx, next) {
+var import_xlsx_exporter = __toESM(require("../xlsx-exporter"));
+var import_xlsx = __toESM(require("xlsx"));
+var import_async_mutex = require("async-mutex");
+const mutex = new import_async_mutex.Mutex();
+async function exportXlsxAction(ctx, next) {
   var _a, _b;
   const { title, filter, sort, fields, except } = ctx.action.params;
   let columns = ((_a = ctx.action.params.values) == null ? void 0 : _a.columns) || ((_b = ctx.action.params) == null ? void 0 : _b.columns);
@@ -50,37 +51,36 @@ async function exportXlsx(ctx, next) {
     columns = JSON.parse(columns);
   }
   const repository = ctx.getCurrentRepository();
+  const dataSource = ctx.dataSource;
   const collection = repository.collection;
-  columns = columns == null ? void 0 : columns.filter((col) => {
-    var _a2;
-    return collection.hasField(col.dataIndex[0]) && ((_a2 = col == null ? void 0 : col.dataIndex) == null ? void 0 : _a2.length) > 0;
-  });
-  const appends = (0, import_utils.columns2Appends)(columns, ctx);
-  const data = await repository.find({
-    filter,
-    fields,
-    appends,
-    except,
-    sort,
-    limit: 200,
-    context: ctx
-  });
-  const collectionFields = columns.map((col) => collection.fields.get(col.dataIndex[0]));
-  const { rows, ranges } = await (0, import_renders.default)({ columns, fields: collectionFields, data }, ctx);
-  ctx.body = import_node_xlsx.default.build([
-    {
-      name: "Sheet 1",
-      data: rows,
-      options: {
-        "!merges": ranges
-      }
+  const xlsxExporter = new import_xlsx_exporter.default({
+    collectionManager: dataSource.collectionManager,
+    collection,
+    columns,
+    findOptions: {
+      filter,
+      fields,
+      except,
+      sort
     }
-  ]);
+  });
+  const wb = await xlsxExporter.run();
+  ctx.body = import_xlsx.default.write(wb, { type: "buffer", bookType: "xlsx" });
   ctx.set({
     "Content-Type": "application/octet-stream",
-    // to avoid "invalid character" error in header (RFC)
     "Content-Disposition": `attachment; filename=${encodeURI(title)}.xlsx`
   });
+}
+async function exportXlsx(ctx, next) {
+  if (mutex.isLocked()) {
+    throw new Error(`another export action is running, please try again later.`);
+  }
+  const release = await mutex.acquire();
+  try {
+    await exportXlsxAction(ctx, next);
+  } finally {
+    release();
+  }
   await next();
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/server/index.d.ts

@@ -6,10 +6,9 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-import { InstallOptions, Plugin } from '@nocobase/server';
+import { Plugin } from '@nocobase/server';
 export declare class PluginActionExportServer extends Plugin {
     beforeLoad(): void;
     load(): Promise<void>;
-    install(options: InstallOptions): Promise<void>;
 }
 export default PluginActionExportServer;

package/dist/server/index.js

@@ -37,10 +37,6 @@ class PluginActionExportServer extends import_server.Plugin {
   }
   async load() {
     this.app.dataSourceManager.afterAddDataSource((dataSource) => {
-      var _a;
-      if (!((_a = dataSource.collectionManager) == null ? void 0 : _a.db)) {
-        return;
-      }
       dataSource.resourceManager.registerActionHandler("export", import_actions.exportXlsx);
       dataSource.acl.setAvailableAction("export", {
         displayName: '{{t("Export")}}',
@@ -48,8 +44,6 @@ class PluginActionExportServer extends import_server.Plugin {
       });
     });
   }
-  async install(options) {
-  }
 }
 var server_default = PluginActionExportServer;
 // Annotate the CommonJS export names for ESM import in node:

package/dist/server/utils/{index.d.ts → deep-get.d.ts}

@@ -6,4 +6,4 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-export * from './columns2Appends';
+export declare function deepGet(object: any, path: any): any;

package/dist/server/utils/{columns2Appends.js → deep-get.js}

@@ -7,9 +7,11 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -23,32 +25,34 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var columns2Appends_exports = {};
-__export(columns2Appends_exports, {
-  columns2Appends: () => columns2Appends
+var deep_get_exports = {};
+__export(deep_get_exports, {
+  deepGet: () => deepGet
 });
-module.exports = __toCommonJS(columns2Appends_exports);
-function columns2Appends(columns, ctx) {
-  const { resourceName } = ctx.action;
-  const appends = /* @__PURE__ */ new Set([]);
-  for (const column of columns) {
-    let collection = ctx.dataSource.collectionManager.getCollection(resourceName);
-    const appendColumns = [];
-    for (let i = 0, iLen = column.dataIndex.length; i < iLen; i++) {
-      const field = collection.getField(column.dataIndex[i]);
-      if (field == null ? void 0 : field.target) {
-        appendColumns.push(column.dataIndex[i]);
-        collection = ctx.dataSource.collectionManager.getCollection(field.target);
-      }
-    }
-    if (appendColumns.length > 0) {
-      appends.add(appendColumns.join("."));
+module.exports = __toCommonJS(deep_get_exports);
+var import_lodash = __toESM(require("lodash"));
+function deepGet(object, path) {
+  const pathParts = Array.isArray(path) ? path : path.split(".");
+  let current = object;
+  for (const part of pathParts) {
+    if (Array.isArray(current)) {
+      current = current.map((item) => import_lodash.default.get(item, part));
+    } else {
+      current = import_lodash.default.get(current, part);
     }
   }
-  return Array.from(appends);
+  return current;
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  columns2Appends
+  deepGet
 });

package/dist/server/xlsx-exporter.d.ts

@@ -0,0 +1,45 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { FindOptions, ICollection, ICollectionManager } from '@nocobase/data-source-manager';
+import XLSX from 'xlsx';
+type ExportColumn = {
+    dataIndex: Array<string>;
+    defaultTitle: string;
+};
+type ExportOptions = {
+    collectionManager: ICollectionManager;
+    collection: ICollection;
+    columns: Array<ExportColumn>;
+    findOptions?: FindOptions;
+    chunkSize?: number;
+};
+declare class XlsxExporter {
+    private options;
+    /**
+     * You can adjust the maximum number of exported rows based on business needs and system
+     * available resources. However, please note that you need to fully understand the risks
+     * after the modification. Increasing the maximum number of rows that can be exported may
+     * increase system resource usage, leading to increased processing delays for other
+     * requests, or even server processes being recycled by the operating system.
+     *
+     * 您可以根据业务需求和系统可用资源等参数，调整最大导出数量的限制。但请注意，您需要充分了解修改之后的风险，
+     * 增加最大可导出的行数可能会导致系统资源占用率升高，导致其他请求处理延迟增加、无法处理、甚至
+     * 服务端进程被操作系统回收等问题。
+     */
+    limit: number;
+    constructor(options: ExportOptions);
+    run(ctx?: any): Promise<XLSX.WorkBook>;
+    private getAppendOptionsFromColumns;
+    private getFindOptions;
+    private findFieldByDataIndex;
+    private renderHeaders;
+    private renderRawValue;
+    private renderCellValue;
+}
+export default XlsxExporter;

package/dist/server/xlsx-exporter.js

@@ -0,0 +1,168 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var xlsx_exporter_exports = {};
+__export(xlsx_exporter_exports, {
+  default: () => xlsx_exporter_default
+});
+module.exports = __toCommonJS(xlsx_exporter_exports);
+var import_xlsx = __toESM(require("xlsx"));
+var import_deep_get = require("./utils/deep-get");
+class XlsxExporter {
+  constructor(options) {
+    this.options = options;
+  }
+  /**
+   * You can adjust the maximum number of exported rows based on business needs and system
+   * available resources. However, please note that you need to fully understand the risks
+   * after the modification. Increasing the maximum number of rows that can be exported may
+   * increase system resource usage, leading to increased processing delays for other
+   * requests, or even server processes being recycled by the operating system.
+   *
+   * 您可以根据业务需求和系统可用资源等参数，调整最大导出数量的限制。但请注意，您需要充分了解修改之后的风险，
+   * 增加最大可导出的行数可能会导致系统资源占用率升高，导致其他请求处理延迟增加、无法处理、甚至
+   * 服务端进程被操作系统回收等问题。
+   */
+  limit = process.env["EXPORT_LIMIT"] ? parseInt(process.env["EXPORT_LIMIT"]) : 2e3;
+  async run(ctx) {
+    const { collection, columns, chunkSize } = this.options;
+    const workbook = import_xlsx.default.utils.book_new();
+    const worksheet = import_xlsx.default.utils.sheet_new();
+    import_xlsx.default.utils.sheet_add_aoa(worksheet, [this.renderHeaders()], {
+      origin: "A1"
+    });
+    let startRowNumber = 2;
+    await collection.repository.chunk({
+      ...this.getFindOptions(),
+      chunkSize: chunkSize || 200,
+      callback: async (rows, options) => {
+        const chunkData = rows.map((r) => {
+          return columns.map((col) => {
+            return this.renderCellValue(r, col, ctx);
+          });
+        });
+        import_xlsx.default.utils.sheet_add_aoa(worksheet, chunkData, {
+          origin: `A${startRowNumber}`
+        });
+        startRowNumber += rows.length;
+        await new Promise((resolve) => {
+          setTimeout(resolve, 50);
+        });
+      }
+    });
+    import_xlsx.default.utils.book_append_sheet(workbook, worksheet, "Data");
+    return workbook;
+  }
+  getAppendOptionsFromColumns() {
+    return this.options.columns.map((col) => {
+      if (col.dataIndex.length > 1) {
+        return col.dataIndex.join(".");
+      }
+      const field = this.options.collection.getField(col.dataIndex[0]);
+      if (field.isRelationField()) {
+        return col.dataIndex[0];
+      }
+      return null;
+    }).filter(Boolean);
+  }
+  getFindOptions() {
+    const { findOptions = {} } = this.options;
+    findOptions.limit = this.limit;
+    const appendOptions = this.getAppendOptionsFromColumns();
+    if (appendOptions.length) {
+      return {
+        ...findOptions,
+        appends: appendOptions
+      };
+    }
+    return findOptions;
+  }
+  findFieldByDataIndex(dataIndex) {
+    const { collection } = this.options;
+    const currentField = collection.getField(dataIndex[0]);
+    if (dataIndex.length > 1) {
+      let targetCollection;
+      for (let i = 0; i < dataIndex.length - 1; i++) {
+        const isLast = i === dataIndex.length - 1;
+        if (isLast) {
+          return targetCollection.getField(dataIndex[i]);
+        }
+        targetCollection = currentField.targetCollection();
+      }
+    }
+    return currentField;
+  }
+  renderHeaders() {
+    return this.options.columns.map((col) => {
+      const field = this.findFieldByDataIndex(col.dataIndex);
+      return (field == null ? void 0 : field.options.title) || col.defaultTitle;
+    });
+  }
+  renderRawValue(value) {
+    if (typeof value === "object" && value !== null) {
+      return JSON.stringify(value);
+    }
+    return value;
+  }
+  renderCellValue(rowData, column, ctx) {
+    const { dataIndex } = column;
+    rowData = rowData.toJSON();
+    const value = rowData[dataIndex[0]];
+    if (dataIndex.length > 1) {
+      const deepValue = (0, import_deep_get.deepGet)(rowData, dataIndex);
+      if (Array.isArray(deepValue)) {
+        return deepValue.join(",");
+      }
+      return deepValue;
+    }
+    const field = this.findFieldByDataIndex(dataIndex);
+    if (!field) {
+      return this.renderRawValue(value);
+    }
+    const fieldOptions = field.options;
+    const interfaceName = fieldOptions["interface"];
+    if (!interfaceName) {
+      return this.renderRawValue(value);
+    }
+    const InterfaceClass = this.options.collectionManager.getFieldInterface(interfaceName);
+    if (!InterfaceClass) {
+      return this.renderRawValue(value);
+    }
+    const interfaceInstance = new InterfaceClass(fieldOptions);
+    return interfaceInstance.toString(value, ctx);
+  }
+}
+var xlsx_exporter_default = XlsxExporter;

package/package.json

@@ -4,7 +4,7 @@
   "displayName.zh-CN": "操作：导出记录",
   "description": "Export filtered records to excel, you can configure which fields to export.",
   "description.zh-CN": "导出筛选后的记录到 Excel 中，可以配置导出哪些字段。",
-  "version": "1.0.0-alpha.9",
+  "version": "1.0.1-alpha.2",
   "license": "AGPL-3.0",
   "main": "./dist/server/index.js",
   "homepage": "https://docs.nocobase.com/handbook/action-export",
@@ -14,10 +14,12 @@
     "@formily/react": "2.x",
     "@formily/shared": "2.x",
     "@types/node-xlsx": "^0.15.1",
+    "async-mutex": "^0.3.2",
     "file-saver": "^2.0.5",
     "node-xlsx": "^0.16.1",
     "react": "^18.2.0",
-    "react-i18next": "^11.15.1"
+    "react-i18next": "^11.15.1",
+    "xlsx": "https://cdn.sheetjs.com/xlsx-0.20.2/xlsx-0.20.2.tgz"
   },
   "peerDependencies": {
     "@nocobase/actions": "1.x",
@@ -27,7 +29,7 @@
     "@nocobase/test": "1.x",
     "@nocobase/utils": "1.x"
   },
-  "gitHead": "562d6ae965317098df05db756d160e03363dcec5",
+  "gitHead": "fc5a8e3c812516f787cb22d3d198f058f45b1963",
   "keywords": [
     "Actions"
   ]

package/dist/node_modules/node-xlsx/lib/helpers.js

@@ -1,142 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.buildSheetFromMatrix = exports.buildExcelDate = exports.isCellDescriptor = exports.isObject = exports.isString = exports.isNumber = exports.isBoolean = void 0;
-
-var _xlsx = _interopRequireDefault(require("xlsx"));
-
-var ORIGIN_DATE = new Date(Date.UTC(1899, 11, 30));
-
-var isBoolean = function isBoolean(maybeBoolean) {
-  return typeof maybeBoolean === 'boolean';
-};
-
-exports.isBoolean = isBoolean;
-
-var isNumber = function isNumber(maybeNumber) {
-  return typeof maybeNumber === 'number';
-};
-
-exports.isNumber = isNumber;
-
-var isString = function isString(maybeString) {
-  return typeof maybeString === 'string';
-};
-
-exports.isString = isString;
-
-var isObject = function isObject(maybeObject) {
-  return maybeObject !== null && typeof maybeObject === 'object';
-};
-
-exports.isObject = isObject;
-
-var isCellDescriptor = function isCellDescriptor(maybeCell) {
-  return isObject(maybeCell) && 'v' in maybeCell;
-};
-
-exports.isCellDescriptor = isCellDescriptor;
-
-var buildExcelDate = function buildExcelDate(value, is1904) {
-  var epoch = Date.parse(value + (is1904 ? 1462 : 0));
-  return (epoch - ORIGIN_DATE) / 864e5;
-};
-
-exports.buildExcelDate = buildExcelDate;
-
-var buildSheetFromMatrix = function buildSheetFromMatrix(data, options) {
-  if (options === void 0) {
-    options = {};
-  }
-
-  var workSheet = {};
-  var range = {
-    s: {
-      c: 1e7,
-      r: 1e7
-    },
-    e: {
-      c: 0,
-      r: 0
-    }
-  };
-  if (!Array.isArray(data)) throw new Error('sheet data is not array');
-
-  for (var R = 0; R !== data.length; R += 1) {
-    for (var C = 0; C !== data[R].length; C += 1) {
-      if (!Array.isArray(data[R])) throw new Error(`${R}th row data is not array`);
-      if (range.s.r > R) range.s.r = R;
-      if (range.s.c > C) range.s.c = C;
-      if (range.e.r < R) range.e.r = R;
-      if (range.e.c < C) range.e.c = C;
-
-      if (data[R][C] === null) {
-        continue; // eslint-disable-line
-      }
-
-      var cell = isCellDescriptor(data[R][C]) ? data[R][C] : {
-        v: data[R][C]
-      };
-
-      var cellRef = _xlsx.default.utils.encode_cell({
-        c: C,
-        r: R
-      });
-
-      if (isNumber(cell.v)) {
-        cell.t = 'n';
-      } else if (isBoolean(cell.v)) {
-        cell.t = 'b';
-      } else if (cell.v instanceof Date) {
-        cell.t = 'n';
-        cell.v = buildExcelDate(cell.v);
-        cell.z = cell.z || _xlsx.default.SSF._table[14]; // eslint-disable-line no-underscore-dangle
-
-        /* eslint-disable spaced-comment, no-trailing-spaces */
-
-        /***
-         * Allows for an non-abstracted representation of the data
-         *
-         * example: {t:'n', z:10, f:'=AVERAGE(A:A)'}
-         *
-         * Documentation:
-         * - Cell Object: https://sheetjs.gitbooks.io/docs/#cell-object
-         * - Data Types: https://sheetjs.gitbooks.io/docs/#data-types
-         * - Format: https://sheetjs.gitbooks.io/docs/#number-formats
-         **/
-
-        /* eslint-disable spaced-comment, no-trailing-spaces */
-      } else if (isObject(cell.v)) {
-        cell.t = cell.v.t;
-        cell.f = cell.v.f;
-        cell.F = cell.v.F;
-        cell.z = cell.v.z;
-      } else {
-        cell.t = 's';
-      }
-
-      if (isNumber(cell.z)) cell.z = _xlsx.default.SSF._table[cell.z]; // eslint-disable-line no-underscore-dangle
-
-      workSheet[cellRef] = cell;
-    }
-  }
-
-  if (range.s.c < 1e7) {
-    workSheet['!ref'] = _xlsx.default.utils.encode_range(range);
-  }
-
-  if (options['!cols']) {
-    workSheet['!cols'] = options['!cols'];
-  }
-
-  if (options['!merges']) {
-    workSheet['!merges'] = options['!merges'];
-  }
-
-  return workSheet;
-};
-
-exports.buildSheetFromMatrix = buildSheetFromMatrix;
-//# sourceMappingURL=helpers.js.map