@mailwoman/codex 6.4.0 → 7.0.0

package/README.md

@@ -70,7 +70,6 @@ import { ADDRESS_SYSTEM_CONVENTIONS, conventionsForSystem } from "@mailwoman/cod
 ## Related
 
 - [`@mailwoman/core`](../core) — `ComponentTag` schema, pipeline infrastructure
-- [`@mailwoman/classifiers`](../classifiers) — rule-based classifiers that consume codex data
 - [`@mailwoman/address-id`](../address-id) — uses codex for stable address primary keys
 - [Address system conventions](https://mailwoman.sister.software/articles/plan/reference/SCHEMA/)
 

package/out/us/floor-designator.d.ts

@@ -32,7 +32,7 @@
  * `requiresNumber` mirrors the Appendix C2 classification: FLOOR and BASEMENT must be followed by a secondary number;
  * PENTHOUSE and LOBBY may stand alone.
  */
-export interface UsFloorDesignator {
+export interface USFloorDesignator {
     /** Full canonical designator (uppercase per the publication). */
     name: string;
     /** Approved USPS abbreviation (what the post office prints on standardized mail). */
@@ -71,26 +71,26 @@ export declare const US_FLOOR_DESIGNATORS: readonly [{
     readonly requiresNumber: false;
 }];
 /** A canonical USPS floor-class designator name. */
-export type UsFloorDesignatorName = (typeof US_FLOOR_DESIGNATORS)[number]["name"];
+export type USFloorDesignatorName = (typeof US_FLOOR_DESIGNATORS)[number]["name"];
 /**
  * Inverse lookup: every surface form (canonical name, approved abbreviation, or Appendix C2 variant) → its canonical
  * designator name. Lowercase-keyed for case-insensitive matching: `"fl"` → `"FLOOR"`, `"bsmt"` → `"BASEMENT"`, `"ph"` →
  * `"PENTHOUSE"`.
  */
-export declare const US_FLOOR_DESIGNATOR_LOOKUP: ReadonlyMap<string, UsFloorDesignatorName>;
+export declare const US_FLOOR_DESIGNATOR_LOOKUP: ReadonlyMap<string, USFloorDesignatorName>;
 /**
  * All lowercase surface tokens for the floor-class designators — the set the span proposer populates `levelDesignators`
  * with when wiring the US codex slice. Includes canonical names, approved abbreviations, and Appendix C2 variants.
  */
 export declare const US_FLOOR_DESIGNATOR_TOKENS: ReadonlySet<string>;
 /** Approved USPS abbreviation per canonical floor designator name. */
-export declare const US_FLOOR_DESIGNATOR_PREFERRED_ABBR: Readonly<Record<UsFloorDesignatorName, string>>;
+export declare const US_FLOOR_DESIGNATOR_PREFERRED_ABBR: Readonly<Record<USFloorDesignatorName, string>>;
 /**
  * Look up a USPS floor-class designator (by canonical name, abbreviation, or any Appendix C2 variant) and return the
  * canonical name + approved abbreviation. Returns null if the token isn't a recognized floor-class designator.
  */
 export declare function lookupFloorDesignator(input: string | null | undefined): {
-    designator: UsFloorDesignatorName;
+    designator: USFloorDesignatorName;
     abbreviation: string;
 } | null;
 /**

package/out/us/military-address.d.ts

@@ -46,7 +46,7 @@ export declare const US_MILITARY_POST_OFFICE_CODES: readonly [{
     readonly name: "Diplomatic Post Office";
     readonly armedForces: false;
 }];
-export type UsMilitaryPostOfficeCode = (typeof US_MILITARY_POST_OFFICE_CODES)[number]["code"];
+export type USMilitaryPostOfficeCode = (typeof US_MILITARY_POST_OFFICE_CODES)[number]["code"];
 /**
  * USPS Armed Forces "state" codes used in place of state names on military/diplomatic addresses. These appear where a
  * US state abbreviation (NY, CA, …) would appear in a civilian address.
@@ -64,7 +64,7 @@ export declare const US_ARMED_FORCES_REGIONS: readonly [{
     readonly name: "Armed Forces Pacific";
     readonly description: "Pacific";
 }];
-export type UsArmedForcesRegionCode = (typeof US_ARMED_FORCES_REGIONS)[number]["code"];
+export type USArmedForcesRegionCode = (typeof US_ARMED_FORCES_REGIONS)[number]["code"];
 /**
  * USPS Pub 28 Appendix B unit-line designators for military/diplomatic overseas addresses. Each designator introduces
  * an installation identifier and optionally a box number.
@@ -94,13 +94,13 @@ export declare const US_MILITARY_UNIT_DESIGNATORS: readonly [{
     readonly requiresBox: false;
     readonly description: "Numbered military unit (battalion/company); format: UNIT <id> [BOX <box>]";
 }];
-export type UsMilitaryUnitDesignatorCode = (typeof US_MILITARY_UNIT_DESIGNATORS)[number]["code"];
+export type USMilitaryUnitDesignatorCode = (typeof US_MILITARY_UNIT_DESIGNATORS)[number]["code"];
 /** Result of a military address line parse (the unit line: PSC/CMR/UNIT). */
-export interface UsMilitaryUnitMatch {
+export interface USMilitaryUnitMatch {
     /** The designator as it appeared ("PSC", "CMR", "Unit"). */
     matched: string;
     /** The canonical designator code ("PSC", "CMR", "UNIT"). */
-    code: UsMilitaryUnitDesignatorCode;
+    code: USMilitaryUnitDesignatorCode;
     /** The installation identifier ("1520", "453"). */
     id: string;
     /** The box number when present ("4620", "1234A"). */
@@ -111,17 +111,17 @@ export interface UsMilitaryUnitMatch {
  * the canonical designator, installation id, and optional box. Null otherwise. Throws on a PSC or CMR line without a
  * BOX component (per Appendix B, BOX is required for PSC/CMR; a bare "PSC 1520" is malformed).
  */
-export declare function matchMilitaryUnitLine(input: unknown): UsMilitaryUnitMatch | null;
+export declare function matchMilitaryUnitLine(input: unknown): USMilitaryUnitMatch | null;
 /** Type-predicate: does the input look like a USPS military unit line (PSC/CMR/UNIT)? */
 export declare function isMilitaryUnitLine(input: unknown): boolean;
 /** Result of a military city-line parse (APO/FPO/DPO + region code + ZIP). */
-export interface UsMilitaryCityMatch {
+export interface USMilitaryCityMatch {
     /** The post-office code as it appeared ("APO", "FPO", "DPO"). */
     matched: string;
     /** The canonical post-office code. */
-    code: UsMilitaryPostOfficeCode;
+    code: USMilitaryPostOfficeCode;
     /** The Armed Forces region code ("AA", "AE", "AP"). */
-    region: UsArmedForcesRegionCode;
+    region: USArmedForcesRegionCode;
     /**
      * The 5-digit or 9-digit ZIP code. Typical ranges per Pub 28: 09xxx (AE), 34xxx (AA), 96xxx (AP) — range validation
      * per region is caller responsibility.
@@ -136,7 +136,7 @@ export interface UsMilitaryCityMatch {
  * validation per region is left to the caller; the matcher accepts any 5. or 9-digit ZIP paired with a valid region
  * code.
  */
-export declare function matchMilitaryCityLine(input: unknown): UsMilitaryCityMatch | null;
+export declare function matchMilitaryCityLine(input: unknown): USMilitaryCityMatch | null;
 /** Type-predicate: does the input look like a USPS military city line (APO/FPO/DPO + region + ZIP)? */
 export declare function isMilitaryCityLine(input: unknown): boolean;
 //# sourceMappingURL=military-address.d.ts.map

package/out/us/po-box.d.ts

@@ -17,7 +17,7 @@
  * punctuation/spacing.
  */
 export declare const US_PO_BOX_DESIGNATORS: readonly ["POST OFFICE BOX", "PO BOX", "P O BOX", "FIRM CALLER", "CALLER", "DRAWER", "LOCKBOX", "BOX"];
-export type UsPoBoxDesignator = (typeof US_PO_BOX_DESIGNATORS)[number];
+export type USPoBoxDesignator = (typeof US_PO_BOX_DESIGNATORS)[number];
 /**
  * Type-predicate: does the input look like a standalone PO Box address? Case-insensitive and tolerant of "P.O. Box",
  * "Post Office Box", "Box 12", "PMB"-style ids. (Widens the original isp-nexus `/^PO BOX [\d-]+$/`, which only matched

package/out/us/state.d.ts

@@ -17,12 +17,12 @@
  */
 export declare const US_STATE_ABBREVIATIONS: readonly ["AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "PR", "GU", "VI", "MP", "AS"];
 /** A USPS two-letter state-or-territory abbreviation. */
-export type UsStateAbbreviation = (typeof US_STATE_ABBREVIATIONS)[number];
+export type USStateAbbreviation = (typeof US_STATE_ABBREVIATIONS)[number];
 /**
  * Type-predicate for a USPS state-or-territory abbreviation. Case-insensitive (`"ca"` and `"CA"` both pass), since the
  * abbreviation arrives from raw address text.
  */
-export declare function isUsStateAbbreviation(input: unknown): input is UsStateAbbreviation;
+export declare function isUSStateAbbreviation(input: unknown): input is USStateAbbreviation;
 /**
  * Full names for the 50 states, DC, and the five primary territories, keyed by USPS abbreviation. The names half of the
  * closed region vocabulary — where the country/state homographs live ("Georgia", "Washington"), which the

package/out/us/state.js

@@ -78,7 +78,7 @@ const STATE_ABBREVIATION_SET = new Set(US_STATE_ABBREVIATIONS);
  * Type-predicate for a USPS state-or-territory abbreviation. Case-insensitive (`"ca"` and `"CA"` both pass), since the
  * abbreviation arrives from raw address text.
  */
-export function isUsStateAbbreviation(input) {
+export function isUSStateAbbreviation(input) {
     return typeof input === "string" && STATE_ABBREVIATION_SET.has(input.toUpperCase());
 }
 /**

package/out/us/street-suffix.d.ts

@@ -227,14 +227,14 @@ export declare const US_STREET_SUFFIX_VARIANTS: {
     readonly WELLS: readonly ["WLS"];
 };
 /** Canonical USPS suffix (full word, uppercase per the publication). */
-export type UsStreetSuffix = keyof typeof US_STREET_SUFFIX_VARIANTS;
+export type USStreetSuffix = keyof typeof US_STREET_SUFFIX_VARIANTS;
 /**
  * Inverse lookup: every variant abbreviation OR full canonical word → its canonical key. Built once at module load,
  * lowercase-keyed for case-insensitive matching (`street` → `"STREET"`, `st` → `"STREET"`, `strt` → `"STREET"`, …).
  */
-export declare const US_STREET_SUFFIX_LOOKUP: ReadonlyMap<string, UsStreetSuffix>;
+export declare const US_STREET_SUFFIX_LOOKUP: ReadonlyMap<string, USStreetSuffix>;
 /** Preferred USPS abbreviation per canonical (`AVENUE → "AVE"`, `STREET → "ST"`). */
-export declare const US_STREET_SUFFIX_PREFERRED_ABBR: Readonly<Record<UsStreetSuffix, string>>;
+export declare const US_STREET_SUFFIX_PREFERRED_ABBR: Readonly<Record<USStreetSuffix, string>>;
 /**
  * Apply `target`'s letters in the same case-pattern as `reference`. Three patterns covered:
  *
@@ -248,7 +248,7 @@ export declare function matchCase(target: string, reference: string): string;
  * matched word. Returns null if the trailing word isn't a known suffix.
  */
 export declare function matchTrailingSuffix(street: string): {
-    canonical: UsStreetSuffix;
+    canonical: USStreetSuffix;
     matched: string;
 } | null;
 /**
@@ -463,9 +463,9 @@ export declare const StreetSuffixAbbreviationRecord: {
 };
 export type StreetSuffixAbbreviationRecord = typeof US_STREET_SUFFIX_VARIANTS;
 /**
- * A canonical USPS street suffix, i.e. "STREET", "AVENUE", "BOULEVARD". Aliases {@link UsStreetSuffix}.
+ * A canonical USPS street suffix, i.e. "STREET", "AVENUE", "BOULEVARD". Aliases {@link USStreetSuffix}.
  */
-export type StreetSuffix = UsStreetSuffix;
+export type StreetSuffix = USStreetSuffix;
 /** A standardized USPS street suffix abbreviation (the preferred form), i.e. "ST", "AVE", "BLVD". */
 export type USPSStandardSuffixAbbreviation = StreetSuffixAbbreviationRecord[StreetSuffix][0];
 /** Any USPS-recognized suffix variant or abbreviation. */

package/out/us/unit-designator.d.ts

@@ -61,34 +61,34 @@ export declare const US_UNIT_DESIGNATOR_VARIANTS: {
     readonly UPPER: readonly ["UPPR"];
 };
 /** Canonical USPS secondary unit designator (full word, uppercase per the publication). */
-export type UsUnitDesignator = keyof typeof US_UNIT_DESIGNATOR_VARIANTS;
+export type USUnitDesignator = keyof typeof US_UNIT_DESIGNATOR_VARIANTS;
 /**
  * Inverse lookup: every variant abbreviation OR full canonical word → its canonical key, built once at module load,
  * lowercase-keyed for case-insensitive matching (`apt` → `"APARTMENT"`, `ste` → `"SUITE"`, `suite` → `"SUITE"`).
  */
-export declare const US_UNIT_DESIGNATOR_LOOKUP: ReadonlyMap<string, UsUnitDesignator>;
+export declare const US_UNIT_DESIGNATOR_LOOKUP: ReadonlyMap<string, USUnitDesignator>;
 /** Approved USPS abbreviation per canonical (`APARTMENT → "APT"`, `SUITE → "STE"`). */
-export declare const US_UNIT_DESIGNATOR_PREFERRED_ABBR: Readonly<Record<UsUnitDesignator, string>>;
+export declare const US_UNIT_DESIGNATOR_PREFERRED_ABBR: Readonly<Record<USUnitDesignator, string>>;
 /**
  * Canonical designators Appendix C2 marks as "Requires a Secondary Number" — the designator must be followed by an
  * identifier ("Apt 4B", "Rm 12"), never appearing bare. The remaining designators (BASEMENT, FRONT, LOBBY, LOWER,
  * OFFICE, PENTHOUSE, REAR, SIDE, UPPER) may stand alone with no trailing identifier. Verbatim from USPS Pub-28 C2; see
  * the module header for provenance (#1100).
  */
-export declare const US_UNIT_DESIGNATOR_REQUIRES_RANGE: Readonly<Record<UsUnitDesignator, boolean>>;
+export declare const US_UNIT_DESIGNATOR_REQUIRES_RANGE: Readonly<Record<USUnitDesignator, boolean>>;
 /**
  * If the FIRST whitespace-separated word of `unit` is a known USPS designator variant, return the canonical key and the
  * matched word. Returns null if the leading word isn't a known designator (e.g. a bare `"4B"` or `"#210"`).
  * Leading-word-only — designators introduce the unit, unlike street suffixes which trail.
  */
 export declare function matchLeadingDesignator(unit: string): {
-    canonical: UsUnitDesignator;
+    canonical: USUnitDesignator;
     matched: string;
 } | null;
 /** Result of {@link matchLeadingDesignatorWithRange}: the leading designator plus its optional secondary range. */
 export interface UnitDesignatorRangeMatch {
     /** The matched canonical designator, i.e. "APARTMENT", "SUITE". */
-    canonical: UsUnitDesignator;
+    canonical: USUnitDesignator;
     /** The designator's own matched surface form, i.e. "Apt". */
     matched: string;
     /**
@@ -110,7 +110,7 @@ export interface UnitDesignatorRangeMatch {
  */
 export declare function matchLeadingDesignatorWithRange(unit: string): UnitDesignatorRangeMatch | null;
 /** Result of a successful USPS secondary-unit designator lookup. */
-export interface UnitDesignatorMatch<D extends UsUnitDesignator = UsUnitDesignator> {
+export interface UnitDesignatorMatch<D extends USUnitDesignator = USUnitDesignator> {
     /** The matched canonical designator, i.e. "APARTMENT", "SUITE". */
     designator: D;
     /** The approved USPS abbreviation, i.e. "APT", "STE". */
@@ -120,7 +120,7 @@ export interface UnitDesignatorMatch<D extends UsUnitDesignator = UsUnitDesignat
  * Look up a USPS secondary unit designator (by canonical word, abbreviation, or any variant) and its approved
  * abbreviation.
  */
-export declare function lookupUnitDesignator<D extends UsUnitDesignator>(designator: D): UnitDesignatorMatch<D>;
+export declare function lookupUnitDesignator<D extends USUnitDesignator>(designator: D): UnitDesignatorMatch<D>;
 export declare function lookupUnitDesignator(input: string | null | undefined): UnitDesignatorMatch | null;
 /**
  * True when a token is any USPS secondary unit designator or abbreviation (case-insensitive) — `"Apt"`, `"STE"`,

package/out/us/zipcode.d.ts

@@ -7,7 +7,7 @@
  *   state geographic prior, and a state-plus-ZIP plucker.
  */
 import type { Tagged } from "type-fest";
-import { type UsStateAbbreviation } from "./state.ts";
+import { type USStateAbbreviation } from "./state.ts";
 /**
  * USPS-recognized ZIP code digits.
  *
@@ -162,14 +162,14 @@ export declare const ZipCodePatterns: {
  */
 export declare function isZipCode(input: unknown): input is ZipCode | ZipCodePlusFour;
 export interface PluckedStateZIPCodeResult {
-    stateAbbreviation: UsStateAbbreviation | null;
+    stateAbbreviation: USStateAbbreviation | null;
     zipCode: ZipCode | ZipCodePlusFour;
 }
 /**
  * Given an address string like `"NY"`, `"CA 94016"`, attempts to match the state abbreviation and postal code, if
  * applicable.
  *
- * @see {@linkcode isUsStateAbbreviation} to validate the state abbreviation.
+ * @see {@linkcode isUSStateAbbreviation} to validate the state abbreviation.
  */
 export declare function pluckStateZIPCode(input: unknown): PluckedStateZIPCodeResult | null;
 //# sourceMappingURL=zipcode.d.ts.map

package/out/us/zipcode.js

@@ -6,7 +6,7 @@
  *   US ZIP (Zone Improvement Plan) codes: branded string types, the shape patterns, the first-digit →
  *   state geographic prior, and a state-plus-ZIP plucker.
  */
-import { isUsStateAbbreviation } from "./state.js";
+import { isUSStateAbbreviation } from "./state.js";
 /**
  * Record of US state abbreviations to their corresponding ZIP code prefix (the leading digit). A cheap geographic
  * prior: a 5-digit code's first digit narrows it to a band of states, which the parser can weigh against the
@@ -105,7 +105,7 @@ export function isZipCode(input) {
  * Given an address string like `"NY"`, `"CA 94016"`, attempts to match the state abbreviation and postal code, if
  * applicable.
  *
- * @see {@linkcode isUsStateAbbreviation} to validate the state abbreviation.
+ * @see {@linkcode isUSStateAbbreviation} to validate the state abbreviation.
  */
 export function pluckStateZIPCode(input) {
     if (!input || typeof input !== "string")
@@ -115,7 +115,7 @@ export function pluckStateZIPCode(input) {
         return null;
     const normalizedState = stateAbbreviation?.toUpperCase();
     return {
-        stateAbbreviation: isUsStateAbbreviation(normalizedState) ? normalizedState : null,
+        stateAbbreviation: isUSStateAbbreviation(normalizedState) ? normalizedState : null,
         zipCode: zipCode,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mailwoman/codex",
-  "version": "6.4.0",
+  "version": "7.0.0",
   "description": "Per-address-system postal reference data + branded types (USPS street suffixes, US ZIP codes). Pure, zero-runtime-dep — the shared canonical home for postal-system primitives the parser, resolver, and synthesis layers all reach for.",
   "license": "AGPL-3.0-only OR LicenseRef-Commercial",
   "repository": {
@@ -116,6 +116,6 @@
     "type-fest": "^5.8.0"
   },
   "devDependencies": {
-    "@mailwoman/annotations": "6.4.0"
+    "@mailwoman/annotations": "7.0.0"
   }
 }