country-data-filter 1.0.5 → 1.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "country-data-filter",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "A package to filter country data",
   "main": "index.js",
   "scripts": {
@@ -23,7 +23,8 @@
   "author": "K N Nadeera",
   "license": "ISC",
   "files": [
-    "./src/index.js",
-    "./src/country-data.json"
+    "src/index.js",
+    "src/countries/LK.js",
+    "src/countries.js"
   ]
 }

package/src/countries/LK.js

@@ -0,0 +1,18 @@
+export const LK = {
+  name: "Sri Lanka",
+  province: {
+    southern: {
+      name: "Southern",
+      districts: {
+        matara: {
+          name: "Matara",
+          cities: [{ name: "Weligama", postalCode: 85700 }],
+        },
+        galle: {
+          name: "Galle",
+          cities: [{ name: "Galle", postalCode: 80000 }],
+        },
+      },
+    },
+  },
+};

package/src/index.js

@@ -1,20 +1,60 @@
-const { countryData } = require("./country-data");
+// src/index.js
 
-// Function to get the list of province names by country code
+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) {
-  const country = countryData.countries[code];
+  const country = countryData[code];
   if (country) {
-    // Return an array of province names
     return Object.values(country.province).map((province) => province.name);
   }
   return [];
 }
 
-// Function to get a list of district names by country code and province name
+/**
+ * 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) {
-  const country = countryData.countries[countryCode];
+  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
     );
@@ -22,9 +62,15 @@ function getDistrictsByProvince(countryCode, provinceName) {
   return [];
 }
 
-// Function to get city details by country code, province name, and district name
+/**
+ * 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) {
-  const country = countryData.countries[countryCode];
+  const country = countryData[countryCode];
   const province = country.province[provinceName];
   if (province && province.districts[districtName]) {
     return province.districts[districtName];
@@ -32,7 +78,10 @@ function getCityByDistrict(countryCode, provinceName, districtName) {
   return null;
 }
 
-// Function to list all available functions
+/**
+ * List all available functions.
+ * @returns {Object} - An object containing references to all the functions.
+ */
 function listFunctions() {
   return {
     getProvincesByCountry,
@@ -41,7 +90,6 @@ function listFunctions() {
   };
 }
 
-// Export all functions
 module.exports = {
   getProvincesByCountry,
   getDistrictsByProvince,