metar-taf-parser 4.0.1 → 5.0.0

package/README.md

@@ -39,9 +39,8 @@ const metar = parseMetar(rawMetarString);
 
 // -or-
 
-// Optionally pass a date (approximately when the report was issued, +/- a week)
-// to get the issued date on the report:
-const datedMetar = parseMetar(rawMetarString, { date: new Date() });
+// Optionally pass the date issued to add it to the report
+const datedMetar = parseMetar(rawMetarString, { issued });
 ```
 
 #### `parseTAF`
@@ -55,9 +54,9 @@ const taf = parseTAF(rawTAFString);
 
 // -or-
 
-// Optionally pass a date (approximately when the report was issued, +/- a week)
-// to get the report issued and trend validity dates (start/end) on the report:
-const datedTAF = parseTAF(rawTAFString, { date: new Date() });
+// Optionally pass the date issued to get the report issued and
+// trend validity dates (start/end) on the report:
+const datedTAF = parseTAF(rawTAFString, { issued });
 ```
 
 ### Higher level parsing: The Forecast abstraction
@@ -72,7 +71,7 @@ Returns a more normalized TAF report. Most notably: while the `parseTAF` functio
 import { parseTAFAsForecast } from "metar-taf-parser";
 
 // You must provide an issued date to use the Forecast abstraction
-const report = parseTAFAsForecast(rawTAFString, { date: tafIssuedDate });
+const report = parseTAFAsForecast(rawTAFString, { issued: tafIssuedDate });
 
 console.log(report.forecast);
 ```
@@ -98,7 +97,7 @@ import {
   getCompositeForecastForDate,
 } from "metar-taf-parser";
 
-const report = parseTAFAsForecast(rawTAFString, { date: tafIssuedDate });
+const report = parseTAFAsForecast(rawTAFString, { issued: tafIssuedDate });
 
 const forecastPerHour = eachHourOfInterval({
   start: report.start,

package/locale/en.js

@@ -207,7 +207,7 @@ var en = {
                 Hourly: "{0}/100 of an inch of precipitation fell in the last hour",
             },
             Beg: {
-                "0": "{0} {1} beginning at {2}:{3} ",
+                "0": "{0} {1} beginning at {2}:{3}",
                 End: "{0} {1} beginning at {2}:{3} ending at {4}:{5}",
             },
             End: "{0} {1} ending at {2}:{3}",

package/metar-taf-parser.d.ts

@@ -1101,7 +1101,29 @@ interface ICloud {
     quantity: CloudQuantity;
     type?: CloudType;
 }
-interface IAbstractWeatherContainer {
+interface IFlags {
+    /**
+     * Amended TAF
+     */
+    amendment?: true;
+    /**
+     * Amended METAR
+     */
+    auto?: true;
+    /**
+     * Canceled TAF
+     */
+    canceled?: true;
+    /**
+     * Corrected METAR/TAF
+     */
+    corrected?: true;
+    /**
+     * No data
+     */
+    nil?: true;
+}
+interface IAbstractWeatherContainer extends IFlags {
     wind?: IWind;
     visibility?: Visibility;
     verticalVisibility?: number;
@@ -1120,11 +1142,11 @@ interface IAbstractValidity {
  * Exclusive for the TS port (because python has `time()` and js does not)
  */
 interface ITime {
-    hour: number;
-    minute: number;
+    hour?: number;
+    minute?: number;
 }
 interface IAbstractWeatherCode extends IAbstractWeatherContainer, ITime {
-    day: number;
+    day?: number;
     airport?: IAirport;
     message: string;
     station: string;
@@ -1138,7 +1160,6 @@ interface IMetar extends IAbstractWeatherCode {
     dewPoint?: number;
     altimeter?: number;
     nosig?: true;
-    auto?: true;
     runwaysInfo: IRunwayInfo[];
     /**
      * Not used in North America
@@ -1149,7 +1170,6 @@ interface ITAF extends IAbstractWeatherCode {
     validity: IValidity;
     maxTemperature?: ITemperatureDated;
     minTemperature?: ITemperatureDated;
-    amendment?: true;
     trends: TAFTrend[];
 }
 interface IAbstractTrend extends IAbstractWeatherContainer {
@@ -1306,15 +1326,12 @@ interface IMetarTAFParserOptions {
 }
 interface IMetarTAFParserOptionsDated extends IMetarTAFParserOptions {
     /**
-     * This date should ideally be the date the report was issued. Otherwise, it
-     * can be be +/- one week of the actual report date and work properly.
-     *
-     * So if you know the report was recently issued, you can pass `new Date()`
+     * This date should be the date the report was issued.
      *
      * This date is needed to create actual timestamps since the report only has
-     * day of month, hour, and minute.
+     * day of month, hour, and minute (and sometimes not even that).
      */
-    date: Date;
+    issued: Date;
 }
 declare function parseMetar(rawMetar: string, options?: IMetarTAFParserOptions): IMetar;
 declare function parseMetar(rawMetar: string, options?: IMetarTAFParserOptionsDated): IMetarDated;
@@ -1322,4 +1339,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, IAirport, IBaseRemark, IBaseTAFTrend, ICeilingHeightRemark, ICeilingSecondLocationRemark, ICloud, ICompositeForecast, ICountry, IEndValidity, IFMValidity, IForecastContainer, IHourlyMaximumMinimumTemperatureRemark, IHourlyMaximumTemperatureRemark, IHourlyMinimumTemperatureRemark, IHourlyPrecipitationAmountRemark, IHourlyPressureRemark, IHourlyTemperatureDewPointRemark, IIceAccretionRemark, IMetar, IMetarTAFParserOptions, IMetarTAFParserOptionsDated, IMetarTrend, IMetarTrendTime, IObscurationRemark, IPrecipitationAmount24HourRemark, IPrecipitationAmount36HourRemark, IPrecipitationBegEndRemark, IPrevailingVisibilityRemark, IRunwayInfo, ISeaLevelPressureRemark, ISecondLocationVisibilityRemark, ISectorVisibilityRemark, ISmallHailSizeRemark, ISnowIncreaseRemark, ISnowPelletsRemark, ISunshineDurationRemark, ISurfaceVisibilityRemark, ITAF, ITAFDated, ITemperatureDated, IThunderStormLocationMovingRemark, IThunderStormLocationRemark, ITime, ITornadicActivityBegEndRemark, ITornadicActivityBegRemark, ITornadicActivityEndRemark, ITowerVisibilityRemark, IUnknownRemark, IValidity, IValidityDated, IVariableSkyHeightRemark, IVariableSkyRemark, IVirgaDirectionRemark, IWaterEquivalentSnowRemark, IWeatherCondition, IWind, IWindPeakCommandRemark, IWindShear, IWindShiftFropaRemark, Intensity, InvalidWeatherStatementError, Locale, ParseError, Phenomenon, Remark, RemarkType, RunwayInfoTrend, RunwayInfoUnit, TAFTrend, TAFTrendDated, TimeIndicator, TimestampOutOfBoundsError, UnexpectedParseError, ValueIndicator, Visibility, WeatherChangeType, getCompositeForecastForDate, isWeatherConditionValid, parseMetar, parseTAF, parseTAFAsForecast };
+export { CloudQuantity, CloudType, CommandExecutionError, Descriptive, Direction, Distance, DistanceUnit, Forecast, IAbstractTrend, IAbstractValidity, IAbstractWeatherCode, IAbstractWeatherCodeDated, IAbstractWeatherContainer, IAirport, IBaseRemark, IBaseTAFTrend, ICeilingHeightRemark, ICeilingSecondLocationRemark, ICloud, ICompositeForecast, ICountry, IEndValidity, IFMValidity, IFlags, IForecastContainer, IHourlyMaximumMinimumTemperatureRemark, IHourlyMaximumTemperatureRemark, IHourlyMinimumTemperatureRemark, IHourlyPrecipitationAmountRemark, IHourlyPressureRemark, IHourlyTemperatureDewPointRemark, IIceAccretionRemark, IMetar, IMetarTAFParserOptions, IMetarTAFParserOptionsDated, IMetarTrend, IMetarTrendTime, IObscurationRemark, IPrecipitationAmount24HourRemark, IPrecipitationAmount36HourRemark, IPrecipitationBegEndRemark, IPrevailingVisibilityRemark, IRunwayInfo, ISeaLevelPressureRemark, ISecondLocationVisibilityRemark, ISectorVisibilityRemark, ISmallHailSizeRemark, ISnowIncreaseRemark, ISnowPelletsRemark, ISunshineDurationRemark, ISurfaceVisibilityRemark, ITAF, ITAFDated, ITemperatureDated, IThunderStormLocationMovingRemark, IThunderStormLocationRemark, ITime, ITornadicActivityBegEndRemark, ITornadicActivityBegRemark, ITornadicActivityEndRemark, ITowerVisibilityRemark, IUnknownRemark, IValidity, IValidityDated, IVariableSkyHeightRemark, IVariableSkyRemark, IVirgaDirectionRemark, IWaterEquivalentSnowRemark, IWeatherCondition, IWind, IWindPeakCommandRemark, IWindShear, IWindShiftFropaRemark, Intensity, InvalidWeatherStatementError, Locale, ParseError, Phenomenon, Remark, RemarkType, RunwayInfoTrend, RunwayInfoUnit, TAFTrend, TAFTrendDated, TimeIndicator, TimestampOutOfBoundsError, UnexpectedParseError, ValueIndicator, Visibility, WeatherChangeType, getCompositeForecastForDate, isWeatherConditionValid, parseMetar, parseTAF, parseTAFAsForecast };

package/metar-taf-parser.js

@@ -2064,13 +2064,31 @@ function parseDeliveryTime(timeString) {
     const hour = +timeString.slice(2, 4);
     const minute = +timeString.slice(4, 6);
     if (isNaN(day) || isNaN(hour) || isNaN(minute))
-        throw new InvalidWeatherStatementError("Report time is invalid");
+        return;
     return {
         day,
         hour,
         minute,
     };
 }
+function parseFlags(abstractWeatherCode, flag) {
+    const flags = findFlags(flag);
+    if (flags)
+        Object.assign(abstractWeatherCode, flags);
+    return !!flags;
+}
+var FlagMap;
+(function (FlagMap) {
+    FlagMap["AMD"] = "amendment";
+    FlagMap["AUTO"] = "auto";
+    FlagMap["CNL"] = "canceled";
+    FlagMap["COR"] = "corrected";
+    FlagMap["NIL"] = "nil";
+})(FlagMap || (FlagMap = {}));
+function findFlags(flag) {
+    if (flag in FlagMap)
+        return { [FlagMap[flag]]: true };
+}
 /**
  * This function parses the array containing the remark and concat the array into a string
  * @param container the metar, taf or taf trend to update
@@ -2102,7 +2120,7 @@ function parseTemperature(input) {
  * @param input the string containing the validity
  * @returns Validity object
  */
-function parseValidity(input, date) {
+function parseValidity(input) {
     const parts = pySplit(input, "/");
     return {
         startDay: +parts[0].slice(0, 2),
@@ -2184,7 +2202,6 @@ class AbstractParser {
             if (digitRegex.test(splitted[i])) {
                 if (splitted[i + 1] && smRegex.test(splitted[i + 1])) {
                     splitted.splice(i, 2, `${splitted[i]} ${splitted[i + 1]}`);
-                    i--;
                 }
             }
         }
@@ -2274,13 +2291,11 @@ class MetarParser extends AbstractParser {
         };
         let index = 2;
         while (index < metarTab.length) {
-            if (!super.generalParse(metar, metarTab[index])) {
+            if (!super.generalParse(metar, metarTab[index]) &&
+                !parseFlags(metar, metarTab[index])) {
                 if (metarTab[index] === "NOSIG") {
                     metar.nosig = true;
                 }
-                else if (metarTab[index] === "AUTO") {
-                    metar.auto = true;
-                }
                 else if (metarTab[index] === this.TEMPO ||
                     metarTab[index] === this.BECMG) {
                     const trend = {
@@ -2328,25 +2343,25 @@ class TAFParser extends AbstractParser {
      * @throws ParseError if the message is invalid
      */
     parse(input) {
-        let amendment;
         const lines = this.extractLinesTokens(input);
         let index = 0;
         if (lines[0][0] === this.TAF)
             index = 1;
         if (lines[0][1] === this.TAF)
             index = 2;
-        if (lines[0][index] === "AMD") {
-            amendment = true;
+        const flags = findFlags(lines[0][index]);
+        if (flags) {
             index += 1;
         }
         const station = lines[0][index];
         index += 1;
         const time = parseDeliveryTime(lines[0][index]);
-        index += 1;
+        if (time)
+            index += 1;
         const validity = parseValidity(lines[0][index]);
         const taf = {
             station,
-            amendment,
+            ...flags,
             ...time,
             validity,
             message: input,
@@ -2365,8 +2380,10 @@ class TAFParser extends AbstractParser {
                 taf.maxTemperature = parseTemperature(token);
             else if (token.startsWith(this.TN))
                 taf.minTemperature = parseTemperature(token);
-            else
+            else {
+                parseFlags(taf, token);
                 this.generalParse(taf, token);
+            }
         }
         // Handle the other lines
         for (let i = 1; i < lines.length; i++) {
@@ -2390,7 +2407,6 @@ class TAFParser extends AbstractParser {
             for (let i = 0; i < ls.length; i++) {
                 if (/^PROB\d{2}$/.test(ls[i]) && /^TEMPO/.test(ls[i + 1])) {
                     ls.splice(i, 2, `${ls[i]} ${ls[i + 1]}`);
-                    i--;
                 }
             }
             return ls;
@@ -2531,6 +2547,9 @@ _RemarkParser_supplier = new WeakMap();
  * @returns
  */
 function determineReportIssuedDate(date, day, hour, minute) {
+    // Some TAF reports do not include a delivery time
+    if (day == null || hour == null)
+        return date;
     const months = [
         setDateComponents(addMonthsUTC(date, -1), day, hour, minute),
         setDateComponents(new Date(date), day, hour, minute),
@@ -2690,8 +2709,8 @@ function parse(rawReport, options, parser, datesHydrator) {
     const lang = options?.locale || en;
     try {
         const report = new parser(lang).parse(rawReport);
-        if (options && "date" in options) {
-            return datesHydrator(report, options.date);
+        if (options && "issued" in options) {
+            return datesHydrator(report, options.issued);
         }
         return report;
     }

package/package.json

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