localized-regions 1.0.2 → 1.2.0

package/dist/data/countries.d.ts

@@ -1,3 +1,3 @@
 import type { Country } from '../types';
-declare const countries: Country[];
-export default countries;
+declare const data: Country[];
+export default data;

package/dist/data/countries.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const countries = [
+const data = [
     {
         "code": "AF",
         "name": "Afghanistan"
@@ -1002,4 +1002,4 @@ const countries = [
         "name": "Zimbabwe"
     }
 ];
-exports.default = countries;
+exports.default = data;

package/dist/data/provinces.d.ts

@@ -1,3 +1,3 @@
 import type { Province } from '../types';
-declare const provinces: Record<string, Province[]>;
-export default provinces;
+declare const data: Record<string, Province[]>;
+export default data;

package/dist/data/provinces.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const provinces = {
+const data = {
     "AF": [
         {
             "code": "AF-BDS",
@@ -17872,24 +17872,6 @@ const provinces = {
         }
     ],
     "NL": [
-        {
-            "code": "NL-AW",
-            "countryCode": "NL",
-            "name": "Aruba",
-            "type": "Country"
-        },
-        {
-            "code": "NL-BQ1",
-            "countryCode": "NL",
-            "name": "Bonaire",
-            "type": "Special municipality"
-        },
-        {
-            "code": "NL-CW",
-            "countryCode": "NL",
-            "name": "Curaçao",
-            "type": "Country"
-        },
         {
             "code": "NL-DR",
             "countryCode": "NL",
@@ -17944,24 +17926,6 @@ const provinces = {
             "name": "Overijssel",
             "type": "Province"
         },
-        {
-            "code": "NL-BQ2",
-            "countryCode": "NL",
-            "name": "Saba",
-            "type": "Special municipality"
-        },
-        {
-            "code": "NL-BQ3",
-            "countryCode": "NL",
-            "name": "Sint Eustatius",
-            "type": "Special municipality"
-        },
-        {
-            "code": "NL-SX",
-            "countryCode": "NL",
-            "name": "Sint Maarten",
-            "type": "Country"
-        },
         {
             "code": "NL-UT",
             "countryCode": "NL",
@@ -31030,4 +30994,4 @@ const provinces = {
         }
     ]
 };
-exports.default = provinces;
+exports.default = data;

package/dist/index.d.ts

@@ -19,12 +19,27 @@ export declare function getProvince(provinceCode: string): Province | undefined;
  * Cities. With no provinceCode, returns all cities of the country. With a
  * provinceCode, returns cities for that subdivision (Spain: mapped to the
  * parent community, best-effort).
+ *
+ * The Netherlands is served from our own baked list (RAT-2000) rather than
+ * country-state-city, whose NL data is 19% "Gemeente X" municipality records
+ * and missing roughly 1000 real places. See scripts/generate.js.
  */
 export declare function getCities(countryCode: string, provinceCode?: string): City[];
+/**
+ * Does this city match what the user typed? Matches the display name and any
+ * alias, so typing "'s-Gravenhage" finds "Den Haag" without ever offering the
+ * formal name as a selectable option (RAT-2000).
+ *
+ * Pass it to react-select's filterOption. Callers using a Creatable select
+ * must let the synthetic "create" option through before calling this - it has
+ * no `name` and would otherwise be filtered away.
+ */
+export declare function cityMatches(city: City, input: string): boolean;
 /** Country options for react-select / MUI. value = ISO code, label = bilingual. */
 export declare function countryOptions(locale?: string): Option[];
 /** Province options. value = ISO 3166-2 code, label = province name. */
 export declare function provinceOptions(countryCode: string): Option[];
 /** City options. value = label = city name (cities have no stable code). */
 export declare function cityOptions(countryCode: string, provinceCode?: string): Option[];
+export { formatAddressLine1, isHouseNumberFirst } from './address';
 export * from './types';

package/dist/index.js

@@ -17,12 +17,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHouseNumberFirst = exports.formatAddressLine1 = void 0;
 exports.getCountries = getCountries;
 exports.getCountry = getCountry;
 exports.formatCountryLabel = formatCountryLabel;
 exports.getProvinces = getProvinces;
 exports.getProvince = getProvince;
 exports.getCities = getCities;
+exports.cityMatches = cityMatches;
 exports.countryOptions = countryOptions;
 exports.provinceOptions = provinceOptions;
 exports.cityOptions = cityOptions;
@@ -32,6 +34,7 @@ const country_state_city_1 = require("country-state-city");
 // or dynamic `require`.
 const countries_1 = __importDefault(require("./data/countries"));
 const provinces_1 = __importDefault(require("./data/provinces"));
+const cities_nl_1 = __importDefault(require("./data/cities-nl"));
 function displayName(code, locale) {
     try {
         return new Intl.DisplayNames([locale], { type: 'region' }).of(code) || undefined;
@@ -87,9 +90,21 @@ const ES_COMMUNITY_TO_SOURCE = {
  * Cities. With no provinceCode, returns all cities of the country. With a
  * provinceCode, returns cities for that subdivision (Spain: mapped to the
  * parent community, best-effort).
+ *
+ * The Netherlands is served from our own baked list (RAT-2000) rather than
+ * country-state-city, whose NL data is 19% "Gemeente X" municipality records
+ * and missing roughly 1000 real places. See scripts/generate.js.
  */
 function getCities(countryCode, provinceCode) {
     const cc = countryCode.toUpperCase();
+    if (cc === 'NL') {
+        if (!provinceCode) {
+            return Object.values(cities_nl_1.default)
+                .flat()
+                .sort((a, b) => a.name.localeCompare(b.name, 'nl'));
+        }
+        return cities_nl_1.default[provinceCode.toUpperCase()] || [];
+    }
     if (!provinceCode) {
         return country_state_city_1.City.getCitiesOfCountry(cc) || [];
     }
@@ -103,6 +118,23 @@ function getCities(countryCode, provinceCode) {
     const bare = provinceCode.includes('-') ? provinceCode.split('-').slice(1).join('-') : provinceCode;
     return country_state_city_1.City.getCitiesOfState(cc, bare) || [];
 }
+/**
+ * Does this city match what the user typed? Matches the display name and any
+ * alias, so typing "'s-Gravenhage" finds "Den Haag" without ever offering the
+ * formal name as a selectable option (RAT-2000).
+ *
+ * Pass it to react-select's filterOption. Callers using a Creatable select
+ * must let the synthetic "create" option through before calling this - it has
+ * no `name` and would otherwise be filtered away.
+ */
+function cityMatches(city, input) {
+    const query = input.trim().toLowerCase();
+    if (!query)
+        return true;
+    if (city.name.toLowerCase().includes(query))
+        return true;
+    return (city.aliases ?? []).some((alias) => alias.toLowerCase().includes(query));
+}
 // --------------------------------------------------- ready-to-use dropdown options
 /** Country options for react-select / MUI. value = ISO code, label = bilingual. */
 function countryOptions(locale) {
@@ -116,4 +148,7 @@ function provinceOptions(countryCode) {
 function cityOptions(countryCode, provinceCode) {
     return getCities(countryCode, provinceCode).map((c) => ({ value: c.name, label: c.name }));
 }
+var address_1 = require("./address");
+Object.defineProperty(exports, "formatAddressLine1", { enumerable: true, get: function () { return address_1.formatAddressLine1; } });
+Object.defineProperty(exports, "isHouseNumberFirst", { enumerable: true, get: function () { return address_1.isHouseNumberFirst; } });
 __exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -33,6 +33,12 @@ export interface City {
     stateCode?: string;
     latitude?: string;
     longitude?: string;
+    /**
+     * Extra strings that should match while typing but are never displayed or
+     * stored, e.g. "'s-Gravenhage" for Den Haag (RAT-2000). Use cityMatches()
+     * rather than reading this directly.
+     */
+    aliases?: string[];
 }
 /** react-select / MUI style option */
 export interface Option {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "localized-regions",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "Country, province and city data with bilingual localized labels (e.g. \"España (Spain)\") and ISO 3166-1 / ISO 3166-2 codes. Ships all 50 Spanish provinces. Framework-agnostic, drop-in options for react-select and MUI dropdowns.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",