feat: add elementTemplates as default engine

`elementTemplates` engine is by default set to `bpmn-js-elements-template` version.
This allows templates authors to indicate compatibility with specific library versions.

karma.config.js

@@ -1,6 +1,9 @@
 /* eslint-env node */
 
 const path = require('path');
+
+const pkg = require('./package.json');
+
 const {
   DefinePlugin,
   NormalModuleReplacementPlugin
@@ -93,6 +96,9 @@ module.exports = function(karma) {
       plugins: [
         new DefinePlugin({
 
+          // @nikku needs to be defined
+          'process.env.PKG_VERSION': JSON.stringify(pkg.version),
+
           // @barmac: process.env has to be defined to make @testing-library/preact work
           'process.env': {}
         }),

package.json

@@ -85,6 +85,7 @@
     "@rollup/plugin-commonjs": "^28.0.1",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.3.0",
+    "@rollup/plugin-replace": "^6.0.1",
     "@testing-library/preact": "^2.0.1",
     "@testing-library/preact-hooks": "^1.1.0",
     "assert": "^2.1.0",

rollup.config.mjs

@@ -4,6 +4,7 @@ import commonjs from '@rollup/plugin-commonjs';
 import copy from 'rollup-plugin-copy';
 import json from '@rollup/plugin-json';
 import resolve from '@rollup/plugin-node-resolve';
+import replace from '@rollup/plugin-replace';
 
 import {
   readFileSync
@@ -81,6 +82,12 @@ function pgl(plugins = []) {
 function corePlugins(plugins = []) {
   return [
     ...plugins,
+    replace({
+      preventAssignment: true,
+      values: {
+        'process.env.PKG_VERSION': JSON.stringify(pkg.version)
+      }
+    }),
     json(),
     resolve({
       mainFields: [

src/cloud-element-templates/linting/rules/element-templates-compatibility.js

@@ -83,11 +83,6 @@ export default function({ templates = [] }) {
 // helpers //////////////////////
 
 function getEnginesConfig(definitions) {
-  const {
-    exporter,
-    exporterVersion
-  } = definitions;
-
   const engines = {};
 
   const executionPlatform = definitions.get('modeler:executionPlatform');
@@ -97,10 +92,6 @@ function getEnginesConfig(definitions) {
     engines.camunda = executionPlatformVersion;
   }
 
-  if (exporter === 'Camunda Modeler' && exporterVersion) {
-    engines.camundaDesktopModeler = exporterVersion;
-  }
-
   return engines;
 }
 

src/element-templates/ElementTemplates.js

@@ -24,6 +24,10 @@ import {
   coerce
 } from 'semver';
 
+// eslint-disable-next-line no-undef
+const packageVersion = process.env.PKG_VERSION;
+
+
 /**
  * Registry for element templates.
  */
@@ -155,6 +159,7 @@ export default class ElementTemplates {
   }
 
   setEngines(engines) {
+
     this._engines = this._coerceEngines(engines);
 
     this._fire('engines.changed');
@@ -169,6 +174,14 @@ export default class ElementTemplates {
    */
   _coerceEngines(engines) {
 
+    // we provide <elementTemplates> engine with the current
+    // package version; templates may use that engine to declare
+    // compatibility with this library
+    engines = {
+      elementTemplates: packageVersion,
+      ...engines
+    };
+
     return reduce(engines, (validEngines, version, engine) => {
 
       const coercedVersion = coerce(version);

test/spec/cloud-element-templates/ElementTemplates.spec.js

@@ -34,6 +34,9 @@ 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';
 
+// eslint-disable-next-line no-undef
+const packageVersion = process.env.PKG_VERSION;
+
 
 describe('provider/cloud-element-templates - ElementTemplates', function() {
 
@@ -785,6 +788,15 @@ describe('provider/cloud-element-templates - ElementTemplates', function() {
 
   describe('getEngines', function() {
 
+    it('should provide default <elementTemplates> engine', inject(function(elementTemplates) {
+
+      // then
+      expect(
+        elementTemplates.getEngines()
+      ).to.have.property('elementTemplates', packageVersion);
+    }));
+
+
     it('should provide set engines', inject(function(elementTemplates) {
 
       // when
@@ -795,9 +807,11 @@ describe('provider/cloud-element-templates - ElementTemplates', function() {
 
       // then
       expect(elementTemplates.getEngines()).to.eql({
+        'elementTemplates': packageVersion,
         'camunda': '8.0.0',
         'other': '100.5.0'
       });
+
     }));
 
   });
@@ -819,6 +833,18 @@ describe('provider/cloud-element-templates - ElementTemplates', function() {
       expect(spy).to.have.been.calledOnce;
     }));
 
+
+    it('should override <elementTemplates> engine', inject(function(elementTemplates) {
+
+      // when
+      elementTemplates.setEngines({
+        elementTemplates: '1.0.0'
+      });
+
+      // then
+      expect(elementTemplates.getEngines()).to.have.property('elementTemplates', '1.0.0');
+    }));
+
   });