Registry / bpmn-js-signavio-compat

bpmn-js-signavio-compat

library1.2.3jsnpmunverified

A Signavio compatibility layer for bpmn-js, enabling interoperability with diagrams exported from Signavio. Current stable version is 1.2.3, with irregular releases as needed. It adds support for Signavio-specific sub-process expand/collapse behavior. Key differentiators: it is the official compatibility module from the bpmn-io team, designed to work with multiple bpmn-js major versions (1.x through 8.x). Requires a transpiler for use. Lightweight plugin that adds a single feature without altering the core bpmn-js library.

npm install bpmn-js-signavio-compat

github ↗package ↗

INSTALL

IMPORT

SIG · BPMN-JS-SIGNAVIO-C

bpmn-js-signavio-compat

javascriptv1.2.3

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

signavioCompatModule

✓ import signavioCompatModule from 'bpmn-js-signavio-compat';

✗ const signavioCompatModule = require('bpmn-js-signavio-compat');

ESM-only; named default export. No named exports available.

signavioCompatModule

✓ var signavioCompatModule = require('bpmn-js-signavio-compat').default;

✗ var signavioCompatModule = require('bpmn-js-signavio-compat');

When using CommonJS via require, the default export is under .default. Importing the module directly will yield an object with default property.

import signavioCompatModule from 'bpmn-js-signavio-compat'

✓ import signavioCompatModule from 'bpmn-js-signavio-compat';

✗ import { signavioCompatModule } from 'bpmn-js-signavio-compat';

The module has a default export, not a named export. Named import will result in undefined.

Shows how to add the Signavio compatibility module to a bpmn-js Modeler and import a diagram.

import Modeler from 'bpmn-js/lib/Modeler'; import signavioCompatModule from 'bpmn-js-signavio-compat'; const modeler = new Modeler({ container: '#container', additionalModules: [ signavioCompatModule ] }); // Load a Signavio-exported diagram fetch('https://example.com/diagram.bpmn') .then(res => res.text()) .then(diagramXML => modeler.importXML(diagramXML)) .catch(err => console.error(err));

Debug

Known issues

gotchaRequires a transpiler (e.g., Babel) to use because it relies on ES modules and may use modern syntax.

fix

Set up Babel or similar to transpile node_modules if not already configured.

affects: >=1.0.0

deprecatedThe package only provides a single feature (sub-process expand/collapse) and may not cover all Signavio-specific behaviors.

fix

Check the Signavio compatibility manually for other features; consider contributing or filing issues.

affects: >=1.0.0

gotchaUsing require() in CommonJS without .default will yield an object with the actual module as default property, leading to errors when passed as additionalModule.

fix

Use require('bpmn-js-signavio-compat').default or switch to ES import syntax.

affects: >=1.0.0

Errors

Common errors & fixes

Error: No provider for "bpmn-js-signavio-compat"!

Missing or incorrect import/require syntax.

fix

Ensure you are using the correct import: import signavioCompatModule from 'bpmn-js-signavio-compat'; or const signavioCompatModule = require('bpmn-js-signavio-compat').default;

Module not found: Can't resolve 'bpmn-js-signavio-compat'

Package not installed or missing in node_modules.

fix

Run npm install bpmn-js-signavio-compat or yarn add bpmn-js-signavio-compat.

TypeError: signavioCompatModule is not a function

Using the module incorrectly, e.g., trying to call it as a function instead of passing as an additional module.

fix

Do not invoke the module; pass it directly to additionalModules array as an object.

Unexpected token 'export'

ES6+ syntax not transpiled; environment does not support ES modules.

fix

Use a transpiler like Babel to compile your code, or switch to CommonJS with require('.default').

Upgrade

Version history

1.2.3latest on npm

Audit

Dependencies

bpmn-jsoptionalpeer dependency required for integration

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/bpmn-io/bpmn-js-signavio-compat ↗

packagehttps://www.npmjs.com/package/bpmn-js-signavio-compat ↗