@sysdml/contracts

The shared contract surface between SysDML packages.

Inclusion rule

A type lives here if and only if it crosses a package boundary — it is imported by a package other than the one that produces it. Package-private types stay in their owning package. This package holds no behavior: only types plus the enums and const-tables that define a contract's valid value-space (e.g. DiagnosticCode, BUILTIN_*).

Domains

• expression/ — the formula tree (IRExpressionNode) and the builtin-function tables.
• syntax/ — parser output: Span, AST nodes, Diagnostic, ParseResult.
• diagnostics/ — semantic diagnostics from compilation (IRDiagnostic) and simulation.
• model/ — the system-dynamics model graph (IR and its parts) and CompileResult.
• simulation/ — simulation output (SimulationResult, SimRow, Simulator).
• protocol/ — serialized messages crossing process boundaries (extension ↔ webview). Runtime schemas land here when added.

Domain dependency graph

The domains form an acyclic graph: leaves depend on nothing, and arrows point from a domain to the domains it depends on. Generated from the actual cross-domain imports by scripts/generate-diagrams.mjs — do not edit the block below by hand.

graph TD
  expression["expression — leaf"]
  syntax["syntax — leaf"]
  diagnostics --> syntax
  model --> diagnostics
  model --> expression
  simulation --> model
  simulation --> diagnostics
  protocol --> diagnostics
  protocol --> model

Model shape

How the IR model graph composes, and where the shared IRExpressionNode formula tree is referenced — edge labels are the property names. Generated from the model/ domain's type definitions by scripts/generate-diagrams.mjs — do not edit the block below by hand.

graph TD
  IRStock -->|init| IRExpressionNode
  IRStock -->|position| IRPosition
  IRAuxiliary -->|expr| IRExpressionNode
  IRAuxiliary -->|position| IRPosition
  IRFlow -->|rate| IRExpressionNode
  IRFlow -->|position| IRPosition
  IRFlow -->|via| IRPosition
  IRConnection -->|via| IRPosition
  IRGraphicalFunction -->|kind| IRGraphicalFunctionKind
  IR -->|time| IRTime
  IR -->|stocks| IRStock
  IR -->|auxiliaries| IRAuxiliary
  IR -->|flows| IRFlow
  IR -->|connections| IRConnection
  IR -->|graphicalFunctions| IRGraphicalFunction
  CompileResult -->|ir| IR
  CompileResult -->|diagnostics| IRDiagnostic