@airframes/acars-decoder 1.6.1 → 1.6.3

package/dist/index.d.mts

@@ -1,2 +1,64 @@
+declare class IcaoDecoder {
+    name: string;
+    icao: string;
+    constructor(icao: string);
+    isMilitary(): true | RegExpMatchArray | null;
+}
 
-export {  }
+/**
+ * Representation of a Message
+ */
+interface Message {
+    label?: string;
+    sublabel?: string;
+    text: string;
+}
+/**
+ * Decoder Options
+ */
+interface Options {
+    debug?: boolean;
+}
+/**
+ * Results from decoding a message
+ */
+interface DecodeResult {
+    decoded: boolean;
+    decoder: {
+        name: string;
+        type: 'pattern-match' | 'none';
+        decodeLevel: 'none' | 'partial' | 'full';
+    };
+    error?: string;
+    formatted: {
+        description: string;
+        items: {
+            type: string;
+            code: string;
+            label: string;
+            value: string;
+        }[];
+    };
+    message?: any;
+    raw: any;
+    remaining: {
+        text?: string;
+    };
+}
+interface DecoderPluginInterface {
+    decode(message: Message): DecodeResult;
+    meetsStateRequirements(): boolean;
+    qualifiers(): any;
+}
+
+declare class MessageDecoder {
+    name: string;
+    plugins: Array<DecoderPluginInterface>;
+    debug: boolean;
+    constructor();
+    registerPlugin(plugin: DecoderPluginInterface): boolean;
+    decode(message: Message, options?: Options): DecodeResult;
+    lookupAirportByIata(iata: string): any;
+}
+
+export { IcaoDecoder, MessageDecoder };

package/dist/index.d.ts

@@ -1,2 +1,64 @@
+declare class IcaoDecoder {
+    name: string;
+    icao: string;
+    constructor(icao: string);
+    isMilitary(): true | RegExpMatchArray | null;
+}
 
-export {  }
+/**
+ * Representation of a Message
+ */
+interface Message {
+    label?: string;
+    sublabel?: string;
+    text: string;
+}
+/**
+ * Decoder Options
+ */
+interface Options {
+    debug?: boolean;
+}
+/**
+ * Results from decoding a message
+ */
+interface DecodeResult {
+    decoded: boolean;
+    decoder: {
+        name: string;
+        type: 'pattern-match' | 'none';
+        decodeLevel: 'none' | 'partial' | 'full';
+    };
+    error?: string;
+    formatted: {
+        description: string;
+        items: {
+            type: string;
+            code: string;
+            label: string;
+            value: string;
+        }[];
+    };
+    message?: any;
+    raw: any;
+    remaining: {
+        text?: string;
+    };
+}
+interface DecoderPluginInterface {
+    decode(message: Message): DecodeResult;
+    meetsStateRequirements(): boolean;
+    qualifiers(): any;
+}
+
+declare class MessageDecoder {
+    name: string;
+    plugins: Array<DecoderPluginInterface>;
+    debug: boolean;
+    constructor();
+    registerPlugin(plugin: DecoderPluginInterface): boolean;
+    decode(message: Message, options?: Options): DecodeResult;
+    lookupAirportByIata(iata: string): any;
+}
+
+export { IcaoDecoder, MessageDecoder };

package/dist/index.js

@@ -204,6 +204,32 @@ var Label_5Z = class extends DecoderPlugin {
   }
 };
 
+// lib/utils/coordinate_utils.ts
+var CoordinateUtils = class {
+  static decodeStringCoordinates(stringCoords) {
+    var results = {};
+    const firstChar = stringCoords.substring(0, 1);
+    let middleChar = stringCoords.substring(6, 7);
+    let longitudeChars = stringCoords.substring(7, 13);
+    if (middleChar == " ") {
+      middleChar = stringCoords.substring(7, 8);
+      longitudeChars = stringCoords.substring(8, 14);
+    }
+    if ((firstChar === "N" || firstChar === "S") && (middleChar === "W" || middleChar === "E")) {
+      results.latitude = Number(stringCoords.substring(1, 6)) / 1e3 * (firstChar === "S" ? -1 : 1);
+      results.longitude = Number(longitudeChars) / 1e3 * (middleChar === "W" ? -1 : 1);
+    } else {
+      return;
+    }
+    return results;
+  }
+  static coordinateString(coords) {
+    const latDir = coords.latitude > 0 ? "N" : "S";
+    const lonDir = coords.longitude > 0 ? "E" : "W";
+    return `${Math.abs(coords.latitude).toFixed(3)} ${latDir}, ${Math.abs(coords.longitude).toFixed(3)} ${lonDir}`;
+  }
+};
+
 // lib/plugins/Label_12_N_Space.ts
 var Label_12_N_Space = class extends DecoderPlugin {
   name = "label-12-n-space";
@@ -225,16 +251,16 @@ var Label_12_N_Space = class extends DecoderPlugin {
         console.log(`Label 12 N : results`);
         console.log(results);
       }
-      decodeResult.raw.latitude_direction = results.groups.lat;
-      decodeResult.raw.latitude = Number(results.groups.lat_coord);
-      decodeResult.raw.longitude_direction = results.groups.long;
-      decodeResult.raw.longitude = Number(results.groups.long_coord);
+      decodeResult.raw.position = {
+        latitude: Number(results.groups.lat_coord) * (results.groups.lat == "N" ? 1 : -1),
+        longitude: Number(results.groups.long_coord) * (results.groups.long == "E" ? 1 : -1)
+      };
       decodeResult.raw.flight_level = results.groups.alt == "GRD" || results.groups.alt == "***" ? "0" : Number(results.groups.alt);
       decodeResult.formatted.items.push({
         type: "aircraft_position",
         code: "POS",
         label: "Aircraft Position",
-        value: `${results.groups.lat_coord} ${decodeResult.raw.latitude_direction}, ${results.groups.long_coord} ${decodeResult.raw.longitude_direction}`
+        value: CoordinateUtils.coordinateString(decodeResult.raw.position)
       });
       decodeResult.formatted.items.push({
         type: "flight_level",
@@ -257,37 +283,6 @@ var Label_12_N_Space = class extends DecoderPlugin {
   }
 };
 
-// lib/utils/coordinate_utils.ts
-var CoordinateUtils = class {
-  static decodeStringCoordinates(stringCoords) {
-    var results = {};
-    const firstChar = stringCoords.substring(0, 1);
-    let middleChar = stringCoords.substring(6, 7);
-    let longitudeChars = stringCoords.substring(7, 13);
-    if (middleChar == " ") {
-      middleChar = stringCoords.substring(7, 8);
-      longitudeChars = stringCoords.substring(8, 14);
-    }
-    if ((firstChar === "N" || firstChar === "S") && (middleChar === "W" || middleChar === "E")) {
-      results.latitudeDirection = firstChar;
-      results.latitude = Number(stringCoords.substring(1, 6)) / 1e3 * (firstChar === "S" ? -1 : 1);
-      results.longitudeDirection = middleChar;
-      results.longitude = Number(longitudeChars) / 1e3 * (middleChar === "W" ? -1 : 1);
-    } else {
-      return;
-    }
-    return results;
-  }
-  static coordinateString(coords) {
-    return `${Math.abs(coords.latitude)} ${coords.latitudeDirection}, ${Math.abs(coords.longitude)} ${coords.longitudeDirection}`;
-  }
-  static latLonToCoordinateString(lat, lon) {
-    const latDir = lat > 0 ? "N" : "S";
-    const lonDir = lon > 0 ? "E" : "W";
-    return `${Math.abs(lat)} ${latDir}, ${Math.abs(lon)} ${lonDir}`;
-  }
-};
-
 // lib/plugins/Label_15.ts
 var Label_15 = class extends DecoderPlugin {
   name = "label-5z";
@@ -341,9 +336,7 @@ var Label_15_FST = class extends DecoderPlugin {
     const middleChar = stringCoords.substring(7, 8);
     decodeResult.raw.position = {};
     if ((firstChar === "N" || firstChar === "S") && (middleChar === "W" || middleChar === "E")) {
-      decodeResult.raw.position.latitudeDirection = firstChar;
       decodeResult.raw.position.latitude = Number(stringCoords.substring(1, 7)) / 1e4 * (firstChar === "S" ? -1 : 1);
-      decodeResult.raw.position.longitudeDirection = middleChar;
       decodeResult.raw.position.longitude = Number(stringCoords.substring(8, 26)) / 1e5 * (middleChar === "W" ? -1 : 1);
     } else {
       decodeResult.decoded = false;
@@ -395,16 +388,16 @@ var Label_16_N_Space = class extends DecoderPlugin {
         console.log(`Label 16 N : results`);
         console.log(results);
       }
-      decodeResult.raw.latitude_direction = results.groups.lat;
-      decodeResult.raw.latitude = Number(results.groups.lat_coord);
-      decodeResult.raw.longitude_direction = results.groups.long;
-      decodeResult.raw.longitude = Number(results.groups.long_coord);
+      decodeResult.raw.position = {
+        latitude: Number(results.groups.lat_coord) * (results.groups.lat == "N" ? 1 : -1),
+        longitude: Number(results.groups.long_coord) * (results.groups.long == "E" ? 1 : -1)
+      };
       decodeResult.raw.flight_level = results.groups.alt == "GRD" || results.groups.alt == "***" ? "0" : Number(results.groups.alt);
       decodeResult.formatted.items.push({
         type: "aircraft_position",
         code: "POS",
         label: "Aircraft Position",
-        value: `${decodeResult.raw.latitude} ${decodeResult.raw.latitude_direction}, ${decodeResult.raw.longitude} ${decodeResult.raw.longitude_direction}`
+        value: CoordinateUtils.coordinateString(decodeResult.raw.position)
       });
       decodeResult.formatted.items.push({
         type: "flight_level",
@@ -420,15 +413,15 @@ var Label_16_N_Space = class extends DecoderPlugin {
         console.log(`Label 16 N : results`);
         console.log(results);
       }
-      decodeResult.raw.latitude_direction = results.groups.lat;
-      decodeResult.raw.latitude = Number(results.groups.lat_coord);
-      decodeResult.raw.longitude_direction = results.groups.long;
-      decodeResult.raw.longitude = Number(results.groups.long_coord);
+      decodeResult.raw.position = {
+        latitude: Number(results.groups.lat_coord) * (results.groups.lat == "N" ? 1 : -1),
+        longitude: Number(results.groups.long_coord) * (results.groups.long == "E" ? 1 : -1)
+      };
       decodeResult.formatted.items.push({
         type: "aircraft_position",
         code: "POS",
         label: "Aircraft Position",
-        value: `${results.groups.lat_coord} ${decodeResult.raw.latitude_direction}, ${results.groups.long_coord} ${decodeResult.raw.longitude_direction}`
+        value: CoordinateUtils.coordinateString(decodeResult.raw.position)
       });
       decodeResult.decoded = true;
       decodeResult.decoder.decodeLevel = "full";
@@ -483,11 +476,14 @@ var DateTimeUtils = class {
   /**
    * 
    * @param time HHMMSS
-   * @param date MMDDYY
+   * @param date MMDDYY or MMDDYYYY
    * @returns seconds since epoch
    */
   static convertDateTimeToEpoch(time, date) {
-    const timestamp = `20${date.substring(4, 6)}-${date.substring(0, 2)}-${date.substring(2, 4)}T${time.substring(0, 2)}:${time.substring(2, 4)}:${time.substring(4, 6)}.000Z`;
+    if (date.length === 6) {
+      date = date.substring(0, 4) + `20${date.substring(4, 6)}`;
+    }
+    const timestamp = `${date.substring(4, 8)}-${date.substring(0, 2)}-${date.substring(2, 4)}T${time.substring(0, 2)}:${time.substring(2, 4)}:${time.substring(4, 6)}.000Z`;
     const millis = Date.parse(timestamp);
     return millis / 1e3;
   }
@@ -579,11 +575,13 @@ var Label_20_POS = class extends DecoderPlugin {
       console.log(`DEBUG: ${this.name}: Variation 2 detected`);
       const rawCoords = fields[0];
       decodeResult.raw.position = CoordinateUtils.decodeStringCoordinates(rawCoords);
-      decodeResult.formatted.items.push({
-        type: "position",
-        label: "Position",
-        value: CoordinateUtils.coordinateString(decodeResult.raw.position)
-      });
+      if (decodeResult.raw.position) {
+        decodeResult.formatted.items.push({
+          type: "position",
+          label: "Position",
+          value: CoordinateUtils.coordinateString(decodeResult.raw.position)
+        });
+      }
       decodeResult.decoded = true;
       decodeResult.decoder.decodeLevel = "full";
     } else {
@@ -1089,7 +1087,7 @@ var Label_80 = class extends DecoderPlugin {
               const lon = Number(posResult.groups.lng) * (posResult.groups.lngd === "W" ? -1 : 1);
               const latitude = Number.isInteger(lat) ? lat / 1e3 : lat / 100;
               const longitude = Number.isInteger(lon) ? lon / 1e3 : lon / 100;
-              decodeResult.raw.aircraft_position = {
+              decodeResult.raw.position = {
                 latitude,
                 longitude
               };
@@ -1097,7 +1095,7 @@ var Label_80 = class extends DecoderPlugin {
                 type: "position",
                 code: "POS",
                 label: "Position",
-                value: `${Math.abs(latitude).toPrecision(5)} ${posResult.groups.latd}, ${Math.abs(longitude).toPrecision(5)} ${posResult.groups.lngd}`
+                value: CoordinateUtils.coordinateString(decodeResult.raw.position)
               });
               break;
             }
@@ -1240,7 +1238,7 @@ var RouteUtils = class _RouteUtils {
   static waypointToString(waypoint) {
     let s = waypoint.name;
     if (waypoint.latitude && waypoint.longitude) {
-      s += `(${CoordinateUtils.latLonToCoordinateString(waypoint.latitude, waypoint.longitude)})`;
+      s += `(${CoordinateUtils.coordinateString({ latitude: waypoint.latitude, longitude: waypoint.longitude })})`;
     }
     if (waypoint.time && waypoint.timeFormat) {
       s += `@${_RouteUtils.timestampToString(waypoint.time, waypoint.timeFormat)}`;
@@ -1251,11 +1249,15 @@ var RouteUtils = class _RouteUtils {
     const waypoint = leg.split(",");
     if (waypoint.length == 2) {
       const position = CoordinateUtils.decodeStringCoordinates(waypoint[1]);
-      return { name: waypoint[0], latitude: position.latitude, longitude: position.longitude };
+      if (position) {
+        return { name: waypoint[0], latitude: position.latitude, longitude: position.longitude };
+      }
     }
     if (leg.length == 14) {
       const position = CoordinateUtils.decodeStringCoordinates(leg);
-      return { name: waypoint[0], latitude: position.latitude, longitude: position.longitude };
+      if (position) {
+        return { name: waypoint[0], latitude: position.latitude, longitude: position.longitude };
+      }
     }
     return { name: leg };
   }
@@ -1508,7 +1510,6 @@ var Label_H1_POS = class extends DecoderPlugin {
     decodeResult.message = message;
     const checksum = message.text.slice(-4);
     const parts = message.text.replace("#M1B", "").replace("POS", "").slice(0, -4).split(",");
-    console.log(parts);
     if (parts.length == 1 && parts[0].startsWith("/RF")) {
       decodeResult.raw.route_status == "RF";
       decodeResult.formatted.items.push({
@@ -1564,6 +1565,40 @@ var Label_H1_POS = class extends DecoderPlugin {
       processChecksum(decodeResult, checksum);
       decodeResult.decoded = true;
       decodeResult.decoder.decodeLevel = "partial";
+    } else if (parts.length === 15) {
+      decodeResult.remaining.text = "";
+      processUnknown(decodeResult, parts[0]);
+      processUnknown(decodeResult, parts[1]);
+      let date = void 0;
+      if (parts[2].startsWith("/DC")) {
+        date = parts[2].substring(3);
+      } else {
+        processUnknown(decodeResult, parts[2]);
+      }
+      processUnknown(decodeResult, parts[3]);
+      const fields = parts[4].split("/");
+      for (let i = 0; i < fields.length; ++i) {
+        const field = fields[i];
+        if (field.startsWith("PS")) {
+          processPosition(decodeResult, field.substring(2));
+        } else {
+          if (i === 0) {
+            processUnknown(decodeResult, field);
+          } else {
+            processUnknown(decodeResult, "/" + field);
+          }
+        }
+      }
+      processRoute(decodeResult, parts[7], parts[5], parts[9], parts[8], void 0, date);
+      processAlt(decodeResult, parts[6]);
+      processTemp(decodeResult, parts[10]);
+      processUnknown(decodeResult, parts[11]);
+      processUnknown(decodeResult, parts[12]);
+      processUnknown(decodeResult, parts[13]);
+      processUnknown(decodeResult, parts[14]);
+      processChecksum(decodeResult, checksum);
+      decodeResult.decoded = true;
+      decodeResult.decoder.decodeLevel = "partial";
     } else if (parts.length === 32) {
       decodeResult.remaining.text = "";
       processPosition(decodeResult, parts[0]);
@@ -1584,7 +1619,7 @@ var Label_H1_POS = class extends DecoderPlugin {
       processAlt(decodeResult, parts[22]);
       processUnknown(decodeResult, parts.slice(23, 31).join(","));
       const allProcessed = FlightPlanUtils.processFlightPlan(decodeResult, (parts[31] + checksum).split(":"));
-      processRoute(decodeResult, past, time, next, eta, "?");
+      processRoute(decodeResult, past, time, next, eta);
       decodeResult.decoded = true;
       decodeResult.decoder.decodeLevel = "partial";
     } else {
@@ -1603,16 +1638,15 @@ function processUnknown(decodeResult, value) {
 }
 function processPosition(decodeResult, value) {
   const position = CoordinateUtils.decodeStringCoordinates(value);
-  decodeResult.raw.latitude_direction = position.latitudeDirection;
-  decodeResult.raw.latitude = Math.abs(position.latitude);
-  decodeResult.raw.longitude_direction = position.longitudeDirection;
-  decodeResult.raw.longitude = Math.abs(position.longitude);
-  decodeResult.formatted.items.push({
-    type: "aircraft_position",
-    code: "POS",
-    label: "Aircraft Position",
-    value: CoordinateUtils.coordinateString(position)
-  });
+  if (position) {
+    decodeResult.raw.position = position;
+    decodeResult.formatted.items.push({
+      type: "aircraft_position",
+      code: "POS",
+      label: "Aircraft Position",
+      value: CoordinateUtils.coordinateString(position)
+    });
+  }
 }
 function processAlt(decodeResult, value) {
   decodeResult.raw.altitude = Number(value) * 100;
@@ -1650,16 +1684,14 @@ function processGndspd(decodeResult, value) {
   });
 }
 function processRoute(decodeResult, last, time, next, eta, then, date) {
-  let waypoints;
-  waypoints = date === void 0 ? [
-    { name: last || "?,", time: DateTimeUtils.convertHHMMSSToTod(time), timeFormat: "tod" },
-    { name: next || "?", time: DateTimeUtils.convertHHMMSSToTod(eta), timeFormat: "tod" },
-    { name: then || "?" }
-  ] : [
-    { name: last || "?,", time: DateTimeUtils.convertDateTimeToEpoch(time, date), timeFormat: "epoch" },
-    { name: next || "?", time: DateTimeUtils.convertDateTimeToEpoch(eta, date), timeFormat: "epoch" },
-    { name: then || "?" }
-  ];
+  const lastCoords = CoordinateUtils.decodeStringCoordinates(last);
+  const nextCoords = CoordinateUtils.decodeStringCoordinates(next);
+  const lastTime = date ? DateTimeUtils.convertDateTimeToEpoch(time, date) : DateTimeUtils.convertHHMMSSToTod(time);
+  const nextTime = date ? DateTimeUtils.convertDateTimeToEpoch(eta, date) : DateTimeUtils.convertHHMMSSToTod(eta);
+  const timeFormat = date ? "epoch" : "tod";
+  const lastWaypoint = lastCoords ? { name: "", latitude: lastCoords.latitude, longitude: lastCoords.longitude, time: lastTime, timeFormat } : { name: last, time: lastTime, timeFormat };
+  const nextWaypoint = nextCoords ? { name: "", latitude: nextCoords.latitude, longitude: nextCoords.longitude, time: nextTime, timeFormat } : { name: next, time: nextTime, timeFormat };
+  const waypoints = [lastWaypoint, nextWaypoint, { name: then || "?" }];
   decodeResult.raw.route = { waypoints };
   decodeResult.formatted.items.push({
     type: "aircraft_route",
@@ -1678,6 +1710,62 @@ function processChecksum(decodeResult, value) {
   });
 }
 
+// lib/plugins/Label_H1_WRN.ts
+var Label_H1_WRN = class extends DecoderPlugin {
+  name = "label-h1-wrn";
+  qualifiers() {
+    return {
+      labels: ["H1"],
+      preambles: ["WRN", "#CFBWRN"]
+    };
+  }
+  decode(message, options = {}) {
+    let decodeResult = this.defaultResult;
+    decodeResult.decoder.name = this.name;
+    decodeResult.formatted.description = "Warning Message";
+    decodeResult.message = message;
+    const parts = message.text.split("/WN");
+    if (parts.length > 1) {
+      decodeResult.remaining.text = "";
+      const fields = parts[0].split("/");
+      for (let i = 1; i < fields.length; i++) {
+        const field = fields[i];
+        if (field.startsWith("PN")) {
+          processUnknown2(decodeResult, "/" + field);
+        } else {
+          processUnknown2(decodeResult, "/" + field);
+        }
+      }
+      const data = parts[1].substring(0, 20);
+      const msg = parts[1].substring(20);
+      const datetime = data.substring(0, 12);
+      const date = datetime.substring(4, 6) + datetime.substring(2, 4) + datetime.substring(0, 2);
+      processUnknown2(decodeResult, data.substring(12));
+      decodeResult.raw.message_timestamp = DateTimeUtils.convertDateTimeToEpoch(datetime.substring(6), date);
+      decodeResult.raw.warning_message = msg;
+      decodeResult.formatted.items.push({
+        type: "warning",
+        code: "WRN",
+        label: "Warning Message",
+        value: decodeResult.raw.warning_message
+      });
+      decodeResult.decoded = true;
+      decodeResult.decoder.decodeLevel = "partial";
+    } else {
+      if (options.debug) {
+        console.log(`Decoder: Unknown H1 message: ${message.text}`);
+      }
+      decodeResult.remaining.text = message.text;
+      decodeResult.decoded = false;
+      decodeResult.decoder.decodeLevel = "none";
+    }
+    return decodeResult;
+  }
+};
+function processUnknown2(decodeResult, value) {
+  decodeResult.remaining.text += value;
+}
+
 // lib/plugins/Label_SQ.ts
 var Label_SQ = class extends DecoderPlugin {
   name = "label-sq";
@@ -2781,6 +2869,7 @@ var MessageDecoder = class {
     this.registerPlugin(new Label_B6_Forwardslash(this));
     this.registerPlugin(new Label_H1_FPN(this));
     this.registerPlugin(new Label_H1_POS(this));
+    this.registerPlugin(new Label_H1_WRN(this));
     this.registerPlugin(new Label_80(this));
     this.registerPlugin(new Label_8E(this));
     this.registerPlugin(new Label_1M_Slash(this));