@orbat-mapper/control-measures 0.2.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Orbat Mapper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,110 @@
+# @orbat-mapper/control-measures
+
+A TypeScript library for generating tactical control measures as GeoJSON, according to MIL-STD-2525 and APP-6 conventions.
+
+## Features
+
+- Framework-agnostic: outputs plain GeoJSON.
+- Type-safe: full TypeScript typings.
+- Map-friendly: works with Leaflet, MapLibre, OpenLayers, or any GeoJSON consumer.
+- Registry-driven: a single `renderControlMeasure(cm, options)` entry point, plus a metadata catalog for discovering every measure and its options.
+- Validation controls: optional `validationMode` per render.
+
+## Installation
+
+```bash
+# npm
+npm install @orbat-mapper/control-measures
+
+# pnpm
+pnpm add @orbat-mapper/control-measures
+```
+
+## Quick Start
+
+The library is registry-driven. Describe a control measure as a `ControlMeasure`
+object — its `kind`, `controlPoints`, and optional `options` — then render it:
+
+```ts
+import { renderControlMeasure, type ControlMeasure } from "@orbat-mapper/control-measures";
+
+const mainAttack: ControlMeasure<"main-attack"> = {
+  id: "alpha",
+  kind: "main-attack",
+  controlPoints: [
+    [10, 10], // tip
+    [5, 5], // spine
+    [0, 0], // neck
+    [2, 6], // width control
+  ],
+};
+
+const render = renderControlMeasure(mainAttack, { validationMode: "warn" });
+// render is a ControlMeasureRender: a GeoJSON FeatureCollection whose features
+// carry stable ids (`${cm.id}:${part}:${index}`) and resolved style hints.
+```
+
+`renderControlMeasure` returns a `ControlMeasureRender` — a GeoJSON
+`FeatureCollection` of `FeaturePartProps`-typed features.
+
+## Discovering measures and options
+
+Rather than importing per-measure generators, use the catalog to enumerate the
+available control measures and their parameters:
+
+```ts
+import {
+  CONTROL_MEASURE_IDS,
+  listControlMeasureMetadata,
+  getControlMeasureMetadata,
+  getDefaultOptions,
+} from "@orbat-mapper/control-measures";
+
+CONTROL_MEASURE_IDS; // readonly list of every control-measure id
+listControlMeasureMetadata(); // metadata (geometry, required points, params, symbology)
+getControlMeasureMetadata("block"); // metadata for one measure
+getDefaultOptions("block"); // default options object for one measure
+```
+
+Each measure also exports its options type and defaults constant, e.g.
+`BlockOptions` / `DEFAULT_BLOCK_OPTIONS`, `MainAttackOptions` /
+`DEFAULT_MAIN_ATTACK_OPTIONS`.
+
+## Validation behavior
+
+`renderControlMeasure` accepts a `RenderOptions` object whose `validationMode`
+controls how invalid coordinate input is handled:
+
+- `validationMode: "silent" | "warn" | "throw"`
+
+When omitted, validation follows each measure's built-in default. `"throw"` is
+useful for strict integrations and tests.
+
+## Supported control measures
+
+| `kind` | Measure |
+| --- | --- |
+| `ambush` | Ambush |
+| `search-area` | Search Area |
+| `main-attack` | Main Attack |
+| `supporting-attack` | Supporting Attack |
+| `airborne-attack` | Airborne Attack |
+| `attack-helicopter` | Attack Helicopter |
+| `support-by-fire` | Support by Fire |
+| `attack-by-fire` | Attack by Fire |
+| `flot` | FLOT (Forward Line of Own Troops) |
+| `breach` | Breach |
+| `bypass` | Bypass |
+| `canalize` | Canalize |
+| `fortified-line` | Fortified Line |
+| `fortified-area` | Fortified Area |
+| `block` | Block |
+| `disrupt` | Disrupt |
+| `fix` | Fix |
+| `obstacle-bypass-easy` | Obstacle Bypass (Easy) |
+| `obstacle-bypass-difficult` | Obstacle Bypass (Difficult) |
+| `obstacle-bypass-impossible` | Obstacle Bypass (Impossible) |
+
+## License
+
+MIT