@mailwoman/soil 9.2.0

package/out/test-kit.d.ts

@@ -0,0 +1,80 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Hand-built survey areas for the fixture rung: geometry, attributes and an outline, with no network and
+ *   no GDAL in the loop.
+ *
+ *   A FIXTURE RUNG THAT COULD ONLY RUN THROUGH ogr2ogr WOULD TEST THE CONVERSION ON THE MACHINES THAT HAVE
+ *   IT AND NOTHING AT ALL ON THE ONES THAT DO NOT. What these fixtures exercise is the whole database half —
+ *   the declared-domain check, the cell classification, the area-weighted reduction, the four absence
+ *   shares, the coverage rows, the manifest and the seal.
+ *
+ *   THE ABSENCE CASES ARE THE POINT, AND IOWA HAS NONE OF THEM. Every Iowa survey area is fully digitized,
+ *   so `NOTCOM`, `NOTPUB` and access-denied map units never appear in the live build — which means the only
+ *   place `nodata_share` can be exercised is here. The same is true of a component whose rating is NULL for
+ *   the not-rateable reason and of a class-8 rating: both exist in Iowa but sparsely, and a fixture pins the
+ *   behaviour rather than hoping a county contains one.
+ */
+import type { SoilComponentTable, SoilMapUnitTable } from "#schema";
+import type { SoilDelineation, SoilFeatureSource } from "#sdk/ingest";
+import type { SurveyAreaAttributes } from "#sdk/survey-area";
+/**
+ * Re-exported so a fixture in another workspace builds its rings the same way this one does.
+ */
+export { rectangleRing, reversedRing as holeRing } from "@mailwoman/spatial";
+/**
+ * Where the fixture geometry sits — central Iowa, so the cells it produces are the ones a real build would use.
+ */
+export declare const FIXTURE_ORIGIN: {
+    lat: number;
+    lon: number;
+};
+/**
+ * Degrees per fixture square side. About 1.6 km at this latitude — several resolution-9 cells across, so a fixture
+ * square has both an interior and a fringe.
+ */
+export declare const FIXTURE_SIDE = 0.015;
+/**
+ * The fixture map units. Each one exists to exercise exactly one reading.
+ */
+export declare function fixtureMapUnits(areaSymbol?: string): SoilMapUnitTable[];
+/**
+ * The fixture components. `mu-mixed` is 45/35/20 across three classes, which is the case a winner-class schema would
+ * report as "class 2" and this one reports as a mixture.
+ */
+export declare function fixtureComponents(): SoilComponentTable[];
+/**
+ * The declared domains a fixture build validates and stores, matching what the real `msdomdet.txt` ships.
+ */
+export declare function fixtureDomains(): SurveyAreaAttributes["domains"];
+/**
+ * The fixture delineations: a mixed square, a class-8 square, a water square, an unrated square, and a `NOTCOM` square,
+ * laid out left to right so each occupies its own ground.
+ */
+export declare function fixtureDelineations(areaSymbol?: string): SoilDelineation[];
+/**
+ * The outline covering every fixture delineation, with margin — the survey area's own footprint.
+ *
+ * The margin is nearly a degree because the coverage test is CONSERVATIVE: `interiorCoverageCellSet` keeps only cells
+ * lying wholly inside the outline, and a resolution-6 cell is about 36 km across. An outline the size of the fixture
+ * squares yields zero interior cells and the build refuses — correctly, since an artifact with no coverage rows answers
+ * unknown everywhere while reporting success.
+ */
+export declare function fixtureOutline(margin?: number): {
+    type: "Polygon";
+    coordinates: number[][][];
+};
+/**
+ * A feature source over hand-built delineations.
+ */
+export declare function fixtureSource(delineations: SoilDelineation[], areaSymbol?: string): SoilFeatureSource;
+/**
+ * One fixture survey area's attributes.
+ *
+ * `areaAcres` is left NULL on purpose: the area cross-check compares against what the AUTHORITY publishes, and a
+ * fixture that invented an acreage would be checking this package's arithmetic against itself.
+ */
+export declare function fixtureAttributes(areaSymbol?: string): SurveyAreaAttributes;
+//# sourceMappingURL=test-kit.d.ts.map

package/out/test-kit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-kit.d.ts","sourceRoot":"","sources":["../lib/test-kit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAMH,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AAE5D;;GAEG;AACH,OAAO,EAAE,aAAa,EAAE,YAAY,IAAI,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAE5E;;GAEG;AACH,eAAO,MAAM,cAAc;;;CAA4B,CAAA;AAEvD;;;GAGG;AACH,eAAO,MAAM,YAAY,QAAQ,CAAA;AAEjC;;GAEG;AACH,wBAAgB,eAAe,CAAC,UAAU,SAAU,GAAG,gBAAgB,EAAE,CAoExE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,kBAAkB,EAAE,CAaxD;AAwBD;;GAEG;AACH,wBAAgB,cAAc,IAAI,oBAAoB,CAAC,SAAS,CAAC,CAiBhE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,SAAU,GAAG,eAAe,EAAE,CAU3E;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,MAAM,SAAO,GAAG;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,CAAA;CAAE,CAS5F;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,YAAY,EAAE,eAAe,EAAE,EAAE,UAAU,SAAU,GAAG,iBAAiB,CAatG;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,SAAU,GAAG,oBAAoB,CAe5E"}

package/out/test-kit.js

@@ -0,0 +1,228 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Hand-built survey areas for the fixture rung: geometry, attributes and an outline, with no network and
+ *   no GDAL in the loop.
+ *
+ *   A FIXTURE RUNG THAT COULD ONLY RUN THROUGH ogr2ogr WOULD TEST THE CONVERSION ON THE MACHINES THAT HAVE
+ *   IT AND NOTHING AT ALL ON THE ONES THAT DO NOT. What these fixtures exercise is the whole database half —
+ *   the declared-domain check, the cell classification, the area-weighted reduction, the four absence
+ *   shares, the coverage rows, the manifest and the seal.
+ *
+ *   THE ABSENCE CASES ARE THE POINT, AND IOWA HAS NONE OF THEM. Every Iowa survey area is fully digitized,
+ *   so `NOTCOM`, `NOTPUB` and access-denied map units never appear in the live build — which means the only
+ *   place `nodata_share` can be exercised is here. The same is true of a component whose rating is NULL for
+ *   the not-rateable reason and of a class-8 rating: both exist in Iowa but sparsely, and a fixture pins the
+ *   behaviour rather than hoping a county contains one.
+ */
+// The exterior and hole ring builders live in `@mailwoman/spatial` — a winding convention rather than this
+// product's geometry, and a second copy of it is a second place for a hole to stop being one.
+import { rectangleRing } from "@mailwoman/spatial";
+/**
+ * Re-exported so a fixture in another workspace builds its rings the same way this one does.
+ */
+export { rectangleRing, reversedRing as holeRing } from "@mailwoman/spatial";
+/**
+ * Where the fixture geometry sits — central Iowa, so the cells it produces are the ones a real build would use.
+ */
+export const FIXTURE_ORIGIN = { lat: 41.6, lon: -93.6 };
+/**
+ * Degrees per fixture square side. About 1.6 km at this latitude — several resolution-9 cells across, so a fixture
+ * square has both an interior and a fringe.
+ */
+export const FIXTURE_SIDE = 0.015;
+/**
+ * The fixture map units. Each one exists to exercise exactly one reading.
+ */
+export function fixtureMapUnits(areaSymbol = "XX001") {
+    return [
+        {
+            mukey: "mu-mixed",
+            areasymbol: areaSymbol,
+            musym: "M1",
+            muname: "Fixture complex, 0 to 2 percent slopes",
+            mukind: "Complex",
+            mustatus: null,
+            farmlndcl: "Prime farmland if drained",
+            farmland_scope: "federal",
+            niccdcd: "2",
+            niccdcdpct: 45,
+            no_mapping: 0,
+        },
+        {
+            mukey: "mu-class8",
+            areasymbol: areaSymbol,
+            musym: "M8",
+            muname: "Fixture badland",
+            mukind: "Consociation",
+            mustatus: null,
+            farmlndcl: "Not prime farmland",
+            farmland_scope: "none",
+            niccdcd: "8",
+            niccdcdpct: 100,
+            no_mapping: 0,
+        },
+        {
+            mukey: "mu-water",
+            areasymbol: areaSymbol,
+            musym: "W",
+            muname: "Water",
+            mukind: "Consociation",
+            mustatus: null,
+            farmlndcl: null,
+            farmland_scope: "none",
+            niccdcd: null,
+            niccdcdpct: null,
+            no_mapping: 0,
+        },
+        {
+            mukey: "mu-unrated",
+            areasymbol: areaSymbol,
+            musym: "U",
+            muname: "Fixture silt loam, unrated",
+            mukind: "Consociation",
+            mustatus: null,
+            farmlndcl: "Farmland of statewide importance",
+            farmland_scope: "state",
+            niccdcd: null,
+            niccdcdpct: null,
+            no_mapping: 0,
+        },
+        {
+            mukey: "mu-notcom",
+            areasymbol: areaSymbol,
+            musym: "NOTCOM",
+            muname: "No Digital Data Available",
+            mukind: null,
+            mustatus: null,
+            farmlndcl: null,
+            farmland_scope: "none",
+            niccdcd: null,
+            niccdcdpct: null,
+            no_mapping: 1,
+        },
+    ];
+}
+/**
+ * The fixture components. `mu-mixed` is 45/35/20 across three classes, which is the case a winner-class schema would
+ * report as "class 2" and this one reports as a mixture.
+ */
+export function fixtureComponents() {
+    return [
+        component("co-mixed-1", "mu-mixed", 45, "Series", "2", "e"),
+        component("co-mixed-2", "mu-mixed", 35, "Series", "3", "e"),
+        component("co-mixed-3", "mu-mixed", 20, "Series", "6", "s"),
+        component("co-class8", "mu-class8", 100, "Series", "8", "s"),
+        // A miscellaneous area with no rating: NOT RATEABLE, which is not the same as unrated and not the same as class 8.
+        component("co-water", "mu-water", 100, "Miscellaneous area", null, null),
+        // A named soil the survey did not rate: UNRATED.
+        component("co-unrated", "mu-unrated", 100, "Series", null, null),
+        // A minority component small enough to fall under the truncation floor once the lattice splits it.
+        component("co-tail", "mu-mixed", 1, "Series", "7", "e"),
+    ];
+}
+function component(cokey, mukey, comppct, compkind, nirrcapcl, nirrcapscl) {
+    return {
+        cokey,
+        mukey,
+        comppct_r: comppct,
+        compname: cokey,
+        compkind,
+        nirrcapcl,
+        nirrcapscl,
+        irrcapcl: null,
+        irrcapscl: null,
+        nccpi_v3: null,
+    };
+}
+/**
+ * The declared domains a fixture build validates and stores, matching what the real `msdomdet.txt` ships.
+ */
+export function fixtureDomains() {
+    const members = [];
+    for (const [index, code] of ["1", "2", "3", "4", "5", "6", "7", "8"].entries()) {
+        members.push({
+            domain: "capability_class",
+            code,
+            sequence: index + 1,
+            definition: `Soils in Class ${code} — fixture definition.`,
+        });
+    }
+    for (const [index, code] of ["e", "w", "s", "c"].entries()) {
+        members.push({ domain: "capability_subclass", code, sequence: index + 1, definition: `Fixture subclass ${code}.` });
+    }
+    return members;
+}
+/**
+ * The fixture delineations: a mixed square, a class-8 square, a water square, an unrated square, and a `NOTCOM` square,
+ * laid out left to right so each occupies its own ground.
+ */
+export function fixtureDelineations(areaSymbol = "XX001") {
+    const { lat, lon } = FIXTURE_ORIGIN;
+    const mukeys = ["mu-mixed", "mu-class8", "mu-water", "mu-unrated", "mu-notcom"];
+    return mukeys.map((mukey, index) => ({
+        areaID: `${areaSymbol}:${index}`,
+        mukey,
+        areasymbol: areaSymbol,
+        polygons: [[rectangleRing(lon + index * FIXTURE_SIDE, lat, lon + (index + 1) * FIXTURE_SIDE, lat + FIXTURE_SIDE)]],
+    }));
+}
+/**
+ * The outline covering every fixture delineation, with margin — the survey area's own footprint.
+ *
+ * The margin is nearly a degree because the coverage test is CONSERVATIVE: `interiorCoverageCellSet` keeps only cells
+ * lying wholly inside the outline, and a resolution-6 cell is about 36 km across. An outline the size of the fixture
+ * squares yields zero interior cells and the build refuses — correctly, since an artifact with no coverage rows answers
+ * unknown everywhere while reporting success.
+ */
+export function fixtureOutline(margin = 0.75) {
+    const { lat, lon } = FIXTURE_ORIGIN;
+    return {
+        type: "Polygon",
+        coordinates: [
+            rectangleRing(lon - margin, lat - margin, lon + 5 * FIXTURE_SIDE + margin, lat + FIXTURE_SIDE + margin),
+        ],
+    };
+}
+/**
+ * A feature source over hand-built delineations.
+ */
+export function fixtureSource(delineations, areaSymbol = "XX001") {
+    return {
+        areaSymbol,
+        declaredFeatureCount: delineations.length,
+        layer: `soilmu_a_${areaSymbol.toLowerCase()}`,
+        epsg: 4326,
+        origin: "fixture",
+        async *delineations() {
+            for (const delineation of delineations) {
+                yield delineation;
+            }
+        },
+    };
+}
+/**
+ * One fixture survey area's attributes.
+ *
+ * `areaAcres` is left NULL on purpose: the area cross-check compares against what the AUTHORITY publishes, and a
+ * fixture that invented an acreage would be checking this package's arithmetic against itself.
+ */
+export function fixtureAttributes(areaSymbol = "XX001") {
+    return {
+        areasymbol: areaSymbol,
+        areaname: "Fixture County, Iowa",
+        saverest: "2025-09-09",
+        saversion: 1,
+        surveySourceDate: "1960",
+        surveySourceTitle: "Soil Survey of Fixture County, Iowa",
+        sourceScale: 15_840,
+        mappingScale: 12_000,
+        areaAcres: null,
+        mapUnits: fixtureMapUnits(areaSymbol),
+        components: fixtureComponents(),
+        domains: fixtureDomains(),
+    };
+}
+//# sourceMappingURL=test-kit.js.map

package/out/test-kit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-kit.js","sourceRoot":"","sources":["../lib/test-kit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,2GAA2G;AAC3G,8FAA8F;AAC9F,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAMlD;;GAEG;AACH,OAAO,EAAE,aAAa,EAAE,YAAY,IAAI,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAE5E;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAA;AAEvD;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAA;AAEjC;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,UAAU,GAAG,OAAO;IACnD,OAAO;QACN;YACC,KAAK,EAAE,UAAU;YACjB,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,wCAAwC;YAChD,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,2BAA2B;YACtC,cAAc,EAAE,SAAS;YACzB,OAAO,EAAE,GAAG;YACZ,UAAU,EAAE,EAAE;YACd,UAAU,EAAE,CAAC;SACb;QACD;YACC,KAAK,EAAE,WAAW;YAClB,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,iBAAiB;YACzB,MAAM,EAAE,cAAc;YACtB,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,oBAAoB;YAC/B,cAAc,EAAE,MAAM;YACtB,OAAO,EAAE,GAAG;YACZ,UAAU,EAAE,GAAG;YACf,UAAU,EAAE,CAAC;SACb;QACD;YACC,KAAK,EAAE,UAAU;YACjB,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,GAAG;YACV,MAAM,EAAE,OAAO;YACf,MAAM,EAAE,cAAc;YACtB,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,IAAI;YACf,cAAc,EAAE,MAAM;YACtB,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,CAAC;SACb;QACD;YACC,KAAK,EAAE,YAAY;YACnB,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,GAAG;YACV,MAAM,EAAE,4BAA4B;YACpC,MAAM,EAAE,cAAc;YACtB,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,kCAAkC;YAC7C,cAAc,EAAE,OAAO;YACvB,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,CAAC;SACb;QACD;YACC,KAAK,EAAE,WAAW;YAClB,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,2BAA2B;YACnC,MAAM,EAAE,IAAI;YACZ,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,IAAI;YACf,cAAc,EAAE,MAAM;YACtB,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,CAAC;SACb;KACD,CAAA;AACF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB;IAChC,OAAO;QACN,SAAS,CAAC,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,CAAC;QAC3D,SAAS,CAAC,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,CAAC;QAC3D,SAAS,CAAC,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,CAAC;QAC3D,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,CAAC;QAC5D,mHAAmH;QACnH,SAAS,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,oBAAoB,EAAE,IAAI,EAAE,IAAI,CAAC;QACxE,iDAAiD;QACjD,SAAS,CAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC;QAChE,mGAAmG;QACnG,SAAS,CAAC,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,CAAC;KACvD,CAAA;AACF,CAAC;AAED,SAAS,SAAS,CACjB,KAAa,EACb,KAAa,EACb,OAAe,EACf,QAAgB,EAChB,SAAwB,EACxB,UAAyB;IAEzB,OAAO;QACN,KAAK;QACL,KAAK;QACL,SAAS,EAAE,OAAO;QAClB,QAAQ,EAAE,KAAK;QACf,QAAQ;QACR,SAAS;QACT,UAAU;QACV,QAAQ,EAAE,IAAI;QACd,SAAS,EAAE,IAAI;QACf,QAAQ,EAAE,IAAI;KACd,CAAA;AACF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc;IAC7B,MAAM,OAAO,GAAoC,EAAE,CAAA;IAEnD,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC;YACZ,MAAM,EAAE,kBAAkB;YAC1B,IAAI;YACJ,QAAQ,EAAE,KAAK,GAAG,CAAC;YACnB,UAAU,EAAE,kBAAkB,IAAI,wBAAwB;SAC1D,CAAC,CAAA;IACH,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QAC5D,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,GAAG,CAAC,EAAE,UAAU,EAAE,oBAAoB,IAAI,GAAG,EAAE,CAAC,CAAA;IACpH,CAAC;IAED,OAAO,OAAO,CAAA;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAAU,GAAG,OAAO;IACvD,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,cAAc,CAAA;IACnC,MAAM,MAAM,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,CAAC,CAAA;IAE/E,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACpC,MAAM,EAAE,GAAG,UAAU,IAAI,KAAK,EAAE;QAChC,KAAK;QACL,UAAU,EAAE,UAAU;QACtB,QAAQ,EAAE,CAAC,CAAC,aAAa,CAAC,GAAG,GAAG,KAAK,GAAG,YAAY,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,YAAY,EAAE,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC;KAClH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,MAAM,GAAG,IAAI;IAC3C,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,cAAc,CAAA;IAEnC,OAAO;QACN,IAAI,EAAE,SAAS;QACf,WAAW,EAAE;YACZ,aAAa,CAAC,GAAG,GAAG,MAAM,EAAE,GAAG,GAAG,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,YAAY,GAAG,MAAM,EAAE,GAAG,GAAG,YAAY,GAAG,MAAM,CAAC;SACvG;KACD,CAAA;AACF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,YAA+B,EAAE,UAAU,GAAG,OAAO;IAClF,OAAO;QACN,UAAU;QACV,oBAAoB,EAAE,YAAY,CAAC,MAAM;QACzC,KAAK,EAAE,YAAY,UAAU,CAAC,WAAW,EAAE,EAAE;QAC7C,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,SAAS;QACjB,KAAK,CAAC,CAAC,YAAY;YAClB,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;gBACxC,MAAM,WAAW,CAAA;YAClB,CAAC;QACF,CAAC;KACD,CAAA;AACF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAU,GAAG,OAAO;IACrD,OAAO;QACN,UAAU,EAAE,UAAU;QACtB,QAAQ,EAAE,sBAAsB;QAChC,QAAQ,EAAE,YAAY;QACtB,SAAS,EAAE,CAAC;QACZ,gBAAgB,EAAE,MAAM;QACxB,iBAAiB,EAAE,qCAAqC;QACxD,WAAW,EAAE,MAAM;QACnB,YAAY,EAAE,MAAM;QACpB,SAAS,EAAE,IAAI;QACf,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC;QACrC,UAAU,EAAE,iBAAiB,EAAE;QAC/B,OAAO,EAAE,cAAc,EAAE;KACzB,CAAA;AACF,CAAC"}

package/out/vocabulary.d.ts

@@ -0,0 +1,179 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   NRCS's own words, as data: the product identity, the licence sentence it ships inside every archive,
+ *   the acknowledgement it asks for, and the caveats that decide what a reading may claim.
+ *
+ *   THE RATING VOCABULARY IS NOT HERE, BECAUSE THE AUTHORITY SHIPS IT. `msdomdet.txt` inside each survey
+ *   area's tabular export carries the declared domain for every `Choice` column, WITH the authority's own
+ *   prose definition of each member — capability classes 1 through 8, subclasses `c`/`e`/`s`/`w`, the 28
+ *   farmland classifications, the six component kinds. So the layer reads the domain out of the file it
+ *   ingested rather than transcribing it from the National Soil Survey Handbook, and an out-of-domain value
+ *   throws: an unknown code is a source-schema change, which is the event a reader most needs to hear
+ *   about, and coercing it to a nearest neighbour or to NULL converts "the source changed" into "there is
+ *   nothing here".
+ *
+ *   THE FARMLAND VOCABULARY IS CONDITIONAL AND THE CONDITION IS THE CLAIM. 28 declared values, of which 24
+ *   carry an "if" — `Prime farmland if drained`, `Prime farmland if irrigated and reclaimed of excess salts
+ *   and sodium`. A boolean `arable` column would be this layer's invention rather than the authority's
+ *   statement, so the string is stored whole.
+ *
+ *   AND TWO OF ITS CATEGORIES TRAVEL WHILE THE OTHERS DO NOT. 7 CFR 657.5 defines prime farmland and unique
+ *   farmland nationally against nine specific criteria; §657.5(c) and (d) hand "additional farmland of
+ *   statewide importance" and "of local importance" to state and local agencies respectively. So
+ *   `Farmland of statewide importance` in Iowa and in Georgia are not the same claim, and a consumer that
+ *   pooled them into one rank would be pooling incompatible vocabularies. {@link FARMLAND_SCOPE} carries
+ *   that distinction into the artifact rather than leaving it in a document.
+ */
+/**
+ * The layer-name prefix. The suffix names the REGION the build covers, because the manifest's declared extent and the
+ * coverage rows describe the same set and that set is a list of published survey areas rather than "the United
+ * States".
+ */
+export declare const SOIL_LAYER_NAME_PREFIX = "soil-capability-nrcs-ssurgo-";
+/**
+ * The layer name for a build over `region`.
+ */
+export declare function soilLayerName(region: string): string;
+/**
+ * The pilot region — Iowa, whole, built survey area by survey area.
+ */
+export declare const SOIL_PILOT_REGION = "ia";
+/**
+ * The acknowledgement string the shipped FGDC metadata asks for, verbatim as the metadata gives the agency name. This
+ * is not decoration: the use constraints say the agency "should be acknowledged as the data source in products derived
+ * from these data", so it rides in `layer_manifest.attribution`.
+ */
+export declare const SSURGO_ATTRIBUTION = "U.S. Department of Agriculture, Natural Resources Conservation Service";
+/**
+ * The licence expression written into `layer_manifest.license`.
+ *
+ * A public-domain identifier, and the grant behind it is the producing agency's own sentence rather than a catalogue
+ * field: data.gov's entry points at `usa.gov/publicdomain/label/1.0/`, which redirects to a page that declines a
+ * blanket grant and tells the reader to check with the agency. The agency was checked at the strongest available place
+ * — the FGDC metadata NRCS ships inside the archive — and it says {@link SSURGO_PUBLIC_INFORMATION_SENTENCE}.
+ */
+export declare const SSURGO_LICENSE = "PDDL-1.0-USGov-NRCS";
+/**
+ * The sentence that makes this layer shippable, verbatim from the `useconst` element of the FGDC metadata inside every
+ * survey-area archive.
+ *
+ * The ingest asserts it is present in each area's metadata. A survey area whose use constraints no longer say this is a
+ * licence change, and a build that absorbed one would ship an artifact under terms nobody checked.
+ */
+export declare const SSURGO_PUBLIC_INFORMATION_SENTENCE = "This is public information";
+/**
+ * The use constraints in full, as the metadata states them. Carried so a reader can check the licence claim against the
+ * authority's own words rather than against this package's summary of them.
+ */
+export declare const SSURGO_USE_CONSTRAINTS: string;
+/**
+ * What a reading is NOT, in the authority's own words. Carried on every reading, because a caller cannot see from a
+ * capability class that the survey declines to speak about a specific site.
+ *
+ * The first two sentences are why §3.1 of the survey forbids a point-level determination: the map is authoritative
+ * about an area at its own scale and explicitly declines to be authoritative about a point.
+ */
+export declare const SSURGO_PRODUCT_LIMITS: ReadonlyArray<string>;
+/**
+ * The coverage statement a `designated` basis rests on: what NRCS declares complete inside a published survey area.
+ *
+ * It is the mapping at the survey's own scale, NOT a site-specific determination — which is why the observation reports
+ * what the survey assigns to the map unit covering a location and never whether the land can be farmed.
+ */
+export declare const SSURGO_COVERAGE_STATEMENT: string;
+/**
+ * Where the product's identity and cadence are published.
+ */
+export declare const SSURGO_STATEMENT_URL = "https://www.nrcs.usda.gov/conservation-basics/natural-resource-concerns/soil/annual-soils-refresh";
+/**
+ * The dataset identifier written into `layer_manifest.source`.
+ */
+export declare const SSURGO_SOURCE = "nrcs.usda.gov/SSURGO";
+/**
+ * The projection every SSURGO survey-area shapefile declares. The `.prj` is an ESRI WKT naming `GCS_WGS_1984`, which
+ * GDAL resolves to this authority code — so no reprojection is needed before H3, and a survey area declaring anything
+ * else is a product change rather than a variation to absorb.
+ */
+export declare const SSURGO_SOURCE_EPSG = 4326;
+/**
+ * Whether a farmland classification's criteria are set nationally or by a state or local agency.
+ *
+ * 7 CFR 657.5 defines prime and unique farmland against nine national criteria; (c) and (d) delegate statewide and
+ * local importance. A consumer comparing two states may compare the national categories and must not compare the
+ * delegated ones.
+ */
+export declare const FarmlandScope: {
+    /**
+     * Criteria set by 7 CFR 657.5(a)–(b). Comparable across the country.
+     */
+    readonly Federal: "federal";
+    /**
+     * Criteria "determined by the appropriate State agency or agencies" — 7 CFR 657.5(c).
+     */
+    readonly State: "state";
+    /**
+     * Criteria "identified by the local agency or agencies concerned" — 7 CFR 657.5(d).
+     */
+    readonly Local: "local";
+    /**
+     * The value states no farmland importance at all.
+     */
+    readonly None: "none";
+};
+export type FarmlandScope = (typeof FarmlandScope)[keyof typeof FarmlandScope];
+/**
+ * Which scope a declared `farmlndcl` value falls under, decided on the phrase the regulation itself uses.
+ *
+ * Matching on the phrase rather than on an enumerated list of the 28 values is deliberate: the domain grows — the
+ * conditional tail is generated by combining a base category with a condition — and a new `Farmland of statewide
+ * importance, if …` must land in {@link FarmlandScope.State} on the day it appears rather than silently defaulting to
+ * the comparable bucket.
+ */
+export declare function farmlandScope(value: string | null | undefined): FarmlandScope;
+/**
+ * Map-unit symbols NRCS uses for a delineation it has drawn and has no soil mapping behind.
+ *
+ * These are polygons rather than holes — the same wall-to-wall discipline that makes them separable from land outside a
+ * survey area entirely. Measured nationally through Soil Data Access: 37 map units carry `NOTCOM` (`No Digital Data
+ * Available`) and 7 carry `NOTPUB` (`Not Public Information`).
+ */
+export declare const SSURGO_NO_MAPPING_SYMBOLS: ReadonlySet<string>;
+/**
+ * Map-unit names for the same case, where the symbol does not carry it. Measured nationally: 72 map units are named
+ * `Area not surveyed, access denied`.
+ *
+ * Matched case-insensitively on the whole name. A prefix match would catch a future `Area not surveyed, access denied —
+ * pending` and would also catch nothing else, but it would equally catch a real soil name beginning with those words,
+ * and there is no such thing to be gained by guessing.
+ */
+export declare const SSURGO_NO_MAPPING_NAMES: ReadonlySet<string>;
+/**
+ * The interpretation rule whose overall value this layer carries, exactly as `cointerp.mrulename` spells it.
+ *
+ * Its `interphr` is an index in [0, 1] — measured 0.001 to 0.991 nationally, 0.022 to 0.990 on `IA153` — and it is
+ * never blended with the capability class: they are two ratings from one authority answering different questions, and
+ * combining them would produce a number NRCS does not publish.
+ */
+export declare const NCCPI_V3_RULE_NAME = "NCCPI - National Commodity Crop Productivity Index (Ver 3.0)";
+/**
+ * The interpretation depth at which a rule reports its own overall value. Sub-rules sit at greater depths and are the
+ * submodels (corn, soybeans, small grains, cotton), which this layer does not carry.
+ */
+export declare const COINTERP_OVERALL_RULE_DEPTH = "0";
+/**
+ * How the per-cell shares were produced, recorded on every row.
+ *
+ * The survey names this as a required record because the weighting mixes two different things — polygon geometry, which
+ * the survey does know, and component percentages, which are a proportion without a location. "60% of this cell's area
+ * lies in map units whose components are class 2" and "the components in this cell sum to 60% class 2" are different
+ * claims, and a reader holding only a share cannot tell which one it is holding.
+ */
+export declare const SOIL_SHARE_WEIGHTING = "cell_area_x_comppct_r";
+/**
+ * The one-sentence expansion of {@link SOIL_SHARE_WEIGHTING}, stored beside it so the artifact explains itself.
+ */
+export declare const SOIL_SHARE_WEIGHTING_DESCRIPTION: string;
+//# sourceMappingURL=vocabulary.d.ts.map

package/out/vocabulary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vocabulary.d.ts","sourceRoot":"","sources":["../lib/vocabulary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,iCAAiC,CAAA;AAEpE;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,OAAO,CAAA;AAErC;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,2EAA2E,CAAA;AAE1G;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,wBAAwB,CAAA;AAEnD;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC,+BAA+B,CAAA;AAE9E;;;GAGG;AACH,eAAO,MAAM,sBAAsB,QAKY,CAAA;AAE/C;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,EAAE,aAAa,CAAC,MAAM,CAMvD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,QAEoD,CAAA;AAE1F;;GAEG;AACH,eAAO,MAAM,oBAAoB,sGACmE,CAAA;AAEpG;;GAEG;AACH,eAAO,MAAM,aAAa,yBAAyB,CAAA;AAEnD;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,OAAO,CAAA;AAEtC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACzB;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEM,CAAA;AAEV,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;AAE9E;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,aAAa,CAkB7E;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,EAAE,WAAW,CAAC,MAAM,CAAiC,CAAA;AAE3F;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,EAAE,WAAW,CAAC,MAAM,CAItD,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,iEAAiE,CAAA;AAEhG;;;GAGG;AACH,eAAO,MAAM,2BAA2B,MAAM,CAAA;AAE9C;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,0BAA0B,CAAA;AAE3D;;GAEG;AACH,eAAO,MAAM,gCAAgC,QAIsC,CAAA"}