refactor: corrections

CHANGELOG.md

@@ -1,5 +1,11 @@
-## 3.0.0
+# aviationweather
+
+## 3.0.4
 
 ### Major Changes
 
 - migration to latest aviationweather api
+
+### Patch Changes
+
+- stations type

package.json

@@ -1,6 +1,6 @@
 {
   "name": "aviationweather",
-  "version": "3.0.0",
+  "version": "3.0.4",
   "description": "Node.js wrapper for aviation weather, written in TypeScript",
   "keywords": [
     "aviation",

src/api.ts

@@ -1,25 +1,29 @@
 import axios, { AxiosResponse } from "axios";
-import { TafParams } from "./types/params/taf.js";
-import { TafResponse } from "./types/response/taf.js";
-import { MetarResponse } from "./types/response/metar.js";
-import { MetarParams } from "./types/params/metar.js";
+import {
+  MetarParams,
+  MetarResponse,
+  TafParams,
+  TafResponse,
+} from "./types/index.js";
 
 export const api = axios.create({
   baseURL: "https://aviationweather.gov/cgi-bin/data",
 });
 
-export function getMetar(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function getMetar<T = MetarResponse[]>(
   params: MetarParams,
-): Promise<AxiosResponse<MetarResponse[]>> {
-  return api.get<MetarResponse[]>("/metar.php", {
+): Promise<AxiosResponse<T>> {
+  return api.get<T>("/metar.php", {
     params,
   });
 }
 
-export function getTaf(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function getTaf<T = TafResponse[]>(
   params: TafParams,
-): Promise<AxiosResponse<TafResponse[]>> {
-  return api.get<TafResponse[]>("/metar.php", {
+): Promise<AxiosResponse<T>> {
+  return api.get<T>("/taf.php", {
     params,
   });
 }

src/common/index.ts

@@ -0,0 +1,4 @@
+import stations from "./stations.js";
+
+export { stations };
+export * from "./sky.js";

src/common/sky.ts

@@ -0,0 +1,15 @@
+import { IMetaSkyCondition } from "../types/common/sky.js";
+
+export const skyConditions: IMetaSkyCondition[] = [
+  { code: "BKN", description: "Broken cloud" },
+  { code: "CB", description: "Cumulonimbus" },
+  { code: "CLR", description: "Sky clear" },
+  { code: "FEW", description: "Few cloud" },
+  { code: "OVC", description: "Overcast cloud" },
+  { code: "OVCX", description: "Overcast cloud" },
+  { code: "SCT", description: "Scattered cloud" },
+  { code: "SKC", description: "Sky Clear" },
+  { code: "TCU", description: "Towering Cumulus" },
+  { code: "NSC", description: "No Significant Cloud" },
+  { code: "CAVOK", description: "Cloud and Visibility OK" },
+];

src/common/stations.ts

@@ -1,3 +1,5 @@
+import { Station } from "../types/common/station";
+
 export default [
   {
     icaoId: "32012",
@@ -125917,4 +125919,4 @@ export default [
     country: "US",
     priority: 6,
   },
-];
+] as Station[];

src/index.ts

@@ -1,4 +1,3 @@
-import stations from "./common/stations.js";
-
 export * from "./api.js";
-export { stations };
+export * from "./common/index.js";
+export * from "./types/index.js";

src/types/common/cloud.ts

@@ -0,0 +1,4 @@
+export interface Cloud {
+  cover: string;
+  base?: number;
+}

src/types/common/index.ts

@@ -0,0 +1,3 @@
+export * from "./cloud.js";
+export * from "./sky.js";
+export * from "./station.js";

src/types/common/station.ts

@@ -0,0 +1,13 @@
+export interface Station {
+  icaoId: string;
+  iataId: string;
+  faaId: string;
+  wmoId: string;
+  lat: number;
+  lon: number;
+  elev: number;
+  site: string;
+  state: string;
+  country: string;
+  priority: number;
+}

src/types/index.ts

@@ -0,0 +1,3 @@
+export * from "./common/index.js";
+export * from "./params/index.js";
+export * from "./response/index.js";

src/types/params/index.ts

@@ -0,0 +1,2 @@
+export * from "./metar.js";
+export * from "./taf.js";

src/types/params/metar.ts

@@ -1,4 +1,6 @@
 export interface MetarParams {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string]: any;
   ids: string;
   format?: "raw" | "json" | "geojson" | "xml" | "html";
   taf?: boolean;

src/types/params/taf.ts

@@ -1,4 +1,6 @@
 export interface TafParams {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string]: any;
   ids: string;
   format?: "raw" | "json" | "geojson" | "xml" | "html";
   taf?: boolean;

src/types/response/index.ts

@@ -0,0 +1,2 @@
+export * from "./metar.js";
+export * from "./taf.js";

src/types/response/metar.ts

@@ -1,3 +1,5 @@
+import { Cloud } from "../common/cloud.js";
+
 export interface MetarResponse {
   metar_id: number;
   icaoId: string;
@@ -9,7 +11,7 @@ export interface MetarResponse {
   wdir?: number;
   wspd?: number;
   wgst?: number;
-  visib?: number;
+  visib?: number | string;
   altim?: number;
   slp?: number;
   qcField: number;
@@ -35,8 +37,3 @@ export interface MetarResponse {
   name: string;
   clouds: Cloud[];
 }
-
-export interface Cloud {
-  cover: string;
-  base?: number;
-}

src/types/response/taf.ts

@@ -1,3 +1,5 @@
+import { Cloud } from "../common/cloud.js";
+
 export interface TafResponse {
   tafId: number;
   icaoId: string;
@@ -30,7 +32,7 @@ export interface Fcst {
   wshearHgt?: number;
   wshearDir?: number;
   wshearSpd?: number;
-  visib: string;
+  visib?: number | string;
   altim?: number;
   vertVis?: number;
   wxString?: string;
@@ -39,9 +41,3 @@ export interface Fcst {
   icgTurb?: number[];
   temp?: number[];
 }
-
-export interface Cloud {
-  cover: string;
-  base: number;
-  type?: number;
-}