country-region-data
TypeScript icon, indicating that this package has built-in type declarations

3.0.0 • Public • Published

country-region-data

This repo provides country and region data in three different formats: es6, UMD (Unified Module Definition) and plain JSON. The data contains country names, country short codes, country regions, and country region short codes. All country names and short codes are guaranteed to be unique. Similarly, all regions and region short codes within a single country are guaranteed to be unique.

Countries can subdivide themselves in all sorts of different ways, often overlapping. They may have states, provinces, regions, districts, municipalities, and more. The goal of this repo was to house whatever subdivisions makes sense from the viewpoint of addressing, and for that we use ISO-3166-2.

The raw data here is used for the country-region-selector, react-country-region-selector scripts but can be used independently for whatever you want.

Install

This package is available as an npm package. Install with your package manager of choice:

pnpm install country-region-data
yarn add country-region-data
npm install country-region-data

Structure

See the data.json file in the root folder for the raw data. The JSON is of the form:

[
  {
    "countryName": "Ecuador",
    "countryShortCode": "EC",
    "regions": [
      {
        "name": "Azuay",
        "shortCode": "A"
      },
      ...
    ]
  },
  ... 
]

The data.json file is the source of truth for the data set, but the generated build artifacts (not seen the repo - only in the npm package) are:

dist/data.js
dist/data-umd.js

The first one is an es6 file containing all the data in tree-shakeable format; the second is a UMD file containing the entire content. As of 3.0.0, the main package.json entry links to the UMD format and the module entry links to the es6 format.

How to use

The es6 file can be imported like so:

import { allCountries } from 'country-region-data';

If you're using typescript you'll get all the typings and see the structure of the exported data in your IDE. If not, check your node_modules/country-region-data/dist folder and look at the data.d.ts file to get the full list of exported information.

The UMD file can be used like this:

import countryRegionData from 'country-region-data/dist/data-umd';

The raw JSON like this:

const json = require('country-region-data/data.json');

Note I slipped into CJS there - node lets you read JSON files by default, so if you want in es6 format (import json from X), you'll need to configure your system (webpack, rollup etc.) with a loader/plugin to let it read JSON directly.

Typings

There are three different formats for the repo data: JSON, UMD and ES6. I figure es6 is going to be the most likely used format, so the generated typings file (dist/data.d.ts) is for the es6 version, and referenced in the "typings" property in the package.json file. It should be automatically picked up by your IDEs.

There are no typings for the UMD or JSON format.

Contribute

Make your changes to the data.json file in the root folder.

Updates and fixes to the data is much appreciated! The region abbreviations in particular are not yet complete, so the more contributors the better. Regions that need ISO-3166-2 codes can be identified by having a missing shortCode property for each region. You can find them by cloning the repo, then running:

yarn install
npx grunt findIncomplete

That'll list all countries with regions that are missing region short codes. Wikipedia has a lot of the data listed here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Data Validation

Before contributing a PR, please validate the JSON content (if you don't, Travis will catch it for you!). To do that, run the following on your command line:

yarn install
npx grunt validate

That'll throw an error if the JSON is invalid or if some duplicate names were accidentally introduced. The error messages are pretty clear, I think.

Changelog

Note that this repo does not use semantic versioning. I realize that's pretty non-standard, but every change to this repo is a dataset change which is technically backward incompatible. So although we could be bumping the major version with each release, I think that that would be more problematic: apps can no longer use the ~ and ^ chars in their package.json files to get the latest content so updates would be manual and frequent. If people disagree about this let me know.

  • 3.0.0 - Aug 13, 2023 - Spain, Cayman Islands, Zambia, Romania, Nigeria, Philippines, Pakistan regions and shortcode updates.
    • Breaking change: the package.json file for this repo now added a module entry to link to the es6 format; the older main entry links to the older UMD format. This should work for all bundlers, but let us know if you encounter problems.
  • 2.7.0 - Dec 28, 2022 - Romanian regions and shortcodes updated.
  • 2.6.0 - July 28, 2022 - UK counties updated.
  • 2.5.0 - July 12, 2022 - Czech Republic regions updated.
  • 2.4.0 - Jun 2, 2022 - UK regions updated.
  • 2.3.0 - Apr 29, 2022.
    • Denmark, Eswatini data updated.
  • 2.2.0 - Mar 12, 2022.
    • Ukraine, Romania, Mexico data updated.
  • 2.1.0 - Feb 22, 2022.
    • countryTuples named export added to es6 bundle.
    • Data updates for Philippines, Taiwan, Nepal
  • 2.0.0 - Jan 4, 2022.
    • New export formats: es6 (default) as well as the old UMD and JSON.
    • Data updates for France, Bolivia, Vietnam.
  • 1.11.0 - Sept 22, 2021. Data updates: Vietnam. Thanks barnett!
  • 1.10.0 - Aug 10, 2021. Data updates: India, Nepal, Moldova regions. Thanks all!
  • 1.9.0 - July 26, 2021. Data updates: China regions. Thanks jshenk
  • 1.8.0 - July 25, 2021. Data updates: Morocco, India, Iceland, Honduras. Thanks all!
  • 1.7.0 - Nov 20, 2020. Data updates: France, Norway, Mali, Croatia, Paraguau, Taiwan, Kosovo, Morocco. Thanks mohouyizme, fabrice102, nicoepp, sc0Vu, ibravoh149 and EPRenaud.
  • 1.6.0 - Mar 28, 2020. Data updates. Spain data updated. Thanks gui64.
  • 1.5.1 - Nov 14, 2019. Data updates. Polish and UK data updated. Thanks nguyennghi3489.
  • 1.5.0 - Sept 22, 2019. Data updates. All versions changes on github will now be listed in milestones.
  • 1.4.7 - Aug 26, 2019. Data updates. Ghana regions updated.
  • 1.4.6 - Aug 14, 2019. Data updates: Hong Kong region shortcode added; Great Britain regions updated; typescript types.
  • 1.4.5 - Nov 28, 2018. Data updates.
  • 1.4.4 - July 8, 2018. Data updates.
  • 1.4.3 - May 29, 2018. More data updates.
  • 1.4.2 - Nov 7, 2017. Data updates.
  • 1.4.1 - Nov 5, 2017. Data updates.
  • 1.4.0 - July 25, 2017. Version bump, no changes.
  • 1.3.6 - July 5, 2017. JS version added of the json file (thanks jayeb!!). Minor bug fixes.
  • 1.3.5 - Apr 20, 2017. Misc updates. Thanks all!
  • 1.3.4 - Dec 31, 2016. Mexico region update - thanks richi3f!
  • 1.3.3 - Dec 22, 2016. French region fix - thanks JMartelot!
  • 1.3.2 - Oct 31, 2016. Lots more region short codes (thanks again, ellenhutchings!).
  • 1.3.1 - Sept 23, 2016. Fix for incorrect shortcodes in Japanese prefectures.
  • 1.3.0 - July 1, 2016. Improved validation added to ensure uniqueness of country names, short codes, region names and shortcodes. Various country region additions / updates.
  • 1.2.1 - Jun 7, 2016. Taiwan country name change. Travis build status added + basic JSON syntax validation.
  • 1.2.0 - May 14, 2015. Lots more region short codes (again, thanks Ellen!). JSON syntax fixes.
  • 1.1.1 - April 30, 2016. JSON syntax fixes.
  • 1.1.0 - April 30, 2016. Looooads of new region shortcodes added thanks to ellenhutchings. Thanks, Ellen!
  • 1.0.0 - April 29, 2016. initial version

License

MIT.

Readme

Keywords

Package Sidebar

Install

npm i country-region-data

Weekly Downloads

24,742

Version

3.0.0

License

MIT

Unpacked Size

844 kB

Total Files

10

Last publish

Collaborators

  • benkeen