colregs 0.1.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/LICENSE +194 -26
  2. package/PROVENANCE.md +45 -12
  3. package/README.md +222 -23
  4. package/data/applicability.json +1252 -190
  5. package/data/deprecated-identifiers.json +7 -0
  6. package/data/facts.json +556 -113
  7. package/data/geometry.json +33 -33
  8. package/data/images.json +51 -25
  9. package/data/lights.json +35 -35
  10. package/data/rules.json +787 -3
  11. package/docs/adr/0001-name-and-jurisdiction-model.md +119 -1
  12. package/docs/adr/0003-language-as-a-dimension.md +220 -0
  13. package/docs/adr/0004-licence-layering.md +78 -0
  14. package/docs/adr/0005-rule-categories-and-the-situation-record.md +323 -0
  15. package/docs/adr/0006-json-schema-and-identifier-diff.md +95 -0
  16. package/docs/adr/0007-rule26-overrides-and-aground.md +68 -0
  17. package/docs/adr/0008-mooring-buoy-modifier.md +87 -0
  18. package/docs/budgets.json +162 -0
  19. package/docs/conventions.md +27 -0
  20. package/docs/gates.json +84 -0
  21. package/docs/identifiers.md +435 -0
  22. package/docs/part-b-invariants.md +922 -0
  23. package/docs/requirements.md +1251 -23
  24. package/docs/verification/2026-08-30-q6-q8.md +278 -0
  25. package/docs/verification/2026-09-05-rule27f-rule28-anchor-scenarios.md +330 -0
  26. package/fixtures/applicability-fixtures.json +361 -227
  27. package/fixtures/situation-fixtures.json +3673 -0
  28. package/package.json +16 -4
  29. package/schema/applicability-fixtures.schema.json +49 -0
  30. package/schema/applicability.schema.json +401 -0
  31. package/schema/deprecated-identifiers.schema.json +29 -0
  32. package/schema/facts.schema.json +793 -0
  33. package/schema/geometry.schema.json +239 -0
  34. package/schema/images.schema.json +53 -0
  35. package/schema/lights.schema.json +131 -0
  36. package/schema/rules.schema.json +50 -0
  37. package/schema/situation-fixtures.schema.json +325 -0
package/LICENSE CHANGED
@@ -1,34 +1,202 @@
1
- MIT License
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
2
4
 
3
- Copyright (c) 2026 Mark Brannan
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
4
6
 
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
7
+ 1. Definitions.
11
8
 
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
14
11
 
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING OUT OF
20
- OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
22
14
 
23
- ---
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
22
 
25
- The MIT licence above covers this compilation: the JSON structure, the
26
- predicates, the fixtures and the tests.
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
27
25
 
28
- The rule text in `data/rules.json` and the diagrams in `images/NRHB_*.png` are
29
- works of the United States Government and are not subject to copyright in the
30
- United States (17 U.S.C. 105). The `*arc.gif` files have unverified
31
- provenance — see PROVENANCE.md.
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Mark Brannan
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
32
202
 
33
- This package is not authoritative and is not endorsed by the US Coast Guard.
34
- Navigate by the published rules.
package/PROVENANCE.md CHANGED
@@ -7,8 +7,10 @@ publications. Nothing here is authoritative: consult the published rules.
7
7
 
8
8
  - **Source:** USCG Navigation Center, *Navigation Rules, International —
9
9
  Inland* (amalgamated), <https://www.navcen.uscg.gov/navigation-rules-amalgamated>
10
- - **Retrieved:** 2026-08-29
11
- - **Scope:** the **International** text only. The amalgamated page marks
10
+ - **Retrieved:** 2026-09-04 (re-fetched to add Rules 1-19; originally 2026-08-29
11
+ for Part C)
12
+ - **Scope:** the **International** text only, now covering Parts A and B
13
+ (Rules 1-19) and Part C (Rules 20-31). The amalgamated page marks
12
14
  inland-only inserts and international-only variants inline; inland text was
13
15
  removed and international variants kept. Nothing was paraphrased.
14
16
  - **Rights:** a work of the US Government, not subject to copyright in the
@@ -17,6 +19,28 @@ publications. Nothing here is authoritative: consult the published rules.
17
19
  reconstruct it from memory, `rules.json` records it under `gaps` and the
18
20
  paragraph is omitted. 24(g) covers inconspicuous, partly submerged tows and
19
21
  is outside the applicability table in this release.
22
+ - **Known quirks kept verbatim:** the source's own text of Rule 1(c) repeats
23
+ "special rules ... special rules made" and Rule 13(b) reads "coming up with
24
+ a another vessel" (sic), and Rule 10(c) reads "A vessel, shall so far as
25
+ practicable, avoid crossing traffic lanes" — comma placement that doesn't
26
+ match the official COLREGS text. All three are transcribed exactly as the
27
+ source HTML has them rather than silently corrected; confirmed by
28
+ re-fetching and grepping the raw source HTML directly (not the rendered
29
+ page) on 2026-09-05. Rule 3(l)'s quoted term ("restricted visibility") is
30
+ also curly in the source and transcribed as such — that part of this note
31
+ previously and incorrectly claimed it was the only curly-quoted term in the
32
+ corpus; Rule 3(m)'s quoted term (“Wing-In-Ground (WIG)”, with `craft`
33
+ outside the quotes) is the other, corrected to match the source on
34
+ 2026-09-05 after having been transcribed with straight quotes and `craft`
35
+ inside the term.
36
+ - **Inland-only inserts deliberately absent:** the source marks Inland
37
+ text with `‹‹ ››`. Rule 21(a) and 21(b)'s "vessel of less than 12 meters
38
+ … as nearly as practicable to the fore and aft centerline" clauses and
39
+ Rule 23(b)'s "where it can best be seen" are such inserts and are not in
40
+ `rules.json`; Rule 29(b)'s "similar" is in the International text and is
41
+ kept. Verified 2026-09-05 against the raw source HTML, 33 CFR 83 (eCFR)
42
+ and the 1972 treaty text (UNTS Vol. 1050) — see
43
+ `docs/verification/2026-08-30-q6-q8.md`, Claim 1 correction.
20
44
 
21
45
  ## Diagrams — `images/NRHB_*.png`
22
46
 
@@ -43,18 +67,27 @@ diagrams the USCG now serves as `NRHB_25_b.png` and `NRHB_27_ei.png` — an
43
67
  older filename for the same images, not a different source. This package uses
44
68
  the current USCG names throughout.
45
69
 
46
- ## Arc diagrams — `images/*arc.gif` — **unresolved**
70
+ ## Arc diagrams — `images/*arc.gif`
47
71
 
48
- `mastheadarc.gif`, `portarc.gif`, `stbdarc.gif`, `sternarc.gif` and
49
- `towingarc.gif` were carried over from `signalk-auto-nav-lights`. They are
50
- believed to be USCG illustrations, but the page that served them no longer
51
- exists and no archived original has been located, so their provenance and
52
- rights are **unverified**. `data/images.json` marks them
53
- `"provenance_status": "unresolved"`.
72
+ - **Source:** USCG Navigation Center, *Navigation Rules Arcs of Visibility*,
73
+ <https://www.navcen.uscg.gov/navigation-rules-arcs-of-visibility>, which
74
+ serves the five files at
75
+ `https://www.navcen.uscg.gov/sites/default/files/images/nr_pics/Arcs/<name>`
76
+ as the rollover states of its Rule 21/22 diagram.
77
+ - **Retrieved:** 2026-09-05 — fetched from the live USCG server and compared
78
+ byte-for-byte (`cmp` and SHA-256) against the copies carried over from
79
+ `signalk-auto-nav-lights`: identical, all five.
80
+ - **Rights:** US Government work, public domain (17 U.S.C. 105).
81
+ - Captions are the page's own image-map `alt` text; each file is mapped to
82
+ the Rule 21 definition it illustrates (`21(a)` masthead, `21(b)`
83
+ sidelights, `21(c)` sternlight, `21(d)` towing light, plus `24(a)(iv)`
84
+ for the towing light's placement).
54
85
 
55
- They are decorative here: the arcs themselves are data, in `data/lights.json`
56
- under each light's `arc`. If provenance cannot be established, delete the GIFs;
57
- nothing in the package depends on them.
86
+ The same filenames existed on the pre-Drupal site under
87
+ `navcen.uscg.gov/mwv/navrules/` (Wayback has `mastheadarc.gif` from
88
+ 2004-10-15), which is why an earlier release could not locate the page and
89
+ recorded them as unresolved. They remain decorative: the arcs themselves are
90
+ data, in `data/lights.json` under each light's `arc`.
58
91
 
59
92
  ## SignalK paths
60
93
 
package/README.md CHANGED
@@ -17,16 +17,23 @@ data/facts.json the fact record, and how to decode SignalK navigation.s
17
17
  data/applicability.json predicate -> lights, each entry also carrying modality, citation, jurisdiction
18
18
  data/geometry.json Annex I: heights, spacings, colour, intensity
19
19
  data/images.json every image, its source, and what it illustrates
20
+ data/deprecated-identifiers.json retired identifiers: what they denoted, when, and their replacement
20
21
  images/ 38 USCG diagrams + 5 arc GIFs
21
22
  fixtures/ fact records and the entries that apply to them
22
23
  ```
23
24
 
24
25
  ## Coverage
25
26
 
26
- Part C lights (Rules 20-31) only, `intl` jurisdiction only, night only. Day
27
- shapes, Part D signals, and every other jurisdiction (US Inland, Canada,
28
- CEVNI) are on the roadmap in [`docs/requirements.md`](docs/requirements.md)
29
- but not present here.
27
+ Part C lights (Rules 20-31), `intl` jurisdiction, night only. Day shapes,
28
+ Part D signals, and every other jurisdiction (US Inland, Canada, CEVNI) are
29
+ on the roadmap in [`docs/requirements.md`](docs/requirements.md) but not
30
+ present here.
31
+
32
+ One exception, not a claim to model the Inland Rules: `us/inland` carries
33
+ two entries, `30a-buoy` and `30b-buoy`, for a vessel made fast to a mooring
34
+ buoy — 33 CFR 90.5 deems her at anchor and the Convention does not, so the
35
+ case cannot be stated under `intl` at all
36
+ ([ADR 0008](docs/adr/0008-mooring-buoy-modifier.md)).
30
37
 
31
38
  ## The four layers
32
39
 
@@ -40,9 +47,10 @@ Rule 22. Bearings run in degrees clockwise from right ahead, and an arc whose
40
47
  `from_deg` exceeds its `to_deg` wraps through the bow. So the masthead light
41
48
  is 247.5° to 112.5°, which is 225° of arc.
42
49
 
43
- **Facts.** Three orthogonal axes (`propulsion`, `activity`, `position`), a
44
- `making_way` modifier that refines `underway`, and scalars such as `length_m`
45
- and `tow_length_m`. There is deliberately no vessel-class field. Under COLREGS
50
+ **Facts.** Three orthogonal axes (`fact:propulsion`, `fact:activity`,
51
+ `fact:position`), a `fact:making_way` modifier that refines
52
+ `position:underway`, and scalars such as `fact:length_m` and
53
+ `fact:tow_length_m`. There is deliberately no vessel-class field. Under COLREGS
46
54
  what a vessel *is* follows from what it is *doing*, so classification falls
47
55
  out of the axes on its own.
48
56
 
@@ -56,6 +64,13 @@ lights or references to other entries, a modality, a citation, and a
56
64
  jurisdiction. Every entry has an id (`25b`, `27a-mw`) that both consumers can
57
65
  point at.
58
66
 
67
+ **Identifiers.** Two classes, with opposite requirements. Citation-derived ids
68
+ — paragraph paths and the entry ids built from them — carry no prefix, because
69
+ the path *is* the citation. Vocabulary ids do: `light:masthead`,
70
+ `fact:activity`, `activity:nuc`, `rel:in_lieu_of`. See
71
+ [`docs/identifiers.md`](docs/identifiers.md); coming from a 0.1.x release, see
72
+ [Migrating from 0.1.x](#migrating-from-01x).
73
+
59
74
  ## Design
60
75
 
61
76
  This repo is requirements-first. Coding sessions work against numbered
@@ -79,7 +94,7 @@ delta on `intl`; entries it doesn't override are inherited, not restated
79
94
  (Great Lakes, Western Rivers) is an ordinary fact a predicate reads, not a
80
95
  jurisdiction of its own (REQ-SCOPE-5).
81
96
 
82
- **Predicates, not enumerations.** Gates are `length_m < 7`, never a pre-built
97
+ **Predicates, not enumerations.** Gates are `fact:length_m < 7`, never a pre-built
83
98
  list of configurations. Enumerated tables are where prior art silently loses
84
99
  rules; a predicate cannot omit a case it was never asked about.
85
100
 
@@ -93,27 +108,110 @@ Selection belongs to the consumer.
93
108
  An entry applies when **every** constraint in its `when` is satisfied. An
94
109
  absent fact never satisfies a constraint. Numeric constraints are
95
110
  `{gte, gt, lte, lt}`; a list means membership; anything else is equality.
96
- `activity: "ram"` also matches `ram_underwater`, which is a refinement of it.
111
+ `fact:activity: "activity:ram"` also matches `activity:ram_underwater`, which
112
+ is a refinement of it.
113
+
114
+ A `when` is a conjunction, and two constructs open it up. `{"not": C}` is a
115
+ constraint satisfied when the fact does *not* satisfy `C`; `any_of` is
116
+ disjunction, holding sub-predicates as a key of a `when` and constraints as the
117
+ value of a fact. **`not` over an absent fact is unsatisfied**, like every other
118
+ constraint over an absent fact — so `{"not": C}` and `C` are both false on a
119
+ record that never mentions the fact, and the two are not complements there. That
120
+ is deliberate: predicates stay conservative, and a duty is never laid on a vessel
121
+ because a consumer left a field out. It also means `not` is a constraint on one
122
+ fact and never a key of a `when` — a predicate-level negation would be satisfied
123
+ by silence, which is the one thing the absent-fact rule is there to forbid. Where
124
+ a paragraph really does mean "any vessel other than …", the negation goes on the
125
+ fact the paragraph names, and the fact has to be present for the entry to apply.
126
+
127
+ | form | where | means |
128
+ |---|---|---|
129
+ | `{"gte": n}` … `{"lt": n}` | a fact's constraint | numeric comparison |
130
+ | `["a", "b"]` | a fact's constraint | membership |
131
+ | `"a"` / `true` / `12` | a fact's constraint | equality |
132
+ | `{"not": C}` | a fact's constraint | the fact is present and does not satisfy `C` |
133
+ | `{"any_of": [C, …]}` | a fact's constraint | the fact satisfies at least one `C` |
134
+ | `"any_of": [W, …]` | a key of a `when` | at least one sub-predicate `W` holds |
135
+
136
+ The `ram`/`ram_underwater` refinement belongs to the *value*, not to one
137
+ constraint form: it applies to equality, to list membership and to each
138
+ `any_of` disjunct alike, and `{"not": C}` negates the refined reading rather
139
+ than sneaking underneath it. It used to fire on a scalar constraint only, so a
140
+ list quietly missed it; that is fixed, and a list and `{"any_of": […]}` are now
141
+ interchangeable wherever both are legal.
142
+
143
+ Some facts are **derived** rather than supplied. `facts.json`'s `derived`
144
+ section holds them, each with a decode table that is its definition — an ordered
145
+ list of predicate/value rows, first match wins — read the same way as the
146
+ SignalK `navigation.state` table. `fact:rule18_class` is the one that exists: a
147
+ vessel's rank under Rule 18, decoded from her propulsion, her activity and the
148
+ 27(c) and WIG booleans, because Rule 18 ranks vessels by the Rule 3 terms of art
149
+ and `fact:activity` answers a different question — what she *shows*. A consumer
150
+ never supplies a derived fact.
97
151
 
98
152
  Entries **compose**: several apply to one fact record, and Rule 28 or Rule 26
99
153
  add to Rule 23 rather than replacing it. Relations between them:
100
154
 
101
155
  | relation | meaning |
102
156
  |---|---|
103
- | `includes` | import the referenced entry's **lights only**, never its predicate |
104
- | `conditional_includes` | import lights when the stated `when` holds; `one_of` is a set of legal alternatives |
105
- | `in_lieu_of` | this entry's lights replace the referenced entries' lights |
106
- | `excludes` | must not be shown together (25(c) and the tricolor) |
107
- | `exempts` | the referenced requirement does not apply (30(e)) |
157
+ | `rel:includes` | import the referenced entry's **lights only**, never its predicate |
158
+ | `rel:conditional_includes` | import lights when the stated `when` holds; `one_of` is a set of legal alternatives |
159
+ | `rel:in_lieu_of` | this entry's lights replace the referenced entries' lights |
160
+ | `rel:excludes` | must not be shown together: a pick-one between alternatives (25(c) and the tricolor), never one obligation vetoing another |
161
+ | `rel:exempts` | the referenced requirement does not apply (30(e)) |
162
+ | `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"); for lights, Rule 26(a)'s "only the lights prescribed in this Rule" displacing Rule 30's anchor lights |
163
+
164
+ A condition on whether a paragraph applies to the vessel at all goes in the
165
+ predicate; a condition on which of two applicable paragraphs prevails is a
166
+ relation. Delete the other paragraph: if this one is still true of the vessel,
167
+ it is a relation. Rule 28 at anchor is a predicate; Rule 18 displacing Rule 15's
168
+ role is `rel:overrides` (REQ-MODEL-13, ADR 0005 §4).
108
169
 
109
170
  Where the rules permit a choice, the data keeps every lawful option instead of
110
171
  picking one. A 12 m sloop under sail has three legal displays: 25(a), the
111
172
  25(b) tricolor, or 25(a) plus the 25(c) red-over-green. Which one a given boat
112
173
  shows depends on what's installed, and that decision belongs to the consumer.
113
174
 
114
- Modality is `shall`, `may`, `shall-if-practicable`, or `conditional` with a
115
- `modality_by` table when it turns on a fact (23(a)(ii) is `shall` at 50 m and
116
- above, `may` below).
175
+ Modality is `shall`, `may`, `shall-if-practicable`, `shall-not`,
176
+ `shall-not-impede`, or `conditional` with a `modality_by` table when it turns
177
+ on a fact (23(a)(ii) is `shall` at 50 m and above, `may` below).
178
+
179
+ Most entries read one vessel and produce lights. A few read **two** — a
180
+ situation, not a fact record — and produce an `effect` instead. Rules 4, 11
181
+ and 19(a) say which section of Part B governs; Rules 18, 9, 10, 12 and 15 say
182
+ which vessel gives way — Rule 18 reading `fact:rule18_class` rather than
183
+ re-listing the activity axis, Rules 12 and 15 reading the propulsion their own
184
+ words name and leaving the rank to Rule 18's `rel:overrides`; and Rules 7(d),
185
+ 13, 14 and 15 say what kind of encounter it is —
186
+ `head-on`, `crossing` or `overtaking` — or that risk of collision exists.
187
+ Those carry `category` and `subjects: 2`, and address each vessel
188
+ through a subject segment: `own:fact:activity`, `other:fact:propulsion`,
189
+ `pair:geo:in_sight`. A key with no subject means `own:`, so nothing above
190
+ changes. `docs/identifiers.md` has the namespace and the effect vocabulary;
191
+ `fixtures/situation-fixtures.json` is their contract.
192
+
193
+ The three encounter types **partition** relative bearing. 13(b)'s overtaking
194
+ sector is written once, as one constraint; Rule 15's crossing is `not` over
195
+ that same constraint and `not` over Rule 14's head-on cone, so no crossing
196
+ sector is enumerated anywhere and none can drift out of step. The suite sweeps
197
+ both vessels' bearings in half-degree steps and asserts that exactly one
198
+ encounter applies at every point, that 13(b)'s 22.5°-abaft-the-beam edge is
199
+ exclusive on both sides, and that Rule 13(d)'s latch holds the classification
200
+ at `overtaking` however far the bearing afterwards draws out. The numbers the
201
+ Rules do not state — what counts as an appreciable bearing change, how wide
202
+ "nearly reciprocal" is — are declared once in `facts.json` under
203
+ `situation.constants`, marked pencil, and read from there by every entry.
204
+
205
+ A situation can state geometry no two vessels can occupy, so the suite checks
206
+ every fixture that states its kinematics against them (REQ-VERIFY-8): the two
207
+ relative bearings must be two readings of one line of sight, positions must
208
+ reproduce range and bearing, and CPA, TCPA and bearing rate must be the ones
209
+ the headings and speeds give. The equations and tolerances are declared once in
210
+ `facts.json` under `situation.geometry.consistency`. The sweeps construct
211
+ situations that pass the same check, and the property that no two vessels are
212
+ both give-way is asserted over a sweep of steady-bearing geometries — where it
213
+ is a theorem — with the both-starboard geometry that breaks it pinned as one
214
+ the check rejects.
117
215
 
118
216
  ## What this package does not do
119
217
 
@@ -138,8 +236,8 @@ declared.
138
236
  A **drift test** (REQ-VERIFY-2) cross-checks two directions: forward, fact
139
237
  record to lights, and reverse, lights already shown to which other entries
140
238
  could explain them. It fails on any collision the data doesn't already
141
- declare through `includes`/`in_lieu_of`/`excludes`/`exempts`/
142
- `conditional_includes`.
239
+ declare through `rel:includes`/`rel:in_lieu_of`/`rel:excludes`/
240
+ `rel:exempts`/`rel:conditional_includes`.
143
241
 
144
242
  Every numeric gate that affects *which entries apply* has fixtures immediately
145
243
  either side of its threshold (REQ-VERIFY-5), and every entry is exercised by
@@ -151,11 +249,112 @@ distinction; see [Q-5](docs/requirements.md#9-open-questions).
151
249
  `fixtures/applicability-fixtures.json` is the cross-implementation contract: an
152
250
  implementation in any language should reproduce those entry sets exactly.
153
251
 
252
+ ## Migrating from 0.1.x
253
+
254
+ 0.2.0 is the first release whose vocabulary identifiers carry a type prefix.
255
+ `colregs@0.1.1`, the last version on npm, has the bare names; every 0.1.x
256
+ consumer holds strings that no longer resolve. Renaming an identifier is a
257
+ breaking change under REQ-PKG-4, and the rename is the one exception
258
+ REQ-MODEL-10 records: 0.1.1 predates the identifier audit, sits outside the
259
+ immutability baseline, and nothing after it may be renamed this way again.
260
+
261
+ **What did not change.** Paragraph paths (`27(a)(i)`) and entry ids (`25b`,
262
+ `27a-mw`) are citation-derived and stay bare. No entry id present in 0.1.1
263
+ is removed — the 40 entries of 0.1.1 are all in 0.2.0, with 30 more.
264
+
265
+ **What did.** Every light id, fact key, fact value and relation verb, in
266
+ every place it appears: `lights.json` keys, `facts.json` keys and `values`,
267
+ the `light` field of an entry's `lights[]`, the keys and values of an entry's
268
+ `when` and `modality_by[].when`, the relation keys on an entry
269
+ (`includes` → `rel:includes`, and so on), the `relations` map in
270
+ `applicability.json`, the `light` field in `geometry.json`, the
271
+ `signalk_navigation_state.decode` table, `actuable_subset.fields`, and the
272
+ `facts` record of every fixture. The rule is in
273
+ [`docs/identifiers.md`](docs/identifiers.md): a light is `light:<id>`, a
274
+ fact key is `fact:<key>`, a value of an enumerated fact is `<fact>:<value>`,
275
+ a relation is `rel:<name>`. The full table, generated from the two data
276
+ sets rather than from memory:
277
+
278
+ | kind | 0.1.1 | 0.2.0 |
279
+ |---|---|---|
280
+ | light id | `masthead` | `light:masthead` |
281
+ | light id | `sidelights` | `light:sidelights` |
282
+ | light id | `sidelight_starboard` | `light:sidelight_starboard` |
283
+ | light id | `sidelight_port` | `light:sidelight_port` |
284
+ | light id | `sternlight` | `light:sternlight` |
285
+ | light id | `towing` | `light:towing` |
286
+ | light id | `all_round` | `light:all_round` |
287
+ | light id | `flashing` | `light:flashing` |
288
+ | light id | `torch` | `light:torch` |
289
+ | light id | `deck_lights` | `light:deck_lights` |
290
+ | fact key | `propulsion` | `fact:propulsion` |
291
+ | value of propulsion | `power` | `propulsion:power` |
292
+ | value of propulsion | `sail` | `propulsion:sail` |
293
+ | value of propulsion | `oars` | `propulsion:oars` |
294
+ | fact key | `activity` | `fact:activity` |
295
+ | value of activity | `none` | `activity:none` |
296
+ | value of activity | `fishing` | `activity:fishing` |
297
+ | value of activity | `trawling` | `activity:trawling` |
298
+ | value of activity | `towing` | `activity:towing` |
299
+ | value of activity | `pushing` | `activity:pushing` |
300
+ | value of activity | `being_towed` | `activity:being_towed` |
301
+ | value of activity | `nuc` | `activity:nuc` |
302
+ | value of activity | `ram` | `activity:ram` |
303
+ | value of activity | `ram_underwater` | `activity:ram_underwater` |
304
+ | value of activity | `cbd` | `activity:cbd` |
305
+ | value of activity | `mine` | `activity:mine` |
306
+ | value of activity | `pilot` | `activity:pilot` |
307
+ | value of activity | `diving` | `activity:diving` |
308
+ | fact key | `position` | `fact:position` |
309
+ | value of position | `underway` | `position:underway` |
310
+ | value of position | `anchored` | `position:anchored` |
311
+ | value of position | `aground` | `position:aground` |
312
+ | value of position | `moored` | `position:moored` |
313
+ | fact key | `making_way` | `fact:making_way` |
314
+ | fact key | `length_m` | `fact:length_m` |
315
+ | fact key | `tow_length_m` | `fact:tow_length_m` |
316
+ | fact key | `max_speed_kn` | `fact:max_speed_kn` |
317
+ | fact key | `gear_extent_m` | `fact:gear_extent_m` |
318
+ | fact key | `beam_m` | `fact:beam_m` |
319
+ | fact key | `composite_unit` | `fact:composite_unit` |
320
+ | fact key | `non_displacement` | `fact:non_displacement` |
321
+ | fact key | `wig` | `fact:wig` |
322
+ | fact key | `wig_near_surface` | `fact:wig_near_surface` |
323
+ | fact key | `near_channel` | `fact:near_channel` |
324
+ | fact key | `inconspicuous_partly_submerged_tow` | `fact:inconspicuous_partly_submerged_tow` |
325
+ | fact key | `towed_alongside` | `fact:towed_alongside` |
326
+ | fact key | `obstruction_exists` | `fact:obstruction_exists` |
327
+ | fact key | `obstruction_side` | `fact:obstruction_side` |
328
+ | value of obstruction_side | `port` | `obstruction_side:port` |
329
+ | value of obstruction_side | `starboard` | `obstruction_side:starboard` |
330
+ | relation | `includes` | `rel:includes` |
331
+ | relation | `conditional_includes` | `rel:conditional_includes` |
332
+ | relation | `in_lieu_of` | `rel:in_lieu_of` |
333
+ | relation | `excludes` | `rel:excludes` |
334
+ | relation | `exempts` | `rel:exempts` |
335
+
336
+ The mapping is mechanical and total: strip nothing, prepend the namespace.
337
+ The one string that needed the prefix to disambiguate is `towing`, which in
338
+ 0.1.1 was both a light id and an `activity` value; it is now `light:towing`
339
+ or `activity:towing` depending on which it was.
340
+
341
+ A consumer that builds a fact record from SignalK `navigation.state` gets
342
+ the new keys and values from the decode table for free. One that stored a
343
+ 0.1.1 fact record, light id or relation name must rewrite it by the table
344
+ above; `fixtures/applicability-fixtures.json` is the check that the rewrite
345
+ came out right.
346
+
347
+ From 0.2.0 on, every identifier in the package is immutable once published
348
+ (REQ-MODEL-10). [`data/deprecated-identifiers.json`](data/deprecated-identifiers.json)
349
+ is the REQ-MODEL-11 registry a retired identifier goes into, and `npm test`
350
+ refuses a removal that is not recorded there.
351
+
154
352
  ## Provenance and licence
155
353
 
156
- Rule text and `NRHB_*` diagrams are USCG publications, public domain. The five
157
- `*arc.gif` files came from an older repo and their provenance is unresolved;
158
- see [PROVENANCE.md](PROVENANCE.md). The compilation is MIT.
354
+ Rule text, the `NRHB_*` diagrams and the five `*arc.gif` files are USCG
355
+ publications, public domain; see [PROVENANCE.md](PROVENANCE.md). The
356
+ compilation is Apache-2.0.
159
357
 
160
358
  Not authoritative, not endorsed by the Coast Guard. Navigate by the published
161
- rules.
359
+ rules. When the `ca/inland` delta lands, it will carry the same condition
360
+ its licence does: it must not be represented as an official version.