@process-analytics/bv-experimental-add-ons - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

dist/index.d.ts

 export * from './bpmn-elements';
 export * from './paths';
+export * from './plugins-support';

dist/index.js

@@ -18,1 +18,2 @@ /*
 export * from './paths';
+export * from './plugins-support';

package.json

 {
   "name": "@process-analytics/bv-experimental-add-ons",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "private": false,
@@ -30,3 +30,3 @@ "description": "Experimental add-ons for bpmn-visualization",
   "scripts": {
-    "dev": "tsc --watch",
+    "dev": "tsc --watch --sourceMap",
     "build": "tsc",
@@ -41,5 +41,4 @@ "clean": "rimraf dist",
     "npm-run-all": "~4.1.5",
-    "rimraf": "~5.0.1",
-    "typescript": "~5.1.6"
+    "rimraf": "~5.0.1"
   }
 }

README.md

@@ -6,4 +6,43 @@ # bpmn-visualization experimental add-ons
 
+## 📌 Usage
+<!-- ### 📌 Usage in applications and projects -->
+
+Install `bv-experimental-add-ons` and [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js/):
+```shell script
+npm i @process-analytics/bv-experimental-add-ons bpmn-visualization
+```
+
+
+## 📜 TypeScript Support
+
+The `@process-analytics/bv-experimental-add-ons` npm package includes type definitions, so the integration works out of the box in TypeScript projects and applications.
+`bv-experimental-add-ons` requires **TypeScript 4.5** or greater.
+
+
 ## 🎨 Features
 
+### Plugins
+
+The plugins infrastructure provides a way to register extension points.
+
+Example of use:
+
+```ts
+// use BpmnVisualization from addons not from bpmn-visualization
+import {BpmnVisualization} from "@process-analytics/bv-experimental-add-ons";
+
+const bpmnVisualization = new BpmnVisualization({
+    container: 'bpmn-container',
+    plugins: [MyPlugin]
+});
+// Retrieve the plugin by id. The id is defined in the plugin implementation
+const myPlugin = bpmnVisualization.getPlugin('my-plugin') as MyPlugin;
+myPlugin.aMethod();
+```
+
+#### Available plugins
+
+- `OverlaysPlugin`: let show/hide overlays created with `BpmnElementsRegistry.addOverlays`.
+
+
 ### `BpmnElementsIdentifier`
@@ -30,3 +69,3 @@
 
-Infer paths. Currently, only infer edges/flows given a list of flow node ids.
+Infer BPMN path. Currently, only infer edges/flows given a list of flow node ids.
 
@@ -42,19 +81,2 @@ **WARNING**: this is front-end processing. It's more efficient for this type of processing to be carried out in the backend.
 
-## 📌 Usage
-<!-- ### 📌 Usage in applications and projects -->
-
-Install `bv-experimental-add-ons`:
-```shell script
-npm i @process-analytics/bv-experimental-add-ons
-```
-
-Also install [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js/).
-
-
-## 📜 TypeScript Support
-
-The `@process-analytics/bv-experimental-add-ons` npm package includes type definitions, so the integration works out of the box in TypeScript projects.
-`bv-experimental-add-ons` requires **TypeScript 4.5** or greater.
-
-
 ## 📃 License
@@ -61,0 +83,0 @@

No alert changes

Improved metrics

Total package byte prevSize

26834

increased by22.11%

Dev dependency count

2

decreased by-33.33%

Number of package files

11

increased by22.22%

Lines of code

300

increased by59.57%

Number of lines in readme file

83

increased by36.07%

No dependency changes