camunda-bpmn-js 5.5.1 → 5.6.1

package/lib/camunda-cloud/Modeler.js

@@ -29,6 +29,8 @@ import {
   CreateAppendElementTemplatesModule as createAppendElementTemplatesModule
 } from 'bpmn-js-create-append-anything';
 
+import camundaDetailsPopupMenuModule from './features/popup-menu';
+
 /**
  * @typedef {import('bpmn-js/lib/BaseViewer').BaseViewerOptions} BaseViewerOptions
  */
@@ -96,7 +98,8 @@ Modeler.prototype._camundaCloudModules = [
   colorPickerModule,
   variableResolverModule,
   exampleDataPropertiesProviderModule,
-  formVariableProviderModule
+  formVariableProviderModule,
+  camundaDetailsPopupMenuModule
 ];
 
 Modeler.prototype._modules = [].concat(

package/lib/camunda-cloud/features/popup-menu/CamundaDetailsPopupMenuProvider.d.ts

@@ -0,0 +1,26 @@
+export default class CamundaDetailsPopupMenuProvider {
+  static $inject: string[];
+
+  /**
+   * @param popupMenu
+   *
+   * @implements PopupMenuProvider
+   */
+  constructor(popupMenu: PopupMenu);
+
+  /**
+   * Register create menu provider in the popup menu
+   */
+  register(): void;
+
+  /**
+   * Returns the create options as menu entries
+   *
+   * @param _element
+   */
+  getPopupMenuEntries(_element: Element): (existingEntries: PopupMenuEntries) => PopupMenuEntries;
+}
+
+type PopupMenu = import("diagram-js/lib/features/popup-menu/PopupMenu").default;
+type Element = import("diagram-js/lib/model").Element;
+type PopupMenuEntries = import("diagram-js/lib/features/popup-menu/PopupMenuProvider").PopupMenuEntries;

package/lib/camunda-cloud/features/popup-menu/CamundaDetailsPopupMenuProvider.js

@@ -0,0 +1,149 @@
+/**
+ * @typedef { import('diagram-js/lib/features/popup-menu/PopupMenu').default } PopupMenu
+ * @typedef { import('diagram-js/lib/model').Element } Element
+ * @typedef { import('diagram-js/lib/features/popup-menu/PopupMenuProvider').PopupMenuEntries } PopupMenuEntries
+ */
+
+import { reduce } from 'min-dash';
+
+const LOW_PRIORITY = 250;
+
+const ANNOTATIONS = [
+  {
+    entries: [
+      'replace-with-call-activity',
+      'append-call-activity',
+      'create-call-activity'
+    ],
+    search: 'child process'
+  },
+  {
+    entries: [
+      'replace-with-receive-task',
+      'append-receive-task',
+      'create-receive-task'
+    ],
+    search: 'message'
+  },
+  {
+    entries: [
+      'replace-with-rule-task',
+      'append-rule-task',
+      'create-rule-task'
+    ],
+    search: 'dmn decision'
+  },
+  {
+    entries: [
+      'replace-with-service-task',
+      'append-service-task',
+      'create-service-task',
+      'replace-with-script-task',
+      'append-script-task',
+      'create-script-task',
+      'replace-with-send-task',
+      'append-send-task',
+      'create-send-task',
+      'replace-with-message-intermediate-throw',
+      'append-message-intermediate-throw',
+      'create-message-intermediate-throw',
+      'replace-with-message-end',
+      'append-message-end',
+      'create-message-end'
+    ],
+    search: 'job worker'
+  },
+  {
+    entries: [
+      'replace-with-user-task',
+      'append-user-task',
+      'create-user-task'
+    ],
+    search: 'form human'
+  }
+];
+
+const ANNOTATIONS_KEYED = reduce(ANNOTATIONS, (annotationsKeyed, annotation) => {
+
+  const { entries, search } = annotation;
+
+  for (const entry of entries) {
+    if (annotationsKeyed[entry]) {
+      annotationsKeyed[entry].search += ' ' + search;
+    } else {
+      annotationsKeyed[entry] = { search };
+    }
+  }
+
+  return annotationsKeyed;
+}, {});
+
+
+/**
+ * @param { PopupMenu } popupMenu
+ *
+ * @implements PopupMenuProvider
+ */
+export default function CamundaDetailsPopupMenuProvider(popupMenu) {
+
+  this._popupMenu = popupMenu;
+
+  this.register();
+}
+
+CamundaDetailsPopupMenuProvider.$inject = [ 'popupMenu' ];
+
+
+/**
+ * Register create menu provider in the popup menu
+ */
+CamundaDetailsPopupMenuProvider.prototype.register = function() {
+
+  // plug-into create-append-anything <create> menu
+  this._popupMenu.registerProvider('bpmn-create', LOW_PRIORITY, this);
+
+  // plug-into create-append-anything <append> menu
+  this._popupMenu.registerProvider('bpmn-append', LOW_PRIORITY, this);
+
+  // plug-into <replace> menu
+  this._popupMenu.registerProvider('bpmn-replace', LOW_PRIORITY, this);
+};
+
+
+/**
+ * Returns the create options as menu entries
+ *
+ * @param { Element } _element
+ */
+CamundaDetailsPopupMenuProvider.prototype.getPopupMenuEntries = function(_element) {
+
+  /**
+   * @param { PopupMenuEntries } existingEntries
+   *
+   * @return { PopupMenuEntries }
+   */
+  return (existingEntries) => {
+
+    return Object.entries(existingEntries).reduce((entries, [ name, entry ]) => {
+
+      entries[name] = this._annotateEntry(name, entry);
+
+      return entries;
+    }, { });
+  };
+
+};
+
+CamundaDetailsPopupMenuProvider.prototype._annotateEntry = function(name, entry) {
+
+  const annotation = ANNOTATIONS_KEYED[name];
+
+  if (annotation) {
+    return {
+      ...entry,
+      search: entry.search ? `${ entry.search } ${ annotation.search }` : annotation.search
+    };
+  }
+
+  return entry;
+};

package/lib/camunda-cloud/features/popup-menu/index.d.ts

@@ -0,0 +1,6 @@
+declare namespace _default {
+    let __init__: string[];
+    let camundaDetailsPopupMenuProvider: (string | typeof CamundaDetailsPopupMenuProvider)[];
+}
+export default _default;
+import CamundaDetailsPopupMenuProvider from './CamundaDetailsPopupMenuProvider.js';

package/lib/camunda-cloud/features/popup-menu/index.js

@@ -0,0 +1,6 @@
+import CamundaDetailsPopupMenuProvider from './CamundaDetailsPopupMenuProvider.js';
+
+export default {
+  __init__: [ 'camundaDetailsPopupMenuProvider' ],
+  camundaDetailsPopupMenuProvider: [ 'type', CamundaDetailsPopupMenuProvider ]
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "camunda-bpmn-js",
-  "version": "5.5.1",
+  "version": "5.6.1",
   "description": "Embeddable Camunda modeling distributions based on bpmn-js",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -56,13 +56,13 @@
     "@bpmn-io/element-template-chooser": "^1.0.0",
     "@bpmn-io/element-template-icon-renderer": "^0.5.2",
     "@bpmn-io/form-variable-provider": "^1.3.0",
-    "@bpmn-io/properties-panel": "^3.26.0",
+    "@bpmn-io/properties-panel": "^3.26.2",
     "@bpmn-io/variable-resolver": "^1.3.3",
     "@camunda/example-data-properties-provider": "^1.2.1",
-    "bpmn-js": "^18.2.0",
+    "bpmn-js": "^18.3.1",
     "bpmn-js-color-picker": "^0.7.1",
     "bpmn-js-create-append-anything": "^0.6.0",
-    "bpmn-js-element-templates": "^2.5.2",
+    "bpmn-js-element-templates": "^2.5.3",
     "bpmn-js-executable-fix": "^0.2.1",
     "camunda-bpmn-js-behaviors": "^1.9.1",
     "camunda-bpmn-moddle": "^7.0.1",
@@ -83,7 +83,7 @@
     "babel-loader": "^9.2.1",
     "babel-plugin-istanbul": "^7.0.0",
     "bio-dts": "^0.11.0",
-    "bpmn-js-properties-panel": "^5.31.1",
+    "bpmn-js-properties-panel": "^5.32.1",
     "chai": "^4.5.0",
     "cross-env": "^7.0.3",
     "del-cli": "^6.0.0",