bpmn-client 1.3.27 → 1.6.0

package/README.md

@@ -0,0 +1,29 @@
+cbpmn-client
+===========
+
+[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
+
+This is a light-weight package to allow remote access to [bpmn-server](https://github.com/bpmnServer/bpmn-server)
+
+# Installation
+
+This installs bpmn-client-sample application along with `bpmn-client`
+
+```sh
+
+git clone https://github.com/bpmnServer/bpmn-client-sample.git
+
+cd bpmn-client-sample
+
+npm install
+
+npm run setup
+```
+the above setup command will copy .env 
+You can edit .env file to point to your implementation of `bpmn-server`
+
+### to update to latest release
+
+```
+$ npm update bpmn-client
+```

package/bin/cli.js

@@ -0,0 +1,245 @@
+#!/usr/bin/env node
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+//import { BPMNClient } from "bpmn-client";
+const _1 = require("../dist/");
+const readline = require("readline");
+const dotenv = require('dotenv');
+const res = dotenv.config();
+const server = new _1.BPMNClient(process.env.HOST, process.env.PORT, process.env.API_KEY);
+const cl = readline.createInterface(process.stdin, process.stdout);
+const question = function (q) {
+    return new Promise((res, rej) => {
+        cl.question(q, answer => {
+            res(answer);
+        });
+    });
+};
+completeUserTask();
+function menu() {
+    console.log('Commands:');
+    console.log('	q	to quit');
+    console.log('	s	start process ');
+    console.log('	lo	list outstanding items');
+    console.log('	li	list items');
+    console.log('	l	list instances for a process');
+    console.log('	di	display Instance information');
+    console.log('	i	Invoke Task');
+    console.log('	sgl	Signal Task');
+    console.log('	msg	Message Task');
+    console.log('	d	delete instnaces');
+    console.log('	?	repeat this list');
+}
+function completeUserTask() {
+    return __awaiter(this, void 0, void 0, function* () {
+        menu();
+        let option = '';
+        var command;
+        while (option !== 'q') {
+            command = yield question('Enter Command, q to quit\n\r>');
+            let opts = command.split(' ');
+            option = opts[0];
+            switch (option) {
+                case '?':
+                    menu();
+                    break;
+                case 'lo':
+                    console.log("Listing Outstanding Items");
+                    yield findItems({ "items.status": "wait" });
+                    break;
+                case 'l':
+                    console.log("Listing Instances for a Process");
+                    yield listInstances();
+                    break;
+                case 'li':
+                    console.log("list items");
+                    yield listItems();
+                    break;
+                case 'di':
+                    console.log("Displaying Instance Details");
+                    yield displayInstance();
+                    break;
+                case 'i':
+                    console.log("invoking");
+                    yield invoke();
+                    break;
+                case 's':
+                    console.log("Starting Process");
+                    yield start();
+                    break;
+                case 'sgl':
+                    console.log("Signalling Process");
+                    yield signal();
+                    break;
+                case 'msg':
+                    console.log("Message Process");
+                    yield message();
+                    break;
+                case 'd':
+                    console.log("deleting");
+                    yield delInstances();
+                    break;
+            }
+        }
+        console.log("bye");
+        cl.close();
+    });
+}
+function start() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const name = yield question('Please provide your process name: ');
+        let taskData = yield question('Please provide your Task Data (json obj) if any: ');
+        console.log(taskData);
+        try {
+            if (taskData === "") {
+                taskData = {};
+            }
+            else {
+                taskData = JSON.parse(taskData.toString());
+            }
+        }
+        catch (exc) {
+            console.log(exc);
+            return;
+        }
+        let response = yield server.engine.start(name, taskData);
+        console.log("Process " + name + " started:", 'InstanceId', response.id);
+        return yield displayInstance(response.id);
+    });
+}
+function findItems(query) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var items = yield server.datastore.findItems(query);
+        console.log(`processName	item.name	item.elementId	instanceId	item.id`);
+        for (var i = 0; i < items.length; i++) {
+            let item = items[i];
+            console.log(`${item['processName']}	${item.name}	${item.elementId}	${item['instanceId']}	${item.id}`);
+        }
+    });
+}
+function listItems() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const answer = yield question('Please items criteria name value pair; example: items.status wait ');
+        let str = '' + answer;
+        const list = str.split(' ');
+        let criteria = {};
+        console.log(list);
+        for (var i = 0; i < list.length; i += 2) {
+            console.log(list[i], list[i + 1]);
+            criteria[list[i]] = list[i + 1];
+        }
+        console.log(criteria);
+        var items = yield server.datastore.findItems(criteria);
+        console.log(items.length);
+        for (var j = 0; j < items.length; j++) {
+            let item = items[j];
+            console.log(`element: ${item.elementId} status: ${item.status}  processName: ${item['processName']} InstanceId: ${item['instanceId']}	id:	${item.id}`);
+        }
+    });
+}
+function listInstances() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const name = yield question('Please provide your process name: ');
+        let insts = yield server.datastore.findInstances({ name: name });
+        for (var i = 0; i < insts.length; i++) {
+            let inst = insts[i];
+            console.log(`name: ${inst.name} status: ${inst.status}	instanceId:	${inst.id}
+	startedAt: ${inst.startedAt} endedAt ${inst.endedAt}`, 'data:', inst.data);
+        }
+    });
+}
+function displayInstance(instanceId = null) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (instanceId == null)
+            instanceId = yield question('Please provide your Instance ID: ');
+        let insts = yield server.datastore.findInstances({ id: instanceId });
+        for (var i = 0; i < insts.length; i++) {
+            let inst = insts[i];
+            var items = inst.items;
+            console.log(`name: ${inst.name} status: ${inst.status}	instanceId:	${inst.id}
+	startedAt: ${inst.startedAt} endedAt ${inst.endedAt}`, 'data:', inst.data);
+            for (var j = 0; j < items.length; j++) {
+                let item = items[j];
+                console.log(`element: ${item.elementId} status: ${item.status}	id:	${item.id}`);
+            }
+        }
+    });
+}
+function invoke() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const instanceId = yield question('Please provide your Instance ID: ');
+        const taskId = yield question('Please provide your Task ID: ');
+        let taskData = yield question('Please provide your Task Data (json obj) if any: ');
+        if (taskData === "") {
+            taskData = {};
+        }
+        else {
+            taskData = JSON.parse(taskData.toString());
+        }
+        try {
+            let response = yield server.engine.invoke({ id: instanceId, "items.elementId": taskId }, taskData);
+            console.log("Completed UserTask:", taskId);
+            return yield displayInstance(response.id);
+        }
+        catch (exc) {
+            console.log("Invoking task failed for:", taskId, instanceId);
+            yield findItems({ id: instanceId, "items.elementId": taskId });
+        }
+    });
+}
+function signal() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const signalId = yield question('Please provide signal ID: ');
+        let signalData = yield question('Please provide your Data (json obj) if any: ');
+        //if (typeof signalData === 'string' && signalData.trim() === '') {
+        if (signalData === "") {
+            signalData = {};
+        }
+        else {
+            try {
+                signalData = JSON.parse(signalData.toString());
+            }
+            catch (exc) {
+                console.log(exc);
+                return;
+            }
+        }
+        let response = yield server.engine.throwSignal(signalId, signalData);
+        console.log("Signal Response:", response);
+    });
+}
+function message() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const messageId = yield question('Please provide message ID: ');
+        let messageData = yield question('Please provide your Data (json obj) if any: ');
+        if (typeof messageData === 'string' && messageData.trim() === '') {
+            messageData = {};
+        }
+        else {
+            messageData = JSON.parse(messageData.toString());
+        }
+        let response = yield server.engine.throwMessage(messageId, messageData);
+        if (response['id'])
+            return yield displayInstance(response['id']);
+        else {
+            console.log(' no results.');
+            return null;
+        }
+    });
+}
+function delInstances() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const name = yield question('Please provide process name to delete instances for process: ');
+        let response = yield server.datastore.deleteInstances({ name: name });
+        console.log("Instances Deleted:", response['result']['deletedCount']);
+    });
+}

package/bin/setup.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const readline = require("readline");
+const cl = readline.createInterface({ input: process.stdin, output: process.stdout, terminal: false });
+const question = function (q) {
+    return new Promise((res, rej) => {
+        cl.question(q, answer => {
+            res(answer);
+        });
+    });
+};
+console.log('This routine will create .env file');
+const cwd = process.cwd();
+createEnv();
+function createEnv() {
+    if (!fs.existsSync('.env')) {
+        fs.appendFileSync('.env', "API_KEY = 12345 \nHOST = localhost\nPORT = 3000\nBASE_URL = api");
+        console.log(`file ".env" created.`);
+    }
+    else
+        console.log('.env file already exists.');
+    process.exit();
+}

package/{src → dist}/BPMNClient.js

@@ -11,7 +11,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientDefinitions = exports.ClientDatastore = exports.ClientEngine = exports.BPMNClient = void 0;
 const WebService_1 = require("./WebService");
-console.log("BPMNClient 1.2");
 class BPMNClient extends WebService_1.WebService {
     constructor(host, port, apiKey) {
         super();
@@ -88,9 +87,9 @@ class ClientEngine {
     constructor(client) {
         this.client = client;
     }
-    start(name, data = {}, startNodeId = null, options = {}) {
+    start(name, data = {}, startNodeId = null, userId = null, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const ret = yield this.client.post('engine/start', { name, data, startNodeId, options });
+            const ret = yield this.client.post('engine/start', { name, data, startNodeId, userId, options });
             if (ret['errors']) {
                 console.log(ret['errors']);
                 throw new Error(ret['errors']);
@@ -99,9 +98,21 @@ class ClientEngine {
             return instance;
         });
     }
-    invoke(query, data) {
+    invoke(query, data, userId = null, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const ret = yield this.client.put('engine/invoke', { query, data });
+            console.log('invoke', options);
+            const ret = yield this.client.put('engine/invoke', { query, data, userId, options });
+            if (ret['errors']) {
+                console.log(ret['errors']);
+                throw new Error(ret['errors']);
+            }
+            const instance = ret['instance'];
+            return instance;
+        });
+    }
+    assign(query, data, userId = null, assignment) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const ret = yield this.client.put('engine/assign', { query, data, userId, assignment });
             if (ret['errors']) {
                 console.log(ret['errors']);
                 throw new Error(ret['errors']);

package/{cli.js → dist/cli.js}

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 "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); }); }
@@ -151,7 +152,7 @@ function listInstances() {
         let insts = yield server.datastore.findInstances({ name: name });
         for (var i = 0; i < insts.length; i++) {
             let inst = insts[i];
-            console.log(`name: ${inst.name} status: ${inst.status}	instanceId:	${inst.id}
+            console.log(`name: ${inst.name} status: ${inst.status}	instanceId:	${inst.id}
 	startedAt: ${inst.startedAt} endedAt ${inst.endedAt}`, 'data:', inst.data);
         }
     });
@@ -164,7 +165,7 @@ function displayInstance(instanceId = null) {
         for (var i = 0; i < insts.length; i++) {
             let inst = insts[i];
             var items = inst.items;
-            console.log(`name: ${inst.name} status: ${inst.status}	instanceId:	${inst.id}
+            console.log(`name: ${inst.name} status: ${inst.status}	instanceId:	${inst.id}
 	startedAt: ${inst.startedAt} endedAt ${inst.endedAt}`, 'data:', inst.data);
             for (var j = 0; j < items.length; j++) {
                 let item = items[j];

package/dist/interfaces/DataObjects.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/{src → dist}/interfaces/Enums.js

@@ -65,15 +65,15 @@ var 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["cancel"] = 4] = "cancel";
+    NODE_ACTION[NODE_ACTION["stop"] = 5] = "stop";
+    NODE_ACTION[NODE_ACTION["error"] = 6] = "error";
+    NODE_ACTION[NODE_ACTION["abort"] = 7] = "abort";
 })(NODE_ACTION || (exports.NODE_ACTION = NODE_ACTION = {}));
 ;
 var ITEM_STATUS;

package/dist/setup.js

@@ -0,0 +1,22 @@
+const fs = require('fs');
+const readline = require("readline");
+const cl = readline.createInterface({ input: process.stdin, output: process.stdout, terminal: false });
+const question = function (q) {
+    return new Promise((res, rej) => {
+        cl.question(q, answer => {
+            res(answer);
+        });
+    });
+};
+console.log('This routine will create .env file');
+const cwd = process.cwd();
+createEnv();
+function createEnv() {
+    if (!fs.existsSync('.env')) {
+        fs.appendFileSync('.env', "API_KEY = 12345 \nHOST = localhost\nPORT = 3000\nBASE_URL = api");
+        console.log(`file ".env" created.`);
+    }
+    else
+        console.log('.env file already exists.');
+    process.exit();
+}

package/dist/test.js

@@ -0,0 +1,75 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = require("./");
+testLong();
+function testLong() {
+    return __awaiter(this, void 0, void 0, function* () {
+        console.log('testlong');
+        const dotenv = require('dotenv');
+        dotenv.config();
+        console.log('env:', process.env.HOST, process.env.PORT, process.env.API_KEY);
+        var caseId = Math.floor(Math.random() * 10000);
+        let name = 'test-concurrency';
+        let response;
+        let instanceId;
+        let userId = 'user1';
+        let options = { noWait: true };
+        const server1 = new _1.BPMNClient(process.env.HOST, process.env.PORT, process.env.API_KEY);
+        response = yield server1.engine.start(name, { caseId: caseId }, null, userId);
+        console.log(response.id, response.items.length);
+        response.items.forEach(item => { console.log(item.id, item.name, item.type, item.status); });
+        response = yield server1.engine.invoke({ id: response.id, "items.elementId": 'UserLong' }, null, userId, options);
+        console.log('invoked userLong', response.items.length);
+        response = yield server1.engine.invoke({ id: response.id, "items.elementId": 'UserShort' }, null, userId, options);
+        console.log('invoked userShort', response.items.length);
+    });
+}
+function test() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const dotenv = require('dotenv');
+        dotenv.config();
+        console.log('env:', process.env.HOST, process.env.PORT, process.env.API_KEY);
+        var caseId = Math.floor(Math.random() * 10000);
+        let name = 'Buy Used Car';
+        let response;
+        let instanceId;
+        let userId = 'user1';
+        let options = { noWait: true };
+        const server1 = new _1.BPMNClient(process.env.HOST, process.env.PORT, process.env.API_KEY);
+        const server2 = new _1.BPMNClient(process.env.HOST, 3030, process.env.API_KEY);
+        response = yield server1.engine.start(name, { caseId: caseId }, null, userId, options);
+        console.log(response.id);
+        response = yield server2.engine.invoke({ id: response.id, "items.elementId": 'task_Buy' }, null, userId, options);
+        console.log('invoked', response.id);
+    });
+}
+function importModel() {
+    return __awaiter(this, void 0, void 0, function* () {
+        console.log('from client lib');
+        try {
+            //    const server = new BPMNClient('localhost', 3000, '12345');
+            const dotenv = require('dotenv');
+            dotenv.config();
+            console.log('env:', process.env.HOST, process.env.PORT, process.env.API_KEY);
+            const server = new _1.BPMNClient(process.env.HOST, process.env.PORT, process.env.API_KEY);
+            var name = 'test-import';
+            var file = '..\\WebApp\\processes\\Trans.bpmn';
+            var file2 = '..\\WebApp\\processes\\Trans.svg';
+            var res = yield server.definitions.import(name, file, file2);
+            return res;
+        }
+        catch (exc) {
+            console.log('*******ERROR********');
+            console.log(exc);
+        }
+    });
+}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "bpmn-client",
-  "version": "1.3.27",
+  "version": "1.6.0",
   "license": "MIT",
+  "main":"./dist/index.js",
   "scripts": {
     "build": "tsc --build",
     "compileRun": "tsc --build && node cli.js",
-    "dev": "nodemon -e ts  --exec \"npm run compileRun\"",
+    "cli": "ts-node src/cli",
     "clean": "tsc --build --clean",
     "start": "node cli.ts",
     "test": "mocha -exit --config=test\\.mocharc.json"
@@ -25,6 +26,14 @@
     "type": "git",
     "url": "git+https:github.com/ralphhanna/bpmn-client.git"
   },
+  "bin": {
+    "bpmn-client-setup": "./bin/setup.js",
+    "bpmn-client-cli": "./bin/cli.js"
+  },
+  "files": [
+    "bin",
+    "dist"
+  ],
   "dependencies": {
     "axios": "^1.3.4",
     "connect-busboy": "0.0.2",

package/.env

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

package/Sample/.env

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

package/Sample/CarExample.js

@@ -1,62 +0,0 @@
-"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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const bpmn_client_1 = require("bpmn-client");
-const dotenv = require('dotenv');
-const res = dotenv.config();
-console.log("Testing BPMNClient 3");
-const http = require('http');
-test();
-function test() {
-    return __awaiter(this, void 0, void 0, function* () {
-        console.log('-------- car.js -----------');
-        const server = new bpmn_client_1.BPMNClient(process.env.HOST, process.env.PORT, process.env.API_KEY);
-        var caseId = Math.floor(Math.random() * 10000);
-        let name = 'Buy Used Car';
-        let instanceId;
-        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 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);
-        });
-    });
-}