feat(DepInjection, and Places): Move to dep injection to allow for scoped access to the API along with pulling stop details from a Go Transit Stop

Author: EntraptaJ

package-lock.json

@@ -43,6 +43,7 @@
     "class-validator": "^0.14.0",
     "got": "^12.6.0",
     "icloudjs": "^1.4.0",
-    "reflect-metadata": "^0.1.13"
+    "reflect-metadata": "^0.1.13",
+    "typedi": "^0.10.0"
   }
 }

package.json

@@ -0,0 +1,115 @@
+// src/Modules/GoTransit/Stop/StopDetails.ts
+
+import { Type } from 'class-transformer';
+import { IsString } from 'class-validator';
+import { Service } from 'typedi';
+
+@Service()
+export class GoTransitPlaceStop {
+  @Type(() => String)
+  public Code: string;
+
+  @Type(() => String)
+  public Name: string;
+
+  @Type(() => String)
+  public NameFr: string;
+}
+
+@Service()
+export class GoTransitPlaceStops {
+  @Type(() => GoTransitPlaceStop)
+  public Stop?: GoTransitPlaceStop[];
+}
+
+@Service()
+export class GoTransitPlace {
+  @Type(() => String)
+  public Code: string;
+
+  @Type(() => String)
+  public Name: string;
+
+  @Type(() => Number)
+  public Longitude: number;
+
+  @Type(() => Number)
+  public Latitude: number;
+
+  @Type(() => Number)
+  public Radius: number;
+
+  @Type(() => GoTransitPlaceStops)
+  public Stops?: GoTransitPlaceStops;
+}
+
+export class GoTransitStopFacilities {
+  @Type(() => String)
+  @IsString()
+  /**
+   * TODO Figure these codes out to an ENUM
+   */
+  public Code: string;
+
+  @Type(() => String)
+  @IsString()
+  public Description: string;
+
+  @Type(() => String)
+  @IsString()
+  public DescriptionFr: string;
+}
+
+@Service()
+export class GoTransitStopDetails {
+  @Type(() => String)
+  public ZoneCode: string;
+
+  @Type(() => String)
+  public StreetNumber: string;
+
+  @Type(() => String)
+  public Intersection: string;
+
+  @Type(() => String)
+  public City: string;
+
+  @Type(() => String)
+  public Code: string;
+
+  @Type(() => String)
+  public StopName: string;
+
+  @Type(() => String)
+  public StopNameFr: string;
+
+  @Type(() => Boolean)
+  public IsBus: boolean;
+
+  @Type(() => Boolean)
+  public IsTrain: boolean;
+
+  @Type(() => Number)
+  public Longitude: number;
+
+  @Type(() => Number)
+  public Latitude: number;
+
+  @Type(() => String)
+  public DrivingDirections?: string;
+
+  @Type(() => String)
+  public DrivingDirectionsFr?: string;
+
+  public BoardingInfo?: string;
+
+  public BoardingInfoFr?: string;
+
+  @Type(() => GoTransitStopFacilities)
+  public Facilities: GoTransitStopFacilities[];
+
+  public Parkings?: any[];
+
+  @Type(() => GoTransitPlace)
+  public Place: GoTransitPlace;
+}

src/Modules/GoTransit/Stop.ts

@@ -0,0 +1,42 @@
+// src/Modules/GoTransit/Stops.ts
+import { TransformPlainToInstance, Type } from 'class-transformer';
+import { IsString } from 'class-validator';
+import { Container, Service } from 'typedi';
+import { APIResponse, GoTransit } from '..';
+import { GoTransitStopDetails } from './StopDetails';
+
+export enum GoTransitStopType {
+  BUS = 'Bus Stop',
+  TRAIN = 'Train Station',
+  TRAINBUS = 'Train & Bus Station',
+  BUSTERMINAL = 'Bus Terminal',
+  PARKNRIDE = 'Park & Ride',
+}
+
+@Service()
+export class GoTransitStop {
+  @Type(() => String)
+  @IsString()
+  public LocationCode: string;
+
+  @Type(() => String)
+  @IsString()
+  public LocationName: string;
+
+  @Type(() => String)
+  @IsString()
+  public PublicStopId: string;
+
+  public LocationType: GoTransitStopType;
+
+  @TransformPlainToInstance(GoTransitStopDetails)
+  public async getStopDetails(): Promise<GoTransitStopDetails> {
+    const goAPI = Container.get<GoTransit>('transitAPI');
+
+    const { Stop } = await goAPI.makeRequest<
+      APIResponse & { Stop: GoTransitStopDetails }
+    >(`Stop/Details/${this.LocationCode}`);
+
+    return Stop;
+  }
+}

src/Modules/GoTransit/Stop/Place.ts

@@ -1,9 +1,10 @@
 // src/Modules/GoTransit/index.ts
-import { plainToInstance } from 'class-transformer';
+import { plainToInstance, TransformPlainToInstance } from 'class-transformer';
 import got, { OptionsOfJSONResponseBody } from 'got';
+import { Service } from 'typedi';
 import { CONFIG } from '../../Library/Config';
 import { logger, LogMode } from '../../Library/Logger';
-import { GoTransitStop, GoTransitStopType } from './Stop';
+import { GoTransitStop } from './Stop';
 import { GoTransitTrainTrip } from './TrainTrip';
 import { GoTransitUnionDepartureTrip } from './UnionDeparture';
 
@@ -21,10 +22,11 @@ interface APIMetadata {
   ErrorMessage: string;
 }
 
-interface APIResponse {
+export interface APIResponse {
   Metadata: APIMetadata;
 }
 
+@Service()
 export class GoTransit {
   private config: GoTransitConfig = {
     apiToken: CONFIG.token,
@@ -45,7 +47,7 @@ export class GoTransit {
     },
   });
 
-  private async makeRequest<ResponseType extends APIResponse>(
+  public async makeRequest<ResponseType extends APIResponse>(
     url: string,
     options?: OptionsOfJSONResponseBody,
   ): Promise<ResponseType> {
@@ -66,7 +68,7 @@ export class GoTransit {
   /**
    * Gets all the trains soon arriving at Union and the platform allocation
    * if provided/same as the departure board/go tracker.
-   * 
+   *
    * @returns array of GoTransitUnionDepartureTrip
    */
   public async unionDepartures(): Promise<GoTransitUnionDepartureTrip[]> {
@@ -80,7 +82,6 @@ export class GoTransit {
     );
   }
 
-
   /**
    * Function to get all active trains within the Go Transit network.
    *
@@ -96,15 +97,16 @@ export class GoTransit {
 
   /**
    * Get all Go Transit Stops within the network
-   * 
-   * @returns Array of all Go Transit Bus Stops, 
+   *
+   * @returns Array of all Go Transit Bus Stops,
    * Bus Terminals, Bus & Train Stations, and Park & Ride Stops
    */
+  @TransformPlainToInstance(GoTransitStop)
   public async getAllStops(): Promise<GoTransitStop[]> {
     const response = await this.makeRequest<
       APIResponse & { Stations: { Station: GoTransitStop[] } }
     >('Stop/All');
 
-    return plainToInstance(GoTransitStop, response.Stations.Station);
+    return response.Stations.Station;
   }
 }

src/Modules/GoTransit/Stop/StopDetails.ts

@@ -30,6 +30,6 @@ export class User {
    * Sends notification to user via her Apple Watch Ultra
    */
   public async notifyUser(options: { subject?: string; text?: string }) {
-    await sendAlert(this.deviceID, options);
+    return sendAlert(this.deviceID, options);
   }
 }

src/Modules/GoTransit/Stop/index.ts

@@ -1,5 +1,8 @@
 // src/index.ts
 import 'reflect-metadata';
+import { Container } from 'typedi';
+import { useContainer } from 'class-validator';
+
 import { CONFIG } from './Library/Config';
 import { logger, LogMode } from './Library/Logger';
 import { GoTransit } from './Modules/GoTransit';
@@ -21,12 +24,15 @@ logger.log(LogMode.INFO, `Starting TransitRouting`);
 //   text: 'Platform 6 & 7'
 // })
 
-const goAPI = new GoTransit({
-  apiURL: CONFIG.apiURL,
+useContainer(Container);
 
+const goAPI = new GoTransit({
   apiToken: CONFIG.token,
+  apiURL: CONFIG.apiURL,
 });
 
+Container.set('transitAPI', goAPI);
+
 logger.log(LogMode.INFO, `Making request`);
 
 // const unionDepartures = await goAPI.unionDepartures();
@@ -51,6 +57,14 @@ logger.log(LogMode.INFO, `Making request`);
 //   }
 // }
 
+const stops = await goAPI.getAllStops();
+
+for (const stop of stops) {
+  const stopDetails = await stop.getStopDetails();
+
+  logger.log(LogMode.INFO, `Stop Details`, stopDetails);
+}
+
 await sayHello('K-FOSS');
 
 export {};