country-codes-list 1.6.12 → 2.1.0

package/README.md

@@ -1,8 +1,14 @@
 # country-codes-list
 
-Module with list of codes per country, which includes:
+Module with list of codes per country, including country codes, currency codes, and more.
 
-- Country code (ISO 3166-1 alpha-2): Obtained from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+> [!WARNING]
+> Release v2.0.0 introduces breaking changes with full TypeScript support and automated testing/publishing.
+
+## Features
+
+- 2 digit country code (ISO 3166-1 alpha-2): Obtained from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+- 3 digit country code (ISO 3166-1 alpha-3): Obtained from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)
 - Country Name: Each name in english and in the local country language
 - Currency Code (ISO 4217): Obtained from [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217)
 - Currency Name (ISO 4217): Obtained from [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217)
@@ -13,6 +19,30 @@ Module with list of codes per country, which includes:
 - Country Calling Code: The phone calling code for the country. Obtained from [Wikipedia](https://en.wikipedia.org/wiki/List_of_country_calling_codes#Alphabetical_listing_by_country_or_region).
 - Region: The Regional Classifications are from the [International Telecommunications Union](http://www.itu.int/ITU-D/ict/definitions/regions/index.html). Seen [here](https://meta.wikimedia.org/wiki/List_of_countries_by_regional_classification)
 
+## Installation
+
+Install the package via npm:
+
+```bash
+npm install --save country-codes-list
+```
+
+## Build & Test
+
+To compile the package, run:
+
+```bash
+npm run build
+```
+
+The compiled output will be in the `dist/` folder.
+
+To run tests:
+
+```bash
+npm test
+```
+
 # Installation
 
 ## Install the NPM module
@@ -21,27 +51,87 @@ Module with list of codes per country, which includes:
     npm install --save country-codes-list
 ```
 
+## Migration Guide (v1.x to v2.0)
+
+### Breaking Changes
+
+1. **TypeScript Types**: If you were using types:
+
+   ```typescript
+   // Old (v1.x)
+   import { CountryProperty } from "country-codes-list";
+   const prop: CountryProperty = CountryProperty.countryCode;
+
+   // New (v2.0)
+   import type { CountryProperty } from "country-codes-list";
+   const prop: CountryProperty = "countryCode";
+   ```
+
+2. **Module Imports**: Now supports both CommonJS and ES modules:
+
+   ```javascript
+   // CommonJS (still works)
+   const countryCodes = require("country-codes-list");
+
+   // ES Modules (new)
+   import * as countryCodes from "country-codes-list";
+   ```
+
+3. **Stricter Types**: Some functions now have stricter type checking:
+   ```typescript
+   // This now requires valid country property keys
+   countryCodes.filter("invalidKey", "value"); // TypeScript error
+   ```
+
 ## Usage
 
-### customList method:
-
-Just import the module and call the customList method. The first parameter must be the key you want for your object, and the second parameter must be a string with placeholders written as you need. The placeholders are defined between brackets (`{placeholder}`).
-
-The possible values for the object key and the placeholders are:
-
-- countryNameEn
-- countryNameLocal
-- countryCode
-- currencyCode
-- currencyNameEn
-- tinType
-- tinName
-- officialLanguageCode
-- officialLanguageNameEn
-- officialLanguageNameLocal
-- countryCallingCode
-- region
-- globalSouth
+This package can be used in both CommonJS (JavaScript) and TypeScript environments.
+
+### CommonJS
+
+```js
+const countryCodes = require("country-codes-list");
+
+const myCountryCodesObject = countryCodes.customList(
+  "countryCode",
+  "[{countryCode}] {countryNameEn}: +{countryCallingCode}"
+);
+
+console.log(myCountryCodesObject);
+```
+
+### TypeScript
+
+```ts
+import * as countryCodes from "country-codes-list";
+
+const myCountryCodesObject = countryCodes.customList(
+  "countryCode",
+  "[{countryCode}] {countryNameEn}: +{countryCallingCode}"
+);
+console.log(myCountryCodesObject);
+```
+
+### API Details – customList Method
+
+- The first parameter is the key used for the returned object's property.
+- The second parameter is a string with placeholders (in `{placeholder}` format) replaced by corresponding country properties.
+
+The available placeholders are:
+
+- `countryNameEn`
+- `countryNameLocal`
+- `countryCode`
+- `currencyCode`
+- `currencyNameEn`
+- `tinType`
+- `tinName`
+- `officialLanguageCode`
+- `officialLanguageNameEn`
+- `officialLanguageNameLocal`
+- `countryCallingCode`
+- `region`
+- `globalSouth`
 
 #### Example
 

package/dist/countriesData.d.ts

@@ -0,0 +1,21 @@
+type CountryData = {
+    countryNameEn: string;
+    countryNameLocal: string;
+    countryCode: string;
+    countryCodeAlpha3: string;
+    currencyCode: string;
+    currencyNameEn: string;
+    tinType: string;
+    tinName: string;
+    officialLanguageCode: string;
+    officialLanguageNameEn: string;
+    officialLanguageNameLocal: string;
+    countryCallingCode: string;
+    areaCodes?: any[];
+    region: string;
+    flag: string;
+};
+type CountryProperty = keyof CountryData;
+declare const countriesData: CountryData[];
+export type { CountryData, CountryProperty };
+export default countriesData;