@nocobase/plugin-workflow 2.1.0-alpha.1 → 2.1.0-alpha.11

package/dist/server/instructions/OutputInstruction.js

@@ -0,0 +1,54 @@
+/**
+ * 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 __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 OutputInstruction_exports = {};
+__export(OutputInstruction_exports, {
+  default: () => ExecutionResultInstruction
+});
+module.exports = __toCommonJS(OutputInstruction_exports);
+var import__ = require(".");
+var import_constants = require("../constants");
+class ExecutionResultInstruction extends import__.Instruction {
+  async run(node, prevJob, processor) {
+    const { value } = node.config;
+    const output = processor.getParsedValue(value, node.id);
+    try {
+      await processor.execution.update({ output }, { hooks: false, transaction: processor.mainTransaction });
+    } catch (e) {
+      return {
+        result: e.message,
+        status: import_constants.JOB_STATUS.FAILED
+      };
+    }
+    return {
+      result: output,
+      status: import_constants.JOB_STATUS.RESOLVED
+    };
+  }
+  async resume(node, job, processor) {
+    return job;
+  }
+}

package/dist/server/instructions/QueryInstruction.d.ts

@@ -6,10 +6,13 @@
  * 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 Joi from 'joi';
 import type Processor from '../Processor';
 import type { FlowNodeModel } from '../types';
 import { Instruction } from '.';
 export declare class QueryInstruction extends Instruction {
+    configSchema: Joi.ObjectSchema<any>;
+    validateConfig(config: Record<string, any>): Record<string, string>;
     run(node: FlowNodeModel, input: any, processor: Processor): Promise<{
         result: any;
         status: -1;

package/dist/server/instructions/QueryInstruction.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,6 +25,14 @@ 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 QueryInstruction_exports = {};
 __export(QueryInstruction_exports, {
@@ -30,12 +40,23 @@ __export(QueryInstruction_exports, {
   default: () => QueryInstruction_default
 });
 module.exports = __toCommonJS(QueryInstruction_exports);
+var import_joi = __toESM(require("joi"));
 var import_actions = require("@nocobase/actions");
 var import_data_source_manager = require("@nocobase/data-source-manager");
 var import_constants = require("../constants");
 var import_utils = require("../utils");
 var import__ = require(".");
 class QueryInstruction extends import__.Instruction {
+  configSchema = import_joi.default.object({
+    collection: import_joi.default.string().required().messages({ "any.required": "Collection is not configured" })
+  });
+  validateConfig(config) {
+    const errors = super.validateConfig(config);
+    if (errors) {
+      return errors;
+    }
+    return (0, import_utils.validateCollectionField)(config.collection, this.workflow.app.dataSourceManager);
+  }
   async run(node, input, processor) {
     const { collection, multiple, params = {}, failOnEmpty = false } = node.config;
     const [dataSourceName, collectionName] = (0, import_data_source_manager.parseCollectionName)(collection);

package/dist/server/instructions/UpdateInstruction.d.ts

@@ -6,10 +6,13 @@
  * 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 Joi from 'joi';
 import type Processor from '../Processor';
 import type { FlowNodeModel } from '../types';
 import { Instruction } from '.';
 export declare class UpdateInstruction extends Instruction {
+    configSchema: Joi.ObjectSchema<any>;
+    validateConfig(config: Record<string, any>): Record<string, string>;
     run(node: FlowNodeModel, input: any, processor: Processor): Promise<{
         result: any;
         status: 1;

package/dist/server/instructions/UpdateInstruction.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,6 +25,14 @@ 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 UpdateInstruction_exports = {};
 __export(UpdateInstruction_exports, {
@@ -30,10 +40,22 @@ __export(UpdateInstruction_exports, {
   default: () => UpdateInstruction_default
 });
 module.exports = __toCommonJS(UpdateInstruction_exports);
+var import_joi = __toESM(require("joi"));
 var import_data_source_manager = require("@nocobase/data-source-manager");
 var import_constants = require("../constants");
+var import_utils = require("../utils");
 var import__ = require(".");
 class UpdateInstruction extends import__.Instruction {
+  configSchema = import_joi.default.object({
+    collection: import_joi.default.string().required().messages({ "any.required": "Collection is not configured" })
+  });
+  validateConfig(config) {
+    const errors = super.validateConfig(config);
+    if (errors) {
+      return errors;
+    }
+    return (0, import_utils.validateCollectionField)(config.collection, this.workflow.app.dataSourceManager);
+  }
   async run(node, input, processor) {
     const { collection, params = {} } = node.config;
     const [dataSourceName, collectionName] = (0, import_data_source_manager.parseCollectionName)(collection);

package/dist/server/instructions/index.d.ts

@@ -6,6 +6,7 @@
  * 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 Joi from 'joi';
 import { Transactionable } from '@nocobase/database';
 import type Plugin from '../Plugin';
 import type Processor from '../Processor';
@@ -24,11 +25,14 @@ export type InstructionInterface = {
     duplicateConfig?: (node: FlowNodeModel, options: Transactionable & {
         origin?: FlowNodeModel;
     }) => object | Promise<object>;
+    validateConfig?: (config: Record<string, any>) => Record<string, string> | null;
     test?: (config: Record<string, any>) => IJob | Promise<IJob>;
 };
 export declare abstract class Instruction implements InstructionInterface {
     workflow: Plugin;
+    configSchema?: Joi.ObjectSchema;
     constructor(workflow: Plugin);
+    validateConfig(config: Record<string, any>): Record<string, string> | null;
     abstract run(node: FlowNodeModel, input: any, processor: Processor): InstructionResult;
 }
 export default Instruction;

package/dist/server/instructions/index.js

@@ -34,6 +34,24 @@ class Instruction {
   constructor(workflow) {
     this.workflow = workflow;
   }
+  configSchema;
+  validateConfig(config) {
+    if (!this.configSchema) {
+      return null;
+    }
+    const { error } = this.configSchema.validate(config, { abortEarly: false, allowUnknown: true });
+    if (!error) {
+      return null;
+    }
+    const errors = {};
+    for (const detail of error.details) {
+      const key = detail.path.join(".");
+      if (!errors[key]) {
+        errors[key] = detail.message;
+      }
+    }
+    return errors;
+  }
 }
 var instructions_default = Instruction;
 // Annotate the CommonJS export names for ESM import in node:

package/dist/server/repositories/WorkflowRepository.js

@@ -97,7 +97,8 @@ class WorkflowRepository extends import_database.Repository {
           { transaction }
         );
         if (typeof instruction.duplicateConfig === "function") {
-          await instruction.duplicateConfig(newNode, { origin: node, transaction });
+          const newConfig = await instruction.duplicateConfig(newNode, { origin: node, transaction });
+          await newNode.update({ config: newConfig }, { transaction });
         }
         oldToNew.set(node.id, newNode);
         newToOld.set(newNode.id, node);

package/dist/server/triggers/CollectionTrigger.d.ts

@@ -6,6 +6,7 @@
  * 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 Joi from 'joi';
 import { Model } from '@nocobase/database';
 import Trigger from '.';
 import type { WorkflowModel } from '../types';
@@ -18,6 +19,8 @@ export interface CollectionChangeTriggerConfig {
 }
 export default class CollectionTrigger extends Trigger {
     readonly workflow: PluginWorkflowServer;
+    configSchema: Joi.ObjectSchema<any>;
+    validateConfig(config: Record<string, any>): Record<string, string>;
     events: Map<any, any>;
     constructor(workflow: PluginWorkflowServer);
     private static handler;

package/dist/server/triggers/CollectionTrigger.js

@@ -39,6 +39,7 @@ __export(CollectionTrigger_exports, {
   default: () => CollectionTrigger
 });
 module.exports = __toCommonJS(CollectionTrigger_exports);
+var import_joi = __toESM(require("joi"));
 var import_lodash = require("lodash");
 var import_utils = require("@nocobase/utils");
 var import_database = require("@nocobase/database");
@@ -81,6 +82,28 @@ class CollectionTrigger extends import__.default {
       }
     });
   }
+  configSchema = import_joi.default.object({
+    collection: import_joi.default.string().required(),
+    mode: import_joi.default.number().valid(...Object.values(MODE_BITMAP)),
+    changed: import_joi.default.when("mode", {
+      is: (mode) => (mode & MODE_BITMAP.UPDATE) === MODE_BITMAP.UPDATE,
+      then: import_joi.default.array().items(import_joi.default.string()).optional(),
+      otherwise: import_joi.default.forbidden()
+    }),
+    condition: import_joi.default.object(),
+    appends: import_joi.default.when("mode", {
+      is: (mode) => mode !== MODE_BITMAP.DESTROY,
+      then: import_joi.default.array().items(import_joi.default.string()).optional(),
+      otherwise: import_joi.default.forbidden()
+    })
+  });
+  validateConfig(config) {
+    const errors = super.validateConfig(config);
+    if (errors) {
+      return errors;
+    }
+    return (0, import_utils2.validateCollectionField)(config.collection, this.workflow.app.dataSourceManager);
+  }
   events = /* @__PURE__ */ new Map();
   // async function, should return promise
   static async handler(workflowId, eventType, data, options) {

package/dist/server/triggers/ScheduleTrigger/index.d.ts

@@ -6,10 +6,13 @@
  * 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 Joi from 'joi';
 import Trigger from '..';
 import type Plugin from '../../Plugin';
 import { WorkflowModel } from '../../types';
 export default class ScheduleTrigger extends Trigger {
+    configSchema: Joi.ObjectSchema<any>;
+    validateConfig(config: Record<string, any>): Record<string, string>;
     sync: boolean;
     private modes;
     constructor(workflow: Plugin);

package/dist/server/triggers/ScheduleTrigger/index.js

@@ -39,17 +39,32 @@ __export(ScheduleTrigger_exports, {
   default: () => ScheduleTrigger
 });
 module.exports = __toCommonJS(ScheduleTrigger_exports);
+var import_joi = __toESM(require("joi"));
 var import__ = __toESM(require(".."));
+var import_utils = require("../../utils");
 var import_DateFieldScheduleTrigger = __toESM(require("./DateFieldScheduleTrigger"));
 var import_StaticScheduleTrigger = __toESM(require("./StaticScheduleTrigger"));
-var import_utils = require("./utils");
+var import_utils2 = require("./utils");
 class ScheduleTrigger extends import__.default {
+  configSchema = import_joi.default.object({
+    mode: import_joi.default.number().valid(import_utils2.SCHEDULE_MODE.STATIC, import_utils2.SCHEDULE_MODE.DATE_FIELD)
+  });
+  validateConfig(config) {
+    const errors = super.validateConfig(config);
+    if (errors) {
+      return errors;
+    }
+    if (config.mode === import_utils2.SCHEDULE_MODE.DATE_FIELD && config.collection) {
+      return (0, import_utils.validateCollectionField)(config.collection, this.workflow.app.dataSourceManager);
+    }
+    return null;
+  }
   sync = false;
   modes = /* @__PURE__ */ new Map();
   constructor(workflow) {
     super(workflow);
-    this.modes.set(import_utils.SCHEDULE_MODE.STATIC, new import_StaticScheduleTrigger.default(workflow));
-    this.modes.set(import_utils.SCHEDULE_MODE.DATE_FIELD, new import_DateFieldScheduleTrigger.default(workflow));
+    this.modes.set(import_utils2.SCHEDULE_MODE.STATIC, new import_StaticScheduleTrigger.default(workflow));
+    this.modes.set(import_utils2.SCHEDULE_MODE.DATE_FIELD, new import_DateFieldScheduleTrigger.default(workflow));
   }
   getTrigger(mode) {
     return this.modes.get(mode);

package/dist/server/triggers/index.d.ts

@@ -6,12 +6,14 @@
  * 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 Joi from 'joi';
 import { Transactionable } from '@nocobase/database';
 import type Plugin from '../Plugin';
 import type { WorkflowModel } from '../types';
 import Processor from '../Processor';
 export declare abstract class Trigger {
     readonly workflow: Plugin;
+    configSchema?: Joi.ObjectSchema;
     constructor(workflow: Plugin);
     on(workflow: WorkflowModel): void;
     off(workflow: WorkflowModel): void;
@@ -19,6 +21,7 @@ export declare abstract class Trigger {
     duplicateConfig?(workflow: WorkflowModel, options: Transactionable & {
         origin?: WorkflowModel;
     }): object | Promise<object>;
+    validateConfig(config: Record<string, any>): Record<string, string> | null;
     validateContext?(values: any, workflow: WorkflowModel): null | void | {
         [key: string]: string;
     };

package/dist/server/triggers/index.js

@@ -34,6 +34,7 @@ class Trigger {
   constructor(workflow) {
     this.workflow = workflow;
   }
+  configSchema;
   on(workflow) {
   }
   off(workflow) {
@@ -41,6 +42,23 @@ class Trigger {
   validateEvent(workflow, context, options) {
     return true;
   }
+  validateConfig(config) {
+    if (!this.configSchema) {
+      return null;
+    }
+    const { error } = this.configSchema.validate(config, { abortEarly: false, allowUnknown: true });
+    if (!error) {
+      return null;
+    }
+    const errors = {};
+    for (const detail of error.details) {
+      const key = detail.path.join(".");
+      if (!errors[key]) {
+        errors[key] = detail.message;
+      }
+    }
+    return errors;
+  }
   sync;
 }
 var triggers_default = Trigger;

package/dist/server/utils.d.ts

@@ -6,4 +6,6 @@
  * 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 type { DataSourceManager } from '@nocobase/data-source-manager';
+export declare function validateCollectionField(collection: string, dataSourceManager: DataSourceManager): Record<string, string> | null;
 export declare function toJSON(data: any): any;

package/dist/server/utils.js

@@ -26,10 +26,29 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var utils_exports = {};
 __export(utils_exports, {
-  toJSON: () => toJSON
+  toJSON: () => toJSON,
+  validateCollectionField: () => validateCollectionField
 });
 module.exports = __toCommonJS(utils_exports);
 var import_database = require("@nocobase/database");
+var import_data_source_manager = require("@nocobase/data-source-manager");
+function validateCollectionField(collection, dataSourceManager) {
+  const [dataSourceName, collectionName] = (0, import_data_source_manager.parseCollectionName)(collection);
+  if (collection.includes(":")) {
+    const parts = collection.split(":");
+    if (parts.length !== 2 || !parts[0] || !parts[1]) {
+      return { collection: `"collection" must be in the format "dataSourceName:collectionName"` };
+    }
+  }
+  const dataSource = dataSourceManager.dataSources.get(dataSourceName);
+  if (!dataSource) {
+    return { collection: `Data source "${dataSourceName}" does not exist` };
+  }
+  if (!dataSource.collectionManager.getCollection(collectionName)) {
+    return { collection: `Collection "${collectionName}" does not exist in data source "${dataSourceName}"` };
+  }
+  return null;
+}
 function toJSON(data) {
   if (Array.isArray(data)) {
     return data.map(toJSON);
@@ -47,5 +66,6 @@ function toJSON(data) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  toJSON
+  toJSON,
+  validateCollectionField
 });