Installations

npm install @bpmn-io/element-templates-validator

Developer Guide

BETA

Typescript

No

Module System

ESM

Node Version

20.18.1

NPM Version

10.8.2 Pull Requests

Open

1

Total

46

Closed

8

Merged

37

Issues

Open

1

Total

5

Closed

4

Releases

6

v2.3.3

Published on 28 Jan 2025

v2.3.2

Published on 23 Jan 2025

v2.3.1

Published on 23 Jan 2025

v2.3.0

Published on 16 Jan 2025

v2.2.0

Published on 06 Dec 2024

v2.1.0

Published on 29 May 2024

View all 6 releases

Contributors

10

View all 10 contributors

Languages

1

JavaScript

JavaScript (100%)

Developer

bpmn-io

Download Statistics

Total Downloads

1,297,361

Last Day

1,466

Last Week

6,723

Last Month

29,748

Last Year

431,680

GitHub Statistics

5 Stars

138 Commits

4 Forks

7 Watching

3 Branches

10 Contributors

Bundle Size

284.33 kB

Minified

33.45 kB

Minified + Gzipped

Bundlephobia

Maintainers

10

Package Meta Information

Latest Version

2.3.3

Package Id

@bpmn-io/element-templates-validator@2.3.3

Unpacked Size

848.43 kB

Size

107.32 kB

File Count

5

NPM Version

10.8.2

Node Version

20.18.1

Publised On

28 Jan 2025

Total Downloads

Cumulative downloads

Total Downloads

1,297,361

Last day

-17.3%

1,466

Compared to previous day

Last week

-24%

6,723

Compared to previous week

Last month

1.5%

29,748

Compared to previous month

Last year

-17.5%

431,680

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

4

@camunda/element-templates-json-schema @camunda/zeebe-element-templates-json-schema json-source-map min-dash

Dev Dependencies

13

@rollup/plugin-alias @rollup/plugin-commonjs @rollup/plugin-json @rollup/plugin-node-resolve ajv ajv-errors chai eslint eslint-plugin-bpmn-io esm mocha npm-run-all2 rollup

Versions

element-templates-validator

Validate element templates based on JSON Schema.

Installation

1npm i --save @bpmn-io/element-templates-validator

Usage

Given an example element template:

1import { validate } from '@bpmn-io/element-templates-validator';
2
3import sample from './test/fixtures/rpa-broken.json';
4
5const {
6  valid,
7  errors
8} = validate(sample);
9
10if (!valid) {
11  console.error('Invalid JSON detected:', errors);
12}
13

This will print detailed information about errors inside the sample:

1[
2  {
3    "keyword": "type",
4    "dataPath": "",
5    "schemaPath": "#/type",
6    "params": {
7      "type": "object"
8    },
9    "message": "must be object",
10    "dataPointer": {
11      "value": {
12        "line": 0,
13        "column": 0,
14        "pos": 0
15      },
16      "valueEnd": {
17        "line": 177,
18        "column": 1,
19        "pos": 4825
20      }
21    }
22  }
23  ...
24]

It's also possible to validate multiple objects at once

1import { validateAll } from '@bpmn-io/element-templates-validator';
2
3import samples from './test/fixtures/multiple-errors.json';
4
5const {
6  valid,
7  results
8} = validateAll(samples);
9
10if (!valid) {
11  console.error('Invalid JSON objects detected:', results.filter(r => !r.valid));
12}

License

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Maintained

Determines if the project is "actively maintained".

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

5.1

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More