feat: metar/taf endpoints

Author: professoralex13

packages/app/src/types.ts

@@ -3,4 +3,5 @@ export enum Scope {
   "FMSDATA" = "fmsdata",
   "TILES" = "tiles",
   "AMDB" = "amdb",
+  "WEATHER" = "weather",
 }

packages/weather/CHANGELOG.md

@@ -0,0 +1,3 @@
+# @navigraph/weather
+
+## 0.0.1

packages/weather/README.md

@@ -0,0 +1,4 @@
+# @navigraph/weather
+
+This package is part of the Navigraph SDK, and is intended to be used in conjuction with other SDK modules.
+See the [navigraph](https://www.npmjs.com/package/navigraph) package for usage.

packages/weather/clean-package.config.json

@@ -0,0 +1,14 @@
+{
+  "replace": {
+    "main": "dist/index.cjs.js",
+    "module": "dist/index.esm.js",
+    "types": "dist/index.d.ts",
+    "exports": {
+      ".": {
+        "import": "./dist/index.esm.js",
+        "require": "./dist/index.cjs.js"
+      },
+      "./package.json": "./package.json"
+    }
+  }
+}

packages/weather/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import("ts-jest").JestConfigWithTsJest} */
+module.exports = {
+  displayName: "Charts",
+  preset: "ts-jest",
+};

packages/weather/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@navigraph/weather",
+  "version": "0.0.1",
+  "license": "MIT",
+  "description": "Allows interaction with the Navigraph Weather API as part of the Navigraph SDK",
+  "author": "Navigraph <[email protected]> (https://navigraph.com)",
+  "homepage": "https://navigraph.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Navigraph/navigraph-js-sdk",
+    "directory": "packages/weather"
+  },
+  "keywords": [
+    "navigraph",
+    "weather",
+    "sdk"
+  ],
+  "main": "./src/index.ts",
+  "private": false,
+  "sideEffects": false,
+  "files": [
+    "dist/**"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --dts",
+    "dev": "tsup src/index.ts --watch --sourcemap inline",
+    "lint": "eslint \"src/**/*.ts\"",
+    "clean": "rimraf .turbo node_modules dist",
+    "prepack": "clean-package",
+    "postpack": "clean-package restore"
+  },
+  "dependencies": {
+    "@navigraph/app": "1.3.5",
+    "@navigraph/auth": "2.5.1",
+    "geojson": "^0.5.0",
+    "metar-taf-parser": "^9.0.1"
+  }
+}

packages/weather/src/api/getReportsAlongRoute.ts

@@ -0,0 +1,27 @@
+import { Logger } from "@navigraph/app"
+import { isAxiosError, navigraphRequest } from "@navigraph/auth"
+import { Position } from "geojson"
+import { getRouteApiRoot } from "../constants"
+import { Metar, Taf } from "./types"
+
+export default async function getReportsAlongRoute<T extends "metar" | "taf">(
+  path: Position[],
+  type: T,
+  range?: number,
+) {
+  type ReportType = T extends "metar" ? Metar : T extends "taf" ? Taf : never
+
+  const result = await navigraphRequest
+    .get<ReportType[]>(getRouteApiRoot(), {
+      params: {
+        path: path.map(position => position.join(",")).join(";"),
+        type,
+        range,
+      },
+    })
+    .catch((e: unknown) =>
+      Logger.err("Failed to fetch weather reports along route. Reason:", isAxiosError(e) ? e.message : e),
+    )
+
+  return result?.data || null
+}

packages/weather/src/api/metar/getMetarAtAirport.ts

@@ -0,0 +1,12 @@
+import { Logger } from "@navigraph/app"
+import { isAxiosError, navigraphRequest } from "@navigraph/auth"
+import { getMetarApiRoot } from "../../constants"
+import { Metar } from "../types"
+
+export default async function getMetarAtAirport(icao: string) {
+  const result = await navigraphRequest
+    .get<Metar>(`${getMetarApiRoot()}/${icao}`)
+    .catch((e: unknown) => Logger.err(`Failed to fetch METAR for ${icao}. Reason:`, isAxiosError(e) ? e.message : e))
+
+  return result?.data || null
+}

packages/weather/src/api/metar/getMetarsAroundPoint.ts

@@ -0,0 +1,24 @@
+import { Logger } from "@navigraph/app"
+import { isAxiosError, navigraphRequest } from "@navigraph/auth"
+import { getMetarApiRoot } from "../../constants"
+import { Metar } from "../types"
+
+export default async function getMetarsAroundPoint(
+  latitude: number,
+  longitude: number,
+  radius?: number,
+  limit?: number,
+) {
+  const result = await navigraphRequest
+    .get<Metar[]>(`${getMetarApiRoot()}/around/${latitude}/${longitude}`, {
+      params: {
+        radius,
+        limit,
+      },
+    })
+    .catch((e: unknown) =>
+      Logger.err(`Failed to fetch METARs around (${latitude}, ${longitude}). Reason:`, isAxiosError(e) ? e.message : e),
+    )
+
+  return result?.data || null
+}

packages/weather/src/api/metar/getMetarsAtAirport.ts

@@ -0,0 +1,12 @@
+import { Logger } from "@navigraph/app"
+import { isAxiosError, navigraphRequest } from "@navigraph/auth"
+import { getMetarApiRoot } from "../../constants"
+import { Metar } from "../types"
+
+export default async function getMetarsAtAirport(icao: string) {
+  const result = await navigraphRequest
+    .get<Metar[]>(`${getMetarApiRoot()}/multi/${icao}`)
+    .catch((e: unknown) => Logger.err(`Failed to fetch METARs for ${icao}. Reason:`, isAxiosError(e) ? e.message : e))
+
+  return result?.data || null
+}