fshub-api 4.0.2 → 4.1.1

package/src/index.ts

@@ -1,5 +1,5 @@
 import axios, { AxiosInstance } from 'axios';
-import type{ Config, FSHubApi, FSHubPilotPointPurchaseTransactionData, FSHubPilotSetRankData, FSHubRequestOptions } from './types';
+import type{ Airport, Config, FSHubApi, FSHubPilotPointPurchaseTransactionData, FSHubPilotSetRankData, FSHubRequestOptions, FSHubResponse } from './types';
 import { Api } from './api';
 export * from './types';
 
@@ -52,10 +52,14 @@ export default class FSHubApiClass implements FSHubApi {
         this.Airline_pilotSetRank = this.Airline_pilotSetRank.bind(this);
         this.Airline_getAllRanks = this.Airline_getAllRanks.bind(this);
         this.Airline_getAllRoles = this.Airline_getAllRoles.bind(this);
-        
+        this.Airline_getAllRoutes = this.Airline_getAllRoutes.bind(this);
+
         this.Flight_getFlightById = this.Flight_getFlightById.bind(this);
         this.Flight_getFlightScreenshotsById = this.Flight_getFlightScreenshotsById.bind(this);
         this.Flight_getFlights = this.Flight_getFlights.bind(this);
+
+        this.Airport_findByICAO = this.Airport_findByICAO.bind(this);
+        this.Airport_findMETAR = this.Airport_findMETAR.bind(this);
     }
 
     public async Pilot_getCurrent() {
@@ -166,6 +170,10 @@ export default class FSHubApiClass implements FSHubApi {
         return await Api.airline.getAllRoles(airlineId, this);
     }
 
+    public async Airline_getAllRoutes(airlineId: number) {
+        return await Api.airline.getAllRoutes(airlineId, this);
+    }
+
     public async Flight_getFlightById(id: number) {
         return await Api.flight.getFlightById(id, this);
     }
@@ -177,4 +185,12 @@ export default class FSHubApiClass implements FSHubApi {
     public async Flight_getFlights(options?: FSHubRequestOptions) {
         return await Api.flight.getFlights(this, options);
     }
+
+    public async Airport_findByICAO(icao: string): Promise<FSHubResponse<Airport>> {
+        return await Api.airport.findByICAO(icao, this);
+    }
+
+    public async Airport_findMETAR(icao: string) {
+        return await Api.airport.findMETAR(icao, this);
+    }
 }

package/src/types/Airline.ts

@@ -0,0 +1,26 @@
+import { Gps, Handles, Link } from './Common';
+
+export type Owner = {
+  id: number
+  name: string
+  bio: any
+  handles: Handles
+  base: string
+  locale: string
+  gps: Gps
+  timezone: string
+  country: string
+  is_online: boolean
+  online_at: string
+  created_at: string
+  links: Link[]
+}
+
+export type Airline = {
+  id: number
+  name: string
+  abbr: string
+  owner: Owner
+  handles: Handles
+  links: Link[]
+}

package/src/types/AirlineRoute.ts

@@ -0,0 +1,60 @@
+export type AirlineRoute = {
+    id: number
+    name: string
+    airport: AirlineRouteAirport
+    routing: string
+    dist_nm: number
+    log: AirlineRouteLog[]
+    waypoints_ignored: string
+    notes: string
+    points: number
+    enabled: boolean
+    created_at: string
+    updated_at: string
+    links: AirlineRouteLink[]
+  }
+  
+  export type AirlineRouteAirport = {
+    departure: AirlineRouteDepartureAirport
+    arrival: AirlineRouteArrivalAirport
+  }
+  
+  export type AirlineRouteDepartureAirport = {
+    icao: string
+    iata: string
+    name: string
+    locale: AirlineRouteLocale
+  }
+  
+  export type AirlineRouteLocale = {
+    city: string
+    state: any
+    country: string
+    gps: AirlineRouteGps
+  }
+  
+  export type AirlineRouteGps = {
+    lat: number
+    lng: number
+  }
+  
+  export type AirlineRouteArrivalAirport = {
+    icao: string
+    iata: string
+    name: string
+    locale: AirlineRouteLocale
+  }
+  
+  export type AirlineRouteLog = {
+    ident: string
+    freq?: string
+    dist: number
+    coords: string
+    remarks: string
+  }
+  
+  export type AirlineRouteLink = {
+    rel: string
+    uri: string
+  }
+  

package/src/types/Airport.ts

@@ -0,0 +1,56 @@
+export type Airport = {
+    icao: string
+    iata: string
+    name: string
+    locale: AirportLocale
+    geo: AirportGeo
+    alt: number
+    mag_var: number
+    frequencies: AirportFrequencies
+    runways: AirportRunway[]
+    links: AirportLink[]
+  }
+  
+  export type AirportLocale = {
+    city: string
+    state: string
+    county: string
+  }
+  
+  export type AirportGeo = {
+    lat: number
+    lng: number
+  }
+  
+  export type AirportFrequencies = {
+    atis: string
+    cd: string
+    gnd: string
+    tower: string
+    unicom: string
+    multicom: any
+    app: string
+    dep: string
+  }
+  
+  export type AirportRunway = {
+    name: string
+    type: string
+    length: number
+    hdg: number
+    geo: AirportGeo
+    ils: AirportIls
+  }
+  
+  export type AirportIls = {
+    id?: string
+    frequency?: string
+    hdg?: number
+    slope?: number
+  }
+  
+  export type AirportLink = {
+    rel: string
+    uri: string
+  }
+  

package/src/types/AirportMETARReport.ts

@@ -0,0 +1,14 @@
+import { Link } from "./Common"
+
+export type AirportMETARReport = {
+    icao: string
+    iata: string
+    name: string
+    metar: AirportMETAR
+    links: Link[]
+}
+
+export type AirportMETAR = {
+    error: boolean
+    report: string
+}

package/src/types/Common.ts

@@ -0,0 +1,17 @@
+export type Link = {
+  rel: string
+  uri: string
+}
+
+export type Gps = {
+  lat: number
+  lng: number
+}
+
+export type Handles = {
+  facebook: any
+  twitter: string
+  website: any
+  vatsim: string
+  ivao: string
+}

package/src/types/Config.ts

@@ -0,0 +1,6 @@
+export type Config = {
+  baseURL?: string;
+  apiKey?: string;
+  timeout?: number;
+  headers?: Record<string, string>;
+};

package/src/types/FSHubAirline.ts

@@ -0,0 +1,73 @@
+export type FSHubAirlineRole = {
+  id: number;
+  name: string;
+  created_at: string;
+  updated_at: string;
+}
+
+export type FSHubAirlineRank = {
+  id: number;
+  name: string;
+  abbreviation: string;
+  min_hours: number;
+  created_at: string;
+  updated_at: string;
+}
+
+export type FSHubAirlinePilotStatsRoles = {
+  [key: string]: any; // TODO: Add proper type
+}
+
+export type FSHubAirlinePilotStatsUserProfile = {
+  avatar_url: string
+  bio: string
+}
+
+export type FSHubAirlinePilotStatsUserLocations = {
+  base: string
+  locale: string
+}
+
+export type FSHubAirlinePilotStatsUserHandles = {
+  website: any
+  twitter: any
+  facebook: any
+  vatsim: any
+  ivao: any
+}
+
+export type FSHubAirlinePilotStatsUser = {
+  id: number
+  name: string
+  email: string
+  profile: FSHubAirlinePilotStatsUserProfile
+  locations: FSHubAirlinePilotStatsUserLocations
+  handles: FSHubAirlinePilotStatsUserHandles
+  timezone: string
+  country: string
+}
+
+export type FSHubAirlinePilotStatsRank = {
+  id: number
+  name: string
+  abbreviation: string
+  min_hours: number
+  created_at: string
+  updated_at: string
+}
+
+export type FSHubAirlinePilotStatsLink = {
+  rel: string
+  uri: string
+}
+
+export type FSHubAirlinePilotStats = {
+  user: FSHubAirlinePilotStatsUser
+  points: number
+  carry_hours: number
+  rank: FSHubAirlinePilotStatsRank
+  roles: FSHubAirlinePilotStatsRoles[]
+  hired_at: string
+  discord_id: number
+  links: FSHubAirlinePilotStatsLink[]
+}

package/src/types/FSHubApi.ts

@@ -0,0 +1,56 @@
+import { AxiosInstance } from 'axios';
+import { Pilot } from './Pilot';
+import { CurrentPilot } from './Pilot';
+import { Flight } from './Flight';
+import { Airline } from './Airline';
+import { PilotStats } from './Stats';
+import { AirlineStats } from './Stats';
+import { Screenshot } from './Screenshot';
+import { FSHubRequestOptions } from './FSHubRequestOptions';
+import { FSHubResponse } from './FSHubResponse';
+import { FSHubApplicationResponse } from './FSHubApplication';
+import { FSHubPilotPointPurchaseTransactionData, FSHubPilotPointPurchaseTransactionResponse } from './FSHubPilotPointPurchase';
+import { FSHubPilotSetRankData } from './FSHubApplication';
+import { FSHubAirlineRank } from './FSHubAirline';
+import { FSHubAirlineRole } from './FSHubAirline';
+import { FSHubAirlinePilotStats } from './FSHubAirline';
+import { AirportMETARReport } from './AirportMETARReport';
+import { Airport } from './Airport';
+import { AirlineRoute } from './AirlineRoute';
+
+export type FSHubApi = {
+  axios: AxiosInstance
+  Pilot_getCurrent: () => Promise<FSHubResponse<CurrentPilot>>
+  Pilot_getAll: () => Promise<FSHubResponse<Pilot[]>>
+  Pilot_get: (id: number) => Promise<FSHubResponse<Pilot>>
+  Pilot_getLatestFlight: (id: number) => Promise<FSHubResponse<Flight>>
+  Pilot_getAllFlights: (id: number) => Promise<FSHubResponse<Flight[]>>
+  Pilot_getAllAirlines: (id: number) => Promise<FSHubResponse<Airline[]>>
+  Pilot_getStats: (id: number) => Promise<FSHubResponse<PilotStats>>
+  Pilot_getAllFlightsDepartures:(id:number, airportCode:string) => Promise<FSHubResponse<Flight[]>>
+  Pilot_getAllFlightsArrivals:(id:number, airportCode:string) => Promise<FSHubResponse<Flight[]>>
+  Pilot_getAllFlightDeparturesAndArrivals:(id:number, departureAirportCode:string, arrivalAirportCode:string) => Promise<FSHubResponse<Flight[]>>
+  Pilot_getAllScreenshots: (id: number) => Promise<FSHubResponse<Screenshot[]>>
+  Airline_getAll: () => Promise<FSHubResponse<Airline[]>>
+  Airline_get: (id: number) => Promise<FSHubResponse<Airline>>
+  Airline_getPilots: (id: number) => Promise<FSHubResponse<Pilot[]>>
+  Airline_getPilotStats: (id: number, pilotId: number) => Promise<FSHubResponse<FSHubAirlinePilotStats>>
+  Airline_getFlights: (id: number) => Promise<FSHubResponse<Flight[]>>
+  Airline_getAllFlightsDepartures:(id:number, airportCode:string) => Promise<FSHubResponse<Flight[]>>
+  Airline_getAllFlightsArrivals:(id:number, airportCode:string) => Promise<FSHubResponse<Flight[]>>
+  Airline_getAllFlightDeparturesAndArrivals:(id:number, departureAirportCode:string, arrivalAirportCode:string) => Promise<FSHubResponse<Flight[]>>
+  Airline_getAllScreenshots: (id: number) => Promise<FSHubResponse<Screenshot[]>>
+  Airline_getStats: (id: number) => Promise<FSHubResponse<AirlineStats>>
+  Airline_approveApplication: (pilotId: number, airlineId: number) => Promise<FSHubResponse<FSHubApplicationResponse>>
+  Airline_rejectApplication: (pilotId: number, airlineId: number) => Promise<FSHubResponse<FSHubApplicationResponse>>
+  Airline_pilotPointPurchase: (pilotId: number, airlineId: number, data: FSHubPilotPointPurchaseTransactionData) => Promise<FSHubResponse<FSHubPilotPointPurchaseTransactionResponse>>
+  Airline_pilotSetRank: (pilotId: number, airlineId: number, data: FSHubPilotSetRankData) => Promise<FSHubResponse<FSHubApplicationResponse>>
+  Airline_getAllRanks: (airlineId: number) => Promise<FSHubResponse<FSHubAirlineRank[]>>
+  Airline_getAllRoles: (airlineId: number) => Promise<FSHubResponse<FSHubAirlineRole[]>>
+  Airline_getAllRoutes: (airlineId: number) => Promise<FSHubResponse<AirlineRoute[]>>
+  Flight_getFlightById: (id: number) => Promise<FSHubResponse<Flight>>
+  Flight_getFlightScreenshotsById: (id: number) => Promise<FSHubResponse<Screenshot[]>>
+  Flight_getFlights: (options?: FSHubRequestOptions) => Promise<FSHubResponse<Flight[]>>
+  Airport_findByICAO: (icao: string) => Promise<FSHubResponse<Airport>>
+  Airport_findMETAR: (icao: string) => Promise<FSHubResponse<AirportMETARReport>>
+}

package/src/types/FSHubApplication.ts

@@ -0,0 +1,8 @@
+export type FSHubApplicationResponse = {
+  successful: boolean;
+  message: string;
+}
+
+export type FSHubPilotSetRankData = {
+  rank_id: number;
+}

package/src/types/FSHubError.ts

@@ -0,0 +1,8 @@
+export type FSHubError = {
+  message: string
+  code: number
+  error?: boolean
+  details?: {
+    pilot: number
+  }
+}

package/src/types/FSHubPilotPointPurchase.ts

@@ -0,0 +1,10 @@
+export type FSHubPilotPointPurchaseTransactionData = {
+  amount: number;
+  summary: string;
+}
+
+export type FSHubPilotPointPurchaseTransactionResponse = {
+  successful: boolean;
+  message: string;
+  transferred: number;
+}

package/src/types/FSHubRequestOptions.ts

@@ -0,0 +1,4 @@
+export type FSHubRequestOptions = {
+  cursor?: number;
+  limit?: number;
+}

package/src/types/FSHubResponse.ts

@@ -0,0 +1,11 @@
+export type FSHubResponse<T> = {
+  data: T
+  meta?: {
+    cursor: {
+      current: number
+      prev: number
+      next: number
+      count: number
+    }
+  }
+}

package/src/types/Flight.ts

@@ -0,0 +1,88 @@
+import { Airline } from './Airline';
+import { Link } from './Common';
+
+export type User = {
+  id: number
+  name: string
+}
+
+export type UserConf = {
+  tail: string
+  icao: string
+}
+
+export type Aircraft = {
+  icao: string
+  icao_name: string
+  name: string
+  type: string
+  user_conf: UserConf
+}
+
+export type Distance = {
+  nm: number
+  km: number
+}
+
+export type Average = {
+  spd: number
+}
+
+export type Max = {
+  alt: number
+  spd: number
+}
+
+export type Geo = {
+  lat: number
+  lng: number
+}
+
+export type Hdg = {
+  mag: number
+  true: number
+}
+
+export type Spd = {
+  tas: number
+}
+
+export type Wind = {
+  spd: number
+  dir: number
+}
+
+export type Airport = {
+  icao: string
+  iata: string
+  name: string
+  time: string
+  geo: Geo
+  hdg: Hdg
+  spd: Spd
+  fuel: number
+  pitch: number
+  bank: number
+  wind: Wind
+}
+
+export type Flight = {
+  id: number
+  user: User
+  airline: Airline
+  schedule_status: any
+  aircraft: Aircraft
+  plan: any
+  fuel_used: number
+  landing_rate: number
+  distance: Distance
+  average: Average
+  max: Max
+  time: number
+  tags: any[]
+  flags: any[]
+  points: number
+  departure: Airport
+  arrival: Airport
+  links: Link[]
+}

package/src/types/Pilot.ts

@@ -0,0 +1,21 @@
+import { Gps, Handles, Link } from './Common';
+
+export type Pilot = {
+  id: number
+  name: string
+  base: string
+  locale: string
+  gps: Gps
+  is_online: boolean
+  online_at: string
+  bio?: string
+  handles?: Handles
+  timezone?: string
+  country?: string
+  created_at?: string
+  links?: Link[]
+}
+
+export type CurrentPilot = Pilot & {
+  discord_id?: number
+}

package/src/types/Screenshot.ts

@@ -0,0 +1,15 @@
+import { Link } from './Common';
+
+export type Urls = {
+  fullsize: string
+  thumbnail: string
+}
+
+export type Screenshot = {
+  id: number
+  name: string
+  desc: any
+  urls: Urls
+  created_at: string
+  links: Link[]
+}

package/src/types/Stats.ts

@@ -0,0 +1,23 @@
+import { Link } from './Common';
+
+export type PilotStat = {
+  total_flights: number
+  total_hours: number
+  total_distance: number
+  average_landing: number
+}
+
+export type PilotStats = {
+  id: number
+  all_time: PilotStat
+  month: PilotStat
+  links: Link[]
+}
+
+export type AirlineStats = {
+  id: number
+  total_pilots: number
+  all_time: PilotStat
+  month: PilotStat
+  links: Link[]
+}