fshub-api 2.0.1 → 3.0.0

package/src/api/pilot/Pilot_getAllFlightsDepartures.ts

@@ -0,0 +1,8 @@
+import { Flight, FSHubApi, FSHubResponse } from "../../types";
+import FSHubApiRequest from "../FSHubApiRequest";
+
+export default async function Pilot_getAllFlightsDepartures(id: number, airportCode: string, api: FSHubApi): Promise<Flight[]> {
+    const response: FSHubResponse<Flight[]> = await FSHubApiRequest(`pilot/${id}/flight/departure/${airportCode}`, api);
+    
+    return response.data;
+}

package/src/api/pilot/Pilot_getAllScreenshots.ts

@@ -0,0 +1,16 @@
+import { FSHubApi, FSHubResponse, Screenshot } from "../../types";
+import FSHubApiRequest from "../FSHubApiRequest";
+
+export default async function Pilot_getAllScreenshots(id: number, api: FSHubApi): Promise<Screenshot[]> {
+    try {
+        const response: FSHubResponse<Screenshot[]> = await FSHubApiRequest(`pilot/${id}/screenshot`, api);
+
+        return response.data;
+    } catch (error) {
+        if (error instanceof Error && error.message === 'No records found') {
+            return [];
+        }
+
+        throw error;
+    }
+}

package/src/api/pilot/Pilot_getCurrent.ts

@@ -0,0 +1,8 @@
+import { CurrentPilot, FSHubApi, FSHubResponse } from "../../types";
+import FSHubApiRequest from "../FSHubApiRequest";
+
+export default async function Pilot_getCurrent(api: FSHubApi): Promise<CurrentPilot> {
+    const response: FSHubResponse<CurrentPilot> = await FSHubApiRequest('user', api);
+    
+    return response.data;
+}

package/src/api/pilot/Pilot_getLatestFlight.ts

@@ -0,0 +1,8 @@
+import { FSHubApi, FSHubResponse, Flight } from "../../types";
+import FSHubApiRequest from "../FSHubApiRequest";
+
+export default async function Pilot_getLatestFlight(id: number, api: FSHubApi): Promise<Flight> {
+    const response: FSHubResponse<Flight> = await FSHubApiRequest(`pilot/${id}/flight/latest`, api);
+    
+    return response.data;
+}

package/src/api/pilot/Pilot_getStats.ts

@@ -0,0 +1,8 @@
+import { FSHubApi, FSHubResponse, PilotStats } from "../../types";
+import FSHubApiRequest from "../FSHubApiRequest";
+
+export default async function Pilot_getStats(id: number, api: FSHubApi): Promise<PilotStats> {
+    const response: FSHubResponse<PilotStats> = await FSHubApiRequest(`pilot/${id}/stats`, api);
+    
+    return response.data;
+}

package/src/api/pilot/index.ts

@@ -0,0 +1,25 @@
+import Pilot_getAll from './Pilot_getAll';
+import Pilot_getCurrent from './Pilot_getCurrent';
+import Pilot_get from './Pilot_get';
+import Pilot_getLatestFlight from './Pilot_getLatestFlight';
+import Pilot_getAllFlights from './Pilot_getAllFlights';
+import Pilot_getAllAirlines from './Pilot_getAllAirlines';
+import Pilot_getStats from './Pilot_getStats';
+import Pilot_getAllFlightsDepartures from './Pilot_getAllFlightsDepartures';
+import Pilot_getAllFlightsArrivals from './Pilot_getAllFlightsArrivals';
+import Pilot_getAllFlightDeparturesAndArrivals from './Pilot_getAllFlightDeparturesAndArrivals';
+import Pilot_getAllScreenshots from './Pilot_getAllScreenshots';
+
+export const Pilot = {
+    getCurrent: Pilot_getCurrent,
+    getAll: Pilot_getAll,
+    get: Pilot_get,
+    getLatestFlight: Pilot_getLatestFlight,
+    getAllFlights: Pilot_getAllFlights,
+    getAllAirlines: Pilot_getAllAirlines,
+    getStats: Pilot_getStats,
+    getAllFlightsDepartures: Pilot_getAllFlightsDepartures,
+    getAllFlightsArrivals: Pilot_getAllFlightsArrivals,
+    getAllFlightDeparturesAndArrivals: Pilot_getAllFlightDeparturesAndArrivals,
+    getAllScreenshots: Pilot_getAllScreenshots,
+}

package/src/index.spec.ts

@@ -0,0 +1,216 @@
+import { describe, before } from 'mocha';
+import { expect } from 'chai';
+import FSHubApiClass from './index';
+import dotenv from 'dotenv';
+import { CurrentPilot, Flight, Pilot, FSHubApi, Airline, PilotStats, Screenshot  } from './types';
+
+dotenv.config();
+let api: FSHubApi;
+
+describe('FSHubApi()', function() {
+    let apiKey: string;
+
+    before(function() {
+        if (!process.env.FSHUB_API_KEY) {
+            throw new Error('FSHUB_API_KEY is not set in .env file');
+        }
+
+        apiKey = process.env.FSHUB_API_KEY;
+        api = new FSHubApiClass({ apiKey });
+    });
+
+    it('when instantiated with valid data, it should return an FSHubApi object with the expected class methods', async function() {
+        expect(api.Pilot_getCurrent).to.be.a('function');
+        expect(api.Pilot_getAll).to.be.a('function');
+        expect(api.Pilot_get).to.be.a('function');
+        expect(api.Pilot_getLatestFlight).to.be.a('function');
+        expect(api.Pilot_getAllFlights).to.be.a('function');
+        expect(api.Pilot_getAllAirlines).to.be.a('function');
+        expect(api.Pilot_getStats).to.be.a('function');
+        expect(api.Pilot_getAllFlightsDepartures).to.be.a('function');
+        expect(api.Pilot_getAllFlightsArrivals).to.be.a('function');
+        expect(api.Pilot_getAllFlightDeparturesAndArrivals).to.be.a('function');
+        expect(api.Pilot_getAllScreenshots).to.be.a('function');
+        expect(api.Airline_getAll).to.be.a('function');
+        expect(api.Airline_get).to.be.a('function');
+        expect(api.Airline_getPilots).to.be.a('function');
+        expect(api.Airline_getPilotStats).to.be.a('function');
+        expect(api.Airline_getFlights).to.be.a('function');
+        expect(api.Airline_getAllFlightsDepartures).to.be.a('function');
+        expect(api.Airline_getAllFlightsArrivals).to.be.a('function');
+        expect(api.Airline_getAllFlightDeparturesAndArrivals).to.be.a('function');
+        expect(api.Airline_getAllScreenshots).to.be.a('function');
+        expect(api.Airline_getStats).to.be.a('function');
+        expect(api.Flight_getFlightById).to.be.a('function');
+        expect(api.Flight_getFlightScreenshotsById).to.be.a('function');
+    });
+
+    describe('Pilot', function() {
+        it('Pilot_getCurrent() is called, it should return a valid CurrentPilot object', async function() {
+            const pilot: CurrentPilot = await api.Pilot_getCurrent();
+
+            expect(pilot).to.be.an('Object');
+            expect(pilot.id).to.be.a('number');
+            expect(pilot.name).to.be.a('string');
+            expect(pilot.base).to.be.a('string');
+            expect(pilot.locale).to.be.an('string');
+            expect(pilot.gps).to.be.an('Object');
+        });
+
+        it('Pilot_getAll() is called, it should return an array of valid Pilot objects', async function() {
+            const pilots: Pilot[] = await api.Pilot_getAll();
+
+            expect(pilots).to.be.an('Array');
+        });
+
+        it('Pilot_get(id) is called, it should return a valid Pilot object', async function() {
+            const pilot: Pilot = await api.Pilot_get(1);
+
+            expect(pilot).to.be.an('Object');
+        });
+
+        it('Pilot_getLatestFlight(id) is called, it should return a valid Flight object', async function() {
+            const pilot: Pilot = await api.Pilot_getCurrent();
+            const flight: Flight = await api.Pilot_getLatestFlight(pilot.id);
+
+            expect(flight).to.be.an('Object');
+        });
+
+        it('Pilot_getAllFlights(id) is called, it should return an array of valid Flight objects', async function() {
+            const pilot: Pilot = await api.Pilot_getCurrent();
+            const flights: Flight[] = await api.Pilot_getAllFlights(pilot.id);
+            
+            expect(flights).to.be.an('Array');
+        });
+
+        it('Pilot_getAllAirlines(id) is called, it should return an array of valid Airline objects', async function() {
+            const pilot: Pilot = await api.Pilot_getCurrent();
+            const airlines: Airline[] = await api.Pilot_getAllAirlines(pilot.id);
+            
+            expect(airlines).to.be.an('Array');
+        });
+
+        it('Pilot_getStats(id) is called, it should return a valid PilotStats object', async function() {
+            const pilot: Pilot = await api.Pilot_getCurrent();
+            const stats: PilotStats = await api.Pilot_getStats(pilot.id);
+            
+            expect(stats).to.be.an('Object');
+            expect(stats.id).to.be.a('number'); 
+            expect(stats.all_time).to.be.an('Object');
+            expect(stats.month).to.be.an('Object');
+        });
+
+        it('Pilot_getAllFlightsDepartures(id, airportCode) is called, it should return an array of valid Flight objects', async function() {
+            const pilot: Pilot = await api.Pilot_getCurrent();
+            const flights: Flight[] = await api.Pilot_getAllFlightsDepartures(pilot.id, 'KPHX');
+            
+            expect(flights).to.be.an('Array');
+        });
+
+        it('Pilot_getAllFlightsArrivals(id, airportCode) is called, it should return an array of valid Flight objects', async function() {
+            const pilot: Pilot = await api.Pilot_getCurrent();
+            const flights: Flight[] = await api.Pilot_getAllFlightsArrivals(pilot.id, 'KPHX');
+            
+            expect(flights).to.be.an('Array');
+        });
+
+        it('Pilot_getAllFlightDeparturesAndArrivals(id, departureAirportCode, arrivalAirportCode) is called, it should return an array of valid Flight objects', async function() {
+            const pilot: Pilot = await api.Pilot_getCurrent();
+            const flights: Flight[] = await api.Pilot_getAllFlightDeparturesAndArrivals(pilot.id, 'KPHX', 'KJAC');
+            
+            expect(flights).to.be.an('Array');
+        });
+
+        it('Pilot_getAllScreenshots(id) is called, it should return an array of valid Screenshot objects', async function() {
+            const pilot: Pilot = await api.Pilot_getCurrent();
+            const screenshots: Screenshot[] = await api.Pilot_getAllScreenshots(pilot.id);
+            
+            expect(screenshots).to.be.an('Array');
+        });
+    });
+
+    describe('Airline', function() {
+        it('Airline_getAll() is called, it should return an array of valid Airline objects', async function() {
+            const airlines: Airline[] = await api.Airline_getAll();
+            
+            expect(airlines).to.be.an('Array');
+        });
+
+        it('Airline_get(id) is called, it should return a valid Airline object', async function() {
+            const airline: Airline = await api.Airline_get(6082);
+            
+            expect(airline).to.be.an('Object');
+        });
+
+        it('Airline_getPilots(id) is called, it should return an array of valid Pilot objects', async function() {
+            const airline: Airline = await api.Airline_get(6082);
+            const pilots: Pilot[] = await api.Airline_getPilots(airline.id);
+            
+            expect(pilots).to.be.an('Array');
+        });
+
+        it('Airline_getPilotStats(id, pilotId) is called, it should return a valid PilotStats object', async function() {
+            const airline: Airline = await api.Airline_get(6082);
+            const pilot: Pilot = await api.Pilot_getCurrent();
+            const stats: PilotStats = await api.Airline_getPilotStats(airline.id, pilot.id);
+            
+            expect(stats).to.be.an('Object');
+        });
+
+        it('Airline_getFlights(id) is called, it should return an array of valid Flight objects', async function() {
+            const airline: Airline = await api.Airline_get(6082);
+            const flights: Flight[] = await api.Airline_getFlights(airline.id);
+            
+            expect(flights).to.be.an('Array');
+        });
+
+        it('Airline_getAllFlightsDepartures(id, airportCode) is called, it should return an array of valid Flight objects', async function() {
+            const airline: Airline = await api.Airline_get(6082);
+            const flights: Flight[] = await api.Airline_getAllFlightsDepartures(airline.id, 'KPHX');
+            
+            expect(flights).to.be.an('Array');
+        });
+
+        it('Airline_getAllFlightsArrivals(id, airportCode) is called, it should return an array of valid Flight objects', async function() {
+            const airline: Airline = await api.Airline_get(6082);
+            const flights: Flight[] = await api.Airline_getAllFlightsArrivals(airline.id, 'KPHX');
+            
+            expect(flights).to.be.an('Array');
+        });
+
+        it('Airline_getAllFlightDeparturesAndArrivals(id, departureAirportCode, arrivalAirportCode) is called, it should return an array of valid Flight objects', async function() {
+            const airline: Airline = await api.Airline_get(6082);
+            const flights: Flight[] = await api.Airline_getAllFlightDeparturesAndArrivals(airline.id, 'KPHX', 'KJAC');
+            
+            expect(flights).to.be.an('Array');
+        });
+
+        it('Airline_getAllScreenshots(id) is called, it should return an array of valid Screenshot objects', async function() {
+            const airline: Airline = await api.Airline_get(6082);
+            const screenshots: Screenshot[] = await api.Airline_getAllScreenshots(airline.id);
+            
+            expect(screenshots).to.be.an('Array');
+        });
+
+        it('Airline_getStats(id) is called, it should return a valid object with airline statistics', async function() {
+            const airline: Airline = await api.Airline_get(6082);
+            const stats = await api.Airline_getStats(airline.id);
+            
+            expect(stats).to.be.an('Object');
+        });
+    });
+
+    describe('Flight', function() {
+        it('Flight_getFlightById(id) is called, it should return a valid Flight object', async function() {
+            const flight: Flight = await api.Flight_getFlightById(4009359);
+            
+            expect(flight).to.be.an('Object');
+        });
+
+        it('Flight_getFlightScreenshotsById(id) is called, it should return an array of valid Screenshot objects', async function() {
+            const flight: Screenshot[] = await api.Flight_getFlightScreenshotsById(4009359);
+            
+            expect(flight).to.be.an('Array');
+        });
+    });
+});

package/src/index.ts

@@ -1,6 +1,6 @@
 import axios, { AxiosInstance } from 'axios';
 import type{ Config, FSHubApi } from './types';
-import { Api } from '@/api';
+import { Api } from './api';
 export * from './types';
 
 export default class FSHubApiClass implements FSHubApi {

package/src/types/index.ts

@@ -0,0 +1,237 @@
+import { AxiosInstance } from 'axios';
+
+/**
+ * FSHub API Types and type= s
+ */
+
+export type Config = {
+  baseURL?: string;
+  apiKey?: string;
+  timeout?: number;
+  headers?: Record<string, string>;
+};
+
+export type CurrentPilot = Pilot & {
+  discord_id?: number
+}
+
+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 Handles = {
+  facebook: any
+  twitter: string
+  website: any
+  vatsim: string
+  ivao: string
+}
+
+export type Link = {
+  rel: string
+  uri: string
+}
+
+export type Gps = {
+  lat: number
+  lng: number
+}
+
+export type FSHubResponse<T> = {
+  data: T
+}
+
+export type FSHubError = {
+  message: string
+  code: number
+  error?: boolean
+  details?: {
+    pilot: number
+  }
+}
+
+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[]
+}
+
+export type Airline = {
+  id: number
+  name: string
+  abbr: string
+  owner: Owner
+  handles: Handles
+  links: Link[]
+}
+
+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 User = {
+  id: number
+  name: string
+}
+
+export type Aircraft = {
+  icao: string
+  icao_name: string
+  name: string
+  type: string
+  user_conf: UserConf
+}
+
+export type UserConf = {
+  tail: string
+  icao: string
+}
+
+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 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[]
+}
+
+export type PilotStat = {
+  total_flights: number
+  total_hours: number
+  total_distance: number
+  average_landing: number
+}
+
+export type Screenshot = {
+  id: number
+  name: string
+  desc: any
+  urls: Urls
+  created_at: string
+  links: Link[]
+}
+
+export type Urls = {
+  fullsize: string
+  thumbnail: string
+}
+
+export type FSHubApi = {
+  axios: AxiosInstance
+  Pilot_getCurrent: () => Promise<CurrentPilot>
+  Pilot_getAll: () => Promise<Pilot[]>
+  Pilot_get: (id: number) => Promise<Pilot>
+  Pilot_getLatestFlight: (id: number) => Promise<Flight>
+  Pilot_getAllFlights: (id: number) => Promise<Flight[]>
+  Pilot_getAllAirlines: (id: number) => Promise<Airline[]>
+  Pilot_getStats: (id: number) => Promise<PilotStats>
+  Pilot_getAllFlightsDepartures:(id:number, airportCode:string) => Promise<Flight[]>
+  Pilot_getAllFlightsArrivals:(id:number, airportCode:string) => Promise<Flight[]>
+  Pilot_getAllFlightDeparturesAndArrivals:(id:number, departureAirportCode:string, arrivalAirportCode:string) => Promise<Flight[]>
+  Pilot_getAllScreenshots: (id: number) => Promise<Screenshot[]>
+  Airline_getAll: () => Promise<Airline[]>
+  Airline_get: (id: number) => Promise<Airline>
+  Airline_getPilots: (id: number) => Promise<Pilot[]>
+  Airline_getPilotStats: (id: number, pilotId: number) => Promise<PilotStats>
+  Airline_getFlights: (id: number) => Promise<Flight[]>
+  Airline_getAllFlightsDepartures:(id:number, airportCode:string) => Promise<Flight[]>
+  Airline_getAllFlightsArrivals:(id:number, airportCode:string) => Promise<Flight[]>
+  Airline_getAllFlightDeparturesAndArrivals:(id:number, departureAirportCode:string, arrivalAirportCode:string) => Promise<Flight[]>
+  Airline_getAllScreenshots: (id: number) => Promise<Screenshot[]>
+  Airline_getStats: (id: number) => Promise<AirlineStats>
+  Flight_getFlightById: (id: number) => Promise<Flight>
+  Flight_getFlightScreenshotsById: (id: number) => Promise<Screenshot[]>
+}

package/tsconfig.json

@@ -0,0 +1,41 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "lib": ["ESNext"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "baseUrl": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "removeComments": false,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "exactOptionalPropertyTypes": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "**/*.test.ts",
+    "**/*.spec.ts"
+  ]
+}