feat(countries): add typescript definitions (#406)

Author: chambo-e

packages/countries/countries.d.ts

@@ -0,0 +1 @@
+export type AvailableCountries = 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PL' | 'PT' | 'PR' | 'QA' | 'RO' | 'RU' | 'RW' | 'RE' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'YE' | 'ZM' | 'ZW'

packages/countries/generate.py

@@ -14,8 +14,11 @@
 
 
 def main():
-    with open("./countries.json") as f:
-        data = json.load(f)
+    with open("./countries.json") as out:
+        data = json.load(out)
+    with open("./countries.d.ts", "w") as out:
+        countries_list = "' | '".join(list(map(lambda country: country["code"], data)))
+        out.write(f"export type AvailableCountries = '{countries_list}'")
 
     for countries in data:
         sub_countries = pycountry.subdivisions.get(country_code=countries["code"])

packages/countries/index.d.ts

@@ -0,0 +1,28 @@
+export interface Country {
+  name: string
+  dial_code: string
+  code: string
+  flag: string
+}
+
+export type Countries = Country[]
+
+export interface SubDivision {
+  code: string
+  country_code: string
+  name: string
+  parent_code: string | null
+  type: string
+}
+
+export type SubDivisions = SubDivision[]
+
+declare const List: Countries
+export default List
+
+declare module './subdivisions/*.json' {
+  const SubDivisionList: SubDivisions
+  export default SubDivisionList
+}
+
+export type AvailableCountries = import('./countries').AvailableCountries

packages/countries/package.json

@@ -3,6 +3,7 @@
   "version": "1.2.1",
   "description": "A package containing ISO 3166 and ISO 3166-2 codes",
   "main": "./countries.json",
+  "types": "./index.d.ts",
   "publishConfig": {
     "access": "public"
   },

packages/countries/poetry.lock

@@ -5,7 +5,7 @@ description = ""
 authors = [""]
 
 [tool.poetry.dependencies]
-python = "^3.0"
+python = "^3.6"
 pycountry = "^20.7.3"
 
 [tool.poetry.dev-dependencies]