bpmn-client 1.4.0 → 1.6.0

package/src/BPMNClient.ts

@@ -1,265 +0,0 @@
-import { IInstanceData, IItemData , IDefinitionData} from './interfaces/DataObjects';
-import {WebService} from './WebService';
-console.log("BPMNClient 1.2");
-
-
-class BPMNClient extends WebService {
-    host;
-    port;
-    apiKey;
-    engine: ClientEngine;
-    datastore: ClientDatastore;
-    definitions: ClientDefinitions;
-
-    constructor(host, port, apiKey) {
-        super();
-
-        this.host = host;
-        this.port = port;
-        this.apiKey = apiKey;
-        this.engine = new ClientEngine(this);
-        this.datastore = new ClientDatastore(this);
-        this.definitions = new ClientDefinitions(this);
-    }
-
-    async get(url, data = {}) {
-        return await this.request(url, 'GET', data);
-
-    }
-    async post(url, data = {}) {
-        return await this.request(url, 'POST', data);
-
-    }
-    async put(url, data = {}) {
-        return await this.request(url, 'PUT', data);
-
-    }
-    async del(url, data = {}) {
-        return await this.request(url, 'DELETE', data);
-
-    }
-
-    async request(url, method, params) {
-
-        var body = JSON.stringify(params);
-        var size = Buffer.byteLength(body);
-        var contentType = "application/json";
-
-        if (method == 'UPLOAD') {
-            contentType = 'multipart/form-data; boundary = ----WebKitFormBoundary7MA4YWxkTrZu0gW';
-            method = 'POST';
-        }
-
-        var headers = {
-            "Content-Type": contentType ,
-            "x-api-key": this.apiKey,
-            "Accept": "*/*",
-            //                        "User-Agent": "PostmanRuntime/ 7.26.8",
-            //                        "Accept-Encoding": "gzip, deflate, br",
-            "Connection": "keep-alive"
-            //,
-            // "Content-Length": Buffer.byteLength(body)
-        };
-
-
-        var options;
-
-        if (params) {
-            options = {
-                host: this.host,
-                port: this.port,
-                path: '/api/' + url,
-                method: method,
-                headers: headers
-            };
-        }
-        else {
-            options = {
-                host: this.host,
-                port: this.port,
-                path: '/api/' + url,
-                method: method
-            };
-        }
-
-        return await this.invoke(params, options);
-
-    }
-
-}
-
-class ClientEngine {
-    private client: BPMNClient;
-
-    constructor(client) {
-        this.client = client;
-    }
-    async start(name, data = {}, startNodeId = null,  userId= null,options = {}): Promise<IInstanceData> {
-        const ret = await this.client.post('engine/start',
-            { name, data, startNodeId, userId, options });
-        if (ret['errors']) {
-            console.log(ret['errors']);
-            throw new Error(ret['errors']);
-        }
-        const instance = ret as IInstanceData;
-        return instance;
-    }
-    async invoke(query, data, userId= null): Promise<IInstanceData> {
-        const ret = await this.client.put('engine/invoke', { query, data , userId });
-        if (ret['errors']) {
-            console.log(ret['errors']);
-            throw new Error(ret['errors']);
-        }
-        const instance = ret['instance'] as IInstanceData;
-        return instance;
-    }
-    async assign(query, data, userId= null,assignment): Promise<IInstanceData> {
-        const ret = await this.client.put('engine/assign', { query, data , userId,assignment });
-        if (ret['errors']) {
-            console.log(ret['errors']);
-            throw new Error(ret['errors']);
-        }
-        const instance = ret['instance'] as IInstanceData;
-        return instance;
-    }
-
-    async throwMessage(messageId, data = {} , messageMatchingKey = {}) {
-        const ret = await this.client.post('engine/throwMessage', { "messageId": messageId, "data": data, messageMatchingKey });
-        if (ret['errors']) {
-            console.log(ret['errors']);
-            throw new Error(ret['errors']);
-        }
-        return ret;
-    }
-    async throwSignal(signalId, data = {} , messageMatchingKey = {}) {
-        const ret = await this.client.post('engine/throwSignal', { "signalId": signalId, "data": data, messageMatchingKey });
-        if (ret['errors']) {
-            console.log(ret['errors']);
-            throw new Error(ret['errors']);
-        }
-        return ret;
-    }
-
-    async get(query): Promise<IInstanceData> {
-        const ret = await this.client.get('engine/get', query);
-        if (ret['errors']) {
-            console.log(ret['errors']);
-            throw new Error(ret['errors']);
-        }
-        const instance = ret['instance'] as IInstanceData;
-        return instance;
-    }
-    async status() {
-        const ret = await this.client.get('engine/status', {});
-        if (ret['errors']) {
-            console.log(ret['errors']);
-            throw new Error(ret['errors']);
-        }
-        return ret;
-    }
-}
-class ClientDatastore {
-    private client: BPMNClient;
-
-    constructor(client) {
-        this.client = client;
-    }
-    async findItems(query): Promise<IItemData[]> {
-        var res = await this.client.get('datastore/findItems', query);
-        if (res['errors']) {
-            console.log(res['errors']);
-            throw new Error(res['errors']);
-        }
-        const items = res['items'] as IItemData[];
-        return items;
-
-    }
-    async findInstances(query): Promise<IInstanceData[]> {
-        const res = await this.client.get('datastore/findInstances', query);
-
-        if (res['errors']) {
-            console.log(res['errors']);
-            throw new Error(res['errors']);
-        }
-        const instances = res['instances'] as IInstanceData[];
-        return instances;
-    }
-    async deleteInstances(query) {
-        return await this.client.del('datastore/deleteInstances', query);
-    }
-}
-class ClientDefinitions {
-    private client: BPMNClient;
-
-    constructor(client) {
-        this.client = client;
-    }
-    
-    async import(name, pathToBPMN,pathToSVG=null) {
-
-        var options = {
-            'method': 'POST',
-            'host': this.client.host,
-            'port': this.client.port,
-            'path': '/api/definitions/import/' + name,
-            'headers': {
-                'x-api-key': this.client.apiKey
-            },
-            'maxRedirects': 20
-        };
-
-        console.log('import ',name,pathToBPMN,pathToSVG);
-        var res = await this.client.upload(name,pathToBPMN,pathToSVG,options);
-        console.log('import done ',res);
-        this.checkErrors(res);
-        return res;
-
-    }
-    async list(): Promise<string[]> {
-        var res = await this.client.get('definitions/list', []);
-        if (res['errors']) {
-            console.log(res['errors']);
-            throw new Error(res['errors']);
-        }
-        return res as string[];
-
-    }
-    async delete(name) {
-        const res = await this.client.post('definitions/delete/', { name });
-        if (res['errors']) {
-            console.log(res['errors']);
-            throw new Error(res['errors']);
-        }
-        console.log(res);
-        return res as IDefinitionData;
-
-    }
-    async rename(name,newName) {
-        const res = await this.client.post('definitions/rename/', { name , newName });
-        if (res['errors']) {
-            console.log(res['errors']);
-            throw new Error(res['errors']);
-        }
-        console.log(res);
-        return res as IDefinitionData;
-
-    }
-    async load(name): Promise<IDefinitionData> {
-        const res = await this.client.get(encodeURI('definitions/load/' + name), { name });
-        if (res['errors']) {
-            console.log(res['errors']);
-            throw new Error(res['errors']);
-        }
-        console.log(res);
-        return res as IDefinitionData;
-    }
-    checkErrors(res) {
-        if (res['errors']) {
-            console.log(res['errors']);
-            throw new Error(res['errors']);
-        }
-    }
-}
-
-
-export { BPMNClient , ClientEngine,ClientDatastore , ClientDefinitions}

package/src/WebService.ts

@@ -1,90 +0,0 @@
-
-const https = require('https');
-const http = require('http');
-const fs = require("fs");
-const axios = require('axios');
-const FormData = require('form-data');
-
-class WebService {
-    statusCode;
-    result;
-    response;
-    constructor() { }
-
-    async invoke(params, options, postData = null) {
-
-
-        var data = JSON.stringify(params);
-        var url = 'http://'+options.host+':'+options.port+options.path;
-
-        if (options.port == 443)
-            url = 'https://'+options.host+options.path;
-
-        var config = {
-            method: options.method,
-            url: url,
-            headers: options.headers,
-            data: data
-        };
-
-        let self = this;
-		try {
-			let response = await axios(config);
-			self.result = response.data;
-
-			return response.data;
-		}
-		catch(err)
-		{
-			console.log('** Connection failed ***',err);
-		}
-    }
-
-    async upload(fileName, path,path2, options) {
-
-        const title = fileName;
-
-        var url = 'http://'+options.host+':'+options.port+options.path;
-
-        if (options.port == 443)
-            url = 'https://'+options.host+options.path;
-  
-        const form = new FormData();
-        form.append('title', title);
-        const fileContents = fs.createReadStream(path);
-        form.append('file', fileContents);
-        if (path2!==null)
-            {
-            const fileContents2 = fs.createReadStream(path2);
-            form.append('file', fileContents2);
-            }
-
-
-        try {
-
-            const response = await axios.post(url, form, {
-              headers: options.headers    });
-
-            console.log('Response Status:',response.status,response.data);
-            return response.data;
-
-        } 
-        catch (error) {
-            console.log('upload failed:',error);
-            throw new Error(error.message);
-/*
-            if (error.response) { // get response with a status code not in range 2xx
-              console.log(error.response.data);
-              console.log(error.response.status);
-              console.log(error.response.headers);
-            } else if (error.request) { // no response
-              console.log(error.request);
-            } else { // Something wrong in setting up the request
-              console.log('Error', error.message);
-            }
-            console.log(error.config); */
-      }
-    }
-
-}
-export {WebService }

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from './interfaces/Enums';
-export * from './interfaces/DataObjects';
-export * from './BPMNClient';
-

package/src/interfaces/BPMNClient.ts

@@ -1,29 +0,0 @@
-import { IInstanceData, IItemData , IDefinitionData} from './DataObjects';
-
-
-export interface IBPMNClient  {
-    engine: IClientEngine;
-    datastore: IClientDatastore;
-    definitions: IClientDefinitions;
-}
-
-export interface IClientEngine {
-     start(name, data , startNodeId ,  userId,options ): Promise<IInstanceData>;
-     invoke(query, data, userId): Promise<IInstanceData> ;
-     assign(query, data, userId,assignment): Promise<IInstanceData>;
-     throwMessage(messageId, data, messageMatchingKey);
-     throwSignal(signalId, data, messageMatchingKey);
-     status();
-}
-export interface IClientDatastore {
-     findItems(query): Promise<IItemData[]>; 
-     findInstances(query): Promise<IInstanceData[]>;
-     deleteInstances(query);
-}
-export interface IClientDefinitions {
-     import(name, pathToBPMN,pathToSVG);
-     list(): Promise<string[]>;
-     delete(name) ;
-     rename(name,newName);
-     load(name): Promise<IDefinitionData>;
-}

package/src/interfaces/DataObjects.ts

@@ -1,100 +0,0 @@
-import { ITEM_STATUS, } from './Enums';
-
-interface IItemData {
-    id: string;            // System generated unique Id
-    itemKey: string;        // application assigned key to call the item by
-    elementId: string;   // bpmn element
-    name: string;       // name of bpmn element
-    type: string;       // bpmn element type
-    instanceId: string;   // Instance Id of the item
-    tokenId: any;         // execution Token
-    userId: any;
-    startedAt: any;
-    endedAt: any;
-    seq: any;
-    timeDue: Date;
-    status: ITEM_STATUS;
-    data: any;
-    messageId;
-    signalId;
-    vars;
-    assignee;
-    candidateGroups;
-    candidateUsers;
-    dueDate;
-    followUpDate;
-    priority;
-}
-interface IInstanceData {
-    id;
-    name;
-    status;
-    startedAt;
-    endedAt;
-    saved;
-    data;
-    items;
-    source;
-    logs;
-    tokens;
-    loops;
-    parentItemId;   // used for subProcess Calls
-}
-
-
-
-interface IDefinitionData {
-    name: any;
-    processes: Map<any, any>;
-    rootElements: any;
-    nodes: Map<any, any>;
-    flows: any[];
-    source: any;
-    logger: any;
-    accessRules: any[];
-}
-
-
-interface IElementData {
-    id: any;
-    type: any;
-    name: any;
-    behaviours: Map<any, any>;
-}
-
-interface IFlowData {
-
-}
-
-interface IEventData {
-    elementId: string;
-    processId: string;
-    type;
-    name;
-    subType;
-    signalId?: string;
-    messageId?: string;
-    // timer info
-    expression;
-    expressionFormat; // cron/iso
-    referenceDateTime; //        start time of event   or last time timer ran
-    maxRepeat;
-    repeatCount;
-    timeDue?: Date;
-
-}
-interface IBpmnModelData {
-    name;
-    source;
-    svg;
-    processes: IProcessData[];
-    events: IEventData[];
-    saved;
-    //    parse(definition: IDefinition);
-}
-interface IProcessData {
-    id;
-    name;
-    isExecutable;
-}
-export { IItemData, IInstanceData , IDefinitionData, IElementData, IFlowData , IBpmnModelData, IProcessData, IEventData }

package/src/interfaces/Enums.ts

@@ -1,82 +0,0 @@
-
-enum BPMN_TYPE {
-    UserTask = 'bpmn:UserTask',
-    ScriptTask = 'bpmn:ScriptTask',
-    ServiceTask = 'bpmn:ServiceTask',
-    SendTask = 'bpmn:SendTask',
-    ReceiveTask = 'bpmn:ReceiveTask',
-    BusinessRuleTask = 'bpmn:BusinessRuleTask',
-    SubProcess = 'bpmn:SubProcess',
-    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',
-    cancel = 'cancel',
-
-    compensate = 'compensate'
-}
-/*
- * 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 = 'process.terminated' ,
-    token_start = 'token.start', token_wait = 'token.wait', token_end = 'token.end', token_terminated = 'token.terminated' 
-}
-/*
- *  possible actions by node
- */
-
-enum NODE_ACTION { continue = 1, wait,  end , cancel, stop , error , abort  };
-
-enum ITEM_STATUS {
-    enter = 'enter',
-    start = 'start',
-    wait = 'wait',
-    end = 'end',
-    terminated = 'terminated',
-    cancelled = 'cancelled',
-    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

@@ -1,20 +0,0 @@
-{
-  "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

@@ -1,12 +0,0 @@
-{
-  "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

@@ -1,4 +0,0 @@
-API_KEY=1234
-HOST=localhost
-PORT=3000
-BASE_URL=api