@onify/flow-extensions 5.0.1 → 6.0.0

package/CHANGELOG.md

@@ -1,6 +1,15 @@
 Changelog
 =========
 
+# 6.0.0
+
+- Require peer dependency `bpmn-elements >= 8`
+- Support timer event definition cron time cycle by overloading parse function. Requires `bpmn-elements >= 10`
+
+# 5.0.2
+
+- Correct package module file...
+
 # 5.0.1
 
 - Doh! Add neglected package.json file to common js dist folder

package/dist/FlowScripts.js

@@ -123,7 +123,6 @@ JavaScript.prototype.execute = async function execute(executionContext, callback
       console: {
         log: console.log // eslint-disable-line no-console
       },
-
       Buffer: {
         from: Buffer.from
       },

package/dist/OnifyTimerEventDefinition.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.OnifyTimerEventDefinition = void 0;
+var _bpmnElements = require("bpmn-elements");
+var _cronParser = _interopRequireDefault(require("cron-parser"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+class OnifyTimerEventDefinition extends _bpmnElements.TimerEventDefinition {
+  constructor(activity, def) {
+    super(activity, def);
+    Object.defineProperty(this, 'supports', {
+      value: ['cron']
+    });
+  }
+  parse(timerType, value) {
+    let cron;
+    if (timerType === 'timeCycle' && (cron = _cronParser.default.parseString(value))) {
+      var _cron$expressions;
+      if ((_cron$expressions = cron.expressions) !== null && _cron$expressions !== void 0 && _cron$expressions.length) {
+        // cronParser.parseString expressions disregards seconds, so we have to parse again
+        const expireAt = _cronParser.default.parseExpression(value).next().toDate();
+        return {
+          expireAt,
+          delay: expireAt - Date.now()
+        };
+      }
+    }
+    return super.parse(timerType, value);
+  }
+}
+exports.OnifyTimerEventDefinition = OnifyTimerEventDefinition;

package/dist/formatters.js

@@ -14,6 +14,8 @@ class FormatActivity {
     let timeCycles;
     if (activity.eventDefinitions) {
       for (const ed of activity.eventDefinitions.filter(e => e.type === 'bpmn:TimerEventDefinition')) {
+        var _ed$supports;
+        if ((_ed$supports = ed.supports) !== null && _ed$supports !== void 0 && _ed$supports.includes('cron')) continue;
         if (!('timeCycle' in ed)) continue;
         timeCycles = timeCycles || [];
         timeCycles.push(ed.timeCycle);

package/dist/index.js

@@ -9,11 +9,18 @@ Object.defineProperty(exports, "OnifySequenceFlow", {
     return _OnifySequenceFlow.OnifySequenceFlow;
   }
 });
+Object.defineProperty(exports, "OnifyTimerEventDefinition", {
+  enumerable: true,
+  get: function () {
+    return _OnifyTimerEventDefinition.OnifyTimerEventDefinition;
+  }
+});
 exports.extendFn = extendFn;
 exports.extensions = extensions;
 var _OnifyProcessExtensions = require("./OnifyProcessExtensions.js");
 var _OnifyElementExtensions = require("./OnifyElementExtensions.js");
 var _OnifySequenceFlow = require("./OnifySequenceFlow.js");
+var _OnifyTimerEventDefinition = require("./OnifyTimerEventDefinition.js");
 function extensions(element, context) {
   if (element.type === 'bpmn:Process') return new _OnifyProcessExtensions.OnifyProcessExtensions(element, context);
   return new _OnifyElementExtensions.OnifyElementExtensions(element, context);

package/index.d.ts

@@ -1,8 +1,11 @@
 declare module '@onify/flow-extensions' {
-  import { SequenceFlow, ElementBase, Context, IExtension } from 'bpmn-elements';
+  import { SequenceFlow, TimerEventDefinition, ElementBase, Context, IExtension } from 'bpmn-elements';
   import { extendFn as extendFunction } from 'moddle-context-serializer';
 
   export class OnifySequenceFlow extends SequenceFlow {}
+  export class OnifyTimerEventDefinition extends TimerEventDefinition {
+    readonly supports: string[];
+  }
   export function extensions(element: ElementBase, context: Context): IExtension;
   export const extendFn: extendFunction;
 }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@onify/flow-extensions",
-  "version": "5.0.1",
+  "version": "6.0.0",
   "description": "Onify Flow extensions",
   "type": "module",
-  "module": "index.js",
+  "module": "src/index.js",
   "main": "dist/index.js",
   "types": "./index.d.ts",
   "sideEffects": false,
@@ -38,26 +38,30 @@
   "license": "MIT",
   "devDependencies": {
     "@aircall/expression-parser": "^1.0.4",
-    "@babel/cli": "^7.21.5",
-    "@babel/core": "^7.21.8",
-    "@babel/preset-env": "^7.21.5",
-    "@babel/register": "^7.21.0",
+    "@babel/cli": "^7.23.4",
+    "@babel/core": "^7.23.5",
+    "@babel/preset-env": "^7.23.5",
+    "@babel/register": "^7.22.15",
     "bpmn-elements-8-1": "npm:bpmn-elements@8.1",
-    "bpmn-engine": "^16.0.0",
+    "bpmn-engine": "^17.1.1",
     "bpmn-engine-14": "npm:bpmn-engine@14",
     "bpmn-moddle": "^8.0.1",
-    "c8": "^7.13.0",
+    "c8": "^8.0.1",
     "camunda-bpmn-moddle": "^7.0.1",
-    "chai": "^4.3.7",
-    "chronokinesis": "^5.0.2",
+    "chai": "^4.3.10",
+    "chronokinesis": "^6.0.0",
     "debug": "^4.3.4",
-    "eslint": "^8.39.0",
+    "eslint": "^8.55.0",
+    "eslint-plugin-import": "^2.29.0",
     "mocha": "^10.2.0",
     "mocha-cakes-2": "^3.3.0",
-    "moddle-context-serializer": "^3.2.2"
+    "moddle-context-serializer": "^4.1.1"
+  },
+  "peerDependencies": {
+    "bpmn-elements": ">=8"
   },
   "dependencies": {
-    "cron-parser": "^4.8.1"
+    "cron-parser": "^4.9.0"
   },
   "files": [
     "src",

package/src/OnifyTimerEventDefinition.js

@@ -0,0 +1,25 @@
+import { TimerEventDefinition } from 'bpmn-elements';
+import cronParser from 'cron-parser';
+
+export class OnifyTimerEventDefinition extends TimerEventDefinition {
+  constructor(activity, def) {
+    super(activity, def);
+    Object.defineProperty(this, 'supports', {
+      value: ['cron'],
+    });
+  }
+  parse(timerType, value) {
+    let cron;
+    if (timerType === 'timeCycle' && (cron = cronParser.parseString(value))) {
+      if (cron.expressions?.length) {
+        // cronParser.parseString expressions disregards seconds, so we have to parse again
+        const expireAt = cronParser.parseExpression(value).next().toDate();
+        return {
+          expireAt,
+          delay: expireAt - Date.now(),
+        };
+      }
+    }
+    return super.parse(timerType, value);
+  }
+}

package/src/formatters.js

@@ -10,6 +10,7 @@ export class FormatActivity {
     let timeCycles;
     if (activity.eventDefinitions) {
       for (const ed of activity.eventDefinitions.filter((e) => e.type === 'bpmn:TimerEventDefinition')) {
+        if (ed.supports?.includes('cron')) continue;
         if (!('timeCycle' in ed)) continue;
         timeCycles = timeCycles || [];
         timeCycles.push(ed.timeCycle);

package/src/index.js

@@ -1,19 +1,14 @@
-import {OnifyProcessExtensions} from './OnifyProcessExtensions.js';
-import {OnifyElementExtensions} from './OnifyElementExtensions.js';
-import {OnifySequenceFlow} from './OnifySequenceFlow.js';
+import { OnifyProcessExtensions } from './OnifyProcessExtensions.js';
+import { OnifyElementExtensions } from './OnifyElementExtensions.js';
+export { OnifySequenceFlow } from './OnifySequenceFlow.js';
+export { OnifyTimerEventDefinition } from './OnifyTimerEventDefinition.js';
 
-export {
-  extensions,
-  extendFn,
-  OnifySequenceFlow,
-};
-
-function extensions(element, context) {
+export function extensions(element, context) {
   if (element.type === 'bpmn:Process') return new OnifyProcessExtensions(element, context);
   return new OnifyElementExtensions(element, context);
 }
 
-function extendFn(behaviour, context) {
+export function extendFn(behaviour, context) {
   if (behaviour.$type === 'bpmn:StartEvent' && behaviour.eventDefinitions) {
     const timer = behaviour.eventDefinitions.find(({type, behaviour: edBehaviour}) => edBehaviour && type === 'bpmn:TimerEventDefinition');
     if (timer && timer.behaviour.timeCycle) Object.assign(behaviour, {scheduledStart: timer.behaviour.timeCycle});