country-code-kit 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shrikanta Mazumder
+
+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,6 +1,6 @@
 # country-kit
 
-Zero-dependency TypeScript package with all **249 ISO 3166-1 countries** — alpha-2 code, English name, and flag emoji — plus fast lookup and search helpers. Ships dual ESM + CJS builds with full type declarations. Works in Node and browsers, tree-shakeable, ~10 KB.
+Zero-dependency TypeScript package with all **249 ISO 3166-1 countries** — alpha-2 code, English name, flag emoji, and ITU dial code — plus fast lookup and search helpers. Ships dual ESM + CJS builds with full type declarations. Works in Node and browsers, tree-shakeable, ~10 KB.
 
 ## Install
 
@@ -18,27 +18,34 @@ import {
   getCountryByFlag,
   getFlag,
   getName,
+  getDialCode,
+  getCountriesByDialCode,
   isValidCode,
   searchCountries,
   codeToFlag,
   flagToCode,
 } from "country-kit";
 
-countries.length;             // 249
-getCountryByCode("in");       // { code: "IN", name: "India", flag: "🇮🇳" }
-getCountryByName("Japan");    // { code: "JP", name: "Japan", flag: "🇯🇵" }
-getCountryByFlag("🇩🇪");      // { code: "DE", name: "Germany", flag: "🇩🇪" }
+countries.length;                    // 249
+getCountryByCode("in");              // { code: "IN", name: "India", flag: "🇮🇳", dialCode: "+91" }
+getCountryByName("Japan");           // { code: "JP", name: "Japan", flag: "🇯🇵", dialCode: "+81" }
+getCountryByFlag("🇩🇪");             // { code: "DE", name: "Germany", flag: "🇩🇪", dialCode: "+49" }
 
-getFlag("BD");                // "🇧🇩"
-getName("FR");                // "France"
-isValidCode("zz");            // false
+getFlag("BD");                       // "🇧🇩"
+getName("FR");                       // "France"
+getDialCode("BD");                   // "+880"
+getDialCode("AQ");                   // null  (territory with no assigned dial code)
+isValidCode("zz");                   // false
+
+getCountriesByDialCode("+1");
+// [{ code: "US", ... }, { code: "CA", ... }, ...]  — all territories sharing +1
 
 searchCountries("uni");
 // [United Arab Emirates, United Kingdom, United States, ...]
 // ranked: exact match → prefix match → substring match
 
-codeToFlag("NP");             // "🇳🇵" (no lookup table needed)
-flagToCode("🇳🇵");            // "NP"
+codeToFlag("NP");                    // "🇳🇵" (no lookup table needed)
+flagToCode("🇳🇵");                   // "NP"
 ```
 
 CommonJS works too:
@@ -56,6 +63,8 @@ const { getName } = require("country-kit");
 | `getCountryByName(name)` | `Country \| undefined` (case-insensitive) |
 | `getCountryByFlag(flag)` | `Country \| undefined` |
 | `getFlag(code)` / `getName(code)` | `string \| undefined` |
+| `getDialCode(code)` | `string \| null \| undefined` — `null` for territories with no dial code |
+| `getCountriesByDialCode(dialCode)` | `Country[]` — all countries sharing a dial code (e.g. `"+1"`) |
 | `isValidCode(code)` | `boolean` |
 | `searchCountries(query)` | `Country[]` ranked by match quality |
 | `codeToFlag(code)` | `string` (throws on invalid input) |
@@ -63,24 +72,13 @@ const { getName } = require("country-kit");
 
 ```ts
 interface Country {
-  code: string; // ISO 3166-1 alpha-2, e.g. "IN"
-  name: string; // English short name, e.g. "India"
-  flag: string; // Flag emoji, e.g. "🇮🇳"
+  code: string;          // ISO 3166-1 alpha-2, e.g. "IN"
+  name: string;          // English short name, e.g. "India"
+  flag: string;          // Flag emoji, e.g. "🇮🇳"
+  dialCode: string | null; // ITU calling code incl. "+", e.g. "+880". Null for territories with no assigned code.
 }
 ```
 
-## Scripts
-
-```bash
-npm run build   # compile ESM + CJS to dist/
-npm test        # run Node's built-in test runner
-```
-
-## Publishing
-
-1. Pick a unique name in `package.json` (check `npm view <name>` first — `country-kit` may be taken).
-2. `npm login`
-3. `npm publish` (runs build + tests automatically via `prepublishOnly`)
 
 ## License