npmpackage.info

moddle

Meta-model based data structures for those who need it

7.2.0

MIT

JavaScript

279.27 kB

12,253,394 4.8

Installations

npm install moddle

Developer Guide

BETA

Typescript

No

Module System

ESM

Node Version

20.18.1

NPM Version

10.8.2 Score

92.4

Supply Chain

99.6

Quality

92.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

40

Closed

9

Merged

29

Issues

Open

3

Total

24

Closed

21

Releases

v7.2.0

Published on 20 Dec 2024

v7.1.0

Published on 19 Dec 2024

v7.0.0

Published on 05 Mar 2024

View all 3 releases

Contributors

View all 15 contributors

Languages

JavaScript

JavaScript (100%)

Developer

bpmn-io

Download Statistics

Total Downloads

12,253,394

Last Day

13,881

Last Week

85,336

Last Month

400,409

Last Year

4,188,830

GitHub Statistics

92 Stars

206 Commits

33 Forks

17 Watching

7 Branches

15 Contributors

Maintainers

Package Meta Information

Latest Version

7.2.0

Package Id

moddle@7.2.0

Unpacked Size

279.27 kB

Size

48.95 kB

File Count

NPM Version

10.8.2

Node Version

20.18.1

Publised On

20 Dec 2024

Total Downloads

Cumulative downloads

Total Downloads

12,253,394

Last day

-19%

13,881

Compared to previous day

Last week

-6%

85,336

Compared to previous week

Last month

2.7%

400,409

Compared to previous month

Last year

44.9%

4,188,830

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

min-dash

Dev Dependencies

ajv ajv-cli chai eslint eslint-plugin-bpmn-io fast-glob mocha npm-run-all rollup

Versions

moddle

A utility library for working with meta-model based data structures.

What is it good for?

moddle offers you a concise way to define meta models in JavaScript. You can use these models to consume documents, create model elements, and perform model validation.

Define a schema

You start by creating a moddle schema. It is a JSON file which describes types, their properties, and relationships:

1{
2  "$schema": "https://unpkg.com/moddle/resources/schema/moddle.json",
3  "name": "Cars",
4  "uri": "http://cars",
5  "prefix": "c",
6  "types": [
7    {
8      "name": "Base",
9      "properties": [
10        { "name": "id", "type": "String", "isAttr": true }
11      ]
12    },
13    {
14      "name": "Root",
15      "superClass": [ "Base" ],
16      "properties": [
17        { "name": "cars", "type": "Car", "isMany": true }
18      ]
19    },
20    {
21      "name": "Car",
22      "superClass": [ "Base" ],
23      "properties": [
24        { "name": "name", "type": "String", "isAttr": true, "default": "No Name" },
25        { "name": "power", "type": "Integer", "isAttr": true },
26        { "name": "similar", "type": "Car", "isMany": true, "isReference": true },
27        { "name": "trunk", "type": "Element", "isMany": true }
28      ]
29    }
30  ]
31}

You may attach the provided JSON schema to get your moddle descriptor validated by code editor.

Instantiate moddle

You can instantiate a moddle instance with a set of defined schemas:

1import { Moddle } from 'moddle';
2
3var cars = new Moddle([ carsJSON ]);

Create objects

Use a moddle instance to create objects of your defined types:

1var taiga = cars.create('c:Car', { name: 'Taiga' });
2
3console.log(taiga);
4// { $type: 'c:Car', name: 'Taiga' };
5
6
7var cheapCar = cars.create('c:Car');
8
9console.log(cheapCar.name);
10// "No Name"
11
12
13// really?
14cheapCar.get('similar').push(taiga);

Introspect things

Then again, given the knowledge moddle has, you can perform deep introspection:

1var carDescriptor = cheapCar.$descriptor;
2
3console.log(carDescriptor.properties);
4// [ { name: 'id', type: 'String', ... }, { name: 'name', type: 'String', ...} ... ]

Access extensions

moddle is friendly towards extensions and keeps unknown any properties around:

1taiga.set('specialProperty', 'not known to moddle');
2
3console.log(taiga.get('specialProperty'));
4// 'not known to moddle'

It also allows you to create any elements for namespaces that you did not explicitly define:

1var screwdriver = cars.createAny('tools:Screwdriver', 'http://tools', {
2  make: 'ScrewIt!'
3});
4
5car.trunk.push(screwdriver);

There is more

Have a look at our test coverage to learn about everything that is currently supported.

Resources

moddle-xml: read xml documents based on moddle descriptors

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

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

7

SAST

Determines if the project uses static code analysis.

5

Code-Review

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

5

Maintained

Determines if the project is "actively maintained".

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Pinned-Dependencies

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

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.

Score

4.8

/10

Last Scanned on 2024-12-16

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

Other packages similar to moddle

bpmn-moddle

9.0.1

A moddle wrapper for BPMN 2.0

moddle-xml

11.0.0

XML import/export for documents described with moddle

camunda-bpmn-moddle

7.0.1

Camunda moddle extensions for BPMN 2.0

zeebe-bpmn-moddle

1.7.0

Zeebe moddle extensions for BPMN 2.0

moddle

Installations

Developer Guide

No

ESM

20.18.1

10.8.2

Score

Pull Requests

2

40

9

29

Issues

3

24

21

Releases

Contributors

Languages

Developer

bpmn-io

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

12,253,394

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

moddle

What is it good for?

Define a schema

Instantiate moddle

Create objects

Introspect things

Access extensions

There is more

Resources

Related

License

10

10

10

10

7

5

5

2

1

0

0

0

0

4.8

/10

Other packages similar to moddle