feat: add cycle information endpoint utility

Author: SkySails

packages/amdb/src/api/getAmdbCycle.ts

@@ -0,0 +1,16 @@
+import { Logger } from "@navigraph/app"
+import { isAxiosError, navigraphRequest } from "@navigraph/auth"
+import { getAmdbApiRoot } from "../constants"
+import { AmdbCycleResult } 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`)
+    .catch((e: unknown) => Logger.err("Failed to fetch amdb cycle. Reason:", isAxiosError(e) ? e.message : e))
+
+  return result?.data || null
+}

packages/amdb/src/constants.ts

@@ -1,4 +1,3 @@
 import { getDefaultAppDomain } from "@navigraph/app"
 
 export const getAmdbApiRoot = () => `https://amdb.api.${getDefaultAppDomain()}/v1`
-export const getInfoApiRoot = () => `https://amdb.api.${getDefaultAppDomain()}/info`

packages/amdb/src/lib/getAmdbAPI.ts

@@ -1,4 +1,5 @@
 import { getApp, Logger, NotInitializedError, Scope } from "@navigraph/app"
+import getAmdbCycle from "../api/getAmdbCycle"
 import getAmdbLayer from "../api/getAmdbLayer"
 import getAmdbLayers from "../api/getAmdbLayers"
 import searchAmdb from "../api/searchAmdb"
@@ -18,6 +19,7 @@ export const getAmdbAPI = () => {
   return {
     getAmdbLayer,
     getAmdbLayers,
+    getAmdbCycle,
     searchAmdb,
   }
 }

packages/amdb/src/types/index.ts

@@ -116,3 +116,10 @@ export interface AmdbSearchResult {
   name: string
   coordinates: { lat: number; lon: number }
 }
+
+export interface AmdbCycleResult {
+  cycle_start_date: string
+  cycle_end_date: string
+  import_time: string
+  airac_cycle: number
+}