@nocobase/plugin-workflow 0.7.0-alpha.9 → 0.7.1-alpha.6

package/lib/models/Workflow.js

@@ -1,78 +1,20 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const database_1 = require("@nocobase/database");
-const triggers_1 = __importDefault(require("../triggers"));
-const constants_1 = require("../constants");
-class WorkflowModel extends database_1.Model {
-    static mount() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const collection = this.database.getCollection('workflows');
-            const workflows = yield collection.repository.find({
-                filter: { enabled: true },
-            });
-            workflows.forEach((workflow) => {
-                workflow.toggle();
-            });
-            this.addHook('afterCreate', (model) => model.toggle());
-            this.addHook('afterUpdate', (model) => model.toggle());
-            this.addHook('afterDestroy', (model) => model.toggle(false));
-        });
-    }
-    getHookId() {
-        return `workflow-${this.get('id')}`;
-    }
-    getTransaction(options) {
-        if (!this.useTransaction) {
-            return undefined;
-        }
-        return options.transaction && !options.transaction.finished
-            ? options.transaction
-            : this.constructor.database.sequelize.transaction();
-    }
-    toggle(enable) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const type = this.get('type');
-            const { on, off } = triggers_1.default.get(type);
-            if (typeof enable !== 'undefined' ? enable : this.get('enabled')) {
-                on.call(this, this.trigger.bind(this));
-            }
-            else {
-                off.call(this);
-            }
-        });
-    }
-    trigger(context, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // `null` means not to trigger
-            if (context === null) {
-                return;
-            }
-            const transaction = yield this.getTransaction(options);
-            const execution = yield this.createExecution({
-                context,
-                status: constants_1.EXECUTION_STATUS.STARTED,
-                useTransaction: this.useTransaction
-            }, { transaction });
-            execution.workflow = this;
-            yield execution.start({ transaction });
-            if (transaction && (!options.transaction || options.transaction.finished)) {
-                yield transaction.commit();
-            }
-            return execution;
-        });
-    }
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+function _database() {
+  const data = require("@nocobase/database");
+
+  _database = function _database() {
+    return data;
+  };
+
+  return data;
 }
-exports.default = WorkflowModel;
-//# sourceMappingURL=Workflow.js.map
+
+class WorkflowModel extends _database().Model {}
+
+exports.default = WorkflowModel;

package/lib/triggers/collection.d.ts

@@ -0,0 +1,12 @@
+import { Trigger } from "..";
+import WorkflowModel from "../models/Workflow";
+export interface CollectionChangeTriggerConfig {
+    collection: string;
+    mode: number;
+    condition: any;
+}
+export default class CollectionTrigger extends Trigger {
+    events: Map<any, any>;
+    on(workflow: WorkflowModel): void;
+    off(workflow: WorkflowModel): void;
+}

package/lib/triggers/collection.js

@@ -0,0 +1,184 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _ = require("..");
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e2) { throw _e2; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e3) { didErr = true; err = _e3; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+
+const MODE_BITMAP = {
+  CREATE: 1,
+  UPDATE: 2,
+  DESTROY: 4
+};
+const MODE_BITMAP_EVENTS = new Map();
+MODE_BITMAP_EVENTS.set(MODE_BITMAP.CREATE, 'afterCreateWithAssociations');
+MODE_BITMAP_EVENTS.set(MODE_BITMAP.UPDATE, 'afterUpdateWithAssociations');
+MODE_BITMAP_EVENTS.set(MODE_BITMAP.DESTROY, 'afterDestroy');
+
+function getHookId(workflow, type) {
+  return `${type}#${workflow.id}`;
+} // async function, should return promise
+
+
+function handler(_x, _x2, _x3) {
+  return _handler.apply(this, arguments);
+}
+
+function _handler() {
+  _handler = _asyncToGenerator(function* (workflow, data, options) {
+    var _condition$$and;
+
+    const _workflow$config3 = workflow.config,
+          collection = _workflow$config3.collection,
+          condition = _workflow$config3.condition,
+          changed = _workflow$config3.changed; // NOTE: if no configured fields changed, do not trigger
+
+    if (changed && changed.length && changed.every(name => !data.changed(name))) {// TODO: temp comment out
+      // return;
+    } // NOTE: if no configured condition match, do not trigger
+
+
+    if (condition && ((_condition$$and = condition.$and) === null || _condition$$and === void 0 ? void 0 : _condition$$and.length)) {
+      // TODO: change to map filter format to calculation format
+      // const calculation = toCalculation(condition);
+      const _data$constructor$dat = data.constructor.database.getCollection(collection),
+            repository = _data$constructor$dat.repository,
+            model = _data$constructor$dat.model;
+
+      const transaction = options.transaction;
+      const count = yield repository.count({
+        filter: {
+          $and: [condition, {
+            [model.primaryKeyAttribute]: data[model.primaryKeyAttribute]
+          }]
+        },
+        transaction
+      });
+
+      if (!count) {
+        return;
+      }
+    }
+
+    return this.plugin.trigger(workflow, {
+      data: data.get()
+    }, {
+      transaction: options.transaction
+    });
+  });
+  return _handler.apply(this, arguments);
+}
+
+class CollectionTrigger extends _.Trigger {
+  constructor(...args) {
+    super(...args);
+    this.events = new Map();
+  }
+
+  on(workflow) {
+    const db = this.plugin.app.db;
+    const _workflow$config = workflow.config,
+          collection = _workflow$config.collection,
+          mode = _workflow$config.mode;
+    const Collection = db.getCollection(collection);
+
+    if (!Collection) {
+      return;
+    }
+
+    var _iterator = _createForOfIteratorHelper(MODE_BITMAP_EVENTS.entries()),
+        _step;
+
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        let _step$value = _slicedToArray(_step.value, 2),
+            key = _step$value[0],
+            type = _step$value[1];
+
+        const event = `${collection}.${type}`;
+        const name = getHookId(workflow, event);
+
+        if (mode & key) {
+          if (!this.events.has(name)) {
+            const listener = handler.bind(this, workflow);
+            this.events.set(name, listener);
+            db.on(event, listener);
+          }
+        } else {
+          const listener = this.events.get(name);
+
+          if (listener) {
+            db.off(event, listener);
+            this.events.delete(name);
+          }
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+  }
+
+  off(workflow) {
+    const db = this.plugin.app.db;
+    const _workflow$config2 = workflow.config,
+          collection = _workflow$config2.collection,
+          mode = _workflow$config2.mode;
+    const Collection = db.getCollection(collection);
+
+    if (!Collection) {
+      return;
+    }
+
+    var _iterator2 = _createForOfIteratorHelper(MODE_BITMAP_EVENTS.entries()),
+        _step2;
+
+    try {
+      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+        let _step2$value = _slicedToArray(_step2.value, 2),
+            key = _step2$value[0],
+            type = _step2$value[1];
+
+        const event = `${collection}.${type}`;
+        const name = getHookId(workflow, event);
+
+        if (mode & key) {
+          const listener = this.events.get(name);
+
+          if (listener) {
+            db.off(event, listener);
+            this.events.delete(name);
+          }
+        }
+      }
+    } catch (err) {
+      _iterator2.e(err);
+    } finally {
+      _iterator2.f();
+    }
+  }
+
+}
+
+exports.default = CollectionTrigger;

package/lib/triggers/index.d.ts

@@ -1,9 +1,13 @@
-import { Registry } from '@nocobase/utils';
+import Plugin from '..';
 import WorkflowModel from '../models/Workflow';
-export interface Trigger {
-    name: string;
-    on(this: WorkflowModel, callback: Function): void;
-    off(this: WorkflowModel): void;
+export declare abstract class Trigger {
+    readonly plugin: Plugin;
+    constructor(plugin: Plugin);
+    abstract on(workflow: WorkflowModel): void;
+    abstract off(workflow: WorkflowModel): void;
 }
-export declare const triggers: Registry<Trigger>;
-export default triggers;
+export default function <T extends Trigger>(plugin: any, more?: {
+    [key: string]: {
+        new (p: Plugin): T;
+    };
+}): void;

package/lib/triggers/index.js

@@ -1,12 +1,65 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.triggers = void 0;
-const utils_1 = require("@nocobase/utils");
-const model_1 = __importDefault(require("./model"));
-exports.triggers = new utils_1.Registry();
-exports.default = exports.triggers;
-exports.triggers.register(model_1.default.name, model_1.default);
-//# sourceMappingURL=index.js.map
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Trigger = void 0;
+exports.default = _default;
+
+function _path() {
+  const data = _interopRequireDefault(require("path"));
+
+  _path = function _path() {
+    return data;
+  };
+
+  return data;
+}
+
+function _utils() {
+  const data = require("@nocobase/utils");
+
+  _utils = function _utils() {
+    return data;
+  };
+
+  return data;
+}
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+class Trigger {
+  constructor(plugin) {
+    this.plugin = void 0;
+    this.plugin = plugin;
+  }
+
+}
+
+exports.Trigger = Trigger;
+
+function _default(plugin, more = {}) {
+  const triggers = plugin.triggers;
+  triggers.register('collection', new ((0, _utils().requireModule)(_path().default.join(__dirname, 'collection')))(plugin));
+  triggers.register('schedule', new ((0, _utils().requireModule)(_path().default.join(__dirname, 'schedule')))(plugin));
+
+  for (var _i = 0, _Object$entries = Object.entries(more); _i < _Object$entries.length; _i++) {
+    const _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+          name = _Object$entries$_i[0],
+          TClass = _Object$entries$_i[1];
+
+    triggers.register(name, new TClass(plugin));
+  }
+}

package/lib/triggers/schedule.d.ts

@@ -0,0 +1,38 @@
+import Plugin, { Trigger } from '..';
+export declare type ScheduleOnField = string | {
+    field: string;
+    offset?: number;
+    unit?: 1000 | 60000 | 3600000 | 86400000;
+};
+export interface ScheduleTriggerConfig {
+    mode: number;
+    repeat?: string | number | null;
+    limit?: number;
+    startsOn?: ScheduleOnField;
+    endsOn?: ScheduleOnField;
+}
+export declare const SCHEDULE_MODE: {
+    readonly CONSTANT: 0;
+    readonly COLLECTION_FIELD: 1;
+};
+export default class ScheduleTrigger extends Trigger {
+    static CacheRules: ((workflow: any, now: any) => any)[];
+    static TriggerRules: ((workflow: any, now: any) => boolean)[];
+    events: Map<any, any>;
+    private timer;
+    private cache;
+    interval: number;
+    cacheCycle: number;
+    constructor(plugin: Plugin);
+    init(): void;
+    run: () => void;
+    onTick(now: any): Promise<any>;
+    reload(): Promise<void>;
+    inspect(workflows: any): void;
+    setCache(workflow: any, out?: boolean): void;
+    shouldCache(workflow: any, now: any): Promise<boolean>;
+    shouldTrigger(workflow: any, now: any): boolean;
+    trigger(workflow: any, date: Date): Promise<any>;
+    on(workflow: any): void;
+    off(workflow: any): void;
+}