@tak-ps/node-tak 11.17.4 → 11.18.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 (95) hide show
  1. package/.github/workflows/release.yml +10 -16
  2. package/CHANGELOG.md +8 -0
  3. package/lib/api/mission.ts +41 -27
  4. package/package.json +3 -3
  5. package/dist/cli.d.ts +0 -2
  6. package/dist/cli.js +0 -183
  7. package/dist/cli.js.map +0 -1
  8. package/dist/index.d.ts +0 -59
  9. package/dist/index.js +0 -204
  10. package/dist/index.js.map +0 -1
  11. package/dist/lib/api/contacts.d.ts +0 -24
  12. package/dist/lib/api/contacts.js +0 -44
  13. package/dist/lib/api/contacts.js.map +0 -1
  14. package/dist/lib/api/credentials.d.ts +0 -21
  15. package/dist/lib/api/credentials.js +0 -83
  16. package/dist/lib/api/credentials.js.map +0 -1
  17. package/dist/lib/api/export.d.ts +0 -21
  18. package/dist/lib/api/export.js +0 -37
  19. package/dist/lib/api/export.js.map +0 -1
  20. package/dist/lib/api/files.d.ts +0 -77
  21. package/dist/lib/api/files.js +0 -170
  22. package/dist/lib/api/files.js.map +0 -1
  23. package/dist/lib/api/groups.d.ts +0 -43
  24. package/dist/lib/api/groups.js +0 -68
  25. package/dist/lib/api/groups.js.map +0 -1
  26. package/dist/lib/api/iconsets.d.ts +0 -27
  27. package/dist/lib/api/iconsets.js +0 -42
  28. package/dist/lib/api/iconsets.js.map +0 -1
  29. package/dist/lib/api/injectors.d.ts +0 -52
  30. package/dist/lib/api/injectors.js +0 -82
  31. package/dist/lib/api/injectors.js.map +0 -1
  32. package/dist/lib/api/locate.d.ts +0 -13
  33. package/dist/lib/api/locate.js +0 -27
  34. package/dist/lib/api/locate.js.map +0 -1
  35. package/dist/lib/api/mission-invite.d.ts +0 -36
  36. package/dist/lib/api/mission-invite.js +0 -55
  37. package/dist/lib/api/mission-invite.js.map +0 -1
  38. package/dist/lib/api/mission-layer.d.ts +0 -137
  39. package/dist/lib/api/mission-layer.js +0 -247
  40. package/dist/lib/api/mission-layer.js.map +0 -1
  41. package/dist/lib/api/mission-log.d.ts +0 -75
  42. package/dist/lib/api/mission-log.js +0 -117
  43. package/dist/lib/api/mission-log.js.map +0 -1
  44. package/dist/lib/api/mission.d.ts +0 -498
  45. package/dist/lib/api/mission.js +0 -696
  46. package/dist/lib/api/mission.js.map +0 -1
  47. package/dist/lib/api/oauth.d.ts +0 -22
  48. package/dist/lib/api/oauth.js +0 -55
  49. package/dist/lib/api/oauth.js.map +0 -1
  50. package/dist/lib/api/package.d.ts +0 -40
  51. package/dist/lib/api/package.js +0 -70
  52. package/dist/lib/api/package.js.map +0 -1
  53. package/dist/lib/api/profile.d.ts +0 -9
  54. package/dist/lib/api/profile.js +0 -16
  55. package/dist/lib/api/profile.js.map +0 -1
  56. package/dist/lib/api/query.d.ts +0 -16
  57. package/dist/lib/api/query.js +0 -60
  58. package/dist/lib/api/query.js.map +0 -1
  59. package/dist/lib/api/repeater.d.ts +0 -47
  60. package/dist/lib/api/repeater.js +0 -62
  61. package/dist/lib/api/repeater.js.map +0 -1
  62. package/dist/lib/api/security.d.ts +0 -110
  63. package/dist/lib/api/security.js +0 -123
  64. package/dist/lib/api/security.js.map +0 -1
  65. package/dist/lib/api/subscriptions.d.ts +0 -103
  66. package/dist/lib/api/subscriptions.js +0 -74
  67. package/dist/lib/api/subscriptions.js.map +0 -1
  68. package/dist/lib/api/types.d.ts +0 -41
  69. package/dist/lib/api/types.js +0 -42
  70. package/dist/lib/api/types.js.map +0 -1
  71. package/dist/lib/api/video.d.ts +0 -139
  72. package/dist/lib/api/video.js +0 -151
  73. package/dist/lib/api/video.js.map +0 -1
  74. package/dist/lib/api.d.ts +0 -60
  75. package/dist/lib/api.js +0 -166
  76. package/dist/lib/api.js.map +0 -1
  77. package/dist/lib/auth.d.ts +0 -34
  78. package/dist/lib/auth.js +0 -97
  79. package/dist/lib/auth.js.map +0 -1
  80. package/dist/lib/commands.d.ts +0 -38
  81. package/dist/lib/commands.js +0 -34
  82. package/dist/lib/commands.js.map +0 -1
  83. package/dist/lib/fetch.d.ts +0 -8
  84. package/dist/lib/fetch.js +0 -26
  85. package/dist/lib/fetch.js.map +0 -1
  86. package/dist/lib/stream.d.ts +0 -2
  87. package/dist/lib/stream.js +0 -9
  88. package/dist/lib/stream.js.map +0 -1
  89. package/dist/test/default.test.d.ts +0 -1
  90. package/dist/test/default.test.js +0 -8
  91. package/dist/test/default.test.js.map +0 -1
  92. package/dist/test/findCoT.test.d.ts +0 -1
  93. package/dist/test/findCoT.test.js +0 -85
  94. package/dist/test/findCoT.test.js.map +0 -1
  95. package/dist/tsconfig.tsbuildinfo +0 -1
@@ -1,696 +0,0 @@
1
- import xmljs from 'xml-js';
2
- import CoT, { CoTParser } from '@tak-ps/node-cot';
3
- import { Type } from '@sinclair/typebox';
4
- import Err from '@openaddresses/batch-error';
5
- import { TAKItem, TAKList } from './types.js';
6
- import { MissionLog } from './mission-log.js';
7
- import Commands, { CommandOutputFormat } from '../commands.js';
8
- export var MissionSubscriberRole;
9
- (function (MissionSubscriberRole) {
10
- MissionSubscriberRole["MISSION_OWNER"] = "MISSION_OWNER";
11
- MissionSubscriberRole["MISSION_SUBSCRIBER"] = "MISSION_SUBSCRIBER";
12
- MissionSubscriberRole["MISSION_READONLY_SUBSCRIBER"] = "MISSION_READONLY_SUBSCRIBER";
13
- })(MissionSubscriberRole || (MissionSubscriberRole = {}));
14
- export const MissionContent = Type.Object({
15
- keywords: Type.Array(Type.String()),
16
- name: Type.String(),
17
- hash: Type.String(),
18
- submissionTime: Type.String(),
19
- uid: Type.String(),
20
- size: Type.Integer(),
21
- creatorUid: Type.Optional(Type.String()),
22
- mimeType: Type.Optional(Type.String()),
23
- submitter: Type.Optional(Type.String()),
24
- expiration: Type.Integer()
25
- });
26
- export const Mission = Type.Object({
27
- name: Type.String(),
28
- description: Type.Optional(Type.String()),
29
- chatRoom: Type.Optional(Type.String()),
30
- baseLayer: Type.Optional(Type.String()),
31
- bbox: Type.Optional(Type.String()),
32
- path: Type.Optional(Type.String()),
33
- classification: Type.Optional(Type.String()),
34
- tool: Type.String(),
35
- keywords: Type.Array(Type.String()),
36
- creatorUid: Type.Optional(Type.String()),
37
- createTime: Type.String(),
38
- externalData: Type.Array(Type.Unknown()),
39
- feeds: Type.Array(Type.Unknown()),
40
- mapLayers: Type.Array(Type.Unknown()),
41
- ownerRole: Type.Optional(Type.Object({
42
- permissions: Type.Array(Type.String()),
43
- type: Type.Enum(MissionSubscriberRole)
44
- })),
45
- inviteOnly: Type.Boolean(),
46
- expiration: Type.Number(),
47
- guid: Type.String(),
48
- uids: Type.Array(Type.Unknown()),
49
- logs: Type.Optional(Type.Array(MissionLog)), // Only present if ?logs=true
50
- contents: Type.Array(Type.Object({
51
- timestamp: Type.String(),
52
- creatorUid: Type.Optional(Type.String()),
53
- data: MissionContent
54
- })),
55
- passwordProtected: Type.Boolean(),
56
- token: Type.Optional(Type.String()), // Only present when mission created
57
- groups: Type.Optional(Type.Union([Type.String(), Type.Array(Type.String())])), // Only present on Mission.get()
58
- missionChanges: Type.Optional(Type.Array(Type.Unknown())) // Only present on Mission.get()
59
- });
60
- export const MissionChange = Type.Object({
61
- isFederatedChange: Type.Boolean(),
62
- type: Type.String(),
63
- missionName: Type.String(),
64
- timestamp: Type.String(),
65
- serverTime: Type.String(),
66
- creatorUid: Type.Optional(Type.String()),
67
- contentUid: Type.Optional(Type.String()),
68
- details: Type.Optional(Type.Object({
69
- type: Type.String(),
70
- callsign: Type.String(),
71
- color: Type.Optional(Type.String()),
72
- location: Type.Object({
73
- lat: Type.Number(),
74
- lon: Type.Number()
75
- })
76
- })),
77
- contentResource: Type.Optional(MissionContent)
78
- });
79
- export const MissionRole = Type.Object({
80
- permissions: Type.Array(Type.String()),
81
- hibernateLazyInitializer: Type.Optional(Type.Any()),
82
- type: Type.Enum(MissionSubscriberRole)
83
- });
84
- export const MissionSubscriber = Type.Object({
85
- token: Type.Optional(Type.String()),
86
- clientUid: Type.String(),
87
- username: Type.String(),
88
- createTime: Type.String(),
89
- role: MissionRole
90
- });
91
- export const MissionOptions = Type.Object({
92
- token: Type.Optional(Type.String())
93
- });
94
- export const AttachContentsInput = Type.Object({
95
- hashes: Type.Optional(Type.Array(Type.String())),
96
- uids: Type.Optional(Type.Array(Type.String())),
97
- });
98
- export const DetachContentsInput = Type.Object({
99
- hash: Type.Optional(Type.String()),
100
- uid: Type.Optional(Type.String())
101
- });
102
- export const MissionChangesInput = Type.Object({
103
- secago: Type.Optional(Type.Integer()),
104
- start: Type.Optional(Type.String()),
105
- end: Type.Optional(Type.String()),
106
- squashed: Type.Optional(Type.Boolean())
107
- });
108
- export const SubscribedInput = Type.Object({
109
- uid: Type.String(),
110
- });
111
- export const UnsubscribeInput = Type.Object({
112
- uid: Type.String(),
113
- disconnectOnly: Type.Optional(Type.Boolean())
114
- });
115
- export const SubscriptionInput = Type.Object({
116
- uid: Type.String(),
117
- });
118
- export const SubscribeInput = Type.Object({
119
- uid: Type.String(),
120
- password: Type.Optional(Type.String()),
121
- secago: Type.Optional(Type.Integer()),
122
- start: Type.Optional(Type.String()),
123
- end: Type.Optional(Type.String())
124
- });
125
- export const MissionDeleteInput = Type.Object({
126
- creatorUid: Type.Optional(Type.String()),
127
- deepDelete: Type.Optional(Type.Boolean())
128
- });
129
- export const GetInput = Type.Object({
130
- password: Type.Optional(Type.String()),
131
- changes: Type.Optional(Type.Boolean()),
132
- logs: Type.Optional(Type.Boolean()),
133
- secago: Type.Optional(Type.Integer()),
134
- start: Type.Optional(Type.String()),
135
- end: Type.Optional(Type.String())
136
- });
137
- export const SetRoleInput = Type.Object({
138
- clientUid: Type.String(),
139
- username: Type.String(),
140
- role: MissionRole
141
- });
142
- export const MissionListInput = Type.Object({
143
- passwordProtected: Type.Optional(Type.Boolean()),
144
- defaultRole: Type.Optional(Type.Boolean()),
145
- tool: Type.Optional(Type.String())
146
- });
147
- export const MissionCreateInput = Type.Object({
148
- name: Type.String(),
149
- group: Type.Optional(Type.Union([Type.Array(Type.String()), Type.String()])),
150
- keywords: Type.Optional(Type.Array(Type.String())),
151
- creatorUid: Type.String(),
152
- description: Type.Optional(Type.String({ default: '' })),
153
- chatRoom: Type.Optional(Type.String()),
154
- baseLayer: Type.Optional(Type.String()),
155
- bbox: Type.Optional(Type.String()),
156
- boundingPolygon: Type.Optional(Type.Array(Type.String())),
157
- path: Type.Optional(Type.String()),
158
- classification: Type.Optional(Type.String()),
159
- tool: Type.Optional(Type.String({ default: 'public' })),
160
- password: Type.Optional(Type.String()),
161
- defaultRole: Type.Optional(Type.String()),
162
- expiration: Type.Optional(Type.Integer()),
163
- inviteOnly: Type.Optional(Type.Boolean({ default: false })),
164
- allowDupe: Type.Optional(Type.Boolean({ default: false })),
165
- });
166
- export const MissionUpdateInput = Type.Object({
167
- creatorUid: Type.Optional(Type.String()),
168
- description: Type.Optional(Type.String()),
169
- keywords: Type.Optional(Type.Array(Type.String())),
170
- chatRoom: Type.Optional(Type.String()),
171
- baseLayer: Type.Optional(Type.String()),
172
- group: Type.Optional(Type.Union([Type.Array(Type.String()), Type.String()])),
173
- bbox: Type.Optional(Type.String()),
174
- path: Type.Optional(Type.String()),
175
- classification: Type.Optional(Type.String()),
176
- tool: Type.Optional(Type.String()),
177
- expiration: Type.Optional(Type.Integer()),
178
- inviteOnly: Type.Optional(Type.Boolean()),
179
- });
180
- export const GUIDMatch = new RegExp(/^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$/);
181
- export const TAKList_Mission = TAKList(Mission);
182
- export const TAKList_MissionInvites = TAKList(Type.String());
183
- export const TAKList_MissionChange = TAKList(MissionChange);
184
- export const TAKList_MissionSubscriber = TAKList(MissionSubscriber);
185
- export const TAKItem_MissionSubscriber = TAKItem(MissionSubscriber);
186
- /**
187
- * @class
188
- */
189
- export default class MissionCommands extends Commands {
190
- schema = {
191
- list: {
192
- description: 'List Missions',
193
- params: Type.Object({}),
194
- query: Type.Object({}),
195
- formats: [CommandOutputFormat.JSON]
196
- },
197
- };
198
- async cli(args) {
199
- if (args._[3] === 'list') {
200
- const list = await this.list({});
201
- if (args.format === 'json') {
202
- return list;
203
- }
204
- else {
205
- return list.data.map((mission) => {
206
- return `${mission.name} - ${mission.description}`;
207
- }).join('\n');
208
- }
209
- }
210
- else {
211
- throw new Error('Unsupported Subcommand');
212
- }
213
- }
214
- #isGUID(id) {
215
- return GUIDMatch.test(id);
216
- }
217
- #encodeName(name) {
218
- return encodeURIComponent(name.trim());
219
- }
220
- #headers(opts) {
221
- if (opts && opts.token) {
222
- return {
223
- MissionAuthorization: `Bearer ${opts.token}`
224
- };
225
- }
226
- else {
227
- return {};
228
- }
229
- }
230
- /**
231
- * Return Zip archive of Mission Sync
232
- *
233
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getMissionArchive_1 TAK Server Docs}.
234
- */
235
- async getArchive(name, opts) {
236
- const url = new URL(`/Marti/api/missions/${this.#encodeName(name)}/archive`, this.api.url);
237
- const res = await this.api.fetch(url, {
238
- method: 'GET',
239
- headers: this.#headers(opts),
240
- }, true);
241
- return res.body;
242
- }
243
- /**
244
- * Return Mission Sync changes in a given time range
245
- *
246
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getMissionChanges TAK Server Docs}.
247
- */
248
- async changes(name, query, opts) {
249
- if (this.#isGUID(name))
250
- name = (await this.getGuid(name, {}, opts)).name;
251
- const url = new URL(`/Marti/api/missions/${this.#encodeName(name)}/changes`, this.api.url);
252
- let q;
253
- for (q in query) {
254
- if (query[q] !== undefined) {
255
- url.searchParams.append(q, String(query[q]));
256
- }
257
- }
258
- const changes = await this.api.fetch(url, {
259
- method: 'GET',
260
- headers: this.#headers(opts),
261
- });
262
- return changes;
263
- }
264
- /**
265
- * Return all current features in the Data Sync as CoT GeoJSON Features
266
- */
267
- async latestFeats(name, opts) {
268
- const feats = [];
269
- const res = xmljs.xml2js(await this.latestCots(name, opts), { compact: true });
270
- if (!Object.keys(res.events).length)
271
- return feats;
272
- if (!res.events.event || (Array.isArray(res.events.event) && !res.events.event.length))
273
- return feats;
274
- for (const event of Array.isArray(res.events.event) ? res.events.event : [res.events.event]) {
275
- feats.push(await CoTParser.to_geojson(new CoT({ event })));
276
- }
277
- return feats;
278
- }
279
- /**
280
- * Return all current features in the Data Sync as CoT GeoJSON Features
281
- *
282
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getLatestMissionCotEvents TAK Server Docs}.
283
- */
284
- async latestCots(name, opts) {
285
- const url = this.#isGUID(name)
286
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}/cot`, this.api.url)
287
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}/cot`, this.api.url);
288
- return await this.api.fetch(url, {
289
- method: 'GET',
290
- headers: this.#headers(opts)
291
- });
292
- }
293
- /**
294
- * Return users associated with this mission
295
- *
296
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getMissionContacts TAK Server Docs}.
297
- */
298
- async contacts(name, opts) {
299
- const url = this.#isGUID(name)
300
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}/contacts`, this.api.url)
301
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}/contacts`, this.api.url);
302
- return await this.api.fetch(url, {
303
- method: 'GET',
304
- headers: this.#headers(opts)
305
- });
306
- }
307
- /**
308
- * Remove a file from the mission
309
- *
310
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/removeMissionContent TAK Server Docs}.
311
- */
312
- async detachContents(name, body, opts) {
313
- const url = this.#isGUID(name)
314
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}/contents`, this.api.url)
315
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}/contents`, this.api.url);
316
- if (body.hash)
317
- url.searchParams.append('hash', body.hash);
318
- if (body.uid)
319
- url.searchParams.append('uid', body.uid);
320
- return await this.api.fetch(url, {
321
- method: 'DELETE',
322
- headers: this.#headers(opts),
323
- });
324
- }
325
- /**
326
- * Attach a file resource by hash from the TAK Server file manager
327
- *
328
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/addMissionContent TAK Server Docs}.
329
- */
330
- async attachContents(name, body, opts) {
331
- const url = this.#isGUID(name)
332
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}/contents`, this.api.url)
333
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}/contents`, this.api.url);
334
- return await this.api.fetch(url, {
335
- method: 'PUT',
336
- headers: this.#headers(opts),
337
- body
338
- });
339
- }
340
- /**
341
- * Upload a Mission Package
342
- *
343
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/addMissionPackage TAK Server Docs}.
344
- */
345
- async upload(name, creatorUid, body, opts) {
346
- if (this.#isGUID(name))
347
- name = (await this.getGuid(name, {}, opts)).name;
348
- const url = new URL(`/Marti/api/missions/${this.#encodeName(name)}/contents/missionpackage`, this.api.url);
349
- url.searchParams.append('creatorUid', creatorUid);
350
- return await this.api.fetch(url, {
351
- method: 'PUT',
352
- headers: this.#headers(opts),
353
- body
354
- });
355
- }
356
- /**
357
- * Return UIDs associated with any subscribed users
358
- *
359
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getMissionSubscriptions TAK Server Docs}.
360
- */
361
- async subscriptions(name, opts) {
362
- const url = this.#isGUID(name)
363
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}/subscriptions`, this.api.url)
364
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}/subscriptions`, this.api.url);
365
- return await this.api.fetch(url, {
366
- method: 'GET',
367
- headers: this.#headers(opts),
368
- });
369
- }
370
- /**
371
- * Return permissions associated with any subscribed users
372
- *
373
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getMissionSubscriptionRoles TAK Server Docs}.
374
- */
375
- async subscriptionRoles(name, opts) {
376
- const url = this.#isGUID(name)
377
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}/subscriptions/roles`, this.api.url)
378
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}/subscriptions/roles`, this.api.url);
379
- return await this.api.fetch(url, {
380
- method: 'GET',
381
- headers: this.#headers(opts),
382
- });
383
- }
384
- /**
385
- * Return Role associated with a given mission if subscribed
386
- *
387
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/setMissionRole TAK Server Docs}.
388
- */
389
- async setRole(name, query, opts) {
390
- const url = this.#isGUID(name)
391
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}/role`, this.api.url)
392
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}/role`, this.api.url);
393
- let q;
394
- for (q in query) {
395
- if (query[q] !== undefined) {
396
- url.searchParams.append(q, String(query[q]));
397
- }
398
- }
399
- const res = await this.api.fetch(url, {
400
- method: 'PUT',
401
- headers: this.#headers(opts),
402
- });
403
- return res.data;
404
- }
405
- /**
406
- * Return Role associated with a given mission if subscribed
407
- *
408
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getMissionRoleFromToken TAK Server Docs}.
409
- */
410
- async role(name, opts) {
411
- const url = this.#isGUID(name)
412
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}/role`, this.api.url)
413
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}/role`, this.api.url);
414
- const res = await this.api.fetch(url, {
415
- method: 'GET',
416
- headers: this.#headers(opts),
417
- });
418
- return res.data;
419
- }
420
- /**
421
- * Return subscription associated with a given mission if subscribed
422
- *
423
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getSubscriptionForUser TAK Server Docs}.
424
- */
425
- async subscription(name, query, opts) {
426
- const url = this.#isGUID(name)
427
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}/subscription`, this.api.url)
428
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}/subscription`, this.api.url);
429
- let q;
430
- for (q in query) {
431
- if (query[q] !== undefined) {
432
- url.searchParams.append(q, String(query[q]));
433
- }
434
- }
435
- const res = await this.api.fetch(url, {
436
- method: 'GET',
437
- headers: this.#headers(opts),
438
- });
439
- return res.data;
440
- }
441
- /**
442
- * Subscribe to a mission
443
- *
444
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/createMissionSubscription TAK Server Docs}.
445
- */
446
- async subscribe(name, query, opts) {
447
- const url = this.#isGUID(name)
448
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}/subscription`, this.api.url)
449
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}/subscription`, this.api.url);
450
- let q;
451
- for (q in query) {
452
- if (query[q] !== undefined) {
453
- url.searchParams.append(q, String(query[q]));
454
- }
455
- }
456
- return await this.api.fetch(url, {
457
- method: 'PUT',
458
- headers: this.#headers(opts),
459
- });
460
- }
461
- /**
462
- * Unsubscribe from a mission
463
- *
464
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/deleteMissionSubscription TAK Server Docs}.
465
- */
466
- async unsubscribe(name, query, opts) {
467
- const url = this.#isGUID(name)
468
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}/subscription`, this.api.url)
469
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}/subscription`, this.api.url);
470
- let q;
471
- for (q in query) {
472
- if (query[q] !== undefined) {
473
- url.searchParams.append(q, String(query[q]));
474
- }
475
- }
476
- return await this.api.fetch(url, {
477
- method: 'DELETE',
478
- headers: this.#headers(opts),
479
- });
480
- }
481
- /**
482
- * List missions in currently active channels
483
- *
484
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getAllMissions_1 TAK Server Docs}.
485
- */
486
- async list(query) {
487
- const url = new URL('/Marti/api/missions', this.api.url);
488
- let q;
489
- for (q in query) {
490
- if (query[q] !== undefined) {
491
- url.searchParams.append(q, String(query[q]));
492
- }
493
- }
494
- return await this.api.fetch(url, {
495
- method: 'GET'
496
- });
497
- }
498
- /**
499
- * Get mission by its GUID
500
- *
501
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getMissionByGuid TAK Server Docs}.
502
- */
503
- async getGuid(guid, query, opts) {
504
- const url = new URL(`/Marti/api/missions/guid/${encodeURIComponent(guid)}`, this.api.url);
505
- let q;
506
- for (q in query) {
507
- if (query[q] !== undefined) {
508
- url.searchParams.append(q, String(query[q]));
509
- }
510
- }
511
- const missions = await this.api.fetch(url, {
512
- method: 'GET',
513
- headers: this.#headers(opts),
514
- });
515
- if (!missions.data.length)
516
- throw new Err(404, null, `No Mission for GUID: ${guid}`);
517
- return missions.data[0];
518
- }
519
- /**
520
- * Check if you have access to a given mission
521
- */
522
- async access(name, opts) {
523
- try {
524
- const url = this.#isGUID(name)
525
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}`, this.api.url)
526
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}`, this.api.url);
527
- const missions = await this.api.fetch(url, {
528
- method: 'GET',
529
- headers: this.#headers(opts),
530
- });
531
- if (!missions.data.length)
532
- return false;
533
- return true;
534
- }
535
- catch (err) {
536
- console.error(err);
537
- return false;
538
- }
539
- }
540
- /**
541
- * Update Mission
542
- *
543
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/createMissionAllowDupe TAK Server Docs}.
544
- */
545
- async update(name, body, opts) {
546
- let mission = await this.get(name, {}, opts);
547
- const url = new URL(`/Marti/api/missions/${encodeURIComponent(mission.name)}`, this.api.url);
548
- const bodyParams = {
549
- group: body.group ?? mission.groups,
550
- creatorUid: body.creatorUid ?? mission.creatorUid,
551
- description: body.description ?? mission.description,
552
- chatRoom: body.chatRoom ?? mission.chatRoom,
553
- baseLayer: body.baseLayer ?? mission.baseLayer,
554
- bbox: body.bbox ?? mission.bbox,
555
- path: body.path ?? mission.path,
556
- classification: body.classification ?? mission.classification,
557
- tool: body.tool ?? mission.tool,
558
- expiration: body.expiration ?? mission.expiration,
559
- inviteOnly: body.inviteOnly ?? mission.inviteOnly
560
- };
561
- let q;
562
- for (q in bodyParams) {
563
- if (body[q] !== undefined) {
564
- url.searchParams.append(q, String(body[q]));
565
- }
566
- }
567
- url.searchParams.append('allowDupe', 'false');
568
- const missions = await this.api.fetch(url, {
569
- method: 'POST'
570
- });
571
- if (!missions.data.length)
572
- throw new Error('Create Mission didn\'t return a mission or an error');
573
- mission = missions.data[0];
574
- if (body.keywords && body.keywords.length) {
575
- mission = await this.#putKeywords(mission.name, body.keywords, {
576
- token: mission.token
577
- });
578
- }
579
- return mission;
580
- }
581
- /**
582
- * Get mission by its Name
583
- *
584
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getMission TAK Server Docs}.
585
- */
586
- async get(name, query, opts) {
587
- const url = this.#isGUID(name)
588
- ? new URL(`/Marti/api/missions/guid/${encodeURIComponent(name)}`, this.api.url)
589
- : new URL(`/Marti/api/missions/${this.#encodeName(name)}`, this.api.url);
590
- let q;
591
- for (q in query) {
592
- if (query[q] !== undefined) {
593
- url.searchParams.append(q, String(query[q]));
594
- }
595
- }
596
- const missions = await this.api.fetch(url, {
597
- method: 'GET',
598
- headers: this.#headers(opts),
599
- });
600
- if (!missions.data.length)
601
- throw new Err(404, null, `No Mission for Name: ${name}`);
602
- return missions.data[0];
603
- }
604
- /**
605
- * Create a new mission
606
- *
607
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/createMission TAK Server Docs}.
608
- */
609
- async create(body) {
610
- const url = new URL(`/Marti/api/missions/${this.#encodeName(body.name)}`, this.api.url);
611
- // I want to keep this 1:1 with the TAK Server Source Code
612
- // eslint-disable-next-line no-useless-escape
613
- if (!body.name.match(/^[\p{L}\p{N}\w\d\s\.\(\)!=@#$&^*_\-\+\[\]\{\}:,\.\/\|\\]*$/u)) {
614
- throw new Err(400, null, 'Mission Name contains an invalid Character');
615
- }
616
- else if (body.name.length === 0) {
617
- throw new Err(400, null, 'Mission Name must have a length > 0');
618
- }
619
- else if (body.name.length > 1024) {
620
- throw new Err(400, null, 'Mission Name cannot exceed 1024 characters');
621
- }
622
- else if (body.name.includes('/')) {
623
- throw new Err(400, null, 'Mission Name cannot contain forward slashes');
624
- }
625
- if (body.group && Array.isArray(body.group))
626
- body.group = body.group.join(',');
627
- let q;
628
- for (q in body) {
629
- if (body[q] !== undefined && !['name', 'keywords'].includes(q)) {
630
- url.searchParams.append(q, String(body[q]));
631
- }
632
- }
633
- const missions = await this.api.fetch(url, {
634
- method: 'POST'
635
- });
636
- if (!missions.data.length)
637
- throw new Error('Create Mission didn\'t return a mission or an error');
638
- let mission = missions.data[0];
639
- if (body.keywords && body.keywords.length) {
640
- mission = await this.#putKeywords(mission.name, body.keywords, {
641
- token: mission.token
642
- });
643
- }
644
- return mission;
645
- }
646
- /**
647
- * Update Mission Keywords
648
- */
649
- async #putKeywords(name, keywords, opts) {
650
- const url = new URL(`/Marti/api/missions/${this.#encodeName(name)}/keywords`, this.api.url);
651
- const missions = await this.api.fetch(url, {
652
- method: 'PUT',
653
- headers: this.#headers(opts),
654
- body: keywords
655
- });
656
- if (!missions.data.length)
657
- throw new Error('Create Mission didn\'t return a mission or an error');
658
- const mission = missions.data[0];
659
- return mission;
660
- }
661
- /**
662
- * Delete a mission
663
- *
664
- * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/deleteMission TAK Server Docs}.
665
- */
666
- async delete(name, query, opts) {
667
- if (this.#isGUID(name)) {
668
- const url = new URL('/Marti/api/missions', this.api.url);
669
- url.searchParams.append('guid', name);
670
- let q;
671
- for (q in query) {
672
- if (query[q] !== undefined) {
673
- url.searchParams.append(q, String(query[q]));
674
- }
675
- }
676
- return await this.api.fetch(url, {
677
- method: 'DELETE',
678
- headers: this.#headers(opts),
679
- });
680
- }
681
- else {
682
- const url = new URL(`/Marti/api/missions/${this.#encodeName(name)}`, this.api.url);
683
- let q;
684
- for (q in query) {
685
- if (query[q] !== undefined) {
686
- url.searchParams.append(q, String(query[q]));
687
- }
688
- }
689
- return await this.api.fetch(url, {
690
- method: 'DELETE',
691
- headers: this.#headers(opts),
692
- });
693
- }
694
- }
695
- }
696
- //# sourceMappingURL=mission.js.map