fshub-api 3.0.0 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fshub-api",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "TypeScript HTTP API wrapper library for FSHub REST API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -53,4 +53,4 @@
     "axios": "^1.6.0",
     "dotenv": "^17.2.1"
   }
-}
+}

package/release.ps1

@@ -0,0 +1,15 @@
+param(
+    [Parameter(Mandatory=$true)]
+    [ValidateSet("patch", "minor", "major")]
+    [string]$Type
+)
+
+npm version $Type
+npm run build
+git add .
+$version = npm pkg get version
+$version = $version.Trim('"')
+git commit -m "Release v$version"
+git tag -a "v$version" -m "Release v$version"
+git push origin master
+git push origin --tags

package/src/api/FSHubApiRequest.ts

@@ -1,8 +1,13 @@
 import { AxiosResponse, AxiosError } from 'axios';
-import { FSHubResponse, FSHubError, FSHubApi } from '../types';
+import { FSHubRequestOptions, FSHubResponse, FSHubError, FSHubApi } from '../types';
 
-export default async function FSHubApiRequest<T>(url: string, api: FSHubApi): Promise<FSHubResponse<T>> {
-    const response: FSHubResponse<T> =  await api.axios.get(url)
+export default async function FSHubApiRequest<T>(url: string, api: FSHubApi, options?: FSHubRequestOptions): Promise<FSHubResponse<T>> {
+    let queryParams = '';
+    if (options) {
+        queryParams = `?cursor=${options.cursor}&limit=${options.limit}`;
+    }
+
+    const response: FSHubResponse<T> =  await api.axios.get(url + queryParams)
         .then((res: AxiosResponse<FSHubResponse<T>>) => res.data)
         .catch((err: AxiosError<FSHubError>) => {
             if (err.response?.data.code === 404) {

package/src/api/airline/Airline_get.ts

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

package/src/api/airline/Airline_getAll.ts

@@ -1,8 +1,8 @@
 import { FSHubApi, FSHubResponse, Airline } from "../../types";
 import FSHubApiRequest from "../FSHubApiRequest";
 
-export default async function Airline_getAll(api: FSHubApi): Promise<Airline[]> {
+export default async function Airline_getAll(api: FSHubApi): Promise<FSHubResponse<Airline[]>> {
     const response: FSHubResponse<Airline[]> = await FSHubApiRequest(`airline`, api);
     
-    return response.data;
+    return response;
 }

package/src/api/airline/Airline_getAllFlightDeparturesAndArrivals.ts

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

package/src/api/airline/Airline_getAllFlightsArrivals.ts

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

package/src/api/airline/Airline_getAllFlightsDepartures.ts

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

package/src/api/airline/Airline_getAllScreenshots.ts

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

package/src/api/airline/Airline_getFlights.ts

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

package/src/api/airline/Airline_getPilotStats.ts

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

package/src/api/airline/Airline_getPilots.ts

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

package/src/api/airline/Airline_getStats.ts

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

package/src/api/flight/Flight_getFlightById.ts

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

package/src/api/flight/Flight_getFlightScreenshotsById.ts

@@ -2,8 +2,17 @@
 import { Screenshot, FSHubApi, FSHubResponse } from "../../types";
 import FSHubApiRequest from "../FSHubApiRequest";
 
-export default async function Flight_getFlightScreenshotsById(id: number, api: FSHubApi): Promise<Screenshot[]> {
-    const response: FSHubResponse<Screenshot[]> = await FSHubApiRequest(`flight/${id}/screenshot`, api);
+export default async function Flight_getFlightScreenshotsById(id: number, api: FSHubApi): Promise<FSHubResponse<Screenshot[]>> {
+    let response: FSHubResponse<Screenshot[]>;
+    try {
+        response = await FSHubApiRequest(`flight/${id}/screenshot`, api);
+    } catch (error: any) {
+        if (error.message === 'Not Found') {
+            return { data: [] };
+        }
+
+        throw error;
+    }
     
-    return response.data;
+    return response;
 }

package/src/api/flight/Flight_getFlights.ts

@@ -0,0 +1,9 @@
+// https://fshub.io/api/v3/flight/{id}
+import { Flight, FSHubApi, FSHubRequestOptions, FSHubResponse } from "../../types";
+import FSHubApiRequest from "../FSHubApiRequest";
+
+export default async function Flight_getFlights(api: FSHubApi, options?: FSHubRequestOptions): Promise<FSHubResponse<Flight[]>> {
+    const response: FSHubResponse<Flight[]> = await FSHubApiRequest(`flight`, api, options);
+    
+    return response;
+}

package/src/api/flight/index.ts

@@ -1,7 +1,9 @@
 import Flight_getFlightById from './Flight_getFlightById';
 import Flight_getFlightScreenshotsById from './Flight_getFlightScreenshotsById';
+import Flight_getFlights from './Flight_getFlights';
 
 export const Flight = {
     getFlightById: Flight_getFlightById,
     getFlightScreenshotsById: Flight_getFlightScreenshotsById,
+    getFlights: Flight_getFlights,
 };

package/src/api/pilot/Pilot_get.ts

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

package/src/api/pilot/Pilot_getAll.ts

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

package/src/api/pilot/Pilot_getAllAirlines.ts

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

package/src/api/pilot/Pilot_getAllFlightDeparturesAndArrivals.ts

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

package/src/api/pilot/Pilot_getAllFlights.ts

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

package/src/api/pilot/Pilot_getAllFlightsArrivals.ts

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

package/src/api/pilot/Pilot_getAllFlightsDepartures.ts

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

package/src/api/pilot/Pilot_getAllScreenshots.ts

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

package/src/api/pilot/Pilot_getCurrent.ts

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

package/src/api/pilot/Pilot_getLatestFlight.ts

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

package/src/api/pilot/Pilot_getStats.ts

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