camunda-bpmn-js 5.6.2 → 5.7.1

package/lib/camunda-cloud/features/external-resources/handlers/form/replaceElement.js

@@ -0,0 +1,82 @@
+import { getBusinessObject, is } from 'bpmn-js/lib/util/ModelUtil';
+
+/**
+ * @typedef {{
+*   type: 'form',
+*   name: string,
+*   formId: string
+* }} Form
+*/
+
+/**
+ * @param {import('diagram-js/lib/model').Element} element
+ * @param {Form} resource
+ * @param {import('didi').Injector} injector
+*/
+export function replaceElement(element, resource, injector) {
+  const bpmnFactory = injector.get('bpmnFactory'),
+        bpmnReplace = injector.get('bpmnReplace'),
+        modeling = injector.get('modeling'),
+        commandStack = injector.get('commandStack');
+
+
+  commandStack.execute('external-resources.composed-command', {
+    command: replace
+  });
+
+
+  function replace() {
+    const replacedElement = bpmnReplace.replaceElement(element, { type: 'bpmn:UserTask' });
+    modeling.updateProperties(replacedElement, {
+      name: resource.name
+    });
+
+    const bo = getBusinessObject(replacedElement);
+
+    const extensionElements = bo.get('extensionElements');
+
+    if (!extensionElements) {
+      modeling.updateProperties(replacedElement, {
+        extensionElements: bpmnFactory.create('bpmn:ExtensionElements', {
+          values: [
+            createZeebeUserTask(bpmnFactory),
+            createFormDefinition(resource, bpmnFactory)
+          ]
+        })
+      });
+
+      return;
+    }
+
+    const formDefinition = getFormDefinition(replacedElement);
+
+    if (!formDefinition) {
+      modeling.updateModdleProperties(replacedElement, extensionElements, {
+        values: [
+          ...extensionElements.values,
+          createFormDefinition(resource, bpmnFactory)
+        ]
+      });
+
+      return;
+    }
+
+    modeling.updateModdleProperties(replacedElement, formDefinition, {
+      formId: resource.formId
+    });
+  }
+}
+
+function getFormDefinition(element) {
+  return element.businessObject?.extensionElements?.values.find(value => is(value, 'zeebe:FormDefinition'));
+}
+
+function createFormDefinition(resource, bpmnFactory) {
+  return bpmnFactory.create('zeebe:FormDefinition', {
+    formId: resource.formId
+  });
+}
+
+function createZeebeUserTask(bpmnFactory) {
+  return bpmnFactory.create('zeebe:UserTask');
+}

package/lib/camunda-cloud/features/external-resources/handlers/form/searchTerms.d.ts

@@ -0,0 +1 @@
+export const searchTerms: string;

package/lib/camunda-cloud/features/external-resources/handlers/form/searchTerms.js

@@ -0,0 +1,6 @@
+export const searchTerms = [
+  'resource',
+  'form',
+  'user task',
+  'human'
+].join(' ');

package/lib/camunda-cloud/features/external-resources/handlers/process/AppendMenuProvider.d.ts

@@ -0,0 +1,5 @@
+export class AppendMenuProvider extends BaseAppendMenuProvider {
+    static $inject: string[];
+    constructor(injector: any);
+}
+import { BaseAppendMenuProvider } from '../util/BaseAppendMenuProvider.js';

package/lib/camunda-cloud/features/external-resources/handlers/process/AppendMenuProvider.js

@@ -0,0 +1,19 @@
+import { createElement } from './createElement.js';
+import { searchTerms } from './searchTerms.js';
+import { BaseAppendMenuProvider } from '../util/BaseAppendMenuProvider.js';
+
+export class AppendMenuProvider extends BaseAppendMenuProvider {
+  static $inject = [
+    'injector'
+  ];
+
+  constructor(injector) {
+    super(injector, {
+      resourceType: 'bpmnProcess',
+      groupName: 'Processes',
+      className: 'bpmn-icon-call-activity',
+      createElement: (resource, bpmnFactory) => createElement(resource, bpmnFactory),
+      search: searchTerms
+    });
+  }
+}

package/lib/camunda-cloud/features/external-resources/handlers/process/CreateMenuProvider.d.ts

@@ -0,0 +1,5 @@
+export class CreateMenuProvider extends BaseCreateMenuProvider {
+    static $inject: string[];
+    constructor(injector: any);
+}
+import { BaseCreateMenuProvider } from '../util/BaseCreateMenuProvider.js';

package/lib/camunda-cloud/features/external-resources/handlers/process/CreateMenuProvider.js

@@ -0,0 +1,19 @@
+import { createElement } from './createElement.js';
+import { searchTerms } from './searchTerms.js';
+import { BaseCreateMenuProvider } from '../util/BaseCreateMenuProvider.js';
+
+export class CreateMenuProvider extends BaseCreateMenuProvider {
+  static $inject = [
+    'injector'
+  ];
+
+  constructor(injector) {
+    super(injector, {
+      resourceType: 'bpmnProcess',
+      groupName: 'Processes',
+      className: 'bpmn-icon-call-activity',
+      createElement: (resource, bpmnFactory) => createElement(resource, bpmnFactory),
+      search: searchTerms
+    });
+  }
+}

package/lib/camunda-cloud/features/external-resources/handlers/process/ReplaceMenuProvider.d.ts

@@ -0,0 +1,5 @@
+export class ReplaceMenuProvider extends BaseReplaceMenuProvider {
+    static $inject: string[];
+    constructor(injector: any);
+}
+import { BaseReplaceMenuProvider } from '../util/BaseReplaceMenuProvider.js';

package/lib/camunda-cloud/features/external-resources/handlers/process/ReplaceMenuProvider.js

@@ -0,0 +1,19 @@
+import { replaceElement } from './replaceElement.js';
+import { searchTerms } from './searchTerms.js';
+import { BaseReplaceMenuProvider } from '../util/BaseReplaceMenuProvider.js';
+
+export class ReplaceMenuProvider extends BaseReplaceMenuProvider {
+  static $inject = [
+    'injector'
+  ];
+
+  constructor(injector) {
+    super(injector, {
+      resourceType: 'bpmnProcess',
+      groupName: 'Processes',
+      className: 'bpmn-icon-call-activity',
+      replaceElement: (element, resource, injector) => replaceElement(element, resource, injector),
+      search: searchTerms
+    });
+  }
+}

package/lib/camunda-cloud/features/external-resources/handlers/process/createElement.d.ts

@@ -0,0 +1,14 @@
+/**
+ *
+ * @param resource
+ * @param bpmnFactory
+ */
+export function createElement(
+  resource: CallActivity,
+  bpmnFactory: import("bpmn-js/lib/features/modeling/BpmnFactory").default
+): any;
+export type CallActivity = {
+    type: "bpmnProcess";
+    name: string;
+    processId: string;
+};

package/lib/camunda-cloud/features/external-resources/handlers/process/createElement.js

@@ -0,0 +1,36 @@
+/**
+ * @typedef {{
+ *   type: 'bpmnProcess',
+ *   name: string,
+ *   processId: string
+ * }} CallActivity
+ */
+
+/**
+ *
+ * @param {CallActivity} resource
+ * @param {import('bpmn-js/lib/features/modeling/BpmnFactory').default} bpmnFactory
+ */
+export function createElement(resource, bpmnFactory) {
+  return createCallActivity(resource, bpmnFactory);
+}
+
+function createCallActivity(resource, bpmnFactory) {
+  const calledElement = createCalledElement(resource, bpmnFactory);
+  const extensionElements = bpmnFactory.create('bpmn:ExtensionElements', {
+    values: [
+      calledElement
+    ]
+  });
+
+  return bpmnFactory.create('bpmn:CallActivity', {
+    name: resource.name,
+    extensionElements
+  });
+}
+
+function createCalledElement(resource, bpmnFactory) {
+  return bpmnFactory.create('zeebe:CalledElement', {
+    processId: resource.processId
+  });
+}

package/lib/camunda-cloud/features/external-resources/handlers/process/index.d.ts

@@ -0,0 +1,8 @@
+export const ProcessHandlerModule: {
+  'resources.processHandler.create': (string | typeof CreateMenuProvider)[];
+  'resources.processHandler.append': (string | typeof AppendMenuProvider)[];
+  'resources.processHandler.replace': (string | typeof ReplaceMenuProvider)[];
+};
+import { CreateMenuProvider } from './CreateMenuProvider';
+import { AppendMenuProvider } from './AppendMenuProvider';
+import { ReplaceMenuProvider } from './ReplaceMenuProvider';

package/lib/camunda-cloud/features/external-resources/handlers/process/index.js

@@ -0,0 +1,14 @@
+import { CreateMenuProvider } from './CreateMenuProvider';
+import { AppendMenuProvider } from './AppendMenuProvider';
+import { ReplaceMenuProvider } from './ReplaceMenuProvider';
+
+export const ProcessHandlerModule = {
+  __init__: [
+    'resources.processHandler.create',
+    'resources.processHandler.append',
+    'resources.processHandler.replace'
+  ],
+  'resources.processHandler.create': [ 'type', CreateMenuProvider ],
+  'resources.processHandler.append': [ 'type', AppendMenuProvider ],
+  'resources.processHandler.replace': [ 'type', ReplaceMenuProvider ]
+};

package/lib/camunda-cloud/features/external-resources/handlers/process/replaceElement.d.ts

@@ -0,0 +1,16 @@
+/**
+ *
+ * @param element
+ * @param resource
+ * @param injector
+ */
+export function replaceElement(
+  element: import("diagram-js/lib/model").Element,
+  resource: CallActivity,
+  injector: import("didi").Injector
+): void;
+export type CallActivity = {
+    type: "bpmnProcess";
+    name: string;
+    processId: string;
+};

package/lib/camunda-cloud/features/external-resources/handlers/process/replaceElement.js

@@ -0,0 +1,78 @@
+import { getBusinessObject, is } from 'bpmn-js/lib/util/ModelUtil';
+
+/**
+ * @typedef {{
+ *   type: 'bpmnProcess',
+ *   name: string,
+ *   processId: string
+ * }} CallActivity
+ */
+
+/**
+ *
+ * @param {import('diagram-js/lib/model').Element} element
+ * @param {CallActivity} resource
+ * @param {import('didi').Injector} injector
+ */
+export function replaceElement(element, resource, injector) {
+  const bpmnFactory = injector.get('bpmnFactory'),
+        bpmnReplace = injector.get('bpmnReplace'),
+        modeling = injector.get('modeling'),
+        commandStack = injector.get('commandStack');
+
+
+  commandStack.execute('external-resources.composed-command', {
+    command: replace
+  });
+
+
+  function replace() {
+    const replacedElement = bpmnReplace.replaceElement(element, { type: 'bpmn:CallActivity' });
+    modeling.updateProperties(replacedElement, {
+      name: resource.name
+    });
+
+    const bo = getBusinessObject(replacedElement);
+
+    const extensionElements = bo.get('extensionElements');
+
+    if (!extensionElements) {
+      modeling.updateProperties(replacedElement, {
+        extensionElements: bpmnFactory.create('bpmn:ExtensionElements', {
+          values: [
+            createCalledElement(resource, bpmnFactory)
+          ]
+        })
+      });
+
+      return;
+    }
+
+    const calledElement = getCalledElement(replacedElement);
+
+    if (!calledElement) {
+      modeling.updateModdleProperties(replacedElement, extensionElements, {
+        values: [
+          ...extensionElements.values,
+          createCalledElement(resource, bpmnFactory)
+        ]
+      });
+
+      return;
+    }
+
+    modeling.updateModdleProperties(replacedElement, calledElement, {
+      processId: resource.processId
+    });
+  }
+}
+
+function getCalledElement(element) {
+  return element.businessObject?.extensionElements?.values.find(value => is(value, 'zeebe:CalledElement'));
+}
+
+function createCalledElement(resource, bpmnFactory) {
+  return bpmnFactory.create('zeebe:CalledElement', {
+    processId: resource.processId
+  });
+}

package/lib/camunda-cloud/features/external-resources/handlers/process/searchTerms.d.ts

@@ -0,0 +1 @@
+export const searchTerms: string;

package/lib/camunda-cloud/features/external-resources/handlers/process/searchTerms.js

@@ -0,0 +1,6 @@
+export const searchTerms = [
+  'resource',
+  'bpmn',
+  'call activity',
+  'child process'
+].join(' ');

package/lib/camunda-cloud/features/external-resources/handlers/util/BaseAppendMenuProvider.d.ts

@@ -0,0 +1,18 @@
+export class BaseAppendMenuProvider {
+  /**
+   *
+   * @param injector
+   * @param config
+   */
+  constructor(injector: import("didi").Injector, config: Config);
+
+  /** @returns */
+  getPopupMenuEntries(element: any): import("diagram-js/lib/features/popup-menu/PopupMenuProvider").PopupMenuEntries;
+}
+export type Config = {
+    resourceType: string;
+    className: string;
+    groupName: string;
+    createElement: Function;
+    search?: string;
+};

package/lib/camunda-cloud/features/external-resources/handlers/util/BaseAppendMenuProvider.js

@@ -0,0 +1,103 @@
+/**
+ * @typedef {object} Config
+ * @property {string} resourceType
+ * @property {string} className
+ * @property {string} groupName
+ * @property {Function} createElement
+ * @property {string} [search]
+ */
+
+export class BaseAppendMenuProvider {
+
+  /**
+   *
+   * @param {import('didi').Injector} injector
+   * @param {Config} config
+   */
+  constructor(injector, config) {
+    this._elementFactory = injector.get('elementFactory');
+    this._bpmnFactory = injector.get('bpmnFactory');
+    this._popupMenu = injector.get('popupMenu');
+    this._create = injector.get('create');
+    this._autoPlace = injector.get('autoPlace');
+    this._rules = injector.get('rules');
+    this._translate = injector.get('translate');
+    this._resources = injector.get('resources');
+
+    this._config = config;
+
+    this._register();
+  }
+
+  _register() {
+    this._popupMenu.registerProvider('bpmn-append', this);
+  };
+
+  /** @returns {import('diagram-js/lib/features/popup-menu/PopupMenuProvider').PopupMenuEntries} */
+  getPopupMenuEntries(element) {
+    const rules = this._rules;
+
+    if (!rules.allowed('shape.append', { element: element })) {
+      return [];
+    }
+
+    const {
+      resourceType,
+      className,
+      groupName,
+      createElement,
+      search
+    } = this._config;
+
+    const resources = this._resources.filter(r => r.type === resourceType);
+    const entries = {};
+
+    resources.forEach((resource, index) => {
+      const getTarget = () => createElement(resource, this._bpmnFactory);
+      entries[`resources-append-${resourceType}-${index}`] = {
+        label: resource.name,
+        action: this._createEntryAction(element, getTarget),
+        group: {
+          id: groupName.toLowerCase(),
+          name: this._translate(groupName)
+        },
+        className,
+        search
+      };
+    });
+
+    return entries;
+  };
+
+  _createEntryAction(element, targetFactory) {
+    const elementFactory = this._elementFactory;
+    const autoPlace = this._autoPlace;
+    const create = this._create;
+
+    const createElement = () => {
+      const businessObject = targetFactory();
+
+      return elementFactory.createShape({
+        type: businessObject.$type,
+        businessObject: businessObject
+      });
+    };
+
+    const autoPlaceElement = () => {
+      const newElement = createElement();
+      autoPlace.append(element, newElement);
+    };
+
+    const manualPlaceElement = (event) => {
+      const newElement = createElement();
+      return create.start(event, newElement, {
+        source: element
+      });
+    };
+
+    return {
+      click: autoPlaceElement,
+      dragstart: manualPlaceElement
+    };
+  }
+}

package/lib/camunda-cloud/features/external-resources/handlers/util/BaseCreateMenuProvider.d.ts

@@ -0,0 +1,17 @@
+export class BaseCreateMenuProvider {
+  /**
+   *
+   * @param injector
+   * @param config
+   */
+  constructor(injector: import("didi").Injector, config: Config);
+
+  getPopupMenuEntries(): {};
+}
+export type Config = {
+    resourceType: string;
+    className: string;
+    groupName: string;
+    createElement: Function;
+    search?: string;
+};

package/lib/camunda-cloud/features/external-resources/handlers/util/BaseCreateMenuProvider.js

@@ -0,0 +1,84 @@
+/**
+ * @typedef {object} Config
+ * @property {string} resourceType
+ * @property {string} className
+ * @property {string} groupName
+ * @property {Function} createElement
+ * @property {string} [search]
+ */
+
+export class BaseCreateMenuProvider {
+
+  /**
+   *
+   * @param {import('didi').Injector} injector
+   * @param {Config} config
+   */
+  constructor(injector, config) {
+    this._elementFactory = injector.get('elementFactory');
+    this._bpmnFactory = injector.get('bpmnFactory');
+    this._popupMenu = injector.get('popupMenu');
+    this._create = injector.get('create');
+    this._autoPlace = injector.get('autoPlace');
+    this._mouse = injector.get('mouse');
+    this._translate = injector.get('translate');
+    this._resources = injector.get('resources');
+
+    injector.get('popupMenu').registerProvider('bpmn-create', this);
+
+    this._config = config;
+  }
+
+  getPopupMenuEntries() {
+    const {
+      resourceType,
+      className,
+      groupName,
+      createElement,
+      search
+    } = this._config;
+
+    const resources = this._resources.filter(r => r.type === resourceType);
+    const entries = {};
+
+    resources.forEach((resource, index) => {
+      const getTarget = () => createElement(resource, this._bpmnFactory);
+      entries[`resources-create-${resourceType}-${index}`] = {
+        label: resource.name,
+        action: this._createEntryAction(getTarget),
+        group: {
+          id: groupName.toLowerCase(),
+          name: this._translate(groupName)
+        },
+        className,
+        search
+      };
+    });
+
+    return entries;
+  }
+
+  _createEntryAction(getTarget) {
+    const create = this._create;
+    const mouse = this._mouse;
+    const popupMenu = this._popupMenu;
+    const elementFactory = this._elementFactory;
+
+    return (event) => {
+      popupMenu.close();
+
+      const businessObject = getTarget();
+      const element = elementFactory.createShape({
+        type: businessObject.$type,
+        businessObject: businessObject
+      });
+
+      // use last mouse event if triggered via keyboard
+      if (event instanceof KeyboardEvent) {
+        event = mouse.getLastMoveEvent();
+      }
+
+      return create.start(event, element);
+    };
+  }
+}

package/lib/camunda-cloud/features/external-resources/handlers/util/BaseReplaceMenuProvider.d.ts

@@ -0,0 +1,22 @@
+export class BaseReplaceMenuProvider {
+  /**
+   *
+   * @param injector
+   * @param config
+   */
+  constructor(injector: import("didi").Injector, config: Config);
+
+  /**
+   * @param element
+   *
+   * @return
+   */
+  getPopupMenuEntries(element: PopupMenuTarget): PopupMenuEntries;
+}
+export type Config = {
+    resourceType: string;
+    className: string;
+    groupName: string;
+    replaceElement: Function;
+    search?: string;
+};

package/lib/camunda-cloud/features/external-resources/handlers/util/BaseReplaceMenuProvider.js

@@ -0,0 +1,82 @@
+import {
+  is
+} from 'bpmn-js/lib/util/ModelUtil';
+
+import {
+  isArray
+} from 'min-dash';
+
+/**
+ * @typedef {object} Config
+ * @property {string} resourceType
+ * @property {string} className
+ * @property {string} groupName
+ * @property {Function} replaceElement
+ * @property {string} [search]
+ */
+
+export class BaseReplaceMenuProvider {
+
+  /**
+   *
+   * @param {import('didi').Injector} injector
+   * @param {Config} config
+   */
+  constructor(injector, config) {
+
+    this._injector = injector;
+    this._popupMenu = injector.get('popupMenu');
+    this._rules = injector.get('rules');
+    this._translate = injector.get('translate');
+    this._resources = injector.get('resources');
+
+    this._popupMenu.registerProvider('bpmn-replace', this);
+
+    this._config = config;
+  }
+
+
+  /**
+   * @param {PopupMenuTarget} element
+   *
+   * @return {PopupMenuEntries}
+   */
+  getPopupMenuEntries(element) {
+    const rules = this._rules;
+
+    if (isArray(element) || !rules.allowed('shape.replace', { element })) {
+      return {};
+    }
+
+    if (!is(element, 'bpmn:Activity')) {
+      return {};
+    }
+
+    const {
+      resourceType,
+      className,
+      groupName,
+      replaceElement,
+      search
+    } = this._config;
+
+    const resources = this._resources.filter(r => r.type === resourceType);
+    const entries = {};
+
+    resources.forEach((resource, index) => {
+      const replace = () => replaceElement(element, resource, this._injector);
+      entries[`resources-replace-${resourceType}-${index}`] = {
+        label: resource.name,
+        action: replace,
+        group: {
+          id: groupName.toLowerCase(),
+          name: this._translate(groupName)
+        },
+        className,
+        search
+      };
+    });
+
+    return entries;
+  }
+}