@nocobase/plugin-action-custom-request 1.0.0-alpha.1

package/dist/server/actions/send.js

@@ -0,0 +1,199 @@
+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 send_exports = {};
+__export(send_exports, {
+  send: () => send
+});
+module.exports = __toCommonJS(send_exports);
+var import_utils = require("@nocobase/utils");
+var import_evaluators = require("@nocobase/evaluators");
+var import_axios = __toESM(require("axios"));
+const getHeaders = (headers) => {
+  return Object.keys(headers).reduce((hds, key) => {
+    if (key.toLocaleLowerCase().startsWith("x-")) {
+      hds[key] = headers[key];
+    }
+    return hds;
+  }, {});
+};
+const arrayToObject = (arr) => {
+  return arr.reduce((acc, cur) => {
+    acc[cur.name] = cur.value;
+    return acc;
+  }, {});
+};
+const omitNullAndUndefined = (obj) => {
+  return Object.keys(obj).reduce((acc, cur) => {
+    if (obj[cur] !== null && typeof obj[cur] !== "undefined") {
+      acc[cur] = obj[cur];
+    }
+    return acc;
+  }, {});
+};
+const CurrentUserVariableRegExp = /{{\s*(currentUser[^}]+)\s*}}/g;
+const getCurrentUserAppends = (str, user) => {
+  const matched = str.matchAll(CurrentUserVariableRegExp);
+  return Array.from(matched).map((item) => {
+    const keys = (item == null ? void 0 : item[1].split(".")) || [];
+    const appendKey = keys[1];
+    if (keys.length > 2 && !Reflect.has(user || {}, appendKey)) {
+      return appendKey;
+    }
+  }).filter(Boolean);
+};
+async function send(ctx, next) {
+  var _a, _b, _c, _d;
+  const resourceName = ctx.action.resourceName;
+  const { filterByTk, values = {} } = ctx.action.params;
+  const {
+    currentRecord = {
+      id: 0,
+      appends: [],
+      data: {}
+    }
+  } = values;
+  if (ctx.state.currentRole !== "root") {
+    const crRepo = ctx.db.getRepository("customRequestsRoles");
+    const hasRoles = await crRepo.find({
+      filter: {
+        customRequestKey: filterByTk
+      }
+    });
+    if (hasRoles.length) {
+      if (!hasRoles.find((item) => item.roleName === ctx.state.currentRole)) {
+        return ctx.throw(403, "custom request no permission");
+      }
+    }
+  }
+  const repo = ctx.db.getRepository(resourceName);
+  const requestConfig = await repo.findOne({
+    filter: {
+      key: filterByTk
+    }
+  });
+  if (!requestConfig) {
+    ctx.throw(404, "request config not found");
+  }
+  ctx.withoutDataWrapping = true;
+  const {
+    dataSourceKey,
+    collectionName,
+    url,
+    headers = [],
+    params = [],
+    data = {},
+    ...options
+  } = requestConfig.options || {};
+  if (!url) {
+    return ctx.throw(400, ctx.t("Please configure the request settings first", { ns: "action-custom-request" }));
+  }
+  let currentRecordValues = {};
+  if (collectionName && typeof currentRecord.id !== "undefined") {
+    const app = ctx.app;
+    const dataSource = app.dataSourceManager.get(dataSourceKey || currentRecord.dataSourceKey || "main");
+    const recordRepo = dataSource.collectionManager.getRepository(collectionName);
+    currentRecordValues = ((_a = await recordRepo.findOne({
+      filterByTk: currentRecord.id,
+      appends: currentRecord.appends
+    })) == null ? void 0 : _a.toJSON()) || {};
+  }
+  let currentUser = ctx.auth.user;
+  const userAppends = getCurrentUserAppends(
+    JSON.stringify(url) + JSON.stringify(headers) + JSON.stringify(params) + JSON.stringify(data),
+    ctx.auth.user
+  );
+  if (userAppends.length) {
+    currentUser = ((_b = await ctx.db.getRepository("users").findOne({
+      filterByTk: ctx.auth.user.id,
+      appends: userAppends
+    })) == null ? void 0 : _b.toJSON()) || {};
+  }
+  const variables = {
+    currentRecord: {
+      ...currentRecordValues,
+      ...currentRecord.data
+    },
+    currentUser,
+    currentTime: (/* @__PURE__ */ new Date()).toISOString()
+  };
+  const getParsedValue = (value) => {
+    const template = (0, import_utils.parse)(value);
+    template.parameters.forEach(({ key }) => {
+      (0, import_evaluators.appendArrayColumn)(variables, key);
+    });
+    return template(variables);
+  };
+  const axiosRequestConfig = {
+    baseURL: ctx.origin,
+    ...options,
+    url: getParsedValue(url),
+    headers: {
+      Authorization: "Bearer " + ctx.getBearerToken(),
+      ...getHeaders(ctx.headers),
+      ...omitNullAndUndefined(getParsedValue(arrayToObject(headers)))
+    },
+    params: getParsedValue(arrayToObject(params)),
+    data: getParsedValue(data)
+  };
+  console.log(axiosRequestConfig);
+  const requestUrl = import_axios.default.getUri(axiosRequestConfig);
+  this.logger.info(`custom-request:send:${filterByTk} request url ${requestUrl}`);
+  this.logger.info(
+    `custom-request:send:${filterByTk} request config ${JSON.stringify({
+      ...axiosRequestConfig,
+      headers: {
+        ...axiosRequestConfig.headers,
+        Authorization: null
+      }
+    })}`
+  );
+  try {
+    const res = await (0, import_axios.default)(axiosRequestConfig);
+    this.logger.info(`custom-request:send:${filterByTk} success`);
+    ctx.body = res.data;
+    if (res.headers["content-disposition"]) {
+      ctx.set("Content-Disposition", res.headers["content-disposition"]);
+    }
+  } catch (err) {
+    if (import_axios.default.isAxiosError(err)) {
+      ctx.status = ((_c = err.response) == null ? void 0 : _c.status) || 500;
+      ctx.body = ((_d = err.response) == null ? void 0 : _d.data) || { message: err.message };
+      this.logger.error(
+        `custom-request:send:${filterByTk} error. status: ${ctx.status}, body: ${typeof ctx.body === "string" ? ctx.body : JSON.stringify(ctx.body)}`
+      );
+    } else {
+      this.logger.error(`custom-request:send:${filterByTk} error. status: ${ctx.status}, message: ${err.message}`);
+      ctx.throw(500, err == null ? void 0 : err.message);
+    }
+  }
+  return next();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  send
+});

package/dist/server/collections/customRequest.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@nocobase/database").CollectionOptions;
+export default _default;

package/dist/server/collections/customRequest.js

@@ -0,0 +1,51 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var customRequest_exports = {};
+__export(customRequest_exports, {
+  default: () => customRequest_default
+});
+module.exports = __toCommonJS(customRequest_exports);
+var import_database = require("@nocobase/database");
+var customRequest_default = (0, import_database.defineCollection)({
+  dumpRules: "required",
+  name: "customRequests",
+  autoGenId: false,
+  fields: [
+    {
+      type: "uid",
+      name: "key",
+      primaryKey: true
+    },
+    {
+      type: "belongsToMany",
+      name: "roles",
+      onDelete: "CASCADE",
+      through: "customRequestsRoles",
+      target: "roles",
+      foreignKey: "customRequestKey",
+      otherKey: "roleName",
+      sourceKey: "key",
+      targetKey: "name"
+    },
+    {
+      type: "json",
+      name: "options"
+      // 配置的请求参数都放这里
+    }
+  ]
+});

package/dist/server/collections/customRequestsRoles.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@nocobase/database").CollectionOptions;
+export default _default;

package/dist/server/collections/customRequestsRoles.js

@@ -0,0 +1,27 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var customRequestsRoles_exports = {};
+__export(customRequestsRoles_exports, {
+  default: () => customRequestsRoles_default
+});
+module.exports = __toCommonJS(customRequestsRoles_exports);
+var import_database = require("@nocobase/database");
+var customRequestsRoles_default = (0, import_database.defineCollection)({
+  dumpRules: "required",
+  name: "customRequestsRoles"
+});

package/dist/server/index.d.ts

@@ -0,0 +1 @@
+export { default } from './plugin';

package/dist/server/index.js

@@ -0,0 +1,33 @@
+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 server_exports = {};
+__export(server_exports, {
+  default: () => import_plugin.default
+});
+module.exports = __toCommonJS(server_exports);
+var import_plugin = __toESM(require("./plugin"));

package/dist/server/migrations/20240425205017-change-locale-module.d.ts

@@ -0,0 +1,6 @@
+import { Migration } from '@nocobase/server';
+export default class extends Migration {
+    on: string;
+    appVersion: string;
+    up(): Promise<void>;
+}

package/dist/server/migrations/20240425205017-change-locale-module.js

@@ -0,0 +1,42 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var change_locale_module_exports = {};
+__export(change_locale_module_exports, {
+  default: () => change_locale_module_default
+});
+module.exports = __toCommonJS(change_locale_module_exports);
+var import_server = require("@nocobase/server");
+class change_locale_module_default extends import_server.Migration {
+  on = "afterLoad";
+  // 'beforeLoad' or 'afterLoad'
+  appVersion = "<1.0.0-alpha.1";
+  async up() {
+    const repo = this.db.getRepository("localizationTexts");
+    if (!repo) {
+      return;
+    }
+    await repo.update({
+      filter: {
+        module: "resources.custom-request"
+      },
+      values: {
+        module: "resources.action-custom-request"
+      }
+    });
+  }
+}

package/dist/server/plugin.d.ts

@@ -0,0 +1,14 @@
+import { Logger } from '@nocobase/logger';
+import { InstallOptions, Plugin } from '@nocobase/server';
+export declare class PluginActionCustomRequestServer extends Plugin {
+    logger: Logger;
+    afterAdd(): void;
+    beforeLoad(): void;
+    getLogger(): Logger;
+    load(): Promise<void>;
+    install(options?: InstallOptions): Promise<void>;
+    afterEnable(): Promise<void>;
+    afterDisable(): Promise<void>;
+    remove(): Promise<void>;
+}
+export default PluginActionCustomRequestServer;

package/dist/server/plugin.js

@@ -0,0 +1,71 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plugin_exports = {};
+__export(plugin_exports, {
+  PluginActionCustomRequestServer: () => PluginActionCustomRequestServer,
+  default: () => plugin_default
+});
+module.exports = __toCommonJS(plugin_exports);
+var import_server = require("@nocobase/server");
+var import_path = require("path");
+var import_listByCurrentRole = require("./actions/listByCurrentRole");
+var import_send = require("./actions/send");
+class PluginActionCustomRequestServer extends import_server.Plugin {
+  logger;
+  afterAdd() {
+  }
+  beforeLoad() {
+    this.logger = this.getLogger();
+  }
+  getLogger() {
+    const logger = this.createLogger({
+      dirname: "custom-request",
+      filename: "%DATE%.log",
+      transports: [...process.env.NODE_ENV === "production" ? ["dailyRotateFile"] : ["console"]]
+    });
+    return logger;
+  }
+  async load() {
+    await this.importCollections((0, import_path.resolve)(__dirname, "collections"));
+    this.app.resource({
+      name: "customRequests",
+      actions: {
+        send: import_send.send.bind(this),
+        listByCurrentRole: import_listByCurrentRole.listByCurrentRole
+      }
+    });
+    this.app.acl.registerSnippet({
+      name: `ui.${this.name}`,
+      actions: ["customRequests:*", "roles:list"]
+    });
+    this.app.acl.allow("customRequests", ["send", "listByCurrentRole"], "loggedIn");
+  }
+  async install(options) {
+  }
+  async afterEnable() {
+  }
+  async afterDisable() {
+  }
+  async remove() {
+  }
+}
+var plugin_default = PluginActionCustomRequestServer;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginActionCustomRequestServer
+});

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@nocobase/plugin-action-custom-request",
+  "version": "1.0.0-alpha.1",
+  "main": "dist/server/index.js",
+  "homepage": "https://docs.nocobase.com/handbook/action-custom-request",
+  "homepage.zh-CN": "https://docs-cn.nocobase.com/handbook/action-custom-request",
+  "displayName": "Action: Custom request",
+  "displayName.zh-CN": "操作：自定义请求",
+  "description": "Sending a request to any HTTP service supports sending context data to the target service.",
+  "description.zh-CN": "向任意 HTTP 服务发送请求，支持将上下文数据发送给目标服务。",
+  "license": "AGPL-3.0",
+  "devDependencies": {
+    "@formily/react": "2.x",
+    "@formily/shared": "2.x",
+    "antd": "5.x",
+    "lodash": "4.x",
+    "react-i18next": "^11.15.1",
+    "react-router-dom": "6.x"
+  },
+  "peerDependencies": {
+    "@nocobase/client": "1.x",
+    "@nocobase/server": "1.x",
+    "@nocobase/test": "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');