Merge pull request #39 from dfpc-coe/basemaps

Basemap XML Parsing

README.md

@@ -1,14 +1,19 @@
 <h1 align=center>Node-CoT</h1>
 
-<p align=center>Javascript Cursor-On-Target Library</p>
+<p align=center>Typescript/Javascript Cursor-On-Target Library</p>
 
-Lightweight JavaScript library for parsing and manipulating TAK related messages, primarily [Cursor-on-Target (COT)](https://git.tak.gov/standards/takcot)
+Lightweight Typescript library for parsing and manipulating TAK related messages, primarily [Cursor-on-Target (COT)](https://git.tak.gov/standards/takcot)
 
 ## About
 
-`node-cot` converts between TAK message protocols and a Javascript object/JSON format.
+`node-cot` converts between TAK message protocols (XML & Protobuf) and a Javascript object/JSON format.
 It also can bidirectionally convert CoT messages into [GeoJSON](https://geojson.org/)
 
+It also support creating and parsing the following TAK Data Types
+
+- Data Packages (CoTs, Attachments, etc)
+- Basemap XML Documents
+
 ## Installation
 
 ### NPM

index.ts

@@ -1,10 +1,11 @@
 import CoT from './lib/cot.js';
-export * as Feature from './lib/feature.js'
-export * as Types from './lib/types.js'
-export * as CoTTypes from './lib/cot-types.js'
+export * as Feature from './lib/types/feature.js'
+export * as Types from './lib/types/types.js'
+export * as CoTTypes from './lib/types/cot-types.js'
 export * from './lib/chat.js'
 export * from './lib/fileshare.js'
 export * from './lib/force-delete.js'
 export * from './lib/data-package.js'
+export * from './lib/basemap.js'
 
 export default CoT;

lib/basemap.ts

@@ -0,0 +1,36 @@
+import type { Static } from '@sinclair/typebox'
+import Err from '@openaddresses/batch-error';
+import BasemapType from './types/basemap.js';
+import xmljs from 'xml-js';
+import AJV from 'ajv';
+
+const checkBasemap = (new AJV({
+    allErrors: true,
+    coerceTypes: true,
+    allowUnionTypes: true
+}))
+    .compile(BasemapType);
+
+/**
+ * Helper class for creating and parsing Basemap XML documents
+ */
+export class Basemap {
+    basemap: Static<typeof BasemapType>;
+
+    constructor(basemap: Static<typeof BasemapType>) {
+        this.basemap = basemap;
+    }
+
+    /**
+     * Return a Basemap from a string XML representation
+     */
+    static async parse(input: string): Promise<Basemap> {
+        const xml = xmljs.xml2js(input, { compact: true })
+
+        checkBasemap(xml);
+        if (checkBasemap.errors) throw new Err(400, null, `${checkBasemap.errors[0].message} (${checkBasemap.errors[0].instancePath})`);
+        const basemap = xml as Static<typeof BasemapType>;
+
+        return new Basemap(basemap);
+    }
+}

lib/chat.ts

@@ -1,6 +1,6 @@
-import Util from './util.js'
+import Util from './utils/util.js'
 import CoT from './cot.js';
-import type JSONCoT from './types.js';
+import type JSONCoT from './types/types.js';
 import type { Static } from '@sinclair/typebox';
 import { randomUUID } from 'node:crypto';
 

lib/cot.ts

@@ -8,18 +8,18 @@ import type {
     Polygon,
     FeaturePropertyMission,
     FeaturePropertyMissionLayer,
-} from './feature.js';
+} from './types/feature.js';
 import {
     InputFeature,
-} from './feature.js';
+} from './types/feature.js';
 import type { AllGeoJSON } from "@turf/helpers";
 import PointOnFeature from '@turf/point-on-feature';
 import Truncate from '@turf/truncate';
 import Ellipse from '@turf/ellipse';
-import Util from './util.js';
-import Color from './color.js';
-import JSONCoT, { Detail } from './types.js'
-import type { MartiDest, MartiDestAttributes, Link, LinkAttributes } from './types.js'
+import Util from './utils/util.js';
+import Color from './utils/color.js';
+import JSONCoT, { Detail } from './types/types.js'
+import type { MartiDest, MartiDestAttributes, Link, LinkAttributes } from './types/types.js'
 import AJV from 'ajv';
 import fs from 'fs';
 

lib/fileshare.ts

@@ -1,7 +1,7 @@
-import Util from './util.js'
+import Util from './utils/util.js'
 import CoT from './cot.js';
-import type JSONCoT from './types.js';
-import type { FileShareAttributes } from './types.js';
+import type JSONCoT from './types/types.js';
+import type { FileShareAttributes } from './types/types.js';
 import type { Static } from '@sinclair/typebox';
 
 export class FileShare extends CoT {

lib/force-delete.ts

@@ -1,6 +1,6 @@
-import Util from './util.js'
+import Util from './utils/util.js'
 import CoT from './cot.js';
-import type JSONCoT from './types.js';
+import type JSONCoT from './types/types.js';
 import type { Static } from '@sinclair/typebox';
 
 export class ForceDelete extends CoT {

lib/types/basemap.ts

@@ -0,0 +1,29 @@
+import { Type } from '@sinclair/typebox';
+
+export const BasemapMapSource = Type.Object({
+    name: Type.Object({
+        _text: Type.String()
+    }),
+    minZoom: Type.Object({
+        _text: Type.Integer()
+    }),
+    maxZoom: Type.Object({
+        _text: Type.Integer()
+    }),
+    tileType: Type.Object({
+        _text: Type.String()
+    }),
+    tileUpdate: Type.Optional(Type.Object({
+        _text: Type.String()
+    })),
+    url: Type.Optional(Type.Object({
+        _text: Type.String()
+    })),
+    backgroundColor: Type.Optional(Type.Object({
+        _text: Type.String()
+    })),
+})
+
+export default Type.Object({
+    customMapSource: BasemapMapSource
+})

lib/util.ts → lib/utils/util.ts

@@ -5,7 +5,7 @@ import type {
     TrackAttributes,
     Detail,
     Point
-} from './types.js';
+} from '../types/types.js';
 
 /**
  * Helper functions for generating CoT data