camstreamerlib 4.0.32 → 4.0.33-55dd1f0

package/README.md

@@ -39,6 +39,15 @@ npm install camstreamerlib
 
 </br>
 
+# Examples
+
+| Example                                                                                                                                                         | Description                                                                                                                                                                                                                                                                                                                                                                                                           | Open in browser                                                                        |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| [CamSwitcherEvents](examples/camswitcher-events.html) ([source](https://github.com/CamStreamer/CamStreamerLib/blob/master/examples/camswitcher-events.html))    | Logs every CamSwitcher event. `DeviceConnectClient` (HTTP) backs [CamSwitcherAPI](doc/CamSwitcherAPI.md) to obtain the websocket authorization token, `DeviceConnectWsClient` (websocket) backs [CamSwitcherEvents](doc/ws/CamSwitcherEvents.md), which validates and dispatches the events. Connection state is taken from the `authorization` event.                                                                | [open](https://camstreamer.github.io/CamStreamerLib/examples/camswitcher-events.html)  |
+| [PlaneTrackerEvents](examples/planetracker-events.html) ([source](https://github.com/CamStreamer/CamStreamerLib/blob/master/examples/planetracker-events.html)) | Logs every PlaneTracker event. PlaneTracker needs no authorization token — [PlaneTrackerEvents](doc/ws/PlaneTrackerEvents.md) announces the connecting user (`userId` / `userName` / `userPriority`, editable in the form) as the init message instead, so only the websocket client is needed. The continuous `CAMERA_POSITION` and `FLIGHT_LIST` events only update the summary line unless the checkbox is ticked. | [open](https://camstreamer.github.io/CamStreamerLib/examples/planetracker-events.html) |
+
+</br>
+
 # Breaking Changes
 
 <details open>

package/cjs/PlaneTrackerAPI.js

@@ -5,12 +5,13 @@ const zod_1 = require("zod");
 const PlaneTrackerAPI_1 = require("./types/PlaneTrackerAPI");
 const errors_1 = require("./errors/errors");
 const BasicAPI_1 = require("./internal/BasicAPI");
+const PlaneTrackerEvents_1 = require("./types/ws/PlaneTrackerEvents");
 const BASE_PATH = '/local/planetracker';
 class PlaneTrackerAPI extends BasicAPI_1.BasicAPI {
     apiUser;
     constructor(client, apiUser) {
         super(client);
-        this.apiUser = apiUser;
+        this.apiUser = PlaneTrackerEvents_1.apiUserInputSchema.parse(apiUser);
     }
     static getProxyPath = () => `${BASE_PATH}/proxy.cgi`;
     static getWsEventsPath = () => `${BASE_PATH}/package/ws`;

package/cjs/browser.index.d.ts

@@ -0,0 +1,2 @@
+export * from './index';
+export * from './web/index';

package/cjs/browser.index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./index"), exports);
+__exportStar(require("./web/index"), exports);

package/cjs/types/ws/PlaneTrackerEvents.d.ts

@@ -2,6 +2,7 @@ import { z } from 'zod';
 declare const wsApiFlightDataSchema: z.ZodObject<{
     targetId: z.ZodString;
     icao: z.ZodString;
+    callsign: z.ZodOptional<z.ZodString>;
     domain: z.ZodEnum<["adsb", "remoteId"]>;
     categoryId: z.ZodString;
     groupId: z.ZodOptional<z.ZodString>;
@@ -50,6 +51,7 @@ declare const wsApiFlightDataSchema: z.ZodObject<{
     emitterCategory: number;
     emergencyState: boolean;
     emergencyStatusMessage: string;
+    callsign?: string | undefined;
     groupId?: string | undefined;
 }, {
     icao: string;
@@ -74,6 +76,7 @@ declare const wsApiFlightDataSchema: z.ZodObject<{
     signalQuality: number;
     emergencyState: boolean;
     emergencyStatusMessage: string;
+    callsign?: string | undefined;
     groupId?: string | undefined;
     emitterCategorySet?: number | undefined;
     emitterCategory?: number | undefined;
@@ -117,6 +120,21 @@ declare const apiUserSchema: z.ZodObject<{
     userName: string;
     userPriority: number;
 }>;
+export declare const USER_PRIORITY_MIN = 1;
+export declare const USER_PRIORITY_MAX = 255;
+export declare const apiUserInputSchema: z.ZodObject<{} & {
+    userId: z.ZodString;
+    userName: z.ZodString;
+    userPriority: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    userId: string;
+    userName: string;
+    userPriority: number;
+}, {
+    userId: string;
+    userName: string;
+    userPriority: number;
+}>;
 export type TEventType = 'CAMERA_POSITION' | 'TRACKING_START' | 'TRACKING_STOP' | 'FLIGHT_LIST' | 'USER_ACTION' | 'CONNECTED_USERS' | 'FORCE_TRACKING_STATUS' | 'API_LOCK_STATUS';
 export declare enum EUserActions {
     TRACK_ICAO = "trackIcao.cgi",
@@ -163,6 +181,7 @@ declare const eventsDataSchema: z.ZodUnion<readonly [z.ZodObject<{
     type: z.ZodLiteral<"TRACKING_START">;
     icao: z.ZodString;
     targetId: z.ZodString;
+    callsign: z.ZodOptional<z.ZodString>;
     domain: z.ZodEnum<["adsb", "remoteId"]>;
     categoryId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -171,12 +190,14 @@ declare const eventsDataSchema: z.ZodUnion<readonly [z.ZodObject<{
     targetId: string;
     domain: "adsb" | "remoteId";
     categoryId: string;
+    callsign?: string | undefined;
 }, {
     type: "TRACKING_START";
     icao: string;
     targetId: string;
     domain: "adsb" | "remoteId";
     categoryId: string;
+    callsign?: string | undefined;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"TRACKING_STOP">;
 }, "strip", z.ZodTypeAny, {
@@ -188,6 +209,7 @@ declare const eventsDataSchema: z.ZodUnion<readonly [z.ZodObject<{
     list: z.ZodArray<z.ZodObject<{
         targetId: z.ZodString;
         icao: z.ZodString;
+        callsign: z.ZodOptional<z.ZodString>;
         domain: z.ZodEnum<["adsb", "remoteId"]>;
         categoryId: z.ZodString;
         groupId: z.ZodOptional<z.ZodString>;
@@ -236,6 +258,7 @@ declare const eventsDataSchema: z.ZodUnion<readonly [z.ZodObject<{
         emitterCategory: number;
         emergencyState: boolean;
         emergencyStatusMessage: string;
+        callsign?: string | undefined;
         groupId?: string | undefined;
     }, {
         icao: string;
@@ -260,6 +283,7 @@ declare const eventsDataSchema: z.ZodUnion<readonly [z.ZodObject<{
         signalQuality: number;
         emergencyState: boolean;
         emergencyStatusMessage: string;
+        callsign?: string | undefined;
         groupId?: string | undefined;
         emitterCategorySet?: number | undefined;
         emitterCategory?: number | undefined;
@@ -291,6 +315,7 @@ declare const eventsDataSchema: z.ZodUnion<readonly [z.ZodObject<{
         emitterCategory: number;
         emergencyState: boolean;
         emergencyStatusMessage: string;
+        callsign?: string | undefined;
         groupId?: string | undefined;
     }[];
 }, {
@@ -318,6 +343,7 @@ declare const eventsDataSchema: z.ZodUnion<readonly [z.ZodObject<{
         signalQuality: number;
         emergencyState: boolean;
         emergencyStatusMessage: string;
+        callsign?: string | undefined;
         groupId?: string | undefined;
         emitterCategorySet?: number | undefined;
         emitterCategory?: number | undefined;
@@ -1319,6 +1345,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
         type: z.ZodLiteral<"TRACKING_START">;
         icao: z.ZodString;
         targetId: z.ZodString;
+        callsign: z.ZodOptional<z.ZodString>;
         domain: z.ZodEnum<["adsb", "remoteId"]>;
         categoryId: z.ZodString;
     }, "strip", z.ZodTypeAny, {
@@ -1327,12 +1354,14 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
         targetId: string;
         domain: "adsb" | "remoteId";
         categoryId: string;
+        callsign?: string | undefined;
     }, {
         type: "TRACKING_START";
         icao: string;
         targetId: string;
         domain: "adsb" | "remoteId";
         categoryId: string;
+        callsign?: string | undefined;
     }>, z.ZodObject<{
         type: z.ZodLiteral<"TRACKING_STOP">;
     }, "strip", z.ZodTypeAny, {
@@ -1344,6 +1373,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
         list: z.ZodArray<z.ZodObject<{
             targetId: z.ZodString;
             icao: z.ZodString;
+            callsign: z.ZodOptional<z.ZodString>;
             domain: z.ZodEnum<["adsb", "remoteId"]>;
             categoryId: z.ZodString;
             groupId: z.ZodOptional<z.ZodString>;
@@ -1392,6 +1422,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
             emitterCategory: number;
             emergencyState: boolean;
             emergencyStatusMessage: string;
+            callsign?: string | undefined;
             groupId?: string | undefined;
         }, {
             icao: string;
@@ -1416,6 +1447,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
             signalQuality: number;
             emergencyState: boolean;
             emergencyStatusMessage: string;
+            callsign?: string | undefined;
             groupId?: string | undefined;
             emitterCategorySet?: number | undefined;
             emitterCategory?: number | undefined;
@@ -1447,6 +1479,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
             emitterCategory: number;
             emergencyState: boolean;
             emergencyStatusMessage: string;
+            callsign?: string | undefined;
             groupId?: string | undefined;
         }[];
     }, {
@@ -1474,6 +1507,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
             signalQuality: number;
             emergencyState: boolean;
             emergencyStatusMessage: string;
+            callsign?: string | undefined;
             groupId?: string | undefined;
             emitterCategorySet?: number | undefined;
             emitterCategory?: number | undefined;
@@ -2460,6 +2494,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
         targetId: string;
         domain: "adsb" | "remoteId";
         categoryId: string;
+        callsign?: string | undefined;
     } | {
         type: "TRACKING_STOP";
     } | {
@@ -2489,6 +2524,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
             emitterCategory: number;
             emergencyState: boolean;
             emergencyStatusMessage: string;
+            callsign?: string | undefined;
             groupId?: string | undefined;
         }[];
     } | {
@@ -2723,6 +2759,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
         targetId: string;
         domain: "adsb" | "remoteId";
         categoryId: string;
+        callsign?: string | undefined;
     } | {
         type: "TRACKING_STOP";
     } | {
@@ -2750,6 +2787,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
             signalQuality: number;
             emergencyState: boolean;
             emergencyStatusMessage: string;
+            callsign?: string | undefined;
             groupId?: string | undefined;
             emitterCategorySet?: number | undefined;
             emitterCategory?: number | undefined;
@@ -2999,6 +3037,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
     type: z.ZodLiteral<"TRACKING_START">;
     icao: z.ZodString;
     targetId: z.ZodString;
+    callsign: z.ZodOptional<z.ZodString>;
     domain: z.ZodEnum<["adsb", "remoteId"]>;
     categoryId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -3007,12 +3046,14 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
     targetId: string;
     domain: "adsb" | "remoteId";
     categoryId: string;
+    callsign?: string | undefined;
 }, {
     type: "TRACKING_START";
     icao: string;
     targetId: string;
     domain: "adsb" | "remoteId";
     categoryId: string;
+    callsign?: string | undefined;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"TRACKING_STOP">;
 }, "strip", z.ZodTypeAny, {
@@ -3024,6 +3065,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
     list: z.ZodArray<z.ZodObject<{
         targetId: z.ZodString;
         icao: z.ZodString;
+        callsign: z.ZodOptional<z.ZodString>;
         domain: z.ZodEnum<["adsb", "remoteId"]>;
         categoryId: z.ZodString;
         groupId: z.ZodOptional<z.ZodString>;
@@ -3072,6 +3114,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
         emitterCategory: number;
         emergencyState: boolean;
         emergencyStatusMessage: string;
+        callsign?: string | undefined;
         groupId?: string | undefined;
     }, {
         icao: string;
@@ -3096,6 +3139,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
         signalQuality: number;
         emergencyState: boolean;
         emergencyStatusMessage: string;
+        callsign?: string | undefined;
         groupId?: string | undefined;
         emitterCategorySet?: number | undefined;
         emitterCategory?: number | undefined;
@@ -3127,6 +3171,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
         emitterCategory: number;
         emergencyState: boolean;
         emergencyStatusMessage: string;
+        callsign?: string | undefined;
         groupId?: string | undefined;
     }[];
 }, {
@@ -3154,6 +3199,7 @@ export declare const ptrEventsSchema: z.ZodUnion<readonly [z.ZodObject<{
         signalQuality: number;
         emergencyState: boolean;
         emergencyStatusMessage: string;
+        callsign?: string | undefined;
         groupId?: string | undefined;
         emitterCategorySet?: number | undefined;
         emitterCategory?: number | undefined;
@@ -4134,4 +4180,5 @@ export type TUserActionDataOfCgi<T extends EUserActions> = Extract<TWsUserAction
 export type TWsApiFlightData = z.infer<typeof wsApiFlightDataSchema>;
 export type TWsApiCameraData = z.infer<typeof wsCameraPositionDataSchema>;
 export type TApiUser = z.infer<typeof apiUserSchema>;
+export type TApiUserInput = z.infer<typeof apiUserInputSchema>;
 export {};

package/cjs/types/ws/PlaneTrackerEvents.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ptrEventsSchema = exports.EUserActions = void 0;
+exports.ptrEventsSchema = exports.EUserActions = exports.apiUserInputSchema = exports.USER_PRIORITY_MAX = exports.USER_PRIORITY_MIN = void 0;
 const zod_1 = require("zod");
 const PlaneTrackerAPI_1 = require("../PlaneTrackerAPI");
 const wsApiFlightDataSchema = zod_1.z.object({
     targetId: zod_1.z.string(),
     icao: zod_1.z.string(),
+    callsign: zod_1.z.string().optional(),
     domain: PlaneTrackerAPI_1.domainIdSchema,
     categoryId: zod_1.z.string(),
     groupId: zod_1.z.string().optional(),
@@ -47,6 +48,18 @@ const apiUserSchema = userSchema.extend({
     ip: zod_1.z.string(),
     userPriority: zod_1.z.number(),
 });
+exports.USER_PRIORITY_MIN = 1;
+exports.USER_PRIORITY_MAX = 255;
+const USER_PRIORITY_ERROR = `userPriority must be an integer between ${exports.USER_PRIORITY_MIN} and ${exports.USER_PRIORITY_MAX}, where ${exports.USER_PRIORITY_MIN} is the highest priority`;
+exports.apiUserInputSchema = apiUserSchema.omit({ ip: true }).extend({
+    userId: zod_1.z.string().nonempty(),
+    userName: zod_1.z.string().nonempty(),
+    userPriority: zod_1.z
+        .number()
+        .int(USER_PRIORITY_ERROR)
+        .min(exports.USER_PRIORITY_MIN, USER_PRIORITY_ERROR)
+        .max(exports.USER_PRIORITY_MAX, USER_PRIORITY_ERROR),
+});
 var EUserActions;
 (function (EUserActions) {
     EUserActions["TRACK_ICAO"] = "trackIcao.cgi";
@@ -70,6 +83,7 @@ const eventsDataSchema = zod_1.z.union([
         type: zod_1.z.literal('TRACKING_START'),
         icao: zod_1.z.string(),
         targetId: zod_1.z.string(),
+        callsign: zod_1.z.string().optional(),
         domain: PlaneTrackerAPI_1.domainIdSchema,
         categoryId: zod_1.z.string(),
     }),

package/cjs/ws/PlaneTrackerEvents.d.ts

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

package/cjs/ws/PlaneTrackerEvents.js

@@ -5,9 +5,9 @@ const WsEvents_1 = require("../internal/WsEvents");
 const PlaneTrackerEvents_1 = require("../types/ws/PlaneTrackerEvents");
 class PlaneTrackerEvents extends WsEvents_1.WsEvents {
     _apiUser;
-    constructor(ws, _apiUser) {
+    constructor(ws, apiUser) {
         super((data) => PlaneTrackerEvents_1.ptrEventsSchema.parse(data), ws);
-        this._apiUser = _apiUser;
+        this._apiUser = PlaneTrackerEvents_1.apiUserInputSchema.parse(apiUser);
         this.ws.onOpen = this.sendInitMsg;
     }
     sendInitMsg = () => {

package/cjs/ws/PlaneTrackerEvents.test.d.ts

@@ -0,0 +1 @@
+export {};

package/cjs/ws/PlaneTrackerEvents.test.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const PlaneTrackerEvents_1 = require("./PlaneTrackerEvents");
+const PlaneTrackerEvents_2 = require("../types/ws/PlaneTrackerEvents");
+const createWsClient = () => ({
+    send: jest.fn(),
+    onOpen: undefined,
+    onMessage: undefined,
+});
+const VALID_USER = { userId: 'asd', userName: 'Asd', userPriority: 1 };
+describe('PlaneTrackerEvents', () => {
+    it.each([0, -1, PlaneTrackerEvents_2.USER_PRIORITY_MAX + 1, 1.5])('rejects userPriority %p', (userPriority) => {
+        expect(() => new PlaneTrackerEvents_1.PlaneTrackerEvents(createWsClient(), { ...VALID_USER, userPriority })).toThrow(/userPriority must be an integer/);
+    });
+    it.each([PlaneTrackerEvents_2.USER_PRIORITY_MIN, PlaneTrackerEvents_2.USER_PRIORITY_MAX])('accepts userPriority %p', (userPriority) => {
+        expect(() => new PlaneTrackerEvents_1.PlaneTrackerEvents(createWsClient(), { ...VALID_USER, userPriority })).not.toThrow();
+    });
+    it('rejects an empty userId', () => {
+        expect(() => new PlaneTrackerEvents_1.PlaneTrackerEvents(createWsClient(), { ...VALID_USER, userId: '' })).toThrow();
+    });
+    it('sends USER_INFO once the socket opens', () => {
+        const ws = createWsClient();
+        new PlaneTrackerEvents_1.PlaneTrackerEvents(ws, VALID_USER);
+        ws.onOpen();
+        expect(ws.send).toHaveBeenCalledWith(JSON.stringify({ type: 'USER_INFO', ...VALID_USER }));
+    });
+});

package/esm/PlaneTrackerAPI.js

@@ -2,12 +2,13 @@ import { z } from 'zod';
 import { blackListSchema, cameraSettingsSchema, domainListSchema, flightInfoSchema, getIcaoSchema, mapInfoSchema, milestoneCameraListSchema, 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';
+import { apiUserInputSchema } from './types/ws/PlaneTrackerEvents';
 const BASE_PATH = '/local/planetracker';
 export class PlaneTrackerAPI extends BasicAPI {
     apiUser;
     constructor(client, apiUser) {
         super(client);
-        this.apiUser = apiUser;
+        this.apiUser = apiUserInputSchema.parse(apiUser);
     }
     static getProxyPath = () => `${BASE_PATH}/proxy.cgi`;
     static getWsEventsPath = () => `${BASE_PATH}/package/ws`;

package/esm/browser.index.js

@@ -0,0 +1,2 @@
+export * from './index';
+export * from './web/index';

package/esm/types/ws/PlaneTrackerEvents.js

@@ -3,6 +3,7 @@ import { blackListSchema, friendlyListSchema, priorityListSchema, trackingModeSc
 const wsApiFlightDataSchema = z.object({
     targetId: z.string(),
     icao: z.string(),
+    callsign: z.string().optional(),
     domain: domainIdSchema,
     categoryId: z.string(),
     groupId: z.string().optional(),
@@ -44,6 +45,18 @@ const apiUserSchema = userSchema.extend({
     ip: z.string(),
     userPriority: z.number(),
 });
+export const USER_PRIORITY_MIN = 1;
+export const USER_PRIORITY_MAX = 255;
+const USER_PRIORITY_ERROR = `userPriority must be an integer between ${USER_PRIORITY_MIN} and ${USER_PRIORITY_MAX}, where ${USER_PRIORITY_MIN} is the highest priority`;
+export const apiUserInputSchema = apiUserSchema.omit({ ip: true }).extend({
+    userId: z.string().nonempty(),
+    userName: z.string().nonempty(),
+    userPriority: z
+        .number()
+        .int(USER_PRIORITY_ERROR)
+        .min(USER_PRIORITY_MIN, USER_PRIORITY_ERROR)
+        .max(USER_PRIORITY_MAX, USER_PRIORITY_ERROR),
+});
 export var EUserActions;
 (function (EUserActions) {
     EUserActions["TRACK_ICAO"] = "trackIcao.cgi";
@@ -67,6 +80,7 @@ const eventsDataSchema = z.union([
         type: z.literal('TRACKING_START'),
         icao: z.string(),
         targetId: z.string(),
+        callsign: z.string().optional(),
         domain: domainIdSchema,
         categoryId: z.string(),
     }),

package/esm/ws/PlaneTrackerEvents.js

@@ -1,10 +1,10 @@
 import { WsEvents } from '../internal/WsEvents';
-import { ptrEventsSchema } from '../types/ws/PlaneTrackerEvents';
+import { ptrEventsSchema, apiUserInputSchema, } from '../types/ws/PlaneTrackerEvents';
 export class PlaneTrackerEvents extends WsEvents {
     _apiUser;
-    constructor(ws, _apiUser) {
+    constructor(ws, apiUser) {
         super((data) => ptrEventsSchema.parse(data), ws);
-        this._apiUser = _apiUser;
+        this._apiUser = apiUserInputSchema.parse(apiUser);
         this.ws.onOpen = this.sendInitMsg;
     }
     sendInitMsg = () => {

package/esm/ws/PlaneTrackerEvents.test.js

@@ -0,0 +1,25 @@
+import { PlaneTrackerEvents } from './PlaneTrackerEvents';
+import { USER_PRIORITY_MAX, USER_PRIORITY_MIN } from '../types/ws/PlaneTrackerEvents';
+const createWsClient = () => ({
+    send: jest.fn(),
+    onOpen: undefined,
+    onMessage: undefined,
+});
+const VALID_USER = { userId: 'asd', userName: 'Asd', userPriority: 1 };
+describe('PlaneTrackerEvents', () => {
+    it.each([0, -1, USER_PRIORITY_MAX + 1, 1.5])('rejects userPriority %p', (userPriority) => {
+        expect(() => new PlaneTrackerEvents(createWsClient(), { ...VALID_USER, userPriority })).toThrow(/userPriority must be an integer/);
+    });
+    it.each([USER_PRIORITY_MIN, USER_PRIORITY_MAX])('accepts userPriority %p', (userPriority) => {
+        expect(() => new PlaneTrackerEvents(createWsClient(), { ...VALID_USER, userPriority })).not.toThrow();
+    });
+    it('rejects an empty userId', () => {
+        expect(() => new PlaneTrackerEvents(createWsClient(), { ...VALID_USER, userId: '' })).toThrow();
+    });
+    it('sends USER_INFO once the socket opens', () => {
+        const ws = createWsClient();
+        new PlaneTrackerEvents(ws, VALID_USER);
+        ws.onOpen();
+        expect(ws.send).toHaveBeenCalledWith(JSON.stringify({ type: 'USER_INFO', ...VALID_USER }));
+    });
+});

package/examples/README.md

@@ -0,0 +1,43 @@
+# Examples
+
+Standalone browser examples that use CamStreamerLib directly from a `<script type="module">`,
+without a bundler or a framework.
+
+## Build the browser bundle
+
+```bash
+npm install
+npm run build:browser
+```
+
+## Run
+
+Modules can't be loaded over `file://`, so serve the folder over HTTP:
+
+```bash
+npx serve examples
+```
+
+Both pages connect to a camera through the Device Connect proxy. Fill in the device host
+(`<MAC_ADDRESS>.device-connect.net`) and the device access token in the form, or hardcode them in the
+`DEVICE_HOST` / `DEVICE_ACCESS_TOKEN` constants at the top of the page's script to have the form
+prefilled. See [doc/Client.md](../doc/Client.md).
+
+## camswitcher-events.html
+
+Logs every CamSwitcher event. `DeviceConnectClient` (HTTP) backs `CamSwitcherAPI` to obtain the
+websocket authorization token; `DeviceConnectWsClient` (websocket) backs `CamSwitcherEvents`, which
+validates and dispatches the events. Connection state is taken from the `authorization` event.
+
+See [doc/ws/CamSwitcherEvents.md](../doc/ws/CamSwitcherEvents.md).
+
+## planetracker-events.html
+
+Logs every PlaneTracker event. PlaneTracker needs no authorization token — `PlaneTrackerEvents`
+announces the connecting user (`userId` / `userName` / `userPriority`, editable in the form) as the
+init message instead, so only the websocket client is needed.
+
+`CAMERA_POSITION` and `FLIGHT_LIST` arrive continuously, so by default they only update the summary
+line above the log; tick the checkbox to log them as well.
+
+See [doc/ws/PlaneTrackerEvents.md](../doc/ws/PlaneTrackerEvents.md).