@airframes/acars-decoder 1.8.13 → 1.8.14

package/dist/index.d.mts

@@ -6,6 +6,70 @@ declare class IcaoDecoder {
     isMilitary(): boolean;
 }
 
+/**
+ * Represenation of a waypoint.
+ *
+ * Usually used in Routes which is an array of waypoints.
+ * Airways/Jetways can also be represented as a waypoint, by just the name.
+ * There is no distinction between the two currently because there is no difference from the current messages
+ * Distinction must be determined from tne name.
+ * In the event that a waypoint is a GPS position, the name can be the raw position string (N12345W012345)
+ */
+interface Waypoint {
+    /** unique identifier of the waypoint*/
+    name: string;
+    /**
+     * latitude in decimal degrees
+     *
+     * if set, longitude must be provided
+     */
+    latitude?: number;
+    /** longitude in decimal degrees
+     *
+     * if set, latitude must be provided
+     */
+    longitude?: number;
+    /**
+     * time of arrival. If in future, it is an ETA.
+     */
+    time?: number;
+    /**
+     * offset from the actual waypoint
+     *
+     * bearing: degrees from the waypoint
+     * distance: distance in nautical miles
+     */
+    offset?: {
+        bearing: number;
+        distance: number;
+    };
+}
+
+/**
+ * Representation of a route
+ *
+ * Typically a list of waypoints, this can also be a named company route.
+ */
+interface Route {
+    /** optional name. If not set, `waypoints` is required */
+    name?: string;
+    /** optional runway */
+    runway?: string;
+    /** optional list of waypoints. If not set, `name` is required */
+    waypoints?: Waypoint[];
+}
+
+interface Wind {
+    waypoint: Waypoint;
+    flightLevel: number;
+    windDirection: number;
+    windSpeed: number;
+    temperature?: {
+        flightLevel: number;
+        degreesC: number;
+    };
+}
+
 /**
  * Representation of a Message
  */
@@ -20,6 +84,87 @@ interface Message {
 interface Options {
     debug?: boolean;
 }
+/**
+ * Known fields that can appear on DecodeResult.raw.
+ * The index signature allows plugin-specific fields without losing type safety
+ * on the well-known ones.
+ */
+interface RawFields {
+    position?: {
+        latitude: number;
+        longitude: number;
+    };
+    altitude?: number;
+    heading?: number;
+    groundspeed?: number;
+    airspeed?: number;
+    mach?: number;
+    flight_number?: string;
+    callsign?: string;
+    tail?: string;
+    departure_icao?: string;
+    departure_iata?: string;
+    arrival_icao?: string;
+    arrival_iata?: string;
+    alternate_icao?: string;
+    departure_runway?: string;
+    arrival_runway?: string;
+    alternate_runway?: string;
+    message_timestamp?: number;
+    eta_time?: number;
+    out_time?: number;
+    off_time?: number;
+    on_time?: number;
+    in_time?: number;
+    engine_start_time?: number;
+    engine_stop_time?: number;
+    day?: number | string;
+    month?: number;
+    departure_day?: number;
+    arrival_day?: number;
+    fuel_on_board?: number;
+    fuel_burned?: number;
+    fuel_remaining?: number;
+    fuel_in_tons?: number;
+    out_fuel?: number;
+    off_fuel?: number;
+    on_fuel?: number;
+    in_fuel?: number;
+    start_fuel?: number;
+    outside_air_temperature?: number;
+    total_air_temperature?: number;
+    center_of_gravity?: number;
+    cg_lower_limit?: number;
+    cg_upper_limit?: number;
+    mac?: number;
+    trim?: number;
+    route?: Route;
+    wind_data?: Wind[];
+    requested_alts?: number[];
+    desired_alt?: number;
+    start_point?: string;
+    route_number?: string;
+    flight_plan?: string;
+    label?: string;
+    sublabel?: string;
+    preamble?: string;
+    version?: number;
+    checksum_algorithm?: string;
+    checksum?: number;
+    sequence_number?: number;
+    sequence_response?: number;
+    ground_address?: string;
+    text?: string;
+    state_change?: {
+        from: string;
+        to: string;
+    };
+    door_event?: {
+        door: string;
+        state: string;
+    };
+    [key: string]: unknown;
+}
 /**
  * Results from decoding a message
  */
@@ -41,7 +186,7 @@ interface DecodeResult {
         }[];
     };
     message?: Message;
-    raw: any;
+    raw: RawFields;
     remaining: {
         text?: string;
     };
@@ -51,7 +196,7 @@ interface Qualifiers {
     preambles?: string[];
 }
 interface DecoderPluginInterface {
-    decode(message: Message): DecodeResult;
+    decode(message: Message, options?: Options): DecodeResult;
     meetsStateRequirements(): boolean;
     qualifiers(): Qualifiers;
 }
@@ -60,6 +205,10 @@ declare class MessageDecoder {
     name: string;
     plugins: Array<DecoderPluginInterface>;
     debug: boolean;
+    /** Maps a label string to the plugins registered for it, preserving registration order. */
+    private labelIndex;
+    /** Plugins that match all labels (qualifier label '*'). */
+    private wildcardPlugins;
     constructor();
     registerPlugin(plugin: DecoderPluginInterface): boolean;
     decode(message: Message, options?: Options): DecodeResult;

package/dist/index.d.ts

@@ -6,6 +6,70 @@ declare class IcaoDecoder {
     isMilitary(): boolean;
 }
 
+/**
+ * Represenation of a waypoint.
+ *
+ * Usually used in Routes which is an array of waypoints.
+ * Airways/Jetways can also be represented as a waypoint, by just the name.
+ * There is no distinction between the two currently because there is no difference from the current messages
+ * Distinction must be determined from tne name.
+ * In the event that a waypoint is a GPS position, the name can be the raw position string (N12345W012345)
+ */
+interface Waypoint {
+    /** unique identifier of the waypoint*/
+    name: string;
+    /**
+     * latitude in decimal degrees
+     *
+     * if set, longitude must be provided
+     */
+    latitude?: number;
+    /** longitude in decimal degrees
+     *
+     * if set, latitude must be provided
+     */
+    longitude?: number;
+    /**
+     * time of arrival. If in future, it is an ETA.
+     */
+    time?: number;
+    /**
+     * offset from the actual waypoint
+     *
+     * bearing: degrees from the waypoint
+     * distance: distance in nautical miles
+     */
+    offset?: {
+        bearing: number;
+        distance: number;
+    };
+}
+
+/**
+ * Representation of a route
+ *
+ * Typically a list of waypoints, this can also be a named company route.
+ */
+interface Route {
+    /** optional name. If not set, `waypoints` is required */
+    name?: string;
+    /** optional runway */
+    runway?: string;
+    /** optional list of waypoints. If not set, `name` is required */
+    waypoints?: Waypoint[];
+}
+
+interface Wind {
+    waypoint: Waypoint;
+    flightLevel: number;
+    windDirection: number;
+    windSpeed: number;
+    temperature?: {
+        flightLevel: number;
+        degreesC: number;
+    };
+}
+
 /**
  * Representation of a Message
  */
@@ -20,6 +84,87 @@ interface Message {
 interface Options {
     debug?: boolean;
 }
+/**
+ * Known fields that can appear on DecodeResult.raw.
+ * The index signature allows plugin-specific fields without losing type safety
+ * on the well-known ones.
+ */
+interface RawFields {
+    position?: {
+        latitude: number;
+        longitude: number;
+    };
+    altitude?: number;
+    heading?: number;
+    groundspeed?: number;
+    airspeed?: number;
+    mach?: number;
+    flight_number?: string;
+    callsign?: string;
+    tail?: string;
+    departure_icao?: string;
+    departure_iata?: string;
+    arrival_icao?: string;
+    arrival_iata?: string;
+    alternate_icao?: string;
+    departure_runway?: string;
+    arrival_runway?: string;
+    alternate_runway?: string;
+    message_timestamp?: number;
+    eta_time?: number;
+    out_time?: number;
+    off_time?: number;
+    on_time?: number;
+    in_time?: number;
+    engine_start_time?: number;
+    engine_stop_time?: number;
+    day?: number | string;
+    month?: number;
+    departure_day?: number;
+    arrival_day?: number;
+    fuel_on_board?: number;
+    fuel_burned?: number;
+    fuel_remaining?: number;
+    fuel_in_tons?: number;
+    out_fuel?: number;
+    off_fuel?: number;
+    on_fuel?: number;
+    in_fuel?: number;
+    start_fuel?: number;
+    outside_air_temperature?: number;
+    total_air_temperature?: number;
+    center_of_gravity?: number;
+    cg_lower_limit?: number;
+    cg_upper_limit?: number;
+    mac?: number;
+    trim?: number;
+    route?: Route;
+    wind_data?: Wind[];
+    requested_alts?: number[];
+    desired_alt?: number;
+    start_point?: string;
+    route_number?: string;
+    flight_plan?: string;
+    label?: string;
+    sublabel?: string;
+    preamble?: string;
+    version?: number;
+    checksum_algorithm?: string;
+    checksum?: number;
+    sequence_number?: number;
+    sequence_response?: number;
+    ground_address?: string;
+    text?: string;
+    state_change?: {
+        from: string;
+        to: string;
+    };
+    door_event?: {
+        door: string;
+        state: string;
+    };
+    [key: string]: unknown;
+}
 /**
  * Results from decoding a message
  */
@@ -41,7 +186,7 @@ interface DecodeResult {
         }[];
     };
     message?: Message;
-    raw: any;
+    raw: RawFields;
     remaining: {
         text?: string;
     };
@@ -51,7 +196,7 @@ interface Qualifiers {
     preambles?: string[];
 }
 interface DecoderPluginInterface {
-    decode(message: Message): DecodeResult;
+    decode(message: Message, options?: Options): DecodeResult;
     meetsStateRequirements(): boolean;
     qualifiers(): Qualifiers;
 }
@@ -60,6 +205,10 @@ declare class MessageDecoder {
     name: string;
     plugins: Array<DecoderPluginInterface>;
     debug: boolean;
+    /** Maps a label string to the plugins registered for it, preserving registration order. */
+    private labelIndex;
+    /** Plugins that match all labels (qualifier label '*'). */
+    private wildcardPlugins;
     constructor();
     registerPlugin(plugin: DecoderPluginInterface): boolean;
     decode(message: Message, options?: Options): DecodeResult;