fix: docomments and endpoint constants

Update avwx.tsx

Author: professoralex13

examples/playground/src/components/map/avwx.tsx

@@ -30,7 +30,7 @@ const Avwx = memo(() => {
   const layers = useQueries({
     queries: sources.map(source => ({
       queryKey: ["avwx", source],
-      queryFn: async () => [source, await weatherApi.getAvwxReports([source])] as const,
+      queryFn: async () => [source, await weatherApi.getAviationWeatherReports([source])] as const,
     })),
   })
 

packages/weather/src/api/avwx/getAvwxReports.ts renamed to packages/weather/src/api/avwx/getAviationWeatherReports.ts

@@ -1,17 +1,17 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { FeatureCollection, Geometry } from "geojson"
-import { getAvwxApiRoot } from "../../constants"
+import { getWeatherApiRoot } from "../../constants"
 import { AVWXSource, AVWXSourceProperties } from "../types"
 
 /**
- * Queries GeoJSON data for all AVWX reports currently available from the selected sources
- * @param sources - List of sources to from which to load AVWX reports from
+ * Queries GeoJSON data for all aviation weather reports currently available from the selected sources
+ * @param sources - List of sources to from which to load the reports from
  * @returns A GEOJson feature collection containing the reports
  */
-export default async function getAvwxReports<S extends AVWXSource>(sources: S[]) {
+export default async function getAviationWeatherReports<S extends AVWXSource>(sources: S[]) {
   const result = await navigraphRequest
-    .get<FeatureCollection<Geometry, AVWXSourceProperties[S]>>(`${getAvwxApiRoot()}/combined`, {
+    .get<FeatureCollection<Geometry, AVWXSourceProperties[S]>>(`${getWeatherApiRoot()}/avwx/combined`, {
       params: { sources: sources.join(",") },
     })
     .catch((e: unknown) => Logger.err("Failed to AVWX reports. Reason:", isAxiosError(e) ? e.message : e))

packages/weather/src/api/getReportsAlongRoute.ts

@@ -1,7 +1,7 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { Position } from "geojson"
-import { getRouteApiRoot } from "../constants"
+import { getWeatherApiRoot } from "../constants"
 import { Metar, Taf } from "./types"
 
 /**
@@ -18,7 +18,7 @@ export default async function getReportsAlongRoute<T extends "metar" | "taf">(
   type ReportType = T extends "metar" ? Metar : T extends "taf" ? Taf : never
 
   const result = await navigraphRequest
-    .get<ReportType[]>(getRouteApiRoot(), {
+    .get<ReportType[]>(`${getWeatherApiRoot()}/route`, {
       params: {
         path: path.map(position => position.join(",")).join(";"),
         type,

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

@@ -1,6 +1,6 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
-import { getMetarApiRoot } from "../../constants"
+import { getWeatherApiRoot } from "../../constants"
 import { Metar } from "../types"
 
 /**
@@ -10,7 +10,7 @@ import { Metar } from "../types"
  */
 export default async function getMetarAtAirport(icao: string) {
   const result = await navigraphRequest
-    .get<Metar>(`${getMetarApiRoot()}/${icao}`)
+    .get<Metar>(`${getWeatherApiRoot()}/metar/${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

@@ -1,10 +1,10 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
-import { getMetarApiRoot } from "../../constants"
+import { getWeatherApiRoot } from "../../constants"
 import { Metar } from "../types"
 
 /**
- * Queries all METARs within a distance of a point issued within approximately the last 10 hours, ordered by distance from the center point
+ * Queries all METARs within a distance of a point issued within approximately the last 10 hours, ordered from most recent to most outdated, then by distance from the center point
  * @param latitude - Latitude of the center point
  * @param longitude - longitude of the center point
  * @param radius - Radius in **nautical miles** around the center point to search for METARs within
@@ -18,7 +18,7 @@ export default async function getMetarsAroundPoint(
   limit?: number,
 ) {
   const result = await navigraphRequest
-    .get<Metar[]>(`${getMetarApiRoot()}/around/${latitude}/${longitude}`, {
+    .get<Metar[]>(`${getWeatherApiRoot()}/metar/around/${latitude}/${longitude}`, {
       params: {
         radius,
         limit,

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

@@ -1,16 +1,16 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
-import { getMetarApiRoot } from "../../constants"
+import { getWeatherApiRoot } from "../../constants"
 import { Metar } from "../types"
 
 /**
- * Queries all METARs for an airport issued within approximately the last 10 hours
+ * Queries all METARs for an airport issued within approximately the last 10 hours, ordered from most recent to most outdated
  * @param icao - The ICAO code of the airport from which to load the METARs
  * @returns - An array of METAR objects parsed from the raw reports using {@link https://www.npmjs.com/package/metar-taf-parser metar-taf-parser}
  */
 export default async function getMetarsAtAirport(icao: string) {
   const result = await navigraphRequest
-    .get<Metar[]>(`${getMetarApiRoot()}/multi/${icao}`)
+    .get<Metar[]>(`${getWeatherApiRoot()}/metar/multi/${icao}`)
     .catch((e: unknown) => Logger.err(`Failed to fetch METARs for ${icao}. Reason:`, isAxiosError(e) ? e.message : e))
 
   return result?.data || null

packages/weather/src/api/taf/getTafAtAirport.ts

@@ -1,6 +1,6 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
-import { getTafApiRoot } from "../../constants"
+import { getWeatherApiRoot } from "../../constants"
 import { Taf } from "../types"
 
 /**
@@ -10,7 +10,7 @@ import { Taf } from "../types"
  */
 export default async function getTafAtAirport(icao: string) {
   const result = await navigraphRequest
-    .get<Taf>(`${getTafApiRoot()}/${icao}`)
+    .get<Taf>(`${getWeatherApiRoot()}/taf/${icao}`)
     .catch((e: unknown) => Logger.err(`Failed to fetch TAF for ${icao}. Reason:`, isAxiosError(e) ? e.message : e))
 
   return result?.data || null

packages/weather/src/api/taf/getTafsAroundPoint.ts

@@ -1,10 +1,10 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
-import { getTafApiRoot } from "../../constants"
+import { getWeatherApiRoot } from "../../constants"
 import { Taf } from "../types"
 
 /**
- * Queries all TAFs within a distance of a point issued within approximately the last 10 hours, ordered by distance from the center point
+ * Queries all TAFs within a distance of a point issued within approximately the last 10 hours, ordered from most recent to most outdated, then by distance from the center point
  * @param latitude - Latitude of the center point
  * @param longitude - longitude of the center point
  * @param radius - Radius in **nautical miles** around the center point to search for TAFs within
@@ -13,7 +13,7 @@ import { Taf } from "../types"
  */
 export default async function getTafsAroundPoint(latitude: number, longitude: number, radius?: number, limit?: number) {
   const result = await navigraphRequest
-    .get<Taf[]>(`${getTafApiRoot()}/around/${latitude}/${longitude}`, {
+    .get<Taf[]>(`${getWeatherApiRoot()}/taf/around/${latitude}/${longitude}`, {
       params: {
         radius,
         limit,

packages/weather/src/api/taf/getTafsAtAirport.ts

@@ -1,16 +1,16 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
-import { getTafApiRoot } from "../../constants"
+import { getWeatherApiRoot } from "../../constants"
 import { Taf } from "../types"
 
 /**
- * Queries all TAFs for an airport issued within approximately the last 10 hours
+ * Queries all TAFs for an airport issued within approximately the last 10 hours, ordered from most recent to most outdated
  * @param icao - The ICAO code of the airport from which to load the TAFs
  * @returns - An array of TAF objects parsed from the raw reports using {@link https://www.npmjs.com/package/metar-taf-parser metar-taf-parser}
  */
 export default async function getTafsAtAirport(icao: string) {
   const result = await navigraphRequest
-    .get<Taf[]>(`${getTafApiRoot()}/multi/${icao}`)
+    .get<Taf[]>(`${getWeatherApiRoot()}/taf/multi/${icao}`)
     .catch((e: unknown) => Logger.err(`Failed to fetch TAFs for ${icao}. Reason:`, isAxiosError(e) ? e.message : e))
 
   return result?.data || null

packages/weather/src/constants.ts

@@ -1,6 +1,3 @@
 import { getDefaultAppDomain } from "@navigraph/app"
 
-export const getMetarApiRoot = () => `https://wx.api.${getDefaultAppDomain()}/v1/metar`
-export const getTafApiRoot = () => `https://wx.api.${getDefaultAppDomain()}/v1/taf`
-export const getRouteApiRoot = () => `https://wx.api.${getDefaultAppDomain()}/v1/route`
-export const getAvwxApiRoot = () => `https://wx.api.${getDefaultAppDomain()}/v1/avwx`
+export const getWeatherApiRoot = () => `https://wx.api.${getDefaultAppDomain()}/v1`