@nocobase/plugin-action-import 1.0.0-alpha.1

package/dist/server/utils/index.js

@@ -0,0 +1,54 @@
+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 utils_exports = {};
+__export(utils_exports, {
+  transform: () => transform
+});
+module.exports = __toCommonJS(utils_exports);
+var import_lodash = __toESM(require("lodash"));
+var transforms = __toESM(require("./transform"));
+function getTransform(name) {
+  return transforms[name] || transforms._;
+}
+async function transform({ ctx, record, columns, fields }) {
+  const newRecord = {};
+  for (let index = 0, iLen = record.length; index < iLen; index++) {
+    const cell = record[index];
+    const column = columns[index] ?? {};
+    const { dataIndex } = column;
+    const field = fields.find((f) => f.name === dataIndex[0]);
+    const t = getTransform(field.options.interface);
+    const value = await t({ ctx, column, value: cell, field });
+    import_lodash.default.set(newRecord, dataIndex[0], value);
+  }
+  return newRecord;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  transform
+});

package/dist/server/utils/transform.d.ts

@@ -0,0 +1,84 @@
+export declare function _({ value, field }: {
+    value: any;
+    field: any;
+}): Promise<any>;
+export declare function email({ value, field, ctx }: {
+    value: any;
+    field: any;
+    ctx: any;
+}): Promise<any>;
+export declare function password({ value, field, ctx }: {
+    value: any;
+    field: any;
+    ctx: any;
+}): Promise<string>;
+export declare function o2o({ value, column, field, ctx }: {
+    value: any;
+    column: any;
+    field: any;
+    ctx: any;
+}): Promise<any>;
+export declare const oho: typeof o2o;
+export declare const obo: typeof o2o;
+export declare function o2m({ value, column, field, ctx }: {
+    value: any;
+    column: any;
+    field: any;
+    ctx: any;
+}): Promise<any[]>;
+export declare function m2o({ value, column, field, ctx }: {
+    value: any;
+    column: any;
+    field: any;
+    ctx: any;
+}): Promise<any>;
+export declare function m2m({ value, column, field, ctx }: {
+    value: any;
+    column: any;
+    field: any;
+    ctx: any;
+}): Promise<any[]>;
+export declare function datetime({ value, field, ctx }: {
+    value: any;
+    field: any;
+    ctx: any;
+}): Promise<any>;
+export declare function time({ value, field, ctx }: {
+    value: any;
+    field: any;
+    ctx: any;
+}): Promise<any>;
+export declare function percent({ value, field, ctx }: {
+    value: any;
+    field: any;
+    ctx: any;
+}): Promise<number>;
+export declare function checkbox({ value, column, field, ctx }: {
+    value: any;
+    column: any;
+    field: any;
+    ctx: any;
+}): Promise<0 | 1>;
+export declare const boolean: typeof checkbox;
+export declare function select({ value, column, field, ctx }: {
+    value: any;
+    column: any;
+    field: any;
+    ctx: any;
+}): Promise<any>;
+export declare const radio: typeof select;
+export declare const radioGroup: typeof select;
+export declare function multipleSelect({ value, column, field, ctx }: {
+    value: any;
+    column: any;
+    field: any;
+    ctx: any;
+}): Promise<any>;
+export declare const checkboxes: typeof multipleSelect;
+export declare const checkboxGroup: typeof multipleSelect;
+export declare function chinaRegion({ value, column, field, ctx }: {
+    value: any;
+    column: any;
+    field: any;
+    ctx: any;
+}): Promise<any>;

package/dist/server/utils/transform.js

@@ -0,0 +1,226 @@
+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 transform_exports = {};
+__export(transform_exports, {
+  _: () => _,
+  boolean: () => boolean,
+  checkbox: () => checkbox,
+  checkboxGroup: () => checkboxGroup,
+  checkboxes: () => checkboxes,
+  chinaRegion: () => chinaRegion,
+  datetime: () => datetime,
+  email: () => email,
+  m2m: () => m2m,
+  m2o: () => m2o,
+  multipleSelect: () => multipleSelect,
+  o2m: () => o2m,
+  o2o: () => o2o,
+  obo: () => obo,
+  oho: () => oho,
+  password: () => password,
+  percent: () => percent,
+  radio: () => radio,
+  radioGroup: () => radioGroup,
+  select: () => select,
+  time: () => time
+});
+module.exports = __toCommonJS(transform_exports);
+var import_utils = require("@nocobase/utils");
+var math = __toESM(require("mathjs"));
+var import__ = require("../../");
+async function _({ value, field }) {
+  return value;
+}
+async function email({ value, field, ctx }) {
+  if (!(value == null ? void 0 : value.trim())) {
+    return value;
+  }
+  const emailReg = /^([a-zA-Z0-9._-])+@([a-zA-Z0-9_-])+(\.[a-zA-Z0-9_-])+/;
+  if (!emailReg.test(value)) {
+    throw new Error(ctx.t("Incorrect email format", { ns: import__.namespace }));
+  }
+  return value;
+}
+async function password({ value, field, ctx }) {
+  if (value === void 0 || value === null) {
+    throw new Error(ctx.t("password is empty", { ns: import__.namespace }));
+  }
+  return `${value}`;
+}
+async function o2o({ value, column, field, ctx }) {
+  const { dataIndex, enum: enumData } = column;
+  const repository = ctx.db.getRepository(field.options.target);
+  let enumItem = null;
+  if ((enumData == null ? void 0 : enumData.length) > 0) {
+    enumItem = enumData.find((e) => e.label === value);
+  }
+  const val = await repository.findOne({ filter: { [dataIndex[1]]: (enumItem == null ? void 0 : enumItem.value) ?? value } });
+  return val;
+}
+const oho = o2o;
+const obo = o2o;
+async function o2m({ value, column, field, ctx }) {
+  let results = [];
+  const values = value.split(";").map((val) => val.trim());
+  const { dataIndex, enum: enumData } = column;
+  const repository = ctx.db.getRepository(field.options.target);
+  if ((enumData == null ? void 0 : enumData.length) > 0) {
+    const enumValues = values.map((val) => {
+      const v = enumData.find((e) => e.label === val);
+      if (v === void 0) {
+        throw new Error(`not found enum value ${val}`);
+      }
+      return v.value;
+    });
+    results = await repository.find({ filter: { [dataIndex[1]]: enumValues } });
+  } else {
+    results = await repository.find({ filter: { [dataIndex[1]]: values } });
+  }
+  return results;
+}
+async function m2o({ value, column, field, ctx }) {
+  var _a;
+  let results = null;
+  const { dataIndex, enum: enumData } = column;
+  const repository = ctx.db.getRepository(field.options.target);
+  if ((enumData == null ? void 0 : enumData.length) > 0) {
+    const enumValue = (_a = enumData.find((e) => e.label === (value == null ? void 0 : value.trim()))) == null ? void 0 : _a.value;
+    results = await repository.findOne({ filter: { [dataIndex[1]]: enumValue } });
+  } else {
+    results = await repository.findOne({ filter: { [dataIndex[1]]: value } });
+  }
+  return results;
+}
+async function m2m({ value, column, field, ctx }) {
+  let results = [];
+  const values = value.split(";").map((val) => val.trim());
+  const { dataIndex, enum: enumData } = column;
+  const repository = ctx.db.getRepository(field.options.target);
+  if ((enumData == null ? void 0 : enumData.length) > 0) {
+    const enumValues = values.map((val) => {
+      const v = enumData.find((e) => e.label === val);
+      if (v === void 0) {
+        throw new Error(`not found enum value ${val}`);
+      }
+      return v.value;
+    });
+    results = await repository.find({ filter: { [dataIndex[1]]: enumValues } });
+  } else {
+    results = await repository.find({ filter: { [dataIndex[1]]: values } });
+  }
+  return results;
+}
+async function datetime({ value, field, ctx }) {
+  var _a, _b;
+  if (!value) {
+    return "";
+  }
+  const utcOffset = ctx.get("X-Timezone");
+  const props = ((_b = (_a = field.options) == null ? void 0 : _a.uiSchema) == null ? void 0 : _b["x-component-props"]) ?? {};
+  const m = (0, import_utils.str2moment)(value, { ...props, utcOffset });
+  if (!m.isValid()) {
+    throw new Error(ctx.t("Incorrect date format", { ns: import__.namespace }));
+  }
+  return m.toDate();
+}
+async function time({ value, field, ctx }) {
+  var _a, _b;
+  const { format } = ((_b = (_a = field.options) == null ? void 0 : _a.uiSchema) == null ? void 0 : _b["x-component-props"]) ?? {};
+  if (format) {
+    const m = (0, import_utils.dayjs)(value, format);
+    if (!m.isValid()) {
+      throw new Error(ctx.t("Incorrect time format", { ns: import__.namespace }));
+    }
+    return m.format(format);
+  }
+  return value;
+}
+async function percent({ value, field, ctx }) {
+  var _a;
+  if (value) {
+    const numberValue = Number(((_a = value == null ? void 0 : value.split("%")) == null ? void 0 : _a[0]) ?? value);
+    if (isNaN(numberValue)) {
+      throw new Error(ctx.t("Illegal percentage format", { ns: import__.namespace }));
+    }
+    return math.round(numberValue / 100, 9);
+  }
+  return 0;
+}
+async function checkbox({ value, column, field, ctx }) {
+  return value === ctx.t("Yes", { ns: import__.namespace }) ? 1 : 0;
+}
+const boolean = checkbox;
+async function select({ value, column, field, ctx }) {
+  const { enum: enumData } = column;
+  const item = enumData.find((item2) => item2.label === value);
+  return item == null ? void 0 : item.value;
+}
+const radio = select;
+const radioGroup = select;
+async function multipleSelect({ value, column, field, ctx }) {
+  const values = value == null ? void 0 : value.split(";");
+  const { enum: enumData } = column;
+  const results = values == null ? void 0 : values.map((val) => {
+    const item = enumData.find((item2) => item2.label === val);
+    return item;
+  });
+  return results == null ? void 0 : results.map((result) => result == null ? void 0 : result.value);
+}
+const checkboxes = multipleSelect;
+const checkboxGroup = multipleSelect;
+async function chinaRegion({ value, column, field, ctx }) {
+  var _a;
+  const values = (_a = value == null ? void 0 : value.split("/")) == null ? void 0 : _a.map((val) => val.trim());
+  const repository = ctx.db.getRepository("chinaRegions");
+  const results = await repository.find({ filter: { name: values } });
+  return results;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  _,
+  boolean,
+  checkbox,
+  checkboxGroup,
+  checkboxes,
+  chinaRegion,
+  datetime,
+  email,
+  m2m,
+  m2o,
+  multipleSelect,
+  o2m,
+  o2o,
+  obo,
+  oho,
+  password,
+  percent,
+  radio,
+  radioGroup,
+  select,
+  time
+});

package/dist/swagger/index.json

@@ -0,0 +1,33 @@
+{
+  "openapi": "3.0.2",
+  "info": {
+    "title": "NocoBase API - Import plugin"
+  },
+  "tags": [],
+  "paths": {
+    "/{collectionName}:importXlsx": {
+      "post": {
+        "tags": ["$collection"],
+        "description": "",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/{collectionName}:downloadXlsxTemplate": {
+      "post": {
+        "tags": ["$collection"],
+        "description": "",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@nocobase/plugin-action-import",
+  "displayName": "Action: Import records",
+  "displayName.zh-CN": "操作：导入记录",
+  "description": "Import records using excel templates. You can configure which fields to import and templates will be generated automatically.",
+  "description.zh-CN": "使用 Excel 模板导入数据，可以配置导入哪些字段，自动生成模板。",
+  "version": "1.0.0-alpha.1",
+  "license": "AGPL-3.0",
+  "main": "./dist/server/index.js",
+  "homepage": "https://docs.nocobase.com/handbook/action-import",
+  "homepage.zh-CN": "https://docs-cn.nocobase.com/handbook/action-import",
+  "devDependencies": {
+    "@ant-design/icons": "5.x",
+    "@formily/antd-v5": "1.x",
+    "@formily/core": "2.x",
+    "@formily/react": "2.x",
+    "@formily/shared": "2.x",
+    "@koa/multer": "^3.0.2",
+    "@types/node-xlsx": "^0.15.1",
+    "antd": "5.x",
+    "file-saver": "^2.0.5",
+    "mathjs": "^10.6.0",
+    "node-xlsx": "^0.16.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-i18next": "^11.15.1",
+    "xlsx": "^0.17.0"
+  },
+  "peerDependencies": {
+    "@nocobase/actions": "1.x",
+    "@nocobase/client": "1.x",
+    "@nocobase/database": "1.x",
+    "@nocobase/server": "1.x",
+    "@nocobase/test": "1.x",
+    "@nocobase/utils": "1.x"
+  },
+  "gitHead": "c73b6d2032a6151fdfeebeb0ec923d766578c53c",
+  "keywords": [
+    "Actions"
+  ]
+}

package/server.d.ts

@@ -0,0 +1,2 @@
+export * from './dist/server';
+export { default } from './dist/server';

package/server.js

@@ -0,0 +1 @@
+module.exports = require('./dist/server/index.js');