@tak-ps/node-cot 5.4.0 → 5.5.1

package/lib/types.ts

@@ -1,177 +1,184 @@
-export interface EventAttributes {
-    version: string,
-    uid: string;
-    type: string;
-    how: string;
-    [k: string]: string;
-}
-
-export interface GenericAttributes {
-    _attributes: {
-        [k: string]: string;
-    }
-}
-
-export interface Track {
-    _attributes: TrackAttributes;
-}
-
-export interface Chat {
-    _attributes: {
-        parent?: string;
-        groupOwner?: string;
-        messageId?: string;
-        chatroom: string;
-        id: string;
-        senderCallsign: string;
-        [k: string]: string | undefined;
-    }
-
-    chatgrp: GenericAttributes
-}
-
-export interface TrackAttributes {
-    speed?: string,
-    course?: string,
-    slope?: string;
-    eCourse?: string;
-    eSpeed?: string;
-    eSlope?: string
-    [k: string]: string | undefined
-}
-
-export interface TakVersion {
-    _attributes: {
-        device?: string;
-        platform?: string;
-        os?: string;
-        version?: string;
-        [k: string]: string | undefined
-    }
-}
-
-export interface FlowTags {
-    _attributes?: {
-        [k: string]: string
-    }
-    [k: string]: string | undefined | object;
-}
-
-export interface Group {
-    _attributes?: {
-        name: string;
-        role: string;
-        [k: string]: string;
-    }
-}
-
-export interface Status {
-    _attributes: {
-        [k: string]: string;
-    }
-}
-
-export interface Uid {
-    _attributes: {
-        Droid: string;
-        [k: string]: string;
-    }
-}
-
-export interface Contact {
-    _attributes: {
-        phone?: string;
-        callsign: string;
-        endpoint?: string;
-        [k: string]: string | undefined;
-    }
-}
-
-export interface Marti {
-    _attributes?: {
-        [k: string]: string | undefined;
-    }
-
-    dest?: MartiDest | MartiDest[]
-}
-
-export interface MartiDest {
-    _attributes: {
-        uid?: string;
-        mission?: string;
-        callsign?: string;
-    }
-}
-
-export interface Remarks {
-    _attributes?: {
-        source?: string;
-        to?: string;
-        time?: string;
-        [k: string]: string | undefined;
-    }
-    _text?: string;
-}
-
-export interface PrecisionLocation {
-    _attributes: {
-        geopointsrc?: string;
-        altsrc?: string;
-        [k: string]: string | undefined;
-    }
-}
-
-export interface UserIcon {
-    _attributes: {
-        iconsetpath: string;
-        [k: string]: string;
-    }
-}
-
-export interface Detail {
-    contact?: Contact;
-    tog?: GenericAttributes;
-    '__group'?: Group;
-    '__chat'?: Chat;
-    '_flow-tags_'?: FlowTags;
-    uid?: Uid;
-    status?: Status;
-    remarks?: Remarks;
-    precisionlocation?: PrecisionLocation;
-    strokeColor?: GenericAttributes;
-    archived?: GenericAttributes;
-    strokeWeight?: GenericAttributes;
-    strokeStyle?: GenericAttributes;
-    labels_on?: GenericAttributes;
-    fillColor?: GenericAttributes;
-    link?: GenericAttributes | GenericAttributes[];
-    usericon?: UserIcon;
-    track?: Track;
-    takv?: TakVersion;
-    marti?: Marti;
-    TakControl?: {
-        TakServerVersionInfo?: GenericAttributes
-    };
-    [k: string]: unknown;
-}
-
-export interface Point {
-    _attributes: {
-        lat: string | number;
-        lon: string | number;
-        hae: string | number;
-        ce: string | number;
-        le: string | number;
-        [k: string]: string | number
-    }
-}
-
-export default interface JSONCoT {
-    event: {
+import { Type } from '@sinclair/typebox';
+
+export const EventAttributes = Type.Object({
+    version: Type.String(),
+    uid: Type.String(),
+    type: Type.String(),
+    how: Type.String(),
+
+    time: Type.String(),
+    stale: Type.String(),
+    start: Type.String(),
+});
+
+export const TogAttributes = Type.Object({
+    _attributes: Type.Optional(Type.Object({
+        enabled: Type.Optional(Type.String())
+    }))
+})
+
+export const LinkAttributes = Type.Object({
+    _attributes: Type.Object({
+        point: Type.Optional(Type.String()),
+
+        uid: Type.Optional(Type.String()),
+        type: Type.Optional(Type.String()),
+        relation: Type.Optional(Type.String()),
+    })
+})
+
+export const ServerVersionAttributes = Type.Object({
+    _attributes: Type.Optional(Type.Object({
+        serverVersion: Type.Optional(Type.String())
+    }))
+})
+
+export const GenericAttributes = Type.Object({
+    _attributes: Type.Optional(Type.Object({
+        value: Type.Optional(Type.String())
+    }))
+})
+
+export const TrackAttributes = Type.Object({
+    speed: Type.Optional(Type.String()),
+    course: Type.Optional(Type.String()),
+    slope: Type.Optional(Type.String()),
+    eCourse: Type.Optional(Type.String()),
+    eSpeed: Type.Optional(Type.String()),
+    eSlope: Type.Optional(Type.String())
+});
+
+
+export const Track = Type.Object({
+    _attributes: TrackAttributes
+})
+
+export const Chat = Type.Object({
+    _attributes: Type.Object({
+        parent: Type.Optional(Type.String()),
+        groupOwner: Type.Optional(Type.String()),
+        messageId: Type.Optional(Type.String()),
+        chatroom: Type.String(),
+        id: Type.String(),
+        senderCallsign: Type.String()
+    }),
+    chatgrp: Type.Any()
+})
+
+export const TakVersion = Type.Object({
+    _attributes: Type.Object({
+        device: Type.Optional(Type.String()),
+        platform: Type.Optional(Type.String()),
+        os: Type.Optional(Type.String()),
+        version: Type.Optional(Type.String())
+    })
+})
+
+export const FlowTags = Type.Any();
+
+export const Group = Type.Object({
+    _attributes: Type.Optional(Type.Object({
+        name: Type.String(),
+        role: Type.String()
+    }))
+})
+
+export const Status = Type.Object({
+    _attributes: Type.Object({
+        battery: Type.Optional(Type.String()),
+        readiness: Type.Optional(Type.String())
+    })
+})
+
+export const Uid = Type.Object({
+    _attributes: Type.Object({
+        Droid: Type.String()
+    })
+})
+
+export const Contact = Type.Object({
+    _attributes: Type.Object({
+        phone: Type.Optional(Type.String()),
+        callsign: Type.String(),
+        endpoint: Type.Optional(Type.String())
+    })
+})
+
+export const MartiDest = Type.Object({
+    _attributes: Type.Object({
+        uid: Type.Optional(Type.String()),
+        mission: Type.Optional(Type.String()),
+        callsign: Type.Optional(Type.String())
+    })
+})
+
+export const Marti = Type.Object({
+    _attributes: Type.Optional(Type.Object({})),
+    dest: Type.Optional(Type.Union([MartiDest, Type.Array(MartiDest)]))
+});
+
+export const Remarks = Type.Object({
+    _attributes: Type.Optional(Type.Object({
+        source: Type.Optional(Type.String()),
+        to: Type.Optional(Type.String()),
+        time: Type.Optional(Type.String())
+    })),
+    _text: Type.Optional(Type.String())
+})
+
+export const PrecisionLocation = Type.Object({
+    _attributes: Type.Object({
+        geopointsrc: Type.Optional(Type.String()),
+        altsrc: Type.Optional(Type.String())
+    })
+})
+
+export const UserIcon = Type.Object({
+    _attributes: Type.Object({
+        iconsetpath: Type.String()
+    })
+})
+
+export const Detail = Type.Object({
+    contact: Type.Optional(Contact),
+    tog: Type.Optional(TogAttributes),
+    '__group': Type.Optional(Group),
+    '__chat': Type.Optional(Chat),
+    '_flow-tags_': Type.Optional(FlowTags),
+    uid: Type.Optional(Uid),
+    status: Type.Optional(Status),
+    remarks: Type.Optional(Remarks),
+    precisionlocation: Type.Optional(PrecisionLocation),
+    strokeColor: Type.Optional(GenericAttributes),
+    archived: Type.Optional(GenericAttributes),
+    strokeWeight: Type.Optional(GenericAttributes),
+    strokeStyle: Type.Optional(GenericAttributes),
+    labels_on: Type.Optional(GenericAttributes),
+    fillColor: Type.Optional(GenericAttributes),
+    link: Type.Optional(Type.Union([LinkAttributes, Type.Array(LinkAttributes)])),
+    usericon: Type.Optional(UserIcon),
+    track: Type.Optional(Track),
+    takv: Type.Optional(TakVersion),
+    marti: Type.Optional(Marti),
+    TakControl: Type.Optional(Type.Object({
+        TakServerVersionInfo: Type.Optional(ServerVersionAttributes)
+    }))
+})
+
+export const Point = Type.Object({
+    _attributes: Type.Object({
+        lat: Type.Union([Type.String(), Type.Number()]),
+        lon: Type.Union([Type.String(), Type.Number()]),
+        hae: Type.Union([Type.String(), Type.Number()]),
+        ce: Type.Union([Type.String(), Type.Number()]),
+        le: Type.Union([Type.String(), Type.Number()]),
+    })
+})
+
+export default Type.Object({
+    event: Type.Object({
         _attributes: EventAttributes,
-        detail?: Detail,
+        detail: Type.Optional(Detail),
         point: Point,
-        [k: string]: unknown
-    },
-    [k: string]: unknown
-}
+    }),
+})

package/lib/util.ts

@@ -1,5 +1,6 @@
 import { randomUUID } from 'crypto'
-import type {
+import { Static } from '@sinclair/typebox';
+import {
     EventAttributes,
     TrackAttributes,
     Detail,
@@ -26,7 +27,7 @@ export default class Util {
         time?: Date | string | null,
         start?: Date | string | null,
         stale?: Date | string | number | null
-    ): EventAttributes {
+    ): Static<typeof EventAttributes> {
         if (!type) throw new Error('type param required');
         if (!how) throw new Error('how param required');
 
@@ -44,7 +45,7 @@ export default class Util {
      *
      * @param [callsign=UNKNOWN] Display Callsign
      */
-    static cot_event_detail(callsign = 'UNKNOWN'): Detail {
+    static cot_event_detail(callsign = 'UNKNOWN'): Static<typeof Detail> {
         return {
             contact: {
                 _attributes: { callsign }
@@ -58,7 +59,7 @@ export default class Util {
      * @param [course] Speed in degrees from north
      * @param [speed=0] Speed in m/s
      */
-    static cot_track_attr(course: number, speed = 0): TrackAttributes {
+    static cot_track_attr(course: number, speed = 0): Static<typeof TrackAttributes> {
         return {
             course: String(course || 0),
             speed: String(speed || 0)
@@ -82,7 +83,7 @@ export default class Util {
     /**
      * Generate Null Island CoT point object
      */
-    static cot_point(): Point {
+    static cot_point(): Static<typeof Point> {
         return {
             '_attributes': {
                 'lat': '0.000000',

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@tak-ps/node-cot",
     "type": "module",
-    "version": "5.4.0",
+    "version": "5.5.1",
     "description": "Lightweight JavaScript library for parsing and manipulating TAK messages",
     "author": "Nick Ingalls <nick@ingalls.ca>",
     "main": "dist/index.js",
@@ -10,10 +10,11 @@
         "test": "ts-node-test test/",
         "lint": "eslint *.ts lib/*.ts",
         "doc": "typedoc index.ts",
-        "build": "typescript-json-schema --required --out ./lib/schema.json ./lib/types.ts JSONCoT && tsc --build && cp package.json dist/",
+        "build": "tsc --build && cp package.json dist/",
         "pretest": "npm run lint"
     },
     "dependencies": {
+        "@sinclair/typebox": "^0.32.20",
         "@turf/helpers": "^6.5.0",
         "@turf/point-on-feature": "^6.5.0",
         "@types/color": "^3.0.3",
@@ -34,8 +35,7 @@
         "ts-node": "^10.9.1",
         "ts-node-test": "^0.4.0",
         "typedoc": "^0.25.0",
-        "typescript": "^5.0.0",
-        "typescript-json-schema": "^0.62.0"
+        "typescript": "^5.0.0"
     },
     "repository": {
         "type": "git",

package/test/chat.test.ts

@@ -25,10 +25,12 @@ test('DirectChat - Basic', (t) => {
         t.ok(cot.raw.event.detail['_flow-tags_']);
         delete cot.raw.event.detail['_flow-tags_'];
 
-        for (const i of ['time', 'start', 'stale']) {
-            t.equals(typeof cot.raw.event._attributes[i], 'string');
-            delete cot.raw.event._attributes[i];
-        }
+        t.equals(typeof cot.raw.event._attributes.time, 'string');
+        cot.raw.event._attributes.time = '2024-04-01'
+        t.equals(typeof cot.raw.event._attributes.start, 'string');
+        cot.raw.event._attributes.start = '2024-04-01'
+        t.equals(typeof cot.raw.event._attributes.stale, 'string');
+        cot.raw.event._attributes.stale = '2024-04-01'
 
         if (!cot.raw.event.detail.__chat) {
             t.fail('No Detail Section')
@@ -51,6 +53,10 @@ test('DirectChat - Basic', (t) => {
                     version: '2.0',
                     type: 'b-t-f',
                     how: 'h-g-i-g-o',
+
+                    time: '2024-04-01',
+                    stale: '2024-04-01',
+                    start: '2024-04-01'
                 },
                 point: {
                     _attributes: { lat: '0.000000', lon: '0.000000', hae: '0.0', ce: '9999999.0', le: '9999999.0' }