Merge pull request #70 from dfpc-coe/creator-milsym

Creator & MilSym Support

Author: ingalls

lib/cot.ts

@@ -16,6 +16,7 @@ import type {
     MartiDestAttributes,
     Link,
     LinkAttributes,
+    CreatorAttributes,
     VideoAttributes,
     SensorAttributes,
     VideoConnectionEntryAttributes,
@@ -77,7 +78,17 @@ export default class CoT {
     // Does the CoT belong to a folder - defaults to "/"
     path: string;
 
-    constructor(cot: Buffer | Static<typeof JSONCoT> | object | string) {
+    constructor(
+        cot: Buffer | Static<typeof JSONCoT> | object | string,
+        opts: {
+            creator?: CoT | {
+                uid: string,
+                type: string,
+                callsign: string,
+                time?: Date | string,
+            }
+        } = {}
+    ) {
         if (typeof cot === 'string' || cot instanceof Buffer) {
             const raw = xmljs.xml2js(String(cot), { compact: true });
             this.raw = raw as Static<typeof JSONCoT>;
@@ -102,6 +113,15 @@ export default class CoT {
         if (this.raw.event.detail.archive && Object.keys(this.raw.event.detail.archive).length === 0) {
             this.raw.event.detail.archive = { _attributes: {} };
         }
+
+        if (opts.creator) {
+            this.creator({
+                uid: opts.creator instanceof CoT ? opts.creator.uid() : opts.creator.uid,
+                type: opts.creator instanceof CoT ? opts.creator.type() : opts.creator.type,
+                callsign: opts.creator instanceof CoT ? opts.creator.callsign() : opts.creator.callsign,
+                time: opts.creator instanceof CoT ? new Date() : opts.creator.time
+            });
+        }
     }
 
     /**
@@ -150,6 +170,14 @@ export default class CoT {
         return diffs.length > 0;
     }
 
+    /**
+     * Returns or sets the UID of the CoT
+     */
+    uid(uid?: string): string {
+        if (uid) this.raw.event._attributes.uid = uid;
+        return this.raw.event._attributes.uid;
+    }
+
     /**
      * Returns or sets the Callsign of the CoT
      */
@@ -163,48 +191,51 @@ export default class CoT {
 
     /**
      * Returns or sets the Callsign of the CoT
+     *
+     * @param callsign - Optional Callsign to set
      */
     callsign(callsign?: string): string {
-        if (!this.raw.event.detail) this.raw.event.detail = {};
+        const detail = this.detail();
 
-        if (callsign && !this.raw.event.detail.contact) {
-            this.raw.event.detail.contact = { _attributes: { callsign } };
-        } else if (callsign && this.raw.event.detail.contact) {
-            this.raw.event.detail.contact._attributes.callsign = callsign;
+        if (callsign && !detail.contact) {
+            detail.contact = { _attributes: { callsign } };
+        } else if (callsign && detail.contact) {
+            detail.contact._attributes.callsign = callsign;
         }
 
-        if (this.raw.event.detail.contact && this.raw.event.detail.contact._attributes && typeof this.raw.event.detail.contact._attributes.callsign === 'string') {
-            return this.raw.event.detail.contact._attributes.callsign;
+        if (detail.contact && detail.contact._attributes && typeof detail.contact._attributes.callsign === 'string') {
+            return detail.contact._attributes.callsign;
         } else {
             return 'UNKNOWN'
         }
     }
 
     /**
-     * Returns or sets the UID of the CoT
+     * Return Detail Object of CoT or create one if it doesn't yet exist and pass a reference
      */
-    uid(uid?: string): string {
-        if (uid) this.raw.event._attributes.uid = uid;
-        return this.raw.event._attributes.uid;
+    detail(): Static<typeof Detail> {
+        if (!this.raw.event.detail) this.raw.event.detail = {};
+        return this.raw.event.detail;
     }
 
     /**
      * Add a given Dest tag to a CoT
      */
     addDest(dest: Static<typeof MartiDestAttributes>): CoT {
-        if (!this.raw.event.detail) this.raw.event.detail = {};
-        if (!this.raw.event.detail.marti) this.raw.event.detail.marti = {};
+        const detail = this.detail();
+
+        if (!detail.marti) detail.marti = {};
 
         let destArr: Array<Static<typeof MartiDest>> = [];
-        if (this.raw.event.detail.marti.dest && !Array.isArray(this.raw.event.detail.marti.dest)) {
-            destArr = [this.raw.event.detail.marti.dest]
-        } else if (this.raw.event.detail.marti.dest && Array.isArray(this.raw.event.detail.marti.dest)) {
-            destArr = this.raw.event.detail.marti.dest;
+        if (detail.marti.dest && !Array.isArray(detail.marti.dest)) {
+            destArr = [detail.marti.dest]
+        } else if (detail.marti.dest && Array.isArray(detail.marti.dest)) {
+            destArr = detail.marti.dest;
         }
 
         destArr.push({ _attributes: dest });
 
-        this.raw.event.detail.marti.dest = destArr;
+        detail.marti.dest = destArr;
 
         return this;
     }
@@ -213,8 +244,8 @@ export default class CoT {
         video: Static<typeof VideoAttributes>,
         connection?: Static<typeof VideoConnectionEntryAttributes>
     ): CoT {
-        if (!this.raw.event.detail) this.raw.event.detail = {};
-        if (this.raw.event.detail.__video) throw new Err(400, null, 'A video stream already exists on this CoT');
+        const detail = this.detail();
+        if (detail.__video) throw new Err(400, null, 'A video stream already exists on this CoT');
 
         if (!video.url) throw new Err(400, null, 'A Video URL must be provided');
 
@@ -226,16 +257,16 @@ export default class CoT {
             video.uid = crypto.randomUUID();
         }
 
-        this.raw.event.detail.__video = {
+        detail.__video = {
             _attributes: video
         };
 
         if (connection) {
-            this.raw.event.detail.__video.ConnectionEntry = {
+            detail.__video.ConnectionEntry = {
                 _attributes: connection
             }
         } else {
-            this.raw.event.detail.__video.ConnectionEntry = {
+            detail.__video.ConnectionEntry = {
                 _attributes: {
                     uid: video.uid,
                     networkTimeout: 12000,
@@ -268,37 +299,71 @@ export default class CoT {
     }
 
     sensor(sensor?: Static<typeof SensorAttributes>): Static<typeof Polygon> | null {
-        if (!this.raw.event.detail) this.raw.event.detail = {};
+        const detail = this.detail();
 
         if (sensor) {
-            this.raw.event.detail.sensor = {
+            detail.sensor = {
                 _attributes: sensor
             }
         }
 
-        if (!this.raw.event.detail.sensor || !this.raw.event.detail.sensor._attributes) {
+        if (!detail.sensor || !detail.sensor._attributes) {
             return null;
         }
 
         return new Sensor(
             this.position(),
-            this.raw.event.detail.sensor._attributes
+            detail.sensor._attributes
         ).to_geojson();
     };
 
+    creator(
+        creator?: {
+            uid: string,
+            type: string,
+            callsign: string,
+            time: Date | string | undefined,
+        }
+    ): Static<typeof CreatorAttributes> | undefined {
+        const detail = this.detail();
+
+        if (creator) {
+            this.addLink({
+                uid: creator.uid,
+                production_time: creator.time ? new Date(creator.time).toISOString() : new Date().toISOString(),
+                type: creator.type,
+                parent_callsign: creator.callsign,
+                relation: 'p-p'
+            });
+
+            detail.creator = {
+                _attributes: {
+                    ...creator,
+                    time: creator.time ? new Date(creator.time).toISOString() : new Date().toISOString(),
+                }
+            };
+        }
+
+        if (detail.creator) {
+            return detail.creator._attributes;
+        } else {
+            return;
+        }
+    }
+
     addLink(link: Static<typeof LinkAttributes>): CoT {
-        if (!this.raw.event.detail) this.raw.event.detail = {};
+        const detail = this.detail();
 
         let linkArr: Array<Static<typeof Link>> = [];
-        if (this.raw.event.detail.link && !Array.isArray(this.raw.event.detail.link)) {
-            linkArr = [this.raw.event.detail.link]
-        } else if (this.raw.event.detail.link && Array.isArray(this.raw.event.detail.link)) {
-            linkArr = this.raw.event.detail.link;
+        if (detail.link && !Array.isArray(detail.link)) {
+            linkArr = [detail.link]
+        } else if (detail.link && Array.isArray(detail.link)) {
+            linkArr = detail.link;
         }
 
         linkArr.push({ _attributes: link });
 
-        this.raw.event.detail.link = linkArr;
+        detail.link = linkArr;
 
         return this;
     }
@@ -375,6 +440,10 @@ export default class CoT {
             feat.properties.contact = contact;
         }
 
+        if (this.creator()) {
+            feat.properties.creator = this.creator();
+        }
+
         if (raw.event.detail.remarks && raw.event.detail.remarks._text) {
             feat.properties.remarks = raw.event.detail.remarks._text;
         }
@@ -978,6 +1047,10 @@ export default class CoT {
             cot.event.detail.takv = { _attributes: { ...feature.properties.takv } };
         }
 
+        if (feature.properties.creator) {
+            cot.event.detail.creator = { _attributes: { ...feature.properties.creator } };
+        }
+
         if (feature.properties.geofence) {
             cot.event.detail.__geofence = { _attributes: { ...feature.properties.geofence } };
         }

lib/types/feature.ts

@@ -1,6 +1,7 @@
 import { Type } from '@sinclair/typebox';
 import {
     GroupAttributes,
+    CreatorAttributes,
     ACKRequestAttributes,
     ShapeEllipseAttributes,
     GeofenceAttributes,
@@ -55,65 +56,6 @@ export const FeaturePropertyMission = Type.Object({
     missionChanges: Type.Optional(Type.Array(FeaturePropertyMissionChange))
 });
 
-export const InputProperties = Type.Object({
-    callsign: Type.Optional(Type.String({ default: 'UNKNOWN' })),
-    type: Type.Optional(Type.String({ default: 'a-f-G' })),
-    how: Type.Optional(Type.String()),
-    time: Type.Optional(Type.Union([Type.String()])),
-    start: Type.Optional(Type.Union([Type.String()])),
-    stale: Type.Optional(Type.Union([Type.Integer(), Type.String()])),
-    center: Type.Optional(Position),
-    course: Type.Optional(Type.Number()),
-    slope: Type.Optional(Type.Number()),
-    speed: Type.Optional(Type.Number()),
-    'marker-color': Type.Optional(Type.String()),
-    'marker-opacity': Type.Optional(Type.Number({ minimum: 0, maximum: 1 })),
-    'stroke': Type.Optional(Type.String()),
-    'stroke-opacity': Type.Optional(Type.Number({ minimum: 0, maximum: 1 })),
-    'stroke-width': Type.Optional(Type.Number()),
-    'stroke-style': Type.Optional(Type.String()),
-    'fill': Type.Optional(Type.String()),
-    'fill-opacity': Type.Optional(Type.Number({ minimum: 0, maximum: 1 })),
-    metadata: Type.Optional(Type.Record(Type.String(), Type.Unknown())),
-    archived: Type.Optional(Type.Boolean()),
-    geofence: Type.Optional(GeofenceAttributes),
-    contact: Type.Optional(ContactAttributes),
-    shape: Type.Optional(Type.Object({
-        ellipse: Type.Optional(ShapeEllipseAttributes)
-    })),
-    remarks: Type.Optional(Type.String()),
-    mission: Type.Optional(FeaturePropertyMission),
-    fileshare: Type.Optional(FileShareAttributes),
-    ackrequest: Type.Optional(ACKRequestAttributes),
-    attachments: Type.Optional(Type.Array(Type.String())),
-    sensor: Type.Optional(SensorAttributes),
-    video: Type.Optional(Type.Composite([
-        VideoAttributes,
-        Type.Optional(Type.Object({
-            connection: Type.Optional(VideoConnectionEntryAttributes)
-        }))
-    ])),
-    links: Type.Optional(Type.Array(LinkAttributes)),
-    chat: Type.Optional(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()
-    })),
-    track: Type.Optional(TrackAttributes),
-    dest: Type.Optional(Type.Union([MartiDestAttributes, Type.Array(MartiDestAttributes)])),
-    icon: Type.Optional(Type.String()),
-    droid: Type.Optional(Type.String()),
-    takv: Type.Optional(TakVersionAttributes),
-    group: Type.Optional(GroupAttributes),
-    status: Type.Optional(StatusAttributes),
-    precisionlocation: Type.Optional(PrecisionLocationAttributes),
-    flow: Type.Optional(Type.Record(Type.String(), Type.String())),
-})
-
 export const Properties = Type.Object({
     callsign: Type.String({ default: 'UNKNOWN' }),
     type: Type.String({ default: 'a-f-G' }),
@@ -122,6 +64,7 @@ export const Properties = Type.Object({
     start: Type.String(),
     stale: Type.String(),
     center: Position,
+    creator: Type.Optional(CreatorAttributes),
     course: Type.Optional(Type.Number()),
     slope: Type.Optional(Type.Number()),
     speed: Type.Optional(Type.Number()),
@@ -217,6 +160,13 @@ export const Feature = Type.Object({
     geometry: Geometry
 })
 
+export const InputProperties = Type.Partial(Type.Composite([
+    Type.Omit(Properties, ['stale']),
+    Type.Object({
+        stale: Type.Union([Type.Integer(), Type.String()])
+    })
+]))
+
 export const InputFeature = Type.Object({
     id: Type.Optional(Type.String()),
     type: Type.Const('Feature'),