adding typing to decoders

lib/DecoderPlugin.ts

@@ -1,28 +1,28 @@
-import { DecoderPluginInterface } from './DecoderPluginInterface';
+import { DecodeResult, DecoderPluginInterface, Message, Options } from './DecoderPluginInterface';
 
 export abstract class DecoderPlugin implements DecoderPluginInterface {
   decoder!: any;
 
   name: string = 'unknown';
 
-  defaultResult: any = {
+  defaultResult: DecodeResult = {
     decoded: false,
-    decoder: <any>{
+    decoder: {
       name: 'unknown',
       type: 'pattern-match',
       decodeLevel: 'none',
     },
-    formatted: <any>{
+    formatted: {
       description: 'Unknown',
-      items: <any>[],
+      items: [],
     },
-    raw: <any>{},
-    remaining: <any>{},
+    raw: {},
+    remaining: {},
   };
 
   options: Object;
 
-  constructor(decoder : any, options : any = {}) {
+  constructor(decoder : any, options : Options = {}) {
     this.decoder = decoder;
     this.options = options;
   }
@@ -48,40 +48,11 @@ export abstract class DecoderPlugin implements DecoderPluginInterface {
     };
   }
 
-  decode(message: any) : any { // eslint-disable-line class-methods-use-this
+  decode(message: Message) : DecodeResult { // eslint-disable-line class-methods-use-this
     const decodeResult: any = this.defaultResult;
     decodeResult.remaining.text = message.text;
     return decodeResult;
   }
-
-  // Utilities
-  // TODO: Move these to a utilities class and instanciate here for use in subclasses
-
-  decodeStringCoordinates(stringCoords: String) : any { // eslint-disable-line class-methods-use-this
-    var results : any = {};
-    // format: N12345W123456 or N12345 W123456
-    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)) / 1000) * (firstChar === 'S' ? -1 : 1);
-      results.longitudeDirection = middleChar;
-      results.longitude = (Number(longitudeChars) / 1000) * (middleChar === 'W' ? -1 : 1);
-    } else {
-      return;
-    }
-
-    return results;
-  }
-
-  coordinateString(coords: any) : String {
-    return `${Math.abs(coords.latitude)} ${coords.latitudeDirection}, ${Math.abs(coords.longitude)} ${coords.longitudeDirection}`
-  }
 }
 
 export default {};

lib/DecoderPluginInterface.ts

@@ -1,5 +1,48 @@
+/**
+ * Representation of a Message
+ */
+export interface Message {
+  label?: string,
+  sublabel?: string,
+  text: string,
+}
+
+/**
+ * Decoder Options
+ */
+export interface Options {
+  debug?:boolean,
+}
+
+/**
+ * Results from decoding a message
+ */
+export 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
+  }
+}
+
 export interface DecoderPluginInterface {
-  decode(message: any) : any;
+  decode(message: Message) : DecodeResult;
   meetsStateRequirements() : boolean;
   // onRegister(store: Store<any>) : void;
   qualifiers() : any;

lib/MessageDecoder.ts

@@ -1,4 +1,4 @@
-import { DecoderPluginInterface } from './DecoderPluginInterface'; // eslint-disable-line import/no-cycle
+import { DecodeResult, DecoderPluginInterface, Message, Options } from './DecoderPluginInterface'; // eslint-disable-line import/no-cycle
 
 import * as Plugins from './plugins/official';
 import { MIAMCoreUtils } from './utils/miam';
@@ -47,7 +47,7 @@ export class MessageDecoder {
     return true;
   }
 
-  decode(message: any, options: any = {}) {
+  decode(message: Message, options: Options = {}): DecodeResult {
     if (message.label === 'MA') {
       const decodeResult = MIAMCoreUtils.parse(message.text);
 
@@ -94,34 +94,34 @@ export class MessageDecoder {
       console.log(usablePlugins);
     }
 
-    let result;
+    let result : DecodeResult;
     if (usablePlugins.length > 0) {
       const plugin: DecoderPluginInterface = usablePlugins[0];
       result = plugin.decode(message);
     } else {
       result = {
         decoded: false,
-        decodeLevel: 'none',
         error: 'No known decoder plugin for this message',
+        decoder: {
+          name: 'none',
+          type: 'none',
+          decodeLevel: 'none',
+        },
         message: message,
         remaining: {
           text: message.text,
         },
         raw: {},
-        formatted: {},
+        formatted: {
+          description: 'Not Decoded',
+          items: [],
+        },
       };
     }
 
     if (options.debug) {
-      let performDebug = true;
-      if (options.debug.only_decoded) {
-        performDebug = result.decoded;
-      }
-
-      if (performDebug) {
-        console.log('Result');
-        console.log(result);
-      }
+      console.log('Result');
+      console.log(result);
     }
 
     return result;

lib/bin/acars-decoder-test.ts

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
 
+import { DecodeResult, Message } from '../DecoderPluginInterface';
 import { MessageDecoder } from '../MessageDecoder';
 
-function debugMessage(message: any, decoding: any) {
+function debugMessage(message: Message, decoding: DecodeResult) {
   console.log("ORIGINAL MESSAGE");
   console.log("Label:", message.label);
   console.log("Text:", message.text);

lib/plugins/Label_12_N_Space.ts

@@ -1,4 +1,5 @@
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 
 export class Label_12_N_Space extends DecoderPlugin {
   name = 'label-12-n-space';
@@ -10,7 +11,7 @@ export class Label_12_N_Space extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'Position Report';

lib/plugins/Label_15.ts

@@ -1,4 +1,5 @@
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 import { CoordinateUtils } from '../utils/coordinate_utils';
 
 // General Aviation Position Report
@@ -12,7 +13,7 @@ export class Label_15 extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'Position Report';

lib/plugins/Label_15_FST.ts

@@ -1,4 +1,5 @@
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 import { CoordinateUtils } from '../utils/coordinate_utils';
 
 // Position Report
@@ -12,7 +13,7 @@ export class Label_15_FST extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'Position Report';

lib/plugins/Label_16_N_Space.ts

@@ -1,4 +1,5 @@
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 
 export class Label_16_N_Space extends DecoderPlugin {
   name = 'label-16-n-space';
@@ -10,7 +11,7 @@ export class Label_16_N_Space extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'Position Report';

lib/plugins/Label_1M_Slash.ts

@@ -1,5 +1,6 @@
 import { DateTimeUtils } from '../DateTimeUtils';
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 
 export class Label_1M_Slash extends DecoderPlugin {
   name = 'label-1m-slash';
@@ -11,7 +12,7 @@ export class Label_1M_Slash extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'ETA Report';

lib/plugins/Label_20_CFB.01.ts

@@ -1,4 +1,5 @@
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 import { CoordinateUtils } from '../utils/coordinate_utils';
 
 // In Air Report
@@ -12,7 +13,7 @@ export class Label_20_CFB01 extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'Crew Flight Bag Message';

lib/plugins/Label_20_POS.ts

@@ -1,4 +1,5 @@
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 import { CoordinateUtils } from '../utils/coordinate_utils';
 
 // Position Report
@@ -12,7 +13,7 @@ export class Label_20_POS extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'Position Report';

lib/plugins/Label_30_Slash_EA.ts

@@ -1,5 +1,6 @@
 import { DateTimeUtils } from '../DateTimeUtils';
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 
 export class Label_30_Slash_EA extends DecoderPlugin {
   name = 'label-30-slash-ea';
@@ -11,7 +12,7 @@ export class Label_30_Slash_EA extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'ETA Report';

lib/plugins/Label_44_ETA.ts

@@ -1,4 +1,5 @@
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 import { CoordinateUtils } from '../utils/coordinate_utils';
 
 // In Air Report
@@ -12,7 +13,7 @@ export class Label_44_ETA extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'ETA Report';

lib/plugins/Label_44_IN.ts

@@ -1,4 +1,5 @@
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 import { CoordinateUtils } from '../utils/coordinate_utils';
 
 // In Air Report
@@ -12,7 +13,7 @@ export class Label_44_IN extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'In Air Report';

lib/plugins/Label_44_OFF.ts

@@ -1,4 +1,5 @@
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 import { CoordinateUtils } from '../utils/coordinate_utils';
 
 // Off Runway Report
@@ -12,7 +13,7 @@ export class Label_44_OFF extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'Off Runway Report';

lib/plugins/Label_44_ON.ts

@@ -1,4 +1,5 @@
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 import { CoordinateUtils } from '../utils/coordinate_utils';
 
 // On Runway Report
@@ -12,7 +13,7 @@ export class Label_44_ON extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'On Runway Report';

lib/plugins/Label_44_POS.ts

@@ -1,4 +1,5 @@
 import { DecoderPlugin } from '../DecoderPlugin';
+import { DecodeResult, Message, Options } from '../DecoderPluginInterface';
 import { CoordinateUtils } from '../utils/coordinate_utils';
 
 // General Aviation Position Report
@@ -12,7 +13,7 @@ export class Label_44_POS extends DecoderPlugin {
     };
   }
 
-  decode(message: any, options: any = {}) : any {
+  decode(message: Message, options: Options = {}) : DecodeResult {
     const decodeResult: any = this.defaultResult;
     decodeResult.decoder.name = this.name;
     decodeResult.formatted.description = 'Position Report';