countrynormalizer 0.1.1 → 0.2.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 JackMcE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,7 +1,23 @@
 # 🌎 Country Data Lookup And Normalizer 🌍
 
+[![CI](https://github.com/JackMcE/CountryNormalizer/actions/workflows/ci.yml/badge.svg)](https://github.com/JackMcE/CountryNormalizer/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/countrynormalizer.svg)](https://www.npmjs.com/package/countrynormalizer)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Coverage](https://codecov.io/gh/JackMcE/CountryNormalizer/branch/main/graph/badge.svg)](https://codecov.io/gh/JackMcE/CountryNormalizer)
+[![npm downloads](https://img.shields.io/npm/dm/countrynormalizer.svg)](https://www.npmjs.com/package/countrynormalizer)
+
 A simple library for consolidation and reverse lookup of common ISO country data fields and calling codes all in one place.
 
+## Installation
+
+```bash
+npm install countrynormalizer
+```
+
+```bash
+bun add countrynormalizer
+```
+
 Developers routinely need to mix and match pieces of country data across an application.
 
 Some common examples are:
@@ -221,6 +237,34 @@ This function returns a trimmed down set of country data for each country on the
 
 If you need absolutely all information about every country on a continent use the `findAllMatchedCountries()` function with a continent entered.
 
+### List All Countries:
+
+You can call `getAllCountries()` to return the complete countries data set. The response is properly typed so it should be decently easy to work with.
+
+This is a massive array of objects for every country on Earth contained in the ISO 3166 list.
+
+This may be helpful for understanding the data shapes, visualizing all the data, or shaping information in ways the package functions/APIs do not support natively.
+
+## Data Sources:
+This data is compiled from a wide array of sources. To give transparency to this I want to document the primary source or reason for each field.
+
+* common_reference: This is a field made up by me as the publisher. This is how people might "commonly refer to a country" in conversation. The full name of Iran formally is "Iran, Islamic Republic of" but most people just say "Iran." That is the idea behind this field. Easily lookup how most English speakers would refer to a country.
+* english_clean: This comes off of the "country name using title case" column on the wikipedia Alpha 2 documentation for ISO 3166: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+* formal_order: On Wikipedia and other sources for easy Alpabetization they order countries by common names. So "Netherlands, Kingdom of the", this just puts it in order as "Kingdom of the Netherlands."
+* alpha_2: ISO 3166 Alpha 2 values as listed on wikipedia: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+* alpha_3: Taken from Wikipedia ISO 3166 master table: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
+* num_code: Taken from Wikipedia ISO 3166 master table: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
+* demonym_male: ChatGTP deep research compiled CSV dataset asking it to align ISO Alpha 3 codes to demonym by country for both male and female.
+* demonym_female: ChatGTP deep research compiled CSV dataset asking it to align ISO Alpha 3 codes to demonym by country for both male and female.
+* gendered_demonym: Manual alignment in Google Sheet by me comparing `demonym_male` and `demonym_male` for string differences and setting a boolean.
+* tld: Taken from Wikipedia ISO 3166 master table: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
+* flag_emoji: Used table available on Flagepedia and then cleaned up the data for easy usage in CSVs and JSON objects: https://flagpedia.net/emoji
+* calling_code: ChatGPT compiled deep research task. Instructed to rely primarily on these data sources to make data easily worked with in a CSV and as JSON objects.
+* * https://en.wikipedia.org/wiki/Trunk_prefix
+* * https://en.wikipedia.org/wiki/List_of_telephone_country_codes
+* * https://www.countrycode.org/
+* continent: ChatGPT deep research compiled list asking to align all ISO Alpha 3 country codes to their continent.
+
 ## To-Do List:
 This package was started as part of language classification and news analytics projects I'm working on in my personal time.
 

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { findCountryByUnique, findAllMatchedCountries } from "./src/findCountryByUnqiue";
 import { getContactFieldsByAlpha2 } from "./src/getCountryContactData";
 import { getCountriesByContinent } from "./src/getCountriesByContinent";
+import { getAllCountries } from "./src/getAllCountries";
 import type { AllCountryFields, ContactCountryFields, ContinentNames, ContinentTrimmedFields } from "./types/core";
-export { findCountryByUnique, findAllMatchedCountries, getContactFieldsByAlpha2, getCountriesByContinent, };
+export { findCountryByUnique, findAllMatchedCountries, getContactFieldsByAlpha2, getCountriesByContinent, getAllCountries, };
 export type { AllCountryFields, ContactCountryFields, ContinentNames, ContinentTrimmedFields, };