@mailwoman/codex 4.16.1 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/address-system-conventions.d.ts +5 -5
- package/out/address-system-conventions.d.ts.map +1 -1
- package/out/address-system-conventions.js +15 -18
- package/out/address-system-conventions.js.map +1 -1
- package/out/au/delivery-service.d.ts +13 -16
- package/out/au/delivery-service.d.ts.map +1 -1
- package/out/au/delivery-service.js +13 -15
- package/out/au/delivery-service.js.map +1 -1
- package/out/au/level-designator.d.ts +20 -21
- package/out/au/level-designator.d.ts.map +1 -1
- package/out/au/level-designator.js +15 -15
- package/out/au/level-designator.js.map +1 -1
- package/out/au/postcode.d.ts.map +1 -1
- package/out/au/postcode.js.map +1 -1
- package/out/ca/postal-code.d.ts +18 -20
- package/out/ca/postal-code.d.ts.map +1 -1
- package/out/ca/postal-code.js +15 -17
- package/out/ca/postal-code.js.map +1 -1
- package/out/ca/province.d.ts +8 -8
- package/out/ca/province.d.ts.map +1 -1
- package/out/ca/province.js +8 -8
- package/out/ca/province.js.map +1 -1
- package/out/ca/street-type.d.ts +15 -17
- package/out/ca/street-type.d.ts.map +1 -1
- package/out/ca/street-type.js +15 -17
- package/out/ca/street-type.js.map +1 -1
- package/out/country/country.d.ts +12 -13
- package/out/country/country.d.ts.map +1 -1
- package/out/country/country.js +17 -15
- package/out/country/country.js.map +1 -1
- package/out/country/names.d.ts +1 -1
- package/out/country/names.js +1 -1
- package/out/country/reference-data.d.ts +1 -1
- package/out/country/reference-data.js +1 -1
- package/out/country/reference.d.ts +4 -4
- package/out/country/reference.d.ts.map +1 -1
- package/out/country/reference.js +4 -4
- package/out/country/reference.js.map +1 -1
- package/out/de/bundesland.d.ts +8 -8
- package/out/de/bundesland.d.ts.map +1 -1
- package/out/de/bundesland.js +8 -8
- package/out/de/bundesland.js.map +1 -1
- package/out/de/postleitzahl.d.ts +7 -9
- package/out/de/postleitzahl.d.ts.map +1 -1
- package/out/de/postleitzahl.js +5 -7
- package/out/de/postleitzahl.js.map +1 -1
- package/out/de/street-type.d.ts +9 -10
- package/out/de/street-type.d.ts.map +1 -1
- package/out/de/street-type.js +9 -10
- package/out/de/street-type.js.map +1 -1
- package/out/fr/cedex.d.ts +2 -3
- package/out/fr/cedex.d.ts.map +1 -1
- package/out/fr/cedex.js +2 -3
- package/out/fr/cedex.js.map +1 -1
- package/out/fr/code-postal.d.ts +8 -11
- package/out/fr/code-postal.d.ts.map +1 -1
- package/out/fr/code-postal.js +6 -9
- package/out/fr/code-postal.js.map +1 -1
- package/out/fr/departement.d.ts +1 -2
- package/out/fr/departement.d.ts.map +1 -1
- package/out/fr/departement.js +1 -2
- package/out/fr/departement.js.map +1 -1
- package/out/fr/region.d.ts +5 -6
- package/out/fr/region.d.ts.map +1 -1
- package/out/fr/region.js +5 -6
- package/out/fr/region.js.map +1 -1
- package/out/fr/voie.d.ts +5 -5
- package/out/fr/voie.d.ts.map +1 -1
- package/out/fr/voie.js +7 -7
- package/out/fr/voie.js.map +1 -1
- package/out/gb/country.d.ts +2 -2
- package/out/gb/country.d.ts.map +1 -1
- package/out/gb/country.js +2 -2
- package/out/gb/country.js.map +1 -1
- package/out/gb/postcode-area.d.ts +10 -12
- package/out/gb/postcode-area.d.ts.map +1 -1
- package/out/gb/postcode-area.js +14 -16
- package/out/gb/postcode-area.js.map +1 -1
- package/out/gb/postcode.d.ts +17 -18
- package/out/gb/postcode.d.ts.map +1 -1
- package/out/gb/postcode.js +14 -15
- package/out/gb/postcode.js.map +1 -1
- package/out/gb/street-type.d.ts +6 -7
- package/out/gb/street-type.d.ts.map +1 -1
- package/out/gb/street-type.js +6 -7
- package/out/gb/street-type.js.map +1 -1
- package/out/jp/address-unit.d.ts +8 -9
- package/out/jp/address-unit.d.ts.map +1 -1
- package/out/jp/address-unit.js +8 -9
- package/out/jp/address-unit.js.map +1 -1
- package/out/jp/postal-code.d.ts +12 -15
- package/out/jp/postal-code.d.ts.map +1 -1
- package/out/jp/postal-code.js +9 -12
- package/out/jp/postal-code.js.map +1 -1
- package/out/jp/prefecture.d.ts +7 -7
- package/out/jp/prefecture.d.ts.map +1 -1
- package/out/jp/prefecture.js +15 -16
- package/out/jp/prefecture.js.map +1 -1
- package/out/nz/delivery-service.d.ts +28 -31
- package/out/nz/delivery-service.d.ts.map +1 -1
- package/out/nz/delivery-service.js +25 -29
- package/out/nz/delivery-service.js.map +1 -1
- package/out/nz/postcode.d.ts.map +1 -1
- package/out/nz/postcode.js.map +1 -1
- package/out/postcode-systems.d.ts +3 -3
- package/out/postcode-systems.d.ts.map +1 -1
- package/out/postcode-systems.js +6 -7
- package/out/postcode-systems.js.map +1 -1
- package/out/us/floor-designator.d.ts +15 -18
- package/out/us/floor-designator.d.ts.map +1 -1
- package/out/us/floor-designator.js +11 -13
- package/out/us/floor-designator.js.map +1 -1
- package/out/us/military-address.d.ts +16 -17
- package/out/us/military-address.d.ts.map +1 -1
- package/out/us/military-address.js +16 -17
- package/out/us/military-address.js.map +1 -1
- package/out/us/po-box.d.ts +12 -12
- package/out/us/po-box.d.ts.map +1 -1
- package/out/us/po-box.js +12 -12
- package/out/us/po-box.js.map +1 -1
- package/out/us/state.d.ts +7 -8
- package/out/us/state.d.ts.map +1 -1
- package/out/us/state.js +7 -8
- package/out/us/state.js.map +1 -1
- package/out/us/street-directional.d.ts +9 -11
- package/out/us/street-directional.d.ts.map +1 -1
- package/out/us/street-directional.js +9 -11
- package/out/us/street-directional.js.map +1 -1
- package/out/us/street-suffix.d.ts +10 -15
- package/out/us/street-suffix.d.ts.map +1 -1
- package/out/us/street-suffix.js +8 -11
- package/out/us/street-suffix.js.map +1 -1
- package/out/us/unit-designator.d.ts +12 -15
- package/out/us/unit-designator.d.ts.map +1 -1
- package/out/us/unit-designator.js +10 -13
- package/out/us/unit-designator.js.map +1 -1
- package/out/us/zipcode.d.ts +16 -19
- package/out/us/zipcode.d.ts.map +1 -1
- package/out/us/zipcode.js +6 -6
- package/out/us/zipcode.js.map +1 -1
- package/package.json +11 -11
|
@@ -20,10 +20,9 @@
|
|
|
20
20
|
* @see {@link https://pe.usps.com/text/pub28/28apc_003.htm USPS Secondary Unit Designators}
|
|
21
21
|
*/
|
|
22
22
|
/**
|
|
23
|
-
* Canonical USPS secondary unit designator → recognized variants. The first variant is the approved
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* both included — synthesis treats them uniformly.
|
|
23
|
+
* Canonical USPS secondary unit designator → recognized variants. The first variant is the approved USPS abbreviation.
|
|
24
|
+
* Keys + values uppercase per the publication. The designators marked by USPS as "requires a secondary number" (APT,
|
|
25
|
+
* BLDG, FL, …) and the standalone ones (BSMT, LBBY, PH, …) are both included — synthesis treats them uniformly.
|
|
27
26
|
*/
|
|
28
27
|
export declare const US_UNIT_DESIGNATOR_VARIANTS: {
|
|
29
28
|
readonly APARTMENT: readonly ["APT", "APRT", "APMT"];
|
|
@@ -54,18 +53,16 @@ export declare const US_UNIT_DESIGNATOR_VARIANTS: {
|
|
|
54
53
|
/** Canonical USPS secondary unit designator (full word, uppercase per the publication). */
|
|
55
54
|
export type UsUnitDesignator = keyof typeof US_UNIT_DESIGNATOR_VARIANTS;
|
|
56
55
|
/**
|
|
57
|
-
* Inverse lookup: every variant abbreviation OR full canonical word → its canonical key, built once
|
|
58
|
-
*
|
|
59
|
-
* `"SUITE"`, `suite` → `"SUITE"`).
|
|
56
|
+
* Inverse lookup: every variant abbreviation OR full canonical word → its canonical key, built once at module load,
|
|
57
|
+
* lowercase-keyed for case-insensitive matching (`apt` → `"APARTMENT"`, `ste` → `"SUITE"`, `suite` → `"SUITE"`).
|
|
60
58
|
*/
|
|
61
59
|
export declare const US_UNIT_DESIGNATOR_LOOKUP: ReadonlyMap<string, UsUnitDesignator>;
|
|
62
60
|
/** Approved USPS abbreviation per canonical (`APARTMENT → "APT"`, `SUITE → "STE"`). */
|
|
63
61
|
export declare const US_UNIT_DESIGNATOR_PREFERRED_ABBR: Readonly<Record<UsUnitDesignator, string>>;
|
|
64
62
|
/**
|
|
65
|
-
* If the FIRST whitespace-separated word of `unit` is a known USPS designator variant, return the
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
* street suffixes which trail.
|
|
63
|
+
* If the FIRST whitespace-separated word of `unit` is a known USPS designator variant, return the canonical key and the
|
|
64
|
+
* matched word. Returns null if the leading word isn't a known designator (e.g. a bare `"4B"` or `"#210"`).
|
|
65
|
+
* Leading-word-only — designators introduce the unit, unlike street suffixes which trail.
|
|
69
66
|
*/
|
|
70
67
|
export declare function matchLeadingDesignator(unit: string): {
|
|
71
68
|
canonical: UsUnitDesignator;
|
|
@@ -79,14 +76,14 @@ export interface UnitDesignatorMatch<D extends UsUnitDesignator = UsUnitDesignat
|
|
|
79
76
|
abbreviation: (typeof US_UNIT_DESIGNATOR_VARIANTS)[D][0];
|
|
80
77
|
}
|
|
81
78
|
/**
|
|
82
|
-
* Look up a USPS secondary unit designator (by canonical word, abbreviation, or any variant) and
|
|
83
|
-
*
|
|
79
|
+
* Look up a USPS secondary unit designator (by canonical word, abbreviation, or any variant) and its approved
|
|
80
|
+
* abbreviation.
|
|
84
81
|
*/
|
|
85
82
|
export declare function lookupUnitDesignator<D extends UsUnitDesignator>(designator: D): UnitDesignatorMatch<D>;
|
|
86
83
|
export declare function lookupUnitDesignator(input: string | null | undefined): UnitDesignatorMatch | null;
|
|
87
84
|
/**
|
|
88
|
-
* True when a token is any USPS secondary unit designator or abbreviation (case-insensitive) —
|
|
89
|
-
* `"
|
|
85
|
+
* True when a token is any USPS secondary unit designator or abbreviation (case-insensitive) — `"Apt"`, `"STE"`,
|
|
86
|
+
* `"floor"`.
|
|
90
87
|
*/
|
|
91
88
|
export declare function isUnitDesignatorToken(input: unknown): boolean;
|
|
92
89
|
//# sourceMappingURL=unit-designator.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"unit-designator.d.ts","sourceRoot":"","sources":["../../us/unit-designator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH
|
|
1
|
+
{"version":3,"file":"unit-designator.d.ts","sourceRoot":"","sources":["../../us/unit-designator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;CAyBc,CAAA;AAEtD,2FAA2F;AAC3F,MAAM,MAAM,gBAAgB,GAAG,MAAM,OAAO,2BAA2B,CAAA;AAEvE;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAaxE,CAAA;AAEJ,uFAAuF;AACvF,eAAO,MAAM,iCAAiC,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAE1C,CAAA;AAE/C;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG;IAAE,SAAS,EAAE,gBAAgB,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAU5G;AAED,oEAAoE;AACpE,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IACjF,mEAAmE;IACnE,UAAU,EAAE,CAAC,CAAA;IACb,yDAAyD;IACzD,YAAY,EAAE,CAAC,OAAO,2BAA2B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CACxD;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,EAAE,UAAU,EAAE,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAA;AACvG,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,mBAAmB,GAAG,IAAI,CAAA;AAUlG;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAE7D"}
|
|
@@ -20,10 +20,9 @@
|
|
|
20
20
|
* @see {@link https://pe.usps.com/text/pub28/28apc_003.htm USPS Secondary Unit Designators}
|
|
21
21
|
*/
|
|
22
22
|
/**
|
|
23
|
-
* Canonical USPS secondary unit designator → recognized variants. The first variant is the approved
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* both included — synthesis treats them uniformly.
|
|
23
|
+
* Canonical USPS secondary unit designator → recognized variants. The first variant is the approved USPS abbreviation.
|
|
24
|
+
* Keys + values uppercase per the publication. The designators marked by USPS as "requires a secondary number" (APT,
|
|
25
|
+
* BLDG, FL, …) and the standalone ones (BSMT, LBBY, PH, …) are both included — synthesis treats them uniformly.
|
|
27
26
|
*/
|
|
28
27
|
export const US_UNIT_DESIGNATOR_VARIANTS = {
|
|
29
28
|
APARTMENT: ["APT", "APRT", "APMT"],
|
|
@@ -52,9 +51,8 @@ export const US_UNIT_DESIGNATOR_VARIANTS = {
|
|
|
52
51
|
UPPER: ["UPPR"],
|
|
53
52
|
};
|
|
54
53
|
/**
|
|
55
|
-
* Inverse lookup: every variant abbreviation OR full canonical word → its canonical key, built once
|
|
56
|
-
*
|
|
57
|
-
* `"SUITE"`, `suite` → `"SUITE"`).
|
|
54
|
+
* Inverse lookup: every variant abbreviation OR full canonical word → its canonical key, built once at module load,
|
|
55
|
+
* lowercase-keyed for case-insensitive matching (`apt` → `"APARTMENT"`, `ste` → `"SUITE"`, `suite` → `"SUITE"`).
|
|
58
56
|
*/
|
|
59
57
|
export const US_UNIT_DESIGNATOR_LOOKUP = (() => {
|
|
60
58
|
const out = new Map();
|
|
@@ -71,10 +69,9 @@ export const US_UNIT_DESIGNATOR_LOOKUP = (() => {
|
|
|
71
69
|
/** Approved USPS abbreviation per canonical (`APARTMENT → "APT"`, `SUITE → "STE"`). */
|
|
72
70
|
export const US_UNIT_DESIGNATOR_PREFERRED_ABBR = Object.fromEntries(Object.keys(US_UNIT_DESIGNATOR_VARIANTS).map((k) => [k, US_UNIT_DESIGNATOR_VARIANTS[k][0]]));
|
|
73
71
|
/**
|
|
74
|
-
* If the FIRST whitespace-separated word of `unit` is a known USPS designator variant, return the
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
* street suffixes which trail.
|
|
72
|
+
* If the FIRST whitespace-separated word of `unit` is a known USPS designator variant, return the canonical key and the
|
|
73
|
+
* matched word. Returns null if the leading word isn't a known designator (e.g. a bare `"4B"` or `"#210"`).
|
|
74
|
+
* Leading-word-only — designators introduce the unit, unlike street suffixes which trail.
|
|
78
75
|
*/
|
|
79
76
|
export function matchLeadingDesignator(unit) {
|
|
80
77
|
const trimmed = unit.trim();
|
|
@@ -95,8 +92,8 @@ export function lookupUnitDesignator(input) {
|
|
|
95
92
|
return { designator, abbreviation: US_UNIT_DESIGNATOR_VARIANTS[designator][0] };
|
|
96
93
|
}
|
|
97
94
|
/**
|
|
98
|
-
* True when a token is any USPS secondary unit designator or abbreviation (case-insensitive) —
|
|
99
|
-
* `"
|
|
95
|
+
* True when a token is any USPS secondary unit designator or abbreviation (case-insensitive) — `"Apt"`, `"STE"`,
|
|
96
|
+
* `"floor"`.
|
|
100
97
|
*/
|
|
101
98
|
export function isUnitDesignatorToken(input) {
|
|
102
99
|
return typeof input === "string" && US_UNIT_DESIGNATOR_LOOKUP.has(input.trim().toLowerCase());
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"unit-designator.js","sourceRoot":"","sources":["../../us/unit-designator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH
|
|
1
|
+
{"version":3,"file":"unit-designator.js","sourceRoot":"","sources":["../../us/unit-designator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG;IAC1C,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;IAClC,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,QAAQ,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;IACzB,UAAU,EAAE,CAAC,MAAM,CAAC;IACpB,KAAK,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;IACpB,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,MAAM,EAAE,CAAC,MAAM,CAAC;IAChB,GAAG,EAAE,CAAC,KAAK,CAAC;IACZ,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,GAAG,EAAE,CAAC,KAAK,CAAC;IACZ,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,MAAM,EAAE,CAAC,KAAK,CAAC;IACf,SAAS,EAAE,CAAC,IAAI,CAAC;IACjB,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,KAAK,CAAC;IACd,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,MAAM,CAAC;CACsC,CAAA;AAKtD;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAA0C,CAAC,GAAG,EAAE;IACrF,MAAM,GAAG,GAAG,IAAI,GAAG,EAA4B,CAAA;IAE/C,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAuB,EAAE,CAAC;QACxF,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAA;QAE3C,KAAK,MAAM,OAAO,IAAI,2BAA2B,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9D,mFAAmF;YACnF,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;gBAAE,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAA;QAC/E,CAAC;IACF,CAAC;IAED,OAAO,GAAG,CAAA;AACX,CAAC,CAAC,EAAE,CAAA;AAEJ,uFAAuF;AACvF,MAAM,CAAC,MAAM,iCAAiC,GAA+C,MAAM,CAAC,WAAW,CAC7G,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACrE,CAAA;AAE/C;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAY;IAClD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;IAE3B,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAA;IACzB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,CAAA;IACtC,MAAM,SAAS,GAAG,yBAAyB,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;IAEpE,IAAI,CAAC,SAAS;QAAE,OAAO,IAAI,CAAA;IAE3B,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;AACrC,CAAC;AAgBD,MAAM,UAAU,oBAAoB,CAAC,KAAgC;IACpE,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAA;IACpD,MAAM,UAAU,GAAG,yBAAyB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAA;IAE5E,IAAI,CAAC,UAAU;QAAE,OAAO,IAAI,CAAA;IAE5B,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AAChF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAc;IACnD,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,yBAAyB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAA;AAC9F,CAAC"}
|
package/out/us/zipcode.d.ts
CHANGED
|
@@ -15,12 +15,11 @@ import { type UsStateAbbreviation } from "./state.js";
|
|
|
15
15
|
*/
|
|
16
16
|
export type ZipCodeDigit = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
|
|
17
17
|
/**
|
|
18
|
-
* A ZIP (Zone Improvement Plan) Code is a five-digit code assigned by the USPS to a section of a
|
|
19
|
-
*
|
|
20
|
-
* the delivery of mail.
|
|
18
|
+
* A ZIP (Zone Improvement Plan) Code is a five-digit code assigned by the USPS to a section of a street, a collection
|
|
19
|
+
* of streets, an establishment, structure, or group of post office boxes, for the delivery of mail.
|
|
21
20
|
*
|
|
22
|
-
* - The first 3 digits of the ZIP code represent a specific central mail processing facility, which
|
|
23
|
-
*
|
|
21
|
+
* - The first 3 digits of the ZIP code represent a specific central mail processing facility, which can be used to
|
|
22
|
+
* identify the locality and region of the address, i.e. the city and state.
|
|
24
23
|
* - The last 2 digits of the ZIP code represent a specific post office or delivery area.
|
|
25
24
|
*
|
|
26
25
|
* ```txt
|
|
@@ -32,19 +31,18 @@ export type ZipCodeDigit = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
|
|
|
32
31
|
* (City)
|
|
33
32
|
* ```
|
|
34
33
|
*
|
|
35
|
-
* Note that ZIP codes are not areas, but rather a group of deliverable addresses, which can and do
|
|
36
|
-
* change over time.
|
|
34
|
+
* Note that ZIP codes are not areas, but rather a group of deliverable addresses, which can and do change over time.
|
|
37
35
|
*
|
|
38
36
|
* @category Delivery
|
|
39
37
|
* @category Postal
|
|
40
|
-
* @see {@linkcode ZipCodePlusFour} for the extended ZIP code format.
|
|
41
38
|
* @title ZIP Code
|
|
42
39
|
* @pattern ^\d{5}$
|
|
40
|
+
* @see {@linkcode ZipCodePlusFour} for the extended ZIP code format.
|
|
43
41
|
*/
|
|
44
42
|
export type ZipCode = Tagged<string, "ZipCode">;
|
|
45
43
|
/**
|
|
46
|
-
* The extended ZIP code format includes the five-digit ZIP code followed by a hyphen and four
|
|
47
|
-
*
|
|
44
|
+
* The extended ZIP code format includes the five-digit ZIP code followed by a hyphen and four additional digits. This
|
|
45
|
+
* extended format is used to provide more precise location information.
|
|
48
46
|
*
|
|
49
47
|
* - The first 3 digits of the ZIP code represent a specific central mail processing facility,
|
|
50
48
|
* - The last 2 digits of the ZIP code represent a specific post office or delivery area.
|
|
@@ -59,15 +57,14 @@ export type ZipCode = Tagged<string, "ZipCode">;
|
|
|
59
57
|
* (Post Office)
|
|
60
58
|
* ```
|
|
61
59
|
*
|
|
62
|
-
* Note that ZIP codes are not areas, but rather a group of deliverable addresses, which can and do
|
|
63
|
-
* change over time.
|
|
60
|
+
* Note that ZIP codes are not areas, but rather a group of deliverable addresses, which can and do change over time.
|
|
64
61
|
*
|
|
65
62
|
* @category Delivery
|
|
66
63
|
* @category Postal
|
|
67
64
|
* @type string
|
|
68
|
-
* @see {@linkcode ZipCode} for the standard ZIP code format.
|
|
69
65
|
* @title ZIP Code+4
|
|
70
66
|
* @pattern ^\d{5}-\d{4}$
|
|
67
|
+
* @see {@linkcode ZipCode} for the standard ZIP code format.
|
|
71
68
|
*/
|
|
72
69
|
export type ZipCodePlusFour = Tagged<string, "ZipCodePlusFour">;
|
|
73
70
|
/**
|
|
@@ -77,12 +74,12 @@ export type ZipCodePlusFour = Tagged<string, "ZipCodePlusFour">;
|
|
|
77
74
|
*/
|
|
78
75
|
export type ExtractStateFromZipCode<Zip extends ZipCode | ZipCodePlusFour> = Zip extends `${infer StateCode}${infer _Rest}` ? StateCode : never;
|
|
79
76
|
/**
|
|
80
|
-
* Record of US state abbreviations to their corresponding ZIP code prefix (the leading digit). A
|
|
81
|
-
*
|
|
82
|
-
*
|
|
77
|
+
* Record of US state abbreviations to their corresponding ZIP code prefix (the leading digit). A cheap geographic
|
|
78
|
+
* prior: a 5-digit code's first digit narrows it to a band of states, which the parser can weigh against the
|
|
79
|
+
* surrounding city/state tokens.
|
|
83
80
|
*
|
|
84
|
-
* @see {@linkcode ZipCodePrefixAbbreviationMap} for the reverse mapping.
|
|
85
81
|
* @internal
|
|
82
|
+
* @see {@linkcode ZipCodePrefixAbbreviationMap} for the reverse mapping.
|
|
86
83
|
*/
|
|
87
84
|
export declare const StateAbbreviationZipCodePrefixRecord: {
|
|
88
85
|
readonly AL: 3;
|
|
@@ -169,8 +166,8 @@ export interface PluckedStateZIPCodeResult {
|
|
|
169
166
|
zipCode: ZipCode | ZipCodePlusFour;
|
|
170
167
|
}
|
|
171
168
|
/**
|
|
172
|
-
* Given an address string like `"NY"`, `"CA 94016"`, attempts to match the state abbreviation and
|
|
173
|
-
*
|
|
169
|
+
* Given an address string like `"NY"`, `"CA 94016"`, attempts to match the state abbreviation and postal code, if
|
|
170
|
+
* applicable.
|
|
174
171
|
*
|
|
175
172
|
* @see {@linkcode isUsStateAbbreviation} to validate the state abbreviation.
|
|
176
173
|
*/
|
package/out/us/zipcode.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"zipcode.d.ts","sourceRoot":"","sources":["../../us/zipcode.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;
|
|
1
|
+
{"version":3,"file":"zipcode.d.ts","sourceRoot":"","sources":["../../us/zipcode.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAEvC,OAAO,EAAyB,KAAK,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAE5E;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;AAE/D;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,CAAC,GAAG,SAAS,OAAO,GAAG,eAAe,IACxE,GAAG,SAAS,GAAG,MAAM,SAAS,GAAG,MAAM,KAAK,EAAE,GAAG,SAAS,GAAG,KAAK,CAAA;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyDa,CAAA;AAE9D;;GAEG;AACH,QAAA,MAAM,4BAA4B,8ZAAiD,CAAA;AAUnF,OAAO,EAAE,4BAA4B,EAAE,CAAA;AAEvC;;GAEG;AACH,eAAO,MAAM,eAAe;IAC3B;;OAEG;;IAGH;;OAEG;;CAEM,CAAA;AAEV;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,GAAG,eAAe,CAE5E;AAED,MAAM,WAAW,yBAAyB;IACzC,iBAAiB,EAAE,mBAAmB,GAAG,IAAI,CAAA;IAC7C,OAAO,EAAE,OAAO,GAAG,eAAe,CAAA;CAClC;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,yBAAyB,GAAG,IAAI,CAalF"}
|
package/out/us/zipcode.js
CHANGED
|
@@ -8,12 +8,12 @@
|
|
|
8
8
|
*/
|
|
9
9
|
import { isUsStateAbbreviation } from "./state.js";
|
|
10
10
|
/**
|
|
11
|
-
* Record of US state abbreviations to their corresponding ZIP code prefix (the leading digit). A
|
|
12
|
-
*
|
|
13
|
-
*
|
|
11
|
+
* Record of US state abbreviations to their corresponding ZIP code prefix (the leading digit). A cheap geographic
|
|
12
|
+
* prior: a 5-digit code's first digit narrows it to a band of states, which the parser can weigh against the
|
|
13
|
+
* surrounding city/state tokens.
|
|
14
14
|
*
|
|
15
|
-
* @see {@linkcode ZipCodePrefixAbbreviationMap} for the reverse mapping.
|
|
16
15
|
* @internal
|
|
16
|
+
* @see {@linkcode ZipCodePrefixAbbreviationMap} for the reverse mapping.
|
|
17
17
|
*/
|
|
18
18
|
export const StateAbbreviationZipCodePrefixRecord = {
|
|
19
19
|
AL: 3,
|
|
@@ -102,8 +102,8 @@ export function isZipCode(input) {
|
|
|
102
102
|
return typeof input === "string" && ZipCodePatterns.Standard.test(input);
|
|
103
103
|
}
|
|
104
104
|
/**
|
|
105
|
-
* Given an address string like `"NY"`, `"CA 94016"`, attempts to match the state abbreviation and
|
|
106
|
-
*
|
|
105
|
+
* Given an address string like `"NY"`, `"CA 94016"`, attempts to match the state abbreviation and postal code, if
|
|
106
|
+
* applicable.
|
|
107
107
|
*
|
|
108
108
|
* @see {@linkcode isUsStateAbbreviation} to validate the state abbreviation.
|
|
109
109
|
*/
|
package/out/us/zipcode.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"zipcode.js","sourceRoot":"","sources":["../../us/zipcode.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;
|
|
1
|
+
{"version":3,"file":"zipcode.js","sourceRoot":"","sources":["../../us/zipcode.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,EAAE,qBAAqB,EAA4B,MAAM,YAAY,CAAA;AAwE5E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG;IACnD,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,CAAC;CACwD,CAAA;AAE9D;;GAEG;AACH,MAAM,4BAA4B,GAAG,IAAI,GAAG,EAAuC,CAAA;AAEnF,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,oCAAoC,CAG9E,EAAE,CAAC;IACL,MAAM,MAAM,GAAG,4BAA4B,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;IAC7D,4BAA4B,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,CAAC,CAAA;AAC7D,CAAC;AAED,OAAO,EAAE,4BAA4B,EAAE,CAAA;AAEvC;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B;;OAEG;IACH,QAAQ,EAAE,wBAAwB;IAElC;;OAEG;IACH,4BAA4B,EAAE,uDAAuD;CAC5E,CAAA;AAEV;;GAEG;AACH,MAAM,UAAU,SAAS,CAAC,KAAc;IACvC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACzE,CAAC;AAOD;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC/C,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAA;IAEpD,MAAM,CAAC,EAAE,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,4BAA4B,CAAC,IAAI,EAAE,CAAA;IAE7G,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAA;IAEzB,MAAM,eAAe,GAAG,iBAAiB,EAAE,WAAW,EAAE,CAAA;IAExD,OAAO;QACN,iBAAiB,EAAE,qBAAqB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI;QAClF,OAAO,EAAE,OAAoC;KAC7C,CAAA;AACF,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mailwoman/codex",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.0.0",
|
|
4
4
|
"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.",
|
|
5
5
|
"license": "AGPL-3.0-only",
|
|
6
6
|
"repository": {
|
|
@@ -8,6 +8,12 @@
|
|
|
8
8
|
"url": "https://github.com/sister-software/mailwoman.git",
|
|
9
9
|
"directory": "codex"
|
|
10
10
|
},
|
|
11
|
+
"files": [
|
|
12
|
+
"out/**/*.js",
|
|
13
|
+
"out/**/*.js.map",
|
|
14
|
+
"out/**/*.d.ts",
|
|
15
|
+
"out/**/*.d.ts.map"
|
|
16
|
+
],
|
|
11
17
|
"type": "module",
|
|
12
18
|
"exports": {
|
|
13
19
|
"./package.json": "./package.json",
|
|
@@ -22,19 +28,13 @@
|
|
|
22
28
|
"./au": "./out/au/index.js",
|
|
23
29
|
"./nz": "./out/nz/index.js"
|
|
24
30
|
},
|
|
31
|
+
"publishConfig": {
|
|
32
|
+
"access": "public"
|
|
33
|
+
},
|
|
25
34
|
"dependencies": {
|
|
26
35
|
"type-fest": "^5.7.0"
|
|
27
36
|
},
|
|
28
37
|
"devDependencies": {
|
|
29
|
-
"@mailwoman/annotations": "
|
|
30
|
-
},
|
|
31
|
-
"files": [
|
|
32
|
-
"out/**/*.js",
|
|
33
|
-
"out/**/*.js.map",
|
|
34
|
-
"out/**/*.d.ts",
|
|
35
|
-
"out/**/*.d.ts.map"
|
|
36
|
-
],
|
|
37
|
-
"publishConfig": {
|
|
38
|
-
"access": "public"
|
|
38
|
+
"@mailwoman/annotations": "5.0.0"
|
|
39
39
|
}
|
|
40
40
|
}
|