@finbheara/domain 0.24.0 → 0.26.0

package/README.md

@@ -34,6 +34,7 @@ ESM, Node ≥ 22 or Bun ≥ 1.4.2. MIT. Not affiliated with or endorsed by any d
 | import | what |
 |---|---|
 | `@finbheara/domain/place` | `place()`, `createPlaceReader`, `placeRelation`, the `Place` types |
+| `@finbheara/domain/geocode` | `geocode()`: a location field read by the place store, then by every GeoNames town of AU, CA, GB, IE, NZ and US; `townCell` |
 | `@finbheara/domain/clrg-regions` | `REGIONS`, `regionOf`, `resolvePhrase` |
 | `@finbheara/domain/school` | `createSchoolNameReader`, `DEFAULT_SCHOOL_NAME_READER`, `compareSchoolNames`, `foldSchoolName`, `schoolEncoder`, `schoolColumns` |
 | `@finbheara/domain/tune` | `tune()`, `tuneRelation`, `tempoLegal`, `settingAt`, `TUNE_NODES`: the CLRG set dance list, each tune with its time, speeds and bars |
@@ -104,6 +105,24 @@ A town followed by a county, district or region reads as the town only where tha
 it: `place("Coventry, West Midlands")` is Coventry, and `place("Coventry, Kent")` is two places.
 Which units hold each town is a table read off GeoNames.
 
+### Geocoding a location field
+
+`place()` holds the places a print of a school or a person may carry, and it reads no other
+town: a town name is often a surname or a word. A caller holding a LOCATION field reads it with
+`geocode()`, which keeps the store's reading and, where the store reads nothing or reads only
+the county or state, reads the GeoNames town layer, and answers only where it reads ONE town: every `cities500` town of Australia, Canada,
+Great Britain, Ireland, New Zealand and the United States, under the store node that holds it.
+
+```ts
+import { geocode } from "@finbheara/domain/geocode";
+
+geocode("Drogheda").pl3;         // "IRL-LH/drogheda", in Leinster
+geocode("Yonkers, NY").region;   // "IDTANA-MARO"
+geocode("Brooklyn").isPlace();   // false: a town of six US states and more, so only
+                                 // `Brooklyn, NY` reads
+place("Drogheda").arm;           // "unread": the store holds no Drogheda
+```
+
 A `Place` is one of four arms: `resolved`, `plural` (a print naming more than one place),
 `ambiguous` (one print, several readings) and `unread`. Only `conflict` between two readings
 says they cannot be one place; `same`, `contains` and `overlaps` do not.
@@ -507,5 +526,8 @@ seatName("Aoife Mhaolvarna").nn2;                    // "Mhaolvarna<<Aoife": nam
 
 MIT, Copyright (c) 2026 Finbheara Systems.
 
-The place-containment table contains data from GeoNames (https://www.geonames.org/), licensed
-under CC BY 4.0.
+The place-containment table and the town layer contain data from GeoNames
+(https://www.geonames.org/), licensed under CC BY 4.0
+(https://creativecommons.org/licenses/by/4.0/). The town layer is GeoNames' `cities500`,
+filtered to six countries and filed under this package's place nodes, each town citing its
+geonameid.

package/dist/ceili.js

@@ -4,7 +4,7 @@ import {
   ceiliById2,
   ceili2,
   ceiliRelation2
-} from "./chunks/place-kk48pfja.js";
+} from "./chunks/place-1cfxanhy.js";
 import"./chunks/place-htxgptyv.js";
 export {
   CEILI_NODES2 as CEILI_NODES,

package/dist/chunks/{place-g3py4821.js → place-h2s1w0tq.js}

@@ -6,6 +6,7 @@ import {
   validity
 } from "./place-q9kwsmzd.js";
 
+var FOREIGN_MEMBER_REGIONS = ["IDTANA-SRO"];
 var PLACE_NODES = [
   {
     id: "world",
@@ -260,6 +261,7 @@ var PLACE_NODES = [
       "s usa",
       "so usa",
       "southern region",
+      "southern region mexico usa",
       "southern region usa",
       "southern us",
       "southern usa",
@@ -2094,7 +2096,7 @@ var PLACE_NODES = [
     kind: "country",
     name: "Mexico",
     geo: "north-america",
-    admin: null,
+    admin: "IDTANA-SRO",
     prints: ["meicsiceo", "mex", "mexican", "mexico"],
     codes: ["MEX", "MX"],
     iso2: "MX",
@@ -7539,12 +7541,26 @@ function createPlaceReader2(options = {}) {
     const parents = new Map;
     for (const n of source)
       parents.set(n.id, upOf(n));
+    const countryOnMap = (n) => {
+      const seen = new Set;
+      for (let at = n;at !== undefined && !seen.has(at.id); ) {
+        if (at.kind === "country")
+          return at.id;
+        seen.add(at.id);
+        at = at.geo === null ? undefined : byId.get(at.geo);
+      }
+      return;
+    };
     const ancestorsOf = new Map;
     for (const n of source) {
       const out = new Set;
       const todo = [n];
+      const own = countryOnMap(n);
       for (let at = todo.pop();at !== undefined; at = todo.pop()) {
+        const foreign = at.kind === "region" && FOREIGN_MEMBER_REGIONS.includes(at.id) && own !== undefined && countryOnMap(at) !== own;
         for (const parent of parents.get(at.id) ?? []) {
+          if (foreign && parent.id === at.geo)
+            continue;
           if (parent.id === n.id || out.has(parent.id))
             continue;
           out.add(parent.id);
@@ -8823,4 +8839,4 @@ function sameReading2(a, b) {
   return DEFAULT_PLACE_READER2.sameReading(a, b);
 }
 
-export { NEVER_NAME, printZones, opensLocation, DEFAULT_PLACE_CAPACITY2, createPlaceReader2, DEFAULT_PLACE_READER2, place2, isPlaceToken2, countryCodeOf2, areAllPlaceTokens2, placeFromId2, placeWindows2, placeParts2, oireachtasOfRegion2, regionOfOireachtas2, placeStats2, resetPlaceCache2, placeRelation2, placesRelation2, probablySamePlace2, sameReading2 };
+export { PLACE_NODES, NEVER_NAME, printZones, opensLocation, DEFAULT_PLACE_CAPACITY2, createPlaceReader2, DEFAULT_PLACE_READER2, place2, isPlaceToken2, countryCodeOf2, areAllPlaceTokens2, placeFromId2, placeWindows2, placeParts2, oireachtasOfRegion2, regionOfOireachtas2, placeStats2, resetPlaceCache2, placeRelation2, placesRelation2, probablySamePlace2, sameReading2 };

package/dist/dance.js

@@ -1,10 +1,10 @@
 import"./chunks/place-htxgptyv.js";
 import {
   ceili2
-} from "./chunks/place-kk48pfja.js";
+} from "./chunks/place-1cfxanhy.js";
 import {
   tune2
-} from "./chunks/place-yndzaae5.js";
+} from "./chunks/place-26pfr6ak.js";
 import {
   validity
 } from "./chunks/place-q9kwsmzd.js";