@tak-ps/node-cot 14.0.0 → 14.0.2

package/dist/lib/utils/2525.d.ts

@@ -0,0 +1,55 @@
+export declare enum Domain {
+    ATOM = "a",
+    BITS = "b",
+    REFERENCE = "r",
+    TASK = "t",
+    CAPABILITY = "c",
+    REPLY = "y"
+}
+export declare enum StandardIdentity {
+    PENDING = "p",
+    UNKNOWN = "u",
+    ASSUMED_FRIEND = "a",
+    FRIEND = "f",
+    NEUTRAL = "n",
+    SUSPECT = "s",
+    HOSTILE = "h",
+    JOKER = "j",
+    FAKER = "k",
+    NONE = "o"
+}
+/**
+ * @class
+ *
+ * Convert a COT Atom Type to/from Symbol Identification Code (SIDC)
+ * Migrated to TypeScript from the original Kotlin verison
+ * @ https://github.com/cyberpython/kotcot under the MIT License
+ */
+export default class Type2525 {
+    /**
+     * Check a given COT Type to see if it is compatible with conversion to SIDC
+     *
+     * @param cotType - Cursor On Target Type to test
+     */
+    static is2525BConvertable(cotType: string): boolean;
+    static domain(cotType: string): Domain;
+    static standardIdentity(cotType: string): StandardIdentity;
+    /**
+     * Given a COT Atom Type, return an SIDC
+     *
+     * @param cotType - Cursor On Target Type (Note must start with atomic "a")
+     */
+    static to2525B(cotType: string): string;
+    /**
+     * Check a given SIDC to see if it is compatible with conversion to CoT Type
+     *
+     * @param sidc - SIDC to test
+     */
+    static isTypeConvertable(sidc: string): boolean;
+    /**
+     * Given an SIDC, return a CoT Type
+     *
+     * @param sidc - SIDC to convert
+     */
+    static from2525B(sidc: string): string;
+}

package/dist/lib/utils/color.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Helper functions for working with CoT Colours
+ *
+ * @param {Number|Number[]} color 32bit packged ARGB or [A, R, G, B]
+ * @class
+ */
+export default class Color {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+    constructor(color: string | number | number[]);
+    as_hex(): string;
+    as_hexa(): string;
+    as_32bit(): number;
+    as_opacity(): number;
+    as_argb(): number[];
+    as_rgb(): number[];
+}

package/dist/lib/utils/type.d.ts

@@ -0,0 +1,14 @@
+import type { Static, TSchema, TUnknown } from '@sinclair/typebox';
+export type TypeOpts = {
+    verbose?: boolean;
+    default?: boolean;
+    convert?: boolean;
+    clean?: boolean;
+};
+export default class TypeValidator {
+    /**
+     * Arbitrary JSON objects occasionally need to get typed as part of an ETL
+     * This function provides the ability to strictly type unknown objects at runtime
+     */
+    static type<T extends TSchema = TUnknown>(type: T, body: unknown, opts?: TypeOpts): Static<T>;
+}

package/dist/lib/utils/util.d.ts

@@ -0,0 +1,57 @@
+import type { Static } from '@sinclair/typebox';
+import type { EventAttributes, TrackAttributes, Detail, Point } from '../types/types.js';
+/**
+ * Helper functions for generating CoT data
+ * @class
+ */
+export default class Util {
+    /**
+     * Return an event._attributes object with as many defaults as possible
+     *
+     * @param type      CoT Type
+     * @param how       CoT how
+     * @param time      Time of CoT Message - if omitted, current time is used
+     * @param start     Start Time of CoT - if omitted, current time is used
+     * @param stale     Expiration of CoT - if null now+20s is used. Alternative an integer representing the ms offset
+     */
+    static cot_event_attr(type: string, how: string, time?: Date | string | null, start?: Date | string | null, stale?: Date | string | number | null): Static<typeof EventAttributes>;
+    /**
+     * Return an event.detail object with as many defaults as possible
+     *
+     * @param [callsign=UNKNOWN] Display Callsign
+     */
+    static cot_event_detail(callsign?: string): Static<typeof Detail>;
+    /**
+     * Return a track object with as many defaults as possible
+     *
+     * @param [course] Speed in degrees from north
+     * @param [speed=0] Speed in m/s
+     */
+    static cot_track_attr(course?: number, speed?: number, slope?: number): Static<typeof TrackAttributes>;
+    /**
+     * Generate a random UUID
+     */
+    static cot_uuid(): string;
+    /**
+     * Return the current version number this library supports
+     */
+    static cot_version(): string;
+    /**
+     * Generate Null Island CoT point object
+     */
+    static cot_point(): Static<typeof Point>;
+    /**
+     * Generate CoT date objects
+     *
+     * cot_date() - Time: now, Start: now, Stale: now + 20s
+     *
+     * @param time      Time of CoT Message - if omitted, current time is used
+     * @param start     Start Time of CoT - if omitted, current time is used
+     * @param stale     Expiration of CoT - if null now+20s is used. Alternative an integer representing the ms offset
+     */
+    static cot_date(time?: Date | string | null, start?: Date | string | null, stale?: Date | string | number | null): {
+        time: string;
+        start: string;
+        stale: string;
+    };
+}

package/dist/lib/xml/basemap.d.ts

@@ -0,0 +1,23 @@
+import XMLDocument from '../xml-document.js';
+import type { Static } from '@sinclair/typebox';
+import BasemapSchema from '../types/basemap.js';
+type BasemapType = Static<typeof BasemapSchema>;
+/**
+ * Helper class for creating and parsing Basemap XML documents
+ */
+export declare class Basemap extends XMLDocument<BasemapType> {
+    /**
+     * Return a Basemap from a string XML representation
+     */
+    static parse(input: string | Buffer): Basemap;
+    to_json(): {
+        name: string | undefined;
+        url: string;
+        minZoom: number | undefined;
+        maxZoom: number | undefined;
+        tileType: string | undefined;
+        tileUpdate: string | undefined;
+        backgroundColor: string | undefined;
+    };
+}
+export {};

package/dist/lib/xml/iconset.d.ts

@@ -0,0 +1,18 @@
+import XMLDocument from '../xml-document.js';
+import type { Static } from '@sinclair/typebox';
+import IconsetSchema, { IconsetAttributes, IconAttributes } from '../types/iconset.js';
+type IconsetType = Static<typeof IconsetSchema>;
+/**
+ * Helper class for creating and parsing Iconset XML documents
+ */
+export declare class Iconset extends XMLDocument<IconsetType> {
+    /**
+     * Return an Iconset from a string XML representation
+     */
+    static parse(input: string | Buffer): Iconset;
+    get uid(): string;
+    get name(): string;
+    icons(): Set<Static<typeof IconAttributes>>;
+    to_json(): Static<typeof IconsetAttributes>;
+}
+export {};

package/dist/lib/xml-document.d.ts

@@ -0,0 +1,11 @@
+import type { ValidateFunction } from 'ajv';
+/**
+ * Core XML Document support used for XML fortatted DataPackages documents
+ * such as Iconsets or Basemaps
+ */
+export default class XMLDocument<T> {
+    raw: T;
+    constructor(raw: T);
+    static check<U>(input: string, check: ValidateFunction<unknown>): U;
+    to_xml(): string;
+}

package/dist/package.json

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

package/lib/parser/normalize_geojson.ts

@@ -94,7 +94,7 @@ export async function normalize_geojson(
 
     feature.properties.center = PointOnFeature(feature).geometry.coordinates;
 
-    feature.properties.archived = feature.properties.archived || false;
+    feature.properties.archived = true;
 
     coordEach(feature.geometry, (coord) => {
         return coord.slice(0, 3);

package/package.json

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

package/tsconfig.json

@@ -2,6 +2,7 @@
     "compilerOptions": {
         "strict": true,
         "strictNullChecks": true,
+        "declaration": true,
         "module": "es2022",
         "esModuleInterop": true,
         "target": "es2022",