colregs 0.3.1 → 0.3.3

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "colregs",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "COLREGS 72 and its national amalgamations as language-neutral JSON — rule text, light definitions, and applicability predicates — with cross-implementation fixtures",
   "license": "Apache-2.0",
+  "colregs": {
+    "referenceLanguage": "en"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mark-brannan/colregs.git"

package/schema/applicability.schema.json

@@ -10,21 +10,21 @@
     "ruleCategory": {
       "type": "string",
       "enum": [
-        "definition",
-        "standard",
-        "scope",
-        "display",
-        "classification",
-        "precedence",
-        "conduct",
-        "care",
-        "meta"
+        "category:definition",
+        "category:standard",
+        "category:scope",
+        "category:display",
+        "category:classification",
+        "category:precedence",
+        "category:conduct",
+        "category:care",
+        "category:meta"
       ]
     },
     "ruleId": { "type": "string", "pattern": "^rule:[0-9]+[a-z]?(_[ivx]+)*(:[a-z][a-z0-9_]*)?$" },
     "modality": {
       "type": "string",
-      "enum": ["shall", "may", "shall-if-practicable", "conditional", "exempt", "shall-not", "shall-not-impede"]
+      "enum": ["modality:shall", "modality:may", "modality:shall-if-practicable", "modality:conditional", "modality:exempt", "modality:shall-not", "modality:shall-not-impede"]
     },
     "predicateValue": {
       "oneOf": [
@@ -95,13 +95,13 @@
       },
       "patternProperties": {
         "^fact:[a-z0-9_]+$": { "$ref": "#/$defs/predicateValue" },
-        "^(own|other):(fact|kin|geo|hist):[a-z0-9_]+$": { "$ref": "#/$defs/predicateValue" },
+        "^(self|other):(fact|kin|geo|hist):[a-z0-9_]+$": { "$ref": "#/$defs/predicateValue" },
         "^pair:(geo|env):[a-z0-9_]+$": { "$ref": "#/$defs/predicateValue" }
       }
     },
     "effectRole": {
       "type": "string",
-      "enum": ["give-way", "stand-on", "shall-not-impede", "keep-clear", "none"]
+      "enum": ["role:give-way", "role:stand-on", "role:shall-not-impede", "role:keep-clear", "role:none"]
     },
     "effect": {
       "oneOf": [
@@ -122,9 +122,9 @@
         {
           "type": "object",
           "additionalProperties": false,
-          "required": ["own", "other"],
+          "required": ["self", "other"],
           "properties": {
-            "own": { "$ref": "#/$defs/effectRole" },
+            "self": { "$ref": "#/$defs/effectRole" },
             "other": { "$ref": "#/$defs/effectRole" }
           }
         },
@@ -135,7 +135,7 @@
           "properties": {
             "encounter": {
               "type": "string",
-              "enum": ["head-on", "crossing", "overtaking", "none"]
+              "enum": ["encounter:head-on", "encounter:crossing", "encounter:overtaking", "encounter:none"]
             }
           }
         },
@@ -230,48 +230,48 @@
       "type": "object",
       "additionalProperties": false,
       "required": [
-        "shall",
-        "may",
-        "shall-if-practicable",
-        "conditional",
-        "exempt",
-        "shall-not",
-        "shall-not-impede"
+        "modality:shall",
+        "modality:may",
+        "modality:shall-if-practicable",
+        "modality:conditional",
+        "modality:exempt",
+        "modality:shall-not",
+        "modality:shall-not-impede"
       ],
       "properties": {
-        "shall": { "type": "string" },
-        "may": { "type": "string" },
-        "shall-if-practicable": { "type": "string" },
-        "conditional": { "type": "string" },
-        "exempt": { "type": "string" },
-        "shall-not": { "type": "string" },
-        "shall-not-impede": { "type": "string" }
+        "modality:shall": { "type": "string" },
+        "modality:may": { "type": "string" },
+        "modality:shall-if-practicable": { "type": "string" },
+        "modality:conditional": { "type": "string" },
+        "modality:exempt": { "type": "string" },
+        "modality:shall-not": { "type": "string" },
+        "modality:shall-not-impede": { "type": "string" }
       }
     },
     "categories": {
       "type": "object",
       "additionalProperties": false,
       "required": [
-        "definition",
-        "standard",
-        "scope",
-        "display",
-        "classification",
-        "precedence",
-        "conduct",
-        "care",
-        "meta"
+        "category:definition",
+        "category:standard",
+        "category:scope",
+        "category:display",
+        "category:classification",
+        "category:precedence",
+        "category:conduct",
+        "category:care",
+        "category:meta"
       ],
       "properties": {
-        "definition": { "type": "string" },
-        "standard": { "type": "string" },
-        "scope": { "type": "string" },
-        "display": { "type": "string" },
-        "classification": { "type": "string" },
-        "precedence": { "type": "string" },
-        "conduct": { "type": "string" },
-        "care": { "type": "string" },
-        "meta": { "type": "string" }
+        "category:definition": { "type": "string" },
+        "category:standard": { "type": "string" },
+        "category:scope": { "type": "string" },
+        "category:display": { "type": "string" },
+        "category:classification": { "type": "string" },
+        "category:precedence": { "type": "string" },
+        "category:conduct": { "type": "string" },
+        "category:care": { "type": "string" },
+        "category:meta": { "type": "string" }
       }
     },
     "effects": {
@@ -283,29 +283,44 @@
         "roles": {
           "type": "object",
           "additionalProperties": false,
-          "required": ["give-way", "stand-on", "shall-not-impede", "keep-clear", "none"],
+          "required": ["role:give-way", "role:stand-on", "role:shall-not-impede", "role:keep-clear", "role:none"],
           "properties": {
-            "give-way": { "type": "string" },
-            "stand-on": { "type": "string" },
-            "shall-not-impede": { "type": "string" },
-            "keep-clear": { "type": "string" },
-            "none": { "type": "string" }
+            "role:give-way": { "type": "string" },
+            "role:stand-on": { "type": "string" },
+            "role:shall-not-impede": { "type": "string" },
+            "role:keep-clear": { "type": "string" },
+            "role:none": { "type": "string" }
           }
         },
         "encounters": {
           "type": "object",
           "additionalProperties": false,
-          "required": ["head-on", "crossing", "overtaking", "none"],
+          "required": ["encounter:head-on", "encounter:crossing", "encounter:overtaking", "encounter:none"],
           "properties": {
-            "head-on": { "type": "string" },
-            "crossing": { "type": "string" },
-            "overtaking": { "type": "string" },
-            "none": { "type": "string" }
+            "encounter:head-on": { "type": "string" },
+            "encounter:crossing": { "type": "string" },
+            "encounter:overtaking": { "type": "string" },
+            "encounter:none": { "type": "string" }
           }
         },
         "classification_shape": { "type": "string" }
       }
     },
+    "suppressions": {
+      "$comment": "Tombstones (REQ-SCOPE-3, ADR 0018): a jurisdiction deliberately lacks an inherited intl entry, as distinct from not-yet-transcribed. With the jurisdiction's own entries these form its RFC 7396 merge patch over intl; suppresses is the key that patch sets to null.",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["jurisdiction", "suppresses", "cite", "why"],
+        "properties": {
+          "jurisdiction": { "type": "string", "pattern": "^[a-z]+(/[a-z]+)+$" },
+          "suppresses": { "$ref": "#/$defs/ruleId" },
+          "cite": { "type": "string", "minLength": 1 },
+          "why": { "type": "string", "minLength": 1 }
+        }
+      }
+    },
     "known_omissions": {
       "type": "array",
       "items": {
@@ -329,7 +344,7 @@
           "id": { "$ref": "#/$defs/ruleId" },
           "jurisdiction": { "type": "string", "pattern": "^[a-z]+(/[a-z]+)*$" },
           "cite": { "type": "string", "minLength": 1 },
-          "category": { "type": "string", "enum": ["care", "meta"] },
+          "category": { "type": "string", "enum": ["category:care", "category:meta"] },
           "note": { "type": "string", "minLength": 1 }
         }
       }

package/schema/conduct-evaluation.schema.json

@@ -57,7 +57,7 @@
     "subject": {
       "type": "string",
       "enum": [
-        "own",
+        "self",
         "other"
       ]
     },

package/schema/encounter-evaluation.schema.json

@@ -30,10 +30,10 @@
       "$comment": "Absent when no classification entry fired: cannot say, not none (Q-43).",
       "type": "string",
       "enum": [
-        "head-on",
-        "crossing",
-        "overtaking",
-        "none"
+        "encounter:head-on",
+        "encounter:crossing",
+        "encounter:overtaking",
+        "encounter:none"
       ]
     },
     "risk_of_collision": {
@@ -56,11 +56,11 @@
       "type": "object",
       "additionalProperties": false,
       "required": [
-        "own",
+        "self",
         "other"
       ],
       "properties": {
-        "own": {
+        "self": {
           "$ref": "#/$defs/subjectRoles"
         },
         "other": {

package/schema/evaluation.schema.json

@@ -108,8 +108,8 @@
         "category": {
           "type": "string",
           "enum": [
-            "care",
-            "meta"
+            "category:care",
+            "category:meta"
           ]
         }
       }

package/schema/facts.schema.json

@@ -578,12 +578,12 @@
               "type": "object",
               "additionalProperties": false,
               "required": [
-                "own",
+                "self",
                 "other",
                 "pair"
               ],
               "properties": {
-                "own": {
+                "self": {
                   "type": "string"
                 },
                 "other": {
@@ -716,12 +716,12 @@
               "type": "object",
               "additionalProperties": false,
               "required": [
-                "own",
+                "self",
                 "other",
                 "pair"
               ],
               "properties": {
-                "own": {
+                "self": {
                   "type": "object",
                   "additionalProperties": false,
                   "properties": {

package/schema/i18n-catalog.schema.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://github.com/mark-brannan/colregs/schema/i18n-catalog.schema.json",
   "title": "data/i18n/*.json",
-  "description": "Display catalog for one BCP 47 language: UI strings for identifier vocabularies (light names, fact-axis labels, modality labels, image captions), not legal text -- see docs/adr/0003-language-as-a-dimension.md 'Display catalogs'.",
+  "description": "Display catalog for one BCP 47 language: UI strings for the closed vocabularies the package emits (lights, modalities, roles, encounters, jurisdictions, closed-list fact values), not legal text -- see docs/adr/0003-language-as-a-dimension.md 'Display catalogs' and REQ-LANG-6.",
   "type": "object",
   "additionalProperties": false,
   "required": ["language", "provenance", "strings"],
@@ -25,17 +25,38 @@
     },
     "strings": {
       "type": "object",
-      "description": "One section per vocabulary. Identifier vocabularies (light) are keyed by the identifier itself, as documented in docs/identifiers.md; closed vocabularies (modality) by their bare value, as stored in data/applicability.json. Values are static strings: no interpolation, no plurals -- the consumer's i18n system owns composition.",
+      "description": "One section per vocabulary (REQ-LANG-6, REQ-LANG-9's ruling docs/adr/0017). Every section is keyed by the identifier itself, as documented in docs/identifiers.md -- light, modality, role and encounter identifiers carry a type prefix; jurisdiction and closed-list fact values are keyed by their own bare or fact-prefixed form. Values are static strings: no interpolation, no plurals -- the consumer's i18n system owns composition.",
       "additionalProperties": false,
       "properties": {
-        "light": {
+        "lights": {
           "type": "object",
           "propertyNames": { "pattern": "^light:[a-z_]+$" },
           "additionalProperties": { "$ref": "#/$defs/label" }
         },
-        "modality": {
+        "modalities": {
           "type": "object",
-          "propertyNames": { "pattern": "^[a-z]+(-[a-z]+)*$" },
+          "propertyNames": { "pattern": "^modality:[a-z]+(-[a-z]+)*$" },
+          "additionalProperties": { "$ref": "#/$defs/label" }
+        },
+        "roles": {
+          "type": "object",
+          "propertyNames": { "pattern": "^role:[a-z]+(-[a-z]+)*$" },
+          "additionalProperties": { "$ref": "#/$defs/label" }
+        },
+        "encounters": {
+          "type": "object",
+          "propertyNames": { "pattern": "^encounter:[a-z]+(-[a-z]+)*$" },
+          "additionalProperties": { "$ref": "#/$defs/label" }
+        },
+        "jurisdictions": {
+          "type": "object",
+          "propertyNames": { "pattern": "^[a-z]+(/[a-z]+)*$" },
+          "additionalProperties": { "$ref": "#/$defs/label" }
+        },
+        "facts": {
+          "type": "object",
+          "description": "Closed-list fact-value labels only (Tier A): propulsion, activity, position, rule18_class, dynamics, obstruction_side, wind_side. Field names (fact:length_m, geo:tcpa_s, ...) have no closed list behind them and are never catalogued here -- form-label text and unit/number formatting are the consumer's.",
+          "propertyNames": { "pattern": "^[a-z][a-z0-9_]*:[a-z][a-z0-9_]*$" },
           "additionalProperties": { "$ref": "#/$defs/label" }
         }
       }

package/schema/lights.schema.json

@@ -53,10 +53,9 @@
         "^light:[a-z_]+$": {
           "type": "object",
           "additionalProperties": false,
-          "required": ["name", "colregs_term", "cite", "character", "rule21"],
+          "required": ["term", "cite", "character", "rule21"],
           "properties": {
-            "name": { "type": "string", "minLength": 1 },
-            "colregs_term": { "type": "string", "minLength": 1 },
+            "term": { "type": "string", "minLength": 1 },
             "cite": { "type": "string", "minLength": 1 },
             "color": { "type": ["string", "null"] },
             "color_note": { "type": "string" },

package/schema/situation-fixtures.schema.json

@@ -40,6 +40,22 @@
           }
         }
       ]
+    },
+    "subjectRole": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "role",
+        "by"
+      ],
+      "properties": {
+        "role": {
+          "$ref": "applicability.schema.json#/$defs/effectRole"
+        },
+        "by": {
+          "$ref": "#/$defs/ruleId"
+        }
+      }
     }
   },
   "properties": {
@@ -175,6 +191,29 @@
           "situation": {
             "$comment": "A Situation (schema/situation.schema.json, ADR 0014).",
             "$ref": "situation.schema.json"
+          },
+          "roles": {
+            "$comment": "The pooled, resolved roles of both subjects (ADR 0016). `expect` stays the self-frame entry ids.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "self",
+              "other"
+            ],
+            "properties": {
+              "self": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/$defs/subjectRole"
+                }
+              },
+              "other": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/$defs/subjectRole"
+                }
+              }
+            }
           }
         }
       }

package/schema/situation.schema.json

@@ -3,12 +3,12 @@
   "$id": "https://github.com/mark-brannan/colregs/schema/situation.schema.json",
   "title": "Situation",
   "description": "Two vessels and the encounter at one instant: the input evaluateEncounter reads, nested by subject and class (ADR 0005 §2, ADR 0011 §3, ADR 0014). Structure only -- every kin:/geo:/hist:/env: key must be declared in data/facts.json §situation, checked in the tests.",
-  "$comment": "The same shape as a case's `situation` in schema/situation-fixtures.schema.json, stated once here so an operation can name it; `own` required, `other` optional (Rule 19's single-vessel scope), every class and key optional -- absent is absent.",
+  "$comment": "The same shape as a case's `situation` in schema/situation-fixtures.schema.json, stated once here so an operation can name it; `self` required, `other` optional (Rule 19's single-vessel scope), every class and key optional -- absent is absent.",
   "type": "object",
   "additionalProperties": false,
-  "required": ["own"],
+  "required": ["self"],
   "properties": {
-    "own": { "$ref": "#/$defs/subject" },
+    "self": { "$ref": "#/$defs/subject" },
     "other": { "$ref": "#/$defs/subject" },
     "pair": {
       "type": "object",