Merge pull request #240 from AlexVlaso/task/th-230-eval-order-price

th-230:  Eval order price on the BE

Author: kalinkaaaa14

backend/.env.example

@@ -26,3 +26,8 @@ DB_CONNECTION_STRING=[db_client]://[db_username]:[db_user_password]@localhost:[d
 DB_DIALECT=pg
 DB_POOL_MIN=2
 DB_POOL_MAX=10
+
+#
+# API
+#
+GOOGLE_MAPS_API_KEY=YOUR_API_KEY

backend/package.json

@@ -32,19 +32,20 @@
     "@fastify/static": "6.10.2",
     "@fastify/swagger": "8.9.0",
     "@fastify/swagger-ui": "1.9.3",
+    "@googlemaps/google-maps-services-js": "3.3.38",
     "@types/bcryptjs": "2.4.3",
     "@types/convict": "6.1.3",
-    "@types/swagger-jsdoc": "6.0.1",
     "@types/nodemailer": "6.4.9",
+    "@types/swagger-jsdoc": "6.0.1",
     "bcryptjs": "2.4.3",
     "convict": "6.2.4",
     "dotenv": "16.3.1",
     "drizzle-kit": "0.19.12",
     "drizzle-orm": "0.28.2",
     "fastify": "4.21.0",
     "fastify-plugin": "4.5.1",
-    "jose": "4.14.4",
     "handlebars": "4.7.8",
+    "jose": "4.14.4",
     "nodemailer": "6.9.4",
     "pg": "8.11.3",
     "pino": "8.15.0",

backend/src/libs/packages/config/config.package.ts

@@ -133,6 +133,14 @@ class Config implements IConfig {
           default: null,
         },
       },
+      API: {
+        GOOGLE_MAPS_API_KEY: {
+          doc: 'Key for Google maps API',
+          format: String,
+          env: 'GOOGLE_MAPS_API_KEY',
+          default: null,
+        },
+      },
     });
   }
 }

backend/src/libs/packages/config/libs/types/environment-schema.type.ts

@@ -22,6 +22,9 @@ type EnvironmentSchema = {
     SMTP_TLS: boolean;
     SENDGRID_SENDER_EMAIL: string;
   };
+  API: {
+    GOOGLE_MAPS_API_KEY: string;
+  };
 };
 
 export { type EnvironmentSchema };

backend/src/packages/map/libs/constants/constants.ts

@@ -0,0 +1,3 @@
+const METERS_IN_ONE_KM = 1000;
+
+export { METERS_IN_ONE_KM };

backend/src/packages/map/libs/enums/enums.ts

@@ -0,0 +1 @@
+export { TravelMode } from '@googlemaps/google-maps-services-js';

backend/src/packages/map/libs/helpers/helpers.ts

@@ -0,0 +1,7 @@
+import { METERS_IN_ONE_KM } from '../constants/constants.js';
+
+const convertMetersToKm = (meters: number): number => {
+  return meters / METERS_IN_ONE_KM;
+};
+
+export { convertMetersToKm };

backend/src/packages/map/libs/types/types.ts

@@ -0,0 +1,4 @@
+export {
+  type Client,
+  type Distance,
+} from '@googlemaps/google-maps-services-js';

backend/src/packages/map/map.service.ts

@@ -0,0 +1,50 @@
+import { TravelMode } from './libs/enums/enums.js';
+import { convertMetersToKm } from './libs/helpers/helpers.js';
+import { type Client, type Distance } from './libs/types/types.js';
+
+class MapService {
+  private client: Client;
+
+  private key: string;
+
+  public constructor(client: Client, key: string) {
+    this.client = client;
+    this.key = key;
+  }
+
+  public async getDistance(
+    startPoint: string,
+    endPoint: string,
+  ): Promise<Distance> {
+    const response = await this.client.distancematrix({
+      params: {
+        key: this.key,
+        origins: [startPoint],
+        destinations: [endPoint],
+        mode: TravelMode.driving,
+      },
+    });
+    const [resultArray] = response.data.rows;
+    const [resultElement] = resultArray.elements;
+
+    return resultElement.distance;
+  }
+
+  public async getPriceByDistance({
+    startPoint,
+    endPoint,
+    pricePerKm,
+  }: {
+    startPoint: string;
+    endPoint: string;
+    pricePerKm: number;
+  }): Promise<number> {
+    const distance = await this.getDistance(startPoint, endPoint);
+    const km = convertMetersToKm(distance.value);
+    const orderPrice = (pricePerKm * km).toFixed(2);
+
+    return Number(orderPrice);
+  }
+}
+
+export { MapService };

backend/src/packages/map/map.ts

@@ -0,0 +1,12 @@
+import { Client } from '@googlemaps/google-maps-services-js';
+
+import { config } from '~/libs/packages/config/config.js';
+
+import { MapService } from './map.service.js';
+
+const mapService = new MapService(
+  new Client({}),
+  config.ENV.API.GOOGLE_MAPS_API_KEY,
+);
+
+export { mapService };