camstreamerlib 4.0.33-a07b434 → 4.0.33-dfd8bbb

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 (11) hide show
  1. package/cjs/CamOverlayAPI.d.ts +1 -0
  2. package/cjs/CamOverlayAPI.js +7 -0
  3. package/cjs/PlaneTrackerAPI.d.ts +7 -25
  4. package/cjs/types/PlaneTrackerAPI.d.ts +21 -125
  5. package/cjs/types/PlaneTrackerAPI.js +6 -28
  6. package/esm/CamOverlayAPI.js +7 -0
  7. package/esm/types/PlaneTrackerAPI.js +6 -28
  8. package/package.json +1 -1
  9. package/types/CamOverlayAPI.d.ts +1 -0
  10. package/types/PlaneTrackerAPI.d.ts +7 -25
  11. package/types/types/PlaneTrackerAPI.d.ts +21 -125
package/cjs/CamOverlayAPI.d.ts CHANGED
@@ -14,6 +14,7 @@ export declare class CamOverlayAPI<Client extends IClient<TResponse, any>> exten
14
14
  }[]>;
15
15
  wsAuthorization(options?: THttpRequestOptions): Promise<string>;
16
16
  getMjpegStreamImage(mjpegUrl: string, options?: THttpRequestOptions): Promise<ReturnType<Awaited<ReturnType<Client["get"]>>["blob"]>>;
17
+ isViewerPassValid(pass: string, options?: THttpRequestOptions): Promise<boolean>;
17
18
  listFiles<T extends TFileType>(fileType: T, options?: THttpRequestOptions): Promise<TFileList<T>>;
18
19
  uploadFile<T extends TFileType>(fileType: T, formData: Parameters<Client['post']>[0]['data'], storage: TFileStorageType<T>, options?: THttpRequestOptions): Promise<void>;
19
20
  removeFile<T extends TFileType>(fileType: T, fileParams: TFile<T>, options?: THttpRequestOptions): Promise<void>;
package/cjs/CamOverlayAPI.js CHANGED
@@ -29,6 +29,13 @@ class CamOverlayAPI extends BasicAPI_1.BasicAPI {
29
29
  async getMjpegStreamImage(mjpegUrl, options) {
30
30
  return await this._getBlob(`${BASE_PATH}/fetch_mjpeg_image.cgi`, { mjpeg_url: decodeURIComponent(mjpegUrl) }, options);
31
31
  }
32
+ async isViewerPassValid(pass, options) {
33
+ const res = await this._getJson(`${BASE_PATH}/check_pass.cgi`, { pass }, options);
34
+ if (res.status !== 200) {
35
+ throw new Error(res.message);
36
+ }
37
+ return res.data === '1';
38
+ }
32
39
  async listFiles(fileType, options) {
33
40
  const res = await this._getJson(`${BASE_PATH}/upload_${fileType}.cgi`, { action: 'list' }, options);
34
41
  return (0, CamOverlayAPI_1.getFileListSchema)(fileType).parse(res.list);
package/cjs/PlaneTrackerAPI.d.ts CHANGED
@@ -99,29 +99,11 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
99
99
  priority: number;
100
100
  };
101
101
  identificationLabel: {
102
- aircraft: {
103
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
104
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
105
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
106
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
107
- opacity: number;
108
- };
109
- drone: {
110
- firstRow: "blank" | "remote_id";
111
- opacity: number;
112
- };
113
- } | {
114
- aircraft: {
115
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
116
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
117
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
118
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
119
- opacity: number;
120
- };
121
- drone: {
122
- readonly firstRow: "remote_id";
123
- readonly opacity: 30;
124
- };
102
+ firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
103
+ secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
104
+ thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
105
+ fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
106
+ opacity: number;
125
107
  };
126
108
  acs: {
127
109
  ip: string;
@@ -199,11 +181,11 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
199
181
  importAppSettings(dataType: TImportDataType, formData: Parameters<Client['post']>[0]['data'], options?: THttpRequestOptions): Promise<void>;
200
182
  getDomainList(options?: THttpRequestOptions): Promise<Partial<Record<"adsb" | "remoteId", {
201
183
  uiName: string;
202
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
184
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
203
185
  categoryList: {
204
186
  categoryId: string;
205
187
  uiName: string;
206
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
188
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
207
189
  }[];
208
190
  }>>>;
209
191
  fetchFlightInfo(targetId: string, options?: THttpRequestOptions): Promise<{
package/cjs/types/PlaneTrackerAPI.d.ts CHANGED
@@ -69,8 +69,6 @@ export declare const widgetSchema: z.ZodObject<{
69
69
  }>;
70
70
  declare const labelOptionsSchema: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
71
71
  export type TLabelOption = z.infer<typeof labelOptionsSchema>;
72
- declare const droneLabelOptionsSchema: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"remote_id">]>;
73
- export type TDroneLabelOption = z.infer<typeof droneLabelOptionsSchema>;
74
72
  export declare const cameraSettingsSchema: z.ZodObject<{
75
73
  units: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"metric">, z.ZodLiteral<"imperial">]>>;
76
74
  adsbSource: z.ZodDefault<z.ZodObject<{
@@ -349,61 +347,7 @@ export declare const cameraSettingsSchema: z.ZodObject<{
349
347
  port?: number | undefined;
350
348
  priority?: number | undefined;
351
349
  }>>;
352
- identificationLabel: z.ZodDefault<z.ZodUnion<[z.ZodObject<{
353
- aircraft: z.ZodObject<{
354
- firstRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
355
- secondRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
356
- thirdRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
357
- fourthRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
358
- opacity: z.ZodNumber;
359
- }, "strip", z.ZodTypeAny, {
360
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
361
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
362
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
363
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
364
- opacity: number;
365
- }, {
366
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
367
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
368
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
369
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
370
- opacity: number;
371
- }>;
372
- drone: z.ZodDefault<z.ZodObject<{
373
- firstRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"remote_id">]>;
374
- opacity: z.ZodNumber;
375
- }, "strip", z.ZodTypeAny, {
376
- firstRow: "blank" | "remote_id";
377
- opacity: number;
378
- }, {
379
- firstRow: "blank" | "remote_id";
380
- opacity: number;
381
- }>>;
382
- }, "strip", z.ZodTypeAny, {
383
- aircraft: {
384
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
385
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
386
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
387
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
388
- opacity: number;
389
- };
390
- drone: {
391
- firstRow: "blank" | "remote_id";
392
- opacity: number;
393
- };
394
- }, {
395
- aircraft: {
396
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
397
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
398
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
399
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
400
- opacity: number;
401
- };
402
- drone?: {
403
- firstRow: "blank" | "remote_id";
404
- opacity: number;
405
- } | undefined;
406
- }>, z.ZodEffects<z.ZodObject<{
350
+ identificationLabel: z.ZodDefault<z.ZodObject<{
407
351
  firstRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
408
352
  secondRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
409
353
  thirdRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
@@ -421,25 +365,7 @@ export declare const cameraSettingsSchema: z.ZodObject<{
421
365
  thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
422
366
  fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
423
367
  opacity: number;
424
- }>, {
425
- aircraft: {
426
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
427
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
428
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
429
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
430
- opacity: number;
431
- };
432
- drone: {
433
- readonly firstRow: "remote_id";
434
- readonly opacity: 30;
435
- };
436
- }, {
437
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
438
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
439
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
440
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
441
- opacity: number;
442
- }>]>>;
368
+ }>>;
443
369
  acs: z.ZodDefault<z.ZodObject<{
444
370
  protocol: z.ZodUnion<[z.ZodLiteral<"http">, z.ZodLiteral<"https">, z.ZodLiteral<"https_insecure">]>;
445
371
  ip: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;
@@ -588,29 +514,11 @@ export declare const cameraSettingsSchema: z.ZodObject<{
588
514
  priority: number;
589
515
  };
590
516
  identificationLabel: {
591
- aircraft: {
592
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
593
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
594
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
595
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
596
- opacity: number;
597
- };
598
- drone: {
599
- firstRow: "blank" | "remote_id";
600
- opacity: number;
601
- };
602
- } | {
603
- aircraft: {
604
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
605
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
606
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
607
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
608
- opacity: number;
609
- };
610
- drone: {
611
- readonly firstRow: "remote_id";
612
- readonly opacity: 30;
613
- };
517
+ firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
518
+ secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
519
+ thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
520
+ fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
521
+ opacity: number;
614
522
  };
615
523
  acs: {
616
524
  ip: string;
@@ -769,18 +677,6 @@ export declare const cameraSettingsSchema: z.ZodObject<{
769
677
  thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
770
678
  fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
771
679
  opacity: number;
772
- } | {
773
- aircraft: {
774
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
775
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
776
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
777
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
778
- opacity: number;
779
- };
780
- drone?: {
781
- firstRow: "blank" | "remote_id";
782
- opacity: number;
783
- } | undefined;
784
680
  } | undefined;
785
681
  acs?: {
786
682
  ip: string;
@@ -1313,11 +1209,11 @@ declare const categoryDescriptorSchema: z.ZodObject<{
1313
1209
  }, "strip", z.ZodTypeAny, {
1314
1210
  categoryId: string;
1315
1211
  uiName: string;
1316
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1212
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1317
1213
  }, {
1318
1214
  categoryId: string;
1319
1215
  uiName: string;
1320
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1216
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1321
1217
  }>;
1322
1218
  export type TCategoryDescriptor = z.infer<typeof categoryDescriptorSchema>;
1323
1219
  declare const domainDescriptorSchema: z.ZodObject<{
@@ -1330,27 +1226,27 @@ declare const domainDescriptorSchema: z.ZodObject<{
1330
1226
  }, "strip", z.ZodTypeAny, {
1331
1227
  categoryId: string;
1332
1228
  uiName: string;
1333
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1229
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1334
1230
  }, {
1335
1231
  categoryId: string;
1336
1232
  uiName: string;
1337
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1233
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1338
1234
  }>, "many">;
1339
1235
  }, "strip", z.ZodTypeAny, {
1340
1236
  uiName: string;
1341
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1237
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1342
1238
  categoryList: {
1343
1239
  categoryId: string;
1344
1240
  uiName: string;
1345
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1241
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1346
1242
  }[];
1347
1243
  }, {
1348
1244
  uiName: string;
1349
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1245
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1350
1246
  categoryList: {
1351
1247
  categoryId: string;
1352
1248
  uiName: string;
1353
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1249
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1354
1250
  }[];
1355
1251
  }>;
1356
1252
  export type TDomainDescriptor = z.infer<typeof domainDescriptorSchema>;
@@ -1364,27 +1260,27 @@ export declare const domainListSchema: z.ZodRecord<z.ZodEnum<["adsb", "remoteId"
1364
1260
  }, "strip", z.ZodTypeAny, {
1365
1261
  categoryId: string;
1366
1262
  uiName: string;
1367
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1263
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1368
1264
  }, {
1369
1265
  categoryId: string;
1370
1266
  uiName: string;
1371
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1267
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1372
1268
  }>, "many">;
1373
1269
  }, "strip", z.ZodTypeAny, {
1374
1270
  uiName: string;
1375
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1271
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1376
1272
  categoryList: {
1377
1273
  categoryId: string;
1378
1274
  uiName: string;
1379
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1275
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1380
1276
  }[];
1381
1277
  }, {
1382
1278
  uiName: string;
1383
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1279
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1384
1280
  categoryList: {
1385
1281
  categoryId: string;
1386
1282
  uiName: string;
1387
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1283
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1388
1284
  }[];
1389
1285
  }>>;
1390
1286
  export type TDomainList = z.infer<typeof domainListSchema>;
package/cjs/types/PlaneTrackerAPI.js CHANGED
@@ -40,32 +40,13 @@ const labelOptionsSchema = zod_1.z.union([
40
40
  zod_1.z.literal('flight_number'),
41
41
  zod_1.z.literal('icao'),
42
42
  ]);
43
- const aircraftIdentificationLabelSchema = zod_1.z.object({
43
+ const identificationLabelSchema = zod_1.z.object({
44
44
  firstRow: labelOptionsSchema,
45
45
  secondRow: labelOptionsSchema,
46
46
  thirdRow: labelOptionsSchema,
47
47
  fourthRow: labelOptionsSchema,
48
48
  opacity: zod_1.z.number().positive(),
49
49
  });
50
- const droneLabelOptionsSchema = zod_1.z.union([zod_1.z.literal('blank'), zod_1.z.literal('remote_id')]);
51
- const droneIdentificationLabelSchema = zod_1.z.object({
52
- firstRow: droneLabelOptionsSchema,
53
- opacity: zod_1.z.number().positive(),
54
- });
55
- const DEFAULT_DRONE_IDENTIFICATION_LABEL = {
56
- firstRow: 'remote_id',
57
- opacity: 30,
58
- };
59
- const identificationLabelSchema = zod_1.z.union([
60
- zod_1.z.object({
61
- aircraft: aircraftIdentificationLabelSchema,
62
- drone: droneIdentificationLabelSchema.default(DEFAULT_DRONE_IDENTIFICATION_LABEL),
63
- }),
64
- aircraftIdentificationLabelSchema.transform((aircraft) => ({
65
- aircraft,
66
- drone: DEFAULT_DRONE_IDENTIFICATION_LABEL,
67
- })),
68
- ]);
69
50
  exports.cameraSettingsSchema = zod_1.z.object({
70
51
  units: zod_1.z.union([zod_1.z.literal('metric'), zod_1.z.literal('imperial')]).default('imperial'),
71
52
  adsbSource: zod_1.z
@@ -222,14 +203,11 @@ exports.cameraSettingsSchema = zod_1.z.object({
222
203
  port: 80,
223
204
  }),
224
205
  identificationLabel: identificationLabelSchema.default({
225
- aircraft: {
226
- firstRow: 'registration',
227
- secondRow: 'blank',
228
- thirdRow: 'blank',
229
- fourthRow: 'blank',
230
- opacity: 30,
231
- },
232
- drone: DEFAULT_DRONE_IDENTIFICATION_LABEL,
206
+ firstRow: 'registration',
207
+ secondRow: 'blank',
208
+ thirdRow: 'blank',
209
+ fourthRow: 'blank',
210
+ opacity: 30,
233
211
  }),
234
212
  acs: exports.connectionSchema
235
213
  .extend({
package/esm/CamOverlayAPI.js CHANGED
@@ -26,6 +26,13 @@ export class CamOverlayAPI extends BasicAPI {
26
26
  async getMjpegStreamImage(mjpegUrl, options) {
27
27
  return await this._getBlob(`${BASE_PATH}/fetch_mjpeg_image.cgi`, { mjpeg_url: decodeURIComponent(mjpegUrl) }, options);
28
28
  }
29
+ async isViewerPassValid(pass, options) {
30
+ const res = await this._getJson(`${BASE_PATH}/check_pass.cgi`, { pass }, options);
31
+ if (res.status !== 200) {
32
+ throw new Error(res.message);
33
+ }
34
+ return res.data === '1';
35
+ }
29
36
  async listFiles(fileType, options) {
30
37
  const res = await this._getJson(`${BASE_PATH}/upload_${fileType}.cgi`, { action: 'list' }, options);
31
38
  return getFileListSchema(fileType).parse(res.list);
package/esm/types/PlaneTrackerAPI.js CHANGED
@@ -37,32 +37,13 @@ const labelOptionsSchema = z.union([
37
37
  z.literal('flight_number'),
38
38
  z.literal('icao'),
39
39
  ]);
40
- const aircraftIdentificationLabelSchema = z.object({
40
+ const identificationLabelSchema = z.object({
41
41
  firstRow: labelOptionsSchema,
42
42
  secondRow: labelOptionsSchema,
43
43
  thirdRow: labelOptionsSchema,
44
44
  fourthRow: labelOptionsSchema,
45
45
  opacity: z.number().positive(),
46
46
  });
47
- const droneLabelOptionsSchema = z.union([z.literal('blank'), z.literal('remote_id')]);
48
- const droneIdentificationLabelSchema = z.object({
49
- firstRow: droneLabelOptionsSchema,
50
- opacity: z.number().positive(),
51
- });
52
- const DEFAULT_DRONE_IDENTIFICATION_LABEL = {
53
- firstRow: 'remote_id',
54
- opacity: 30,
55
- };
56
- const identificationLabelSchema = z.union([
57
- z.object({
58
- aircraft: aircraftIdentificationLabelSchema,
59
- drone: droneIdentificationLabelSchema.default(DEFAULT_DRONE_IDENTIFICATION_LABEL),
60
- }),
61
- aircraftIdentificationLabelSchema.transform((aircraft) => ({
62
- aircraft,
63
- drone: DEFAULT_DRONE_IDENTIFICATION_LABEL,
64
- })),
65
- ]);
66
47
  export const cameraSettingsSchema = z.object({
67
48
  units: z.union([z.literal('metric'), z.literal('imperial')]).default('imperial'),
68
49
  adsbSource: z
@@ -219,14 +200,11 @@ export const cameraSettingsSchema = z.object({
219
200
  port: 80,
220
201
  }),
221
202
  identificationLabel: identificationLabelSchema.default({
222
- aircraft: {
223
- firstRow: 'registration',
224
- secondRow: 'blank',
225
- thirdRow: 'blank',
226
- fourthRow: 'blank',
227
- opacity: 30,
228
- },
229
- drone: DEFAULT_DRONE_IDENTIFICATION_LABEL,
203
+ firstRow: 'registration',
204
+ secondRow: 'blank',
205
+ thirdRow: 'blank',
206
+ fourthRow: 'blank',
207
+ opacity: 30,
230
208
  }),
231
209
  acs: connectionSchema
232
210
  .extend({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "camstreamerlib",
3
- "version": "4.0.33-a07b434",
3
+ "version": "4.0.33-dfd8bbb",
4
4
  "description": "Helper library for CamStreamer ACAP applications.",
5
5
  "prettier": "@camstreamer/prettier-config",
6
6
  "engine": {
package/types/CamOverlayAPI.d.ts CHANGED
@@ -14,6 +14,7 @@ export declare class CamOverlayAPI<Client extends IClient<TResponse, any>> exten
14
14
  }[]>;
15
15
  wsAuthorization(options?: THttpRequestOptions): Promise<string>;
16
16
  getMjpegStreamImage(mjpegUrl: string, options?: THttpRequestOptions): Promise<ReturnType<Awaited<ReturnType<Client["get"]>>["blob"]>>;
17
+ isViewerPassValid(pass: string, options?: THttpRequestOptions): Promise<boolean>;
17
18
  listFiles<T extends TFileType>(fileType: T, options?: THttpRequestOptions): Promise<TFileList<T>>;
18
19
  uploadFile<T extends TFileType>(fileType: T, formData: Parameters<Client['post']>[0]['data'], storage: TFileStorageType<T>, options?: THttpRequestOptions): Promise<void>;
19
20
  removeFile<T extends TFileType>(fileType: T, fileParams: TFile<T>, options?: THttpRequestOptions): Promise<void>;
package/types/PlaneTrackerAPI.d.ts CHANGED
@@ -99,29 +99,11 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
99
99
  priority: number;
100
100
  };
101
101
  identificationLabel: {
102
- aircraft: {
103
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
104
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
105
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
106
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
107
- opacity: number;
108
- };
109
- drone: {
110
- firstRow: "blank" | "remote_id";
111
- opacity: number;
112
- };
113
- } | {
114
- aircraft: {
115
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
116
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
117
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
118
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
119
- opacity: number;
120
- };
121
- drone: {
122
- readonly firstRow: "remote_id";
123
- readonly opacity: 30;
124
- };
102
+ firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
103
+ secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
104
+ thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
105
+ fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
106
+ opacity: number;
125
107
  };
126
108
  acs: {
127
109
  ip: string;
@@ -199,11 +181,11 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
199
181
  importAppSettings(dataType: TImportDataType, formData: Parameters<Client['post']>[0]['data'], options?: THttpRequestOptions): Promise<void>;
200
182
  getDomainList(options?: THttpRequestOptions): Promise<Partial<Record<"adsb" | "remoteId", {
201
183
  uiName: string;
202
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
184
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
203
185
  categoryList: {
204
186
  categoryId: string;
205
187
  uiName: string;
206
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
188
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
207
189
  }[];
208
190
  }>>>;
209
191
  fetchFlightInfo(targetId: string, options?: THttpRequestOptions): Promise<{
package/types/types/PlaneTrackerAPI.d.ts CHANGED
@@ -69,8 +69,6 @@ export declare const widgetSchema: z.ZodObject<{
69
69
  }>;
70
70
  declare const labelOptionsSchema: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
71
71
  export type TLabelOption = z.infer<typeof labelOptionsSchema>;
72
- declare const droneLabelOptionsSchema: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"remote_id">]>;
73
- export type TDroneLabelOption = z.infer<typeof droneLabelOptionsSchema>;
74
72
  export declare const cameraSettingsSchema: z.ZodObject<{
75
73
  units: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"metric">, z.ZodLiteral<"imperial">]>>;
76
74
  adsbSource: z.ZodDefault<z.ZodObject<{
@@ -349,61 +347,7 @@ export declare const cameraSettingsSchema: z.ZodObject<{
349
347
  port?: number | undefined;
350
348
  priority?: number | undefined;
351
349
  }>>;
352
- identificationLabel: z.ZodDefault<z.ZodUnion<[z.ZodObject<{
353
- aircraft: z.ZodObject<{
354
- firstRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
355
- secondRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
356
- thirdRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
357
- fourthRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
358
- opacity: z.ZodNumber;
359
- }, "strip", z.ZodTypeAny, {
360
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
361
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
362
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
363
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
364
- opacity: number;
365
- }, {
366
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
367
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
368
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
369
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
370
- opacity: number;
371
- }>;
372
- drone: z.ZodDefault<z.ZodObject<{
373
- firstRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"remote_id">]>;
374
- opacity: z.ZodNumber;
375
- }, "strip", z.ZodTypeAny, {
376
- firstRow: "blank" | "remote_id";
377
- opacity: number;
378
- }, {
379
- firstRow: "blank" | "remote_id";
380
- opacity: number;
381
- }>>;
382
- }, "strip", z.ZodTypeAny, {
383
- aircraft: {
384
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
385
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
386
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
387
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
388
- opacity: number;
389
- };
390
- drone: {
391
- firstRow: "blank" | "remote_id";
392
- opacity: number;
393
- };
394
- }, {
395
- aircraft: {
396
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
397
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
398
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
399
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
400
- opacity: number;
401
- };
402
- drone?: {
403
- firstRow: "blank" | "remote_id";
404
- opacity: number;
405
- } | undefined;
406
- }>, z.ZodEffects<z.ZodObject<{
350
+ identificationLabel: z.ZodDefault<z.ZodObject<{
407
351
  firstRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
408
352
  secondRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
409
353
  thirdRow: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
@@ -421,25 +365,7 @@ export declare const cameraSettingsSchema: z.ZodObject<{
421
365
  thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
422
366
  fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
423
367
  opacity: number;
424
- }>, {
425
- aircraft: {
426
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
427
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
428
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
429
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
430
- opacity: number;
431
- };
432
- drone: {
433
- readonly firstRow: "remote_id";
434
- readonly opacity: 30;
435
- };
436
- }, {
437
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
438
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
439
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
440
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
441
- opacity: number;
442
- }>]>>;
368
+ }>>;
443
369
  acs: z.ZodDefault<z.ZodObject<{
444
370
  protocol: z.ZodUnion<[z.ZodLiteral<"http">, z.ZodLiteral<"https">, z.ZodLiteral<"https_insecure">]>;
445
371
  ip: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;
@@ -588,29 +514,11 @@ export declare const cameraSettingsSchema: z.ZodObject<{
588
514
  priority: number;
589
515
  };
590
516
  identificationLabel: {
591
- aircraft: {
592
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
593
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
594
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
595
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
596
- opacity: number;
597
- };
598
- drone: {
599
- firstRow: "blank" | "remote_id";
600
- opacity: number;
601
- };
602
- } | {
603
- aircraft: {
604
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
605
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
606
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
607
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
608
- opacity: number;
609
- };
610
- drone: {
611
- readonly firstRow: "remote_id";
612
- readonly opacity: 30;
613
- };
517
+ firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
518
+ secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
519
+ thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
520
+ fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
521
+ opacity: number;
614
522
  };
615
523
  acs: {
616
524
  ip: string;
@@ -769,18 +677,6 @@ export declare const cameraSettingsSchema: z.ZodObject<{
769
677
  thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
770
678
  fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
771
679
  opacity: number;
772
- } | {
773
- aircraft: {
774
- firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
775
- secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
776
- thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
777
- fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
778
- opacity: number;
779
- };
780
- drone?: {
781
- firstRow: "blank" | "remote_id";
782
- opacity: number;
783
- } | undefined;
784
680
  } | undefined;
785
681
  acs?: {
786
682
  ip: string;
@@ -1313,11 +1209,11 @@ declare const categoryDescriptorSchema: z.ZodObject<{
1313
1209
  }, "strip", z.ZodTypeAny, {
1314
1210
  categoryId: string;
1315
1211
  uiName: string;
1316
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1212
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1317
1213
  }, {
1318
1214
  categoryId: string;
1319
1215
  uiName: string;
1320
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1216
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1321
1217
  }>;
1322
1218
  export type TCategoryDescriptor = z.infer<typeof categoryDescriptorSchema>;
1323
1219
  declare const domainDescriptorSchema: z.ZodObject<{
@@ -1330,27 +1226,27 @@ declare const domainDescriptorSchema: z.ZodObject<{
1330
1226
  }, "strip", z.ZodTypeAny, {
1331
1227
  categoryId: string;
1332
1228
  uiName: string;
1333
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1229
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1334
1230
  }, {
1335
1231
  categoryId: string;
1336
1232
  uiName: string;
1337
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1233
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1338
1234
  }>, "many">;
1339
1235
  }, "strip", z.ZodTypeAny, {
1340
1236
  uiName: string;
1341
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1237
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1342
1238
  categoryList: {
1343
1239
  categoryId: string;
1344
1240
  uiName: string;
1345
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1241
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1346
1242
  }[];
1347
1243
  }, {
1348
1244
  uiName: string;
1349
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1245
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1350
1246
  categoryList: {
1351
1247
  categoryId: string;
1352
1248
  uiName: string;
1353
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1249
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1354
1250
  }[];
1355
1251
  }>;
1356
1252
  export type TDomainDescriptor = z.infer<typeof domainDescriptorSchema>;
@@ -1364,27 +1260,27 @@ export declare const domainListSchema: z.ZodRecord<z.ZodEnum<["adsb", "remoteId"
1364
1260
  }, "strip", z.ZodTypeAny, {
1365
1261
  categoryId: string;
1366
1262
  uiName: string;
1367
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1263
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1368
1264
  }, {
1369
1265
  categoryId: string;
1370
1266
  uiName: string;
1371
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1267
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1372
1268
  }>, "many">;
1373
1269
  }, "strip", z.ZodTypeAny, {
1374
1270
  uiName: string;
1375
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1271
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1376
1272
  categoryList: {
1377
1273
  categoryId: string;
1378
1274
  uiName: string;
1379
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1275
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1380
1276
  }[];
1381
1277
  }, {
1382
1278
  uiName: string;
1383
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1279
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1384
1280
  categoryList: {
1385
1281
  categoryId: string;
1386
1282
  uiName: string;
1387
- icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
1283
+ icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
1388
1284
  }[];
1389
1285
  }>>;
1390
1286
  export type TDomainList = z.infer<typeof domainListSchema>;