bpmn-client 1.0.3 → 1.2.5

package/src/interfaces/Enums.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NODE_SUBTYPE = exports.EXECUTION_STATUS = exports.TOKEN_STATUS = exports.ITEM_STATUS = exports.FLOW_ACTION = exports.NODE_ACTION = exports.EXECUTION_EVENT = exports.BPMN_TYPE = void 0;
+var BPMN_TYPE;
+(function (BPMN_TYPE) {
+    BPMN_TYPE["UserTask"] = "bpmn:UserTask";
+    BPMN_TYPE["ScriptTask"] = "bpmn:ScriptTask";
+    BPMN_TYPE["ServiceTask"] = "bpmn:ServiceTask";
+    BPMN_TYPE["SendTask"] = "bpmn:SendTask";
+    BPMN_TYPE["ReceiveTask"] = "bpmn:ReceiveTask";
+    BPMN_TYPE["BusinessRuleTask"] = "bpmn:BusinessRuleTask";
+    BPMN_TYPE["SubProcess"] = "bpmn:SubProces";
+    BPMN_TYPE["ParallelGateway"] = "bpmn:ParallelGateway";
+    BPMN_TYPE["EventBasedGateway"] = "bpmn:EventBasedGateway";
+    BPMN_TYPE["InclusiveGateway"] = "bpmn:InclusiveGateway";
+    BPMN_TYPE["ExclusiveGateway"] = "bpmn:ExclusiveGateway";
+    BPMN_TYPE["BoundaryEvent"] = "bpmn:BoundaryEvent";
+    BPMN_TYPE["StartEvent"] = "bpmn:StartEvent";
+    BPMN_TYPE["IntermediateCatchEvent"] = "bpmn:IntermediateCatchEvent";
+    BPMN_TYPE["IntermediateThrowEvent"] = "bpmn:IntermediateThrowEvent";
+    BPMN_TYPE["EndEvent"] = "bpmn:EndEvent";
+    BPMN_TYPE["SequenceFlow"] = "bpmn:SequenceFlow";
+    BPMN_TYPE["MessageFlow"] = "bpmn:MessageFlow";
+    BPMN_TYPE["CallActivity"] = "bpmn:CallActivity";
+})(BPMN_TYPE || (BPMN_TYPE = {}));
+exports.BPMN_TYPE = BPMN_TYPE;
+var NODE_SUBTYPE;
+(function (NODE_SUBTYPE) {
+    NODE_SUBTYPE["timer"] = "timer";
+    NODE_SUBTYPE["message"] = "message";
+    NODE_SUBTYPE["signal"] = "signal";
+    NODE_SUBTYPE["error"] = "error";
+    NODE_SUBTYPE["escalation"] = "escalation";
+})(NODE_SUBTYPE || (NODE_SUBTYPE = {}));
+exports.NODE_SUBTYPE = NODE_SUBTYPE;
+/*
+ * ALL events
+ */
+var EXECUTION_EVENT;
+(function (EXECUTION_EVENT) {
+    EXECUTION_EVENT["node_enter"] = "enter";
+    EXECUTION_EVENT["node_start"] = "start";
+    EXECUTION_EVENT["node_wait"] = "wait";
+    EXECUTION_EVENT["node_end"] = "end";
+    EXECUTION_EVENT["node_terminated"] = "terminated";
+    EXECUTION_EVENT["transform_input"] = "transformInput";
+    EXECUTION_EVENT["transform_output"] = "transformOutput";
+    EXECUTION_EVENT["flow_take"] = "take";
+    EXECUTION_EVENT["flow_discard"] = "discard";
+    EXECUTION_EVENT["process_loaded"] = "process.loaded";
+    EXECUTION_EVENT["process_start"] = "process.start";
+    EXECUTION_EVENT["process_started"] = "process.started";
+    EXECUTION_EVENT["process_invoke"] = "process.invoke";
+    EXECUTION_EVENT["process_invoked"] = "process.invoked";
+    EXECUTION_EVENT["process_restored"] = "process.restored";
+    EXECUTION_EVENT["process_resumed"] = "process_resumed";
+    EXECUTION_EVENT["process_wait"] = "process.wait";
+    EXECUTION_EVENT["process_end"] = "process.end";
+    EXECUTION_EVENT["process_terminated"] = "executeion.terminate";
+    EXECUTION_EVENT["token_start"] = "token.start";
+    EXECUTION_EVENT["token_wait"] = "token.wait";
+    EXECUTION_EVENT["token_end"] = "token.end";
+    EXECUTION_EVENT["token_terminated"] = "token.terminated";
+})(EXECUTION_EVENT || (EXECUTION_EVENT = {}));
+exports.EXECUTION_EVENT = EXECUTION_EVENT;
+/*
+ *  possible actions by node
+ */
+//   must be same as above
+var NODE_ACTION;
+(function (NODE_ACTION) {
+    NODE_ACTION[NODE_ACTION["continue"] = 1] = "continue";
+    NODE_ACTION[NODE_ACTION["wait"] = 2] = "wait";
+    NODE_ACTION[NODE_ACTION["end"] = 3] = "end";
+    NODE_ACTION[NODE_ACTION["stop"] = 4] = "stop";
+    NODE_ACTION[NODE_ACTION["error"] = 5] = "error";
+    NODE_ACTION[NODE_ACTION["abort"] = 6] = "abort";
+})(NODE_ACTION || (NODE_ACTION = {}));
+exports.NODE_ACTION = NODE_ACTION;
+;
+var ITEM_STATUS;
+(function (ITEM_STATUS) {
+    ITEM_STATUS["enter"] = "enter";
+    ITEM_STATUS["start"] = "start";
+    ITEM_STATUS["wait"] = "wait";
+    ITEM_STATUS["end"] = "end";
+    ITEM_STATUS["terminated"] = "terminated";
+    ITEM_STATUS["discard"] = "discard";
+})(ITEM_STATUS || (ITEM_STATUS = {}));
+exports.ITEM_STATUS = ITEM_STATUS;
+//type ITEMSTATUS = 'enter' | 'start' | 'wait' | 'end' | 'terminated' | 'discard';
+var EXECUTION_STATUS;
+(function (EXECUTION_STATUS) {
+    EXECUTION_STATUS["running"] = "running";
+    EXECUTION_STATUS["wait"] = "wait";
+    EXECUTION_STATUS["end"] = "end";
+    EXECUTION_STATUS["terminated"] = "terminated";
+})(EXECUTION_STATUS || (EXECUTION_STATUS = {}));
+exports.EXECUTION_STATUS = EXECUTION_STATUS;
+var TOKEN_STATUS;
+(function (TOKEN_STATUS) {
+    TOKEN_STATUS["running"] = "running";
+    TOKEN_STATUS["wait"] = "wait";
+    TOKEN_STATUS["end"] = "end";
+    TOKEN_STATUS["terminated"] = "terminated";
+})(TOKEN_STATUS || (TOKEN_STATUS = {}));
+exports.TOKEN_STATUS = TOKEN_STATUS;
+/*
+ * possible actions by flow
+ */
+//   must be same as above
+var FLOW_ACTION;
+(function (FLOW_ACTION) {
+    FLOW_ACTION["take"] = "take";
+    FLOW_ACTION["discard"] = "discard";
+})(FLOW_ACTION || (FLOW_ACTION = {}));
+exports.FLOW_ACTION = FLOW_ACTION;

package/src/interfaces/Enums.ts

@@ -0,0 +1,71 @@
+
+enum BPMN_TYPE {
+    UserTask = 'bpmn:UserTask',
+    ScriptTask = 'bpmn:ScriptTask',
+    ServiceTask = 'bpmn:ServiceTask',
+    SendTask = 'bpmn:SendTask',
+    ReceiveTask = 'bpmn:ReceiveTask',
+    BusinessRuleTask = 'bpmn:BusinessRuleTask',
+    SubProcess = 'bpmn:SubProces',
+    ParallelGateway = 'bpmn:ParallelGateway',
+    EventBasedGateway = 'bpmn:EventBasedGateway',
+    InclusiveGateway = 'bpmn:InclusiveGateway',
+    ExclusiveGateway = 'bpmn:ExclusiveGateway',
+    BoundaryEvent = 'bpmn:BoundaryEvent',
+    StartEvent = 'bpmn:StartEvent',
+    IntermediateCatchEvent = 'bpmn:IntermediateCatchEvent',
+    IntermediateThrowEvent = 'bpmn:IntermediateThrowEvent',
+    EndEvent = 'bpmn:EndEvent',
+    SequenceFlow = 'bpmn:SequenceFlow',
+    MessageFlow = 'bpmn:MessageFlow',
+    CallActivity = 'bpmn:CallActivity'
+}
+
+enum NODE_SUBTYPE {
+    timer = 'timer',
+    message = 'message',
+    signal = 'signal',
+    error = 'error',
+    escalation = 'escalation'
+}
+/*
+ * ALL events 
+ */
+enum EXECUTION_EVENT {
+    node_enter = 'enter', node_start = 'start', node_wait = 'wait', node_end = 'end', node_terminated = 'terminated',
+    transform_input = 'transformInput', transform_output ='transformOutput',
+    flow_take = 'take', flow_discard = 'discard',
+    process_loaded ='process.loaded',
+    process_start = 'process.start',   process_started = 'process.started',
+    process_invoke = 'process.invoke',     process_invoked = 'process.invoked',
+    process_restored = 'process.restored', process_resumed = 'process_resumed',
+    process_wait = 'process.wait',
+    process_end = 'process.end', process_terminated = 'executeion.terminate' ,
+    token_start = 'token.start', token_wait = 'token.wait', token_end = 'token.end', token_terminated = 'token.terminated' 
+}
+/*
+ *  possible actions by node
+ */
+//   must be same as above
+enum NODE_ACTION { continue = 1, wait,  end , stop , error , abort  };
+
+enum ITEM_STATUS {  enter = 'enter', start = 'start', wait = 'wait', end = 'end', terminated = 'terminated' , discard= 'discard'}
+
+//type ITEMSTATUS = 'enter' | 'start' | 'wait' | 'end' | 'terminated' | 'discard';
+
+enum EXECUTION_STATUS { running='running',wait='wait', end = 'end' , terminated ='terminated' }
+
+enum TOKEN_STATUS { running = 'running', wait = 'wait', end = 'end', terminated = 'terminated' }
+/*
+ * possible actions by flow
+ */
+//   must be same as above
+
+enum FLOW_ACTION { take = 'take', discard = 'discard' }
+
+
+export {
+    BPMN_TYPE ,
+    EXECUTION_EVENT, NODE_ACTION, FLOW_ACTION,
+    ITEM_STATUS, TOKEN_STATUS, EXECUTION_STATUS , NODE_SUBTYPE
+}

package/test/.eslintrc.json

@@ -0,0 +1,20 @@
+{
+  "env": {
+    "mocha": true
+  },
+  "rules": {
+    "no-unused-expressions": 0,
+    "no-var": 1,
+    "prefer-arrow-callback": 1
+  },
+  "globals": {
+    "expect": false,
+    "Feature": false,
+    "Scenario": false,
+    "Given": false,
+    "When": false,
+    "Then": false,
+    "And": false,
+    "But": false
+  }
+}

package/test/.mocharc.json

@@ -0,0 +1,12 @@
+{
+  "diff": true,
+  "extension": [ "js" ],
+  "package": "package.json",
+  "reporter": "spec",
+  "slow": 1500,
+  "timeout": 50000,
+  "recursive": true,
+  "file": [ "test/helpers/setup.js" ],
+  "ui": "mocha-cakes-2",
+  "watch-files": [ "test/feature/*.js" ]
+}

package/test/feature/.env

@@ -0,0 +1,5 @@
+API_KEY=1234
+MONGO_DB_URL=mongodb://localhost:27017?retryWrites=true&w=majority
+MONGO_DB_NAME=bpmn
+SENDGRID_API_KEY=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
+

package/test/feature/carServer.js

@@ -0,0 +1,122 @@
+const {  BPMNClient } = require("../../src/");
+
+
+
+const API_KEY = '12345';
+const HOST = 'localhost';
+const PORT = '3000';
+//const HOST = 'test.omniworkflow.com';
+//const PORT = '443';
+
+const BASE_URL = 'api';
+
+
+console.log('-------- car.js -----------');
+
+const server = new BPMNClient(HOST, PORT, API_KEY);
+
+var caseId = Math.floor(Math.random() * 10000);
+
+let name = 'Buy Used Car';
+let process;
+let response;
+let instanceId;
+
+Feature('Buy Used Car- clean and repair', () => {
+    Scenario('Simple', () => {
+        Given('Start Buy Used Car Process', async () => {
+            response = await server.engine.start(name, { caseId: caseId });
+            instanceId = response.id;
+            console.log('**instanceId', response.id, instanceId);
+            console.log(' after start ', response.data.caseId);
+        });
+        Then('check for output', () => {
+            expect(response.data.caseId).equals(caseId);
+            expect(getItem('task_Buy').status).equals('wait');
+        });
+
+        When('a process defintion is executed', async () => {
+
+            const data = { needsCleaning: "Yes", needsRepairs: "Yes" };
+            const query = {
+                id: instanceId,
+                "items.elementId": 'task_Buy'
+            };
+            console.log(query);
+            response = await server.engine.invoke(query, data);
+        });
+
+        When('engine get', async () => {
+            const query = { id: instanceId };
+
+            response = await server.engine.get(query);
+
+            expect(response.id).equals(instanceId);
+
+        });
+
+
+        Then('check for output to have engine', () => {
+            expect(getItem('task_Buy').status).equals('end');
+        });
+
+        and('Clean it', async () => {
+
+            const query = {
+                "data.caseId": caseId,
+                "items.elementId": 'task_clean'
+            };
+            console.log(query);
+            await server.engine.invoke(query, {});
+        });
+
+        and('Repair it', async () => {
+            const query = { id: instanceId, "items.elementId": 'task_repair' };
+            response = await server.engine.invoke(query, {});
+        });
+        and('Drive it 1', async () => {
+            const query = {
+                id: instanceId,
+                "items.elementId": 'task_Drive'
+            };
+            response = await server.engine.invoke(query, {});
+        });
+
+        and('Case Complete', async () => {
+
+            console.log(response.status);
+            expect(getItem('task_Drive').status).equals('end');
+
+        });
+
+        and('find engine status', async () => {
+
+            var insts = await server.engine.status();
+ 
+        });
+
+        // 
+        and('find instances', async () => {
+
+            var insts = await server.datastore.findInstances({ id: response.id });
+            expect(insts).to.have.lengthOf(1);
+
+        });
+
+        and('find items', async () => {
+
+            var items = await server.datastore.findItems({ id: response.id } );
+            expect(items).to.have.lengthOf(17);
+
+        });
+
+
+
+
+    });
+
+});
+
+function getItem(id) {
+    return response.items.filter(item => { return item.elementId == id; })[0];
+}

package/test/helpers/setup.js

@@ -0,0 +1,9 @@
+'use strict';
+
+process.env.NODE_ENV = 'test';
+Error.stackTraceLimit = 20;
+global.expect = require('chai').expect;
+global.assert = require('chai').assert;
+
+
+

package/test.env

@@ -0,0 +1,4 @@
+API_KEY=12345
+HOST=test.omniworkflow.com
+PORT=443
+BASE_URL=api

package/test.js

@@ -9,12 +9,60 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const BPMNClient_1 = require("./BPMNClient");
+const _1 = require("./");
+console.log("Testing BPMNClient");
+const dotenv = require('dotenv');
+const res = dotenv.config();
+console.log(res);
+test();
 function test() {
     return __awaiter(this, void 0, void 0, function* () {
-        const client = new BPMNClient_1.BPMNClient('bpmn.omniworkflow.com', 80);
-        const ret = yield client.engine.start({ name: "Buy Used Car", data: {} });
-        console.log(ret);
+        const server = new _1.BPMNClient(process.env.HOST, process.env.PORT, process.env.API_KEY);
+        const caseId = 3040;
+        var defs = yield server.definitions.list();
+        console.log(defs);
+        var def = yield server.definitions.load('Buy Used Car');
+        console.log(def['elements']);
+        //var instance = await server.engine.start("Buy Used Car", {});
+        var instance = yield server.engine.start("Buy Used Car", { caseId: caseId });
+        console.log("instance.id", instance.id, instance.name, instance.status, instance.data.caseId);
+        var response = yield server.engine.invoke({ id: instance.id, "items.elementId": 'task_Buy' }, { needsCleaning: "Yes", needsRepairs: "Yes" });
+        console.log('after buy', response.id, response.data);
+        response = yield server.engine.invoke({ id: instance.id, "items.elementId": 'task_clean' }, {});
+        console.log('after clean', response.id, response.data);
+        response = yield server.engine.invoke({ id: instance.id, "items.elementId": 'task_repair' }, {});
+        console.log('after repair', response.id, response.data);
+        try {
+            response = yield server.engine.invoke({ id: instance.id, "items.elementId": 'task_Drive' }, {});
+            console.log('after drive', response.id, response.data);
+        }
+        catch (exc) {
+            console.log(exc);
+        }
+        var items = yield server.datastore.findItems({ "items.status": "end", "items.elementId": "task_Buy" });
+        items.forEach(item => {
+            console.log('item: id==>' + item.elementId, item.type, item.name, 'status==>', item.status);
+        });
+        var insts = yield server.datastore.findInstances({ data: { caseId: caseId } });
+        insts.forEach(inst => {
+            console.log('Inst for CaseId id==>' + inst.id, inst.name, inst.data.caseId, 'status==>', inst.status);
+        });
+        var insts = yield server.datastore.findInstances({ id: instance.id });
+        insts.forEach(inst => {
+            for (var i = 0; i < inst.items.length; i++) {
+                var item = inst.items[i];
+                console.log('   item: elementId==>' + item.elementId, item.name, 'status==>', item.status);
+            }
+        });
+        var inst = yield server.engine.get({ id: instance.id });
+        for (var i = 0; i < inst.items.length; i++) {
+            var item = inst.items[i];
+            console.log('   item: elementId==>' + item.elementId, item.name, 'status==>', item.status);
+        }
+        //    var items = await server.datastore.findItems({ query: { "items.elementId": "task_Buy" } });
+        var items = yield server.datastore.findItems({ id: instance.id });
+        items.forEach(item => {
+            console.log('item: id==>' + item.elementId, item.type, item.name, 'status==>', item.status);
+        });
     });
 }
-//# sourceMappingURL=test.js.map

package/test.ts

@@ -1,10 +1,110 @@
-import { BPMNClient } from './BPMNClient';
+import { BPMNClient } from './';
 
 
+console.log("Testing BPMNClient");
+const dotenv = require('dotenv');
+const res = dotenv.config();
+
+console.log(res);
+test();
+
 async function test() {
-    const client = new BPMNClient('bpmn.omniworkflow.com', 80);
-    const ret= await client.engine.start({ name: "Buy Used Car", data: {} });
-    console.log(ret);
+
+    const server= new BPMNClient(process.env.HOST, process.env.PORT, process.env.API_KEY);
+
+    const caseId = 3040;
+
+    var defs = await server.definitions.list();
+
+    console.log(defs);
+    var def = await server.definitions.load('Buy Used Car');
+
+    console.log(def['elements']);
+
+    //var instance = await server.engine.start("Buy Used Car", {});
+
+    var instance = await server.engine.start("Buy Used Car", { caseId: caseId });
+
+
+    console.log("instance.id", instance.id, instance.name, instance.status, instance.data.caseId);
+
+    var response = await server.engine.invoke(
+        { id: instance.id, "items.elementId": 'task_Buy' }
+        , { needsCleaning: "Yes", needsRepairs: "Yes" });
+
+    console.log('after buy', response.id, response.data);
+
+    response = await server.engine.invoke(
+        { id: instance.id, "items.elementId": 'task_clean' }
+        , {});
+
+    console.log('after clean', response.id, response.data);
+
+    response = await server.engine.invoke(
+        { id: instance.id, "items.elementId": 'task_repair' }
+        , {});
+
+    console.log('after repair', response.id, response.data);
+
+
+    try {
+        response = await server.engine.invoke(
+            { id: instance.id, "items.elementId": 'task_Drive' }
+            , {});
+
+        console.log('after drive', response.id, response.data);
+
+    }
+    catch (exc) {
+        console.log(exc);
+    }
+
+
+    
+
+    var items = await server.datastore.findItems({ "items.status": "end", "items.elementId": "task_Buy" });
+
+
+    items.forEach(item => {
+        console.log('item: id==>' + item.elementId, item.type, item.name, 'status==>', item.status);
+    });
+
+
+  
+    var insts = await server.datastore.findInstances({ data: { caseId: caseId } });
+
+    insts.forEach(inst => {
+        console.log('Inst for CaseId id==>' + inst.id, inst.name, inst.data.caseId, 'status==>', inst.status);
+    });
+    var insts = await server.datastore.findInstances({ id: instance.id });
+
+    insts.forEach(inst => {
+        for (var i = 0; i < inst.items.length; i++) {
+            var item = inst.items[i];
+            console.log('   item: elementId==>' + item.elementId, item.name, 'status==>', item.status);
+
+        }
+    });
+
+    var inst = await server.engine.get({ id: instance.id });
+
+
+    for (var i = 0; i < inst.items.length; i++) {
+        var item = inst.items[i];
+        console.log('   item: elementId==>' + item.elementId, item.name, 'status==>', item.status);
+
+    }
+
+
+
+    //    var items = await server.datastore.findItems({ query: { "items.elementId": "task_Buy" } });
+    var items = await server.datastore.findItems({ id: instance.id });
+
+
+    items.forEach(item => {
+        console.log('item: id==>' + item.elementId, item.type, item.name, 'status==>', item.status);
+    });
 
 }
 
+