colregs 0.1.0 → 0.2.0

package/README.md

@@ -1,24 +1,69 @@
 # colregs
 
-The international collision regulations, and the national amalgamations derived
-from them, as language-neutral JSON — with the provenance to check every line
-against its source and fixtures a second implementation can verify against.
+The COLREGS 72 navigation *light* rules as language-neutral JSON, plus the
+USCG's own diagrams and enough geometry to draw the lights yourself. Built as
+the base other countries' national amalgamations hang off of, not scoped to
+one country's rulebook.
 
 Data only. No runtime, no dependencies, no inference.
 
-> **Status: pre-release.** Nothing here is complete, and nothing here is fit for
-> navigation. See [`docs/requirements.md`](docs/requirements.md) for what it is
-> meant to become.
+> **Status: pre-release.** Not complete, and not fit for navigation. Navigate
+> by the published rules.
+
+```text
+data/rules.json          verbatim rule text, keyed by paragraph path and jurisdiction
+data/lights.json         the six Rule 21 lights: colour, arc, Rule 22 range
+data/facts.json          the fact record, and how to decode SignalK navigation.state
+data/applicability.json  predicate -> lights, each entry also carrying modality, citation, jurisdiction
+data/geometry.json       Annex I: heights, spacings, colour, intensity
+data/images.json         every image, its source, and what it illustrates
+data/deprecated-identifiers.json  retired identifiers: what they denoted, when, and their replacement
+images/                  38 USCG diagrams + 5 arc GIFs
+fixtures/                fact records and the entries that apply to them
+```
 
 ## Coverage
 
-| | |
-|---|---|
-| **Rules** | Part C, lights (Rules 20–31). Day shapes and Part D signals are not here. |
-| **Jurisdictions** | `intl` only. US Inland, Canada and the rest are modelled for but not present. |
-| **Conditions** | Night. |
+Part C lights (Rules 20-31) only, `intl` jurisdiction only, night only. Day
+shapes, Part D signals, and every other jurisdiction (US Inland, Canada,
+CEVNI) are on the roadmap in [`docs/requirements.md`](docs/requirements.md)
+but not present here.
+
+## The four layers
+
+**Rule text.** Keyed by *paragraph path*, like `27(a)(i)` or `25(d)(ii)`,
+because the paragraph is the unit you actually cite. The text is verbatim
+International text; Inland-only inserts were stripped rather than paraphrased.
+
+**Light definitions.** This layer is Rule 21. Each light carries its colour,
+its arc as a bearing range, and its minimum visible range by length band from
+Rule 22. Bearings run in degrees clockwise from right ahead, and an arc whose
+`from_deg` exceeds its `to_deg` wraps through the bow. So the masthead light
+is 247.5° to 112.5°, which is 225° of arc.
+
+**Facts.** Three orthogonal axes (`fact:propulsion`, `fact:activity`,
+`fact:position`), a `fact:making_way` modifier that refines
+`position:underway`, and scalars such as `fact:length_m` and
+`fact:tow_length_m`. There is deliberately no vessel-class field. Under COLREGS
+what a vessel *is* follows from what it is *doing*, so classification falls
+out of the axes on its own.
 
-Coverage is stated because silence must not imply it (REQ-SCOPE-6).
+SignalK's `navigation.state` flattens all of that into one enum. `facts.json`
+therefore carries a decode table, the enum values it can't decode, and the
+five places where the flattening loses information. Fishing at anchor and
+making-way are the two of those that matter in practice.
+
+**Applicability entries.** Each entry is a predicate over facts, a set of
+lights or references to other entries, a modality, a citation, and a
+jurisdiction. Every entry has an id (`25b`, `27a-mw`) that both consumers can
+point at.
+
+**Identifiers.** Two classes, with opposite requirements. Citation-derived ids
+— paragraph paths and the entry ids built from them — carry no prefix, because
+the path *is* the citation. Vocabulary ids do: `light:masthead`,
+`fact:activity`, `activity:nuc`, `rel:in_lieu_of`. See
+[`docs/identifiers.md`](docs/identifiers.md); coming from a 0.1.x release, see
+[Migrating from 0.1.x](#migrating-from-01x).
 
 ## Design
 
@@ -26,25 +71,284 @@ This repo is requirements-first. Coding sessions work against numbered
 requirements and cite them; decisions that shaped the design are recorded as
 ADRs rather than argued again.
 
-- [`docs/requirements.md`](docs/requirements.md) — the source of truth
-- [`docs/adr/`](docs/adr/) — decisions, with the reasoning that produced them
+- [`docs/requirements.md`](docs/requirements.md): the source of truth
+- [`docs/adr/`](docs/adr/): decisions, with the reasoning that produced them
 
 Three ideas carry most of the design:
 
 **The paragraph is the unit.** Rule text, citations and composition all key on
-the paragraph path — `27(a)(i)`, not "Rule 27". Citation unit and composition
+the paragraph path (`27(a)(i)`, not "Rule 27"). Citation unit and composition
 unit turn out to be the same thing.
 
-**Predicates, not enumerations.** Gates are `length_m < 7`, never a pre-built
+**Jurisdiction is a dimension, not a fork.** Every rule-text record and every
+applicability entry carries a `jurisdiction`: `intl` (the reserved base value)
+or `<country-or-body>/<waters>` (`us/inland`, `eu/cevni`). A jurisdiction is a
+delta on `intl`; entries it doesn't override are inherited, not restated
+(REQ-SCOPE-2/3). Geography that merely gates a rule inside one jurisdiction
+(Great Lakes, Western Rivers) is an ordinary fact a predicate reads, not a
+jurisdiction of its own (REQ-SCOPE-5).
+
+**Predicates, not enumerations.** Gates are `fact:length_m < 7`, never a pre-built
 list of configurations. Enumerated tables are where prior art silently loses
 rules; a predicate cannot omit a case it was never asked about.
 
-**Alternatives are first-class.** COLREGS routinely permits a choice — a
+**Alternatives are first-class.** COLREGS routinely permits a choice: a
 tricolor *in lieu of* separate sidelights, a torch *in lieu of* either. The data
 carries every lawful option with its modality and gate, and picks none of them.
 Selection belongs to the consumer.
 
-## Licence
+## Predicate semantics
+
+An entry applies when **every** constraint in its `when` is satisfied. An
+absent fact never satisfies a constraint. Numeric constraints are
+`{gte, gt, lte, lt}`; a list means membership; anything else is equality.
+`fact:activity: "activity:ram"` also matches `activity:ram_underwater`, which
+is a refinement of it.
+
+A `when` is a conjunction, and two constructs open it up. `{"not": C}` is a
+constraint satisfied when the fact does *not* satisfy `C`; `any_of` is
+disjunction, holding sub-predicates as a key of a `when` and constraints as the
+value of a fact. **`not` over an absent fact is unsatisfied**, like every other
+constraint over an absent fact — so `{"not": C}` and `C` are both false on a
+record that never mentions the fact, and the two are not complements there. That
+is deliberate: predicates stay conservative, and a duty is never laid on a vessel
+because a consumer left a field out. It also means `not` is a constraint on one
+fact and never a key of a `when` — a predicate-level negation would be satisfied
+by silence, which is the one thing the absent-fact rule is there to forbid. Where
+a paragraph really does mean "any vessel other than …", the negation goes on the
+fact the paragraph names, and the fact has to be present for the entry to apply.
+
+| form | where | means |
+|---|---|---|
+| `{"gte": n}` … `{"lt": n}` | a fact's constraint | numeric comparison |
+| `["a", "b"]` | a fact's constraint | membership |
+| `"a"` / `true` / `12` | a fact's constraint | equality |
+| `{"not": C}` | a fact's constraint | the fact is present and does not satisfy `C` |
+| `{"any_of": [C, …]}` | a fact's constraint | the fact satisfies at least one `C` |
+| `"any_of": [W, …]` | a key of a `when` | at least one sub-predicate `W` holds |
+
+The `ram`/`ram_underwater` refinement belongs to the *value*, not to one
+constraint form: it applies to equality, to list membership and to each
+`any_of` disjunct alike, and `{"not": C}` negates the refined reading rather
+than sneaking underneath it. It used to fire on a scalar constraint only, so a
+list quietly missed it; that is fixed, and a list and `{"any_of": […]}` are now
+interchangeable wherever both are legal.
+
+Some facts are **derived** rather than supplied. `facts.json`'s `derived`
+section holds them, each with a decode table that is its definition — an ordered
+list of predicate/value rows, first match wins — read the same way as the
+SignalK `navigation.state` table. `fact:rule18_class` is the one that exists: a
+vessel's rank under Rule 18, decoded from her propulsion, her activity and the
+27(c) and WIG booleans, because Rule 18 ranks vessels by the Rule 3 terms of art
+and `fact:activity` answers a different question — what she *shows*. A consumer
+never supplies a derived fact.
+
+Entries **compose**: several apply to one fact record, and Rule 28 or Rule 26
+add to Rule 23 rather than replacing it. Relations between them:
+
+| relation | meaning |
+|---|---|
+| `rel:includes` | import the referenced entry's **lights only**, never its predicate |
+| `rel:conditional_includes` | import lights when the stated `when` holds; `one_of` is a set of legal alternatives |
+| `rel:in_lieu_of` | this entry's lights replace the referenced entries' lights |
+| `rel:excludes` | must not be shown together (25(c) and the tricolor) |
+| `rel:exempts` | the referenced requirement does not apply (30(e)) |
+| `rel:overrides` | the superiority relation: this paragraph's requirement prevails over the referenced one's when both apply (Rule 18's "except where Rules 9, 10 and 13 otherwise require") |
+
+A condition on whether a paragraph applies to the vessel at all goes in the
+predicate; a condition on which of two applicable paragraphs prevails is a
+relation. Delete the other paragraph: if this one is still true of the vessel,
+it is a relation. Rule 28 at anchor is a predicate; Rule 18 displacing Rule 15's
+role is `rel:overrides` (REQ-MODEL-13, ADR 0005 §4).
+
+Where the rules permit a choice, the data keeps every lawful option instead of
+picking one. A 12 m sloop under sail has three legal displays: 25(a), the
+25(b) tricolor, or 25(a) plus the 25(c) red-over-green. Which one a given boat
+shows depends on what's installed, and that decision belongs to the consumer.
+
+Modality is `shall`, `may`, `shall-if-practicable`, `shall-not`,
+`shall-not-impede`, or `conditional` with a `modality_by` table when it turns
+on a fact (23(a)(ii) is `shall` at 50 m and above, `may` below).
+
+Most entries read one vessel and produce lights. A few read **two** — a
+situation, not a fact record — and produce an `effect` instead. Rules 4, 11
+and 19(a) say which section of Part B governs; Rules 18, 9, 10, 12 and 15 say
+which vessel gives way — Rule 18 reading `fact:rule18_class` rather than
+re-listing the activity axis, Rules 12 and 15 reading the propulsion their own
+words name and leaving the rank to Rule 18's `rel:overrides`; and Rules 7(d),
+13, 14 and 15 say what kind of encounter it is —
+`head-on`, `crossing` or `overtaking` — or that risk of collision exists.
+Those carry `category` and `subjects: 2`, and address each vessel
+through a subject segment: `own:fact:activity`, `other:fact:propulsion`,
+`pair:geo:in_sight`. A key with no subject means `own:`, so nothing above
+changes. `docs/identifiers.md` has the namespace and the effect vocabulary;
+`fixtures/situation-fixtures.json` is their contract.
+
+The three encounter types **partition** relative bearing. 13(b)'s overtaking
+sector is written once, as one constraint; Rule 15's crossing is `not` over
+that same constraint and `not` over Rule 14's head-on cone, so no crossing
+sector is enumerated anywhere and none can drift out of step. The suite sweeps
+both vessels' bearings in half-degree steps and asserts that exactly one
+encounter applies at every point, that 13(b)'s 22.5°-abaft-the-beam edge is
+exclusive on both sides, and that Rule 13(d)'s latch holds the classification
+at `overtaking` however far the bearing afterwards draws out. The numbers the
+Rules do not state — what counts as an appreciable bearing change, how wide
+"nearly reciprocal" is — are declared once in `facts.json` under
+`situation.constants`, marked pencil, and read from there by every entry.
+
+A situation can state geometry no two vessels can occupy, so the suite checks
+every fixture that states its kinematics against them (REQ-VERIFY-8): the two
+relative bearings must be two readings of one line of sight, positions must
+reproduce range and bearing, and CPA, TCPA and bearing rate must be the ones
+the headings and speeds give. The equations and tolerances are declared once in
+`facts.json` under `situation.geometry.consistency`. The sweeps construct
+situations that pass the same check, and the property that no two vessels are
+both give-way is asserted over a sweep of steady-bearing geometries — where it
+is a theorem — with the both-starboard geometry that breaks it pinned as one
+the check rejects.
+
+## What this package does not do
+
+It does not infer anything. It is a pure function of the fact record. Deciding
+*that* a vessel is making way, or fishing, or aground is somebody else's job.
+Nothing here reads a sensor.
+
+It does not select a single display. Where the rules offer alternatives, all of
+them come back.
+
+## Verifying
+
+```bash
+npm test
+```
+
+Every fixture reproduces exactly; every citation, cross-reference, light and
+geometry reference resolves; every image is on disk with its SHA-256 recorded;
+every decoded `navigation.state` value and every fact a predicate reads is
+declared.
+
+A **drift test** (REQ-VERIFY-2) cross-checks two directions: forward, fact
+record to lights, and reverse, lights already shown to which other entries
+could explain them. It fails on any collision the data doesn't already
+declare through `rel:includes`/`rel:in_lieu_of`/`rel:excludes`/
+`rel:exempts`/`rel:conditional_includes`.
+
+Every numeric gate that affects *which entries apply* has fixtures immediately
+either side of its threshold (REQ-VERIFY-5), and every entry is exercised by
+at least one fixture and absent from at least one other (REQ-VERIFY-3). Three
+gates that affect only *modality*, not which entries apply, are flagged as an
+open question rather than fixtured against a schema that can't express the
+distinction; see [Q-5](docs/requirements.md#9-open-questions).
+
+`fixtures/applicability-fixtures.json` is the cross-implementation contract: an
+implementation in any language should reproduce those entry sets exactly.
+
+## Migrating from 0.1.x
+
+0.2.0 is the first release whose vocabulary identifiers carry a type prefix.
+`colregs@0.1.1`, the last version on npm, has the bare names; every 0.1.x
+consumer holds strings that no longer resolve. Renaming an identifier is a
+breaking change under REQ-PKG-4, and the rename is the one exception
+REQ-MODEL-10 records: 0.1.1 predates the identifier audit, sits outside the
+immutability baseline, and nothing after it may be renamed this way again.
+
+**What did not change.** Paragraph paths (`27(a)(i)`) and entry ids (`25b`,
+`27a-mw`) are citation-derived and stay bare. No entry id present in 0.1.1
+is removed — the 40 entries of 0.1.1 are all in 0.2.0, with 30 more.
+
+**What did.** Every light id, fact key, fact value and relation verb, in
+every place it appears: `lights.json` keys, `facts.json` keys and `values`,
+the `light` field of an entry's `lights[]`, the keys and values of an entry's
+`when` and `modality_by[].when`, the relation keys on an entry
+(`includes` → `rel:includes`, and so on), the `relations` map in
+`applicability.json`, the `light` field in `geometry.json`, the
+`signalk_navigation_state.decode` table, `actuable_subset.fields`, and the
+`facts` record of every fixture. The rule is in
+[`docs/identifiers.md`](docs/identifiers.md): a light is `light:<id>`, a
+fact key is `fact:<key>`, a value of an enumerated fact is `<fact>:<value>`,
+a relation is `rel:<name>`. The full table, generated from the two data
+sets rather than from memory:
+
+| kind | 0.1.1 | 0.2.0 |
+|---|---|---|
+| light id | `masthead` | `light:masthead` |
+| light id | `sidelights` | `light:sidelights` |
+| light id | `sidelight_starboard` | `light:sidelight_starboard` |
+| light id | `sidelight_port` | `light:sidelight_port` |
+| light id | `sternlight` | `light:sternlight` |
+| light id | `towing` | `light:towing` |
+| light id | `all_round` | `light:all_round` |
+| light id | `flashing` | `light:flashing` |
+| light id | `torch` | `light:torch` |
+| light id | `deck_lights` | `light:deck_lights` |
+| fact key | `propulsion` | `fact:propulsion` |
+| value of propulsion | `power` | `propulsion:power` |
+| value of propulsion | `sail` | `propulsion:sail` |
+| value of propulsion | `oars` | `propulsion:oars` |
+| fact key | `activity` | `fact:activity` |
+| value of activity | `none` | `activity:none` |
+| value of activity | `fishing` | `activity:fishing` |
+| value of activity | `trawling` | `activity:trawling` |
+| value of activity | `towing` | `activity:towing` |
+| value of activity | `pushing` | `activity:pushing` |
+| value of activity | `being_towed` | `activity:being_towed` |
+| value of activity | `nuc` | `activity:nuc` |
+| value of activity | `ram` | `activity:ram` |
+| value of activity | `ram_underwater` | `activity:ram_underwater` |
+| value of activity | `cbd` | `activity:cbd` |
+| value of activity | `mine` | `activity:mine` |
+| value of activity | `pilot` | `activity:pilot` |
+| value of activity | `diving` | `activity:diving` |
+| fact key | `position` | `fact:position` |
+| value of position | `underway` | `position:underway` |
+| value of position | `anchored` | `position:anchored` |
+| value of position | `aground` | `position:aground` |
+| value of position | `moored` | `position:moored` |
+| fact key | `making_way` | `fact:making_way` |
+| fact key | `length_m` | `fact:length_m` |
+| fact key | `tow_length_m` | `fact:tow_length_m` |
+| fact key | `max_speed_kn` | `fact:max_speed_kn` |
+| fact key | `gear_extent_m` | `fact:gear_extent_m` |
+| fact key | `beam_m` | `fact:beam_m` |
+| fact key | `composite_unit` | `fact:composite_unit` |
+| fact key | `non_displacement` | `fact:non_displacement` |
+| fact key | `wig` | `fact:wig` |
+| fact key | `wig_near_surface` | `fact:wig_near_surface` |
+| fact key | `near_channel` | `fact:near_channel` |
+| fact key | `inconspicuous_partly_submerged_tow` | `fact:inconspicuous_partly_submerged_tow` |
+| fact key | `towed_alongside` | `fact:towed_alongside` |
+| fact key | `obstruction_exists` | `fact:obstruction_exists` |
+| fact key | `obstruction_side` | `fact:obstruction_side` |
+| value of obstruction_side | `port` | `obstruction_side:port` |
+| value of obstruction_side | `starboard` | `obstruction_side:starboard` |
+| relation | `includes` | `rel:includes` |
+| relation | `conditional_includes` | `rel:conditional_includes` |
+| relation | `in_lieu_of` | `rel:in_lieu_of` |
+| relation | `excludes` | `rel:excludes` |
+| relation | `exempts` | `rel:exempts` |
+
+The mapping is mechanical and total: strip nothing, prepend the namespace.
+The one string that needed the prefix to disambiguate is `towing`, which in
+0.1.1 was both a light id and an `activity` value; it is now `light:towing`
+or `activity:towing` depending on which it was.
+
+A consumer that builds a fact record from SignalK `navigation.state` gets
+the new keys and values from the decode table for free. One that stored a
+0.1.1 fact record, light id or relation name must rewrite it by the table
+above; `fixtures/applicability-fixtures.json` is the check that the rewrite
+came out right.
+
+From 0.2.0 on, every identifier in the package is immutable once published
+(REQ-MODEL-10). [`data/deprecated-identifiers.json`](data/deprecated-identifiers.json)
+is the REQ-MODEL-11 registry a retired identifier goes into, and `npm test`
+refuses a removal that is not recorded there.
+
+## Provenance and licence
+
+Rule text, the `NRHB_*` diagrams and the five `*arc.gif` files are USCG
+publications, public domain; see [PROVENANCE.md](PROVENANCE.md). The
+compilation is Apache-2.0.
 
-Code and fixtures: see `LICENSE`. Rule text and diagrams carry their own terms,
-recorded per asset — see `PROVENANCE.md` once data lands.
+Not authoritative, not endorsed by the Coast Guard. Navigate by the published
+rules. When the `ca/inland` delta lands, it will carry the same condition
+its licence does: it must not be represented as an official version.