@sonoransoftware/sonoran.js 1.0.18 → 1.0.20
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.
- package/.eslintrc.js +10 -10
- package/.github/workflows/npm-publish.yml +34 -34
- package/.prettierrc.js +6 -6
- package/dist/builders/cad/DispatchCall.d.ts +92 -92
- package/dist/builders/cad/DispatchCall.js +144 -144
- package/dist/builders/cad/index.d.ts +1 -1
- package/dist/builders/cad/index.js +17 -17
- package/dist/builders/index.d.ts +1 -1
- package/dist/builders/index.js +19 -19
- package/dist/constants.d.ts +230 -230
- package/dist/constants.js +27 -27
- package/dist/errors/LibraryErrors.d.ts +19 -19
- package/dist/errors/LibraryErrors.js +47 -47
- package/dist/errors/Messages.d.ts +1 -1
- package/dist/errors/Messages.js +8 -8
- package/dist/errors/index.d.ts +2 -2
- package/dist/errors/index.js +18 -18
- package/dist/index.d.ts +4 -4
- package/dist/index.js +24 -24
- package/dist/instance/Instance.d.ts +24 -24
- package/dist/instance/Instance.js +139 -139
- package/dist/instance/instance.types.d.ts +17 -17
- package/dist/instance/instance.types.js +2 -2
- package/dist/libs/rest/src/index.d.ts +6 -6
- package/dist/libs/rest/src/index.js +22 -22
- package/dist/libs/rest/src/lib/REST.d.ts +101 -101
- package/dist/libs/rest/src/lib/REST.js +136 -129
- package/dist/libs/rest/src/lib/RequestManager.d.ts +59 -59
- package/dist/libs/rest/src/lib/RequestManager.js +191 -191
- package/dist/libs/rest/src/lib/errors/APIError.d.ts +9 -9
- package/dist/libs/rest/src/lib/errors/APIError.js +17 -17
- package/dist/libs/rest/src/lib/errors/HTTPError.d.ts +17 -17
- package/dist/libs/rest/src/lib/errors/HTTPError.js +23 -23
- package/dist/libs/rest/src/lib/errors/RateLimitError.d.ts +13 -13
- package/dist/libs/rest/src/lib/errors/RateLimitError.js +19 -19
- package/dist/libs/rest/src/lib/errors/index.d.ts +4 -4
- package/dist/libs/rest/src/lib/errors/index.js +20 -20
- package/dist/libs/rest/src/lib/handlers/IHandler.d.ts +7 -7
- package/dist/libs/rest/src/lib/handlers/IHandler.js +2 -2
- package/dist/libs/rest/src/lib/handlers/SequentialHandler.d.ts +45 -45
- package/dist/libs/rest/src/lib/handlers/SequentialHandler.js +143 -143
- package/dist/libs/rest/src/lib/utils/constants.d.ts +533 -527
- package/dist/libs/rest/src/lib/utils/constants.js +463 -443
- package/dist/libs/rest/src/lib/utils/utils.d.ts +1 -1
- package/dist/libs/rest/src/lib/utils/utils.js +22 -22
- package/dist/managers/BaseManager.d.ts +14 -14
- package/dist/managers/BaseManager.js +18 -18
- package/dist/managers/CADActiveUnitsManager.d.ts +15 -15
- package/dist/managers/CADActiveUnitsManager.js +38 -38
- package/dist/managers/CADManager.d.ts +29 -29
- package/dist/managers/CADManager.js +86 -86
- package/dist/managers/CADServerManager.d.ts +8 -8
- package/dist/managers/CADServerManager.js +28 -28
- package/dist/managers/CMSManager.d.ts +101 -101
- package/dist/managers/CMSManager.js +266 -266
- package/dist/managers/CMSServerManager.d.ts +8 -8
- package/dist/managers/CMSServerManager.js +34 -34
- package/dist/managers/CacheManager.d.ts +10 -10
- package/dist/managers/CacheManager.js +36 -36
- package/dist/managers/DataManager.d.ts +31 -31
- package/dist/managers/DataManager.js +58 -58
- package/dist/structures/Base.d.ts +9 -9
- package/dist/structures/Base.js +24 -24
- package/dist/structures/CADActiveUnit.d.ts +47 -47
- package/dist/structures/CADActiveUnit.js +66 -66
- package/dist/structures/CADServer.d.ts +26 -26
- package/dist/structures/CADServer.js +15 -15
- package/dist/structures/CMSServer.d.ts +18 -18
- package/dist/structures/CMSServer.js +12 -12
- package/dist/utils/index.d.ts +1 -1
- package/dist/utils/index.js +17 -17
- package/dist/utils/utils.d.ts +13 -13
- package/dist/utils/utils.js +79 -79
- package/docs/CAD-Methods-and-Usage.md +58 -58
- package/docs/CMS-Methods-and-Usage.md +211 -211
- package/docs/REST-Methods-and-Usage.md +46 -46
- package/package.json +48 -48
- package/readme.md +53 -53
- package/src/constants.ts +248 -248
- package/src/instance/Instance.ts +121 -121
- package/src/instance/instance.types.ts +17 -17
- package/src/libs/rest/src/lib/REST.ts +241 -235
- package/src/libs/rest/src/lib/RequestManager.ts +260 -260
- package/src/libs/rest/src/lib/handlers/SequentialHandler.ts +160 -160
- package/src/libs/rest/src/lib/utils/constants.ts +1012 -985
- package/src/managers/CADManager.ts +63 -63
- package/src/managers/CMSManager.ts +226 -226
- package/src/managers/CMSServerManager.ts +32 -32
- package/tsconfig.json +71 -71
|
@@ -1,527 +1,533 @@
|
|
|
1
|
-
import { productEnums } from '../../../../../constants';
|
|
2
|
-
import type { RESTOptions } from '../REST';
|
|
3
|
-
export declare const DefaultUserAgent = "Sonoran.js NPM Module";
|
|
4
|
-
export declare const DefaultCADRestOptions: Required<RESTOptions>;
|
|
5
|
-
export declare const DefaultCMSRestOptions: Required<RESTOptions>;
|
|
6
|
-
/**
|
|
7
|
-
* The events that the REST manager emits
|
|
8
|
-
*/
|
|
9
|
-
export declare const enum RESTEvents {
|
|
10
|
-
Debug = "restDebug",
|
|
11
|
-
InvalidRequestWarning = "invalidRequestWarning",
|
|
12
|
-
RateLimited = "rateLimited",
|
|
13
|
-
Request = "request",
|
|
14
|
-
Response = "response"
|
|
15
|
-
}
|
|
16
|
-
export interface APITypeData {
|
|
17
|
-
type: string;
|
|
18
|
-
path: string;
|
|
19
|
-
method: 'POST' | 'GET' | 'DELETE' | 'PATCH';
|
|
20
|
-
minVersion: number;
|
|
21
|
-
}
|
|
22
|
-
export interface AllAPITypeData {
|
|
23
|
-
product: productEnums;
|
|
24
|
-
type: string;
|
|
25
|
-
path: string;
|
|
26
|
-
method: 'POST' | 'GET' | 'DELETE' | 'PATCH';
|
|
27
|
-
minVersion: number;
|
|
28
|
-
}
|
|
29
|
-
export declare const GeneralCADAPITypes: APITypeData[];
|
|
30
|
-
export declare const CivilianCADAPITypes: APITypeData[];
|
|
31
|
-
export declare const EmergencyCADAPITypes: APITypeData[];
|
|
32
|
-
export declare const GeneralCMSAPITypes: APITypeData[];
|
|
33
|
-
export declare const ServersCMSAPITypes: APITypeData[];
|
|
34
|
-
export declare const EventsCMSAPITypes: APITypeData[];
|
|
35
|
-
export declare const
|
|
36
|
-
export
|
|
37
|
-
export
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
}
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
} | {
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
} | {
|
|
461
|
-
apiId: string;
|
|
462
|
-
|
|
463
|
-
} | {
|
|
464
|
-
apiId: string;
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
} | {
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
} | {
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
} | {
|
|
517
|
-
apiId
|
|
518
|
-
|
|
519
|
-
} | {
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
1
|
+
import { productEnums } from '../../../../../constants';
|
|
2
|
+
import type { RESTOptions } from '../REST';
|
|
3
|
+
export declare const DefaultUserAgent = "Sonoran.js NPM Module";
|
|
4
|
+
export declare const DefaultCADRestOptions: Required<RESTOptions>;
|
|
5
|
+
export declare const DefaultCMSRestOptions: Required<RESTOptions>;
|
|
6
|
+
/**
|
|
7
|
+
* The events that the REST manager emits
|
|
8
|
+
*/
|
|
9
|
+
export declare const enum RESTEvents {
|
|
10
|
+
Debug = "restDebug",
|
|
11
|
+
InvalidRequestWarning = "invalidRequestWarning",
|
|
12
|
+
RateLimited = "rateLimited",
|
|
13
|
+
Request = "request",
|
|
14
|
+
Response = "response"
|
|
15
|
+
}
|
|
16
|
+
export interface APITypeData {
|
|
17
|
+
type: string;
|
|
18
|
+
path: string;
|
|
19
|
+
method: 'POST' | 'GET' | 'DELETE' | 'PATCH';
|
|
20
|
+
minVersion: number;
|
|
21
|
+
}
|
|
22
|
+
export interface AllAPITypeData {
|
|
23
|
+
product: productEnums;
|
|
24
|
+
type: string;
|
|
25
|
+
path: string;
|
|
26
|
+
method: 'POST' | 'GET' | 'DELETE' | 'PATCH';
|
|
27
|
+
minVersion: number;
|
|
28
|
+
}
|
|
29
|
+
export declare const GeneralCADAPITypes: APITypeData[];
|
|
30
|
+
export declare const CivilianCADAPITypes: APITypeData[];
|
|
31
|
+
export declare const EmergencyCADAPITypes: APITypeData[];
|
|
32
|
+
export declare const GeneralCMSAPITypes: APITypeData[];
|
|
33
|
+
export declare const ServersCMSAPITypes: APITypeData[];
|
|
34
|
+
export declare const EventsCMSAPITypes: APITypeData[];
|
|
35
|
+
export declare const FormsCMSAPITypes: APITypeData[];
|
|
36
|
+
export declare const AllAPITypes: AllAPITypeData[];
|
|
37
|
+
export type AllAPITypesType = 'GET_SERVERS' | 'SET_SERVERS' | 'GET_VERSION' | 'SET_PENAL_CODES' | 'SET_API_ID' | 'GET_TEMPLATES' | 'NEW_RECORD' | 'EDIT_RECORD' | 'REMOVE_RECORD' | 'LOOKUP_INT' | 'LOOKUP' | 'GET_ACCOUNT' | 'CHECK_APIID' | 'APPLY_PERMISSION_KEY' | 'SET_ACCOUNT_PERMISSIONS' | 'BAN_USER' | 'VERIFY_SECRET' | 'AUTH_STREETSIGNS' | 'SET_POSTALS' | 'SEND_PHOTO' | 'GET_CHARACTERS' | 'NEW_CHARACTER' | 'EDIT_CHARACTER' | 'REMOVE_CHARACTER' | 'GET_IDENTIFIERS' | 'MODIFY_IDENTIFIER' | 'SET_IDENTIFIER' | 'UNIT_PANIC' | 'UNIT_STATUS' | 'GET_BLIPS' | 'ADD_BLIP' | 'MODIFY_BLIP' | 'REMOVE_BLIP' | '911_CALL' | 'REMOVE_911' | 'GET_CALLS' | 'GET_ACTIVE_UNITS' | 'KICK_UNIT' | 'NEW_DISPATCH' | 'ATTACH_UNIT' | 'DETACH_UNIT' | 'SET_CALL_POSTAL' | 'SET_CALL_PRIMARY' | 'ADD_CALL_NOTE' | 'CLOSE_CALL' | 'UNIT_LOCATION' | 'SET_STREETSIGN_CONFIG' | 'UPDATE_STREETSIGN' | 'GET_COM_ACCOUNT' | 'GET_DEPARTMENTS' | 'GET_SUB_VERSION' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT' | 'FULL_WHITELIST' | 'GET_ACCOUNT_RANKS' | 'SET_ACCOUNT_RANKS' | 'RSVP' | 'CHANGE_FORM_STAGE';
|
|
38
|
+
export interface CMSServerAPIStruct {
|
|
39
|
+
id: number;
|
|
40
|
+
name: string;
|
|
41
|
+
description: string;
|
|
42
|
+
}
|
|
43
|
+
export interface CADServerAPIStruct {
|
|
44
|
+
id: number;
|
|
45
|
+
name: string;
|
|
46
|
+
description: string;
|
|
47
|
+
signal: string;
|
|
48
|
+
mapUrl: string;
|
|
49
|
+
mapIp: string;
|
|
50
|
+
listenerPort: number;
|
|
51
|
+
differingOutbound: boolean;
|
|
52
|
+
outboundIp: string;
|
|
53
|
+
enableMap: boolean;
|
|
54
|
+
isStatic: boolean;
|
|
55
|
+
mapType: string;
|
|
56
|
+
}
|
|
57
|
+
export interface CADPenalCodeStruct {
|
|
58
|
+
code: string;
|
|
59
|
+
type: string;
|
|
60
|
+
title: string;
|
|
61
|
+
bondType: string;
|
|
62
|
+
jailTime: string;
|
|
63
|
+
bondAmount: number;
|
|
64
|
+
}
|
|
65
|
+
export interface CADSetAPIIDStruct {
|
|
66
|
+
username: string;
|
|
67
|
+
sessionId?: string;
|
|
68
|
+
apiIds: string[];
|
|
69
|
+
pushNew: boolean;
|
|
70
|
+
}
|
|
71
|
+
export declare enum CADRecordTypeEnums {
|
|
72
|
+
Warrant = 2,
|
|
73
|
+
Bolo = 3,
|
|
74
|
+
License = 4,
|
|
75
|
+
VehicleRegistration = 5,
|
|
76
|
+
Character = 7,
|
|
77
|
+
PoliceRecord = 8,
|
|
78
|
+
PoliceReport = 9,
|
|
79
|
+
MedicalRecord = 10,
|
|
80
|
+
MedicalReport = 11,
|
|
81
|
+
FireRecord = 12,
|
|
82
|
+
FireReport = 13,
|
|
83
|
+
DMVRecord = 14,
|
|
84
|
+
LawRecord = 15,
|
|
85
|
+
LawReport = 16
|
|
86
|
+
}
|
|
87
|
+
export declare enum CADRecordSectionCategoryEnums {
|
|
88
|
+
Custom = 0,
|
|
89
|
+
Flags = 1,
|
|
90
|
+
Speed = 5,
|
|
91
|
+
Charges = 6,
|
|
92
|
+
LinkedRecords = 9
|
|
93
|
+
}
|
|
94
|
+
export interface CADRecordDependencyStruct {
|
|
95
|
+
type: string;
|
|
96
|
+
fid: string;
|
|
97
|
+
acceptableValues: string[];
|
|
98
|
+
}
|
|
99
|
+
export interface CADRecordSectionFieldStruct {
|
|
100
|
+
type: 'INPUT' | 'TEXTAREA' | 'ADDRESS' | 'SELECT' | 'STATUS' | 'DATE' | 'TIME' | 'IMAGE' | 'CHECKBOXES' | 'LABEL' | 'UNIT_NUMBER' | 'UNIT_NAME' | 'UNIT_RANK' | 'UNIT_AGENCY' | 'UNIT_DEPARTMENT' | 'UNIT_SUBDIVISION' | 'UNIT_AGENCY_LOCATION' | 'UNIT_AGENCY_ZIP' | 'UNIT_LOCATION';
|
|
101
|
+
value: string;
|
|
102
|
+
size: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
|
|
103
|
+
data: Record<string | number | symbol, unknown>;
|
|
104
|
+
options: string[];
|
|
105
|
+
isPreviewed: boolean;
|
|
106
|
+
isSupervisor: boolean;
|
|
107
|
+
isRequired: boolean;
|
|
108
|
+
unique: boolean;
|
|
109
|
+
readOnly: boolean;
|
|
110
|
+
mask: string;
|
|
111
|
+
maskReverse: boolean;
|
|
112
|
+
dbMap: boolean;
|
|
113
|
+
isFromSync: boolean;
|
|
114
|
+
uid: string;
|
|
115
|
+
dependency: CADRecordDependencyStruct;
|
|
116
|
+
}
|
|
117
|
+
export interface CADRecordSectionStruct {
|
|
118
|
+
category: CADRecordSectionCategoryEnums;
|
|
119
|
+
label: string;
|
|
120
|
+
fields: CADRecordSectionFieldStruct[];
|
|
121
|
+
searchCiv: boolean;
|
|
122
|
+
searchVeh: boolean;
|
|
123
|
+
enableDuplicate: boolean;
|
|
124
|
+
dependency: CADRecordDependencyStruct;
|
|
125
|
+
}
|
|
126
|
+
export interface CADRecordStruct {
|
|
127
|
+
recordTypeId: number;
|
|
128
|
+
id: number;
|
|
129
|
+
syncId: string;
|
|
130
|
+
name: string;
|
|
131
|
+
type: CADRecordTypeEnums;
|
|
132
|
+
sections: CADRecordSectionStruct[];
|
|
133
|
+
}
|
|
134
|
+
export interface CADNewEditRecordOptionOneStruct {
|
|
135
|
+
user: string;
|
|
136
|
+
useDictionary: boolean;
|
|
137
|
+
recordTypeId: number;
|
|
138
|
+
replaceValues: Record<string, string>;
|
|
139
|
+
}
|
|
140
|
+
export interface CADNewEditRecordOptionTwoStruct {
|
|
141
|
+
user: string;
|
|
142
|
+
record: CADRecordStruct;
|
|
143
|
+
}
|
|
144
|
+
export declare enum CADLookupByIntSearchTypeEnums {
|
|
145
|
+
IDENTIFIER = 0,
|
|
146
|
+
SUPERVISOR_STATUS = 1,
|
|
147
|
+
ACTIVE_STATUS = 2,
|
|
148
|
+
NUMBER = 3
|
|
149
|
+
}
|
|
150
|
+
export interface CADLookupByIntStruct {
|
|
151
|
+
apiId?: string;
|
|
152
|
+
searchType: CADLookupByIntSearchTypeEnums;
|
|
153
|
+
value: number;
|
|
154
|
+
types: number[];
|
|
155
|
+
limit?: number;
|
|
156
|
+
offset?: number;
|
|
157
|
+
}
|
|
158
|
+
export interface CADLookupStruct {
|
|
159
|
+
apiId?: string;
|
|
160
|
+
types: number[];
|
|
161
|
+
first: string;
|
|
162
|
+
last: string;
|
|
163
|
+
mi: string;
|
|
164
|
+
plate: string;
|
|
165
|
+
partial: boolean;
|
|
166
|
+
agency?: string;
|
|
167
|
+
department?: string;
|
|
168
|
+
subdivision?: string;
|
|
169
|
+
}
|
|
170
|
+
export interface CADModifyAccountPermsStruct {
|
|
171
|
+
apiId?: string;
|
|
172
|
+
username?: string;
|
|
173
|
+
active?: boolean;
|
|
174
|
+
add: string[];
|
|
175
|
+
remove: string[];
|
|
176
|
+
}
|
|
177
|
+
export interface CADKickBanUserStruct {
|
|
178
|
+
apiId: string;
|
|
179
|
+
isBan?: boolean;
|
|
180
|
+
isKick?: boolean;
|
|
181
|
+
}
|
|
182
|
+
export interface CADSetPostalStruct {
|
|
183
|
+
code: string;
|
|
184
|
+
x: number;
|
|
185
|
+
y: number;
|
|
186
|
+
}
|
|
187
|
+
export declare enum CADModifyIdentifierActionEnums {
|
|
188
|
+
ADD = 0,
|
|
189
|
+
EDIT = 1,
|
|
190
|
+
REMOVE = 2
|
|
191
|
+
}
|
|
192
|
+
export interface CADModifyIdentifierStruct {
|
|
193
|
+
apiId: string;
|
|
194
|
+
action: CADModifyIdentifierActionEnums;
|
|
195
|
+
identifier?: Record<string, string>;
|
|
196
|
+
identId?: number;
|
|
197
|
+
}
|
|
198
|
+
export interface CADBlipStruct {
|
|
199
|
+
id: number;
|
|
200
|
+
coordinates: {
|
|
201
|
+
x: number;
|
|
202
|
+
y: number;
|
|
203
|
+
};
|
|
204
|
+
icon: string;
|
|
205
|
+
color: string;
|
|
206
|
+
tooltip: string;
|
|
207
|
+
}
|
|
208
|
+
export interface CADAddBlipStruct {
|
|
209
|
+
serverId: number;
|
|
210
|
+
blip: CADBlipStruct;
|
|
211
|
+
}
|
|
212
|
+
export interface CADModifyBlipStruct {
|
|
213
|
+
id: number;
|
|
214
|
+
coordinates?: {
|
|
215
|
+
x: number;
|
|
216
|
+
y: number;
|
|
217
|
+
};
|
|
218
|
+
icon?: string;
|
|
219
|
+
color?: string;
|
|
220
|
+
tooltip?: string;
|
|
221
|
+
}
|
|
222
|
+
export interface CADGetCallsStruct {
|
|
223
|
+
serverId?: number;
|
|
224
|
+
closedLimit?: number;
|
|
225
|
+
closedOffset?: number;
|
|
226
|
+
}
|
|
227
|
+
export interface CADGetActiveUnitsStruct {
|
|
228
|
+
serverId?: number;
|
|
229
|
+
onlyUnits?: boolean;
|
|
230
|
+
includeOffline?: boolean;
|
|
231
|
+
limit?: number;
|
|
232
|
+
offset?: number;
|
|
233
|
+
}
|
|
234
|
+
export declare enum CADDispatchOriginEnums {
|
|
235
|
+
Caller = 0,
|
|
236
|
+
RadioDispatch = 1,
|
|
237
|
+
Observed = 2,
|
|
238
|
+
WalkUp = 3
|
|
239
|
+
}
|
|
240
|
+
export declare enum CADDispatchStatusEnums {
|
|
241
|
+
Pending = 0,
|
|
242
|
+
Active = 1,
|
|
243
|
+
Closed = 2
|
|
244
|
+
}
|
|
245
|
+
export interface CADNewDispatchStruct {
|
|
246
|
+
serverId: number;
|
|
247
|
+
origin: CADDispatchOriginEnums;
|
|
248
|
+
status: CADDispatchStatusEnums;
|
|
249
|
+
priority: 1 | 2 | 3;
|
|
250
|
+
block: string;
|
|
251
|
+
address: string;
|
|
252
|
+
postal: string;
|
|
253
|
+
title: string;
|
|
254
|
+
code: string;
|
|
255
|
+
primary: number;
|
|
256
|
+
trackPrimary: boolean;
|
|
257
|
+
description: string;
|
|
258
|
+
metaData: Record<string, string>;
|
|
259
|
+
units: string[];
|
|
260
|
+
}
|
|
261
|
+
export interface CADStreetSignStruct {
|
|
262
|
+
id: number;
|
|
263
|
+
label: string;
|
|
264
|
+
text1: string;
|
|
265
|
+
text2: string;
|
|
266
|
+
text3: string;
|
|
267
|
+
}
|
|
268
|
+
export interface CADUnitLocationStruct {
|
|
269
|
+
apiId: string;
|
|
270
|
+
location: string;
|
|
271
|
+
}
|
|
272
|
+
export interface RESTTypedAPIDataStructs {
|
|
273
|
+
GET_SERVERS: [];
|
|
274
|
+
SET_SERVERS: [
|
|
275
|
+
servers: CADServerAPIStruct[],
|
|
276
|
+
deployMap: boolean
|
|
277
|
+
];
|
|
278
|
+
GET_VERSION: [];
|
|
279
|
+
SET_PENAL_CODES: [data: CADPenalCodeStruct[]];
|
|
280
|
+
SET_API_ID: [data: CADSetAPIIDStruct];
|
|
281
|
+
GET_TEMPLATES: [recordTypeId?: number];
|
|
282
|
+
NEW_RECORD: [data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct];
|
|
283
|
+
EDIT_RECORD: [data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct];
|
|
284
|
+
REMOVE_RECORD: [id: number];
|
|
285
|
+
LOOKUP_INT: [data: CADLookupByIntStruct];
|
|
286
|
+
LOOKUP: [data: CADLookupStruct];
|
|
287
|
+
GET_ACCOUNT: [
|
|
288
|
+
apiId?: string,
|
|
289
|
+
username?: string
|
|
290
|
+
];
|
|
291
|
+
CHECK_APIID: [apiId: string];
|
|
292
|
+
APPLY_PERMISSION_KEY: [
|
|
293
|
+
apiId: string,
|
|
294
|
+
permissionKey: string
|
|
295
|
+
];
|
|
296
|
+
SET_ACCOUNT_PERMISSIONS: [data: CADModifyAccountPermsStruct];
|
|
297
|
+
BAN_USER: [data: CADKickBanUserStruct];
|
|
298
|
+
VERIFY_SECRET: [secret: string];
|
|
299
|
+
AUTH_STREETSIGNS: [serverId: number];
|
|
300
|
+
SET_POSTALS: [data: CADSetPostalStruct[]];
|
|
301
|
+
SEND_PHOTO: [
|
|
302
|
+
apiId: string,
|
|
303
|
+
url: string
|
|
304
|
+
];
|
|
305
|
+
GET_CHARACTERS: [apiId: string];
|
|
306
|
+
NEW_CHARACTER: [data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct];
|
|
307
|
+
EDIT_CHARACTER: [data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct];
|
|
308
|
+
REMOVE_CHARACTER: [id: number];
|
|
309
|
+
GET_IDENTIFIERS: [apiId: string];
|
|
310
|
+
MODIFY_IDENTIFIER: [data: CADModifyIdentifierStruct];
|
|
311
|
+
SET_IDENTIFIER: [
|
|
312
|
+
apiId: string,
|
|
313
|
+
identId: number
|
|
314
|
+
];
|
|
315
|
+
UNIT_PANIC: [
|
|
316
|
+
apiId: string,
|
|
317
|
+
isPanic: boolean
|
|
318
|
+
];
|
|
319
|
+
UNIT_STATUS: [
|
|
320
|
+
apiId: string,
|
|
321
|
+
status: number,
|
|
322
|
+
serverId: number
|
|
323
|
+
];
|
|
324
|
+
GET_BLIPS: [serverId: number];
|
|
325
|
+
ADD_BLIP: [data: CADAddBlipStruct[]];
|
|
326
|
+
MODIFY_BLIP: [data: CADModifyBlipStruct[]];
|
|
327
|
+
REMOVE_BLIP: [id: number];
|
|
328
|
+
REMOVE_911: [callId: number];
|
|
329
|
+
GET_CALLS: [data: CADGetCallsStruct];
|
|
330
|
+
GET_ACTIVE_UNITS: [data: CADGetActiveUnitsStruct];
|
|
331
|
+
KICK_UNIT: [
|
|
332
|
+
apiId: string,
|
|
333
|
+
reason: string,
|
|
334
|
+
serverId: number
|
|
335
|
+
];
|
|
336
|
+
NEW_DISPATCH: [data: CADNewDispatchStruct];
|
|
337
|
+
ATTACH_UNIT: [
|
|
338
|
+
serverId: number,
|
|
339
|
+
callId: number,
|
|
340
|
+
units: string[]
|
|
341
|
+
];
|
|
342
|
+
DETACH_UNIT: [
|
|
343
|
+
serverId: number,
|
|
344
|
+
units: string[]
|
|
345
|
+
];
|
|
346
|
+
SET_CALL_POSTAL: [
|
|
347
|
+
serverId: number,
|
|
348
|
+
callId: number,
|
|
349
|
+
postal: string
|
|
350
|
+
];
|
|
351
|
+
SET_CALL_PRIMARY: [
|
|
352
|
+
serverId: number,
|
|
353
|
+
callId: number,
|
|
354
|
+
primary: number,
|
|
355
|
+
trackPrimary: boolean
|
|
356
|
+
];
|
|
357
|
+
ADD_CALL_NOTE: [
|
|
358
|
+
serverId: number,
|
|
359
|
+
callId: number,
|
|
360
|
+
note: string
|
|
361
|
+
];
|
|
362
|
+
CLOSE_CALL: [
|
|
363
|
+
serverId: number,
|
|
364
|
+
callId: number
|
|
365
|
+
];
|
|
366
|
+
'CALL_911': [
|
|
367
|
+
serverId: number,
|
|
368
|
+
isEmergency: boolean,
|
|
369
|
+
caller: string,
|
|
370
|
+
location: string,
|
|
371
|
+
description: string,
|
|
372
|
+
metaData: Record<string, string>
|
|
373
|
+
];
|
|
374
|
+
SET_STREETSIGN_CONFIG: [
|
|
375
|
+
serverId: number,
|
|
376
|
+
signConfig: CADStreetSignStruct[]
|
|
377
|
+
];
|
|
378
|
+
UPDATE_STREETSIGN: [
|
|
379
|
+
serverId: number,
|
|
380
|
+
signData: {
|
|
381
|
+
ids: number[];
|
|
382
|
+
text1: string;
|
|
383
|
+
text2: string;
|
|
384
|
+
text3: string;
|
|
385
|
+
}
|
|
386
|
+
];
|
|
387
|
+
UNIT_LOCATION: [data: CADUnitLocationStruct[]];
|
|
388
|
+
GET_COM_ACCOUNT: [
|
|
389
|
+
apiId?: string,
|
|
390
|
+
username?: string,
|
|
391
|
+
accId?: string,
|
|
392
|
+
discord?: string
|
|
393
|
+
];
|
|
394
|
+
GET_SUB_VERSION: [];
|
|
395
|
+
CHECK_COM_APIID: [apiId: string];
|
|
396
|
+
CLOCK_IN_OUT: [
|
|
397
|
+
apiId?: string,
|
|
398
|
+
accId?: string,
|
|
399
|
+
forceClockIn?: boolean
|
|
400
|
+
];
|
|
401
|
+
GET_DEPARTMENTS: [];
|
|
402
|
+
GET_ACCOUNT_RANKS: [
|
|
403
|
+
apiId?: string,
|
|
404
|
+
username?: string,
|
|
405
|
+
accId?: string,
|
|
406
|
+
discord?: string
|
|
407
|
+
];
|
|
408
|
+
SET_ACCOUNT_RANKS: [
|
|
409
|
+
accountId: string,
|
|
410
|
+
set?: {
|
|
411
|
+
primary?: string | null;
|
|
412
|
+
secondary?: string[];
|
|
413
|
+
},
|
|
414
|
+
add?: string[],
|
|
415
|
+
remove?: string[]
|
|
416
|
+
];
|
|
417
|
+
GET_GAME_SERVERS: [];
|
|
418
|
+
VERIFY_WHITELIST: [
|
|
419
|
+
apiId: string | undefined,
|
|
420
|
+
accId: string | undefined,
|
|
421
|
+
serverId: number
|
|
422
|
+
];
|
|
423
|
+
FULL_WHITELIST: [
|
|
424
|
+
serverId?: number
|
|
425
|
+
];
|
|
426
|
+
RSVP: [
|
|
427
|
+
eventId: string,
|
|
428
|
+
apiId: string | undefined,
|
|
429
|
+
accId: string | undefined
|
|
430
|
+
];
|
|
431
|
+
CHANGE_FORM_STAGE: [
|
|
432
|
+
accId: string,
|
|
433
|
+
formId: number,
|
|
434
|
+
newStageId: string
|
|
435
|
+
];
|
|
436
|
+
}
|
|
437
|
+
export type PossibleRequestData = undefined | {
|
|
438
|
+
data: CADPenalCodeStruct[] | CADSetAPIIDStruct | CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct | CADLookupByIntStruct | CADLookupStruct | CADModifyAccountPermsStruct | CADKickBanUserStruct | CADSetPostalStruct[] | CADModifyIdentifierStruct | CADAddBlipStruct[] | CADModifyBlipStruct[] | CADGetCallsStruct | CADGetActiveUnitsStruct | CADNewDispatchStruct;
|
|
439
|
+
} | {
|
|
440
|
+
servers: CADServerAPIStruct[];
|
|
441
|
+
deployMap: boolean;
|
|
442
|
+
} | {
|
|
443
|
+
id: number;
|
|
444
|
+
} | {
|
|
445
|
+
recordTypeId?: number;
|
|
446
|
+
} | {
|
|
447
|
+
apiId?: string;
|
|
448
|
+
username?: string;
|
|
449
|
+
} | {
|
|
450
|
+
apiId: string;
|
|
451
|
+
} | {
|
|
452
|
+
apiId: string;
|
|
453
|
+
permissionKey: string;
|
|
454
|
+
} | {
|
|
455
|
+
secret: string;
|
|
456
|
+
} | {
|
|
457
|
+
serverId: number;
|
|
458
|
+
} | {
|
|
459
|
+
serverId?: number;
|
|
460
|
+
} | {
|
|
461
|
+
apiId: string;
|
|
462
|
+
url: string;
|
|
463
|
+
} | {
|
|
464
|
+
apiId: string;
|
|
465
|
+
identId: number;
|
|
466
|
+
} | {
|
|
467
|
+
apiId: string;
|
|
468
|
+
isPanic: boolean;
|
|
469
|
+
} | {
|
|
470
|
+
apiId: string;
|
|
471
|
+
status: number;
|
|
472
|
+
serverId: number;
|
|
473
|
+
} | {
|
|
474
|
+
callId: number;
|
|
475
|
+
} | {
|
|
476
|
+
serverId: number;
|
|
477
|
+
callId: number;
|
|
478
|
+
units: string[];
|
|
479
|
+
} | {
|
|
480
|
+
serverId: number;
|
|
481
|
+
units: string[];
|
|
482
|
+
} | {
|
|
483
|
+
serverId: number;
|
|
484
|
+
callId: number;
|
|
485
|
+
postal: string;
|
|
486
|
+
} | {
|
|
487
|
+
serverId: number;
|
|
488
|
+
callId: number;
|
|
489
|
+
primary: number;
|
|
490
|
+
trackPrimary: boolean;
|
|
491
|
+
} | {
|
|
492
|
+
serverId: number;
|
|
493
|
+
callId: number;
|
|
494
|
+
note: string;
|
|
495
|
+
} | {
|
|
496
|
+
serverId: number;
|
|
497
|
+
callId: number;
|
|
498
|
+
} | {
|
|
499
|
+
serverId: number;
|
|
500
|
+
isEmergency: boolean;
|
|
501
|
+
caller: string;
|
|
502
|
+
location: string;
|
|
503
|
+
description: string;
|
|
504
|
+
metaData: Record<string, string>;
|
|
505
|
+
} | {
|
|
506
|
+
serverId: number;
|
|
507
|
+
signConfig: CADStreetSignStruct[];
|
|
508
|
+
} | {
|
|
509
|
+
serverId: number;
|
|
510
|
+
signData: {
|
|
511
|
+
ids: number[];
|
|
512
|
+
text1: string;
|
|
513
|
+
text2: string;
|
|
514
|
+
text3: string;
|
|
515
|
+
};
|
|
516
|
+
} | {
|
|
517
|
+
apiId?: string;
|
|
518
|
+
username?: string;
|
|
519
|
+
} | {
|
|
520
|
+
apiId: string;
|
|
521
|
+
serverId: number;
|
|
522
|
+
} | {
|
|
523
|
+
apiId: string;
|
|
524
|
+
forceClockIn: boolean;
|
|
525
|
+
} | {
|
|
526
|
+
accountId: string;
|
|
527
|
+
set?: {
|
|
528
|
+
primary: string[];
|
|
529
|
+
secondary: string[];
|
|
530
|
+
};
|
|
531
|
+
add?: string[];
|
|
532
|
+
remove?: string[];
|
|
533
|
+
};
|