Update data & types (new partOf, userAssigned params) (#135)

dmythro · web-flow · commit db04d498a3b8 · 2024-03-04T19:17:58.000+02:00
* Bump modules * Update types and data for cases like #36 and #132 * Update comments in types.ts * Update phone code for Kazakhstan to just `7` #134 * Case insensitive search in getCountryCode function #131 * Rebuild dist data
diff --git a/dist/cjs/index.js b/dist/cjs/index.js
diff --git a/dist/countries.csv b/dist/countries.csv
@@ -123,7 +123,7 @@
 "KR","South Korea","대한민국","82","Asia","Seoul","KRW","ko"
 "KW","Kuwait","الكويت","965","Asia","Kuwait City","KWD","ar"
 "KY","Cayman Islands","Cayman Islands","1345","North America","George Town","KYD","en"
-"KZ","Kazakhstan","Қазақстан","76,77","Asia","Astana","KZT","kk,ru"
+"KZ","Kazakhstan","Қазақстан","7","Asia","Astana","KZT","kk,ru"
 "LA","Laos","ສປປລາວ","856","Asia","Vientiane","LAK","lo"
 "LB","Lebanon","لبنان","961","Asia","Beirut","LBP","ar,fr"
 "LC","Saint Lucia","Saint Lucia","1758","North America","Castries","XCD","en"
diff --git a/dist/countries.min.json b/dist/countries.min.json
diff --git a/dist/data.sql b/dist/data.sql
@@ -278,7 +278,7 @@ INSERT INTO `countries` (`code`, `name`, `native`, `phone`, `continent`, `capita
   ('KR', 'South Korea', '대한민국', '82', 'AS', 'Seoul', 'KRW', 'ko'),
   ('KW', 'Kuwait', 'الكويت', '965', 'AS', 'Kuwait City', 'KWD', 'ar'),
   ('KY', 'Cayman Islands', 'Cayman Islands', '1345', 'NA', 'George Town', 'KYD', 'en'),
-  ('KZ', 'Kazakhstan', 'Қазақстан', '76,77', 'AS', 'Astana', 'KZT', 'kk,ru'),
+  ('KZ', 'Kazakhstan', 'Қазақстан', '7', 'AS', 'Astana', 'KZT', 'kk,ru'),
   ('LA', 'Laos', 'ສປປລາວ', '856', 'AS', 'Vientiane', 'LAK', 'lo'),
   ('LB', 'Lebanon', 'لبنان', '961', 'AS', 'Beirut', 'LBP', 'ar,fr'),
   ('LC', 'Saint Lucia', 'Saint Lucia', '1758', 'NA', 'Castries', 'XCD', 'en'),
diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -33,12 +33,20 @@ export interface ICountry {
   native: string
   /**
    * Specified in cases when entity is currently a part of another one.
+   * Example: Åland is an autonomous and demilitarised region of Finland and has own ISO code.
+   * @see: https://en.wikipedia.org/wiki/Åland
+   * @todo: Type should be TCountryCode, but need to resolve cyclic referencing on dynamically generated type.
    */
-  parent?: TCountryCode
+  partOf?: string
   /**
    * Calling phone codes.
    */
   phone: number[]
+  /**
+   * Specified in cases when entity is not a part of the main ISO 3166-1 standart, but a User assigned code.
+   * @see: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#User-assigned_code_elements
+   */
+  userAssigned?: boolean
 }
 
 export interface ILanguage {
diff --git a/dist/index.iife.js b/dist/index.iife.js
diff --git a/dist/mjs/index.js b/dist/mjs/index.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -16,14 +16,14 @@
     "version": "cd ./packages/scripts && npm run version"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "6.8.0",
-    "@typescript-eslint/parser": "6.8.0",
-    "eslint": "8.51.0",
+    "@typescript-eslint/eslint-plugin": "7.1.0",
+    "@typescript-eslint/parser": "7.1.0",
+    "eslint": "8.57.0",
     "eslint-config-custom": "*",
-    "husky": "8.0.3",
-    "lint-staged": "15.0.2",
-    "prettier": "3.0.3",
-    "turbo": "1.10.16"
+    "husky": "9.0.11",
+    "lint-staged": "15.2.2",
+    "prettier": "3.2.5",
+    "turbo": "1.12.4"
   },
   "devEngines": {
     "node": ">=18"
diff --git a/packages/countries/package.json b/packages/countries/package.json
@@ -19,8 +19,8 @@
     "lint:fix": "eslint \"{/**,}/*.ts\" --fix"
   },
   "devDependencies": {
-    "tsup": "7.2.0",
-    "typescript": "~5.2.2"
+    "tsup": "8.0.2",
+    "typescript": "~5.3.3"
   },
   "license": "MIT"
 }
diff --git a/packages/countries/src/data/countries.ts b/packages/countries/src/data/countries.ts
@@ -135,6 +135,7 @@ export default {
     capital: 'Mariehamn',
     currency: ['EUR'],
     languages: ['sv'],
+    partOf: 'FI',
   },
   AZ: {
     name: 'Azerbaijan',
@@ -1124,7 +1125,7 @@ export default {
   KZ: {
     name: 'Kazakhstan',
     native: 'Қазақстан',
-    phone: [76, 77],
+    phone: [7],
     continent: 'AS',
     continents: ['AS', 'EU'],
     capital: 'Astana',
@@ -2212,6 +2213,7 @@ export default {
     capital: 'Pristina',
     currency: ['EUR'],
     languages: ['sq', 'sr'],
+    userAssigned: true,
   },
   YE: {
     name: 'Yemen',
diff --git a/packages/countries/src/getCountryCode.ts b/packages/countries/src/getCountryCode.ts
@@ -3,6 +3,12 @@ import { getCountryDataList } from './getCountryData.ts'
 
 const countryDataList = getCountryDataList()
 
-export const getCountryCode = (countryName: string): TCountryCode | false =>
-  countryDataList.find(({ name, native }) => countryName === name || countryName === native)
-    ?.iso2 || false
+export const getCountryCode = (countryName: string): TCountryCode | false => {
+  // Match exact country name, but case insensitive
+  const nameRegex = new RegExp('^' + countryName + '$', 'i')
+
+  return (
+    countryDataList.find(({ name, native }) => nameRegex.test(name) || nameRegex.test(native))
+      ?.iso2 || false
+  )
+}
diff --git a/packages/countries/src/types.ts b/packages/countries/src/types.ts
@@ -37,12 +37,20 @@ export interface ICountry {
   native: string
   /**
    * Specified in cases when entity is currently a part of another one.
+   * Example: Åland is an autonomous and demilitarised region of Finland and has own ISO code.
+   * @see: https://en.wikipedia.org/wiki/Åland
+   * @todo: Type should be TCountryCode, but need to resolve cyclic referencing on dynamically generated type.
    */
-  parent?: TCountryCode
+  partOf?: string
   /**
    * Calling phone codes.
    */
   phone: number[]
+  /**
+   * Specified in cases when entity is not a part of the main ISO 3166-1 standart, but a User assigned code.
+   * @see: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#User-assigned_code_elements
+   */
+  userAssigned?: boolean
 }
 
 export interface ILanguage {
diff --git a/packages/scripts/package.json b/packages/scripts/package.json
@@ -8,13 +8,13 @@
     "access": "public"
   },
   "devDependencies": {
-    "@types/node": "20.8.7",
-    "@types/semver-compare": "1.0.2",
+    "@types/node": "20.11.24",
+    "@types/semver-compare": "1.0.3",
     "chalk": "5.3.0",
     "countries-list": "*",
     "pretty-bytes": "6.1.1",
     "semver-compare": "1.0.0",
-    "tsx": "3.14.0"
+    "tsx": "4.7.1"
   },
   "scripts": {
     "build": "tsx index.ts",
diff --git a/packages/test-node/getCountryCode.test.ts b/packages/test-node/getCountryCode.test.ts
@@ -5,5 +5,11 @@ import { getCountryCode } from 'src/getCountryCode.ts'
 
 test('getCountryCode()', () => {
   assert.equal(getCountryCode('Ukraine'), 'UA')
+  assert.equal(getCountryCode('uKraine'), 'UA')
   assert.equal(getCountryCode('Україна'), 'UA')
+  assert.equal(getCountryCode('уКраїна'), 'UA')
+
+  assert.equal(getCountryCode('Ukrain'), false)
+  assert.equal(getCountryCode('Ukraine1'), false)
+  assert.equal(getCountryCode('Unknown'), false)
 })
diff --git a/packages/test-node/package.json b/packages/test-node/package.json
@@ -3,7 +3,7 @@
   "type": "module",
   "devDependencies": {
     "@swc-node/register": "1.6.7",
-    "typescript": "5.2.2"
+    "typescript": "5.3.3"
   },
   "devEngines": {
     "node": ">=18"
