feat: begin amdb module

Author: professoralex13

packages/amdb/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @navigraph/amdb
+
+## 0.0.1
+
+### Patch Changes
+
+- 

packages/amdb/README.md

@@ -0,0 +1,4 @@
+# @navigraph/amdb
+
+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/amdb/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/amdb/jest.config.js

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

packages/amdb/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@navigraph/amdb",
+  "version": "0.0.1",
+  "license": "MIT",
+  "description": "Allows interaction with the Navigraph AMDB 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/amdb"
+  },
+  "keywords": [
+    "navigraph",
+    "oans",
+    "amm",
+    "airport",
+    "AIRAC",
+    "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"
+  }
+}

packages/amdb/src/api/getAmdbLayer.ts

@@ -0,0 +1,27 @@
+import { Logger } from "@navigraph/app"
+import { isAxiosError, navigraphRequest } from "@navigraph/auth"
+import { getAmdbApiRoot } from "../constants"
+import { AmdbLayerName, AmdbResult, Projection } from "../types"
+
+export default async function getAmdbLayer<L extends AmdbLayerName>({
+  icao,
+  projection,
+  layer,
+  precision,
+}: {
+  icao: string
+  layer: L
+  projection?: Projection
+  precision?: number
+}) {
+  const result = await navigraphRequest
+    .get<AmdbResult<L>[L]>(`${getAmdbApiRoot()}/${icao}/${layer}`, {
+      params: {
+        projection,
+        precision,
+      },
+    })
+    .catch((e: unknown) => Logger.err("Failed to fetch amdb layers. Reason:", isAxiosError(e) ? e.message : e))
+
+  return result?.data || null
+}

packages/amdb/src/api/getAmdbLayers.ts

@@ -0,0 +1,42 @@
+import { Logger } from "@navigraph/app"
+import { isAxiosError, navigraphRequest } from "@navigraph/auth"
+import { getAmdbApiRoot } from "../constants"
+import { AmdbLayerName, AmdbResult, Projection } from "../types"
+
+export default async function getAmdbLayers<
+  I extends AmdbLayerName[] | undefined = undefined,
+  E extends AmdbLayerName[] | undefined = undefined,
+>({
+  icao,
+  include,
+  exclude,
+  projection,
+  precision,
+}: {
+  icao: string
+  include?: I
+  exclude?: E
+  projection?: Projection
+  precision?: number
+}) {
+  type Result = AmdbResult<
+    I extends AmdbLayerName[]
+      ? I[number]
+      : E extends AmdbLayerName[]
+      ? Exclude<AmdbLayerName, E[number]>
+      : AmdbLayerName
+  >
+
+  const result = await navigraphRequest
+    .get<Result>(`${getAmdbApiRoot()}/${icao}`, {
+      params: {
+        include: include?.join(","),
+        exclude: exclude?.join(","),
+        projection,
+        precision,
+      },
+    })
+    .catch((e: unknown) => Logger.err("Failed to fetch amdb layers. Reason:", isAxiosError(e) ? e.message : e))
+
+  return result?.data || null
+}

packages/amdb/src/constants.ts

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

packages/amdb/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./types"
+
+export { getAmdbAPI } from "./lib/getAmdbAPI"

packages/amdb/src/lib/getAmdbAPI.ts

@@ -0,0 +1,21 @@
+import { getApp, Logger, NotInitializedError, Scope } from "@navigraph/app"
+import getAmdbLayer from "../api/getAmdbLayer"
+import getAmdbLayers from "../api/getAmdbLayers"
+
+/** Grabs a reference to an object containing available Navigraph Charts API functionality */
+export const getAmdbAPI = () => {
+  const app = getApp()
+
+  if (!app) {
+    throw new NotInitializedError("Auth")
+  } else if (!app.scopes.includes(Scope.AMDB)) {
+    Logger.warning(
+      "Your Navigraph Application does not have the AMDB scope. Attempts to access the AMDB API will fail.",
+    )
+  }
+
+  return {
+    getAmdbLayer,
+    getAmdbLayers,
+  }
+}