2.0.2 • Published 6 years ago
bpmn-js-differ v2.0.2
bpmn-js-differ
A diffing utility for BPMN 2.0 documents. To be used together with bpmn-moddle.
Usage
Get the project via npm:
npm install --save bpmn-js-differ
Use the differ to compare two BPMN 2.0 documents:
import { diff } from 'bpmn-js-differ';
var oldDefinitions, newDefinitions; // read with bpmn-moddle
var changes = diff(oldDefinitions, newDefinitions);
The diff returns an object with the _changed
, _added
, _remove
, _layoutChanged
keys containing all differences between the models.
console.log(changes._changed);
// {
// ServiceTask_1: {
// model: { $type: 'bpmn:ServiceTask', id: 'ServiceTask_1', ... },
// attrs: { name: { oldValue: '', newValue: 'T' } }
// }
// }
console.log(changes._removed);
// {
// SequenceFlow_1: { $type: 'bpmn:SequenceFlow', id: 'SequenceFlow_1' }
// }
console.log(changes._layoutChanged);
// {
// StartEvent_1: { $type: 'bpmn:StartEvent', id: 'StartEvent_1' }
// }
console.log(changes._added);
// {
// Participant_1: { $type: 'bpmn:Participant', id: 'Participant_1' }
// }
Reading BPMN 2.0 documents
Get bpmn-moddle via npm:
npm install --save bpmn-moddle
Load two diagrams:
import BpmnModdle from 'bpmn-moddle';
function loadModels(a, b) {
new BpmnModdle().fromXML(a, function(err, adefs) {
if (err) {
return done(err);
}
new BpmnModdle().fromXML(b, function(err, bdefs) {
if (err) {
return done(err);
} else {
return done(null, adefs, bdefs);
}
});
});
}
loadModels(aXML, bXML, function(err, aDefinitions, bDefinitions) {
// go ahead and use the models
});
License
MIT