metar-taf-parser 0.0.1 → 1.0.1

package/LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2021 Alexander Harding
+Copyright (c) 2022 Alexander Harding
+Copyright 2021 Jean-Kevin KPADEY
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,11 +1,9 @@
 # metar-taf-parser
 
-This is a port of [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser) to typescript. It's fully typed and tested with i18n support, and can run on Node or the browser.
+This is a port of [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser) to Typescript. It's fully typed and tested with i18n support, and can run on Node or the browser.
 
 ## Example
 
-⚠️ This project is an active work in progress. These examples do not currently work.
-
 ### Parse METAR
 
 ```ts
@@ -13,7 +11,7 @@ import { parseMetar } from 'metar-taf-parser'
 
 // Get the raw METAR/TAF strings in your preferred way
 // For example: https://www.aviationweather.gov/dataserver
-const { metar } = await myService.getAirportData('KMSN')
+// const { metar } = await myService.getAirportData('KMSN')
 
 // Readily serializable
 const metarResult = parseMetar(metar)
@@ -28,7 +26,7 @@ import { parseTAF } from 'metar-taf-parser'
 
 // Get the raw METAR/TAF strings in your preferred way
 // For example: https://www.aviationweather.gov/dataserver
-const { taf } = await myService.getAirportData('KMSN')
+// const { taf } = await myService.getAirportData('KMSN')
 
 // Readily serializable
 const tafResult = parseTAF(taf)
@@ -40,9 +38,23 @@ const tafResult = parseTAF(taf)
 
 ```ts
 import { parseMetar } from 'metar-taf-parser'
-import de from 'metar-taf-parser/locale/de'
+import de from 'metar-taf-parser/dist/locale/de'
 
 const { metar } = await myService.getAirportData('KMSN')
 
 const metarResult = parseMetar(metar, { locale: de })
-```
+```
+
+## Contributing
+
+This project is intended to provide feature parity with [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser) and will only accept PRs to maintain feature parity or to fix inconsistencies with that project.
+
+## Development
+
+### Example site
+
+Please see [the example site README.md](example/README.md).
+
+## Acknowledgment
+
+This software port was made possible due to the fantastic work of [@mivek](https://github.com/mivek) in [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser). If you like this project, please [consider buying @mivek a coffee](https://ko-fi.com/mivek).

package/dist/{lib/command → command}/common.d.ts

@@ -1,4 +1,4 @@
-import { IAbstractWeatherContainer, ICloud, IWind, IWindShear } from "model/model";
+import { IAbstractWeatherContainer, ICloud, IWind, IWindShear } from "../model/model";
 interface ICommand {
     canParse(str: string): boolean;
     execute(container: IAbstractWeatherContainer, str: string): boolean;

package/dist/{lib/command → command}/common.js

@@ -30,9 +30,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _CloudCommand_cloudRegex, _MainVisibilityCommand_regex, _WindCommand_regex, _WindVariationCommand_regex, _WindShearCommand_regex, _VerticalVisibilityCommand_regex, _MinimalVisibilityCommand_regex, _MainVisibilityNauticalMilesCommand_regex, _CommandSupplier_commands;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandSupplier = exports.MainVisibilityNauticalMilesCommand = exports.MinimalVisibilityCommand = exports.VerticalVisibilityCommand = exports.WindShearCommand = exports.WindVariationCommand = exports.WindCommand = exports.MainVisibilityCommand = exports.CloudCommand = void 0;
-const converter = __importStar(require("commons/converter"));
-const enum_1 = require("model/enum");
-const errors_1 = require("commons/errors");
+const converter = __importStar(require("../commons/converter"));
+const enum_1 = require("../model/enum");
+const errors_1 = require("../commons/errors");
 /**
  * This function creates a wind element.
  * @param wind The wind object
@@ -110,7 +110,7 @@ class WindCommand {
         const matches = windString.match(__classPrivateFieldGet(this, _WindCommand_regex, "f"));
         if (!matches)
             throw new errors_1.UnexpectedParseError("Wind should be defined");
-        return makeWind(matches[1], matches[2], matches[3], matches[5]);
+        return makeWind(matches[1], matches[2], matches[3], matches[4]);
     }
     execute(container, windString) {
         const wind = this.parseWind(windString);
@@ -135,6 +135,8 @@ class WindVariationCommand {
         wind.maxVariation = +matches[2];
     }
     execute(container, windString) {
+        if (!container.wind)
+            throw new errors_1.InvalidWeatherStatementError();
         this.parseWindVariation(container.wind, windString);
         return true;
     }

package/dist/{lib/command → command}/metar.d.ts

@@ -1,4 +1,4 @@
-import { IMetar } from "model/model";
+import { IMetar } from "../model/model";
 interface ICommand {
     canParse(str: string): boolean;
     execute(metar: IMetar, str: string): void;
@@ -23,4 +23,8 @@ export declare class TemperatureCommand implements ICommand {
     canParse(input: string): boolean;
     execute(metar: IMetar, input: string): void;
 }
+export declare class CommandSupplier {
+    #private;
+    get(input: string): ICommand | undefined;
+}
 export {};

package/dist/{lib/command → command}/metar.js

@@ -29,9 +29,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _AltimeterCommand_regex, _AltimeterMercuryCommand_regex, _RunwayCommand_genericRegex, _RunwayCommand_runwayMaxRangeRegex, _RunwayCommand_runwayRegex, _TemperatureCommand_regex, _CommandSupplier_commands;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemperatureCommand = exports.RunwayCommand = exports.AltimeterMercuryCommand = exports.AltimeterCommand = void 0;
-const converter = __importStar(require("commons/converter"));
-const errors_1 = require("commons/errors");
+exports.CommandSupplier = exports.TemperatureCommand = exports.RunwayCommand = exports.AltimeterMercuryCommand = exports.AltimeterCommand = void 0;
+const converter = __importStar(require("../commons/converter"));
+const errors_1 = require("../commons/errors");
 class AltimeterCommand {
     constructor() {
         _AltimeterCommand_regex.set(this, /^Q(\d{4})$/);
@@ -43,7 +43,7 @@ class AltimeterCommand {
         const matches = input.match(__classPrivateFieldGet(this, _AltimeterCommand_regex, "f"));
         if (!matches)
             throw new errors_1.UnexpectedParseError("Match not found");
-        metar.altimeter = +matches[1];
+        metar.altimeter = Math.trunc(+matches[1]);
     }
 }
 exports.AltimeterCommand = AltimeterCommand;
@@ -60,7 +60,7 @@ class AltimeterMercuryCommand {
         if (!matches)
             throw new errors_1.UnexpectedParseError("Match not found");
         const mercury = +matches[1] / 100;
-        metar.altimeter = converter.convertInchesMercuryToPascal(mercury);
+        metar.altimeter = Math.trunc(converter.convertInchesMercuryToPascal(mercury));
     }
 }
 exports.AltimeterMercuryCommand = AltimeterMercuryCommand;
@@ -131,4 +131,5 @@ class CommandSupplier {
         }
     }
 }
+exports.CommandSupplier = CommandSupplier;
 _CommandSupplier_commands = new WeakMap();

package/dist/{lib/command → command}/remark.d.ts

@@ -1,4 +1,7 @@
+import { Locale } from "../commons/i18n";
 export declare abstract class Command {
+    protected locale: Locale;
+    constructor(locale: Locale);
     abstract canParse(code: string): boolean;
     abstract execute(code: string, remark: string[]): [string, string[]];
 }
@@ -192,8 +195,9 @@ export declare class DefaultCommand extends Command {
     execute(code: string, remark: string[]): [string, string[]];
 }
 export declare class RemarkCommandSupplier {
+    private locale;
     defaultCommand: Command;
     commandList: Command[];
-    constructor();
+    constructor(locale: Locale);
     get(code: string): Command;
 }