camstreamerlib 4.0.6 → 4.0.8

package/cjs/types/ws/PlaneTrackerEvents.js

@@ -1,10 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ptrEventsSchema = exports.planeTrackerUserActionData = exports.PlaneTrackerUserActions = exports.PlaneTrackerWsEvents = void 0;
+exports.ptrEventsSchema = exports.EUserActions = void 0;
 const zod_1 = require("zod");
 const PlaneTrackerAPI_1 = require("../PlaneTrackerAPI");
-const apiFlightDataSchema = zod_1.z.object({
+const wsApiFlightDataSchema = zod_1.z.object({
+    targetId: zod_1.z.string(),
     icao: zod_1.z.string(),
+    domain: PlaneTrackerAPI_1.domainIdSchema,
+    categoryId: zod_1.z.string(),
+    groupId: zod_1.z.string().optional(),
     lat: zod_1.z.number(),
     lon: zod_1.z.number(),
     heading: zod_1.z.number(),
@@ -15,7 +19,6 @@ const apiFlightDataSchema = zod_1.z.object({
     whiteListed: zod_1.z.boolean(),
     blackListed: zod_1.z.boolean(),
     priorityListed: zod_1.z.boolean(),
-    typePriorityListed: zod_1.z.boolean().default(false),
     autoSelectionIgnored: zod_1.z.boolean(),
     signalQuality: zod_1.z.number(),
     emitterCategorySet: zod_1.z.number().default(4),
@@ -23,169 +26,134 @@ const apiFlightDataSchema = zod_1.z.object({
     emergencyState: zod_1.z.boolean(),
     emergencyStatusMessage: zod_1.z.string(),
 });
-const apiUserSchema = zod_1.z.object({
-    userId: zod_1.z.string(),
-    userName: zod_1.z.string(),
-    userPriority: zod_1.z.number(),
-    ip: zod_1.z.string(),
+const wsCameraPositionDataSchema = zod_1.z.object({
+    lat: zod_1.z.number(),
+    lon: zod_1.z.number(),
+    azimuth: zod_1.z.number().min(0).max(360),
+    elevation: zod_1.z.number().min(-90).max(90),
+    fov: zod_1.z.number(),
 });
-const apiStringUserSchema = zod_1.z.object({
+const userSchema = zod_1.z.object({
     userId: zod_1.z.string(),
     userName: zod_1.z.string(),
     userPriority: zod_1.z.string(),
 });
-var PlaneTrackerWsEvents;
-(function (PlaneTrackerWsEvents) {
-    PlaneTrackerWsEvents["FLIGHT_LIST"] = "FLIGHT_LIST";
-    PlaneTrackerWsEvents["CAMERA_POSITION"] = "CAMERA_POSITION";
-    PlaneTrackerWsEvents["TRACKING_START"] = "TRACKING_START";
-    PlaneTrackerWsEvents["TRACKING_STOP"] = "TRACKING_STOP";
-    PlaneTrackerWsEvents["USER_ACTION"] = "USER_ACTION";
-    PlaneTrackerWsEvents["CONNECTED_USERS"] = "CONNECTED_USERS";
-    PlaneTrackerWsEvents["FORCE_TRACKING_STATUS"] = "FORCE_TRACKING_STATUS";
-})(PlaneTrackerWsEvents || (exports.PlaneTrackerWsEvents = PlaneTrackerWsEvents = {}));
-var PlaneTrackerUserActions;
-(function (PlaneTrackerUserActions) {
-    PlaneTrackerUserActions["TRACK_ICAO"] = "trackIcao.cgi";
-    PlaneTrackerUserActions["RESET_ICAO"] = "resetIcao.cgi";
-    PlaneTrackerUserActions["SET_PRIORITY_LIST"] = "setPriorityList.cgi";
-    PlaneTrackerUserActions["SET_BLACK_LIST"] = "setBlackList.cgi";
-    PlaneTrackerUserActions["SET_WHITE_LIST"] = "setWhiteList.cgi";
-    PlaneTrackerUserActions["GO_TO_COORDINATES"] = "goToCoordinates.cgi";
-    PlaneTrackerUserActions["SET_TRACKING_MODE"] = "setTrackingMode.cgi";
-    PlaneTrackerUserActions["SET_ZONES"] = "setZones.cgi";
-    PlaneTrackerUserActions["RESET_PTZ_CALIBRATION"] = "resetPtzCalibration.cgi";
-    PlaneTrackerUserActions["LOCK_API"] = "lockApi.cgi";
-    PlaneTrackerUserActions["UNLOCK_API"] = "unlockApi.cgi";
-})(PlaneTrackerUserActions || (exports.PlaneTrackerUserActions = PlaneTrackerUserActions = {}));
-exports.planeTrackerUserActionData = zod_1.z.discriminatedUnion('cgi', [
+const apiUserSchema = userSchema.extend({
+    ip: zod_1.z.string(),
+    userPriority: zod_1.z.number(),
+});
+var EUserActions;
+(function (EUserActions) {
+    EUserActions["TRACK_ICAO"] = "trackIcao.cgi";
+    EUserActions["RESET_ICAO"] = "resetIcao.cgi";
+    EUserActions["SET_PRIORITY_LIST"] = "setPriorityList.cgi";
+    EUserActions["SET_BLACK_LIST"] = "setBlackList.cgi";
+    EUserActions["SET_WHITE_LIST"] = "setWhiteList.cgi";
+    EUserActions["GO_TO_COORDINATES"] = "goToCoordinates.cgi";
+    EUserActions["SET_TRACKING_MODE"] = "setTrackingMode.cgi";
+    EUserActions["SET_ZONES"] = "setZones.cgi";
+    EUserActions["RESET_PTZ_CALIBRATION"] = "resetPtzCalibration.cgi";
+    EUserActions["LOCK_API"] = "lockApi.cgi";
+    EUserActions["UNLOCK_API"] = "unlockApi.cgi";
+})(EUserActions || (exports.EUserActions = EUserActions = {}));
+const eventsDataSchema = zod_1.z.union([
+    zod_1.z.object({ type: zod_1.z.literal('CAMERA_POSITION') }).merge(wsCameraPositionDataSchema),
     zod_1.z.object({
-        cgi: zod_1.z.literal(PlaneTrackerUserActions.TRACK_ICAO),
+        type: zod_1.z.literal('TRACKING_START'),
+        icao: zod_1.z.string(),
+        targetId: zod_1.z.string(),
+        domain: PlaneTrackerAPI_1.domainIdSchema,
+        categoryId: zod_1.z.string(),
+    }),
+    zod_1.z.object({ type: zod_1.z.literal('TRACKING_STOP') }),
+    zod_1.z.object({ type: zod_1.z.literal('FLIGHT_LIST'), list: zod_1.z.array(wsApiFlightDataSchema) }),
+    zod_1.z.object({
+        type: zod_1.z.literal('USER_ACTION'),
+        cgi: zod_1.z.literal(EUserActions.TRACK_ICAO),
         ip: zod_1.z.string(),
-        params: apiStringUserSchema.extend({
-            icao: zod_1.z.string(),
-        }),
+        params: userSchema.extend({ icao: zod_1.z.string() }),
+        postJsonBody: zod_1.z.any(),
     }),
     zod_1.z.object({
-        cgi: zod_1.z.literal(PlaneTrackerUserActions.RESET_ICAO),
+        type: zod_1.z.literal('USER_ACTION'),
+        cgi: zod_1.z.literal(EUserActions.RESET_ICAO),
         ip: zod_1.z.string(),
-        params: apiStringUserSchema,
+        params: userSchema,
+        postJsonBody: zod_1.z.any(),
     }),
     zod_1.z.object({
-        cgi: zod_1.z.literal(PlaneTrackerUserActions.SET_PRIORITY_LIST),
+        type: zod_1.z.literal('USER_ACTION'),
+        cgi: zod_1.z.literal(EUserActions.SET_PRIORITY_LIST),
         ip: zod_1.z.string(),
-        params: apiStringUserSchema,
+        params: userSchema,
         postJsonBody: PlaneTrackerAPI_1.priorityListSchema,
     }),
     zod_1.z.object({
-        cgi: zod_1.z.literal(PlaneTrackerUserActions.SET_BLACK_LIST),
+        type: zod_1.z.literal('USER_ACTION'),
+        cgi: zod_1.z.literal(EUserActions.SET_BLACK_LIST),
         ip: zod_1.z.string(),
-        params: apiStringUserSchema,
+        params: userSchema,
         postJsonBody: PlaneTrackerAPI_1.blackListSchema,
     }),
     zod_1.z.object({
-        cgi: zod_1.z.literal(PlaneTrackerUserActions.SET_WHITE_LIST),
+        type: zod_1.z.literal('USER_ACTION'),
+        cgi: zod_1.z.literal(EUserActions.SET_WHITE_LIST),
         ip: zod_1.z.string(),
-        params: apiStringUserSchema,
+        params: userSchema,
         postJsonBody: PlaneTrackerAPI_1.whiteListSchema,
     }),
     zod_1.z.object({
-        cgi: zod_1.z.literal(PlaneTrackerUserActions.GO_TO_COORDINATES),
+        type: zod_1.z.literal('USER_ACTION'),
+        cgi: zod_1.z.literal(EUserActions.GO_TO_COORDINATES),
         ip: zod_1.z.string(),
-        params: apiStringUserSchema.extend({
-            lat: zod_1.z.string(),
-            lon: zod_1.z.string(),
-        }),
+        params: userSchema.extend({ lat: zod_1.z.string(), lon: zod_1.z.string() }),
+        postJsonBody: zod_1.z.any(),
     }),
     zod_1.z.object({
-        cgi: zod_1.z.literal(PlaneTrackerUserActions.SET_TRACKING_MODE),
+        type: zod_1.z.literal('USER_ACTION'),
+        cgi: zod_1.z.literal(EUserActions.SET_TRACKING_MODE),
         ip: zod_1.z.string(),
-        params: apiStringUserSchema,
+        params: userSchema,
         postJsonBody: PlaneTrackerAPI_1.trackingModeSchema,
     }),
     zod_1.z.object({
-        cgi: zod_1.z.literal(PlaneTrackerUserActions.SET_ZONES),
+        type: zod_1.z.literal('USER_ACTION'),
+        cgi: zod_1.z.literal(EUserActions.SET_ZONES),
         ip: zod_1.z.string(),
-        params: apiStringUserSchema,
+        params: userSchema,
         postJsonBody: PlaneTrackerAPI_1.zonesSchema,
     }),
     zod_1.z.object({
-        cgi: zod_1.z.literal(PlaneTrackerUserActions.RESET_PTZ_CALIBRATION),
-        ip: zod_1.z.string(),
-        params: apiStringUserSchema,
-    }),
-    zod_1.z.object({
-        cgi: zod_1.z.literal(PlaneTrackerUserActions.LOCK_API),
+        type: zod_1.z.literal('USER_ACTION'),
+        cgi: zod_1.z.literal(EUserActions.RESET_PTZ_CALIBRATION),
         ip: zod_1.z.string(),
-        params: apiStringUserSchema.extend({
-            timeout: zod_1.z.string(),
-        }),
+        params: userSchema,
+        postJsonBody: zod_1.z.any(),
     }),
     zod_1.z.object({
-        cgi: zod_1.z.literal(PlaneTrackerUserActions.UNLOCK_API),
+        type: zod_1.z.literal('USER_ACTION'),
+        cgi: zod_1.z.literal(EUserActions.LOCK_API),
         ip: zod_1.z.string(),
-        params: apiStringUserSchema,
-    }),
-]);
-const ptrEventsDataSchema = zod_1.z.discriminatedUnion('type', [
-    zod_1.z.object({
-        type: zod_1.z.literal('CAMERA_POSITION'),
-        lat: zod_1.z.number(),
-        lon: zod_1.z.number(),
-        azimuth: zod_1.z.number().min(0).max(360),
-        elevation: zod_1.z.number().min(-90).max(90),
-        fov: zod_1.z.number(),
-    }),
-    zod_1.z.object({
-        type: zod_1.z.literal('TRACKING_START'),
-        icao: zod_1.z.string(),
-    }),
-    zod_1.z.object({
-        type: zod_1.z.literal('TRACKING_STOP'),
-    }),
-    zod_1.z.object({
-        type: zod_1.z.literal('FLIGHT_LIST'),
-        list: zod_1.z.array(apiFlightDataSchema),
+        params: userSchema.extend({ timeout: zod_1.z.string() }),
+        postJsonBody: zod_1.z.any(),
     }),
     zod_1.z.object({
         type: zod_1.z.literal('USER_ACTION'),
+        cgi: zod_1.z.literal(EUserActions.UNLOCK_API),
         ip: zod_1.z.string(),
-        params: apiStringUserSchema.extend({
-            lat: zod_1.z.string().optional(),
-            lon: zod_1.z.string().optional(),
-            timeout: zod_1.z.string().optional(),
-        }),
-        cgi: zod_1.z.enum([
-            PlaneTrackerUserActions.TRACK_ICAO,
-            PlaneTrackerUserActions.RESET_ICAO,
-            PlaneTrackerUserActions.SET_PRIORITY_LIST,
-            PlaneTrackerUserActions.SET_BLACK_LIST,
-            PlaneTrackerUserActions.SET_WHITE_LIST,
-            PlaneTrackerUserActions.GO_TO_COORDINATES,
-            PlaneTrackerUserActions.SET_TRACKING_MODE,
-            PlaneTrackerUserActions.SET_ZONES,
-            PlaneTrackerUserActions.RESET_PTZ_CALIBRATION,
-            PlaneTrackerUserActions.LOCK_API,
-            PlaneTrackerUserActions.UNLOCK_API,
-        ]),
+        params: userSchema,
         postJsonBody: zod_1.z.any(),
     }),
-    zod_1.z.object({
-        type: zod_1.z.literal('CONNECTED_USERS'),
-        users: zod_1.z.array(apiUserSchema),
-    }),
+    zod_1.z.object({ type: zod_1.z.literal('CONNECTED_USERS'), users: zod_1.z.array(apiUserSchema) }),
     zod_1.z.object({
         type: zod_1.z.literal('FORCE_TRACKING_STATUS'),
         enabled: zod_1.z.boolean(),
         icao: zod_1.z.string().optional(),
+        targetId: zod_1.z.string().optional(),
     }),
-    zod_1.z.object({
-        type: zod_1.z.literal('API_LOCK_STATUS'),
-        isLocked: zod_1.z.boolean(),
-        user: apiUserSchema.optional(),
-    }),
+    zod_1.z.object({ type: zod_1.z.literal('API_LOCK_STATUS'), isLocked: zod_1.z.boolean(), user: apiUserSchema.optional() }),
 ]);
-exports.ptrEventsSchema = zod_1.z.discriminatedUnion('type', [
-    zod_1.z.object({ type: zod_1.z.literal('init'), data: ptrEventsDataSchema }),
-    ...ptrEventsDataSchema.options,
+exports.ptrEventsSchema = zod_1.z.union([
+    zod_1.z.object({ type: zod_1.z.literal('init'), data: eventsDataSchema }),
+    ...eventsDataSchema.options,
 ]);

package/cjs/ws/PlaneTrackerEvents.d.ts

@@ -1,9 +1,8 @@
 import { IWsClient } from '../internal/types';
 import { WsEvents } from '../internal/WsEvents';
-import { TApiUser } from '../types/PlaneTrackerAPI';
-import { TPlaneTrackerEvent } from '../types/ws/PlaneTrackerEvents';
-export declare class PlaneTrackerEvents extends WsEvents<TPlaneTrackerEvent> {
+import { TEventData, TApiUser } from '../types/ws/PlaneTrackerEvents';
+export declare class PlaneTrackerEvents extends WsEvents<TEventData> {
     private _apiUser;
-    constructor(ws: IWsClient, _apiUser: TApiUser);
+    constructor(ws: IWsClient, _apiUser: Omit<TApiUser, 'ip'>);
     private sendInitMsg;
 }

package/cjs/ws/PlaneTrackerEvents.js

@@ -6,15 +6,7 @@ const PlaneTrackerEvents_1 = require("../types/ws/PlaneTrackerEvents");
 class PlaneTrackerEvents extends WsEvents_1.WsEvents {
     _apiUser;
     constructor(ws, _apiUser) {
-        super((data) => {
-            const parsedData = PlaneTrackerEvents_1.ptrEventsSchema.parse(data);
-            if (parsedData.type === PlaneTrackerEvents_1.PlaneTrackerWsEvents.USER_ACTION) {
-                const { type, ...actionData } = parsedData;
-                const userAction = PlaneTrackerEvents_1.planeTrackerUserActionData.parse(actionData);
-                return { ...userAction, type };
-            }
-            return parsedData;
-        }, ws);
+        super((data) => PlaneTrackerEvents_1.ptrEventsSchema.parse(data), ws);
         this._apiUser = _apiUser;
         this.ws.onOpen = this.sendInitMsg;
     }

package/esm/PlaneTrackerAPI.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { blackListSchema, cameraSettingsSchema, flightInfoSchema, getIcaoSchema, mapInfoSchema, priorityListSchema, serverSettingsSchema, trackingModeSchema, whiteListSchema, wsAliasResponseSchema, zonesSchema, } from './types/PlaneTrackerAPI';
+import { blackListSchema, cameraSettingsSchema, domainListSchema, flightInfoSchema, getIcaoSchema, mapInfoSchema, priorityListSchema, serverSettingsSchema, trackingModeSchema, whiteListSchema, wsAliasResponseSchema, zonesSchema, } from './types/PlaneTrackerAPI';
 import { CannotSetCoordsInAutoModeError, ImportSettingsError, InvalidAltitudeError, InvalidLatLngError, ResetCalibrationError, ServerError, BadRequestError, } from './errors/errors';
 import { BasicAPI } from './internal/BasicAPI';
 const BASE_PATH = '/local/planetracker';
@@ -85,8 +85,12 @@ export class PlaneTrackerAPI extends BasicAPI {
             throw new ImportSettingsError(res);
         }
     }
-    async fetchFlightInfo(icao, options) {
-        const res = await this._getJson(`${BASE_PATH}/package/flightInfo.cgi`, { icao }, options);
+    async getDomainList(options) {
+        const res = await this._getJson(`${BASE_PATH}/getDomainList.cgi`, { action: 'get' }, options);
+        return domainListSchema.parse(res);
+    }
+    async fetchFlightInfo(targetId, options) {
+        const res = await this._getJson(`${BASE_PATH}/package/flightInfo.cgi`, { targetId }, options);
         return flightInfoSchema.parse(res);
     }
     async getTrackingMode(options) {
@@ -112,9 +116,25 @@ export class PlaneTrackerAPI extends BasicAPI {
             timeout: options?.timeout,
         });
     }
+    async startTrackingTarget(targetId, options) {
+        const agent = this.getClient(options?.proxyParams);
+        await agent.get({
+            path: `${BASE_PATH}/package/trackTarget.cgi`,
+            parameters: { targetId, ...this.apiUser },
+            timeout: options?.timeout,
+        });
+    }
+    async stopTrackingTarget(options) {
+        const agent = this.getClient(options?.proxyParams);
+        await agent.get({
+            path: `${BASE_PATH}/package/resetTarget.cgi`,
+            parameters: this.apiUser,
+            timeout: options?.timeout,
+        });
+    }
     async getIcao(by, value, options) {
         const res = await this._getJson(`${BASE_PATH}/package/getIcao.cgi`, { [by]: value }, options);
-        return getIcaoSchema.parse(res).icao;
+        return getIcaoSchema.parse(res).targetId;
     }
     async getPriorityList(options) {
         const res = await this._getJson(`${BASE_PATH}/package/getPriorityList.cgi`, undefined, options);

package/esm/types/PlaneTrackerAPI.js

@@ -248,6 +248,7 @@ export const serverSettingsSchema = z.object({
 });
 export const getIcaoSchema = z.object({
     icao: z.string(),
+    targetId: z.string(),
 });
 export const trackingModeSchema = z.object({
     mode: z.union([z.literal('MANUAL'), z.literal('AUTOMATIC')]).default('AUTOMATIC'),
@@ -323,3 +324,41 @@ export const zonesSchema = z.object({
     }))
         .default([]),
 });
+export const domainIdSchema = z.enum(['adsb', 'remoteId']);
+const categoryIconSchema = z.enum(['small', 'large', 'heavy', 'helicopter', 'drone', 'operator', 'unknown']);
+const categoryDescriptorSchema = z.object({
+    categoryId: z.string(),
+    uiName: z.string(),
+    icon: categoryIconSchema,
+});
+const domainDescriptorSchema = z.object({
+    uiName: z.string(),
+    icon: categoryIconSchema,
+    categoryList: z.array(categoryDescriptorSchema),
+});
+export const domainListSchema = z.record(domainIdSchema, domainDescriptorSchema);
+export const ADSB_CATEGORY_IDS = {
+    A_LIGHT: 'A_LIGHT',
+    A_SMALL: 'A_SMALL',
+    A_LARGE: 'A_LARGE',
+    A_HIGH_VORTEX: 'A_HIGH_VORTEX',
+    A_HEAVY: 'A_HEAVY',
+    A_HIGH_PERF: 'A_HIGH_PERF',
+    A_ROTORCRAFT: 'A_ROTORCRAFT',
+    B_GLIDER: 'B_GLIDER',
+    B_LIGHTER_THAN_AIR: 'B_LIGHTER_THAN_AIR',
+    B_PARACHUTIST: 'B_PARACHUTIST',
+    B_ULTRALIGHT: 'B_ULTRALIGHT',
+    B_UAV: 'B_UAV',
+    B_SPACE: 'B_SPACE',
+    C_SURFACE_EMERGENCY: 'C_SURFACE_EMERGENCY',
+    C_SERVICE_VEHICLE: 'C_SERVICE_VEHICLE',
+    C_POINT_OBSTACLE: 'C_POINT_OBSTACLE',
+    C_CLUSTER_OBSTACLE: 'C_CLUSTER_OBSTACLE',
+    C_LINE_OBSTACLE: 'C_LINE_OBSTACLE',
+    UNKNOWN: 'UNKNOWN',
+};
+export const REMOTE_ID_CATEGORY_IDS = {
+    DRONE: 'DRONE',
+    OPERATOR: 'OPERATOR',
+};