metar-taf-parser 8.0.1 → 8.0.2

package/metar-taf-parser.d.ts

@@ -754,10 +754,10 @@ declare const _default: {
     };
 };
 
-declare type DeepPartial<T> = T extends object ? {
+type DeepPartial<T> = T extends object ? {
     [P in keyof T]?: DeepPartial<T[P]>;
 } : T;
-declare type Locale = DeepPartial<typeof _default>;
+type Locale = DeepPartial<typeof _default>;
 
 interface ICeilingHeightRemark extends IBaseRemark {
     type: RemarkType.CeilingHeight;
@@ -1051,7 +1051,7 @@ interface IWindShiftFropaRemark extends IBaseRemark {
     startMinute: number;
 }
 
-declare type DefaultRemarkTypes = RemarkType.AO1 | RemarkType.AO2 | RemarkType.PRESFR | RemarkType.PRESRR | RemarkType.TORNADO | RemarkType.FUNNELCLOUD | RemarkType.WATERSPOUT | RemarkType.VIRGA;
+type DefaultRemarkTypes = RemarkType.AO1 | RemarkType.AO2 | RemarkType.PRESFR | RemarkType.PRESRR | RemarkType.TORNADO | RemarkType.FUNNELCLOUD | RemarkType.WATERSPOUT | RemarkType.VIRGA;
 interface IDefaultCommandRemark extends IBaseRemark {
     type: DefaultRemarkTypes;
 }
@@ -1130,7 +1130,7 @@ declare enum RemarkType {
     SunshineDuration = "SunshineDuration",
     WaterEquivalentSnow = "WaterEquivalentSnow"
 }
-declare type Remark = IUnknownRemark | IDefaultCommandRemark | ICeilingHeightRemark | ICeilingSecondLocationRemark | IHailSizeRemark | IHourlyMaximumMinimumTemperatureRemark | IHourlyMaximumTemperatureRemark | IHourlyMinimumTemperatureRemark | IHourlyPrecipitationAmountRemark | IHourlyPressureRemark | IHourlyTemperatureDewPointRemark | IIceAccretionRemark | IObscurationRemark | IPrecipitationAmount24HourRemark | IPrecipitationAmount36HourRemark | IPrecipitationAmount36HourRemark | IPrecipitationBegRemark | IPrecipitationBegEndRemark | IPrecipitationEndRemark | IPrevailingVisibilityRemark | ISeaLevelPressureRemark | ISecondLocationVisibilityRemark | ISectorVisibilityRemark | ISmallHailSizeRemark | ISnowDepthRemark | ISnowIncreaseRemark | ISnowPelletsRemark | ISunshineDurationRemark | ISurfaceVisibilityRemark | IThunderStormLocationRemark | IThunderStormLocationMovingRemark | ITornadicActivityBegRemark | ITornadicActivityBegEndRemark | ITornadicActivityEndRemark | ITowerVisibilityRemark | IVariableSkyRemark | IVariableSkyHeightRemark | IVirgaDirectionRemark | IWaterEquivalentSnowRemark | IWindPeakCommandRemark | IWindShiftRemark | IWindShiftFropaRemark;
+type Remark = IUnknownRemark | IDefaultCommandRemark | ICeilingHeightRemark | ICeilingSecondLocationRemark | IHailSizeRemark | IHourlyMaximumMinimumTemperatureRemark | IHourlyMaximumTemperatureRemark | IHourlyMinimumTemperatureRemark | IHourlyPrecipitationAmountRemark | IHourlyPressureRemark | IHourlyTemperatureDewPointRemark | IIceAccretionRemark | IObscurationRemark | IPrecipitationAmount24HourRemark | IPrecipitationAmount36HourRemark | IPrecipitationAmount36HourRemark | IPrecipitationBegRemark | IPrecipitationBegEndRemark | IPrecipitationEndRemark | IPrevailingVisibilityRemark | ISeaLevelPressureRemark | ISecondLocationVisibilityRemark | ISectorVisibilityRemark | ISmallHailSizeRemark | ISnowDepthRemark | ISnowIncreaseRemark | ISnowPelletsRemark | ISunshineDurationRemark | ISurfaceVisibilityRemark | IThunderStormLocationRemark | IThunderStormLocationMovingRemark | ITornadicActivityBegRemark | ITornadicActivityBegEndRemark | ITornadicActivityEndRemark | ITowerVisibilityRemark | IVariableSkyRemark | IVariableSkyHeightRemark | IVirgaDirectionRemark | IWaterEquivalentSnowRemark | IWindPeakCommandRemark | IWindShiftRemark | IWindShiftFropaRemark;
 
 interface IWind {
     speed: number;
@@ -1154,7 +1154,7 @@ interface Distance {
     /** No Directional Visibility */
     ndv?: true;
 }
-declare type Visibility = Distance & {
+type Visibility = Distance & {
     /**
      * Never in North American METARs
      */
@@ -1182,7 +1182,7 @@ interface ITemperature {
 interface ITemperatureDated extends ITemperature {
     date: Date;
 }
-declare type RunwayInfo = IRunwayInfoRange | IRunwayInfoDeposit;
+type RunwayInfo = IRunwayInfoRange | IRunwayInfoDeposit;
 interface IBaseRunwayInfo {
     name: string;
 }
@@ -1376,7 +1376,7 @@ interface IBaseTAFTrend extends IAbstractTrend, ITafGroups {
      */
     validity: IAbstractValidity & Partial<IFMValidity> & Partial<IValidity>;
 }
-declare type TAFTrend = IBaseTAFTrend & ({
+type TAFTrend = IBaseTAFTrend & ({
     type: WeatherChangeType.FM;
     validity: IFMValidity;
 } | {
@@ -1431,7 +1431,7 @@ interface IMetarDated extends IMetar {
     issued: Date;
 }
 
-declare type TAFTrendDated = IAbstractTrend & IBaseTAFTrend & {
+type TAFTrendDated = IAbstractTrend & IBaseTAFTrend & {
     validity: IBaseTAFTrend["validity"] & {
         start: Date;
         end?: Date;
@@ -1468,6 +1468,16 @@ declare class InvalidWeatherStatementError extends ParseError {
     cause?: unknown;
     constructor(cause?: unknown);
 }
+/**
+ * Thrown when an input contains data elements that are recognized but
+ * intentionally not supported.
+ */
+declare class PartialWeatherStatementError extends InvalidWeatherStatementError {
+    name: string;
+    part: number;
+    total: number;
+    constructor(partialMessage: string, part: number, total: number);
+}
 /**
  * Thrown when command marked as canParse, but couldn't parse when
  * executing (for example, an invalid CloudQuantity)
@@ -1488,9 +1498,9 @@ declare class UnexpectedParseError extends ParseError {
  * The initial forecast, extracted from the first line of the TAF, does not have
  * a trend type (FM, BECMG, etc)
  */
-declare type ForecastWithoutDates = Omit<TAFTrendDated, "type"> & Partial<Pick<TAFTrendDated, "type">>;
-declare type ForecastWithoutValidity = Omit<ForecastWithoutDates, "validity">;
-declare type Forecast = Omit<ForecastWithoutValidity, "type"> & {
+type ForecastWithoutDates = Omit<TAFTrendDated, "type"> & Partial<Pick<TAFTrendDated, "type">>;
+type ForecastWithoutValidity = Omit<ForecastWithoutDates, "validity">;
+type Forecast = Omit<ForecastWithoutValidity, "type"> & {
     start: Date;
     end: Date;
 } & ({
@@ -1554,4 +1564,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 { 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 };
+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, PartialWeatherStatementError, 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

@@ -39,6 +39,19 @@ class InvalidWeatherStatementError extends ParseError {
             this.cause = cause;
     }
 }
+/**
+ * Thrown when an input contains data elements that are recognized but
+ * intentionally not supported.
+ */
+class PartialWeatherStatementError extends InvalidWeatherStatementError {
+    constructor(partialMessage, part, total) {
+        super(`Input is partial TAF (${partialMessage}), see: https://github.com/aeharding/metar-taf-parser/issues/68`);
+        this.name = "PartialWeatherStatementError";
+        Object.setPrototypeOf(this, new.target.prototype);
+        this.part = part;
+        this.total = total;
+    }
+}
 /**
  * Thrown when command marked as canParse, but couldn't parse when
  * executing (for example, an invalid CloudQuantity)
@@ -2239,7 +2252,7 @@ class CommandSupplier {
 }
 _CommandSupplier_commands = new WeakMap();
 
-var _AbstractParser_INTENSITY_REGEX, _AbstractParser_CAVOK, _AbstractParser_commonSupplier, _MetarParser_commandSupplier, _TAFParser_commandSupplier, _TAFParser_validityPattern, _RemarkParser_supplier;
+var _AbstractParser_INTENSITY_REGEX, _AbstractParser_CAVOK, _AbstractParser_commonSupplier, _MetarParser_commandSupplier, _TAFParser_commandSupplier, _TAFParser_validityPattern, _TAFParser_partialPattern, _RemarkParser_supplier;
 function isStation(stationString) {
     return stationString.length === 4;
 }
@@ -2576,6 +2589,23 @@ class TAFParser extends AbstractParser {
         this.TN = "TN";
         _TAFParser_commandSupplier.set(this, new CommandSupplier());
         _TAFParser_validityPattern.set(this, /^\d{4}\/\d{4}$/);
+        _TAFParser_partialPattern.set(this, /^PART (\d) OF (\d) /);
+    }
+    /**
+     * Check a tokenized TAF against patterns that are explicitly not supported,
+     * throwing a descriptive exception to assist anyone who might want to apply
+     * any necessary custom parsing.
+     *
+     * @param input original input.
+     */
+    throwIfPartial(input) {
+        // TAFs in NOAA cycle files beginning `PART x OF y`,
+        // implying they are incomplete
+        const matches = input.match(__classPrivateFieldGet(this, _TAFParser_partialPattern, "f"));
+        if (matches) {
+            const [partialMessage, part, total] = matches;
+            throw new PartialWeatherStatementError(partialMessage.trim(), +part, +total);
+        }
     }
     /**
      * TAF messages can be formatted poorly
@@ -2605,6 +2635,7 @@ class TAFParser extends AbstractParser {
      * @throws ParseError if the message is invalid
      */
     parse(input) {
+        this.throwIfPartial(input);
         const lines = this.extractLinesTokens(input);
         let [index, flags] = this.parseMessageStart(lines[0]);
         const station = lines[0][index];
@@ -2674,7 +2705,7 @@ class TAFParser extends AbstractParser {
         const singleLine = tafCode.replace(/\n/g, " ");
         const cleanLine = singleLine.replace(/\s{2,}/g, " ");
         const lines = joinProbIfNeeded(cleanLine
-            .replace(/\s(?=PROB\d{2}\s(?=TEMPO|INTER)|TEMPO|INTER|BECMG|FM|PROB)/g, "\n")
+            .replace(/\s(?=PROB\d{2}\s(?=TEMPO|INTER)|TEMPO|INTER|BECMG|FM(?![A-Z]{2}\s)|PROB)/g, "\n")
             .split(/\n/));
         // TODO cleanup
         function joinProbIfNeeded(ls) {
@@ -2785,7 +2816,7 @@ class TAFParser extends AbstractParser {
         };
     }
 }
-_TAFParser_commandSupplier = new WeakMap(), _TAFParser_validityPattern = new WeakMap();
+_TAFParser_commandSupplier = new WeakMap(), _TAFParser_validityPattern = new WeakMap(), _TAFParser_partialPattern = new WeakMap();
 class RemarkParser {
     constructor(locale) {
         this.locale = locale;
@@ -3093,4 +3124,4 @@ function parse(rawReport, options, parser, datesHydrator) {
     }
 }
 
-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 };
+export { AltimeterUnit, CloudQuantity, CloudType, CommandExecutionError, DepositCoverage, DepositType, Descriptive, Direction, DistanceUnit, IcingIntensity, Intensity, InvalidWeatherStatementError, MetarType, ParseError, PartialWeatherStatementError, 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": "8.0.1",
+  "version": "8.0.2",
   "description": "Parse METAR and TAF reports",
   "homepage": "https://aeharding.github.io/metar-taf-parser",
   "keywords": [