Merge branch 'main' of https://github.com/ubeydeozdmr/turkiye-api

ubeydeozdmr · Nov 13, 2024 · 7544e1f · 7544e1f
2 parents b4d7f87 + a8b9e31
commit 7544e1f
Show file tree

Hide file tree

Showing 9 changed files with 2,173 additions and 998 deletions.
diff --git a/README.md b/README.md
@@ -10,11 +10,13 @@ The API uses [turkiyeapi.dev](https://turkiyeapi.dev) as the main domain. But yo
 
 ## What's new?
 
-> _Latest update: November 4, 2024_
+> _Latest update: November 9, 2024_
 
-- New query parameters like `minArea` and `maxArea` added to the get-all-type routes.
-- You can now filter by province name or ID in the Get All Districts route.
-- You can now filter by province/district name or ID in Get All Neighborhoods, Get All Villages, Get All Towns routes.
+- Postal codes have been added to the provinces & districts. (Experimental feature)
+- Improvement about the filtering system.
+  - New query parameters like `minArea` and `maxArea` added to the get-all-type routes.
+  - You can now filter by province name or ID in the Get All Districts route.
+  - You can now filter by province/district name or ID in Get All Neighborhoods, Get All Villages, Get All Towns routes.
 
 ## Sources
 

diff --git a/src/v1/controller.js b/src/v1/controller.js
@@ -14,6 +14,8 @@ exports.getProvinces = (req, res) => {
       maxArea,
       minAltitude,
       maxAltitude,
+      activatePostalCodes,
+      postalCode,
       isMetropolitan,
       offset,
       limit,
@@ -29,6 +31,8 @@ exports.getProvinces = (req, res) => {
       maxArea,
       minAltitude,
       maxAltitude,
+      activatePostalCodes,
+      postalCode,
       isMetropolitan,
       offset,
       limit,
@@ -48,9 +52,14 @@ exports.getProvinces = (req, res) => {
 exports.getExactProvince = (req, res) => {
   try {
     const { id } = req.params;
-    const { fields, extend } = req.query;
+    const { fields, extend, activatePostalCodes } = req.query;
 
-    const province = Provinces.getExactProvince(id, fields, extend);
+    const province = Provinces.getExactProvince(
+      id,
+      fields,
+      extend,
+      activatePostalCodes,
+    );
 
     return res.send({ status: 'OK', data: province });
   } catch (error) {
@@ -69,6 +78,8 @@ exports.getDistricts = (req, res) => {
       maxPopulation,
       minArea,
       maxArea,
+      activatePostalCodes,
+      postalCode,
       provinceId,
       province,
       offset,
@@ -83,6 +94,8 @@ exports.getDistricts = (req, res) => {
       maxPopulation,
       minArea,
       maxArea,
+      activatePostalCodes,
+      postalCode,
       provinceId,
       province,
       offset,
@@ -103,9 +116,13 @@ exports.getDistricts = (req, res) => {
 exports.getExactDistrict = (req, res) => {
   try {
     const { id } = req.params;
-    const { fields } = req.query;
+    const { fields, activatePostalCodes } = req.query;
 
-    const district = Districts.getExactDistrict(id, fields);
+    const district = Districts.getExactDistrict(
+      id,
+      fields,
+      activatePostalCodes,
+    );
 
     return res.send({ status: 'OK', data: district });
   } catch (error) {

diff --git a/src/v1/data/Districts.js b/src/v1/data/Districts.js
@@ -8,6 +8,8 @@ exports.getDistricts = function (
   maxPopulation = 1000000000,
   minArea = 1,
   maxArea = 1000000000,
+  activatePostalCodes,
+  postalCode,
   provinceId,
   province,
   offset = 0,
@@ -16,7 +18,10 @@ exports.getDistricts = function (
   sort,
 ) {
   try {
-    let districts = data;
+    let districts =
+      activatePostalCodes === 'true'
+        ? data
+        : data.map(({ postalCode, ...rest }) => rest);
 
     if (!Object.values(arguments).some((item) => item)) {
       return districts;
@@ -75,6 +80,10 @@ exports.getDistricts = function (
       });
     }
 
+    if (postalCode) {
+      districts = districts.filter((item) => item.postalCode === postalCode);
+    }
+
     if (provinceId || province) {
       console.log(provinceId, province);
       if (provinceId && province) {
@@ -212,7 +221,7 @@ exports.getDistricts = function (
   }
 };
 
-exports.getExactDistrict = function (id, fields) {
+exports.getExactDistrict = function (id, fields, activatePostalCodes) {
   try {
     if (!isFinite(id)) {
       throw {
@@ -221,7 +230,11 @@ exports.getExactDistrict = function (id, fields) {
       };
     }
 
-    const district = data.find((item) => item.id === +id);
+    const district = activatePostalCodes
+      ? data.find((item) => item.id === +id)
+      : data
+          .map(({ postalCode, ...rest }) => rest)
+          .find((item) => item.id === +id);
 
     const districtNeighborhoods = neighborhoods
       .filter((neighborhood) => neighborhood.districtId === district.id)

diff --git a/src/v1/data/Provinces.js b/src/v1/data/Provinces.js
@@ -11,14 +11,19 @@ exports.getProvinces = function (
   maxArea = 1000000000,
   minAltitude = 0,
   maxAltitude = 10000,
+  activatePostalCodes,
+  postalCode,
   isMetropolitan,
   offset = 0,
   limit = 81,
   fields,
   sort,
 ) {
   try {
-    let provinces = data;
+    let provinces =
+      activatePostalCodes === 'true'
+        ? data
+        : data.map(({ postalCode, ...rest }) => rest);
 
     provinces.forEach((province) => {
       const provinceDistricts = districts
@@ -112,6 +117,10 @@ exports.getProvinces = function (
       });
     }
 
+    if (activatePostalCodes && postalCode) {
+      provinces = provinces.filter((item) => item.postalCode === postalCode);
+    }
+
     if (isMetropolitan) {
       if (isMetropolitan === 'true') {
         provinces = provinces.filter((item) => item.isMetropolitan === true);
@@ -227,7 +236,7 @@ exports.getProvinces = function (
   }
 };
 
-exports.getExactProvince = function (id, fields, extend) {
+exports.getExactProvince = function (id, fields, extend, activatePostalCodes) {
   try {
     if (!isFinite(id)) {
       throw {
@@ -236,15 +245,30 @@ exports.getExactProvince = function (id, fields, extend) {
       };
     }
 
-    const province = data.find((item) => item.id === +id);
+    const province = activatePostalCodes
+      ? data.find((item) => item.id === +id)
+      : data
+          .map(({ postalCode, ...rest }) => rest)
+          .find((item) => item.id === +id);
 
     const provinceDistricts = districts.filter(
       (district) => district.provinceId === province.id,
     );
 
-    province.districts = provinceDistricts.map(
-      ({ id, name, population, area }) => ({ id, name, population, area }),
-    );
+    province.districts = activatePostalCodes
+      ? provinceDistricts.map(({ id, name, population, area, postalCode }) => ({
+          id,
+          name,
+          population,
+          area,
+          postalCode,
+        }))
+      : provinceDistricts.map(({ id, name, population, area }) => ({
+          id,
+          name,
+          population,
+          area,
+        }));
 
     if (extend === 'true') {
       province.districts.forEach((district) => {