metar-taf-parser 4.1.0 → 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/metar-taf-parser.d.ts

@@ -1142,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;
@@ -1326,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;

package/metar-taf-parser.js

@@ -2064,7 +2064,7 @@ 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,
@@ -2120,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),
@@ -2356,7 +2356,8 @@ class TAFParser extends AbstractParser {
         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,
@@ -2546,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),
@@ -2705,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.1.0",
+  "version": "5.0.0",
   "description": "Parse METAR and TAF reports",
   "homepage": "https://aeharding.github.io/metar-taf-parser",
   "keywords": [