@mailwoman/codex 4.0.0

package/out/us/state.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   US two-letter postal abbreviations for the 50 states, DC, and the five primary territories.
+ *
+ *   This is the minimal state primitive `zipcode.ts` needs (a closed abbreviation set + predicate)
+ *   without pulling in `@mailwoman/tiger`'s FIPS enums and their `shapefile-parser` dependency —
+ *   the point of the codex being a zero-runtime-dep package the browser-pure parser can consume.
+ *   The full FIPS-keyed table still lives in `@mailwoman/tiger` (`tiger/state.ts`) and in the
+ *   corpus TIGER adapter; folding those onto this set is a deliberate follow-up, not a v1 concern.
+ */
+/**
+ * USPS two-letter abbreviations: the 50 states, the District of Columbia, and the five primary
+ * territories (Puerto Rico, Guam, US Virgin Islands, Northern Mariana Islands, American Samoa).
+ */
+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];
+/**
+ * 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;
+//# sourceMappingURL=state.d.ts.map

package/out/us/state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../us/state.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH;;;GAGG;AACH,eAAO,MAAM,sBAAsB,2VAyDG,CAAA;AAEtC,yDAAyD;AACzD,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAA;AAIzE;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,mBAAmB,CAElF"}

package/out/us/state.js

@@ -0,0 +1,84 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   US two-letter postal abbreviations for the 50 states, DC, and the five primary territories.
+ *
+ *   This is the minimal state primitive `zipcode.ts` needs (a closed abbreviation set + predicate)
+ *   without pulling in `@mailwoman/tiger`'s FIPS enums and their `shapefile-parser` dependency —
+ *   the point of the codex being a zero-runtime-dep package the browser-pure parser can consume.
+ *   The full FIPS-keyed table still lives in `@mailwoman/tiger` (`tiger/state.ts`) and in the
+ *   corpus TIGER adapter; folding those onto this set is a deliberate follow-up, not a v1 concern.
+ */
+/**
+ * USPS two-letter abbreviations: the 50 states, the District of Columbia, and the five primary
+ * territories (Puerto Rico, Guam, US Virgin Islands, Northern Mariana Islands, American Samoa).
+ */
+export const US_STATE_ABBREVIATIONS = [
+    "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",
+];
+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) {
+    return typeof input === "string" && STATE_ABBREVIATION_SET.has(input.toUpperCase());
+}
+//# sourceMappingURL=state.js.map

package/out/us/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../../us/state.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACrC,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;CACiC,CAAA;AAKtC,MAAM,sBAAsB,GAAwB,IAAI,GAAG,CAAC,sBAAsB,CAAC,CAAA;AAEnF;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAc;IACnD,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;AACpF,CAAC"}

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

@@ -0,0 +1,499 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   USPS Publication 28, Appendix C — Postal Service Standard Suffix Abbreviations.
+ *
+ *   For each canonical suffix the value lists every recognized variant in USPS-published order; the
+ *   first variant is the preferred USPS abbreviation (e.g. `AVENUE → ["AVE", "AV", "AVEN", "AVENU",
+ *   "AVN", "AVNUE"]` — `AVE` is what the post office prints).
+ *
+ *   This module is the single home for the USPS suffix table. It carries both the synthesis-layer
+ *   helpers (`US_STREET_SUFFIX_PREFERRED_ABBR`, `matchCase`, `matchTrailingSuffix` — used by
+ *   `@mailwoman/corpus`) and the richer branded-type lookup (`StreetSuffix`, `lookupStreetSuffix`,
+ *   `isStreetSuffix`) salvaged from the original isp-nexus `postal/suffix.ts`. The data is verbatim
+ *   USPS Pub-28; the two APIs share one underlying record.
+ *
+ *   Salvaged 2026-05-17 (data) / 2026-06-03 (types) from
+ *   `isp-nexus/universe@6eeb7bd99643a6d62a8b8abbd50968a1e492b90b` `mailwoman/postal/suffix.ts`
+ *   (originally copyright Sister Software; both projects are AGPL-3.0).
+ * @see {@link https://pe.usps.com/text/pub28/28apc_002.htm USPS Street Suffix Abbreviations}
+ */
+/**
+ * Canonical USPS street suffix → list of recognized variants. The first variant in each list is the
+ * preferred USPS abbreviation. Keys + values are uppercase per the publication.
+ */
+export declare const US_STREET_SUFFIX_VARIANTS: {
+    readonly ALLEY: readonly ["ALY", "ALLEE", "ALLY"];
+    readonly ANEX: readonly ["ANX", "ANNEX", "ANNX"];
+    readonly ARCADE: readonly ["ARC"];
+    readonly AVENUE: readonly ["AVE", "AV", "AVEN", "AVENU", "AVN", "AVNUE"];
+    readonly BAYOU: readonly ["BYU", "BAYOO"];
+    readonly BEACH: readonly ["BCH"];
+    readonly BEND: readonly ["BND"];
+    readonly BLUFF: readonly ["BLF", "BLUF"];
+    readonly BLUFFS: readonly ["BLFS"];
+    readonly BOTTOM: readonly ["BTM", "BOT", "BOTTM"];
+    readonly BOULEVARD: readonly ["BLVD", "BOUL", "BOULV"];
+    readonly BRANCH: readonly ["BR", "BRNCH"];
+    readonly BRIDGE: readonly ["BRG", "BRDGE"];
+    readonly BROOK: readonly ["BRK"];
+    readonly BROOKS: readonly ["BRKS"];
+    readonly BURG: readonly ["BG"];
+    readonly BURGS: readonly ["BGS"];
+    readonly BYPASS: readonly ["BYP", "BYPA", "BYPAS", "BYPS"];
+    readonly CAMP: readonly ["CP", "CMP"];
+    readonly CANYON: readonly ["CYN", "CANYN", "CNYN"];
+    readonly CAPE: readonly ["CPE"];
+    readonly CAUSEWAY: readonly ["CSWY", "CAUSWA"];
+    readonly CENTER: readonly ["CTR", "CEN", "CENT", "CENTR", "CENTRE", "CNTER", "CNTR"];
+    readonly CENTERS: readonly ["CTRS"];
+    readonly CIRCLE: readonly ["CIR", "CIRC", "CIRCL", "CRCL", "CRCLE"];
+    readonly CIRCLES: readonly ["CIRS"];
+    readonly CLIFF: readonly ["CLF"];
+    readonly CLIFFS: readonly ["CLFS"];
+    readonly CLUB: readonly ["CLB"];
+    readonly COMMON: readonly ["CMN"];
+    readonly COMMONS: readonly ["CMNS"];
+    readonly CORNER: readonly ["COR"];
+    readonly CORNERS: readonly ["CORS"];
+    readonly COURSE: readonly ["CRSE"];
+    readonly COURT: readonly ["CT"];
+    readonly COURTS: readonly ["CTS"];
+    readonly COVE: readonly ["CV"];
+    readonly COVES: readonly ["CVS"];
+    readonly CREEK: readonly ["CRK"];
+    readonly CRESCENT: readonly ["CRES", "CRSENT", "CRSNT"];
+    readonly CREST: readonly ["CRST"];
+    readonly CROSSING: readonly ["XING", "CRSSNG"];
+    readonly CROSSROAD: readonly ["XRD"];
+    readonly CROSSROADS: readonly ["XRDS"];
+    readonly CURVE: readonly ["CURV"];
+    readonly DALE: readonly ["DL"];
+    readonly DAM: readonly ["DM"];
+    readonly DIVIDE: readonly ["DV", "DIV", "DVD"];
+    readonly DRIVE: readonly ["DR", "DRIV", "DRV"];
+    readonly DRIVES: readonly ["DRS"];
+    readonly ESTATE: readonly ["EST"];
+    readonly ESTATES: readonly ["ESTS"];
+    readonly EXPRESSWAY: readonly ["EXPY", "EXP", "EXPR", "EXPRESS", "EXPW"];
+    readonly EXTENSION: readonly ["EXT", "EXTN", "EXTNSN"];
+    readonly EXTENSIONS: readonly ["EXTS"];
+    readonly FALL: readonly ["FALL"];
+    readonly FALLS: readonly ["FLS"];
+    readonly FERRY: readonly ["FRY", "FRRY"];
+    readonly FIELD: readonly ["FLD"];
+    readonly FIELDS: readonly ["FLDS"];
+    readonly FLAT: readonly ["FLT"];
+    readonly FLATS: readonly ["FLTS"];
+    readonly FORD: readonly ["FRD"];
+    readonly FORDS: readonly ["FRDS"];
+    readonly FOREST: readonly ["FRST", "FORESTS"];
+    readonly FORGE: readonly ["FRG", "FORG"];
+    readonly FORGES: readonly ["FRGS"];
+    readonly FORK: readonly ["FRK"];
+    readonly FORKS: readonly ["FRKS"];
+    readonly FORT: readonly ["FT", "FRT"];
+    readonly FREEWAY: readonly ["FWY", "FREEWY", "FRWAY", "FRWY"];
+    readonly GARDEN: readonly ["GDN", "GARDN", "GRDEN", "GRDN"];
+    readonly GARDENS: readonly ["GDNS", "GRDNS"];
+    readonly GATEWAY: readonly ["GTWY", "GATEWY", "GATWAY", "GTWAY"];
+    readonly GLEN: readonly ["GLN"];
+    readonly GLENS: readonly ["GLNS"];
+    readonly GREEN: readonly ["GRN"];
+    readonly GREENS: readonly ["GRNS"];
+    readonly GROVE: readonly ["GRV", "GROV"];
+    readonly GROVES: readonly ["GRVS"];
+    readonly HARBOR: readonly ["HBR", "HARB", "HARBR", "HRBOR"];
+    readonly HARBORS: readonly ["HBRS"];
+    readonly HAVEN: readonly ["HVN"];
+    readonly HEIGHTS: readonly ["HTS", "HT"];
+    readonly HIGHWAY: readonly ["HWY", "HIGHWY", "HIWAY", "HIWY", "HWAY"];
+    readonly HILL: readonly ["HL"];
+    readonly HILLS: readonly ["HLS"];
+    readonly HOLLOW: readonly ["HOLW", "HLLW", "HOLLOWS", "HOLWS"];
+    readonly INLET: readonly ["INLT"];
+    readonly ISLAND: readonly ["IS", "ISLND"];
+    readonly ISLANDS: readonly ["ISS", "ISLNDS"];
+    readonly ISLE: readonly ["ISLE", "ISLES"];
+    readonly JUNCTION: readonly ["JCT", "JCTION", "JCTN", "JUNCTN", "JUNCTON"];
+    readonly JUNCTIONS: readonly ["JCTS", "JCTNS"];
+    readonly KEY: readonly ["KY"];
+    readonly KEYS: readonly ["KYS"];
+    readonly KNOLL: readonly ["KNL", "KNOL"];
+    readonly KNOLLS: readonly ["KNLS"];
+    readonly LAKE: readonly ["LK"];
+    readonly LAKES: readonly ["LKS"];
+    readonly LAND: readonly ["LAND"];
+    readonly LANDING: readonly ["LNDG", "LNDNG"];
+    readonly LANE: readonly ["LN"];
+    readonly LIGHT: readonly ["LGT"];
+    readonly LIGHTS: readonly ["LGTS"];
+    readonly LOAF: readonly ["LF"];
+    readonly LOCK: readonly ["LCK"];
+    readonly LOCKS: readonly ["LCKS"];
+    readonly LODGE: readonly ["LDG", "LDGE", "LODG"];
+    readonly LOOP: readonly ["LOOP", "LOOPS"];
+    readonly MALL: readonly ["MALL"];
+    readonly MANOR: readonly ["MNR"];
+    readonly MANORS: readonly ["MNRS"];
+    readonly MEADOW: readonly ["MDW"];
+    readonly MEADOWS: readonly ["MDWS", "MDW", "MEDOWS"];
+    readonly MEWS: readonly ["MEWS"];
+    readonly MILL: readonly ["ML"];
+    readonly MILLS: readonly ["MLS"];
+    readonly MISSION: readonly ["MSN", "MISSN", "MSSN"];
+    readonly MOTORWAY: readonly ["MTWY"];
+    readonly MOUNT: readonly ["MT", "MNT"];
+    readonly MOUNTAIN: readonly ["MTN", "MNTAIN", "MNTN", "MOUNTIN", "MTIN"];
+    readonly MOUNTAINS: readonly ["MTNS", "MNTNS"];
+    readonly NECK: readonly ["NCK"];
+    readonly ORCHARD: readonly ["ORCH", "ORCHRD"];
+    readonly OVAL: readonly ["OVAL", "OVL"];
+    readonly OVERPASS: readonly ["OPAS"];
+    readonly PARK: readonly ["PARK", "PRK", "PARKS"];
+    readonly PARKWAY: readonly ["PKWY", "PARKWY", "PKWAY", "PKY"];
+    readonly PARKWAYS: readonly ["PKWY", "PKWYS"];
+    readonly PASS: readonly ["PASS"];
+    readonly PASSAGE: readonly ["PSGE"];
+    readonly PATH: readonly ["PATH", "PATHS"];
+    readonly PIKE: readonly ["PIKE", "PIKES"];
+    readonly PINE: readonly ["PNE"];
+    readonly PINES: readonly ["PNES"];
+    readonly PLACE: readonly ["PL"];
+    readonly PLAIN: readonly ["PLN"];
+    readonly PLAINS: readonly ["PLNS"];
+    readonly PLAZA: readonly ["PLZ", "PLZA"];
+    readonly POINT: readonly ["PT"];
+    readonly POINTS: readonly ["PTS"];
+    readonly PORT: readonly ["PRT"];
+    readonly PORTS: readonly ["PRTS"];
+    readonly PRAIRIE: readonly ["PR", "PRR"];
+    readonly RADIAL: readonly ["RADL", "RAD", "RADIEL"];
+    readonly RAMP: readonly ["RAMP"];
+    readonly RANCH: readonly ["RNCH", "RANCHES", "RNCHS"];
+    readonly RAPID: readonly ["RPD"];
+    readonly RAPIDS: readonly ["RPDS"];
+    readonly REST: readonly ["RST"];
+    readonly RIDGE: readonly ["RDG", "RDGE"];
+    readonly RIDGES: readonly ["RDGS"];
+    readonly RIVER: readonly ["RIV", "RVR", "RIVR"];
+    readonly ROAD: readonly ["RD"];
+    readonly ROADS: readonly ["RDS"];
+    readonly ROUTE: readonly ["RTE"];
+    readonly ROW: readonly ["ROW"];
+    readonly RUE: readonly ["RUE"];
+    readonly RUN: readonly ["RUN"];
+    readonly SHOAL: readonly ["SHL"];
+    readonly SHOALS: readonly ["SHLS"];
+    readonly SHORE: readonly ["SHR", "SHOAR"];
+    readonly SHORES: readonly ["SHRS", "SHOARS"];
+    readonly SKYWAY: readonly ["SKWY"];
+    readonly SPRING: readonly ["SPG", "SPNG", "SPRNG"];
+    readonly SPRINGS: readonly ["SPGS", "SPNGS", "SPRNGS"];
+    readonly SPUR: readonly ["SPUR"];
+    readonly SPURS: readonly ["SPUR"];
+    readonly SQUARE: readonly ["SQ", "SQR", "SQRE", "SQU"];
+    readonly SQUARES: readonly ["SQS", "SQRS"];
+    readonly STATION: readonly ["STA", "STATN", "STN"];
+    readonly STRAVENUE: readonly ["STRA", "STRAV", "STRAVEN", "STRAVN", "STRVN", "STRVNUE"];
+    readonly STREAM: readonly ["STRM", "STREME"];
+    readonly STREET: readonly ["ST", "STRT", "STR"];
+    readonly STREETS: readonly ["STS"];
+    readonly SUMMIT: readonly ["SMT", "SUMIT", "SUMITT"];
+    readonly TERRACE: readonly ["TER", "TERR"];
+    readonly THROUGHWAY: readonly ["TRWY"];
+    readonly TRACE: readonly ["TRCE", "TRACES"];
+    readonly TRACK: readonly ["TRAK", "TRACKS", "TRK", "TRKS"];
+    readonly TRAFFICWAY: readonly ["TRFY"];
+    readonly TRAIL: readonly ["TRL", "TRAILS", "TRLS"];
+    readonly TRAILER: readonly ["TRLR", "TRLRS"];
+    readonly TUNNEL: readonly ["TUNL", "TUNEL", "TUNLS", "TUNNELS", "TUNNL"];
+    readonly TURNPIKE: readonly ["TPKE", "TRNPK", "TURNPK"];
+    readonly UNDERPASS: readonly ["UPAS"];
+    readonly UNION: readonly ["UN"];
+    readonly UNIONS: readonly ["UNS"];
+    readonly VALLEY: readonly ["VLY", "VALLY", "VLLY"];
+    readonly VALLEYS: readonly ["VLYS"];
+    readonly VIADUCT: readonly ["VIA", "VDCT", "VIADCT"];
+    readonly VIEW: readonly ["VW"];
+    readonly VIEWS: readonly ["VWS"];
+    readonly VILLAGE: readonly ["VLG", "VILL", "VILLAG", "VILLG", "VILLIAGE"];
+    readonly VILLAGES: readonly ["VLGS"];
+    readonly VILLE: readonly ["VL"];
+    readonly VISTA: readonly ["VIS", "VIST", "VST", "VSTA"];
+    readonly WALK: readonly ["WALK"];
+    readonly WALKS: readonly ["WALK"];
+    readonly WALL: readonly ["WALL"];
+    readonly WAY: readonly ["WAY", "WY"];
+    readonly WAYS: readonly ["WAYS"];
+    readonly WELL: readonly ["WL"];
+    readonly WELLS: readonly ["WLS"];
+};
+/** Canonical USPS suffix (full word, uppercase per the publication). */
+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>;
+/** Preferred USPS abbreviation per canonical (`AVENUE → "AVE"`, `STREET → "ST"`). */
+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:
+ *
+ * - All-uppercase reference (`"AVE"`) → uppercase target (`"AVENUE"`).
+ * - All-lowercase reference (`"ave"`) → lowercase target (`"avenue"`).
+ * - Anything else (`"Ave"`, `"aVe"`) → title-case target (`"Avenue"`).
+ */
+export declare function matchCase(target: string, reference: string): string;
+/**
+ * If the last whitespace-separated word of `street` is a known USPS suffix variant, return the
+ * canonical key and the matched word. Returns null if the trailing word isn't a known suffix.
+ */
+export declare function matchTrailingSuffix(street: string): {
+    canonical: UsStreetSuffix;
+    matched: string;
+} | null;
+/**
+ * The USPS suffix record, under its original isp-nexus name. Aliases
+ * {@link US_STREET_SUFFIX_VARIANTS}.
+ */
+export declare const StreetSuffixAbbreviationRecord: {
+    readonly ALLEY: readonly ["ALY", "ALLEE", "ALLY"];
+    readonly ANEX: readonly ["ANX", "ANNEX", "ANNX"];
+    readonly ARCADE: readonly ["ARC"];
+    readonly AVENUE: readonly ["AVE", "AV", "AVEN", "AVENU", "AVN", "AVNUE"];
+    readonly BAYOU: readonly ["BYU", "BAYOO"];
+    readonly BEACH: readonly ["BCH"];
+    readonly BEND: readonly ["BND"];
+    readonly BLUFF: readonly ["BLF", "BLUF"];
+    readonly BLUFFS: readonly ["BLFS"];
+    readonly BOTTOM: readonly ["BTM", "BOT", "BOTTM"];
+    readonly BOULEVARD: readonly ["BLVD", "BOUL", "BOULV"];
+    readonly BRANCH: readonly ["BR", "BRNCH"];
+    readonly BRIDGE: readonly ["BRG", "BRDGE"];
+    readonly BROOK: readonly ["BRK"];
+    readonly BROOKS: readonly ["BRKS"];
+    readonly BURG: readonly ["BG"];
+    readonly BURGS: readonly ["BGS"];
+    readonly BYPASS: readonly ["BYP", "BYPA", "BYPAS", "BYPS"];
+    readonly CAMP: readonly ["CP", "CMP"];
+    readonly CANYON: readonly ["CYN", "CANYN", "CNYN"];
+    readonly CAPE: readonly ["CPE"];
+    readonly CAUSEWAY: readonly ["CSWY", "CAUSWA"];
+    readonly CENTER: readonly ["CTR", "CEN", "CENT", "CENTR", "CENTRE", "CNTER", "CNTR"];
+    readonly CENTERS: readonly ["CTRS"];
+    readonly CIRCLE: readonly ["CIR", "CIRC", "CIRCL", "CRCL", "CRCLE"];
+    readonly CIRCLES: readonly ["CIRS"];
+    readonly CLIFF: readonly ["CLF"];
+    readonly CLIFFS: readonly ["CLFS"];
+    readonly CLUB: readonly ["CLB"];
+    readonly COMMON: readonly ["CMN"];
+    readonly COMMONS: readonly ["CMNS"];
+    readonly CORNER: readonly ["COR"];
+    readonly CORNERS: readonly ["CORS"];
+    readonly COURSE: readonly ["CRSE"];
+    readonly COURT: readonly ["CT"];
+    readonly COURTS: readonly ["CTS"];
+    readonly COVE: readonly ["CV"];
+    readonly COVES: readonly ["CVS"];
+    readonly CREEK: readonly ["CRK"];
+    readonly CRESCENT: readonly ["CRES", "CRSENT", "CRSNT"];
+    readonly CREST: readonly ["CRST"];
+    readonly CROSSING: readonly ["XING", "CRSSNG"];
+    readonly CROSSROAD: readonly ["XRD"];
+    readonly CROSSROADS: readonly ["XRDS"];
+    readonly CURVE: readonly ["CURV"];
+    readonly DALE: readonly ["DL"];
+    readonly DAM: readonly ["DM"];
+    readonly DIVIDE: readonly ["DV", "DIV", "DVD"];
+    readonly DRIVE: readonly ["DR", "DRIV", "DRV"];
+    readonly DRIVES: readonly ["DRS"];
+    readonly ESTATE: readonly ["EST"];
+    readonly ESTATES: readonly ["ESTS"];
+    readonly EXPRESSWAY: readonly ["EXPY", "EXP", "EXPR", "EXPRESS", "EXPW"];
+    readonly EXTENSION: readonly ["EXT", "EXTN", "EXTNSN"];
+    readonly EXTENSIONS: readonly ["EXTS"];
+    readonly FALL: readonly ["FALL"];
+    readonly FALLS: readonly ["FLS"];
+    readonly FERRY: readonly ["FRY", "FRRY"];
+    readonly FIELD: readonly ["FLD"];
+    readonly FIELDS: readonly ["FLDS"];
+    readonly FLAT: readonly ["FLT"];
+    readonly FLATS: readonly ["FLTS"];
+    readonly FORD: readonly ["FRD"];
+    readonly FORDS: readonly ["FRDS"];
+    readonly FOREST: readonly ["FRST", "FORESTS"];
+    readonly FORGE: readonly ["FRG", "FORG"];
+    readonly FORGES: readonly ["FRGS"];
+    readonly FORK: readonly ["FRK"];
+    readonly FORKS: readonly ["FRKS"];
+    readonly FORT: readonly ["FT", "FRT"];
+    readonly FREEWAY: readonly ["FWY", "FREEWY", "FRWAY", "FRWY"];
+    readonly GARDEN: readonly ["GDN", "GARDN", "GRDEN", "GRDN"];
+    readonly GARDENS: readonly ["GDNS", "GRDNS"];
+    readonly GATEWAY: readonly ["GTWY", "GATEWY", "GATWAY", "GTWAY"];
+    readonly GLEN: readonly ["GLN"];
+    readonly GLENS: readonly ["GLNS"];
+    readonly GREEN: readonly ["GRN"];
+    readonly GREENS: readonly ["GRNS"];
+    readonly GROVE: readonly ["GRV", "GROV"];
+    readonly GROVES: readonly ["GRVS"];
+    readonly HARBOR: readonly ["HBR", "HARB", "HARBR", "HRBOR"];
+    readonly HARBORS: readonly ["HBRS"];
+    readonly HAVEN: readonly ["HVN"];
+    readonly HEIGHTS: readonly ["HTS", "HT"];
+    readonly HIGHWAY: readonly ["HWY", "HIGHWY", "HIWAY", "HIWY", "HWAY"];
+    readonly HILL: readonly ["HL"];
+    readonly HILLS: readonly ["HLS"];
+    readonly HOLLOW: readonly ["HOLW", "HLLW", "HOLLOWS", "HOLWS"];
+    readonly INLET: readonly ["INLT"];
+    readonly ISLAND: readonly ["IS", "ISLND"];
+    readonly ISLANDS: readonly ["ISS", "ISLNDS"];
+    readonly ISLE: readonly ["ISLE", "ISLES"];
+    readonly JUNCTION: readonly ["JCT", "JCTION", "JCTN", "JUNCTN", "JUNCTON"];
+    readonly JUNCTIONS: readonly ["JCTS", "JCTNS"];
+    readonly KEY: readonly ["KY"];
+    readonly KEYS: readonly ["KYS"];
+    readonly KNOLL: readonly ["KNL", "KNOL"];
+    readonly KNOLLS: readonly ["KNLS"];
+    readonly LAKE: readonly ["LK"];
+    readonly LAKES: readonly ["LKS"];
+    readonly LAND: readonly ["LAND"];
+    readonly LANDING: readonly ["LNDG", "LNDNG"];
+    readonly LANE: readonly ["LN"];
+    readonly LIGHT: readonly ["LGT"];
+    readonly LIGHTS: readonly ["LGTS"];
+    readonly LOAF: readonly ["LF"];
+    readonly LOCK: readonly ["LCK"];
+    readonly LOCKS: readonly ["LCKS"];
+    readonly LODGE: readonly ["LDG", "LDGE", "LODG"];
+    readonly LOOP: readonly ["LOOP", "LOOPS"];
+    readonly MALL: readonly ["MALL"];
+    readonly MANOR: readonly ["MNR"];
+    readonly MANORS: readonly ["MNRS"];
+    readonly MEADOW: readonly ["MDW"];
+    readonly MEADOWS: readonly ["MDWS", "MDW", "MEDOWS"];
+    readonly MEWS: readonly ["MEWS"];
+    readonly MILL: readonly ["ML"];
+    readonly MILLS: readonly ["MLS"];
+    readonly MISSION: readonly ["MSN", "MISSN", "MSSN"];
+    readonly MOTORWAY: readonly ["MTWY"];
+    readonly MOUNT: readonly ["MT", "MNT"];
+    readonly MOUNTAIN: readonly ["MTN", "MNTAIN", "MNTN", "MOUNTIN", "MTIN"];
+    readonly MOUNTAINS: readonly ["MTNS", "MNTNS"];
+    readonly NECK: readonly ["NCK"];
+    readonly ORCHARD: readonly ["ORCH", "ORCHRD"];
+    readonly OVAL: readonly ["OVAL", "OVL"];
+    readonly OVERPASS: readonly ["OPAS"];
+    readonly PARK: readonly ["PARK", "PRK", "PARKS"];
+    readonly PARKWAY: readonly ["PKWY", "PARKWY", "PKWAY", "PKY"];
+    readonly PARKWAYS: readonly ["PKWY", "PKWYS"];
+    readonly PASS: readonly ["PASS"];
+    readonly PASSAGE: readonly ["PSGE"];
+    readonly PATH: readonly ["PATH", "PATHS"];
+    readonly PIKE: readonly ["PIKE", "PIKES"];
+    readonly PINE: readonly ["PNE"];
+    readonly PINES: readonly ["PNES"];
+    readonly PLACE: readonly ["PL"];
+    readonly PLAIN: readonly ["PLN"];
+    readonly PLAINS: readonly ["PLNS"];
+    readonly PLAZA: readonly ["PLZ", "PLZA"];
+    readonly POINT: readonly ["PT"];
+    readonly POINTS: readonly ["PTS"];
+    readonly PORT: readonly ["PRT"];
+    readonly PORTS: readonly ["PRTS"];
+    readonly PRAIRIE: readonly ["PR", "PRR"];
+    readonly RADIAL: readonly ["RADL", "RAD", "RADIEL"];
+    readonly RAMP: readonly ["RAMP"];
+    readonly RANCH: readonly ["RNCH", "RANCHES", "RNCHS"];
+    readonly RAPID: readonly ["RPD"];
+    readonly RAPIDS: readonly ["RPDS"];
+    readonly REST: readonly ["RST"];
+    readonly RIDGE: readonly ["RDG", "RDGE"];
+    readonly RIDGES: readonly ["RDGS"];
+    readonly RIVER: readonly ["RIV", "RVR", "RIVR"];
+    readonly ROAD: readonly ["RD"];
+    readonly ROADS: readonly ["RDS"];
+    readonly ROUTE: readonly ["RTE"];
+    readonly ROW: readonly ["ROW"];
+    readonly RUE: readonly ["RUE"];
+    readonly RUN: readonly ["RUN"];
+    readonly SHOAL: readonly ["SHL"];
+    readonly SHOALS: readonly ["SHLS"];
+    readonly SHORE: readonly ["SHR", "SHOAR"];
+    readonly SHORES: readonly ["SHRS", "SHOARS"];
+    readonly SKYWAY: readonly ["SKWY"];
+    readonly SPRING: readonly ["SPG", "SPNG", "SPRNG"];
+    readonly SPRINGS: readonly ["SPGS", "SPNGS", "SPRNGS"];
+    readonly SPUR: readonly ["SPUR"];
+    readonly SPURS: readonly ["SPUR"];
+    readonly SQUARE: readonly ["SQ", "SQR", "SQRE", "SQU"];
+    readonly SQUARES: readonly ["SQS", "SQRS"];
+    readonly STATION: readonly ["STA", "STATN", "STN"];
+    readonly STRAVENUE: readonly ["STRA", "STRAV", "STRAVEN", "STRAVN", "STRVN", "STRVNUE"];
+    readonly STREAM: readonly ["STRM", "STREME"];
+    readonly STREET: readonly ["ST", "STRT", "STR"];
+    readonly STREETS: readonly ["STS"];
+    readonly SUMMIT: readonly ["SMT", "SUMIT", "SUMITT"];
+    readonly TERRACE: readonly ["TER", "TERR"];
+    readonly THROUGHWAY: readonly ["TRWY"];
+    readonly TRACE: readonly ["TRCE", "TRACES"];
+    readonly TRACK: readonly ["TRAK", "TRACKS", "TRK", "TRKS"];
+    readonly TRAFFICWAY: readonly ["TRFY"];
+    readonly TRAIL: readonly ["TRL", "TRAILS", "TRLS"];
+    readonly TRAILER: readonly ["TRLR", "TRLRS"];
+    readonly TUNNEL: readonly ["TUNL", "TUNEL", "TUNLS", "TUNNELS", "TUNNL"];
+    readonly TURNPIKE: readonly ["TPKE", "TRNPK", "TURNPK"];
+    readonly UNDERPASS: readonly ["UPAS"];
+    readonly UNION: readonly ["UN"];
+    readonly UNIONS: readonly ["UNS"];
+    readonly VALLEY: readonly ["VLY", "VALLY", "VLLY"];
+    readonly VALLEYS: readonly ["VLYS"];
+    readonly VIADUCT: readonly ["VIA", "VDCT", "VIADCT"];
+    readonly VIEW: readonly ["VW"];
+    readonly VIEWS: readonly ["VWS"];
+    readonly VILLAGE: readonly ["VLG", "VILL", "VILLAG", "VILLG", "VILLIAGE"];
+    readonly VILLAGES: readonly ["VLGS"];
+    readonly VILLE: readonly ["VL"];
+    readonly VISTA: readonly ["VIS", "VIST", "VST", "VSTA"];
+    readonly WALK: readonly ["WALK"];
+    readonly WALKS: readonly ["WALK"];
+    readonly WALL: readonly ["WALL"];
+    readonly WAY: readonly ["WAY", "WY"];
+    readonly WAYS: readonly ["WAYS"];
+    readonly WELL: readonly ["WL"];
+    readonly WELLS: readonly ["WLS"];
+};
+export type StreetSuffixAbbreviationRecord = typeof US_STREET_SUFFIX_VARIANTS;
+/** A canonical USPS street suffix, i.e. "STREET", "AVENUE", "BOULEVARD". Aliases
+{@link 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. */
+export type StreetSuffixAbbreviation = StreetSuffixAbbreviationRecord[StreetSuffix][number];
+/** Result of a successful USPS street suffix lookup. */
+export interface StreetSuffixMatch<S extends StreetSuffix = StreetSuffix> {
+    /** The matched canonical USPS street suffix, i.e. "STREET", "AVENUE". */
+    suffix: S;
+    /** The preferred USPS street suffix abbreviation, i.e. "ST", "AVE". */
+    abbreviation: StreetSuffixAbbreviationRecord[S][0];
+}
+/**
+ * Look up a USPS street suffix (by canonical word, abbreviation, or any variant) and its preferred
+ * abbreviation.
+ */
+export declare function lookupStreetSuffix<S extends StreetSuffix>(suffix: S): StreetSuffixMatch<S>;
+export declare function lookupStreetSuffix(input: string | null | undefined): StreetSuffixMatch | null;
+/** Type-predicate: is the input a canonical USPS street suffix (uppercase full word, e.g. "STREET")? */
+export declare function isStreetSuffix(input: unknown): input is StreetSuffix;
+/**
+ * True when a token is any USPS street suffix or abbreviation (case-insensitive) — `"St"`,
+ * `"BLVD"`, `"trail"`.
+ */
+export declare function isStreetSuffixToken(input: unknown): boolean;
+//# sourceMappingURL=street-suffix.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"street-suffix.d.ts","sourceRoot":"","sources":["../../us/street-suffix.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;GAGG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8MgB,CAAA;AAEtD,wEAAwE;AACxE,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,yBAAyB,CAAA;AAEnE;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,WAAW,CAAC,MAAM,EAAE,cAAc,CAYpE,CAAA;AAEJ,qFAAqF;AACrF,eAAO,MAAM,+BAA+B,EAAE,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAExC,CAAA;AAE7C;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAKnE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG;IAAE,SAAS,EAAE,cAAc,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAQzG;AAMD;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA4B,CAAA;AACvE,MAAM,MAAM,8BAA8B,GAAG,OAAO,yBAAyB,CAAA;AAE7E;0BAC0B;AAC1B,MAAM,MAAM,YAAY,GAAG,cAAc,CAAA;AAEzC,qGAAqG;AACrG,MAAM,MAAM,8BAA8B,GAAG,8BAA8B,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;AAE5F,0DAA0D;AAC1D,MAAM,MAAM,wBAAwB,GAAG,8BAA8B,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3F,wDAAwD;AACxD,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY;IACvE,yEAAyE;IACzE,MAAM,EAAE,CAAC,CAAA;IACT,uEAAuE;IACvE,YAAY,EAAE,8BAA8B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAClD;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,YAAY,EAAE,MAAM,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAA;AAC3F,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,iBAAiB,GAAG,IAAI,CAAA;AAQ9F,wGAAwG;AACxG,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY,CAEpE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAE3D"}