@mailwoman/codex 8.4.0 → 8.6.0

package/es/codigo-postal.ts

@@ -0,0 +1,51 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Spanish postal codes (código postal): the branded type, the shape, and the province prior.
+ *
+ *   The contrast with a German PLZ is the informative part. A PLZ's leading digit maps to a Leitzone
+ *   that deliberately CROSSES state borders, so it cannot tell you the Bundesland. A Spanish código
+ *   postal is the opposite: its first TWO digits are the province code, assigned alphabetically
+ *   (01 Álava … 28 Madrid … 50 Zaragoza), so the province is derivable from the postcode exactly.
+ *   Code that wants a Spanish region from an address can read it off the postcode; code that wants a
+ *   German one cannot.
+ */
+
+import type { Tagged } from "type-fest"
+
+/**
+ * A Spanish postal code: five digits, `PPNNN`, where `PP` is the province (`28001` is Madrid).
+ *
+ * @category Postal
+ * @type string
+ * @title CodigoPostal
+ * @pattern ^\d{5}$
+ */
+export type CodigoPostal = Tagged<string, "CodigoPostal">
+
+/**
+ * Shape of a Spanish código postal — five digits. Identical in shape to a French code postal, a German PLZ and a US
+ * ZIP; disambiguation is the parser's job, not the pattern's.
+ */
+export const CODIGO_POSTAL_PATTERN = /^\d{5}$/
+
+/**
+ * Narrow a string to a {@link CodigoPostal}, or `null` when it is not one.
+ */
+export function parseCodigoPostal(input: string): CodigoPostal | null {
+	const s = input.trim()
+
+	return CODIGO_POSTAL_PATTERN.test(s) ? (s as CodigoPostal) : null
+}
+
+/**
+ * The two-digit province prefix (`"28001"` → `"28"`), or `null` for a non-postcode. Callers map it through their own
+ * province table; this module deliberately does not ship one, since the campaign that needed it only needs the shape.
+ */
+export function codigoPostalProvincePrefix(input: string): string | null {
+	const code = parseCodigoPostal(input)
+
+	return code ? code.slice(0, 2) : null
+}

package/es/index.ts

@@ -0,0 +1,9 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Spanish (ES) address-system reference data.
+ */
+
+export * from "./codigo-postal.ts"

package/it/cap.ts

@@ -0,0 +1,39 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Italian postal codes (Codice di Avviamento Postale, CAP): the branded type and the shape.
+ *
+ *   Five digits like the Spanish, French and German forms, but do NOT infer a province from the
+ *   leading digits the way `es/codigo-postal.ts` documents for Spain. Italy's large cities are
+ *   assigned RANGES rather than a single code (Rome spans 00118–00199, Milan 20121–20162), and
+ *   several provinces share leading digits, so the CAP narrows geography without identifying a
+ *   province. It is the same trap German PLZ Leitzonen set, in a different disguise.
+ */
+
+import type { Tagged } from "type-fest"
+
+/**
+ * An Italian postal code: five digits (`00184` is Rome, Rione Monti).
+ *
+ * @category Postal
+ * @type string
+ * @title CAP
+ * @pattern ^\d{5}$
+ */
+export type CAP = Tagged<string, "CAP">
+
+/**
+ * Shape of an Italian CAP — five digits.
+ */
+export const CAP_PATTERN = /^\d{5}$/
+
+/**
+ * Narrow a string to a {@link CAP}, or `null` when it is not one.
+ */
+export function parseCAP(input: string): CAP | null {
+	const s = input.trim()
+
+	return CAP_PATTERN.test(s) ? (s as CAP) : null
+}

package/it/index.ts

@@ -0,0 +1,9 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Italian (IT) address-system reference data.
+ */
+
+export * from "./cap.ts"

package/out/es/codigo-postal.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Spanish postal codes (código postal): the branded type, the shape, and the province prior.
+ *
+ *   The contrast with a German PLZ is the informative part. A PLZ's leading digit maps to a Leitzone
+ *   that deliberately CROSSES state borders, so it cannot tell you the Bundesland. A Spanish código
+ *   postal is the opposite: its first TWO digits are the province code, assigned alphabetically
+ *   (01 Álava … 28 Madrid … 50 Zaragoza), so the province is derivable from the postcode exactly.
+ *   Code that wants a Spanish region from an address can read it off the postcode; code that wants a
+ *   German one cannot.
+ */
+import type { Tagged } from "type-fest";
+/**
+ * A Spanish postal code: five digits, `PPNNN`, where `PP` is the province (`28001` is Madrid).
+ *
+ * @category Postal
+ * @type string
+ * @title CodigoPostal
+ * @pattern ^\d{5}$
+ */
+export type CodigoPostal = Tagged<string, "CodigoPostal">;
+/**
+ * Shape of a Spanish código postal — five digits. Identical in shape to a French code postal, a German PLZ and a US
+ * ZIP; disambiguation is the parser's job, not the pattern's.
+ */
+export declare const CODIGO_POSTAL_PATTERN: RegExp;
+/**
+ * Narrow a string to a {@link CodigoPostal}, or `null` when it is not one.
+ */
+export declare function parseCodigoPostal(input: string): CodigoPostal | null;
+/**
+ * The two-digit province prefix (`"28001"` → `"28"`), or `null` for a non-postcode. Callers map it through their own
+ * province table; this module deliberately does not ship one, since the campaign that needed it only needs the shape.
+ */
+export declare function codigoPostalProvincePrefix(input: string): string | null;
+//# sourceMappingURL=codigo-postal.d.ts.map

package/out/es/codigo-postal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codigo-postal.d.ts","sourceRoot":"","sources":["../../es/codigo-postal.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAEvC;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;AAEzD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,QAAY,CAAA;AAE9C;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI,CAIpE;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAIvE"}

package/out/es/codigo-postal.js

@@ -0,0 +1,35 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Spanish postal codes (código postal): the branded type, the shape, and the province prior.
+ *
+ *   The contrast with a German PLZ is the informative part. A PLZ's leading digit maps to a Leitzone
+ *   that deliberately CROSSES state borders, so it cannot tell you the Bundesland. A Spanish código
+ *   postal is the opposite: its first TWO digits are the province code, assigned alphabetically
+ *   (01 Álava … 28 Madrid … 50 Zaragoza), so the province is derivable from the postcode exactly.
+ *   Code that wants a Spanish region from an address can read it off the postcode; code that wants a
+ *   German one cannot.
+ */
+/**
+ * Shape of a Spanish código postal — five digits. Identical in shape to a French code postal, a German PLZ and a US
+ * ZIP; disambiguation is the parser's job, not the pattern's.
+ */
+export const CODIGO_POSTAL_PATTERN = /^\d{5}$/;
+/**
+ * Narrow a string to a {@link CodigoPostal}, or `null` when it is not one.
+ */
+export function parseCodigoPostal(input) {
+    const s = input.trim();
+    return CODIGO_POSTAL_PATTERN.test(s) ? s : null;
+}
+/**
+ * The two-digit province prefix (`"28001"` → `"28"`), or `null` for a non-postcode. Callers map it through their own
+ * province table; this module deliberately does not ship one, since the campaign that needed it only needs the shape.
+ */
+export function codigoPostalProvincePrefix(input) {
+    const code = parseCodigoPostal(input);
+    return code ? code.slice(0, 2) : null;
+}
+//# sourceMappingURL=codigo-postal.js.map

package/out/es/codigo-postal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codigo-postal.js","sourceRoot":"","sources":["../../es/codigo-postal.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAcH;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,SAAS,CAAA;AAE9C;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC9C,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IAEtB,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAkB,CAAC,CAAC,CAAC,IAAI,CAAA;AAClE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAAa;IACvD,MAAM,IAAI,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAA;IAErC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;AACtC,CAAC"}

package/out/es/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Spanish (ES) address-system reference data.
+ */
+export * from "./codigo-postal.ts";
+//# sourceMappingURL=index.d.ts.map

package/out/es/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../es/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,cAAc,oBAAoB,CAAA"}

package/out/es/index.js

@@ -0,0 +1,9 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Spanish (ES) address-system reference data.
+ */
+export * from "./codigo-postal.js";
+//# sourceMappingURL=index.js.map

package/out/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../es/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,cAAc,oBAAoB,CAAA"}

package/out/it/cap.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Italian postal codes (Codice di Avviamento Postale, CAP): the branded type and the shape.
+ *
+ *   Five digits like the Spanish, French and German forms, but do NOT infer a province from the
+ *   leading digits the way `es/codigo-postal.ts` documents for Spain. Italy's large cities are
+ *   assigned RANGES rather than a single code (Rome spans 00118–00199, Milan 20121–20162), and
+ *   several provinces share leading digits, so the CAP narrows geography without identifying a
+ *   province. It is the same trap German PLZ Leitzonen set, in a different disguise.
+ */
+import type { Tagged } from "type-fest";
+/**
+ * An Italian postal code: five digits (`00184` is Rome, Rione Monti).
+ *
+ * @category Postal
+ * @type string
+ * @title CAP
+ * @pattern ^\d{5}$
+ */
+export type CAP = Tagged<string, "CAP">;
+/**
+ * Shape of an Italian CAP — five digits.
+ */
+export declare const CAP_PATTERN: RegExp;
+/**
+ * Narrow a string to a {@link CAP}, or `null` when it is not one.
+ */
+export declare function parseCAP(input: string): CAP | null;
+//# sourceMappingURL=cap.d.ts.map

package/out/it/cap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cap.d.ts","sourceRoot":"","sources":["../../it/cap.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAEvC;;;;;;;GAOG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAEvC;;GAEG;AACH,eAAO,MAAM,WAAW,QAAY,CAAA;AAEpC;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI,CAIlD"}

package/out/it/cap.js

@@ -0,0 +1,25 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Italian postal codes (Codice di Avviamento Postale, CAP): the branded type and the shape.
+ *
+ *   Five digits like the Spanish, French and German forms, but do NOT infer a province from the
+ *   leading digits the way `es/codigo-postal.ts` documents for Spain. Italy's large cities are
+ *   assigned RANGES rather than a single code (Rome spans 00118–00199, Milan 20121–20162), and
+ *   several provinces share leading digits, so the CAP narrows geography without identifying a
+ *   province. It is the same trap German PLZ Leitzonen set, in a different disguise.
+ */
+/**
+ * Shape of an Italian CAP — five digits.
+ */
+export const CAP_PATTERN = /^\d{5}$/;
+/**
+ * Narrow a string to a {@link CAP}, or `null` when it is not one.
+ */
+export function parseCAP(input) {
+    const s = input.trim();
+    return CAP_PATTERN.test(s) ? s : null;
+}
+//# sourceMappingURL=cap.js.map

package/out/it/cap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cap.js","sourceRoot":"","sources":["../../it/cap.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAcH;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,SAAS,CAAA;AAEpC;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAa;IACrC,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IAEtB,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAS,CAAC,CAAC,CAAC,IAAI,CAAA;AAC/C,CAAC"}

package/out/it/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Italian (IT) address-system reference data.
+ */
+export * from "./cap.ts";
+//# sourceMappingURL=index.d.ts.map

package/out/it/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../it/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,cAAc,UAAU,CAAA"}

package/out/it/index.js

@@ -0,0 +1,9 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ *
+ *   Italian (IT) address-system reference data.
+ */
+export * from "./cap.js";
+//# sourceMappingURL=index.js.map

package/out/it/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../it/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,cAAc,UAAU,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mailwoman/codex",
-  "version": "8.4.0",
+  "version": "8.6.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": {
@@ -68,6 +68,14 @@
     "./tools": {
       "types": "./out/tools/index.d.ts",
       "default": "./out/tools/index.js"
+    },
+    "./es": {
+      "types": "./out/es/index.d.ts",
+      "default": "./out/es/index.js"
+    },
+    "./it": {
+      "types": "./out/it/index.d.ts",
+      "default": "./out/it/index.js"
     }
   },
   "publishConfig": {
@@ -117,6 +125,14 @@
       "./tools": {
         "types": "./out/tools/index.d.ts",
         "default": "./out/tools/index.js"
+      },
+      "./es": {
+        "types": "./out/es/index.d.ts",
+        "default": "./out/es/index.js"
+      },
+      "./it": {
+        "types": "./out/it/index.d.ts",
+        "default": "./out/it/index.js"
       }
     }
   },
@@ -124,6 +140,6 @@
     "type-fest": "^5.8.0"
   },
   "devDependencies": {
-    "@mailwoman/annotations": "8.4.0"
+    "@mailwoman/annotations": "8.6.0"
   }
 }