-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
BaseViewer.js
858 lines (720 loc) · 20.3 KB
/
BaseViewer.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
/**
* The code in the <project-logo></project-logo> area
* must not be changed.
*
* @see http://bpmn.io/license for more information.
*/
import {
assign,
find,
isNumber,
omit
} from 'min-dash';
import {
domify,
assignStyle,
query as domQuery,
remove as domRemove
} from 'min-dom';
import {
innerSVG
} from 'tiny-svg';
import Diagram from 'diagram-js';
import BpmnModdle from 'bpmn-moddle';
import inherits from 'inherits-browser';
import {
importBpmnDiagram
} from './import/Importer';
/**
* @template T
*
* @typedef { import('diagram-js/lib/core/EventBus').default<T> } EventBus
*/
/**
* @template T
*
* @typedef {import('diagram-js/lib/core/EventBus').EventBusEventCallback<T>} EventBusEventCallback
*/
/**
* @typedef {import('didi').ModuleDeclaration} ModuleDeclaration
*
* @typedef {import('./model/Types').Moddle} Moddle
* @typedef {import('./model/Types').ModdleElement} ModdleElement
* @typedef {import('./model/Types').ModdleExtension} ModdleExtension
*
* @typedef { {
* width?: number|string;
* height?: number|string;
* position?: string;
* container?: string|HTMLElement;
* moddleExtensions?: ModdleExtensions;
* additionalModules?: ModuleDeclaration[];
* } & Record<string, any> } BaseViewerOptions
*
* @typedef {Record<string, ModdleElement>} ModdleElementsById
*
* @typedef { {
* [key: string]: ModdleExtension;
* } } ModdleExtensions
*
* @typedef { {
* warnings: string[];
* } } ImportXMLResult
*
* @typedef {ImportXMLResult & Error} ImportXMLError
*
* @typedef {ImportXMLResult} ImportDefinitionsResult
*
* @typedef {ImportXMLError} ImportDefinitionsError
*
* @typedef {ImportXMLResult} OpenResult
*
* @typedef {ImportXMLError} OpenError
*
* @typedef { {
* format?: boolean;
* preamble?: boolean;
* } } SaveXMLOptions
*
* @typedef { {
* xml?: string;
* error?: Error;
* } } SaveXMLResult
*
* @typedef { {
* svg: string;
* } } SaveSVGResult
*
* @typedef { {
* xml: string;
* } } ImportParseStartEvent
*
* @typedef { {
* error?: ImportXMLError;
* definitions?: ModdleElement;
* elementsById?: ModdleElementsById;
* references?: ModdleElement[];
* warnings: string[];
* } } ImportParseCompleteEvent
*
* @typedef { {
* error?: ImportXMLError;
* warnings: string[];
* } } ImportDoneEvent
*
* @typedef { {
* definitions: ModdleElement;
* } } SaveXMLStartEvent
*
* @typedef {SaveXMLResult} SaveXMLDoneEvent
*
* @typedef { {
* error?: Error;
* svg: string;
* } } SaveSVGDoneEvent
*/
/**
* @template Type
*
* @typedef { Type extends { eventBus: EventBus<infer X> } ? X : never } EventMap
*/
/**
* A base viewer for BPMN 2.0 diagrams.
*
* Have a look at {@link bpmn-js/lib/Viewer}, {@link bpmn-js/lib/NavigatedViewer} or {@link bpmn-js/lib/Modeler} for
* bundles that include actual features.
*
* @template [ServiceMap=null]
*
* @extends Diagram<ServiceMap>
*
* @param {BaseViewerOptions} [options] The options to configure the viewer.
*/
export default function BaseViewer(options) {
/**
* @type {BaseViewerOptions}
*/
options = assign({}, DEFAULT_OPTIONS, options);
/**
* @type {Moddle}
*/
this._moddle = this._createModdle(options);
/**
* @type {HTMLElement}
*/
this._container = this._createContainer(options);
/* <project-logo> */
addProjectLogo(this._container);
/* </project-logo> */
this._init(this._container, this._moddle, options);
}
inherits(BaseViewer, Diagram);
/**
* Parse and render a BPMN 2.0 diagram.
*
* Once finished the viewer reports back the result to the
* provided callback function with (err, warnings).
*
* ## Life-Cycle Events
*
* During import the viewer will fire life-cycle events:
*
* * import.parse.start (about to read model from XML)
* * import.parse.complete (model read; may have worked or not)
* * import.render.start (graphical import start)
* * import.render.complete (graphical import finished)
* * import.done (everything done)
*
* You can use these events to hook into the life-cycle.
*
* @throws {ImportXMLError} An error thrown during the import of the XML.
*
* @fires BaseViewer#ImportParseStartEvent
* @fires BaseViewer#ImportParseCompleteEvent
* @fires Importer#ImportRenderStartEvent
* @fires Importer#ImportRenderCompleteEvent
* @fires BaseViewer#ImportDoneEvent
*
* @param {string} xml The BPMN 2.0 XML to be imported.
* @param {ModdleElement|string} [bpmnDiagram] The optional diagram or Id of the BPMN diagram to open.
*
* @return {Promise<ImportXMLResult>} A promise resolving with warnings that were produced during the import.
*/
BaseViewer.prototype.importXML = async function importXML(xml, bpmnDiagram) {
const self = this;
function ParseCompleteEvent(data) {
return self.get('eventBus').createEvent(data);
}
let aggregatedWarnings = [];
try {
// hook in pre-parse listeners +
// allow xml manipulation
/**
* A `import.parse.start` event.
*
* @event BaseViewer#ImportParseStartEvent
* @type {ImportParseStartEvent}
*/
xml = this._emit('import.parse.start', { xml: xml }) || xml;
let parseResult;
try {
parseResult = await this._moddle.fromXML(xml, 'bpmn:Definitions');
} catch (error) {
this._emit('import.parse.complete', {
error
});
throw error;
}
let definitions = parseResult.rootElement;
const references = parseResult.references;
const parseWarnings = parseResult.warnings;
const elementsById = parseResult.elementsById;
aggregatedWarnings = aggregatedWarnings.concat(parseWarnings);
// hook in post parse listeners +
// allow definitions manipulation
/**
* A `import.parse.complete` event.
*
* @event BaseViewer#ImportParseCompleteEvent
* @type {ImportParseCompleteEvent}
*/
definitions = this._emit('import.parse.complete', ParseCompleteEvent({
error: null,
definitions: definitions,
elementsById: elementsById,
references: references,
warnings: aggregatedWarnings
})) || definitions;
const importResult = await this.importDefinitions(definitions, bpmnDiagram);
aggregatedWarnings = aggregatedWarnings.concat(importResult.warnings);
/**
* A `import.parse.complete` event.
*
* @event BaseViewer#ImportDoneEvent
* @type {ImportDoneEvent}
*/
this._emit('import.done', { error: null, warnings: aggregatedWarnings });
return { warnings: aggregatedWarnings };
} catch (err) {
let error = err;
aggregatedWarnings = aggregatedWarnings.concat(error.warnings || []);
addWarningsToError(error, aggregatedWarnings);
error = checkValidationError(error);
this._emit('import.done', { error, warnings: error.warnings });
throw error;
}
};
/**
* Import parsed definitions and render a BPMN 2.0 diagram.
*
* Once finished the viewer reports back the result to the
* provided callback function with (err, warnings).
*
* ## Life-Cycle Events
*
* During import the viewer will fire life-cycle events:
*
* * import.render.start (graphical import start)
* * import.render.complete (graphical import finished)
*
* You can use these events to hook into the life-cycle.
*
* @throws {ImportDefinitionsError} An error thrown during the import of the definitions.
*
* @param {ModdleElement} definitions The definitions.
* @param {ModdleElement|string} [bpmnDiagram] The optional diagram or ID of the BPMN diagram to open.
*
* @return {Promise<ImportDefinitionsResult>} A promise resolving with warnings that were produced during the import.
*/
BaseViewer.prototype.importDefinitions = async function importDefinitions(definitions, bpmnDiagram) {
this._setDefinitions(definitions);
const result = await this.open(bpmnDiagram);
return { warnings: result.warnings };
};
/**
* Open diagram of previously imported XML.
*
* Once finished the viewer reports back the result to the
* provided callback function with (err, warnings).
*
* ## Life-Cycle Events
*
* During switch the viewer will fire life-cycle events:
*
* * import.render.start (graphical import start)
* * import.render.complete (graphical import finished)
*
* You can use these events to hook into the life-cycle.
*
* @throws {OpenError} An error thrown during opening.
*
* @param {ModdleElement|string} bpmnDiagramOrId The diagram or Id of the BPMN diagram to open.
*
* @return {Promise<OpenResult>} A promise resolving with warnings that were produced during opening.
*/
BaseViewer.prototype.open = async function open(bpmnDiagramOrId) {
const definitions = this._definitions;
let bpmnDiagram = bpmnDiagramOrId;
if (!definitions) {
const error = new Error('no XML imported');
addWarningsToError(error, []);
throw error;
}
if (typeof bpmnDiagramOrId === 'string') {
bpmnDiagram = findBPMNDiagram(definitions, bpmnDiagramOrId);
if (!bpmnDiagram) {
const error = new Error('BPMNDiagram <' + bpmnDiagramOrId + '> not found');
addWarningsToError(error, []);
throw error;
}
}
// clear existing rendered diagram
// catch synchronous exceptions during #clear()
try {
this.clear();
} catch (error) {
addWarningsToError(error, []);
throw error;
}
// perform graphical import
const { warnings } = await importBpmnDiagram(this, definitions, bpmnDiagram);
return { warnings };
};
/**
* Export the currently displayed BPMN 2.0 diagram as
* a BPMN 2.0 XML document.
*
* ## Life-Cycle Events
*
* During XML saving the viewer will fire life-cycle events:
*
* * saveXML.start (before serialization)
* * saveXML.serialized (after xml generation)
* * saveXML.done (everything done)
*
* You can use these events to hook into the life-cycle.
*
* @throws {Error} An error thrown during export.
*
* @fires BaseViewer#SaveXMLStart
* @fires BaseViewer#SaveXMLDone
*
* @param {SaveXMLOptions} [options] The options.
*
* @return {Promise<SaveXMLResult>} A promise resolving with the XML.
*/
BaseViewer.prototype.saveXML = async function saveXML(options) {
options = options || {};
let definitions = this._definitions,
error, xml;
try {
if (!definitions) {
throw new Error('no definitions loaded');
}
// allow to fiddle around with definitions
/**
* A `saveXML.start` event.
*
* @event BaseViewer#SaveXMLStartEvent
* @type {SaveXMLStartEvent}
*/
definitions = this._emit('saveXML.start', {
definitions
}) || definitions;
const result = await this._moddle.toXML(definitions, options);
xml = result.xml;
xml = this._emit('saveXML.serialized', {
xml
}) || xml;
} catch (err) {
error = err;
}
const result = error ? { error } : { xml };
/**
* A `saveXML.done` event.
*
* @event BaseViewer#SaveXMLDoneEvent
* @type {SaveXMLDoneEvent}
*/
this._emit('saveXML.done', result);
if (error) {
throw error;
}
return result;
};
/**
* Export the currently displayed BPMN 2.0 diagram as
* an SVG image.
*
* ## Life-Cycle Events
*
* During SVG saving the viewer will fire life-cycle events:
*
* * saveSVG.start (before serialization)
* * saveSVG.done (everything done)
*
* You can use these events to hook into the life-cycle.
*
* @throws {Error} An error thrown during export.
*
* @fires BaseViewer#SaveSVGDone
*
* @return {Promise<SaveSVGResult>} A promise resolving with the SVG.
*/
BaseViewer.prototype.saveSVG = async function saveSVG() {
this._emit('saveSVG.start');
let svg, err;
try {
const canvas = this.get('canvas');
const contentNode = canvas.getActiveLayer(),
defsNode = domQuery('defs', canvas._svg);
const contents = innerSVG(contentNode),
defs = defsNode ? '<defs>' + innerSVG(defsNode) + '</defs>' : '';
const bbox = contentNode.getBBox();
svg =
'<?xml version="1.0" encoding="utf-8"?>\n' +
'<!-- created with bpmn-js / http://bpmn.io -->\n' +
'<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">\n' +
'<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" ' +
'width="' + bbox.width + '" height="' + bbox.height + '" ' +
'viewBox="' + bbox.x + ' ' + bbox.y + ' ' + bbox.width + ' ' + bbox.height + '" version="1.1">' +
defs + contents +
'</svg>';
} catch (e) {
err = e;
}
/**
* A `saveSVG.done` event.
*
* @event BaseViewer#SaveSVGDoneEvent
* @type {SaveSVGDoneEvent}
*/
this._emit('saveSVG.done', {
error: err,
svg: svg
});
if (err) {
throw err;
}
return { svg };
};
BaseViewer.prototype._setDefinitions = function(definitions) {
this._definitions = definitions;
};
/**
* Return modules to instantiate with.
*
* @return {ModuleDeclaration[]} The modules.
*/
BaseViewer.prototype.getModules = function() {
return this._modules;
};
/**
* Remove all drawn elements from the viewer.
*
* After calling this method the viewer can still be reused for opening another
* diagram.
*/
BaseViewer.prototype.clear = function() {
if (!this.getDefinitions()) {
// no diagram to clear
return;
}
// remove drawn elements
Diagram.prototype.clear.call(this);
};
/**
* Destroy the viewer instance and remove all its remainders from the document
* tree.
*/
BaseViewer.prototype.destroy = function() {
// diagram destroy
Diagram.prototype.destroy.call(this);
// dom detach
domRemove(this._container);
};
/**
* @overlord
*
* Register an event listener for events with the given name.
*
* The callback will be invoked with `event, ...additionalArguments`
* that have been passed to {@link EventBus#fire}.
*
* Returning false from a listener will prevent the events default action
* (if any is specified). To stop an event from being processed further in
* other listeners execute {@link Event#stopPropagation}.
*
* Returning anything but `undefined` from a listener will stop the listener propagation.
*
* @template T
*
* @param {string|string[]} events The event(s) to listen to.
* @param {number} [priority] The priority with which to listen.
* @param {EventBusEventCallback<T>} callback The callback.
* @param {any} [that] Value of `this` the callback will be called with.
*/
/**
* Register an event listener for events with the given name.
*
* The callback will be invoked with `event, ...additionalArguments`
* that have been passed to {@link EventBus#fire}.
*
* Returning false from a listener will prevent the events default action
* (if any is specified). To stop an event from being processed further in
* other listeners execute {@link Event#stopPropagation}.
*
* Returning anything but `undefined` from a listener will stop the listener propagation.
*
* @template {keyof EventMap<ServiceMap>} EventName
*
* @param {EventName} events to subscribe to
* @param {number} [priority=1000] listen priority
* @param {EventBusEventCallback<(EventMap<ServiceMap>)[EventName]>} callback
* @param {any} [that] callback context
*/
BaseViewer.prototype.on = function(events, priority, callback, that) {
return this.get('eventBus').on(events, priority, callback, that);
};
/**
* Remove an event listener.
*
* @param {string|string[]} events The event(s).
* @param {Function} [callback] The callback.
*/
BaseViewer.prototype.off = function(events, callback) {
this.get('eventBus').off(events, callback);
};
/**
* Attach the viewer to an HTML element.
*
* @param {HTMLElement} parentNode The parent node to attach to.
*/
BaseViewer.prototype.attachTo = function(parentNode) {
if (!parentNode) {
throw new Error('parentNode required');
}
// ensure we detach from the
// previous, old parent
this.detach();
// unwrap jQuery if provided
if (parentNode.get && parentNode.constructor.prototype.jquery) {
parentNode = parentNode.get(0);
}
if (typeof parentNode === 'string') {
parentNode = domQuery(parentNode);
}
parentNode.appendChild(this._container);
this._emit('attach', {});
this.get('canvas').resized();
};
/**
* Get the definitions model element.
*
* @return {ModdleElement} The definitions model element.
*/
BaseViewer.prototype.getDefinitions = function() {
return this._definitions;
};
/**
* Detach the viewer.
*
* @fires BaseViewer#DetachEvent
*/
BaseViewer.prototype.detach = function() {
const container = this._container,
parentNode = container.parentNode;
if (!parentNode) {
return;
}
/**
* A `detach` event.
*
* @event BaseViewer#DetachEvent
* @type {Object}
*/
this._emit('detach', {});
parentNode.removeChild(container);
};
BaseViewer.prototype._init = function(container, moddle, options) {
const baseModules = options.modules || this.getModules(options),
additionalModules = options.additionalModules || [],
staticModules = [
{
bpmnjs: [ 'value', this ],
moddle: [ 'value', moddle ]
}
];
const diagramModules = [].concat(staticModules, baseModules, additionalModules);
const diagramOptions = assign(omit(options, [ 'additionalModules' ]), {
canvas: assign({}, options.canvas, { container: container }),
modules: diagramModules
});
// invoke diagram constructor
Diagram.call(this, diagramOptions);
if (options && options.container) {
this.attachTo(options.container);
}
};
/**
* Emit an event on the underlying {@link EventBus}
*
* @param {string} type
* @param {Object} event
*
* @return {Object} The return value after calling all event listeners.
*/
BaseViewer.prototype._emit = function(type, event) {
return this.get('eventBus').fire(type, event);
};
/**
* @param {BaseViewerOptions} options
*
* @return {HTMLElement}
*/
BaseViewer.prototype._createContainer = function(options) {
const container = domify('<div class="bjs-container"></div>');
assignStyle(container, {
width: ensureUnit(options.width),
height: ensureUnit(options.height),
position: options.position
});
return container;
};
/**
* @param {BaseViewerOptions} options
*
* @return {Moddle}
*/
BaseViewer.prototype._createModdle = function(options) {
const moddleOptions = assign({}, this._moddleExtensions, options.moddleExtensions);
return new BpmnModdle(moddleOptions);
};
BaseViewer.prototype._modules = [];
// helpers ///////////////
function addWarningsToError(err, warningsAry) {
err.warnings = warningsAry;
return err;
}
function checkValidationError(err) {
// check if we can help the user by indicating wrong BPMN 2.0 xml
// (in case he or the exporting tool did not get that right)
const pattern = /unparsable content <([^>]+)> detected([\s\S]*)$/;
const match = pattern.exec(err.message);
if (match) {
err.message =
'unparsable content <' + match[1] + '> detected; ' +
'this may indicate an invalid BPMN 2.0 diagram file' + match[2];
}
return err;
}
const DEFAULT_OPTIONS = {
width: '100%',
height: '100%',
position: 'relative'
};
/**
* Ensure the passed argument is a proper unit (defaulting to px)
*/
function ensureUnit(val) {
return val + (isNumber(val) ? 'px' : '');
}
/**
* Find BPMNDiagram in definitions by ID
*
* @param {ModdleElement<Definitions>} definitions
* @param {string} diagramId
*
* @return {ModdleElement<BPMNDiagram>|null}
*/
function findBPMNDiagram(definitions, diagramId) {
if (!diagramId) {
return null;
}
return find(definitions.diagrams, function(element) {
return element.id === diagramId;
}) || null;
}
/* <project-logo> */
import {
open as openPoweredBy,
BPMNIO_IMG,
LOGO_STYLES,
LINK_STYLES
} from './util/PoweredByUtil';
import {
event as domEvent
} from 'min-dom';
/**
* Adds the project logo to the diagram container as
* required by the bpmn.io license.
*
* @see http://bpmn.io/license
*
* @param {Element} container
*/
function addProjectLogo(container) {
const img = BPMNIO_IMG;
const linkMarkup =
'<a href="http://bpmn.io" ' +
'target="_blank" ' +
'class="bjs-powered-by" ' +
'title="Powered by bpmn.io" ' +
'>' +
img +
'</a>';
const linkElement = domify(linkMarkup);
assignStyle(domQuery('svg', linkElement), LOGO_STYLES);
assignStyle(linkElement, LINK_STYLES, {
position: 'absolute',
bottom: '15px',
right: '15px',
zIndex: '100'
});
container.appendChild(linkElement);
domEvent.bind(linkElement, 'click', function(event) {
openPoweredBy();
event.preventDefault();
});
}
/* </project-logo> */