refactor: result -> response

To match the types in the other modules

Author: SkySails

packages/amdb/src/api/getAmdbCycle.ts

@@ -1,15 +1,15 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getAmdbApiRoot } from "../constants"
-import { AmdbCycleResult } from "../types"
+import { AmdbCycleResponse } from "../types"
 
 /**
  * Fetches information about the currently active cycle
  * @returns A record conntaining the cycle number along with start and end dates.
  */
 export default async function getAmdbCycle() {
   const result = await navigraphRequest
-    .get<AmdbCycleResult>(`${getAmdbApiRoot()}/cycle`)
+    .get<AmdbCycleResponse>(`${getAmdbApiRoot()}/cycle`)
     .catch((e: unknown) => Logger.err("Failed to fetch amdb cycle. Reason:", isAxiosError(e) ? e.message : e))
 
   return result?.data || null

packages/amdb/src/api/getAmdbLayer.ts

@@ -1,7 +1,7 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getAmdbApiRoot } from "../constants"
-import { AmdbLayerName, AmdbResult, Projection } from "../types"
+import { AmdbLayerName, AmdbResponse, Projection } from "../types"
 
 /**
  * Fetches a single layer from the AMDB for a specific airport
@@ -24,7 +24,7 @@ export default async function getAmdbLayer<L extends AmdbLayerName>({
   precision?: number
 }) {
   const result = await navigraphRequest
-    .get<AmdbResult<L>[L]>(`${getAmdbApiRoot()}/${icao}/${layer}`, {
+    .get<AmdbResponse<L>[L]>(`${getAmdbApiRoot()}/${icao}/${layer}`, {
       params: {
         projection,
         precision,

packages/amdb/src/api/getAmdbLayers.ts

@@ -1,7 +1,7 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getAmdbApiRoot } from "../constants"
-import { AmdbLayerName, AmdbResult, Projection } from "../types"
+import { AmdbLayerName, AmdbResponse, Projection } from "../types"
 
 /**
  * Fetches all layers, specific layers, or all layers minus some set of layers from the AMDB for a specific airport
@@ -29,7 +29,7 @@ export default async function getAmdbLayers<
   projection?: Projection
   precision?: number
 }) {
-  type Result = AmdbResult<
+  type Response = AmdbResponse<
     I extends AmdbLayerName[]
       ? I[number]
       : E extends AmdbLayerName[]
@@ -38,7 +38,7 @@ export default async function getAmdbLayers<
   >
 
   const result = await navigraphRequest
-    .get<Result>(`${getAmdbApiRoot()}/${icao}`, {
+    .get<Response>(`${getAmdbApiRoot()}/${icao}`, {
       params: {
         include: include?.join(","),
         exclude: exclude?.join(","),

packages/amdb/src/api/searchAmdb.ts

@@ -2,7 +2,7 @@ import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getAmdbApiRoot } from "../constants"
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { AerodromeReferencePoint, AmdbSearchResult } from "../types"
+import { AerodromeReferencePoint, AmdbSearchResponse } from "../types"
 
 /**
  * Searches for airports with AMDB data based on a query string and returns some metadata about them
@@ -13,7 +13,7 @@ import { AerodromeReferencePoint, AmdbSearchResult } from "../types"
  */
 export default async function searchAmdb(query: string) {
   const result = await navigraphRequest
-    .get<AmdbSearchResult[]>(`${getAmdbApiRoot()}/search`, {
+    .get<AmdbSearchResponse[]>(`${getAmdbApiRoot()}/search`, {
       params: {
         q: query,
       },

packages/amdb/src/types/index.ts

@@ -52,7 +52,7 @@ type FeatureCollection<T extends AmdbFeature<object, FeatureType, Point | LineSt
   T["properties"]
 >
 
-export interface AmdbResultStructure {
+export interface AmdbResponseStructure {
   aerodromereferencepoint: FeatureCollection<AerodromeReferencePoint>
   apronelement: FeatureCollection<ApronElement>
   arrestinggearlocation: FeatureCollection<ArrestingGearLocation>
@@ -89,14 +89,14 @@ export interface AmdbResultStructure {
   water: FeatureCollection<Water>
 }
 
-export type AmdbLayerName = keyof AmdbResultStructure
+export type AmdbLayerName = keyof AmdbResponseStructure
 
-// Type checks that FeatureType names match AmdbResultStructure so we can have an array of valid layers
+// Type checks that FeatureType names match AmdbResponseStructure so we can have an array of valid layers
 export const allLayers: AmdbLayerName[] = Object.keys(FeatureType)
   .filter(item => !parseInt(item) && item != "0")
   .map(item => item.toLowerCase()) as Lowercase<keyof typeof FeatureType>[]
 
-export type AmdbResult<P extends AmdbLayerName> = Pick<AmdbResultStructure, P>
+export type AmdbResponse<P extends AmdbLayerName> = Pick<AmdbResponseStructure, P>
 
 export enum Projection {
   /**
@@ -109,15 +109,15 @@ export enum Projection {
   Epsg4326 = "EPSG:4326",
 }
 
-export interface AmdbSearchResult {
+export interface AmdbSearchResponse {
   idarpt: string
   iata: string | null
   elev: number
   name: string
   coordinates: { lat: number; lon: number }
 }
 
-export interface AmdbCycleResult {
+export interface AmdbCycleResponse {
   cycle_start_date: string
   cycle_end_date: string
   import_time: string