feat: add elementTemplates as default engine

bpmn-io · Dec 11, 2024 · 7414cbe · 7414cbe
1 parent 84a37a2
commit 7414cbe
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 3 deletions.
diff --git a/src/cloud-element-templates/linting/rules/element-templates-compatibility.js b/src/cloud-element-templates/linting/rules/element-templates-compatibility.js
@@ -32,15 +32,24 @@ export default function({ templates = [] }) {
 
   elementTemplates.set(validTemplates);
 
+  let enginesSet = false;
+
   function setEngines(engines) {
 
-    const isEmpty = (obj) => Object.keys(obj).length === 0;
+    const enginesEmpty = Object.keys(engines).length === 0;
 
-    if (isEmpty(engines) || !isEmpty(elementTemplates.getEngines())) {
+    if (enginesEmpty || enginesSet) {
       return;
     }
 
-    elementTemplates.setEngines(engines);
+    elementTemplates.setEngines({
+
+      // Make sure not to overwrite default engines
+      ...elementTemplates.getEngines(),
+      ...engines
+    });
+
+    enginesSet = true;
   }
 
   function isUpdateAvailable(template) {

diff --git a/src/element-templates/ElementTemplates.js b/src/element-templates/ElementTemplates.js
@@ -24,6 +24,8 @@ import {
   coerce
 } from 'semver';
 
+import packageInfo from 'package.json';
+
 /**
  * Registry for element templates.
  */
@@ -41,6 +43,11 @@ export default class ElementTemplates {
 
     this._engines = this._coerceEngines(config.engines || {});
 
+    // Provide `elementTemplates` engine as current package version.
+    // Templates can use this to specify compatibility with the library.
+    const { version } = packageInfo;
+    this._engines.elementTemplates = version;
+
     eventBus.on('elementTemplates.engines.changed', event => {
       this.set(this._templates);
     });

diff --git a/test/spec/cloud-element-templates/ElementTemplates.spec.js b/test/spec/cloud-element-templates/ElementTemplates.spec.js
@@ -34,6 +34,8 @@ import { findExtensions, findExtension } from 'src/cloud-element-templates/Helpe
 import { getLabel } from 'bpmn-js/lib/features/label-editing/LabelUtil';
 import { findMessage } from 'src/cloud-element-templates/Helper';
 
+import packageInfo from 'package.json';
+
 
 describe('provider/cloud-element-templates - ElementTemplates', function() {
 
@@ -782,6 +784,19 @@ describe('provider/cloud-element-templates - ElementTemplates', function() {
 
   });
 
+  describe('getEngines', function() {
+
+    it('should have default <elementTemplates> engine set to package version', inject(function(elementTemplates) {
+
+      // given
+      const { version } = packageInfo;
+
+      // then
+      expect(elementTemplates.getEngines()).to.have.property('elementTemplates', version);
+    }));
+
+  });
+
 
   describe('setEngines', function() {