@bpmn-ld/bpmn-ld 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Dejan Dimic <dejan.dimic@gmail.com>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,126 @@
-# Temporary Holding Version
+# bpmn-ld
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**A Semantic JSON-LD Representation of BPMN 2.0**
+
+> Bringing BPMN 2.0 into the Semantic Web and the AI Agent ecosystem.
+
+## Overview
+
+BPMN-LD is an open-source initiative to develop a semantic representation of the
+Business Process Model and Notation (BPMN) 2.0 specification using JSON-LD.
+
+The project aims to make BPMN models machine-readable, semantically interoperable
+and accessible to AI agents.
+
+The initiative will establish a common semantic foundation for creating,
+interpreting, analysing and validating business process models.
+
+## Vision
+
+Enable humans and AI agents to collaborate in business process modelling through
+a standardised, semantically rich and machine-interpretable representation of
+BPMN.
+
+## Project Objectives
+
+1. Develop a JSON-LD semantic representation of BPMN 2.0.
+2. Define the BPMN-LD ontology, JSON-LD context and associated validation schemas.
+3. Preserve BPMN 2.0 semantics and support interoperability with BPMN XML.
+4. Develop an AI Agent Skill capable of creating BPMN diagrams from
+natural-language requirements.
+5. Enable AI agents to interpret, explain, modify and improve existing BPMN diagrams.
+6. Implement structural, semantic and process-level validation.
+7. Provide reusable tools, documentation, examples and test cases.
+
+## Main Workstreams
+
+### 1. BPMN-LD Semantic Model
+
+- BPMN classes and properties.
+- Events, activities, gateways and flows, including message, signal, error, escalation, compensation, conditional and link event definitions, ad-hoc sub-processes and transactions.
+- Root elements (messages, signals, errors, escalations) and the references to them.
+- Participants, pools and lanes.
+- Data objects and associations.
+- Processes and collaborations.
+- BPMN diagram interchange (BPMN DI).
+
+The generated [coverage report](reports/coverage.md) shows no in-scope gaps against the BPMN 2.0.2 XSDs. Item definitions and operations are not modelled, so `itemRef`, `operationRef`, `structureRef` and `evaluatesToTypeRef` are kept as unresolved identifiers. The converter does not yet convert data constructs.
+
+### 2. JSON-LD Representation
+
+- JSON-LD context.
+- RDF/OWL ontology.
+- JSON Schema.
+- SHACL validation constraints.
+- Semantic identifiers and relationships.
+
+### 3. BPMN Processing Engine
+
+- JSON-LD parsing and serialization.
+- Model validation.
+- BPMN XML interoperability: [import](docs/conventions/converter.md) and [export](docs/conventions/exporter.md).
+- Automatic diagram layout (BPMN DI) for models without a diagram, see [layout](docs/conventions/layout.md).
+- External checks of exported XML: XSD, bpmn-moddle and bpmnlint.
+- Semantic graph analysis.
+- [Process structure analysis](docs/conventions/process-analysis.md).
+
+### 4. AI Agent Skill
+
+- Natural-language-to-BPMN generation.
+- BPMN model interpretation.
+- Diagram modification.
+- Process documentation.
+- Validation and error explanation.
+- Iterative refinement through user feedback.
+- Install and usage: [AI agent skill](docs/conventions/skill.md).
+
+### 5. Testing and Demonstration
+
+- Reference BPMN models.
+- Positive and negative validation examples.
+- JSON-LD interoperability tests.
+- AI-generated BPMN test cases.
+- Regression testing.
+
+## Commands
+
+| Command | Purpose | Documentation |
+| ------- | ------- | ------------- |
+| `npm run convert` | BPMN 2.0 XML to BPMN-LD | [Converter](docs/conventions/converter.md) |
+| `npm run export` | BPMN-LD to BPMN 2.0 XML, optionally with `--layout` | [Exporter](docs/conventions/exporter.md) |
+| `npm run layout` | Add BPMN DI shapes and edges to a BPMN-LD document | [Layout](docs/conventions/layout.md) |
+| `npm run check-xml` | Check BPMN 2.0 XML with the XSD, bpmn-moddle and bpmnlint | [Exporter](docs/conventions/exporter.md#external-checks) |
+| `npm run analyze` | Process-level analysis of a BPMN-LD document | [Process analysis](docs/conventions/process-analysis.md) |
+| `npm run render` | Render BPMN-LD or BPMN XML to SVG | [Renderer](docs/conventions/renderer.md) |
+| `npm run validate` | Schema and SHACL validation | [Documentation index](docs/README.md) |
+
+The design of the exporter, layout and external checks is recorded in [ADR 0012](docs/adr/0012-bpmn-xml-exporter-layout-and-external-checks.md). The AI agent skill is described in [the skill page](docs/conventions/skill.md) and recorded in [ADR 0013](docs/adr/0013-ai-agent-skill.md). The renderer is recorded in [ADR 0015](docs/adr/0015-svg-renderer.md).
+
+## Guiding Principles
+
+- Standards-based: maintain alignment with OMG BPMN 2.0.2.
+- Semantic interoperability: use W3C Linked Data standards.
+- AI-ready: provide machine-interpretable structures.
+- Open-source: encourage collaboration and reuse.
+- Extensible: support future BPMN extensions and domain-specific vocabularies.
+- Verifiable: provide repeatable validation and testing.
+
+## Initial Technology References
+
+| Name | Version | URL | Description |
+| ---- | ------- | --- | ----------- |
+| OMG BPMN | 2.0.2 | <https://www.omg.org/spec/BPMN/2.0.2/PDF> | Business Process Model and Notation specification. |
+| BPMN XML | 2.0 (XSD) | <https://www.omg.org/spec/BPMN/20100501/BPMN20.xsd> | Normative XML schema for BPMN interchange; the semantic part is at <https://www.omg.org/spec/BPMN/20100501/Semantic.xsd>. |
+| W3C JSON-LD | 1.1 | <https://www.w3.org/TR/2020/REC-json-ld11-20200716/> | JSON-based serialization of Linked Data. |
+| W3C RDF | 1.1 Concepts | <https://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/> | Core data model for graph-based semantic data. |
+| W3C OWL | 2 | <https://www.w3.org/TR/2012/REC-owl2-overview-20121211/> | Ontology language for describing classes and properties. |
+| W3C SHACL | 1.0 | <https://www.w3.org/TR/2017/REC-shacl-20170720/> | Language for validating RDF graphs against constraints. |
+| JSON Schema | 2020-12 | <https://json-schema.org/draft/2020-12> | Vocabulary for validating the structure of JSON documents. |
+
+## Collaboration
+
+Contributions, discussions, architectural proposals and implementation ideas are
+welcome.
+
+The project aims to build an open ecosystem connecting business process
+modelling, semantic technologies and AI agents.

package/contexts/combined.jsonld

@@ -0,0 +1,3 @@
+{
+  "@context": ["core.jsonld", "di.jsonld"]
+}

package/contexts/core.jsonld

@@ -0,0 +1,170 @@
+{
+  "@context": {
+    "@version": 1.1,
+    "@protected": true,
+    "id": "@id",
+    "type": "@type",
+    "xsd": "http://www.w3.org/2001/XMLSchema#",
+    "bpmn": "https://bpmn-ld.example.org/ns#",
+    "Process": "bpmn:Process",
+    "SubProcess": "bpmn:SubProcess",
+    "AdHocSubProcess": "bpmn:AdHocSubProcess",
+    "Transaction": "bpmn:Transaction",
+    "Collaboration": "bpmn:Collaboration",
+    "Participant": "bpmn:Participant",
+    "MessageFlow": "bpmn:MessageFlow",
+    "Message": "bpmn:Message",
+    "Signal": "bpmn:Signal",
+    "Error": "bpmn:Error",
+    "Escalation": "bpmn:Escalation",
+    "Association": "bpmn:Association",
+    "LaneSet": "bpmn:LaneSet",
+    "Lane": "bpmn:Lane",
+    "StartEvent": "bpmn:StartEvent",
+    "EndEvent": "bpmn:EndEvent",
+    "CatchEvent": "bpmn:CatchEvent",
+    "ThrowEvent": "bpmn:ThrowEvent",
+    "IntermediateCatchEvent": "bpmn:IntermediateCatchEvent",
+    "IntermediateThrowEvent": "bpmn:IntermediateThrowEvent",
+    "ImplicitThrowEvent": "bpmn:ImplicitThrowEvent",
+    "BoundaryEvent": "bpmn:BoundaryEvent",
+    "MessageEventDefinition": "bpmn:MessageEventDefinition",
+    "TimerEventDefinition": "bpmn:TimerEventDefinition",
+    "ErrorEventDefinition": "bpmn:ErrorEventDefinition",
+    "SignalEventDefinition": "bpmn:SignalEventDefinition",
+    "EscalationEventDefinition": "bpmn:EscalationEventDefinition",
+    "ConditionalEventDefinition": "bpmn:ConditionalEventDefinition",
+    "LinkEventDefinition": "bpmn:LinkEventDefinition",
+    "CompensateEventDefinition": "bpmn:CompensateEventDefinition",
+    "CancelEventDefinition": "bpmn:CancelEventDefinition",
+    "TerminateEventDefinition": "bpmn:TerminateEventDefinition",
+    "SequenceFlow": "bpmn:SequenceFlow",
+    "BusinessRuleTask": "bpmn:BusinessRuleTask",
+    "ManualTask": "bpmn:ManualTask",
+    "ReceiveTask": "bpmn:ReceiveTask",
+    "SendTask": "bpmn:SendTask",
+    "ScriptTask": "bpmn:ScriptTask",
+    "ServiceTask": "bpmn:ServiceTask",
+    "UserTask": "bpmn:UserTask",
+    "ExclusiveGateway": "bpmn:ExclusiveGateway",
+    "ParallelGateway": "bpmn:ParallelGateway",
+    "InclusiveGateway": "bpmn:InclusiveGateway",
+    "EventBasedGateway": "bpmn:EventBasedGateway",
+    "ComplexGateway": "bpmn:ComplexGateway",
+    "Expression": "bpmn:Expression",
+    "FormalExpression": "bpmn:FormalExpression",
+    "DataObject": "bpmn:DataObject",
+    "DataObjectReference": "bpmn:DataObjectReference",
+    "DataStore": "bpmn:DataStore",
+    "DataStoreReference": "bpmn:DataStoreReference",
+    "DataInput": "bpmn:DataInput",
+    "DataOutput": "bpmn:DataOutput",
+    "InputSet": "bpmn:InputSet",
+    "OutputSet": "bpmn:OutputSet",
+    "InputOutputSpecification": "bpmn:InputOutputSpecification",
+    "DataInputAssociation": "bpmn:DataInputAssociation",
+    "DataOutputAssociation": "bpmn:DataOutputAssociation",
+    "Assignment": "bpmn:Assignment",
+    "Unspecified": "bpmn:Unspecified",
+    "Converging": "bpmn:Converging",
+    "Diverging": "bpmn:Diverging",
+    "Mixed": "bpmn:Mixed",
+    "Exclusive": "bpmn:Exclusive",
+    "Parallel": "bpmn:Parallel",
+    "Sequential": "bpmn:Sequential",
+    "Compensate": "bpmn:Compensate",
+    "Image": "bpmn:Image",
+    "Store": "bpmn:Store",
+    "None": "bpmn:None",
+    "One": "bpmn:One",
+    "Both": "bpmn:Both",
+    "Public": "bpmn:Public",
+    "Private": "bpmn:Private",
+    "name": "bpmn:name",
+    "flowElements": { "@id": "bpmn:flowElements", "@container": "@set" },
+    "laneSets": { "@id": "bpmn:laneSets", "@container": "@set" },
+    "lanes": { "@id": "bpmn:lanes", "@container": "@set" },
+    "flowNodeRef": { "@id": "bpmn:flowNodeRef", "@type": "@id", "@container": "@set" },
+    "childLaneSet": { "@id": "bpmn:childLaneSet" },
+    "partitionElement": { "@id": "bpmn:partitionElement" },
+    "partitionElementRef": { "@id": "bpmn:partitionElementRef", "@type": "@id" },
+    "gatewayDirection": { "@id": "bpmn:gatewayDirection", "@type": "@vocab" },
+    "eventGatewayType": { "@id": "bpmn:eventGatewayType", "@type": "@vocab" },
+    "processType": { "@id": "bpmn:processType", "@type": "@vocab" },
+    "isExecutable": { "@id": "bpmn:isExecutable", "@type": "xsd:boolean" },
+    "isImmediate": { "@id": "bpmn:isImmediate", "@type": "xsd:boolean" },
+    "isClosed": { "@id": "bpmn:isClosed", "@type": "xsd:boolean" },
+    "instantiate": { "@id": "bpmn:instantiate", "@type": "xsd:boolean" },
+    "implementation": "bpmn:implementation",
+    "script": "bpmn:script",
+    "scriptFormat": "bpmn:scriptFormat",
+    "eventDefinitionRef": { "@id": "bpmn:eventDefinitionRef", "@type": "@id", "@container": "@set" },
+    "eventDefinitions": { "@id": "bpmn:eventDefinitions", "@container": "@set" },
+    "attachedToRef": { "@id": "bpmn:attachedToRef", "@type": "@id" },
+    "cancelActivity": { "@id": "bpmn:cancelActivity", "@type": "xsd:boolean" },
+    "isInterrupting": { "@id": "bpmn:isInterrupting", "@type": "xsd:boolean" },
+    "triggeredByEvent": { "@id": "bpmn:triggeredByEvent", "@type": "xsd:boolean" },
+    "parallelMultiple": { "@id": "bpmn:parallelMultiple", "@type": "xsd:boolean" },
+    "timeDate": "bpmn:timeDate",
+    "timeDuration": "bpmn:timeDuration",
+    "timeCycle": "bpmn:timeCycle",
+    "errorCode": "bpmn:errorCode",
+    "escalationCode": "bpmn:escalationCode",
+    "waitForCompletion": { "@id": "bpmn:waitForCompletion", "@type": "xsd:boolean" },
+    "sourceRef": { "@id": "bpmn:sourceRef", "@type": "@id" },
+    "targetRef": { "@id": "bpmn:targetRef", "@type": "@id" },
+    "participants": { "@id": "bpmn:participants", "@container": "@set" },
+    "artifacts": { "@id": "bpmn:artifacts", "@container": "@set" },
+    "associationDirection": { "@id": "bpmn:associationDirection", "@type": "@vocab" },
+    "messageFlows": { "@id": "bpmn:messageFlows", "@container": "@set" },
+    "processRef": { "@id": "bpmn:processRef", "@type": "@id" },
+    "messageRef": { "@id": "bpmn:messageRef", "@type": "@id" },
+    "source": { "@id": "bpmn:source", "@type": "@id", "@container": "@set" },
+    "target": { "@id": "bpmn:target", "@type": "@id" },
+    "itemRef": { "@id": "bpmn:itemRef", "@type": "@id" },
+    "signalRef": { "@id": "bpmn:signalRef", "@type": "@id" },
+    "errorRef": { "@id": "bpmn:errorRef", "@type": "@id" },
+    "escalationRef": { "@id": "bpmn:escalationRef", "@type": "@id" },
+    "activityRef": { "@id": "bpmn:activityRef", "@type": "@id" },
+    "structureRef": { "@id": "bpmn:structureRef", "@type": "@id" },
+    "operationRef": { "@id": "bpmn:operationRef", "@type": "@id" },
+    "default": { "@id": "bpmn:default", "@type": "@id" },
+    "conditionExpression": { "@id": "bpmn:conditionExpression" },
+    "method": { "@id": "bpmn:method", "@type": "@vocab" },
+    "isForCompensation": { "@id": "bpmn:isForCompensation", "@type": "xsd:boolean" },
+    "startQuantity": { "@id": "bpmn:startQuantity", "@type": "xsd:nonNegativeInteger" },
+    "completionQuantity": { "@id": "bpmn:completionQuantity", "@type": "xsd:nonNegativeInteger" },
+    "completionCondition": { "@id": "bpmn:completionCondition" },
+    "condition": { "@id": "bpmn:condition" },
+    "activationCondition": { "@id": "bpmn:activationCondition" },
+    "evaluatesToTypeRef": { "@id": "bpmn:evaluatesToTypeRef", "@type": "@id" },
+    "ordering": { "@id": "bpmn:ordering", "@type": "@vocab" },
+    "cancelRemainingInstances": { "@id": "bpmn:cancelRemainingInstances", "@type": "xsd:boolean" },
+    "language": "bpmn:language",
+    "body": "bpmn:body",
+    "ioSpecification": { "@id": "bpmn:ioSpecification" },
+    "dataInputs": { "@id": "bpmn:dataInputs", "@container": "@set" },
+    "dataOutputs": { "@id": "bpmn:dataOutputs", "@container": "@set" },
+    "inputSets": { "@id": "bpmn:inputSets", "@container": "@set" },
+    "outputSets": { "@id": "bpmn:outputSets", "@container": "@set" },
+    "dataInputRefs": { "@id": "bpmn:dataInputRefs", "@type": "@id", "@container": "@set" },
+    "optionalInputRefs": { "@id": "bpmn:optionalInputRefs", "@type": "@id", "@container": "@set" },
+    "whileExecutingInputRefs": { "@id": "bpmn:whileExecutingInputRefs", "@type": "@id", "@container": "@set" },
+    "outputSetRefs": { "@id": "bpmn:outputSetRefs", "@type": "@id", "@container": "@set" },
+    "dataOutputRefs": { "@id": "bpmn:dataOutputRefs", "@type": "@id", "@container": "@set" },
+    "optionalOutputRefs": { "@id": "bpmn:optionalOutputRefs", "@type": "@id", "@container": "@set" },
+    "whileExecutingOutputRefs": { "@id": "bpmn:whileExecutingOutputRefs", "@type": "@id", "@container": "@set" },
+    "inputSetRefs": { "@id": "bpmn:inputSetRefs", "@type": "@id", "@container": "@set" },
+    "dataInputAssociations": { "@id": "bpmn:dataInputAssociations", "@container": "@set" },
+    "dataOutputAssociations": { "@id": "bpmn:dataOutputAssociations", "@container": "@set" },
+    "transformation": { "@id": "bpmn:transformation" },
+    "assignments": { "@id": "bpmn:assignments", "@container": "@set" },
+    "from": { "@id": "bpmn:from" },
+    "to": { "@id": "bpmn:to" },
+    "dataObjectRef": { "@id": "bpmn:dataObjectRef", "@type": "@id" },
+    "dataStoreRef": { "@id": "bpmn:dataStoreRef", "@type": "@id" },
+    "isCollection": { "@id": "bpmn:isCollection", "@type": "xsd:boolean" },
+    "capacity": { "@id": "bpmn:capacity", "@type": "xsd:integer" },
+    "isUnlimited": { "@id": "bpmn:isUnlimited", "@type": "xsd:boolean" }
+  }
+}

package/contexts/di.jsonld

@@ -0,0 +1,37 @@
+{
+  "@context": {
+    "@version": 1.1,
+    "@protected": true,
+    "id": "@id",
+    "type": "@type",
+    "xsd": "http://www.w3.org/2001/XMLSchema#",
+    "bpmndi": "https://bpmn-ld.example.org/di#",
+    "BPMNDiagram": "bpmndi:BPMNDiagram",
+    "BPMNPlane": "bpmndi:BPMNPlane",
+    "BPMNShape": "bpmndi:BPMNShape",
+    "BPMNEdge": "bpmndi:BPMNEdge",
+    "BPMNLabel": "bpmndi:BPMNLabel",
+    "Bounds": "bpmndi:Bounds",
+    "Point": "bpmndi:Point",
+    "plane": { "@id": "bpmndi:plane" },
+    "planeElements": { "@id": "bpmndi:planeElements", "@container": "@set" },
+    "bpmnElement": { "@id": "bpmndi:bpmnElement", "@type": "@id" },
+    "bounds": { "@id": "bpmndi:bounds" },
+    "label": { "@id": "bpmndi:label" },
+    "waypoints": { "@id": "bpmndi:waypoints", "@container": "@list" },
+    "sourceElement": { "@id": "bpmndi:sourceElement", "@type": "@id" },
+    "targetElement": { "@id": "bpmndi:targetElement", "@type": "@id" },
+    "initiating": "bpmndi:initiating",
+    "non_initiating": "bpmndi:non_initiating",
+    "resolution": { "@id": "bpmndi:resolution", "@type": "xsd:double" },
+    "messageVisibleKind": { "@id": "bpmndi:messageVisibleKind", "@type": "@vocab" },
+    "isExpanded": { "@id": "bpmndi:isExpanded", "@type": "xsd:boolean" },
+    "isHorizontal": { "@id": "bpmndi:isHorizontal", "@type": "xsd:boolean" },
+    "isMarkerVisible": { "@id": "bpmndi:isMarkerVisible", "@type": "xsd:boolean" },
+    "isMessageVisible": { "@id": "bpmndi:isMessageVisible", "@type": "xsd:boolean" },
+    "x": { "@id": "bpmndi:x", "@type": "xsd:double" },
+    "y": { "@id": "bpmndi:y", "@type": "xsd:double" },
+    "width": { "@id": "bpmndi:width", "@type": "xsd:double" },
+    "height": { "@id": "bpmndi:height", "@type": "xsd:double" }
+  }
+}

package/dist/analyze/analyze.d.ts

@@ -0,0 +1,3 @@
+import { type Finding } from "./findings.ts";
+import type { Rule } from "./rules/rule.ts";
+export declare const analyze: (document: unknown, base: string, rules?: Rule[]) => Promise<Finding[]>;

package/dist/analyze/analyze.js

@@ -0,0 +1,11 @@
+import { validateDocument } from "../validate.js";
+import { STRUCTURAL_RULE } from "./findings.js";
+import { rules as defaultRules } from "./rules/index.js";
+import { buildScopes } from "./scope-graph.js";
+export const analyze = async (document, base, rules = defaultRules) => {
+    const structure = await validateDocument(document, base);
+    if (!structure.valid) {
+        return structure.errors.map((message) => ({ rule: STRUCTURAL_RULE, severity: "error", node: null, message }));
+    }
+    return buildScopes(structure.expanded).flatMap((scope) => rules.flatMap((rule) => rule.check(scope)));
+};

package/dist/analyze/findings.d.ts

@@ -0,0 +1,8 @@
+export type Severity = "error" | "warning";
+export interface Finding {
+    rule: string;
+    severity: Severity;
+    node: string | null;
+    message: string;
+}
+export declare const STRUCTURAL_RULE = "structural-validity";

package/dist/analyze/findings.js

@@ -0,0 +1 @@
+export const STRUCTURAL_RULE = "structural-validity";

package/dist/analyze/report.d.ts

@@ -0,0 +1,3 @@
+import type { Finding } from "./findings.ts";
+export declare const formatJson: (findings: Finding[]) => string;
+export declare const formatText: (findings: Finding[]) => string;

package/dist/analyze/report.js

@@ -0,0 +1,9 @@
+const count = (findings, severity) => findings.filter((f) => f.severity === severity).length;
+export const formatJson = (findings) => `${JSON.stringify({ findings, summary: { errors: count(findings, "error"), warnings: count(findings, "warning") } }, null, 2)}\n`;
+export const formatText = (findings) => {
+    if (findings.length === 0)
+        return "no findings\n";
+    const lines = findings.map((f) => `${f.severity} ${f.rule} ${f.node ?? "-"}: ${f.message}`);
+    lines.push(`${count(findings, "error")} error(s), ${count(findings, "warning")} warning(s)`);
+    return `${lines.join("\n")}\n`;
+};

package/dist/analyze/rules/ad-hoc-completion-condition.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from "./rule.ts";
+export declare const adHocCompletionConditionRule: Rule;

package/dist/analyze/rules/ad-hoc-completion-condition.js

@@ -0,0 +1,7 @@
+export const adHocCompletionConditionRule = {
+    id: "ad-hoc-completion-condition-missing",
+    severity: "warning",
+    check: (scope) => scope.adHoc && !scope.completionCondition
+        ? [{ rule: "ad-hoc-completion-condition-missing", severity: "warning", node: scope.id, message: "ad-hoc sub-process has no completion condition, so nothing defines when it ends" }]
+        : [],
+};

package/dist/analyze/rules/cannot-reach-end.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from "./rule.ts";
+export declare const cannotReachEndRule: Rule;

package/dist/analyze/rules/cannot-reach-end.js

@@ -0,0 +1,28 @@
+import { hasType } from "../scope-graph.js";
+export const cannotReachEndRule = {
+    id: "node-cannot-reach-end",
+    severity: "warning",
+    check: (scope) => {
+        const ends = scope.nodes.filter((node) => hasType(node, "EndEvent"));
+        if (scope.adHoc || ends.length === 0)
+            return [];
+        const predecessors = new Map();
+        const link = (from, to) => predecessors.set(to, [...(predecessors.get(to) ?? []), from]);
+        scope.flows.forEach((flow) => flow.source !== null && flow.target !== null && link(flow.source, flow.target));
+        scope.nodes.forEach((node) => node.attachedTo !== null && link(node.attachedTo, node.id));
+        const reaching = new Set(ends.map((node) => node.id));
+        const queue = [...reaching];
+        while (queue.length > 0) {
+            for (const previous of predecessors.get(queue.shift()) ?? []) {
+                if (!reaching.has(previous)) {
+                    reaching.add(previous);
+                    queue.push(previous);
+                }
+            }
+        }
+        const sources = new Set(scope.flows.map((flow) => flow.source));
+        return scope.nodes
+            .filter((node) => !node.exempt && !reaching.has(node.id) && sources.has(node.id))
+            .map((node) => ({ rule: "node-cannot-reach-end", severity: "warning", node: node.id, message: "no end event can be reached from this flow node" }));
+    },
+};

package/dist/analyze/rules/compensation-association.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from "./rule.ts";
+export declare const compensationAssociationRule: Rule;