metar-taf-parser 2.0.0 → 3.0.0

package/README.md

@@ -1,9 +1,21 @@
 # ✈️ [metar-taf-parser](https://aeharding.github.io/metar-taf-parser)
 
-Parser for METeorological Aerodrome Reports (METARs) and Terminal Aerodrome Forecasts (TAFs). This is a port of [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser) to Typescript. It's dependency-free, fully typed, tested, has i18n support, and can run on Node or in the browser.
+Parser for METeorological Aerodrome Reports (METARs) and Terminal Aerodrome Forecasts (TAFs). This is a port of [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser) to Typescript with some additional features.
 
 [Check out the demo here](https://aeharding.github.io/metar-taf-parser)
 
+Features:
+
+- ✈️ Complete METAR and TAF parsing
+- 🛠 Fully typed
+- 🪶 Dependency free
+- 🧪 Full test suite
+- ✅ Runs anywhere: Web browser or Node
+- 🌎 i18n: Translations
+- 🌏 i18n: Handling international TAF & METAR report format differences
+- 🌪 Remark parsing to human and machine readable formats
+- 🗓 [`Forecast` abstraction](https://aeharding.github.io/metar-taf-parser/forecast) to easily query TAF reports by `Date`
+
 ## Installation
 
 ```sh
@@ -114,6 +126,33 @@ const metarResult = parseMetar(rawMetarReport, {
 console.log(metarReport.remarks[0].description);
 ```
 
+## Handling remarks
+
+Remarks may be found on base TAF and METARs, along with TAF trends.
+
+Each Remark will have a `description` (if translated), `type` and `raw` properties. There are additional properties for each unique remark, depending on the remark's `type`. We can type guard on `type` to access these unique properties.
+
+If the remark is not understood, it will have `type` as `RemarkType.Unknown`, with `raw` containing everything until the next understood remark.
+
+### Example
+
+```ts
+import { Remark, RemarkType } from "metar-taf-parser";
+
+/**
+ * Find the sea level pressure given remarks, if defined
+ */
+function findSeaLevelPressure(remarks: Remark[]): number | undefined {
+  for (const remark of remarks) {
+    switch (remark.type) {
+      case RemarkType.SeaLevelPressure:
+        // can now access remark.pressure
+        return remark.pressure;
+    }
+  }
+}
+```
+
 ## Development
 
 ### Example site

package/dist/command/common.js

@@ -233,8 +233,7 @@ class CommandSupplier {
         ]);
     }
     get(input) {
-        for (let i = 0; i < __classPrivateFieldGet(this, _CommandSupplier_commands, "f").length; i++) {
-            const command = __classPrivateFieldGet(this, _CommandSupplier_commands, "f")[i];
+        for (const command of __classPrivateFieldGet(this, _CommandSupplier_commands, "f")) {
             if (command.canParse(input))
                 return command;
         }

package/dist/command/metar.js

@@ -21,8 +21,7 @@ class CommandSupplier {
         ]);
     }
     get(input) {
-        for (let i = 0; i < __classPrivateFieldGet(this, _CommandSupplier_commands, "f").length; i++) {
-            const command = __classPrivateFieldGet(this, _CommandSupplier_commands, "f")[i];
+        for (const command of __classPrivateFieldGet(this, _CommandSupplier_commands, "f")) {
             if (command.canParse(input))
                 return command;
         }

package/dist/command/remark/HailSizeCommand.d.ts

@@ -2,7 +2,7 @@ import { IBaseRemark, RemarkType, Remark } from "../remark";
 import { Command } from "./Command";
 export interface IHailSizeRemark extends IBaseRemark {
     type: RemarkType.HailSize;
-    size: string;
+    size: number;
 }
 export declare class HailSizeCommand extends Command {
     #private;

package/dist/command/remark/HailSizeCommand.js

@@ -11,6 +11,7 @@ const i18n_1 = require("../../commons/i18n");
 const errors_1 = require("../../commons/errors");
 const remark_1 = require("../remark");
 const Command_1 = require("./Command");
+const converter_1 = require("../../commons/converter");
 class HailSizeCommand extends Command_1.Command {
     constructor() {
         super(...arguments);
@@ -28,7 +29,7 @@ class HailSizeCommand extends Command_1.Command {
             type: remark_1.RemarkType.HailSize,
             description,
             raw: matches[0],
-            size: matches[1],
+            size: (0, converter_1.convertFractionalAmount)(matches[1]),
         });
         return [code.replace(__classPrivateFieldGet(this, _HailSizeCommand_regex, "f"), "").trim(), remark];
     }

package/dist/command/remark/PrevailingVisibilityCommand.d.ts

@@ -2,8 +2,8 @@ import { IBaseRemark, RemarkType, Remark } from "../remark";
 import { Command } from "./Command";
 export interface IPrevailingVisibilityRemark extends IBaseRemark {
     type: RemarkType.PrevailingVisibility;
-    minVisibility: string;
-    maxVisibility: string;
+    minVisibility: number;
+    maxVisibility: number;
 }
 export declare class PrevailingVisibilityCommand extends Command {
     #private;

package/dist/command/remark/PrevailingVisibilityCommand.js

@@ -11,6 +11,7 @@ const i18n_1 = require("../../commons/i18n");
 const errors_1 = require("../../commons/errors");
 const remark_1 = require("../remark");
 const Command_1 = require("./Command");
+const converter_1 = require("../../commons/converter");
 class PrevailingVisibilityCommand extends Command_1.Command {
     constructor() {
         super(...arguments);
@@ -30,8 +31,8 @@ class PrevailingVisibilityCommand extends Command_1.Command {
             type: remark_1.RemarkType.PrevailingVisibility,
             description,
             raw: matches[0],
-            minVisibility,
-            maxVisibility,
+            minVisibility: (0, converter_1.convertFractionalAmount)(minVisibility),
+            maxVisibility: (0, converter_1.convertFractionalAmount)(maxVisibility),
         });
         return [code.replace(__classPrivateFieldGet(this, _PrevailingVisibilityCommand_regex, "f"), "").trim(), remark];
     }

package/dist/command/remark/SecondLocationVisibilityCommand.d.ts

@@ -2,7 +2,7 @@ import { IBaseRemark, RemarkType, Remark } from "../remark";
 import { Command } from "./Command";
 export interface ISecondLocationVisibilityRemark extends IBaseRemark {
     type: RemarkType.SecondLocationVisibility;
-    distance: string;
+    distance: number;
     location: string;
 }
 export declare class SecondLocationVisibilityCommand extends Command {

package/dist/command/remark/SecondLocationVisibilityCommand.js

@@ -11,6 +11,7 @@ const i18n_1 = require("../../commons/i18n");
 const errors_1 = require("../../commons/errors");
 const remark_1 = require("../remark");
 const Command_1 = require("./Command");
+const converter_1 = require("../../commons/converter");
 class SecondLocationVisibilityCommand extends Command_1.Command {
     constructor() {
         super(...arguments);
@@ -30,7 +31,7 @@ class SecondLocationVisibilityCommand extends Command_1.Command {
             type: remark_1.RemarkType.SecondLocationVisibility,
             description,
             raw: matches[0],
-            distance,
+            distance: (0, converter_1.convertFractionalAmount)(distance),
             location,
         });
         return [code.replace(__classPrivateFieldGet(this, _SecondLocationVisibilityCommand_regex, "f"), "").trim(), remark];

package/dist/command/remark/SectorVisibilityCommand.d.ts

@@ -4,7 +4,7 @@ import { Command } from "./Command";
 export interface ISectorVisibilityRemark extends IBaseRemark {
     type: RemarkType.SectorVisibility;
     direction: Direction;
-    distance: string;
+    distance: number;
 }
 export declare class SectorVisibilityCommand extends Command {
     #private;

package/dist/command/remark/SectorVisibilityCommand.js

@@ -13,6 +13,7 @@ const errors_1 = require("../../commons/errors");
 const enum_1 = require("../../model/enum");
 const remark_1 = require("../remark");
 const Command_1 = require("./Command");
+const converter_1 = require("../../commons/converter");
 class SectorVisibilityCommand extends Command_1.Command {
     constructor() {
         super(...arguments);
@@ -32,7 +33,7 @@ class SectorVisibilityCommand extends Command_1.Command {
             description,
             raw: matches[0],
             direction,
-            distance: matches[2],
+            distance: (0, converter_1.convertFractionalAmount)(matches[2]),
         });
         return [code.replace(__classPrivateFieldGet(this, _SectorVisibilityCommand_regex, "f"), "").trim(), remark];
     }

package/dist/command/remark/SmallHailSizeCommand.d.ts

@@ -2,7 +2,7 @@ import { IBaseRemark, RemarkType, Remark } from "../remark";
 import { Command } from "./Command";
 export interface ISmallHailSizeRemark extends IBaseRemark {
     type: RemarkType.SmallHailSize;
-    size: string;
+    size: number;
 }
 export declare class SmallHailSizeCommand extends Command {
     #private;

package/dist/command/remark/SmallHailSizeCommand.js

@@ -11,6 +11,7 @@ const i18n_1 = require("../../commons/i18n");
 const errors_1 = require("../../commons/errors");
 const remark_1 = require("../remark");
 const Command_1 = require("./Command");
+const converter_1 = require("../../commons/converter");
 class SmallHailSizeCommand extends Command_1.Command {
     constructor() {
         super(...arguments);
@@ -28,7 +29,7 @@ class SmallHailSizeCommand extends Command_1.Command {
             type: remark_1.RemarkType.SmallHailSize,
             description,
             raw: matches[0],
-            size: matches[1],
+            size: (0, converter_1.convertFractionalAmount)(matches[1]),
         });
         return [code.replace(__classPrivateFieldGet(this, _SmallHailSizeCommand_regex, "f"), "").trim(), remark];
     }

package/dist/command/remark/SurfaceVisibilityCommand.d.ts

@@ -2,7 +2,7 @@ import { IBaseRemark, RemarkType, Remark } from "../remark";
 import { Command } from "./Command";
 export interface ISurfaceVisibilityRemark extends IBaseRemark {
     type: RemarkType.SurfaceVisibility;
-    distance: string;
+    distance: number;
 }
 export declare class SurfaceVisibilityCommand extends Command {
     #private;

package/dist/command/remark/SurfaceVisibilityCommand.js

@@ -11,6 +11,7 @@ const i18n_1 = require("../../commons/i18n");
 const errors_1 = require("../../commons/errors");
 const remark_1 = require("../remark");
 const Command_1 = require("./Command");
+const converter_1 = require("../../commons/converter");
 class SurfaceVisibilityCommand extends Command_1.Command {
     constructor() {
         super(...arguments);
@@ -29,7 +30,7 @@ class SurfaceVisibilityCommand extends Command_1.Command {
             type: remark_1.RemarkType.SurfaceVisibility,
             description,
             raw: matches[0],
-            distance,
+            distance: (0, converter_1.convertFractionalAmount)(distance),
         });
         return [code.replace(__classPrivateFieldGet(this, _SurfaceVisibilityCommand_regex, "f"), "").trim(), remark];
     }

package/dist/command/remark/TowerVisibilityCommand.d.ts

@@ -2,7 +2,7 @@ import { IBaseRemark, RemarkType, Remark } from "../remark";
 import { Command } from "./Command";
 export interface ITowerVisibilityRemark extends IBaseRemark {
     type: RemarkType.TowerVisibility;
-    distance: string;
+    distance: number;
 }
 export declare class TowerVisibilityCommand extends Command {
     #private;

package/dist/command/remark/TowerVisibilityCommand.js

@@ -11,6 +11,7 @@ const i18n_1 = require("../../commons/i18n");
 const errors_1 = require("../../commons/errors");
 const remark_1 = require("../remark");
 const Command_1 = require("./Command");
+const converter_1 = require("../../commons/converter");
 class TowerVisibilityCommand extends Command_1.Command {
     constructor() {
         super(...arguments);
@@ -29,7 +30,7 @@ class TowerVisibilityCommand extends Command_1.Command {
             type: remark_1.RemarkType.TowerVisibility,
             description,
             raw: matches[0],
-            distance,
+            distance: (0, converter_1.convertFractionalAmount)(distance),
         });
         return [code.replace(__classPrivateFieldGet(this, _TowerVisibilityCommand_regex, "f"), "").trim(), remark];
     }

package/dist/command/remark.js

@@ -88,8 +88,7 @@ class RemarkCommandSupplier {
         ];
     }
     get(code) {
-        for (let i = 0; i < this.commandList.length; i++) {
-            const command = this.commandList[i];
+        for (const command of this.commandList) {
             if (command.canParse(code))
                 return command;
         }

package/dist/commons/i18n.js

@@ -18,8 +18,8 @@ function format(message, ...args) {
     if (!message)
         return;
     // All arguments must be defined, otherwise nothing is returned
-    for (let i = 0; i < args.length; i++) {
-        if (args[i] === undefined)
+    for (const arg of args) {
+        if (arg === undefined)
             return;
     }
     return message.replace(/{\d+}/g, (match) => {

package/dist/forecast/forecast.js

@@ -52,8 +52,7 @@ function getCompositeForecastForDate(date, forecastContainer) {
         throw new TimestampOutOfBoundsError("Provided timestamp is outside the report validity period");
     let base;
     let additional = [];
-    for (let i = 0; i < forecastContainer.forecast.length; i++) {
-        const forecast = forecastContainer.forecast[i];
+    for (const forecast of forecastContainer.forecast) {
         if (!forecast.validity.end &&
             forecast.validity.start.getTime() <= date.getTime()) {
             // Is FM or initial forecast

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metar-taf-parser",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "Parse METAR and TAF reports",
   "homepage": "https://aeharding.github.io/metar-taf-parser",
   "keywords": [