camunda-bpmn-js 5.6.2 → 5.7.0

package/lib/camunda-cloud/Modeler.js

@@ -30,6 +30,7 @@ import {
 } from 'bpmn-js-create-append-anything';
 
 import camundaDetailsPopupMenuModule from './features/popup-menu';
+import { DefaultHandlersModule, ResourcesModule } from './features/external-resources';
 
 /**
  * @typedef {import('bpmn-js/lib/BaseViewer').BaseViewerOptions} BaseViewerOptions
@@ -99,7 +100,9 @@ Modeler.prototype._camundaCloudModules = [
   variableResolverModule,
   exampleDataPropertiesProviderModule,
   formVariableProviderModule,
-  camundaDetailsPopupMenuModule
+  camundaDetailsPopupMenuModule,
+  DefaultHandlersModule,
+  ResourcesModule
 ];
 
 Modeler.prototype._modules = [].concat(

package/lib/camunda-cloud/features/external-resources/README.md

@@ -0,0 +1,14 @@
+# external-resources
+
+Define available resources and create linked elements right away in BPMN editor.
+
+## Usage
+
+Import the library and include it in `additionalModules`.
+Then, register a resources provider to pass the resources to the handlers.
+
+## Principles
+
+* The module is extensible. You can pass any resources, and define handlers for them.
+You can also override the default handlers.
+* User is in control. Unlike in element templates, the user can still decide to override any properties set in the handler. The built-in resource handlers are merely helpers to create standard BPMN elements.

package/lib/camunda-cloud/features/external-resources/ResourceLoader.d.ts

@@ -0,0 +1,6 @@
+export class ResourceLoader {
+  static $inject: string[];
+  constructor(eventBus: any, resources: any);
+  register(resourceProvider: any): void;
+  reload(): void;
+}

package/lib/camunda-cloud/features/external-resources/ResourceLoader.js

@@ -0,0 +1,24 @@
+export class ResourceLoader {
+  static $inject = [ 'eventBus', 'resources' ];
+
+  constructor(eventBus, resources) {
+    this._resources = resources;
+    this._providers = [];
+
+    eventBus.on('diagram.init', () => {
+      this.reload();
+    });
+  }
+
+  register(resourceProvider) {
+    this._providers.push(resourceProvider);
+  }
+
+  reload() {
+    const combined = this._providers.reduce((resources, provider) => {
+      return resources.concat(provider.getResources());
+    }, []);
+
+    this._resources.set(combined);
+  }
+}

package/lib/camunda-cloud/features/external-resources/Resources.d.ts

@@ -0,0 +1,7 @@
+export class Resources {
+  static $inject: string[];
+  constructor(resources: any);
+  set(resources: any): void;
+  getAll(): any;
+  filter(fn: any): any;
+}

package/lib/camunda-cloud/features/external-resources/Resources.js

@@ -0,0 +1,19 @@
+export class Resources {
+  static $inject = [ 'config.resources' ];
+
+  constructor(resources) {
+    this._resources = resources || [];
+  }
+
+  set(resources) {
+    this._resources = resources;
+  }
+
+  getAll() {
+    return this._resources;
+  }
+
+  filter(fn) {
+    return this._resources.filter(fn);
+  }
+}

package/lib/camunda-cloud/features/external-resources/cmd/ComposedCommandHandler.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Command handler to compose multiple commands into a single command.
+ * It allows to use facades like `BpmnReplace` and `Modeling` while retaining
+ * single undo/redo feature.
+ */
+export class ComposedCommandHandler {
+  constructor(commandStack: any);
+  preExecute(context: any): void;
+}
+export namespace ComposedCommandHandler {
+    let $inject: string[];
+}

package/lib/camunda-cloud/features/external-resources/cmd/ComposedCommandHandler.js

@@ -0,0 +1,16 @@
+/**
+ * Command handler to compose multiple commands into a single command.
+ * It allows to use facades like `BpmnReplace` and `Modeling` while retaining
+ * single undo/redo feature.
+ */
+export class ComposedCommandHandler {
+  constructor(commandStack) {
+    this._commandStack = commandStack;
+  }
+
+  preExecute(context) {
+    context.command();
+  }
+}
+
+ComposedCommandHandler.$inject = [ 'commandStack' ];

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

@@ -0,0 +1,4 @@
+export default class CommandInitializer {
+    static $inject: string[];
+    constructor(eventBus: any, commandStack: any);
+}

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

@@ -0,0 +1,21 @@
+import {
+  forEach
+} from 'min-dash';
+
+import { ComposedCommandHandler } from './ComposedCommandHandler.js';
+
+const HANDLERS = {
+  'external-resources.composed-command': ComposedCommandHandler
+};
+
+
+export default function CommandInitializer(eventBus, commandStack) {
+
+  eventBus.on('diagram.init', function() {
+    forEach(HANDLERS, function(handler, id) {
+      commandStack.registerHandler(id, handler);
+    });
+  });
+}
+
+CommandInitializer.$inject = [ 'eventBus', 'commandStack' ];

package/lib/camunda-cloud/features/external-resources/handlers/decision/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/decision/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: 'dmnDecision',
+      groupName: 'Decisions',
+      className: 'bpmn-icon-business-rule-task',
+      createElement: (resource, bpmnFactory) => createElement(resource, bpmnFactory),
+      search: searchTerms
+    });
+  }
+}

package/lib/camunda-cloud/features/external-resources/handlers/decision/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/decision/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: 'dmnDecision',
+      groupName: 'Decisions',
+      className: 'bpmn-icon-business-rule-task',
+      createElement: (resource, bpmnFactory) => createElement(resource, bpmnFactory),
+      search: searchTerms
+    });
+  }
+}

package/lib/camunda-cloud/features/external-resources/handlers/decision/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/decision/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: 'dmnDecision',
+      groupName: 'Decisions',
+      className: 'bpmn-icon-business-rule-task',
+      replaceElement: (element, resource, injector) => replaceElement(element, resource, injector),
+      search: searchTerms
+    });
+  }
+}

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

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

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

@@ -0,0 +1,35 @@
+/**
+ * @typedef {{
+ *   type: 'dmnDecision',
+ *   name: string,
+ *   decisionId: string
+ * }} Decision
+ */
+
+/**
+ * @param {Decision} resource
+ * @param {import('bpmn-js/lib/features/modeling/BpmnFactory').default} bpmnFactory
+ */
+export function createElement(resource, bpmnFactory) {
+  return createDecisionTask(resource, bpmnFactory);
+}
+
+function createDecisionTask(resource, bpmnFactory) {
+  const calledElement = createCalledDecision(resource, bpmnFactory);
+  const extensionElements = bpmnFactory.create('bpmn:ExtensionElements', {
+    values: [
+      calledElement
+    ]
+  });
+
+  return bpmnFactory.create('bpmn:BusinessRuleTask', {
+    name: resource.name,
+    extensionElements
+  });
+}
+
+function createCalledDecision(resource, bpmnFactory) {
+  return bpmnFactory.create('zeebe:CalledDecision', {
+    decisionId: resource.decisionId
+  });
+}

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

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

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

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

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

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

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

@@ -0,0 +1,77 @@
+import { getBusinessObject, is } from 'bpmn-js/lib/util/ModelUtil';
+
+/**
+ * @typedef {{
+*   type: 'dmnDecision',
+*   name: string,
+*   decisionId: string
+* }} Decision
+*/
+
+/**
+ * @param {import('diagram-js/lib/model').Element} element
+ * @param {Decision} 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:BusinessRuleTask' });
+    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: [
+            createCalledDecision(resource, bpmnFactory)
+          ]
+        })
+      });
+
+      return;
+    }
+
+    const calledDecision = getCalledDecision(replacedElement);
+
+    if (!calledDecision) {
+      modeling.updateModdleProperties(replacedElement, extensionElements, {
+        values: [
+          ...extensionElements.values,
+          createCalledDecision(resource, bpmnFactory)
+        ]
+      });
+
+      return;
+    }
+
+    modeling.updateModdleProperties(replacedElement, calledDecision, {
+      decisionId: resource.decisionId
+    });
+  }
+}
+
+function getCalledDecision(element) {
+  return element.businessObject?.extensionElements?.values.find(value => is(value, 'zeebe:CalledDecision'));
+}
+
+function createCalledDecision(resource, bpmnFactory) {
+  return bpmnFactory.create('zeebe:CalledDecision', {
+    decisionId: resource.decisionId
+  });
+}

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

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

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

@@ -0,0 +1,6 @@
+export const searchTerms = [
+  'resource',
+  'dmn',
+  'business rule task',
+  'decision'
+].join(' ');

package/lib/camunda-cloud/features/external-resources/handlers/form/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/form/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: 'form',
+      groupName: 'Forms',
+      className: 'bpmn-icon-user-task',
+      createElement: (resource, bpmnFactory) => createElement(resource, bpmnFactory),
+      search: searchTerms
+    });
+  }
+}

package/lib/camunda-cloud/features/external-resources/handlers/form/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/form/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: 'form',
+      groupName: 'Forms',
+      className: 'bpmn-icon-user-task',
+      createElement: (resource, bpmnFactory) => createElement(resource, bpmnFactory),
+      search: searchTerms
+    });
+  }
+}

package/lib/camunda-cloud/features/external-resources/handlers/form/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/form/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: 'form',
+      groupName: 'Forms',
+      className: 'bpmn-icon-user-task',
+      replaceElement: (element, resource, injector) => replaceElement(element, resource, injector),
+      search: searchTerms
+    });
+  }
+}

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

@@ -0,0 +1,9 @@
+/**
+ * @param resource
+ */
+export function createElement(resource: Form): any;
+export type Form = {
+    type: "form";
+    name: string;
+    formId: string;
+};

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

@@ -0,0 +1,39 @@
+/**
+ * @typedef {{
+ *   type: 'form',
+ *   name: string,
+ *   formId: string
+ * }} Form
+ */
+
+/**
+ * @param {Form} resource
+ */
+export function createElement(resource, bpmnFactory) {
+  return createFormTask(resource, bpmnFactory);
+}
+
+function createFormTask(resource, bpmnFactory) {
+  const formDefinition = createFormDefinition(resource, bpmnFactory);
+  const extensionElements = bpmnFactory.create('bpmn:ExtensionElements', {
+    values: [
+      createZeebeUserTask(bpmnFactory),
+      formDefinition
+    ]
+  });
+
+  return bpmnFactory.create('bpmn:UserTask', {
+    name: resource.name,
+    extensionElements
+  });
+}
+
+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/index.d.ts

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

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

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

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

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