@nocobase/plugin-workflow-request-interceptor 2.0.3

package/dist/server/Plugin.js

@@ -0,0 +1,56 @@
+/**
+ * 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 Plugin_exports = {};
+__export(Plugin_exports, {
+  PluginWorkflowRequestInterceptorServer: () => PluginWorkflowRequestInterceptorServer,
+  default: () => Plugin_default
+});
+module.exports = __toCommonJS(Plugin_exports);
+var import_server = require("@nocobase/server");
+var import_plugin_workflow = __toESM(require("@nocobase/plugin-workflow"));
+var import_RequestInterceptionTrigger = __toESM(require("./RequestInterceptionTrigger"));
+class PluginWorkflowRequestInterceptorServer extends import_server.Plugin {
+  async load() {
+    const workflowPlugin = this.app.pm.get(import_plugin_workflow.default);
+    workflowPlugin.registerTrigger("request-interception", import_RequestInterceptionTrigger.default);
+  }
+}
+var Plugin_default = PluginWorkflowRequestInterceptorServer;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginWorkflowRequestInterceptorServer
+});

package/dist/server/RequestInterceptionTrigger.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { EventOptions, Trigger, WorkflowModel } from '@nocobase/plugin-workflow';
+export default class RequestInterceptionTrigger extends Trigger {
+    static TYPE: string;
+    sync: boolean;
+    middleware: (context: any, next: any) => Promise<any>;
+    constructor(workflow: any);
+    validateContext(values: any): {
+        target: string;
+        userId?: undefined;
+    } | {
+        userId: string;
+        target?: undefined;
+    };
+    execute(workflow: WorkflowModel, values: any, options: EventOptions): Promise<void | import("@nocobase/plugin-workflow").Processor>;
+}

package/dist/server/RequestInterceptionTrigger.js

@@ -0,0 +1,218 @@
+/**
+ * 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 RequestInterceptionTrigger_exports = {};
+__export(RequestInterceptionTrigger_exports, {
+  default: () => RequestInterceptionTrigger
+});
+module.exports = __toCommonJS(RequestInterceptionTrigger_exports);
+var import_lodash = require("lodash");
+var import_plugin_error_handler = __toESM(require("@nocobase/plugin-error-handler"));
+var import_plugin_workflow = require("@nocobase/plugin-workflow");
+var import_data_source_manager = require("@nocobase/data-source-manager");
+var import_constants = require("../common/constants");
+class RequestInterceptionError extends Error {
+  status = 400;
+  messages = [];
+  constructor(message) {
+    super(message);
+    this.name = "RequestInterceptionError";
+  }
+}
+class RequestInterceptionTrigger extends import_plugin_workflow.Trigger {
+  static TYPE = "request-interception";
+  sync = true;
+  middleware = async (context, next) => {
+    const {
+      resourceName,
+      actionName,
+      params: { filterByTk, filter, values, triggerWorkflows = "" }
+    } = context.action;
+    const dataSourceHeader = context.get("x-data-source") || "main";
+    const dataSource = context.app.dataSourceManager.dataSources.get(dataSourceHeader);
+    if (!dataSource) {
+      context.logger.warn(`[Workflow pre-action]: data source "${dataSourceHeader}" not found`);
+      return next();
+    }
+    const collection = dataSource.collectionManager.getCollection(resourceName);
+    if (!collection) {
+      context.logger.warn(`[Workflow pre-action]: collection "${resourceName}" not found`);
+      return next();
+    }
+    const fullCollectionName = (0, import_data_source_manager.joinCollectionName)(dataSourceHeader, collection.name);
+    const triggerWorkflowsMap = /* @__PURE__ */ new Map();
+    const triggerWorkflowsArray = [];
+    for (const trigger of triggerWorkflows.split(",")) {
+      const [key, path] = trigger.split("!");
+      triggerWorkflowsMap.set(key, path);
+      triggerWorkflowsArray.push(key);
+    }
+    const workflows = Array.from(this.workflow.enabledCache.values()).filter(
+      (item) => item.type === this.constructor.TYPE && item.config.collection === fullCollectionName
+    );
+    const globalWorkflows = workflows.filter((item) => {
+      var _a;
+      return item.config.global && ((_a = item.config.actions) == null ? void 0 : _a.includes(actionName));
+    }).sort((a, b) => a.id - b.id);
+    const localWorkflows = workflows.filter((item) => !item.config.global).sort((a, b) => {
+      const aIndex = triggerWorkflowsArray.indexOf(a.key);
+      const bIndex = triggerWorkflowsArray.indexOf(b.key);
+      if (aIndex === -1 && bIndex === -1) {
+        return a.id - b.id;
+      }
+      if (aIndex === -1) {
+        return 1;
+      }
+      if (bIndex === -1) {
+        return -1;
+      }
+      return aIndex - bIndex;
+    });
+    for (const workflow of localWorkflows.concat(globalWorkflows)) {
+      if (!workflow.config.global && !triggerWorkflowsMap.has(workflow.key)) {
+        continue;
+      }
+      const processor = await this.workflow.trigger(
+        workflow,
+        {
+          user: context.state.currentUser,
+          roleName: context.state.currentRole,
+          params: {
+            filterByTk,
+            filter,
+            values
+          }
+        },
+        { httpContext: context }
+      );
+      if (!processor) {
+        return context.throw(500);
+      }
+      const { lastSavedJob, nodesMap } = processor;
+      const lastNode = nodesMap.get(lastSavedJob == null ? void 0 : lastSavedJob.nodeId);
+      if (processor.execution.status === import_plugin_workflow.EXECUTION_STATUS.RESOLVED) {
+        if ((lastNode == null ? void 0 : lastNode.type) === "end") {
+          return;
+        }
+        continue;
+      }
+      if (processor.execution.status < import_plugin_workflow.EXECUTION_STATUS.STARTED) {
+        if ((lastNode == null ? void 0 : lastNode.type) !== "end") {
+          return context.throw(500, "Workflow on your action failed, please contact the administrator");
+        }
+        const err = new RequestInterceptionError("Request is intercepted by workflow");
+        err.status = 400;
+        err.messages = context.state.messages;
+        return context.throw(err.status, err);
+      }
+      return context.throw(500, "Workflow on your action hangs, please contact the administrator");
+    }
+    await next();
+  };
+  constructor(workflow) {
+    super(workflow);
+    workflow.app.dataSourceManager.use(this.middleware);
+    workflow.app.pm.get(import_plugin_error_handler.default).errorHandler.register(
+      (err) => err instanceof RequestInterceptionError || err.name === "RequestInterceptionError",
+      async (err, ctx, next) => {
+        ctx.body = {
+          errors: err.messages
+        };
+        ctx.status = err.status;
+      }
+    );
+  }
+  validateContext(values) {
+    if (!values.target) {
+      return {
+        target: "Target data or key is required"
+      };
+    }
+    if (!values.userId) {
+      return {
+        userId: "UserId is required"
+      };
+    }
+    return null;
+  }
+  async execute(workflow, values, options) {
+    var _a;
+    const [dataSourceName, collectionName] = (0, import_data_source_manager.parseCollectionName)(workflow.config.collection);
+    const dataSource = this.workflow.app.dataSourceManager.dataSources.get(dataSourceName);
+    if (!dataSource) {
+      throw new Error(`Data source ${dataSourceName} not found`);
+    }
+    const collection = dataSource.collectionManager.getCollection(collectionName);
+    if (!collection) {
+      throw new Error(`Collection ${collectionName} not found`);
+    }
+    const { filterTargetKey, repository } = collection;
+    let { target } = values;
+    let filterByTk;
+    let loadNeeded = false;
+    if (target && typeof target === "object") {
+      filterByTk = Array.isArray(filterTargetKey) ? (0, import_lodash.pick)(target, filterTargetKey) : target[filterTargetKey];
+    } else {
+      filterByTk = target;
+      loadNeeded = true;
+    }
+    if (loadNeeded) {
+      target = await repository.findOne({
+        filterByTk
+      });
+    }
+    const params = values.action === import_constants.INTERCEPTABLE_ACTIONS.DESTROY ? { filterByTk } : { values: target };
+    const UserRepo = this.workflow.app.db.getRepository("users");
+    const actor = await UserRepo.findOne({
+      filterByTk: values.userId,
+      appends: ["roles"]
+    });
+    if (!actor) {
+      throw new Error("user not found");
+    }
+    const { roles, ...user } = actor.desensitize().get();
+    const roleName = values.roleName || ((_a = roles == null ? void 0 : roles[0]) == null ? void 0 : _a.name);
+    return this.workflow.trigger(
+      workflow,
+      {
+        params,
+        user,
+        roleName
+      },
+      options
+    );
+  }
+}

package/dist/server/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This program is offered under a commercial license.
+ * For more information, see <https://www.nocobase.com/agreement>
+ */
+export { default } from './Plugin';

package/dist/server/index.js

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

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@nocobase/plugin-workflow-request-interceptor",
+  "version": "2.0.3",
+  "displayName": "Workflow: Pre-action event",
+  "displayName.zh-CN": "工作流：操作前事件",
+  "description": "Triggered before the execution of a request initiated through an action button or API, such as before adding, updating, or deleting data. Suitable for data validation and logic judgment before action, and the request could be rejected by using the \"End process\" node.",
+  "description.zh-CN": "通过操作按钮或 API 发起请求并在执行前触发，比如新增、更新、删除数据之前。适用于在操作前进行数据验证、逻辑判断，并可通过“结束节点”来拦截请求。",
+  "main": "./dist/server/index.js",
+  "homepage": "https://docs.nocobase.com/handbook/workflow-request-interceptor",
+  "homepage.zh-CN": "https://docs-cn.nocobase.com/handbook/workflow-request-interceptor",
+  "peerDependencies": {
+    "@nocobase/client": "2.x",
+    "@nocobase/plugin-error-handler": "2.x",
+    "@nocobase/plugin-users": "2.x",
+    "@nocobase/plugin-workflow": ">= 0.19.0-alpha.3",
+    "@nocobase/server": "2.x",
+    "@nocobase/test": "2.x",
+    "@nocobase/utils": "2.x"
+  },
+  "nocobase": {
+    "supportedVersions": [
+      "1.x",
+      "2.x"
+    ],
+    "editionLevel": 0
+  },
+  "keywords": [
+    "Workflow"
+  ],
+  "gitHead": "5bcb42fc092f85adb9511c1a351b388bd7aaf66e",
+  "license": "Apache-2.0"
+}

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');