country-data-filter 1.0.7 → 1.0.8

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "country-data-filter",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "A package to filter country data",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "scripts": {
     "test": "jest"
   },
   "devDependencies": {
-    "jest": "^29.0.0"
+    "jest": "^29.0.0",
+    "typescript": "^5.0.0"
   },
   "repository": {
     "type": "git",
@@ -24,7 +26,6 @@
   "license": "ISC",
   "files": [
     "src/index.js",
-    "src/countries/LK.js",
-    "src/countries.js"
+    "src/countries/*.js"
   ]
 }

package/src/index.js

@@ -1,60 +1,20 @@
-// src/index.js
+import { countryData } from "./country-data.js";
 
-const { countryData } = require("./countries.js");
-
-/**
- * @typedef {Object} City
- * @property {string} name
- * @property {number} postalCode
- */
-
-/**
- * @typedef {Object} District
- * @property {string} name
- * @property {City[]} cities
- */
-
-/**
- * @typedef {Object} Province
- * @property {string} name
- * @property {Object<string, District>} districts
- */
-
-/**
- * @typedef {Object} Country
- * @property {string} name
- * @property {Object<string, Province>} province
- */
-
-/**
- * @type {Object<string, Country>}
- */
-const countryData = {
-  // Data here
-};
-
-/**
- * Get the list of province names by country code.
- * @param {string} code - The country code.
- * @returns {string[]} - An array of province names.
- */
-function getProvincesByCountry(code) {
+// Function to get the list of province names by country code
+export function getProvincesByCountry(code) {
   const country = countryData[code];
   if (country) {
+    // Return an array of province names
     return Object.values(country.province).map((province) => province.name);
   }
   return [];
 }
 
-/**
- * Get a list of district names by country code and province name.
- * @param {string} countryCode - The country code.
- * @param {string} provinceName - The province name.
- * @returns {string[]} - An array of district names.
- */
-function getDistrictsByProvince(countryCode, provinceName) {
+// Function to get a list of district names by country code and province name
+export function getDistrictsByProvince(countryCode, provinceName) {
   const country = countryData[countryCode];
   if (country && country.province[provinceName]) {
+    // Return an array of district names
     return Object.values(country.province[provinceName].districts).map(
       (district) => district.name
     );
@@ -62,14 +22,8 @@ function getDistrictsByProvince(countryCode, provinceName) {
   return [];
 }
 
-/**
- * Get city details by country code, province name, and district name.
- * @param {string} countryCode - The country code.
- * @param {string} provinceName - The province name.
- * @param {string} districtName - The district name.
- * @returns {District | null} - The district object or null if not found.
- */
-function getCityByDistrict(countryCode, provinceName, districtName) {
+// Function to get city details by country code, province name, and district name
+export function getCityByDistrict(countryCode, provinceName, districtName) {
   const country = countryData[countryCode];
   const province = country.province[provinceName];
   if (province && province.districts[districtName]) {
@@ -78,21 +32,11 @@ function getCityByDistrict(countryCode, provinceName, districtName) {
   return null;
 }
 
-/**
- * List all available functions.
- * @returns {Object} - An object containing references to all the functions.
- */
-function listFunctions() {
+// Function to list all available functions
+export function listFunctions() {
   return {
     getProvincesByCountry,
     getDistrictsByProvince,
     getCityByDistrict,
   };
 }
-
-module.exports = {
-  getProvincesByCountry,
-  getDistrictsByProvince,
-  getCityByDistrict,
-  listFunctions,
-};