@canonical/anatomy-dsl 0.2.0 → 0.2.1

package/definitions/ontology.ttl

@@ -0,0 +1,190 @@
+@prefix anatomy: <http://anatomy-dsl.example.org/ontology#> .
+@prefix owl:     <http://www.w3.org/2002/07/owl#> .
+@prefix rdfs:    <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix rdf:     <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix xsd:     <http://www.w3.org/2001/XMLSchema#> .
+@prefix skos:    <http://www.w3.org/2004/02/skos/core#> .
+
+# ═══════════════════════════════════════════════════════════════
+# ONTOLOGY DECLARATION
+# ═══════════════════════════════════════════════════════════════
+
+<http://anatomy-dsl.example.org/ontology> a owl:Ontology ;
+    owl:versionInfo "0.2.0" ;
+    rdfs:label "Anatomy DSL Ontology" ;
+    rdfs:comment "Compliant with OWL DL profile" ;
+    skos:definition """Meta-model for the Anatomy DSL — a YAML-based language
+    for describing design system component structure.
+
+    Models anatomy files as trees of nodes connected by reified edges.
+    Inspired by the Relay GraphQL connection pattern.
+
+    Consolidates WD404 (core) and WD404.1 (addendum 1).
+
+    OUT OF SCOPE (matching the DSL itself):
+    - Prop mapping
+    - State or state machines
+    - Modifier descriptions (only token references)
+
+    Validation shapes defined in shapes.ttl.""" .
+
+# ═══════════════════════════════════════════════════════════════
+# CORE CLASSES
+# ═══════════════════════════════════════════════════════════════
+
+anatomy:Specification a owl:Class ;
+    rdfs:label "Specification" ;
+    skos:definition "Root of an anatomy file." .
+
+anatomy:Node a owl:Class ;
+    rdfs:label "Node" ;
+    skos:definition "Position in the anatomy tree." .
+
+anatomy:NamedNode a owl:Class ;
+    rdfs:subClassOf anatomy:Node ;
+    rdfs:label "Named Node" ;
+    skos:definition "Design system entity instantiable by consumers." .
+
+anatomy:AnonymousNode a owl:Class ;
+    rdfs:subClassOf anatomy:Node ;
+    rdfs:label "Anonymous Node" ;
+    skos:definition "Structural element without design system identity." .
+
+anatomy:Edge a owl:Class ;
+    rdfs:label "Edge" ;
+    skos:definition "Reified parent-child relationship in the anatomy tree." .
+
+anatomy:Relation a owl:Class ;
+    rdfs:label "Relation" ;
+    skos:definition "Metadata qualifying a parent-child relationship." .
+
+anatomy:Style a owl:Class ;
+    rdfs:label "Style" ;
+    skos:definition "A single style declaration binding a property key to a value." .
+
+# ═══════════════════════════════════════════════════════════════
+# SWITCH CONSTRUCT
+# ═══════════════════════════════════════════════════════════════
+
+anatomy:Switch a owl:Class ;
+    rdfs:label "Switch" ;
+    skos:definition "Polymorphic position admitting several alternatives." .
+
+anatomy:SwitchCase a owl:Class ;
+    rdfs:label "Switch Case" ;
+    skos:definition "One alternative within a Switch." .
+
+# ═══════════════════════════════════════════════════════════════
+# OBJECT PROPERTIES
+# ═══════════════════════════════════════════════════════════════
+
+anatomy:rootNode a owl:ObjectProperty ;
+    rdfs:label "root node" ;
+    rdfs:domain anatomy:Specification ;
+    rdfs:range anatomy:NamedNode ;
+    skos:definition "Top-level node of an anatomy specification." .
+
+anatomy:hasEdge a owl:ObjectProperty ;
+    rdfs:label "has edge" ;
+    rdfs:domain anatomy:Node ;
+    rdfs:range anatomy:Edge ;
+    skos:definition "Connects a node to a child relationship." .
+
+anatomy:hasRelation a owl:ObjectProperty ;
+    rdfs:label "has relation" ;
+    rdfs:domain anatomy:Edge ;
+    rdfs:range anatomy:Relation ;
+    skos:definition "Relation qualifying this edge." .
+
+anatomy:edgeTarget a owl:ObjectProperty ;
+    rdfs:label "edge target" ;
+    rdfs:domain anatomy:Edge ;
+    rdfs:range anatomy:Node ;
+    skos:definition "Child node this edge connects to." .
+
+anatomy:edgeSwitch a owl:ObjectProperty ;
+    rdfs:label "edge switch" ;
+    rdfs:domain anatomy:Edge ;
+    rdfs:range anatomy:Switch ;
+    skos:definition "Polymorphic switch this edge connects to." .
+
+anatomy:hasCase a owl:ObjectProperty ;
+    rdfs:label "has case" ;
+    rdfs:domain anatomy:Switch ;
+    rdfs:range anatomy:SwitchCase ;
+    skos:definition "An alternative within this switch." .
+
+anatomy:caseNode a owl:ObjectProperty ;
+    rdfs:label "case node" ;
+    rdfs:domain anatomy:SwitchCase ;
+    rdfs:range anatomy:Node ;
+    skos:definition "Node this case resolves to." .
+
+anatomy:hasStyle a owl:ObjectProperty ;
+    rdfs:label "has style" ;
+    rdfs:domain anatomy:Node ;
+    rdfs:range anatomy:Style ;
+    skos:definition "Attaches a style declaration to a node." .
+
+# ═══════════════════════════════════════════════════════════════
+# DATATYPE PROPERTIES
+# ═══════════════════════════════════════════════════════════════
+
+anatomy:uri a owl:DatatypeProperty ;
+    rdfs:label "uri" ;
+    rdfs:domain anatomy:NamedNode ;
+    rdfs:range xsd:string ;
+    skos:definition "Unique identifier for a named node within the design system." ;
+    skos:example "global.component.button" ,
+                 "global.subcomponent.accordion-item" ,
+                 "global.subcomponent.card_header" .
+
+anatomy:role a owl:DatatypeProperty ;
+    rdfs:label "role" ;
+    rdfs:domain anatomy:AnonymousNode ;
+    rdfs:range xsd:string ;
+    skos:definition "Human-readable purpose of an anonymous node." ;
+    skos:example "content wrapper" ,
+                 "spacer element" ,
+                 "icon container" .
+
+anatomy:discriminator a owl:DatatypeProperty ;
+    rdfs:label "discriminator" ;
+    rdfs:domain anatomy:Switch ;
+    rdfs:range xsd:string ;
+    skos:definition "What determines which case applies." ;
+    skos:example "props" , "internal" , "override" .
+
+anatomy:cardinality a owl:DatatypeProperty ;
+    rdfs:label "cardinality" ;
+    rdfs:domain anatomy:Relation ;
+    rdfs:range xsd:string ;
+    skos:definition "Instance count constraint on the child." ;
+    skos:example "1" , "0..1" , "0..*" , "1..*" , "2..5" .
+
+anatomy:slotName a owl:DatatypeProperty ;
+    rdfs:label "slot name" ;
+    rdfs:domain anatomy:Relation ;
+    rdfs:range xsd:string ;
+    skos:definition "Named slot in the parent that this child maps to." ;
+    skos:example "default" , "header" , "footer" , "icon" .
+
+anatomy:styleKey a owl:DatatypeProperty ;
+    rdfs:label "style key" ;
+    rdfs:domain anatomy:Style ;
+    rdfs:range xsd:string ;
+    skos:definition "Platform-agnostic style property identifier." ;
+    skos:example "layout.type" ,
+                 "spacing.internal" ,
+                 "appearance.background" ,
+                 "typography.weight" .
+
+anatomy:styleValue a owl:DatatypeProperty ;
+    rdfs:label "style value" ;
+    rdfs:domain anatomy:Style ;
+    rdfs:range xsd:string ;
+    skos:definition "Value for a style property." ;
+    skos:example "stack" ,
+                 "spacing/medium" ,
+                 "color/surface/primary" ,
+                 "color/surface/button?" .

package/definitions/shapes.ttl

@@ -0,0 +1,232 @@
+@prefix anatomy: <http://anatomy-dsl.example.org/ontology#> .
+@prefix sh:      <http://www.w3.org/ns/shacl#> .
+@prefix xsd:     <http://www.w3.org/2001/XMLSchema#> .
+@prefix rdfs:    <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix skos:    <http://www.w3.org/2004/02/skos/core#> .
+
+# ═══════════════════════════════════════════════════════════════
+# SHACL SHAPES FOR ANATOMY DSL 0.2.0
+# ═══════════════════════════════════════════════════════════════
+#
+# Constraints, patterns, enumerations, and encoding conventions.
+# Semantic definitions live in ontology.ttl.
+#
+# Shapes:
+#   SpecificationShape  — root document
+#   NamedNodeShape      — uri required, encoding pattern
+#   AnonymousNodeShape  — role required
+#   EdgeShape           — edgeTarget XOR edgeSwitch
+#   RelationShape       — cardinality pattern, optional slotName
+#   SwitchShape         — discriminator enum, minimum cases
+#   SwitchCaseShape     — case node required
+#   StyleShape          — reified key-value tuple (one key, one value)
+# ═══════════════════════════════════════════════════════════════
+
+# ───────────────────────────────────────────────────────────────
+# SPECIFICATION
+# ───────────────────────────────────────────────────────────────
+
+anatomy:SpecificationShape a sh:NodeShape ;
+    sh:targetClass anatomy:Specification ;
+    rdfs:label "Specification Shape" ;
+    skos:definition "Root document constraints." ;
+
+    sh:property [
+        sh:path anatomy:rootNode ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:class anatomy:NamedNode ;
+        sh:message "Specification requires exactly one rootNode of type NamedNode." ;
+    ] .
+
+# ───────────────────────────────────────────────────────────────
+# NAMED NODE
+# ───────────────────────────────────────────────────────────────
+
+anatomy:NamedNodeShape a sh:NodeShape ;
+    sh:targetClass anatomy:NamedNode ;
+    rdfs:label "Named Node Shape" ;
+    skos:definition "URI encoding and presence constraints." ;
+
+    sh:property [
+        sh:path anatomy:uri ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:datatype xsd:string ;
+        sh:minLength 1 ;
+        sh:message "NamedNode requires exactly one non-empty uri." ;
+    ] ;
+
+    # URI encoding: dot-separated hierarchy, underscore for PascalCase
+    # word boundaries, hyphen for compound names from dotted labels.
+    # Reserved value "$custom" for consumer-provided components.
+    sh:property [
+        sh:path anatomy:uri ;
+        sh:pattern "^(\\$custom|[a-z][a-z0-9_-]*(\\.[a-z][a-z0-9_-]*)*)$" ;
+        sh:message "URI must be dot-separated lowercase path or '$custom'." ;
+    ] ;
+
+    sh:property [
+        sh:path anatomy:role ;
+        sh:maxCount 0 ;
+        sh:message "NamedNode must not have a role (use AnonymousNode instead)." ;
+    ] .
+
+# ───────────────────────────────────────────────────────────────
+# ANONYMOUS NODE
+# ───────────────────────────────────────────────────────────────
+
+anatomy:AnonymousNodeShape a sh:NodeShape ;
+    sh:targetClass anatomy:AnonymousNode ;
+    rdfs:label "Anonymous Node Shape" ;
+    skos:definition "Role presence and uri exclusion." ;
+
+    sh:property [
+        sh:path anatomy:role ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:datatype xsd:string ;
+        sh:minLength 1 ;
+        sh:message "AnonymousNode requires exactly one non-empty role." ;
+    ] ;
+
+    sh:property [
+        sh:path anatomy:uri ;
+        sh:maxCount 0 ;
+        sh:message "AnonymousNode must not have a uri (use NamedNode instead)." ;
+    ] .
+
+# ───────────────────────────────────────────────────────────────
+# EDGE
+# ───────────────────────────────────────────────────────────────
+
+anatomy:EdgeShape a sh:NodeShape ;
+    sh:targetClass anatomy:Edge ;
+    rdfs:label "Edge Shape" ;
+    skos:definition "Mutual exclusivity of edgeTarget and edgeSwitch." ;
+
+    sh:property [
+        sh:path anatomy:hasRelation ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:class anatomy:Relation ;
+        sh:message "Edge requires exactly one relation." ;
+    ] ;
+
+    sh:or (
+        [
+            sh:property [
+                sh:path anatomy:edgeTarget ;
+                sh:minCount 1 ;
+                sh:maxCount 1 ;
+            ] ;
+            sh:property [
+                sh:path anatomy:edgeSwitch ;
+                sh:maxCount 0 ;
+            ] ;
+        ]
+        [
+            sh:property [
+                sh:path anatomy:edgeSwitch ;
+                sh:minCount 1 ;
+                sh:maxCount 1 ;
+            ] ;
+            sh:property [
+                sh:path anatomy:edgeTarget ;
+                sh:maxCount 0 ;
+            ] ;
+        ]
+    ) ;
+    sh:message "Edge requires exactly one of edgeTarget or edgeSwitch." .
+
+# ───────────────────────────────────────────────────────────────
+# RELATION
+# ───────────────────────────────────────────────────────────────
+
+anatomy:RelationShape a sh:NodeShape ;
+    sh:targetClass anatomy:Relation ;
+    rdfs:label "Relation Shape" ;
+    skos:definition "Cardinality pattern and slotName constraints." ;
+
+    sh:property [
+        sh:path anatomy:cardinality ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:datatype xsd:string ;
+        sh:pattern "^\\d+(\\.\\.(\\d+|\\*))?$" ;
+        sh:message "Cardinality must match: digit+ ('..' (digit+ | '*'))?" ;
+    ] ;
+
+    sh:property [
+        sh:path anatomy:slotName ;
+        sh:maxCount 1 ;
+        sh:datatype xsd:string ;
+    ] .
+
+# ───────────────────────────────────────────────────────────────
+# SWITCH
+# ───────────────────────────────────────────────────────────────
+
+anatomy:SwitchShape a sh:NodeShape ;
+    sh:targetClass anatomy:Switch ;
+    rdfs:label "Switch Shape" ;
+    skos:definition "Discriminator vocabulary and minimum case count." ;
+
+    sh:property [
+        sh:path anatomy:discriminator ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:datatype xsd:string ;
+        sh:in ( "props" "internal" "override" ) ;
+        sh:message "Discriminator must be one of: props, internal, override." ;
+    ] ;
+
+    sh:property [
+        sh:path anatomy:hasCase ;
+        sh:minCount 2 ;
+        sh:class anatomy:SwitchCase ;
+        sh:message "Switch requires at least two cases." ;
+    ] .
+
+# ───────────────────────────────────────────────────────────────
+# SWITCH CASE
+# ───────────────────────────────────────────────────────────────
+
+anatomy:SwitchCaseShape a sh:NodeShape ;
+    sh:targetClass anatomy:SwitchCase ;
+    rdfs:label "Switch Case Shape" ;
+    skos:definition "Each case resolves to a node." ;
+
+    sh:property [
+        sh:path anatomy:caseNode ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:class anatomy:Node ;
+        sh:message "SwitchCase requires exactly one caseNode." ;
+    ] .
+
+# ───────────────────────────────────────────────────────────────
+# STYLE
+# ───────────────────────────────────────────────────────────────
+
+anatomy:StyleShape a sh:NodeShape ;
+    sh:targetClass anatomy:Style ;
+    rdfs:label "Style Shape" ;
+    skos:definition "Reified key-value tuple: exactly one key and one value." ;
+
+    sh:property [
+        sh:path anatomy:styleKey ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:datatype xsd:string ;
+        sh:pattern "^[a-z]+\\.[a-z]+(\\.[a-z]+)*$" ;
+        sh:message "Style key must follow CTI dot-notation: category.type[.item]." ;
+    ] ;
+
+    sh:property [
+        sh:path anatomy:styleValue ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:datatype xsd:string ;
+        sh:message "Style requires exactly one value." ;
+    ] .

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@canonical/anatomy-dsl",
   "description": "Anatomy DSL meta-model: TypeScript types mirroring the OWL ontology, and a YAML-to-Turtle transform",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "type": "module",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -12,7 +12,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "definitions"
   ],
   "license": "LGPL-3.0",
   "scripts": {