metar-taf-parser 7.1.3 → 8.0.0

package/README.md

@@ -32,6 +32,8 @@ The `parseMetar` & `parseTAF` functions are designed to parse the raw report str
 
 #### `parseMetar`
 
+If the payload begins with [`METAR` or `SPECI`](http://www.bom.gov.au/aviation/data/education/metar-speci.pdf), that will be added as the `type`.
+
 ```ts
 import { parseMetar } from "metar-taf-parser";
 

package/metar-taf-parser.d.ts

@@ -1,3 +1,7 @@
+declare enum MetarType {
+    METAR = "METAR",
+    SPECI = "SPECI"
+}
 declare enum CloudQuantity {
     /**
      * Sky clear
@@ -326,6 +330,41 @@ declare enum TurbulenceIntensity {
     /** Extreme turbulence */
     Extreme = "X"
 }
+declare enum DepositType {
+    /** (runway clearance in progress) */
+    NotReported = "/",
+    ClearDry = "0",
+    Damp = "1",
+    WetWaterPatches = "2",
+    RimeFrostCovered = "3",
+    DrySnow = "4",
+    WetSnow = "5",
+    Slush = "6",
+    Ice = "7",
+    CompactedSnow = "8",
+    FrozenRidges = "9"
+}
+declare enum DepositCoverage {
+    NotReported = "/",
+    Less10 = "1",
+    From11To25 = "2",
+    From26To50 = "5",
+    From51To100 = "9"
+}
+declare enum AltimeterUnit {
+    /**
+     * Inches of mercury (inHg)
+     *
+     * e.g. A2994 parses as 29.94 inHg
+     */
+    InHg = "inHg",
+    /**
+     * Hectopascals (hPa), also known as millibars
+     *
+     * e.g. Q1018 parses as 1018 millibars
+     */
+    HPa = "hPa"
+}
 
 declare const _default: {
     CloudQuantity: {
@@ -1131,6 +1170,10 @@ interface IWeatherCondition {
     phenomenons: Phenomenon[];
 }
 declare function isWeatherConditionValid(weather: IWeatherCondition): boolean;
+interface IAltimeter {
+    value: number;
+    unit: AltimeterUnit;
+}
 interface ITemperature {
     temperature: number;
     day: number;
@@ -1139,7 +1182,11 @@ interface ITemperature {
 interface ITemperatureDated extends ITemperature {
     date: Date;
 }
-interface IRunwayInfo {
+declare type RunwayInfo = IRunwayInfoRange | IRunwayInfoDeposit;
+interface IBaseRunwayInfo {
+    name: string;
+}
+interface IRunwayInfoRange extends IBaseRunwayInfo {
     name: string;
     minRange: number;
     maxRange?: number;
@@ -1153,6 +1200,50 @@ interface IRunwayInfo {
     trend?: RunwayInfoTrend;
     unit: RunwayInfoUnit;
 }
+interface IRunwayInfoDeposit extends IBaseRunwayInfo {
+    depositType?: DepositType;
+    coverage?: DepositCoverage;
+    /**
+     * Depth of deposit
+     *
+     * Note: the quoted depth is the mean of a number of reading or if operationally significant the greatest depth measured.
+     *
+     * | Value | Description |
+     * | ----- | ----------- |
+     * | `"00"` | Less than 1mm |
+     * | `"01"` to `"90"` | Measurement in mm |
+     * | `"92"` | 10cm |
+     * | `"93"` | 15cm |
+     * | `"94"` | 20cm |
+     * | `"95"` | 25cm |
+     * | `"96"` | 30cm |
+     * | `"97"` | 35cm |
+     * | `"98"` | 40cm or more |
+     * | `"99"` | Runway not operational due to snow, slush, ice, large drifts or runway clearance, depth not reported |
+     * | `"//"` | Not operationally significant or not measurable |
+     */
+    thickness?: string;
+    /**
+     * Friction Coefficient or Braking Action
+     *
+     * Note: Where braking action is assessed at a number of points along the runway the mean value will be transmitted or if operationally significant the lowest value.
+     *
+     * If measuring equipment does not allow measurement of friction with satisfactory reliability (such as contaminated by wet snow, slush or loose snow) the figure 99 will be used.
+     *
+     * | Value | Description |
+     * | ----- | ----------- |
+     * | `"28"` | Friction coefficient 0.28
+     * | `"35"` | Friction coefficient 0.35
+     * | `"91"` | Braking action poor
+     * | `"92"` | Braking action medium to poor
+     * | `"93"` | Braking action medium
+     * | `"94"` | Braking action medium to good
+     * | `"95"` | Braking action good
+     * | `"99"` | Figures unreliable
+     * | `"//"` | Braking action not reported or runway not operations or airport closed.
+     */
+    brakingCapacity?: string;
+}
 interface ICloud {
     height?: number;
     quantity: CloudQuantity;
@@ -1222,11 +1313,12 @@ interface IAbstractWeatherCodeDated extends IAbstractWeatherCode {
     issued: Date;
 }
 interface IMetar extends IAbstractWeatherCode {
+    type?: MetarType;
     temperature?: number;
     dewPoint?: number;
-    altimeter?: number;
+    altimeter?: IAltimeter;
     nosig?: true;
-    runwaysInfo: IRunwayInfo[];
+    runwaysInfo: RunwayInfo[];
     /**
      * Not used in North America
      */
@@ -1462,4 +1554,4 @@ declare function parseTAF(rawTAF: string, options?: IMetarTAFParserOptions): ITA
 declare function parseTAF(rawTAF: string, options?: IMetarTAFParserOptionsDated): ITAFDated;
 declare function parseTAFAsForecast(rawTAF: string, options: IMetarTAFParserOptionsDated): IForecastContainer;
 
-export { CloudQuantity, CloudType, CommandExecutionError, Descriptive, Direction, Distance, DistanceUnit, Forecast, IAbstractTrend, IAbstractValidity, IAbstractWeatherCode, IAbstractWeatherCodeDated, IAbstractWeatherContainer, IBaseRemark, IBaseTAFTrend, ICeilingHeightRemark, ICeilingSecondLocationRemark, ICloud, ICompositeForecast, IEndValidity, IFMValidity, IFlags, IForecastContainer, IHourlyMaximumMinimumTemperatureRemark, IHourlyMaximumTemperatureRemark, IHourlyMinimumTemperatureRemark, IHourlyPrecipitationAmountRemark, IHourlyPressureRemark, IHourlyTemperatureDewPointRemark, IIceAccretionRemark, IIcing, IMetar, IMetarDated, IMetarTAFParserOptions, IMetarTAFParserOptionsDated, IMetarTrend, IMetarTrendTime, IObscurationRemark, IPrecipitationAmount24HourRemark, IPrecipitationAmount36HourRemark, IPrecipitationBegEndRemark, IPrevailingVisibilityRemark, IRunwayInfo, ISeaLevelPressureRemark, ISecondLocationVisibilityRemark, ISectorVisibilityRemark, ISmallHailSizeRemark, ISnowIncreaseRemark, ISnowPelletsRemark, ISunshineDurationRemark, ISurfaceVisibilityRemark, ITAF, ITAFDated, ITafGroups, ITemperature, ITemperatureDated, IThunderStormLocationMovingRemark, IThunderStormLocationRemark, ITime, ITornadicActivityBegEndRemark, ITornadicActivityBegRemark, ITornadicActivityEndRemark, ITowerVisibilityRemark, ITurbulence, IUnknownRemark, IValidity, IValidityDated, IVariableSkyHeightRemark, IVariableSkyRemark, IVirgaDirectionRemark, IWaterEquivalentSnowRemark, IWeatherCondition, IWind, IWindPeakCommandRemark, IWindShear, IWindShiftFropaRemark, IcingIntensity, Intensity, InvalidWeatherStatementError, Locale, ParseError, Phenomenon, Remark, RemarkType, RunwayInfoTrend, RunwayInfoUnit, SpeedUnit, TAFTrend, TAFTrendDated, TimeIndicator, TimestampOutOfBoundsError, TurbulenceIntensity, UnexpectedParseError, ValueIndicator, Visibility, WeatherChangeType, getCompositeForecastForDate, isWeatherConditionValid, parseMetar, parseTAF, parseTAFAsForecast };
+export { AltimeterUnit, CloudQuantity, CloudType, CommandExecutionError, DepositCoverage, DepositType, Descriptive, Direction, Distance, DistanceUnit, Forecast, IAbstractTrend, IAbstractValidity, IAbstractWeatherCode, IAbstractWeatherCodeDated, IAbstractWeatherContainer, IAltimeter, IBaseRemark, IBaseRunwayInfo, IBaseTAFTrend, ICeilingHeightRemark, ICeilingSecondLocationRemark, ICloud, ICompositeForecast, IEndValidity, IFMValidity, IFlags, IForecastContainer, IHourlyMaximumMinimumTemperatureRemark, IHourlyMaximumTemperatureRemark, IHourlyMinimumTemperatureRemark, IHourlyPrecipitationAmountRemark, IHourlyPressureRemark, IHourlyTemperatureDewPointRemark, IIceAccretionRemark, IIcing, IMetar, IMetarDated, IMetarTAFParserOptions, IMetarTAFParserOptionsDated, IMetarTrend, IMetarTrendTime, IObscurationRemark, IPrecipitationAmount24HourRemark, IPrecipitationAmount36HourRemark, IPrecipitationBegEndRemark, IPrevailingVisibilityRemark, IRunwayInfoDeposit, IRunwayInfoRange, ISeaLevelPressureRemark, ISecondLocationVisibilityRemark, ISectorVisibilityRemark, ISmallHailSizeRemark, ISnowIncreaseRemark, ISnowPelletsRemark, ISunshineDurationRemark, ISurfaceVisibilityRemark, ITAF, ITAFDated, ITafGroups, ITemperature, ITemperatureDated, IThunderStormLocationMovingRemark, IThunderStormLocationRemark, ITime, ITornadicActivityBegEndRemark, ITornadicActivityBegRemark, ITornadicActivityEndRemark, ITowerVisibilityRemark, ITurbulence, IUnknownRemark, IValidity, IValidityDated, IVariableSkyHeightRemark, IVariableSkyRemark, IVirgaDirectionRemark, IWaterEquivalentSnowRemark, IWeatherCondition, IWind, IWindPeakCommandRemark, IWindShear, IWindShiftFropaRemark, IcingIntensity, Intensity, InvalidWeatherStatementError, Locale, MetarType, ParseError, Phenomenon, Remark, RemarkType, RunwayInfo, RunwayInfoTrend, RunwayInfoUnit, SpeedUnit, TAFTrend, TAFTrendDated, TimeIndicator, TimestampOutOfBoundsError, TurbulenceIntensity, UnexpectedParseError, ValueIndicator, Visibility, WeatherChangeType, getCompositeForecastForDate, isWeatherConditionValid, parseMetar, parseTAF, parseTAFAsForecast };

package/metar-taf-parser.js

@@ -183,6 +183,11 @@ class CeilingSecondLocationCommand extends Command {
 }
 _CeilingSecondLocationCommand_regex = new WeakMap();
 
+var MetarType;
+(function (MetarType) {
+    MetarType["METAR"] = "METAR";
+    MetarType["SPECI"] = "SPECI";
+})(MetarType || (MetarType = {}));
 var CloudQuantity;
 (function (CloudQuantity) {
     /**
@@ -526,6 +531,44 @@ var TurbulenceIntensity;
     /** Extreme turbulence */
     TurbulenceIntensity["Extreme"] = "X";
 })(TurbulenceIntensity || (TurbulenceIntensity = {}));
+var DepositType;
+(function (DepositType) {
+    /** (runway clearance in progress) */
+    DepositType["NotReported"] = "/";
+    DepositType["ClearDry"] = "0";
+    DepositType["Damp"] = "1";
+    DepositType["WetWaterPatches"] = "2";
+    DepositType["RimeFrostCovered"] = "3";
+    DepositType["DrySnow"] = "4";
+    DepositType["WetSnow"] = "5";
+    DepositType["Slush"] = "6";
+    DepositType["Ice"] = "7";
+    DepositType["CompactedSnow"] = "8";
+    DepositType["FrozenRidges"] = "9";
+})(DepositType || (DepositType = {}));
+var DepositCoverage;
+(function (DepositCoverage) {
+    DepositCoverage["NotReported"] = "/";
+    DepositCoverage["Less10"] = "1";
+    DepositCoverage["From11To25"] = "2";
+    DepositCoverage["From26To50"] = "5";
+    DepositCoverage["From51To100"] = "9";
+})(DepositCoverage || (DepositCoverage = {}));
+var AltimeterUnit;
+(function (AltimeterUnit) {
+    /**
+     * Inches of mercury (inHg)
+     *
+     * e.g. A2994 parses as 29.94 inHg
+     */
+    AltimeterUnit["InHg"] = "inHg";
+    /**
+     * Hectopascals (hPa), also known as millibars
+     *
+     * e.g. Q1018 parses as 1018 millibars
+     */
+    AltimeterUnit["HPa"] = "hPa";
+})(AltimeterUnit || (AltimeterUnit = {}));
 
 function degreesToCardinal(input) {
     const degrees = +input;
@@ -607,9 +650,6 @@ function convertTemperature(input) {
         return -pySplit(input, "M")[1];
     return +input;
 }
-function convertInchesMercuryToPascal(input) {
-    return 33.8639 * input;
-}
 /**
  * Converts number `.toFixed(1)` before outputting to match python implementation
  */
@@ -2010,7 +2050,10 @@ class AltimeterCommand {
         const matches = input.match(__classPrivateFieldGet(this, _AltimeterCommand_regex, "f"));
         if (!matches)
             throw new UnexpectedParseError("Match not found");
-        metar.altimeter = Math.trunc(+matches[1]);
+        metar.altimeter = {
+            value: +matches[1],
+            unit: AltimeterUnit.HPa,
+        };
     }
 }
 _AltimeterCommand_regex = new WeakMap();
@@ -2028,24 +2071,41 @@ class AltimeterMercuryCommand {
         if (!matches)
             throw new UnexpectedParseError("Match not found");
         const mercury = +matches[1] / 100;
-        metar.altimeter = Math.trunc(convertInchesMercuryToPascal(mercury));
+        metar.altimeter = {
+            value: mercury,
+            unit: AltimeterUnit.InHg,
+        };
     }
 }
 _AltimeterMercuryCommand_regex = new WeakMap();
 
-var _RunwayCommand_genericRegex, _RunwayCommand_runwayMaxRangeRegex, _RunwayCommand_runwayRegex;
+var _RunwayCommand_genericRegex, _RunwayCommand_runwayMaxRangeRegex, _RunwayCommand_runwayRegex, _RunwayCommand_runwayDepositRegex;
 class RunwayCommand {
     constructor() {
         _RunwayCommand_genericRegex.set(this, /^(R\d{2}\w?\/)/);
         _RunwayCommand_runwayMaxRangeRegex.set(this, /^R(\d{2}\w?)\/(\d{4})V(\d{3,4})([UDN])?(FT)?/);
         _RunwayCommand_runwayRegex.set(this, /^R(\d{2}\w?)\/([MP])?(\d{4})([UDN])?(FT)?$/);
+        _RunwayCommand_runwayDepositRegex.set(this, /^R(\d{2}\w?)\/([/\d])([/\d])(\/\/|\d{2})(\/\/|\d{2})$/);
     }
     canParse(input) {
         return __classPrivateFieldGet(this, _RunwayCommand_genericRegex, "f").test(input);
     }
     execute(metar, input) {
-        // TODO idk if this matches super well...
-        if (__classPrivateFieldGet(this, _RunwayCommand_runwayRegex, "f").test(input)) {
+        if (__classPrivateFieldGet(this, _RunwayCommand_runwayDepositRegex, "f").test(input)) {
+            const matches = input.match(__classPrivateFieldGet(this, _RunwayCommand_runwayDepositRegex, "f"));
+            if (!matches)
+                throw new UnexpectedParseError("Should be able to parse");
+            const depositType = as(matches[2], DepositType);
+            const coverage = as(matches[3], DepositCoverage);
+            metar.runwaysInfo.push({
+                name: matches[1],
+                depositType,
+                coverage,
+                thickness: matches[4],
+                brakingCapacity: matches[5],
+            });
+        }
+        else if (__classPrivateFieldGet(this, _RunwayCommand_runwayRegex, "f").test(input)) {
             const matches = input.match(__classPrivateFieldGet(this, _RunwayCommand_runwayRegex, "f"));
             if (!matches)
                 throw new UnexpectedParseError("Should be able to parse");
@@ -2080,7 +2140,7 @@ class RunwayCommand {
         }
     }
 }
-_RunwayCommand_genericRegex = new WeakMap(), _RunwayCommand_runwayMaxRangeRegex = new WeakMap(), _RunwayCommand_runwayRegex = new WeakMap();
+_RunwayCommand_genericRegex = new WeakMap(), _RunwayCommand_runwayMaxRangeRegex = new WeakMap(), _RunwayCommand_runwayRegex = new WeakMap(), _RunwayCommand_runwayDepositRegex = new WeakMap();
 
 var _TemperatureCommand_regex;
 class TemperatureCommand {
@@ -2438,6 +2498,9 @@ class MetarParser extends AbstractParser {
     parse(input) {
         const metarTab = this.tokenize(input);
         let index = 0;
+        const type = this.parseType(metarTab[index]);
+        if (type)
+            index++;
         // Only parse flag if precedes station identifier
         if (isStation(metarTab[index + 1])) {
             var flags = findFlags(metarTab[index]);
@@ -2445,8 +2508,9 @@ class MetarParser extends AbstractParser {
                 index += 1;
         }
         const metar = {
-            ...parseDeliveryTime(metarTab[index + 1]),
+            type,
             station: metarTab[index],
+            ...parseDeliveryTime(metarTab[index + 1]),
             ...flags,
             message: input,
             remarks: [],
@@ -2492,6 +2556,12 @@ class MetarParser extends AbstractParser {
         }
         return metar;
     }
+    parseType(token) {
+        for (const type in MetarType) {
+            if (token === MetarType[type])
+                return type;
+        }
+    }
 }
 _MetarParser_commandSupplier = new WeakMap();
 /**
@@ -3023,4 +3093,4 @@ function parse(rawReport, options, parser, datesHydrator) {
     }
 }
 
-export { CloudQuantity, CloudType, CommandExecutionError, Descriptive, Direction, DistanceUnit, IcingIntensity, Intensity, InvalidWeatherStatementError, ParseError, Phenomenon, RemarkType, RunwayInfoTrend, RunwayInfoUnit, SpeedUnit, TimeIndicator, TimestampOutOfBoundsError, TurbulenceIntensity, UnexpectedParseError, ValueIndicator, WeatherChangeType, getCompositeForecastForDate, isWeatherConditionValid, parseMetar, parseTAF, parseTAFAsForecast };
+export { AltimeterUnit, CloudQuantity, CloudType, CommandExecutionError, DepositCoverage, DepositType, Descriptive, Direction, DistanceUnit, IcingIntensity, Intensity, InvalidWeatherStatementError, MetarType, ParseError, Phenomenon, RemarkType, RunwayInfoTrend, RunwayInfoUnit, SpeedUnit, TimeIndicator, TimestampOutOfBoundsError, TurbulenceIntensity, UnexpectedParseError, ValueIndicator, WeatherChangeType, getCompositeForecastForDate, isWeatherConditionValid, parseMetar, parseTAF, parseTAFAsForecast };

package/package.json

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