@tak-ps/node-tak 11.26.0 → 11.26.2

package/CHANGELOG.md

@@ -10,6 +10,14 @@
 
 ## Version History
 
+### v11.26.2 - 2025-02-05
+
+- :bug: Wrap return type of Client list in TAKList object
+
+### v11.26.1 - 2025-02-05
+
+- :rocket: Allow specifying Client Endpoint List query parameters
+
 ### v11.26.0 - 2025-02-05
 
 - :tada: Add support for Client Endpoint List

package/dist/lib/api/client.d.ts

@@ -9,15 +9,40 @@ export declare const ClientEndpoint: import("@sinclair/typebox").TObject<{
     role: import("@sinclair/typebox").TString;
     lastStatus: import("@sinclair/typebox").TString;
 }>;
+export declare const ClientEndpointList: import("@sinclair/typebox").TObject<{
+    version: import("@sinclair/typebox").TString;
+    type: import("@sinclair/typebox").TString;
+    data: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        callsign: import("@sinclair/typebox").TString;
+        uid: import("@sinclair/typebox").TString;
+        username: import("@sinclair/typebox").TString;
+        team: import("@sinclair/typebox").TString;
+        role: import("@sinclair/typebox").TString;
+        lastStatus: import("@sinclair/typebox").TString;
+    }>>;
+    messages: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    nodeId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const ClientListQuery: import("@sinclair/typebox").TObject<{
+    secAgo: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TInteger>;
+    showCurrentlyConnectedClients: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    showMostRecentOnly: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    group: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+}>;
 export default class Client extends Commands {
     schema: {
         list: {
             description: string;
             params: import("@sinclair/typebox").TObject<{}>;
-            query: import("@sinclair/typebox").TObject<{}>;
+            query: import("@sinclair/typebox").TObject<{
+                secAgo: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TInteger>;
+                showCurrentlyConnectedClients: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                showMostRecentOnly: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+                group: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+            }>;
             formats: CommandOutputFormat[];
         };
     };
     cli(args: ParsedArgs): Promise<object | string>;
-    list(): Promise<Array<Static<typeof ClientEndpoint>>>;
+    list(query?: Static<typeof ClientListQuery>): Promise<Static<typeof ClientEndpointList>>;
 }

package/dist/lib/api/client.js

@@ -1,4 +1,5 @@
 import { Type } from '@sinclair/typebox';
+import { TAKList } from './types.js';
 import Commands, { CommandOutputFormat } from '../commands.js';
 export const ClientEndpoint = Type.Object({
     callsign: Type.String(),
@@ -8,25 +9,48 @@ export const ClientEndpoint = Type.Object({
     role: Type.String(),
     lastStatus: Type.String(),
 });
+export const ClientEndpointList = TAKList(ClientEndpoint);
+export const ClientListQuery = Type.Object({
+    secAgo: Type.Optional(Type.Integer({ default: 0 })),
+    showCurrentlyConnectedClients: Type.Optional(Type.String({ default: "false" })),
+    showMostRecentOnly: Type.Optional(Type.String({ default: "false" })),
+    group: Type.Optional(Type.Array(Type.String()))
+});
 export default class Client extends Commands {
     schema = {
         list: {
             description: 'List Client Endpoints',
             params: Type.Object({}),
-            query: Type.Object({}),
+            query: ClientListQuery,
             formats: [CommandOutputFormat.JSON]
         }
     };
     async cli(args) {
         if (args._[3] === 'list') {
-            return await this.list();
+            return await this.list({
+                secAgo: args.secAgo,
+                showCurrentlyConnectedClients: args.showCurrentlyConnectedClients ? String(args.showCurrentlyConnectedClients) : undefined,
+                showMostRecentOnly: args.showMostRecentOnly ? String(args.showMostRecentOnly) : undefined,
+                group: args.group ? (Array.isArray(args.group) ? args.group : [args.group]) : undefined
+            });
         }
         else {
             throw new Error('Unsupported Subcommand');
         }
     }
-    async list() {
+    async list(query = {}) {
         const url = new URL(`/Marti/api/clientEndPoints`, this.api.url);
+        if (query.secAgo)
+            url.searchParams.append('secAgo', String(query.secAgo));
+        if (query.showCurrentlyConnectedClients)
+            url.searchParams.append('showCurrentlyConnectedClients', query.showCurrentlyConnectedClients);
+        if (query.showMostRecentOnly)
+            url.searchParams.append('showMostRecentOnly', query.showMostRecentOnly);
+        if (query.group) {
+            for (const group of query.group) {
+                url.searchParams.append('group', group);
+            }
+        }
         return await this.api.fetch(url, {
             method: 'GET'
         });

package/dist/lib/api/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../lib/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAU,MAAM,mBAAmB,CAAC;AAEjD,OAAO,QAAQ,EAAE,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAE/D,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC;IACtC,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE;IACvB,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE;IAClB,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE;IACvB,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;IACnB,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE;CAC5B,CAAC,CAAC;AAEH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IACxC,MAAM,GAAG;QACL,IAAI,EAAE;YACF,WAAW,EAAE,uBAAuB;YACpC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACvB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtB,OAAO,EAAE,CAAE,mBAAmB,CAAC,IAAI,CAAE;SACxC;KACJ,CAAA;IAED,KAAK,CAAC,GAAG,CAAC,IAAgB;QACtB,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;YACvB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAC7B,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI;QACN,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,4BAA4B,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChE,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE;YAC7B,MAAM,EAAE,KAAK;SAChB,CAAC,CAAC;IACP,CAAC;CACJ"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../lib/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAU,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,QAAQ,EAAE,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAE/D,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC;IACtC,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE;IACvB,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE;IAClB,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE;IACvB,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;IACnB,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE;CAC5B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAE1D,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;IACvC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;IACnD,6BAA6B,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,kBAAkB,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IACpE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;CAClD,CAAC,CAAC;AAEH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IACxC,MAAM,GAAG;QACL,IAAI,EAAE;YACF,WAAW,EAAE,uBAAuB;YACpC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACvB,KAAK,EAAE,eAAe;YACtB,OAAO,EAAE,CAAE,mBAAmB,CAAC,IAAI,CAAE;SACxC;KACJ,CAAA;IAED,KAAK,CAAC,GAAG,CAAC,IAAgB;QACtB,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;YACvB,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC;gBACnB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,6BAA6B,EAAE,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,SAAS;gBAC1H,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,SAAS;gBACzF,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;aAC1F,CAAC,CAAC;QACP,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,QAAwC,EAAE;QACjD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,4BAA4B,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEhE,IAAI,KAAK,CAAC,MAAM;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1E,IAAI,KAAK,CAAC,6BAA6B;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,+BAA+B,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACvI,IAAI,KAAK,CAAC,kBAAkB;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,oBAAoB,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAEtG,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YACd,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;gBAC9B,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC5C,CAAC;QACL,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE;YAC7B,MAAM,EAAE,KAAK;SAChB,CAAC,CAAC;IACP,CAAC;CACJ"}

package/lib/api/client.ts

@@ -1,5 +1,6 @@
 import { Type, Static } from '@sinclair/typebox';
 import type { ParsedArgs } from 'minimist'
+import { TAKList } from './types.js';
 import Commands, { CommandOutputFormat } from '../commands.js';
 
 export const ClientEndpoint = Type.Object({
@@ -11,26 +12,51 @@ export const ClientEndpoint = Type.Object({
     lastStatus: Type.String(),
 });
 
+export const ClientEndpointList = TAKList(ClientEndpoint);
+
+export const ClientListQuery = Type.Object({
+    secAgo: Type.Optional(Type.Integer({ default: 0 })),
+    showCurrentlyConnectedClients: Type.Optional(Type.String({ default: "false" })),
+    showMostRecentOnly: Type.Optional(Type.String({ default: "false" })),
+    group: Type.Optional(Type.Array(Type.String()))
+});
+
 export default class Client extends Commands {
     schema = {
         list: {
             description: 'List Client Endpoints',
             params: Type.Object({}),
-            query: Type.Object({}),
+            query: ClientListQuery,
             formats: [ CommandOutputFormat.JSON ]
         }
     }
 
     async cli(args: ParsedArgs): Promise<object | string> {
         if (args._[3] === 'list') {
-            return await this.list();
+            return await this.list({
+                secAgo: args.secAgo,
+                showCurrentlyConnectedClients: args.showCurrentlyConnectedClients ? String(args.showCurrentlyConnectedClients) : undefined,
+                showMostRecentOnly: args.showMostRecentOnly ? String(args.showMostRecentOnly) : undefined,
+                group: args.group ? (Array.isArray(args.group) ? args.group : [args.group]) : undefined
+            });
         } else {
             throw new Error('Unsupported Subcommand');
         }
     }
 
-    async list(): Promise<Array<Static<typeof ClientEndpoint>>> {
+    async list(query: Static<typeof ClientListQuery> = {}): Promise<Static<typeof ClientEndpointList>> {
         const url = new URL(`/Marti/api/clientEndPoints`, this.api.url);
+
+        if (query.secAgo) url.searchParams.append('secAgo', String(query.secAgo));
+        if (query.showCurrentlyConnectedClients) url.searchParams.append('showCurrentlyConnectedClients', query.showCurrentlyConnectedClients);
+        if (query.showMostRecentOnly) url.searchParams.append('showMostRecentOnly', query.showMostRecentOnly);
+
+        if (query.group) {
+            for (const group of query.group) {
+                url.searchParams.append('group', group);
+            }
+        }
+
         return await this.api.fetch(url, {
             method: 'GET'
         });

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@tak-ps/node-tak",
     "type": "module",
-    "version": "11.26.0",
+    "version": "11.26.2",
     "description": "Lightweight JavaScript library for communicating with TAK Server",
     "author": "Nick Ingalls <nick@ingalls.ca>",
     "main": "dist/index.js",