Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

camunda-bpmn-moddle

camunda108.4kMIT7.0.1

Camunda moddle extensions for BPMN 2.0

bpmn, moddle, bpmn20, camunda, meta-model

readme

camunda-bpmn-moddle

CI

This project defines the Camunda namespace extensions for BPMN 2.0 as a moddle descriptor.

Usage

Use it together with bpmn-moddle to validate Camunda BPMN 2.0 extensions.

import BpmnModdle from 'bpmn-moddle';

import camundaModdle from 'camunda-bpmn-moddle/resources/camunda.json';

const moddle = new BpmnModdle({ camunda: camundaModdle });

const serviceTask = moddle.create('bpmn:ServiceTask', {
  'javaDelegate': 'my.company.SomeDelegate'
});

Building the Project

To run the test suite that includes XSD schema validation you must have a Java JDK installed and properly exposed through the JAVA_HOME variable.

Execute the test via

npm test

Perform a complete build of the application via

npm run all

Behaviors

Inside a bpmn-js editor pair this extension with camunda-bpmn-js-behaviors to ensure Camunda properties are created, updated and deleted as expected.

License

Use under the terms of the MIT license.

changelog

Changelog

All notable changes to camunda-bpmn-moddle are documented here. We use semantic versioning for releases.

Unreleased

_Note: Yet to be released changes appear here._

7.0.1

7.0.0

  • CHORE: remove behaviors (#112)

Breaking Changes

6.1.2

  • DEPS: deps: mark bpmn-js@9 and diagram-js@8 as peer dependency

6.1.1

  • FIX: remove invalid camunda:formRefBinding default value (#87)

6.1.0

  • FEAT: remove variableEvents for startEvent outside of EventSubProcess (#77)
  • FIX: remove initiator property for shape.create (#78)

6.0.0

  • FEAT: support camunda:formRef, camunda:formRefBinding and camunda:formRefVersion elements (#76)
  • FIX: remove initiator property for startEvent when moved to a subProcess (#74)

5.1.2

  • FIX: ensure root element is referenced on correct position (#70)

5.1.1

  • FIX: do not copy non existing root elements (#69)

5.1.0

  • FEAT: add behavior to copy and paste bpmn:Error elements referenced via camunda:ErrorEventDefinition elements (#68)
  • FIX: support camunda:modelerTemplate and camunda:modelerTemplateVersion for bpmn:Collaboration elements (#67)

5.0.0

  • CHORE: rename *EventDefinition to *EventDefinitionExtension
  • FEAT: support camunda:ErrorEventDefinition for external service tasks

Breaking Changes

  • *EventDefinition elements were re-named by appending Extension. Adjust the name of these elements, if you extended or superclassed them.

4.5.0

  • FIX: add modelerTemplateVersion property (#60)

4.4.1

  • FIX: rename variableEvent to variableEvents (cd4a417)

4.4.0

4.3.0

  • FEAT: add id and eventDefinitions to task listener schema (9668525f)

4.2.0

  • FEAT: add camunda:diagramRelationId to schema (#49)

4.1.2

  • FIX: do not copy camunda:InputOutput on gateways
  • FIX: copy camunda:FailedJobRetryTimeCycle consistently for all camunda:AsyncCapable elements

4.1.1

4.1.0

  • FEAT: add camunda:errorMessage to schema (d47da)

4.0.1

  • DOCS: update bpmn-js integration docs

4.0.0

  • CHORE: update moddle copy mechanism for compatibility with bpmn-js@5
  • CHORE: use Camunda logical types in allowedIn mappings
  • FIX: make extension work

Breaking Changes

  • Requires bpmn-js@5+ for proper copying of moddle attributes

3.2.0

  • FEAT: add camunda:calledElementVersionTag to schema (#43)

3.1.1

  • FIX: correct camunda:isStartableInTasklist default value (#41)

3.1.0

  • FEAT: support camunda:isStartableInTasklist

...

Check git log for earlier history.