@headwindsimulations/api-client 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 FlyByWire Simulations
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,393 @@
+# <img src="https://raw.githubusercontent.com/flybywiresim/fbw-branding/master/svg/FBW-Logo.svg" placeholder="FlyByWire" width="400"/>
+# FlyByWire Simulations API Client
+
+The official JavaScript client for the FBW API.
+The library supports both JavaScript and TypeScript.
+
+## Installation
+
+Install the client library using npm:
+
+    $ npm install --save @flybywiresim/api-client
+
+## Usage
+
+### Initializing the client
+```ts
+import { NXApi } from '@flybywiresim/api-client';
+
+NXApi.url = new URL('http://localhost:3000');
+```
+
+By default, the URL is set to `https://api.flybywiresim.com`. If this is the desired URL this step can be omitted.
+
+### METAR
+```ts
+import { Metar } from '@flybywiresim/api-client';
+
+Metar.get(icao, source)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `icao` is a string of the the airport ICAO code to get the METAR for.
+- `source` is the selected datasource for the METAR and is _optional_.
+  Valid sources are:
+  - vatsim
+  - ms
+  - ivao
+  - pilotedge
+
+### TAF
+```ts
+import { Taf } from '@flybywiresim/api-client';
+
+Taf.get(icao, source)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `icao` is a string of the the airport ICAO code to get the TAF for.
+- `source` is the selected datasource for the TAF and is _optional_.
+  Valid sources are:
+  - aviationweather
+  - faa
+
+### ATIS
+```ts
+import { Atis } from '@flybywiresim/api-client';
+
+Atis.get(icao, source)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `icao` is a string of the the airport ICAO code to get the ATIS for.
+- `source` is the selected datasource for the ATIS and is _optional_.
+  Valid sources are:
+  - faa
+  - vatsim
+  - ivao
+  - pilotedge
+
+### Airport
+```ts
+import { Airport } from '@flybywiresim/api-client';
+
+Airport.get(icao)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `icao` is a string of the the airport ICAO code to search for.
+
+
+### ATC
+```ts
+import { Atis } from '@flybywiresim/api-client';
+
+ATC.get(source)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `source` is the selected datasource for the ATC.
+  Valid sources are:
+  - vatsim
+  - ivao
+
+
+### TELEX connection handling
+
+#### Connect to TELEX system
+```ts
+import { Telex } from '@flybywiresim/api-client';
+
+Telex.connect(status)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `status` is of type `AircraftStatus` and contains information about the current flight.
+
+The backend might block certain flight numbers from being used for various reasons.
+
+#### Update the TELEX status
+```ts
+import { Telex } from '@flybywiresim/api-client';
+
+Telex.update(status)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `status` is of type `AircraftStatus` and contains information about the current flight.
+
+The status has to updated every 6 minutes for the connection to stay alive.
+It is recommended to update the status every 15 seconds for a usable live map.
+The status can only be updated once a connection has been established.
+
+#### Disconnect from TELEX system
+```ts
+import { Telex } from '@flybywiresim/api-client';
+
+Telex.disconnect()
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+The connection can only be disconnected once it has been established.
+This releases the flight number for reuse and removes the flight from the live map.
+
+### TELEX message handling
+
+#### Sending a message
+```ts
+import { Telex } from '@flybywiresim/api-client';
+
+Telex.sendMessage(recipient, message)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `recipient` is a string containing the flight number of the recipient flight.
+- `message` is a string containing the message to send.
+
+Messages will be filtered for profanity in the backend.
+
+#### Receiving messages
+```ts
+import { Telex } from '@flybywiresim/api-client';
+
+Telex.fetchMessages()
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+Messages can only be received once and will be acknowledged by this transaction.
+
+### TELEX Querying
+
+#### Fetch a single page of active connections
+```ts
+import { Telex } from '@flybywiresim/api-client';
+
+Telex.fetchConnections(skip, take, bounds)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `skip` is a number and tells the backend to skip the first n connections.
+- `take` is a number and tells the backend how many connections to send.
+- `bounds` is an optional bounding box. Query only connections within this area.
+
+`take` and `skip` are used to control the pagination. A maximum of 100 entries can be fetched at a time.
+
+#### Fetch all active connections
+```ts
+import { Telex } from '@flybywiresim/api-client';
+
+Telex.fetchAllConnections(bounds, callback)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `bounds` is an optional bounding box. Query only connections within this area.
+- `callback` gets called after every fetched page.
+
+#### Fetch a certain connection
+```ts
+import { Telex } from '@flybywiresim/api-client';
+
+Telex.fetchConnection(id)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `id` is the unique identifier of the connection.
+
+#### Find all active connections matching a flight number
+```ts
+import { Telex } from '@flybywiresim/api-client';
+
+Telex.findConnection(flight)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `flight` is the flight number to search for.
+
+#### Count active connections
+```ts
+import { Telex } from '@flybywiresim/api-client';
+
+Telex.countConnections()
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+### Github
+
+#### Get the newest commit for a branch
+```ts
+import { GitVersions } from '@flybywiresim/api-client';
+
+GitVersions.getNewestCommit(user, repo, branch)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `user` the owner of the repository.
+- `repo` the repository.
+- `branch` the requested branch.
+
+#### Get all releases for a repository
+```ts
+import { GitVersions } from '@flybywiresim/api-client';
+
+GitVersions.getReleases(user, repo)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `user` the owner of the repository.
+- `repo` the repository.
+
+#### Get open pull requests for a repository
+```ts
+import { GitVersions } from '@flybywiresim/api-client';
+
+GitVersions.getPulls(user, repo)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `user` the owner of the repository.
+- `repo` the repository.
+
+#### Get the artifact URL for a pull request
+```ts
+import { GitVersions } from '@flybywiresim/api-client';
+
+GitVersions.getArtifact(user, repo, pull)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `user` the owner of the repository.
+- `repo` the repository.
+- `pull` the number of the pull request.
+
+
+### Charts
+
+#### Get the charts for an airport
+```ts
+import { Charts } from '@flybywiresim/api-client';
+
+Charts.get(icao, source)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `icao` is a string of the the airport ICAO code to search for.
+
+
+### GNSS
+
+#### Fetch data for all GNSS satellites
+```ts
+import { Atis } from '@flybywiresim/api-client';
+
+GNSS.get()
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+### Hoppie
+
+#### Send the request
+```ts
+import { Hoppie } from '@flybywiresim/api-client';
+
+const body {
+  logon: 'XXXXXXXXX',
+  from: 'TEST0',
+  to: 'TEST0',
+  type: 'poll'
+}
+Hoppie.post(body)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+
+## License
+
+This software is licensed under the [MIT license](https://github.com/flybywiresim/api-client/blob/main/LICENSE).

package/dist/apis/Hoppie.d.ts

@@ -0,0 +1,6 @@
+export declare class HoppieResponse {
+    response: string;
+}
+export declare class Hoppie {
+    static sendRequest(body: any): Promise<HoppieResponse>;
+}

package/dist/apis/airport.d.ts

@@ -0,0 +1,16 @@
+export declare class AirportResponse {
+    icao: string;
+    iata: string;
+    type: string;
+    name: string;
+    lat: number;
+    lon: number;
+    elevation: number;
+    continent: string;
+    country: string;
+    transAlt: number;
+}
+export declare class Airport {
+    static get(icao: string): Promise<AirportResponse>;
+    static getBatch(icaos: string[]): Promise<AirportResponse[]>;
+}

package/dist/apis/atc.d.ts

@@ -0,0 +1,22 @@
+export declare enum AtcType {
+    UNKNOWN = 0,
+    DELIVERY = 1,
+    GROUND = 2,
+    TOWER = 3,
+    DEPARTURE = 4,
+    APPROACH = 5,
+    RADAR = 6,
+    ATIS = 7
+}
+export declare class ATCInfo {
+    callsign: string;
+    frequency: string;
+    visualRange: number;
+    textAtis: string[];
+    type: AtcType;
+    latitude?: number;
+    longitude?: number;
+}
+export declare class ATC {
+    static get(source: string): Promise<ATCInfo[]>;
+}

package/dist/apis/atc.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/apis/atis.d.ts

@@ -0,0 +1,10 @@
+export declare class AtisResponse {
+    icao: string;
+    source: string;
+    combined?: string;
+    arr?: string;
+    dep?: string;
+}
+export declare class Atis {
+    static get(icao: string, source?: string): Promise<AtisResponse>;
+}

package/dist/apis/atis.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/apis/charts.d.ts

@@ -0,0 +1,11 @@
+export declare class Chart {
+    url: string;
+    name: string;
+}
+export declare class ChartsResponse {
+    icao: string;
+    charts?: Chart[];
+}
+export declare class Charts {
+    static get(icao: string): Promise<ChartsResponse>;
+}

package/dist/apis/charts.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/apis/git-versions.d.ts

@@ -0,0 +1,33 @@
+export declare class CommitInfo {
+    sha: string;
+    shortSha: string;
+    timestamp: Date;
+}
+export declare class ReleaseInfo {
+    name: string;
+    isPreRelease: boolean;
+    publishedAt: Date;
+    htmlUrl: string;
+    body: string;
+}
+export declare class PullLabel {
+    id: string;
+    name: string;
+    color: string;
+}
+export declare class PullInfo {
+    number: number;
+    title: string;
+    author: string;
+    labels: PullLabel[];
+    isDraft: boolean;
+}
+export declare class ArtifactInfo {
+    artifactUrl: string;
+}
+export declare class GitVersions {
+    static getNewestCommit(user: string, repo: string, branch: string): Promise<CommitInfo>;
+    static getReleases(user: string, repo: string, includePreReleases?: boolean, skip?: number, take?: number): Promise<ReleaseInfo[]>;
+    static getPulls(user: string, repo: string): Promise<PullInfo[]>;
+    static getArtifact(user: string, repo: string, pull: string): Promise<ArtifactInfo>;
+}

package/dist/apis/git-versions.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/apis/gnss.d.ts

@@ -0,0 +1,23 @@
+export declare class GNSSResponse {
+    name: string;
+    id: string;
+    epoch: Date;
+    meanMotion: number;
+    eccentricity: number;
+    inclination: number;
+    raOfAscNode: number;
+    argOfPericenter: number;
+    meanAnomaly: number;
+    ephemerisType: number;
+    classificationType: string;
+    noradCatId: number;
+    elementSetNo: number;
+    revAtEpoch: number;
+    bstar: number;
+    meanMotionDot: number;
+    meanMotionDdot: number;
+}
+export declare class GNSS {
+    static get(): Promise<GNSSResponse[]>;
+    private static mapResult;
+}

package/dist/apis/gnss.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/apis/index.d.ts

@@ -0,0 +1,10 @@
+export * from './airport';
+export * from './atc';
+export * from './atis';
+export * from './charts';
+export * from './git-versions';
+export * from './gnss';
+export * from './metar';
+export * from './taf';
+export * from './telex';
+export * from './Hoppie';

package/dist/apis/metar.d.ts

@@ -0,0 +1,8 @@
+export declare class MetarResponse {
+    icao: string;
+    source: string;
+    metar: string;
+}
+export declare class Metar {
+    static get(icao: string, source?: string): Promise<MetarResponse>;
+}

package/dist/apis/metar.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/apis/taf.d.ts

@@ -0,0 +1,8 @@
+export declare class TafResponse {
+    icao: string;
+    source: string;
+    taf: string;
+}
+export declare class Taf {
+    static get(icao: string, source?: string): Promise<TafResponse>;
+}

package/dist/apis/taf.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/apis/telex.d.ts

@@ -0,0 +1,81 @@
+export declare class TelexConnection {
+    id: string;
+    isActive: boolean;
+    firstContact: Date;
+    lastContact: Date;
+    flight: string;
+    location: {
+        x: number;
+        y: number;
+    };
+    trueAltitude: number;
+    heading: number;
+    freetextEnabled: boolean;
+    aircraftType: string;
+    origin: string;
+    destination: string;
+}
+export declare class SearchResult<T> {
+    fullMatch?: T;
+    matches: T[];
+}
+export declare class TelexMessage {
+    id: string;
+    createdAt: Date;
+    received: boolean;
+    message: string;
+    isProfane: boolean;
+    from: TelexConnection;
+    to?: TelexConnection;
+}
+export declare class Token {
+    accessToken: string;
+    connection: string;
+    flight: string;
+}
+export declare class AircraftStatus {
+    location: {
+        long: number;
+        lat: number;
+    };
+    trueAltitude: number;
+    heading: number;
+    origin: string;
+    destination: string;
+    freetextEnabled: boolean;
+    flight: string;
+    aircraftType: string;
+}
+export declare class Paginated<T> {
+    results: T[];
+    count: number;
+    total: number;
+}
+export declare class Bounds {
+    north: number;
+    east: number;
+    south: number;
+    west: number;
+}
+export declare type StageCallback = (flights: TelexConnection[]) => void;
+export declare class TelexNotConnectedError extends Error {
+    constructor();
+}
+export declare class Telex {
+    private static accessToken;
+    static connect(status: AircraftStatus): Promise<Token>;
+    static update(status: AircraftStatus): Promise<TelexConnection>;
+    static disconnect(): Promise<void>;
+    static sendMessage(recipientFlight: string, message: string): Promise<TelexMessage>;
+    static fetchMessages(): Promise<TelexMessage[]>;
+    static fetchConnections(skip?: number, take?: number, bounds?: Bounds): Promise<Paginated<TelexConnection>>;
+    static fetchAllConnections(bounds?: Bounds, stageCallback?: StageCallback): Promise<TelexConnection[]>;
+    static fetchConnection(id: string): Promise<TelexConnection>;
+    static findConnections(flightNumber: string): Promise<SearchResult<TelexConnection>>;
+    static countConnections(): Promise<number>;
+    private static buildBody;
+    private static buildToken;
+    private static connectionOrThrow;
+    private static mapConnection;
+    private static mapMessage;
+}

package/dist/apis/telex.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export declare class NXApi {
+    static url: URL;
+}
+export * from './apis';