Provide separate Modelers

[pinussilvestrus]

base

• diagram-js-minimap
• diagram-js-origin & @bpmn-io/align-to-origin (exclusive, optional)
  • Default: align-to-origin
  • config.disableAdjustOrigin: diagram-js-origin
• @bpmn-io/add-exporter --> this would require to set exporter metadata any time
• bpmn-js-executable-fix
• bpmn-js-signavio-compat
• bpmn-js-disable-collapsed-subprocess
• bpmn-js-properties-panel
• BPMN properties provider

camunda-cloud
cf. zeebe-io/zeebe-modeler#BpmnModeler

Everything from base + zeebe related modules

• context-pad
• palette
• modeling
• replace-menu
• rules
• zeebe-bpmn-moddle
• zeebe-properties-provider (implemented, tests are missing)

camunda-platform
cf. camunda/camunda-modeler#BpmnModeler

Everything from base + camunda related modules

• camunda-bpmn-moddle
• camunda-properties-provider

What else?

available in Camunda Modeler as well, do we need them here? --> I'd vote for no

• complete-direct-editing
• global-clipboard
• hand-tool-on-space
• properties-panel-keyboard-bindings

---

Related to zeebe-io/zeebe-modeler#288

[pinussilvestrus]

Open questions (03-02-2021)

• Advertise that thing
  • Update README
  • Create how-to
  • Ask for feedback in other teams
• What about extensions baked into the Camunda Modeler? Cf. Provide separate Modelers #1 (comment)
  • Let's keep them outside
• Do we want to keep the distinction between diagram-js-origin & align-to-origin?
• What to do with bpmn-js-add-exporter?
  • Let's keep it outside, consumer has to integrate it
• Is bpmn-js-disable-collapsed-subprocess engine related or a basic modeling concern we promote?
  • Let's keep it in base
• What about styles? Cf. Bundle css files #2
• What about pre-packaged versions? Cf. Provide pre-packaged versions #3
• What about Viewers? Cf. Provide Viewer and NavigatedViewer for each module #4

[pinussilvestrus]

Chat with Cawemo (04-02-2021)

• Are generally interested in using it, had to copy-paste stuff in the past
• Would be interested in a similar thing for dmn-js, containing the DMN overview as an example
• Modules should be overridable, also things like executable-fix (which is untyped)
• Would be interested in a separate Cawemo bundle, e.g. excluding the Properties panel ==> Provide Cawemo distribution #7

[pinussilvestrus]

Chat with Cloud (04-02-2021)

• perfect!
• Asked whether it would be possible to also include the Properties Panel close handle + basic styles to properly align the Properties Panel (to the right) ==> Include additional Properties Panel styles and close handle #6

[nikku]

I'm wondering why we excluded this one as we decided what to include in our distributions:

* [ ] @bpmn-io/add-exporter --> this would require to set exporter metadata any time

In fact, it is best practice to set an exporter (and required meta-data). We could argue that it makes sense for our consumers to provide it.

[pinussilvestrus]

I think we decided this because we don't want to force our users to set the exporter (throws an error) any time they use a camunda-bpmn-js Modeler. The goal was to keep the configuration effort as small as possible.

But I see that this one should be at least available. Maybe we can update bpmn-io/add-exporter to have the config.exporter optional? Or we only include this module in the camunda-bpmn-js Modelers once the config is defined.

[nikku]

I think we decided this because we don't want to force our users to set the exporter (throws an error) any time they use a camunda-bpmn-js Modeler. The goal was to keep the configuration effort as small as possible.

That is a valid point. Why not force them to do it though? As mentioned, this is best practice that any of our modeling tools should follow. If a diagram is edited in Optimize it should clearly state Optimize, v412.1 in the exporter field. If it is edited in the cloud console you could argue for a similar thing.

We could set up a naming conventions on our side and document it. With that in place, enforcing the exporter to be set (and best practices to be followed) should not cause our users too much pain.

[nikku]

Created #32 to track my feedback.

[pinussilvestrus]

Thanks for your feedback 👍 I think it makes sense to enforce it (if it's well documented).