@tak-ps/node-cot 2.2.0 → 2.3.0

package/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Test
+
+on:
+    pull_request:
+        types:
+            - opened
+            - synchronize
+            - reopened
+            - ready_for_review
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+        if: github.event.pull_request.draft == false
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  ref: ${{ github.event.pull_request.head.sha }}
+
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 18
+                  registry-url: https://registry.npmjs.org/
+
+            - name: Install
+              run: npm install
+
+            - name: Test
+              run: npm test
+
+            - name: Lint
+              run: npm run lint

package/CHANGELOG.md

@@ -10,6 +10,14 @@
 
 ## Version History
 
+### v2.3.0
+
+- :tada: `from_geojson(Feature.Polygon)` Support
+
+### v2.2.1
+
+- :bug: `event.display` => `event.detail`
+
 ### v2.2.0
 
 - :bug: Bugfixes in default values

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@tak-ps/node-cot",
     "type": "module",
-    "version": "2.2.0",
+    "version": "2.3.0",
     "description": "Lightweight JavaScript library for parsing and manipulating TAK messages",
     "main": "index.js",
     "scripts": {
@@ -9,6 +9,7 @@
         "lint": "eslint *.js src/*.js test/*.js"
     },
     "dependencies": {
+        "@turf/point-on-feature": "^6.5.0",
         "protobufjs": "^7.1.2",
         "uuid": "^9.0.0",
         "xml-js": "^1.6.11"

package/src/util.js

@@ -27,13 +27,13 @@ export default class Util {
     }
 
     /**
-     * Return an event.display object with as many defaults as possible
+     * Return an event.detail object with as many defaults as possible
      *
      * @param {String} [callsign=UNKNOWN] Display Callsign
      *
      * @returns {Object}
      */
-    static cot_event_display(callsign = 'UNKNOWN') {
+    static cot_event_detail(callsign = 'UNKNOWN') {
         return {
             contact: {
                 _attributes: { callsign }

package/src/xml.js

@@ -1,5 +1,6 @@
 import xmljs from 'xml-js';
 import Util from './util.js';
+import PointOnFeature from '@turf/point-on-feature';
 
 /**
  * Convert to and from an XML CoT message
@@ -20,9 +21,9 @@ export default class XMLCot {
         }
 
         // Attempt to cast all point to numerics
-        for (const key of Object.keys(this.raw.event.point)) {
-            if (!isNaN(parseFloat(this.raw.event.point[key]))) {
-                this.raw.event.point[key] = parseFloat(this.raw.event.point[key]);
+        for (const key of Object.keys(this.raw.event.point._attributes)) {
+            if (!isNaN(parseFloat(this.raw.event.point._attributes[key]))) {
+                this.raw.event.point._attributes[key] = parseFloat(this.raw.event.point._attributes[key]);
             }
         }
     }
@@ -36,14 +37,13 @@ export default class XMLCot {
      */
     static from_geojson(feature) {
         if (feature.type !== 'Feature') throw new Error('Must be GeoJSON Feature');
-        if (!feature.geometry || feature.geometry.type !== 'Point') throw new Error('Must be GeoJSON Point Feature');
         if (!feature.properties) throw new Error('Feature must have properties');
 
         const cot = {
             event: {
                 _attributes: Util.cot_event_attr(feature.properties.type || 'a-f-G', feature.properties.how || 'm-g'),
                 point: Util.cot_point(),
-                display: Util.cot_event_display(feature.properties.callsign)
+                detail: Util.cot_event_detail(feature.properties.callsign)
             }
         };
 
@@ -54,8 +54,36 @@ export default class XMLCot {
             if (feature.properties[key]) cot.event._attributes[key] = feature.properties[key];
         }
 
-        cot.event.point._attributes.lon = feature.geometry.coordinates[0];
-        cot.event.point._attributes.lat = feature.geometry.coordinates[1];
+        if (!feature.geometry) throw new Error('Must have Geometry');
+        if (!['Point', 'Polygon'].includes(feature.geometry.type)) throw new Error('Unsupported Geoemtry Type');
+
+        if (feature.geometry.type === 'Point') {
+            cot.event.point._attributes.lon = feature.geometry.coordinates[0];
+            cot.event.point._attributes.lat = feature.geometry.coordinates[1];
+        } else if (feature.geometry.type === 'Polygon') {
+            // Inner rings are not yet supported
+
+            cot.event.detail.link = [];
+            feature.geometry.coordinates[0].pop(); // Dont' Close Loop in COT
+            for (const coord of feature.geometry.coordinates[0]) {
+                cot.event.detail.link.push({
+                    _attributes: {
+                        point: `${coord[1]},${coord[0]}`
+                    }
+                });
+            }
+
+            cot.event.detail.labels_on = { _attributes: { value: 'false' } };
+            cot.event.detail.tog = { _attributes: { enabled: '0' } };
+            cot.event.detail.strokeColor = { _attributes: { value: '-256' } };
+            cot.event.detail.strokeWeight = { _attributes: { value: '3.0' } };
+            cot.event.detail.strokeStyle = { _attributes: { value: 'solid' } };
+            cot.event.detail.fillColor = { _attributes: { value: '-1761607936' } };
+
+            const centre = PointOnFeature(feature);
+            cot.event.point._attributes.lon = centre.geometry.coordinates[0];
+            cot.event.point._attributes.lat = centre.geometry.coordinates[1];
+        }
 
         return new XMLCot(cot);
     }

package/test/cot.test.js

@@ -17,11 +17,11 @@ test('Decode COT message', (t) => {
             },
             'point': {
                 '_attributes': {
-                    'lat': '1.234567',
-                    'lon': '-3.141592',
-                    'hae': '-25.7',
-                    'ce': '9.9',
-                    'le': '9999999.0'
+                    'lat': 1.234567,
+                    'lon': -3.141592,
+                    'hae': -25.7,
+                    'ce': 9.9,
+                    'le': 9999999.0
                 }
             },
             'detail': {
@@ -68,11 +68,11 @@ test('Decode COT message', (t) => {
             },
             'point': {
                 '_attributes': {
-                    'lat': '0.000000',
-                    'lon': '0.000000',
-                    'hae': '0.0',
-                    'ce': '9999999.0',
-                    'le': '9999999.0'
+                    'lat': 0.000000,
+                    'lon': 0.000000,
+                    'hae': 0.0,
+                    'ce': 9999999.0,
+                    'le': 9999999.0
                 }
             },
             'detail': {
@@ -134,11 +134,11 @@ test('Encode COT message', (t) => {
             },
             'point': {
                 '_attributes': {
-                    'lat': '1.234567',
-                    'lon': '-3.141592',
-                    'hae': '-25.7',
-                    'ce': '9.9',
-                    'le': '9999999.0'
+                    'lat': 1.234567,
+                    'lon': -3.141592,
+                    'hae': -25.7,
+                    'ce': 9.9,
+                    'le': 9999999
                 }
             },
             'detail': {
@@ -168,7 +168,7 @@ test('Encode COT message', (t) => {
 
     t.deepEquals(
         (new XML(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.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>'
+        '<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>'
     );
 
     t.end();
@@ -203,11 +203,11 @@ test('Parse GeoChat message', (t) => {
             },
             'point': {
                 '_attributes': {
-                    'lat': '1.234567',
-                    'lon': '-3.141592',
-                    'hae': '-25.8',
-                    'ce': '9.9',
-                    'le': '9999999.0'
+                    'lat': 1.234567,
+                    'lon': -3.141592,
+                    'hae': -25.8,
+                    'ce': 9.9,
+                    'le': 9999999
                 }
             },
             'detail': {

package/test/from_geojson.test.js

@@ -0,0 +1,78 @@
+import test from 'tape';
+import { XML } from '../index.js';
+
+test('XML.from_geojson - point', (t) => {
+    const geo = XML.from_geojson({
+        type: 'Feature',
+        properties: {},
+        geometry: {
+            type: 'Point',
+            coordinates: [1.1, 2.2]
+        }
+    });
+
+    t.equals(geo.raw.event._attributes.version, '2.0');
+    t.equals(geo.raw.event._attributes.type, 'a-f-G');
+    t.equals(geo.raw.event._attributes.how, 'm-g');
+    t.equals(geo.raw.event._attributes.uid.length, 36);
+    t.equals(geo.raw.event._attributes.time.length, 24);
+    t.equals(geo.raw.event._attributes.start.length, 24);
+    t.equals(geo.raw.event._attributes.stale.length, 24);
+
+    t.deepEquals(geo.raw.event.point, {
+        _attributes: { lat: 2.2, lon: 1.1, hae: 0, ce: 9999999, le: 9999999 }
+    });
+
+    t.deepEquals(geo.raw.event.detail, {
+        contact: { _attributes: { callsign: 'UNKNOWN' } }
+    });
+
+    t.end();
+});
+
+test('XML.from_geojson - polygon', (t) => {
+    const geo = XML.from_geojson({
+        type: 'Feature',
+        properties: {},
+        geometry: {
+            type: 'Polygon',
+            coordinates: [[
+                [-108.587, 39.098],
+                [-108.587, 39.032],
+                [-108.505, 39.032],
+                [-108.505, 39.098],
+                [-108.587, 39.098]
+            ]]
+        }
+    });
+
+    t.equals(geo.raw.event._attributes.version, '2.0');
+    t.equals(geo.raw.event._attributes.type, 'a-f-G');
+    t.equals(geo.raw.event._attributes.how, 'm-g');
+    t.equals(geo.raw.event._attributes.uid.length, 36);
+    t.equals(geo.raw.event._attributes.time.length, 24);
+    t.equals(geo.raw.event._attributes.start.length, 24);
+    t.equals(geo.raw.event._attributes.stale.length, 24);
+
+    t.deepEquals(geo.raw.event.point, {
+        _attributes: { lat: 39.065, lon: -108.54599999999999, hae: 0, ce: 9999999, le: 9999999 }
+    });
+
+    t.deepEquals(geo.raw.event.detail, {
+        contact: { _attributes: { callsign: 'UNKNOWN' } },
+        link: [
+            { _attributes: { point: '39.098,-108.587' } },
+            { _attributes: { point: '39.032,-108.587' } },
+            { _attributes: { point: '39.032,-108.505' } },
+            { _attributes: { point: '39.098,-108.505' } }
+        ],
+        labels_on: { _attributes: { value: 'false' } },
+        tog: { _attributes: { enabled: '0' } },
+        strokeColor: { _attributes: { value: '-256' } },
+        strokeWeight: { _attributes: { value: '3.0' } },
+        strokeStyle: { _attributes: { value: 'solid' } },
+        fillColor: { _attributes: { value: '-1761607936' } }
+    });
+
+    t.end();
+});