fshub-api 1.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,207 @@
+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>;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEtC;;GAEG;AAEH,MAAM,MAAM,MAAM,GAAG;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG;IACjC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;CACf,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,QAAQ,EAAE,GAAG,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,GAAG,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAC7B,IAAI,EAAE,CAAC,CAAA;CACR,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,OAAO,CAAC,EAAE;QACR,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,IAAI,CAAA;IACV,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,GAAG,CAAA;IACpB,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,EAAE,GAAG,CAAA;IACT,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,QAAQ,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,GAAG,CAAA;IACR,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,KAAK,EAAE,GAAG,EAAE,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE,IAAI,EAAE,CAAA;CACd,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE,IAAI,EAAE,CAAA;CACd,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,GAAG,CAAA;IACR,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,IAAI,EAAE,CAAA;CACd,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,QAAQ,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,GAAG,CAAA;IACR,GAAG,EAAE,GAAG,CAAA;IACR,GAAG,EAAE,GAAG,CAAA;IACR,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,IAAI,CAAA;CACX,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,SAAS,CAAA;IACnB,KAAK,EAAE,SAAS,CAAA;IAChB,KAAK,EAAE,IAAI,EAAE,CAAA;CACd,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,SAAS,CAAA;IACnB,KAAK,EAAE,SAAS,CAAA;IAChB,KAAK,EAAE,IAAI,EAAE,CAAA;CACd,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,cAAc,EAAE,MAAM,CAAA;IACtB,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,GAAG,CAAA;IACT,IAAI,EAAE,IAAI,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,IAAI,EAAE,CAAA;CACd,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,EAAE,aAAa,CAAA;IACpB,gBAAgB,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,CAAA;IAC7C,YAAY,EAAE,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;IACpC,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,KAAK,CAAC,CAAA;IACzC,qBAAqB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;IACtD,mBAAmB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IACtD,oBAAoB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;IACxD,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;IACnD,6BAA6B,EAAC,CAAC,EAAE,EAAC,MAAM,EAAE,WAAW,EAAC,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAClF,2BAA2B,EAAC,CAAC,EAAE,EAAC,MAAM,EAAE,WAAW,EAAC,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAChF,uCAAuC,EAAC,CAAC,EAAE,EAAC,MAAM,EAAE,oBAAoB,EAAC,MAAM,EAAE,kBAAkB,EAAC,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAChI,uBAAuB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAC9D,cAAc,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;IACxC,WAAW,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAC7C,iBAAiB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;IACnD,qBAAqB,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;IAC3E,kBAAkB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IACrD,+BAA+B,EAAC,CAAC,EAAE,EAAC,MAAM,EAAE,WAAW,EAAC,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IACpF,6BAA6B,EAAC,CAAC,EAAE,EAAC,MAAM,EAAE,WAAW,EAAC,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAClF,yCAAyC,EAAC,CAAC,EAAE,EAAC,MAAM,EAAE,oBAAoB,EAAC,MAAM,EAAE,kBAAkB,EAAC,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAClI,yBAAyB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAChE,gBAAgB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAA;CACxD,CAAA"}

package/dist/types/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "fshub-api",
+  "version": "1.0.0",
+  "description": "TypeScript HTTP API wrapper library for FSHub REST API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "lint": "eslint src/**/*.ts",
+    "clean": "rimraf dist",
+    "test": "mocha --timeout 20000 --require ts-node/register src/**/*.spec.ts",
+    "test:debug": "tsx test.ts",
+    "test:watch": "mocha -w --timeout 20000 --require ts-node/register src/**/*.spec.ts",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "keywords": [
+    "fshub",
+    "api",
+    "typescript",
+    "wrapper",
+    "rest"
+  ],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/jest": "^29.0.0",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "chai": "^5.2.1",
+    "eslint": "^8.0.0",
+    "jest": "^29.0.0",
+    "mocha": "^11.7.1",
+    "rimraf": "^5.0.0",
+    "ts-jest": "^29.0.0",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.20.3",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "axios": "^1.6.0",
+    "dotenv": "^17.2.1"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ]
+}