fix(element-templates): trigger create mode if auto place not possible

Related to camunda/camunda-modeler#5193

Author: philippfromme

lib/element-templates/append-menu/ElementTemplatesAppendProvider.js

@@ -141,23 +141,45 @@ ElementTemplatesAppendProvider.prototype._filterTemplates = function(templates)
  * @returns {Object}
  */
 ElementTemplatesAppendProvider.prototype._getEntryAction = function(element, template) {
-  return {
-
-    click: () => {
-      const newElement = this._elementTemplates.createElement(template);
-      this._autoPlace.append(element, newElement);
-    },
+  const autoPlaceElement = () => {
+    const newElement = this._elementTemplates.createElement(template);
 
-    dragstart: (event) => {
-      const newElement = this._elementTemplates.createElement(template);
+    this._autoPlace.append(element, newElement);
+  };
 
-      if (event instanceof KeyboardEvent) {
-        event = this._mouse.getLastMoveEvent();
-      }
+  const manualPlaceElement = (event) => {
+    const newElement = this._elementTemplates.createElement(template);
 
-      this._create.start(event, newElement, {
-        source: element
-      });
+    if (event instanceof KeyboardEvent) {
+      event = this._mouse.getLastMoveEvent();
     }
+
+    return this._create.start(event, newElement, {
+      source: element
+    });
+  };
+
+  return {
+    click: canAutoPlaceElement(template) ? autoPlaceElement : manualPlaceElement,
+    dragstart: manualPlaceElement
   };
 };
+
+function canAutoPlaceElement(elementTemplate) {
+  const {
+    appliesTo = [],
+    elementType = {}
+  } = elementTemplate;
+
+  const type = elementType.value || appliesTo[0];
+
+  if (type === 'bpmn:BoundaryEvent') {
+    return false;
+  }
+
+  if (type === 'bpmn:IntermediateCatchEvent' && elementType.eventDefinition === 'bpmn:LinkEventDefinition') {
+    return false;
+  }
+
+  return true;
+}

test/fixtures/element-templates.json

@@ -11,7 +11,7 @@
         "type": "Boolean",
         "binding": {
           "type": "property",
-          "name": "customProperty"
+          "name": "foo"
         }
       }
     ]
@@ -34,7 +34,7 @@
       {
         "binding": {
           "type": "property",
-          "name": "someProp"
+          "name": "foo"
         }
       }
     ]
@@ -57,7 +57,7 @@
       {
         "binding": {
           "type": "property",
-          "name": "someProp"
+          "name": "foo"
         }
       }
     ]
@@ -98,5 +98,45 @@
       "first keyword",
       "another keyword"
     ]
+  },
+  {
+    "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
+    "name": "Message Boundary Event Template",
+    "id": "example.MessageBoundaryEventTemplate",
+    "appliesTo": [
+      "bpmn:BoundaryEvent"
+    ],
+    "elementType": {
+      "value": "bpmn:BoundaryEvent",
+      "eventDefinition": "bpmn:MessageEventDefinition"
+    },
+    "properties": [
+      {
+        "binding": {
+          "type": "property",
+          "name": "foo"
+        }
+      }
+    ]
+  },
+  {
+    "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
+    "name": "Link Intermediate Catch Event Template",
+    "id": "example.LinkIntermediateCatchEventTemplate",
+    "appliesTo": [
+      "bpmn:IntermediateCatchEvent"
+    ],
+    "elementType": {
+      "value": "bpmn:IntermediateCatchEvent",
+      "eventDefinition": "bpmn:LinkEventDefinition"
+    },
+    "properties": [
+      {
+        "binding": {
+          "type": "property",
+          "name": "foo"
+        }
+      }
+    ]
   }
 ]

test/spec/create-append-anything/append-menu/AppendMenuProvider.spec.js

@@ -430,7 +430,6 @@ describe('features/create-append-anything - append menu provider', function() {
 
           // then
           expect(spy).to.have.been.called;
-
         }));
 
 
@@ -450,7 +449,6 @@ describe('features/create-append-anything - append menu provider', function() {
 
           // then
           expect(spy).to.have.been.called;
-
         }));
 
       });

test/spec/element-templates/append-menu/ElementTemplatesAppendProvider.spec.js

@@ -207,6 +207,48 @@ describe('<ElementTemplatesAppendProvider>', function() {
       expect(isTemplateApplied(newElement, template)).to.be.true;
     }));
 
+
+    describe('should trigger create mode', function() {
+
+      it('boundary event', inject(function(elementRegistry, eventBus) {
+
+        // given
+        const task = elementRegistry.get('Task_1');
+
+        const spy = sinon.spy();
+
+        eventBus.on('create.init', spy);
+
+        // when
+        openPopup(task);
+
+        triggerAction('append.template-example.MessageBoundaryEventTemplate');
+
+        // then
+        expect(spy).to.have.been.called;
+      }));
+
+
+      it('link intermediate catch event', inject(function(elementRegistry, eventBus) {
+
+        // given
+        const task = elementRegistry.get('Task_1');
+
+        const spy = sinon.spy();
+
+        eventBus.on('create.init', spy);
+
+        // when
+        openPopup(task);
+
+        triggerAction('append.template-example.LinkIntermediateCatchEventTemplate');
+
+        // then
+        expect(spy).to.have.been.called;
+      }));
+
+    });
+
   });