Have ideas to improve npm?Join in the discussion! »

    cmmn-moddle

    5.0.0 • Public • Published

    cmmn-moddle

    Build Status

    Read and write CMMN 1.1 diagram files in NodeJS and the browser.

    cmmn-moddle uses the CMMN 1.1 meta-model to validate the input and produce correct CMMN 1.1 XML. The library is built on top of moddle and moddle-xml.

    Usage

    Get the library via npm package. Bundle it for the web using browserify or webpack.

    var CmmnModdle = require('cmmn-moddle');
     
    var moddle = new CmmnModdle();
     
    var xmlStr =
      '<?xml version="1.0" encoding="UTF-8"?>' +
      '<cmmn:definitions xmlns:cmmn="http://www.omg.org/spec/CMMN/20150516/MODEL" id="empty-definitions" targetNamespace="http://bpmn.io/schema/cmmn">' +
      '</cmmn:definitions>';
     
     
    moddle.fromXML(xmlStr, function(err, definitions) {
     
      // update id attribute
      definitions.set('id', 'NEW ID');
     
      // add a root element
      var cmmnCase = moddle.create('cmmn:Case', { id: 'MyCase_1' });
      definitions.get('cases').push(cmmnCase);
     
      moddle.toXML(definitions, function(err, xmlStrUpdated) {
     
        // xmlStrUpdated contains new id and the added process
     
      });
     
    });

    Resources

    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 library via

    npm run all
    

    License

    Use under the terms of the MIT license.

    Install

    npm i cmmn-moddle

    DownloadsWeekly Downloads

    1,190

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    334 kB

    Total Files

    18

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar