@tak-ps/node-cot 3.5.4 → 4.1.0

package/lib/{xml.ts → cot.ts}

@@ -80,14 +80,14 @@ export interface JSONCoT {
  *
  * @prop raw Raw XML-JS representation of CoT
  */
-export default class XMLCot {
+export default class CoT {
     raw: JSONCoT;
 
     constructor(cot: Buffer | JSONCoT | string) {
         if (typeof cot === 'string' || cot instanceof Buffer) {
             if (cot instanceof Buffer) cot = String(cot);
 
-            const raw: any = xmljs.xml2js(cot, { compact: true });
+            const raw = xmljs.xml2js(cot, { compact: true });
             this.raw = raw as JSONCoT;
         } else {
             this.raw = cot;
@@ -100,11 +100,11 @@ export default class XMLCot {
     }
 
     /**
-     * Return an XMLCot Message
+     * Return an CoT Message
      *
      * @param {Object} feature GeoJSON Point Feature
      *
-     * @return {XMLCot}
+     * @return {CoT}
      */
     static from_geojson(feature: Feature) {
         if (feature.type !== 'Feature') throw new Error('Must be GeoJSON Feature');
@@ -141,6 +141,8 @@ export default class XMLCot {
             }
         }
 
+        cot.event.detail.remarks = { _attributes: { }, _text: feature.properties.remarks || '' };
+
         if (!feature.geometry) throw new Error('Must have Geometry');
         if (!['Point', 'Polygon', 'LineString'].includes(feature.geometry.type)) throw new Error('Unsupported Geometry Type');
 
@@ -192,14 +194,12 @@ export default class XMLCot {
             cot.event.detail.labels_on = { _attributes: { value: 'false' } };
             cot.event.detail.tog = { _attributes: { enabled: '0' } };
 
-            cot.event.detail.remarks = { _attributes: { }, _text: feature.properties.remarks || '' };
-
             const centre = PointOnFeature(feature as AllGeoJSON);
             cot.event.point._attributes.lon = String(centre.geometry.coordinates[0]);
             cot.event.point._attributes.lat = String(centre.geometry.coordinates[1]);
         }
 
-        return new XMLCot(cot);
+        return new CoT(cot);
     }
 
     /**
@@ -220,7 +220,7 @@ export default class XMLCot {
                 how: raw.event._attributes.how,
                 time: raw.event._attributes.time,
                 start: raw.event._attributes.start,
-                stale: raw.event._attributes.stale
+                stale: raw.event._attributes.stale,
             },
             geometry: {
                 type: 'Point',
@@ -232,22 +232,33 @@ export default class XMLCot {
             }
         };
 
+        if (!geojson.properties) geojson.properties = {};
+
+        if (raw.event.detail.remarks && raw.event.detail.remarks._text) {
+            geojson.properties.remarks = raw.event.detail.remarks._text;
+        }
+
+        if (raw.event.detail.track && raw.event.detail.track._attributes) {
+            if (raw.event.detail.track._attributes.course) geojson.properties.course = Number(raw.event.detail.track._attributes.course);
+            if (raw.event.detail.track._attributes.course) geojson.properties.speed = Number(raw.event.detail.track._attributes.speed);
+        }
+
+        if (raw.event.detail.usericon && raw.event.detail.usericon._attributes && raw.event.detail.usericon._attributes.iconsetpath) {
+            geojson.properties.icon = raw.event.detail.usericon._attributes.iconsetpath;
+        }
+
         return geojson;
     }
 
-    to_xml() {
-        return xmljs.js2xml(this.raw, {
-            compact: true
-        });
+    to_xml(): string {
+        return xmljs.js2xml(this.raw, { compact: true });
     }
 
     /**
      * Return a CoT Message
-     *
-     * @returns {XMLCot}
      */
-    static ping() {
-        return new XMLCot({
+    static ping(): CoT {
+        return new CoT({
             event: {
                 _attributes: Util.cot_event_attr('t-x-c-t', 'h-g-i-g-o'),
                 detail: {},
@@ -255,4 +266,166 @@ export default class XMLCot {
             }
         });
     }
+
+    /**
+     * Determines if the CoT message represents a Friendly Element
+     *
+     * @return {boolean}
+     */
+    is_friend(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-f-/)
+    }
+
+    /**
+     * Determines if the CoT message represents a Hostile Element
+     *
+     * @return {boolean}
+     */
+    is_hostile(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-h-/)
+    }
+
+    /**
+     * Determines if the CoT message represents a Unknown Element
+     *
+     * @return {boolean}
+     */
+    is_unknown(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-u-/)
+    }
+
+    /**
+     * Determines if the CoT message represents a Pending Element
+     *
+     * @return {boolean}
+     */
+    is_pending(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-p-/)
+    }
+
+    /**
+     * Determines if the CoT message represents an Assumed Element
+     *
+     * @return {boolean}
+     */
+    is_assumed(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-a-/)
+    }
+
+    /**
+     * Determines if the CoT message represents a Neutral Element
+     *
+     * @return {boolean}
+     */
+    is_neutral(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-n-/)
+    }
+
+    /**
+     * Determines if the CoT message represents a Suspect Element
+     *
+     * @return {boolean}
+     */
+    is_suspect(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-s-/)
+    }
+
+    /**
+     * Determines if the CoT message represents a Joker Element
+     *
+     * @return {boolean}
+     */
+    is_joker(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-j-/)
+    }
+
+    /**
+     * Determines if the CoT message represents a Faker Element
+     *
+     * @return {boolean}
+     */
+    is_faker(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-k-/)
+    }
+
+    /**
+     * Determines if the CoT message represents an Element
+     *
+     * @return {boolean}
+     */
+    is_atom(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-/)
+    }
+
+    /**
+     * Determines if the CoT message represents an Airborne Element
+     *
+     * @return {boolean}
+     */
+    is_airborne(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-.-A/)
+    }
+
+    /**
+     * Determines if the CoT message represents a Ground Element
+     *
+     * @return {boolean}
+     */
+    is_ground(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-.-G/)
+    }
+
+    /**
+     * Determines if the CoT message represents an Installation
+     *
+     * @return {boolean}
+     */
+    is_installation(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-.-G-I/)
+    }
+
+    /**
+     * Determines if the CoT message represents a Vehicle
+     *
+     * @return {boolean}
+     */
+    is_vehicle(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-.-G-E-V/)
+    }
+
+    /**
+     * Determines if the CoT message represents Equipment
+     *
+     * @return {boolean}
+     */
+    is_equipment(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-.-G-E/)
+    }
+
+    /**
+     * Determines if the CoT message represents a Surface Element
+     *
+     * @return {boolean}
+     */
+    is_surface(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-.-S/)
+    }
+
+    /**
+     * Determines if the CoT message represents a Subsurface Element
+     *
+     * @return {boolean}
+     */
+    is_subsurface(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-.-U/)
+    }
+
+    /**
+     * Determines if the CoT message represents a UAV Element
+     *
+     * @return {boolean}
+     */
+    is_uav(): boolean {
+        return !!this.raw.event._attributes.type.match(/^a-f-A-M-F-Q-r/)
+    }
 }

package/lib/util.ts

@@ -4,7 +4,7 @@ import type {
     TrackAttributes,
     Detail,
     Point
-} from './xml.js';
+} from './cot.js';
 
 /**
  * Helper functions for generating CoT data
@@ -120,7 +120,7 @@ export default class Util {
                 start: (new Date(start || now)).toISOString(),
                 stale: (new Date(new Date(start || now).getTime() + 20 * 1000)).toISOString()
             };
-        } else if (!isNaN(parseInt(String(stale)))) {
+        } else if (typeof stale === 'number') {
             return {
                 time: (new Date(time || now)).toISOString(),
                 start: (new Date(start || now)).toISOString(),

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@tak-ps/node-cot",
     "type": "module",
-    "version": "3.5.4",
+    "version": "4.1.0",
     "description": "Lightweight JavaScript library for parsing and manipulating TAK messages",
     "author": "Nick Ingalls <nick@ingalls.ca>",
     "main": "dist/index.js",

package/test/cot-itak.test.ts

@@ -0,0 +1,65 @@
+import test from 'tape';
+import CoT from '../index.js';
+
+test('Decode iTAK COT message', (t) => {
+    const packet = '<event version="2.0" uid="C94B9215-9BD4-4DBE-BDE1-83625F09153F" type="a-f-G-E-V-C" time="2023-07-18T15:23:09.00Z" start="2023-07-18T15:23:09.00Z" stale="2023-07-18T15:25:09.00Z" how="m-g"><point lat="41.52309645" lon="-107.72376567" hae="1681.23725821" ce="9999999" le="9999999" /><detail><contact callsign="DFPC-iSchmidt" phone="7204258729" endpoint="*:-1:stcp" /><uid Droid="DFPC-iSchmidt" /><__group name="Yellow" role="Team Member" /><precisionlocation geopointsrc="GPS" altsrc="???" /><status battery="100" /><takv device="iPhone" platform="iTAK" os="16.5.1" version="2.7.0.609" /><track speed="0.00000000" course="137.23542786" /></detail></event>';
+
+    t.deepEquals((new CoT(packet)).raw, {
+        'event': {
+            '_attributes': {
+                'version': '2.0',
+                'uid': 'C94B9215-9BD4-4DBE-BDE1-83625F09153F',
+                'type': 'a-f-G-E-V-C',
+                'time': '2023-07-18T15:23:09.00Z',
+                'start': '2023-07-18T15:23:09.00Z',
+                'stale': '2023-07-18T15:25:09.00Z',
+                'how': 'm-g',
+            },
+            'point': {
+                '_attributes': {
+                    'lat': '41.52309645',
+                    'lon': '-107.72376567',
+                    'hae': '1681.23725821',
+                    'ce': '9999999',
+                    'le': '9999999'
+                }
+            },
+            detail: {
+                contact: {
+                    _attributes: {
+                        callsign: 'DFPC-iSchmidt',
+                        phone: '7204258729',
+                        endpoint: '*:-1:stcp'
+                    }
+                },
+                uid: { _attributes: { Droid: 'DFPC-iSchmidt' } },
+                __group: { _attributes: { name: 'Yellow', role: 'Team Member' } },
+                precisionlocation: { _attributes: { geopointsrc: 'GPS', altsrc: '???' } },
+                status: { _attributes: { battery: '100' } },
+                takv: { _attributes: { device: 'iPhone', platform: 'iTAK', os: '16.5.1', version: '2.7.0.609' } },
+                track: { _attributes: { speed: '0.00000000', course: '137.23542786' } } 
+            }
+        }
+    });
+
+    t.deepEquals((new CoT(packet)).to_geojson(), {
+        id: 'C94B9215-9BD4-4DBE-BDE1-83625F09153F',
+        type: 'Feature',
+        properties: {
+            callsign: 'DFPC-iSchmidt',
+            type: 'a-f-G-E-V-C',
+            how: 'm-g',
+            time: '2023-07-18T15:23:09.00Z',
+            start: '2023-07-18T15:23:09.00Z',
+            stale: '2023-07-18T15:25:09.00Z',
+            course: 137.23542786,
+            speed: 0
+        },
+        geometry: {
+            type: 'Point',
+            coordinates: [ -107.72376567, 41.52309645, 1681.23725821 ] 
+        }
+    });
+
+    t.end();
+});

package/test/cot.test.ts

@@ -1,10 +1,10 @@
 import test from 'tape';
-import { XML } from '../index.js';
+import CoT from '../index.js';
 
 test('Decode COT message', (t) => {
     const packet = '<event version="2.0" uid="ANDROID-deadbeef" type="a-f-G-U-C" how="m-g" time="2021-02-27T20:32:24.771Z" start="2021-02-27T20:32:24.771Z" stale="2021-02-27T20:38:39.771Z"><point lat="1.234567" lon="-3.141592" hae="-25.7" ce="9.9" le="9999999.0"/><detail><takv os="29" version="4.0.0.0 (deadbeef).1234567890-CIV" device="Some Android Device" platform="ATAK-CIV"/><contact xmppUsername="xmpp@host.com" endpoint="*:-1:stcp" callsign="JENNY"/><uid Droid="JENNY"/><precisionlocation altsrc="GPS" geopointsrc="GPS"/><__group role="Team Member" name="Cyan"/><status battery="78"/><track course="80.24833892285461" speed="0.0"/></detail></event>';
 
-    t.deepEquals((new XML(packet)).raw, {
+    t.deepEquals((new CoT(packet)).raw, {
         'event': {
             '_attributes': {
                 'version': '2.0',
@@ -55,7 +55,7 @@ test('Decode COT message', (t) => {
 test('Decode COT message', (t) => {
     const packet = '<event version="2.0" uid="TEST-deadbeef" type="a" how="m-g" time="2021-03-12T15:49:07.138Z" start="2021-03-12T15:49:07.138Z" stale="2021-03-12T15:49:07.138Z"><point lat="0.000000" lon="0.000000" hae="0.0" ce="9999999.0" le="9999999.0"/><detail><takv os="Android" version="10" device="Some Device" platform="python unittest"/><status battery="83"/><uid Droid="JENNY"/><contact callsign="JENNY" endpoint="*:-1:stcp" phone="800-867-5309"/><__group role="Team Member" name="Cyan"/><track course="90.1" speed="10.3"/></detail></event>';
 
-    t.deepEquals((new XML(packet)).raw, {
+    t.deepEquals((new CoT(packet)).raw, {
         'event': {
             '_attributes': {
                 'version': '2.0',
@@ -167,7 +167,7 @@ test('Encode COT message', (t) => {
     };
 
     t.deepEquals(
-        (new XML(packet)).to_xml(),
+        (new CoT(packet)).to_xml(),
         '<event version="2.0" uid="ANDROID-deadbeef" type="a-f-G-U-C" how="m-g" time="2021-02-27T20:32:24.771Z" start="2021-02-27T20:32:24.771Z" stale="2021-02-27T20:38:39.771Z"><point lat="1.234567" lon="-3.141592" hae="-25.7" ce="9.9" le="9999999"/><detail><takv os="29" version="4.0.0.0 (deadbeef).1234567890-CIV" device="Some Android Device" platform="ATAK-CIV"/><contact xmppUsername="xmpp@host.com" endpoint="*:-1:stcp" callsign="JENNY"/><uid Droid="JENNY"/><precisionlocation altsrc="GPS" geopointsrc="GPS"/><__group role="Team Member" name="Cyan"/><status battery="78"/><track course="80.24833892285461" speed="0.0"/></detail></event>'
     );
 
@@ -190,7 +190,7 @@ test('Parse GeoChat message', (t) => {
         '  </detail>\n' +
         '</event>';
 
-    t.deepEquals((new XML(geochat)).raw, {
+    t.deepEquals((new CoT(geochat)).raw, {
         'event': {
             '_attributes': {
                 'version': '2.0',