bpmn-js 14.2.0 → 15.0.0

package/lib/Modeler.js

@@ -30,6 +30,7 @@ import LabelEditingModule from './features/label-editing';
 import ModelingModule from './features/modeling';
 import ModelingFeedbackModule from './features/modeling-feedback';
 import MoveModule from 'diagram-js/lib/features/move';
+import OutlineModule from './features/outline';
 import PaletteModule from './features/palette';
 import ReplacePreviewModule from './features/replace-preview';
 import ResizeModule from 'diagram-js/lib/features/resize';
@@ -182,6 +183,7 @@ Modeler.prototype._modelingModules = [
   ModelingModule,
   ModelingFeedbackModule,
   MoveModule,
+  OutlineModule,
   PaletteModule,
   ReplacePreviewModule,
   ResizeModule,

package/lib/draw/BpmnRenderUtil.d.ts

@@ -7,6 +7,7 @@
  * @return
  */
 export function isTypedEvent(event: any, eventDefinitionType: string): boolean;
+
 /**
  * Check if element is a throw event.
  *
@@ -15,6 +16,7 @@ export function isTypedEvent(event: any, eventDefinitionType: string): boolean;
  * @return
  */
 export function isThrowEvent(event: any): boolean;
+
 /**
  * Check if element is a throw event.
  *
@@ -23,34 +25,42 @@ export function isThrowEvent(event: any): boolean;
  * @return
  */
 export function isCollection(element: any): boolean;
+
 /**
  * @param element
  * @param defaultColor
+ * @param overrideColor
  *
  * @return
  */
-export function getFillColor(element: any, defaultColor?: string): string;
+export function getFillColor(element: any, defaultColor?: string, overrideColor?: string): string;
+
 /**
  * @param element
  * @param defaultColor
+ * @param overrideColor
  *
  * @return
  */
-export function getStrokeColor(element: any, defaultColor?: string): string;
+export function getStrokeColor(element: any, defaultColor?: string, overrideColor?: string): string;
+
 /**
  * @param element
  * @param defaultColor
  * @param defaultStrokeColor
+ * @param overrideColor
  *
  * @return
  */
-export function getLabelColor(element: any, defaultColor?: string, defaultStrokeColor?: string): string;
+export function getLabelColor(element: any, defaultColor?: string, defaultStrokeColor?: string, overrideColor?: string): string;
+
 /**
  * @param shape
  *
  * @return path
  */
 export function getCirclePath(shape: any): string;
+
 /**
  * @param shape
  * @param borderRadius
@@ -58,20 +68,56 @@ export function getCirclePath(shape: any): string;
  * @return path
  */
 export function getRoundRectPath(shape: any, borderRadius?: number): string;
+
 /**
  * @param shape
  *
  * @return path
  */
 export function getDiamondPath(shape: any): string;
+
 /**
  * @param shape
  *
  * @return path
  */
 export function getRectPath(shape: any): string;
+
+/**
+ * Get width and height from element or overrides.
+ *
+ * @param bounds
+ * @param overrides
+ *
+ * @returns
+ */
+export function getBounds(bounds: Dimensions | Rect | Shape, overrides?: any): Dimensions;
+
+/**
+ * Get width from element or overrides.
+ *
+ * @param bounds
+ * @param overrides
+ *
+ * @returns
+ */
+export function getWidth(bounds: Dimensions | Rect | Shape, overrides?: any): number;
+
+/**
+ * Get height from element or overrides.
+ *
+ * @param bounds
+ * @param overrides
+ *
+ * @returns
+ */
+export function getHeight(bounds: Dimensions | Rect | Shape, overrides?: any): number;
+
 export const black: string;
+export const white: string;
 export type ModdleElement = any;
 export type Element = any;
 export type ShapeLike = any;
+type Dimensions = import('diagram-js/lib/util/Types').Dimensions;
+type Rect = import('diagram-js/lib/util/Types').Rect;
 export { getDi, getBusinessObject as getSemantic } from "../util/ModelUtil";

package/lib/draw/BpmnRenderUtil.js

@@ -1,4 +1,5 @@
 import {
+  has,
   some
 } from 'min-dash';
 
@@ -16,6 +17,9 @@ import {
  * @typedef {import('../model').Element} Element
  *
  * @typedef {import('../model').ShapeLike} ShapeLike
+ *
+ * @typedef {import('diagram-js/lib/util/Types').Dimensions} Dimensions
+ * @typedef {import('diagram-js/lib/util/Types').Rect} Rect
  */
 
 // re-export for compatibility
@@ -26,6 +30,7 @@ export {
 
 
 export var black = 'hsl(225, 10%, 15%)';
+export var white = 'white';
 
 // element utils //////////////////////
 
@@ -73,39 +78,42 @@ export function isCollection(element) {
 /**
  * @param {Element} element
  * @param {string} [defaultColor]
+ * @param {string} [overrideColor]
  *
  * @return {string}
  */
-export function getFillColor(element, defaultColor) {
+export function getFillColor(element, defaultColor, overrideColor) {
   var di = getDi(element);
 
-  return di.get('color:background-color') || di.get('bioc:fill') || defaultColor || 'white';
+  return overrideColor || di.get('color:background-color') || di.get('bioc:fill') || defaultColor || white;
 }
 
 /**
  * @param {Element} element
  * @param {string} [defaultColor]
+ * @param {string} [overrideColor]
  *
  * @return {string}
  */
-export function getStrokeColor(element, defaultColor) {
+export function getStrokeColor(element, defaultColor, overrideColor) {
   var di = getDi(element);
 
-  return di.get('color:border-color') || di.get('bioc:stroke') || defaultColor || black;
+  return overrideColor || di.get('color:border-color') || di.get('bioc:stroke') || defaultColor || black;
 }
 
 /**
  * @param {Element} element
  * @param {string} [defaultColor]
  * @param {string} [defaultStrokeColor]
+ * @param {string} [overrideColor]
  *
  * @return {string}
  */
-export function getLabelColor(element, defaultColor, defaultStrokeColor) {
+export function getLabelColor(element, defaultColor, defaultStrokeColor, overrideColor) {
   var di = getDi(element),
       label = di.get('label');
 
-  return label && label.get('color:color') || defaultColor ||
+  return overrideColor || (label && label.get('color:color')) || defaultColor ||
     getStrokeColor(element, defaultStrokeColor);
 }
 
@@ -208,3 +216,42 @@ export function getRectPath(shape) {
 
   return componentsToPath(rectPath);
 }
+
+/**
+ * Get width and height from element or overrides.
+ *
+ * @param {Dimensions|Rect|Shape} bounds
+ * @param {Object} overrides
+ *
+ * @returns {Dimensions}
+ */
+export function getBounds(bounds, overrides = {}) {
+  return {
+    width: getWidth(bounds, overrides),
+    height: getHeight(bounds, overrides)
+  };
+}
+
+/**
+ * Get width from element or overrides.
+ *
+ * @param {Dimensions|Rect|Shape} bounds
+ * @param {Object} overrides
+ *
+ * @returns {number}
+ */
+export function getWidth(bounds, overrides = {}) {
+  return has(overrides, 'width') ? overrides.width : bounds.width;
+}
+
+/**
+ * Get height from element or overrides.
+ *
+ * @param {Dimensions|Rect|Shape} bounds
+ * @param {Object} overrides
+ *
+ * @returns {number}
+ */
+export function getHeight(bounds, overrides = {}) {
+  return has(overrides, 'height') ? overrides.height : bounds.height;
+}

package/lib/draw/BpmnRenderer.d.ts

@@ -17,66 +17,45 @@ export default class BpmnRenderer extends BaseRenderer {
   constructor(config: BpmnRendererConfig, eventBus: import('diagram-js/lib/core/EventBus').default, styles: import('diagram-js/lib/draw/Styles').default, pathMap: import('./PathMap').default, canvas: import('diagram-js/lib/core/Canvas').default, textRenderer: import('./TextRenderer').default, priority?: number);
 
   handlers: {
-      'bpmn:Event': (parentGfx: any, element: any, attrs: any) => SVGCircleElement;
-      'bpmn:StartEvent': (parentGfx: any, element: any, options: any) => any;
-      'bpmn:MessageEventDefinition': (parentGfx: any, element: any, isThrowing: any) => SVGPathElement;
-      'bpmn:TimerEventDefinition': (parentGfx: any, element: any) => SVGCircleElement;
-      'bpmn:EscalationEventDefinition': (parentGfx: any, event: any, isThrowing: any) => SVGPathElement;
-      'bpmn:ConditionalEventDefinition': (parentGfx: any, event: any) => SVGPathElement;
-      'bpmn:LinkEventDefinition': (parentGfx: any, event: any, isThrowing: any) => SVGPathElement;
-      'bpmn:ErrorEventDefinition': (parentGfx: any, event: any, isThrowing: any) => SVGPathElement;
-      'bpmn:CancelEventDefinition': (parentGfx: any, event: any, isThrowing: any) => SVGPathElement;
-      'bpmn:CompensateEventDefinition': (parentGfx: any, event: any, isThrowing: any) => SVGPathElement;
-      'bpmn:SignalEventDefinition': (parentGfx: any, event: any, isThrowing: any) => SVGPathElement;
-      'bpmn:MultipleEventDefinition': (parentGfx: any, event: any, isThrowing: any) => SVGPathElement;
-      'bpmn:ParallelMultipleEventDefinition': (parentGfx: any, event: any) => SVGPathElement;
-      'bpmn:EndEvent': (parentGfx: any, element: any, options: any) => any;
-      'bpmn:TerminateEventDefinition': (parentGfx: any, element: any) => SVGCircleElement;
-      'bpmn:IntermediateEvent': (parentGfx: any, element: any, options: any) => any;
-      'bpmn:IntermediateCatchEvent': (parentGfx: any, element: any, options: any) => any;
-      'bpmn:IntermediateThrowEvent': (parentGfx: any, element: any, options: any) => any;
-      'bpmn:Activity': (parentGfx: any, element: any, attrs: any) => SVGRectElement;
-      'bpmn:Task': (parentGfx: any, element: any) => any;
-      'bpmn:ServiceTask': (parentGfx: any, element: any) => any;
-      'bpmn:UserTask': (parentGfx: any, element: any) => any;
-      'bpmn:ManualTask': (parentGfx: any, element: any) => any;
-      'bpmn:SendTask': (parentGfx: any, element: any) => any;
-      'bpmn:ReceiveTask': (parentGfx: any, element: any) => any;
-      'bpmn:ScriptTask': (parentGfx: any, element: any) => any;
-      'bpmn:BusinessRuleTask': (parentGfx: any, element: any) => any;
-      'bpmn:SubProcess': (parentGfx: any, element: any, attrs: any) => any;
-      'bpmn:AdHocSubProcess': (parentGfx: any, element: any) => any;
-      'bpmn:Transaction': (parentGfx: any, element: any) => any;
-      'bpmn:CallActivity': (parentGfx: any, element: any) => any;
-      'bpmn:Participant': (parentGfx: any, element: any) => any;
-      'bpmn:Lane': (parentGfx: any, element: any, attrs: any) => SVGRectElement;
-      'bpmn:InclusiveGateway': (parentGfx: any, element: any) => any;
-      'bpmn:ExclusiveGateway': (parentGfx: any, element: any) => any;
-      'bpmn:ComplexGateway': (parentGfx: any, element: any) => any;
-      'bpmn:ParallelGateway': (parentGfx: any, element: any) => any;
-      'bpmn:EventBasedGateway': (parentGfx: any, element: any) => any;
-      'bpmn:Gateway': (parentGfx: any, element: any) => SVGPolygonElement;
-      'bpmn:SequenceFlow': (parentGfx: any, element: any) => SVGElement;
-      'bpmn:Association': (parentGfx: any, element: any, attrs: any) => SVGElement;
-      'bpmn:DataInputAssociation': (parentGfx: any, element: any) => any;
-      'bpmn:DataOutputAssociation': (parentGfx: any, element: any) => any;
-      'bpmn:MessageFlow': (parentGfx: any, element: any) => SVGElement;
-      'bpmn:DataObject': (parentGfx: any, element: any) => SVGPathElement;
-      'bpmn:DataObjectReference': (parentGfx: any, element: any, options: any) => any;
-      'bpmn:DataInput': (parentGfx: any, element: any) => any;
-      'bpmn:DataOutput': (parentGfx: any, element: any) => any;
-      'bpmn:DataStoreReference': (parentGfx: any, element: any) => SVGPathElement;
-      'bpmn:BoundaryEvent': (parentGfx: any, element: any, options: any) => any;
-      'bpmn:Group': (parentGfx: any, element: any) => SVGRectElement;
-      label: (parentGfx: any, element: any) => SVGElement;
-      'bpmn:TextAnnotation': (parentGfx: any, element: any) => SVGRectElement;
-      ParticipantMultiplicityMarker: (parentGfx: any, element: any) => void;
-      SubProcessMarker: (parentGfx: any, element: any) => void;
-      ParallelMarker: (parentGfx: any, element: any, position: any) => void;
-      SequentialMarker: (parentGfx: any, element: any, position: any) => void;
-      CompensationMarker: (parentGfx: any, element: any, position: any) => void;
-      LoopMarker: (parentGfx: any, element: any, position: any) => void;
-      AdhocMarker: (parentGfx: any, element: any, position: any) => void;
+      'bpmn:AdHocSubProcess': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:Association': (parentGfx: any, element: any, attrs?: {}) => SVGElement;
+      'bpmn:BoundaryEvent': (parentGfx: any, element: any, attrs?: {}) => SVGCircleElement;
+      'bpmn:BusinessRuleTask': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:CallActivity': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:ComplexGateway': (parentGfx: any, element: any, attrs?: {}) => SVGPolygonElement;
+      'bpmn:DataInput': (parentGfx: any, element: any, attrs?: {}) => SVGPathElement;
+      'bpmn:DataInputAssociation': (parentGfx: any, element: any, attrs?: {}) => SVGElement;
+      'bpmn:DataObject': (parentGfx: any, element: any, attrs?: {}) => SVGPathElement;
+      'bpmn:DataObjectReference': (parentGfx: any, element: any, attrs: any) => any;
+      'bpmn:DataOutput': (parentGfx: any, element: any, attrs?: {}) => SVGPathElement;
+      'bpmn:DataOutputAssociation': (parentGfx: any, element: any, attrs?: {}) => SVGElement;
+      'bpmn:DataStoreReference': (parentGfx: any, element: any, attrs?: {}) => SVGPathElement;
+      'bpmn:EndEvent': (parentGfx: any, element: any, attrs?: {}) => SVGCircleElement;
+      'bpmn:EventBasedGateway': (parentGfx: any, element: any, attrs?: {}) => SVGPolygonElement;
+      'bpmn:ExclusiveGateway': (parentGfx: any, element: any, attrs?: {}) => SVGPolygonElement;
+      'bpmn:Gateway': (parentGfx: any, element: any, attrs?: {}) => SVGPolygonElement;
+      'bpmn:Group': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:InclusiveGateway': (parentGfx: any, element: any, attrs?: {}) => SVGPolygonElement;
+      'bpmn:IntermediateEvent': (parentGfx: any, element: any, attrs?: {}) => SVGCircleElement;
+      'bpmn:IntermediateCatchEvent': (parentGfx: any, element: any, attrs: any) => any;
+      'bpmn:IntermediateThrowEvent': (parentGfx: any, element: any, attrs: any) => any;
+      'bpmn:Lane': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:ManualTask': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:MessageFlow': (parentGfx: any, element: any, attrs?: {}) => SVGElement;
+      'bpmn:ParallelGateway': (parentGfx: any, element: any, attrs?: {}) => SVGPolygonElement;
+      'bpmn:Participant': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:ReceiveTask': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:ScriptTask': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:SendTask': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:SequenceFlow': (parentGfx: any, element: any, attrs?: {}) => SVGElement;
+      'bpmn:ServiceTask': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:StartEvent': (parentGfx: any, element: any, attrs?: {}) => SVGCircleElement;
+      'bpmn:SubProcess': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:Task': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:TextAnnotation': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:Transaction': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      'bpmn:UserTask': (parentGfx: any, element: any, attrs?: {}) => SVGRectElement;
+      label: (parentGfx: any, element: any, attrs?: {}) => SVGElement;
   };
 
   /**
@@ -91,20 +70,22 @@ export default class BpmnRenderer extends BaseRenderer {
    *
    * @param parentGfx
    * @param element
+   * @param attrs
    *
    * @return mainGfx
    */
-  drawShape(parentGfx: SVGElement, element: Element): SVGElement;
+  drawShape(parentGfx: SVGElement, element: Element, attrs?: Attrs): SVGElement;
 
   /**
    * Draw connection into parentGfx.
    *
    * @param parentGfx
    * @param element
+   * @param attrs
    *
    * @return mainGfx
    */
-  drawConnection(parentGfx: SVGElement, element: Element): SVGElement;
+  drawConnection(parentGfx: SVGElement, element: Element, attrs?: Attrs): SVGElement;
 
   /**
    * Get shape path.
@@ -122,5 +103,12 @@ export type BpmnRendererConfig = Partial<{
     defaultLabelColor: string;
 }>;
 
+export type Attrs = Partial<{
+    fill: string;
+    stroke: string;
+    width: string;
+    height: string;
+}>;
+
 type Element = import('../model/Types').Element;
 import BaseRenderer from 'diagram-js/lib/draw/BaseRenderer';