@nspot/geo-pack-romania-localities 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 NSpot Games
+
+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/LICENSE-DATA

@@ -0,0 +1,51 @@
+Data licence for @nspot/geo-pack-romania-localities
+===================================================
+
+`LICENSE` (MIT) covers this package's text. It does not cover the data in
+`pack.json`, which is licensed separately.
+
+The label points are a derivative database of OpenStreetMap, © OpenStreetMap
+contributors, made available under the Open Database License 1.0 (ODbL):
+
+    https://opendatacommons.org/licenses/odbl/1-0/
+    https://www.openstreetmap.org/copyright
+
+They were taken from Geofabrik's extract of Romania, data of 2026-10-08:
+
+    https://download.geofabrik.de/europe/romania-261008.osm.pbf
+
+Because `pack.json` is built from those points, the whole of `pack.json` is
+ODbL 1.0, names and codes included. If you publicly use or convey it, or a
+database derived from it, you must offer it under the ODbL too, and keep the
+credit below.
+
+The names, SIRUTA codes and parents (the UAT each locality belongs to) come from
+the Institutul Național de Statistică (INS), SIRUTA nomenclature, first
+semester of 2026, published under the Creative Commons Attribution 4.0
+International licence (CC BY 4.0):
+
+    https://data.gov.ro/dataset/siruta_s1-2026
+    https://creativecommons.org/licenses/by/4.0/
+    https://data.gov.ro/pages/licence
+
+We changed the data: each locality was matched to an OpenStreetMap place node
+by its SIRUTA code, or failing that by name within its UAT, checked against the
+UAT's boundary, and rounded to 6 decimals. Names were converted from upper
+case with cedilla forms to title case with comma-below diacritics. A locality
+with no trustworthy node has no point and says why.
+
+Attribution: a map or anything else that shows the points must credit
+
+    © OpenStreetMap contributors
+
+(where the medium allows, link it to https://www.openstreetmap.org/copyright)
+
+and wherever you show or distribute the names and codes, credit
+
+    Institutul Național de Statistică, SIRUTA, CC BY 4.0
+
+The data is provided as is, with no warranty; it does not imply endorsement by
+OpenStreetMap or INS.
+
+The UATs these localities name as parents are not in this pack: they are in
+@nspot/geo-pack-romania-uat (see that package's LICENSE-DATA).

package/README.md

@@ -1,3 +1,85 @@
-# Temporary Holding Version
+# @nspot/geo-pack-romania-localities
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A [geo-engine](https://github.com/NSpot-Games/geo-engine) locality pack: every village of
+Romania and every component locality of its towns and cities, each with the point where
+OpenStreetMap labels it, parented to its UAT.
+
+## What's in it
+
+**13,749 localities**, each coded by its SIRUTA code (`code`, country `RO`) and named as
+SIRUTA names it, in title case with comma-below diacritics (ș, ț).
+
+- **12,959 villages**, tagged `sat`.
+- **790 component localities** of towns and cities (districts and suburbs with a SIRUTA
+  code of their own), tagged `localitate-componenta`.
+- **3,180** of them are also tagged `resedinta`: the locality where its UAT has its seat
+  (2,862 villages and 318 component localities).
+
+Each locality's parent is its UAT in
+[`@nspot/geo-pack-romania-uat`](https://www.npmjs.com/package/@nspot/geo-pack-romania-uat),
+by slug (`bran-bv`). Its `properties` carry:
+
+- `tip`: SIRUTA's locality type (9, 10, 11, 17, 18, 19, 22 or 23). Always there.
+- `point_rule`: how the point was chosen, when there is one. `coded` is the OpenStreetMap
+  place node that carries the locality's SIRUTA code (13,630 localities). `coded_outside`
+  is the same, but the node lies up to 1 km outside the UAT's simplified border, as it can
+  for a village on the border (69). `name` is the one place node of that name within the
+  UAT, for a locality with no coded node (15).
+- `osm_node`: the OpenStreetMap node id the point comes from.
+- `outside_m`: how far outside the UAT the point lies, in metres, when it lies outside.
+
+**35 localities have no point** (`point` is `null`) and carry the reason in `point_gap`:
+`no_osm_node` (26: no node of theirs, or two alike in the UAT and no way to choose),
+`far_outside_uat` (8: its coded node lies more than 1 km outside its UAT) and
+`nodes_disagree` (1: several coded nodes more than 2 km apart). They are listed by județ in
+the
+[gap report](https://github.com/NSpot-Games/geo-engine/blob/main/packages/db/seed/RO/localities/report.md);
+how the points are chosen is in
+[`packages/db/seed/RO/localities/README.md`](https://github.com/NSpot-Games/geo-engine/blob/main/packages/db/seed/RO/localities/README.md).
+
+**A point is a label point.** It is where OpenStreetMap puts the name of the place, not a
+boundary, a centre of mass or a postal area. Do not infer a village's extent from it, and do
+not assume the village lies in the UAT of the point on a border: the parent is SIRUTA's.
+
+The country entry carries no outline, so installing this pack never overwrites Romania's.
+The pack is about 4 MB.
+
+## Installing it
+
+It needs `@nspot/geo-engine` 0.5.0 or later (schema 9), which has localities. Install it
+beside `@nspot/geo-pack-romania-uat` (and `@nspot/geo-pack-romania`, which that needs):
+
+```bash
+npm i @nspot/geo-pack-romania @nspot/geo-pack-romania-uat @nspot/geo-pack-romania-localities
+```
+
+```ts
+import { installPack, localitiesIn } from "@nspot/geo-engine";
+
+await installPack(pool, "@nspot/geo-pack-romania");
+await installPack(pool, "@nspot/geo-pack-romania-uat");
+await installPack(pool, "@nspot/geo-pack-romania-localities");
+
+(await localitiesIn(pool, ["bran-bv"])).map((l) => l.name); // Bran, Predeluț, Șimon, Sohodol
+```
+
+Install them in that order, or in any other: parents are linked by slug, so a locality
+installed first stays unparented until the UAT arrives, and is linked then.
+
+If your own tables point at a locality, make the foreign key on `(country, code)` with
+`ON DELETE NO ACTION`. An update keeps localities in place by `(country, code)`. An update
+that would drop a locality your rows reference, or an uninstall, then fails loudly and names
+the locality instead of deleting your rows.
+
+## Licence
+
+The package's text is MIT (`LICENSE`); the data is ODbL 1.0 (`LICENSE-DATA`), because the
+points are a derivative of OpenStreetMap, and so is the whole of `pack.json`. A map or any
+other work that shows the points must credit
+
+- © OpenStreetMap contributors (where the medium allows, link it to
+  https://www.openstreetmap.org/copyright)
+
+and wherever you show the names and codes, credit
+
+- Institutul Național de Statistică, SIRUTA, CC BY 4.0