@tak-ps/node-tak 11.26.0 → 11.26.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/dist/lib/api/client.d.ts +13 -2
  3. package/dist/lib/api/client.js +25 -3
  4. package/dist/lib/api/client.js.map +1 -1
  5. package/lib/api/client.ts +26 -3
  6. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -10,6 +10,10 @@
10
10
 
11
11
  ## Version History
12
12
 
13
+ ### v11.26.1 - 2025-02-05
14
+
15
+ - :rocket: Allow specifying Client Endpoint List query parameters
16
+
13
17
  ### v11.26.0 - 2025-02-05
14
18
 
15
19
  - :tada: Add support for Client Endpoint List
package/dist/lib/api/client.d.ts CHANGED
@@ -9,15 +9,26 @@ export declare const ClientEndpoint: import("@sinclair/typebox").TObject<{
9
9
  role: import("@sinclair/typebox").TString;
10
10
  lastStatus: import("@sinclair/typebox").TString;
11
11
  }>;
12
+ export declare const ClientListQuery: import("@sinclair/typebox").TObject<{
13
+ secAgo: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TInteger>;
14
+ showCurrentlyConnectedClients: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
15
+ showMostRecentOnly: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
16
+ group: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
17
+ }>;
12
18
  export default class Client extends Commands {
13
19
  schema: {
14
20
  list: {
15
21
  description: string;
16
22
  params: import("@sinclair/typebox").TObject<{}>;
17
- query: import("@sinclair/typebox").TObject<{}>;
23
+ query: import("@sinclair/typebox").TObject<{
24
+ secAgo: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TInteger>;
25
+ showCurrentlyConnectedClients: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
26
+ showMostRecentOnly: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
27
+ group: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
28
+ }>;
18
29
  formats: CommandOutputFormat[];
19
30
  };
20
31
  };
21
32
  cli(args: ParsedArgs): Promise<object | string>;
22
- list(): Promise<Array<Static<typeof ClientEndpoint>>>;
33
+ list(query?: Static<typeof ClientListQuery>): Promise<Array<Static<typeof ClientEndpoint>>>;
23
34
  }
package/dist/lib/api/client.js CHANGED
@@ -8,25 +8,47 @@ export const ClientEndpoint = Type.Object({
8
8
  role: Type.String(),
9
9
  lastStatus: Type.String(),
10
10
  });
11
+ export const ClientListQuery = Type.Object({
12
+ secAgo: Type.Optional(Type.Integer({ default: 0 })),
13
+ showCurrentlyConnectedClients: Type.Optional(Type.String({ default: "false" })),
14
+ showMostRecentOnly: Type.Optional(Type.String({ default: "false" })),
15
+ group: Type.Optional(Type.Array(Type.String()))
16
+ });
11
17
  export default class Client extends Commands {
12
18
  schema = {
13
19
  list: {
14
20
  description: 'List Client Endpoints',
15
21
  params: Type.Object({}),
16
- query: Type.Object({}),
22
+ query: ClientListQuery,
17
23
  formats: [CommandOutputFormat.JSON]
18
24
  }
19
25
  };
20
26
  async cli(args) {
21
27
  if (args._[3] === 'list') {
22
- return await this.list();
28
+ return await this.list({
29
+ secAgo: args.secAgo,
30
+ showCurrentlyConnectedClients: args.showCurrentlyConnectedClients ? String(args.showCurrentlyConnectedClients) : undefined,
31
+ showMostRecentOnly: args.showMostRecentOnly ? String(args.showMostRecentOnly) : undefined,
32
+ group: args.group ? (Array.isArray(args.group) ? args.group : [args.group]) : undefined
33
+ });
23
34
  }
24
35
  else {
25
36
  throw new Error('Unsupported Subcommand');
26
37
  }
27
38
  }
28
- async list() {
39
+ async list(query = {}) {
29
40
  const url = new URL(`/Marti/api/clientEndPoints`, this.api.url);
41
+ if (query.secAgo)
42
+ url.searchParams.append('secAgo', String(query.secAgo));
43
+ if (query.showCurrentlyConnectedClients)
44
+ url.searchParams.append('showCurrentlyConnectedClients', query.showCurrentlyConnectedClients);
45
+ if (query.showMostRecentOnly)
46
+ url.searchParams.append('showMostRecentOnly', query.showMostRecentOnly);
47
+ if (query.group) {
48
+ for (const group of query.group) {
49
+ url.searchParams.append('group', group);
50
+ }
51
+ }
30
52
  return await this.api.fetch(url, {
31
53
  method: 'GET'
32
54
  });
package/dist/lib/api/client.js.map CHANGED
@@ -1 +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"}
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,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 CHANGED
@@ -11,26 +11,49 @@ export const ClientEndpoint = Type.Object({
11
11
  lastStatus: Type.String(),
12
12
  });
13
13
 
14
+ export const ClientListQuery = Type.Object({
15
+ secAgo: Type.Optional(Type.Integer({ default: 0 })),
16
+ showCurrentlyConnectedClients: Type.Optional(Type.String({ default: "false" })),
17
+ showMostRecentOnly: Type.Optional(Type.String({ default: "false" })),
18
+ group: Type.Optional(Type.Array(Type.String()))
19
+ });
20
+
14
21
  export default class Client extends Commands {
15
22
  schema = {
16
23
  list: {
17
24
  description: 'List Client Endpoints',
18
25
  params: Type.Object({}),
19
- query: Type.Object({}),
26
+ query: ClientListQuery,
20
27
  formats: [ CommandOutputFormat.JSON ]
21
28
  }
22
29
  }
23
30
 
24
31
  async cli(args: ParsedArgs): Promise<object | string> {
25
32
  if (args._[3] === 'list') {
26
- return await this.list();
33
+ return await this.list({
34
+ secAgo: args.secAgo,
35
+ showCurrentlyConnectedClients: args.showCurrentlyConnectedClients ? String(args.showCurrentlyConnectedClients) : undefined,
36
+ showMostRecentOnly: args.showMostRecentOnly ? String(args.showMostRecentOnly) : undefined,
37
+ group: args.group ? (Array.isArray(args.group) ? args.group : [args.group]) : undefined
38
+ });
27
39
  } else {
28
40
  throw new Error('Unsupported Subcommand');
29
41
  }
30
42
  }
31
43
 
32
- async list(): Promise<Array<Static<typeof ClientEndpoint>>> {
44
+ async list(query: Static<typeof ClientListQuery> = {}): Promise<Array<Static<typeof ClientEndpoint>>> {
33
45
  const url = new URL(`/Marti/api/clientEndPoints`, this.api.url);
46
+
47
+ if (query.secAgo) url.searchParams.append('secAgo', String(query.secAgo));
48
+ if (query.showCurrentlyConnectedClients) url.searchParams.append('showCurrentlyConnectedClients', query.showCurrentlyConnectedClients);
49
+ if (query.showMostRecentOnly) url.searchParams.append('showMostRecentOnly', query.showMostRecentOnly);
50
+
51
+ if (query.group) {
52
+ for (const group of query.group) {
53
+ url.searchParams.append('group', group);
54
+ }
55
+ }
56
+
34
57
  return await this.api.fetch(url, {
35
58
  method: 'GET'
36
59
  });
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@tak-ps/node-tak",
3
3
  "type": "module",
4
- "version": "11.26.0",
4
+ "version": "11.26.1",
5
5
  "description": "Lightweight JavaScript library for communicating with TAK Server",
6
6
  "author": "Nick Ingalls <nick@ingalls.ca>",
7
7
  "main": "dist/index.js",