camstreamerlib 4.0.36 → 5.0.0-20ab5c4

package/cjs/types/ws/PlaneTrackerEvents.js

@@ -78,7 +78,7 @@ var EUserActions;
     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({ type: zod_1.z.literal('CAMERA_POSITION') }).extend(wsCameraPositionDataSchema.shape),
     zod_1.z.object({
         type: zod_1.z.literal('TRACKING_START'),
         icao: zod_1.z.string(),

package/cjs/web/WsClient.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WsClient = void 0;
-const REFRESH_TIMEOUT = 5000;
+const REFRESH_TIMEOUT = 5_000;
 class WsClient {
     getUrl;
     isDestroyed = false;

package/esm/CamStreamerAPI.js

@@ -98,7 +98,7 @@ export class CamStreamerAPI extends BasicAPI {
         if (newStream.success) {
             return newStream.data;
         }
-        const oldStream = oldStringStreamSchema.passthrough().parse(res.data);
+        const oldStream = oldStringStreamSchema.loose().parse(res.data);
         throw new MigrationError([], [{ streamId, ...parseCameraStreamResponse(oldStream) }], [], []);
     }
     async setStream(streamId, streamData, options) {

package/esm/CamSwitcherAPI.js

@@ -153,6 +153,7 @@ export class CamSwitcherAPI extends BasicAPI {
             audio: {
                 sampleRate: data.audioSampleRate,
                 channelCount: data.audioChannelCount,
+                bitrate: data.audioBitrate,
             },
             keyboard: data.keyboard,
         };
@@ -204,6 +205,7 @@ export class CamSwitcherAPI extends BasicAPI {
         const settings = {
             audioSampleRate: saveData.audio?.sampleRate,
             audioChannelCount: saveData.audio?.channelCount,
+            audioBitrate: saveData.audio?.bitrate,
             keyboard: saveData.keyboard,
             fps: saveData.video.fps,
             resolution: saveData.video.resolution,

package/esm/VapixAPI.js

@@ -196,7 +196,7 @@ export class VapixAPI extends BasicAPI {
     async getHeaders(options) {
         const data = { apiVersion: '1.0', method: 'list' };
         const res = await this._postJsonEncoded('/axis-cgi/customhttpheader.cgi', data, undefined, options);
-        return z.object({ data: z.record(z.string()) }).parse(await res.json()).data;
+        return z.object({ data: z.record(z.string(), z.string()) }).parse(await res.json()).data;
     }
     async setHeaders(headers, options) {
         const data = { apiVersion: '1.0', method: 'set', params: headers };
@@ -633,7 +633,7 @@ export class VapixAPI extends BasicAPI {
             headers: {
                 contentType: 'application/octet-stream',
             },
-            timeout: options?.timeout ?? 300000,
+            timeout: options?.timeout ?? 300_000,
         });
         if (!res.ok) {
             throw new ErrorWithResponse(res);

package/esm/errors/errors.js

@@ -1,7 +1,7 @@
 export class ErrorWithResponse extends Error {
     res;
-    constructor(res) {
-        super(res.statusText);
+    constructor(res, message) {
+        super(message ?? res.statusText);
         this.res = res;
         this.name = 'ErrorWithResponse';
     }

package/esm/node/VapixEvents.js

@@ -43,7 +43,7 @@ export class VapixEvents extends EventEmitter {
             const topics = [];
             const eventNames = this.eventNames();
             for (const eventName of eventNames) {
-                if (!this.isReservedEventName(eventName)) {
+                if (typeof eventName === 'string' && !this.isReservedEventName(eventName)) {
                     const topic = {
                         topicFilter: eventName,
                     };

package/esm/node/WsClient.js

@@ -22,7 +22,7 @@ export class WsClient {
         const protocol = tls ? 'wss' : 'ws';
         this.address = `${protocol}://${host}:${port}${options.address}`;
         this.digestAddress = options.address;
-        this.pingInterval = options.pingInterval ?? 30000;
+        this.pingInterval = options.pingInterval ?? 30_000;
         this.protocol = options.protocol;
         this.wsOptions = {
             auth: `${this.user}:${this.pass}`,

package/esm/node/events/AxisCameraStationEvents.js

@@ -1,3 +1,4 @@
+import { ErrorWithResponse } from '../../errors/errors';
 import { pad } from '../../internal/utils';
 import { ProxyClient } from '../../internal/ProxyClient';
 import { DefaultClient } from '../DefaultClient';
@@ -33,7 +34,7 @@ export class AxisCameraStationEvents {
             timeout: options?.timeout,
         });
         if (!res.ok) {
-            throw new Error(`ACS status code: ${res.status}`);
+            throw new ErrorWithResponse(res, `ACS status code: ${res.status}`);
         }
     }
     getDate() {

package/esm/types/CamOverlayAPI/CamOverlayAPI.js

@@ -84,12 +84,12 @@ export const getStorageResponseSchema = (fileType) => {
 };
 export const imageFileSchema = z.object({
     name: z.string(),
-    path: z.string().url(),
+    path: z.url(),
     storage: imageFileStorageTypeSchema,
 });
 export const fontFileSchema = z.object({
     name: z.string(),
-    path: z.string().url(),
+    path: z.url(),
     storage: fontFileStorageTypeSchema,
 });
 export const getFileSchema = (fileType) => {

package/esm/types/CamOverlayAPI/htmlOverlaySchema.js

@@ -5,7 +5,7 @@ export const htmlOverlaySchema = serviceCommonSchema.extend({
     pos_x: z.number().nonnegative(),
     pos_y: z.number().nonnegative(),
     coordSystem: coordinateSystemSchema,
-    url: z.string().url().or(z.literal('')).default(''),
+    url: z.url().or(z.literal('')).default(''),
     pageWidth: z.number().nonnegative(),
     pageHeight: z.number().nonnegative(),
     fps: z.number().nonnegative(),

package/esm/types/CamOverlayAPI/pipSchema.js

@@ -9,8 +9,8 @@ export const pipSchema = serviceCommonSchema.extend({
     compression: z.number().nonnegative(),
     screenSize: z.number().nonnegative(),
     source_type: z.union([z.literal('axis_camera'), z.literal('mjpeg_url')]),
-    mjpeg_url: z.union([z.string().url(), z.literal('')]),
-    camera_ip: z.union([z.string().ip(), z.literal('')]),
+    mjpeg_url: z.union([z.url(), z.literal('')]),
+    camera_ip: z.union([z.ipv4(), z.ipv6(), z.literal('')]),
     camera_port: z.number().nonnegative(),
     camera_user: z.string(),
     camera_pass: z.string(),

package/esm/types/CamOverlayAPI/ptzCompassSchema.js

@@ -7,7 +7,7 @@ export const ptzCompassSchema = serviceCommonSchema.extend({
     coordSystem: coordinateSystemSchema,
     scale: z.number().nonnegative(),
     type: z.union([z.literal('compass'), z.literal('map'), z.literal('image')]),
-    image: z.union([z.string().url(), z.literal('')]),
+    image: z.union([z.url(), z.literal('')]),
     northPan: z.number(),
     cameraPosX: z.number(),
     cameraPosY: z.number(),

package/esm/types/CamStreamerAPI/youtubeSchema.js

@@ -5,7 +5,7 @@ export const youtubeSchema = streamCommonSchema.extend({
     description: z.string().optional(),
     playlists: z.array(z.string()),
     tags: z.array(z.string()),
-    notificationEmails: z.array(z.string().email()),
+    notificationEmails: z.array(z.email()),
     streamPrivacy: z.union([z.literal('public'), z.literal('unlisted'), z.literal('private')]),
     latency: z.union([z.literal('normal'), z.literal('low'), z.literal('ultra_low')]),
     afterEndStatus: z.union([z.literal('no_change'), z.literal('public'), z.literal('unlisted'), z.literal('private')]),

package/esm/types/CamSwitcherAPI.js

@@ -142,6 +142,7 @@ export const cameraOptionsSchema = bitrateVapixParamsSchema
     bitrateVapixParams: z.string().nullable(),
     audioSampleRate: z.number(),
     audioChannelCount: audioChannelCountSchema,
+    audioBitrate: z.number().int().nonnegative(),
     keyboard: z.object({
         fromSource: keyboardShortcutSchema,
         none: keyboardShortcutSchema,

package/esm/types/PlaneTrackerAPI.js

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 export const connectionSchema = z.object({
     protocol: z.union([z.literal('http'), z.literal('https'), z.literal('https_insecure')]),
-    ip: z.union([z.string().ip(), z.literal('')]),
+    ip: z.union([z.ipv4(), z.ipv6(), z.literal('')]),
     port: z.number().positive().lt(65535),
     user: z.string(),
     pass: z.string(),
@@ -25,6 +25,7 @@ export const widgetSchema = z.object({
     posY: z.number().nonnegative(),
     scale: z.number().positive(),
 });
+const widgetUnitsSchema = z.union([z.literal('metric'), z.literal('imperial'), z.literal('rotate')]);
 const labelOptionsSchema = z.union([
     z.literal('blank'),
     z.literal('registration'),
@@ -90,7 +91,7 @@ export const cameraSettingsSchema = z.object({
     adsbSource: z
         .object({
         enabled: z.boolean().default(true),
-        ip: z.union([z.string().ip(), z.literal('')]),
+        ip: z.union([z.ipv4(), z.ipv6(), z.literal('')]),
         port: z.number().positive().lt(65535),
         useSystemTime: z.boolean().default(false),
     })
@@ -159,7 +160,7 @@ export const cameraSettingsSchema = z.object({
         guardTourEnabled: z.boolean().default(false),
         guardTourId: z.number().int().nonnegative().default(0),
     })
-        .default({ prioritizeEmergency: true, guardTourEnabled: false, guardTourId: 0 }),
+        .default({ prioritizeEmergency: true, trackingZoneWeightIncrease: 0, guardTourEnabled: false, guardTourId: 0 }),
     overlayText: z
         .object({
         displayIcao: z.boolean().optional(),
@@ -186,18 +187,25 @@ export const cameraSettingsSchema = z.object({
         displaySystemInfo: z.boolean().optional(),
     })
         .optional(),
-    widget: widgetSchema.default({
+    widget: widgetSchema
+        .extend({
+        units: widgetUnitsSchema.default('rotate'),
+    })
+        .default({
         enabled: true,
         coord: 'top_right',
         posX: 10,
         posY: 10,
         scale: 100,
+        units: 'rotate',
     }),
     airportWidget: widgetSchema
         .extend({
         showWeather: z.boolean().default(false),
         weatherLocationKey: z.string().default(''),
         weatherLocationName: z.string().default(''),
+        windSpeedUnits: widgetUnitsSchema.default('rotate'),
+        temperatureUnits: widgetUnitsSchema.default('rotate'),
     })
         .default({
         enabled: true,
@@ -208,6 +216,8 @@ export const cameraSettingsSchema = z.object({
         showWeather: false,
         weatherLocationKey: '',
         weatherLocationName: '',
+        windSpeedUnits: 'rotate',
+        temperatureUnits: 'rotate',
     }),
     fr24FlightInfoSource: z
         .object({
@@ -226,7 +236,7 @@ export const cameraSettingsSchema = z.object({
         .object({
         enabled: z.boolean().default(false),
         priority: z.number().int().positive().default(2),
-        ip: z.union([z.string().ip(), z.literal('')]).default(''),
+        ip: z.union([z.ipv4(), z.ipv6(), z.literal('')]).default(''),
         port: z.number().positive().lt(65535).default(80),
     })
         .default({
@@ -426,7 +436,7 @@ const domainDescriptorSchema = z.object({
     icon: categoryIconSchema,
     categoryList: z.array(categoryDescriptorSchema),
 });
-export const domainListSchema = z.record(domainIdSchema, domainDescriptorSchema);
+export const domainListSchema = z.partialRecord(domainIdSchema, domainDescriptorSchema);
 export const ADSB_CATEGORY_IDS = {
     A_LIGHT: 'A_LIGHT',
     A_SMALL: 'A_SMALL',

package/esm/types/PlaneTrackerAPI.test.js

@@ -86,3 +86,30 @@ describe('cameraSettingsSchema cameraConfig', () => {
         expect(cameraSettingsSchema.safeParse({ cameraConfig }).success).toBe(false);
     });
 });
+describe('cameraSettingsSchema widget units', () => {
+    const WIDGET = { coord: 'top_left', posX: 10, posY: 10, scale: 100 };
+    test('defaults all widget units to rotate', () => {
+        const settings = cameraSettingsSchema.parse({});
+        expect(settings.widget.units).toBe('rotate');
+        expect(settings.airportWidget.windSpeedUnits).toBe('rotate');
+        expect(settings.airportWidget.temperatureUnits).toBe('rotate');
+    });
+    test('defaults missing units of saved widgets to rotate', () => {
+        const settings = cameraSettingsSchema.parse({ widget: WIDGET, airportWidget: WIDGET });
+        expect(settings.widget.units).toBe('rotate');
+        expect(settings.airportWidget.windSpeedUnits).toBe('rotate');
+        expect(settings.airportWidget.temperatureUnits).toBe('rotate');
+    });
+    test('parses independent widget units', () => {
+        const settings = cameraSettingsSchema.parse({
+            widget: { ...WIDGET, units: 'imperial' },
+            airportWidget: { ...WIDGET, windSpeedUnits: 'rotate', temperatureUnits: 'metric' },
+        });
+        expect(settings.widget.units).toBe('imperial');
+        expect(settings.airportWidget.windSpeedUnits).toBe('rotate');
+        expect(settings.airportWidget.temperatureUnits).toBe('metric');
+    });
+    test('rejects an unknown widget unit', () => {
+        expect(cameraSettingsSchema.safeParse({ widget: { ...WIDGET, units: 'kelvin' } }).success).toBe(false);
+    });
+});

package/esm/types/VapixAPI.js

@@ -195,6 +195,6 @@ export const portSequenceStateSchema = z.object({
 export const recordingConfigItemSchema = z.object({
     diskid: z.string(),
     eventid: z.string(),
-    options: z.record(z.string()),
+    options: z.record(z.string(), z.string()),
     profile: z.string(),
 });

package/esm/types/common.js

@@ -11,7 +11,7 @@ export const networkCameraListSchema = z.array(z.object({
     ip: z.string(),
 }));
 export const keyboardShortcutSchema = z.string().nullable();
-export const keyboardShortcutsSchema = z.record(keyboardShortcutSchema);
+export const keyboardShortcutsSchema = z.record(z.string(), keyboardShortcutSchema);
 export const wsAliasResponseSchema = z.object({
     alias: z.string(),
     ws: z.string(),

package/esm/types/ws/PlaneTrackerEvents.js

@@ -75,7 +75,7 @@ export var EUserActions;
     EUserActions["UNLOCK_API"] = "unlockApi.cgi";
 })(EUserActions || (EUserActions = {}));
 const eventsDataSchema = z.union([
-    z.object({ type: z.literal('CAMERA_POSITION') }).merge(wsCameraPositionDataSchema),
+    z.object({ type: z.literal('CAMERA_POSITION') }).extend(wsCameraPositionDataSchema.shape),
     z.object({
         type: z.literal('TRACKING_START'),
         icao: z.string(),

package/esm/web/WsClient.js

@@ -1,4 +1,4 @@
-const REFRESH_TIMEOUT = 5000;
+const REFRESH_TIMEOUT = 5_000;
 export class WsClient {
     getUrl;
     isDestroyed = false;

package/package.json

@@ -1,114 +1,113 @@
 {
-    "name": "camstreamerlib",
-    "version": "4.0.36",
-    "description": "Helper library for CamStreamer ACAP applications.",
-    "prettier": "@camstreamer/prettier-config",
-    "engine": {
-        "node": ">=18.0.0"
+  "name": "camstreamerlib",
+  "version": "5.0.0-20ab5c4",
+  "description": "Helper library for CamStreamer ACAP applications.",
+  "prettier": "@camstreamer/prettier-config",
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "adm-zip": "^0.6.0",
+    "eventemitter2": "^6.4.9",
+    "fast-xml-parser": "^5.3.6",
+    "type-fest": "^5.10.0",
+    "undici": "^6.28.1",
+    "ws": "^8.18.0",
+    "zod": "^4.6.7"
+  },
+  "devDependencies": {
+    "@camstreamer/eslint-config": "^1.0.10",
+    "@camstreamer/prettier-config": "^2.0.4",
+    "@eslint/js": "^10.0.1",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^18.19.127",
+    "@types/ws": "^8.5.10",
+    "esbuild": "^0.28.2",
+    "eslint": "^10.12.0",
+    "eslint-plugin-unused-imports": "^4.4.1",
+    "globals": "^17.13.0",
+    "jest": "^30.5.2",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.7.1",
+    "ts-jest": "^29.4.14",
+    "ts-node": "^10.7.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.71.2"
+  },
+  "overrides": {
+    "js-yaml": "^4.3.2",
+    "browserslist": "^4.28.7"
+  },
+  "scripts": {
+    "clean": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\"",
+    "build": "npm-run-all clean build:cjs build:esm copyPackage",
+    "build:cjs": "tsc --project tsconfig.cjs.json",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "build:browser": "esbuild src/browser.index.ts --bundle --format=esm --platform=browser --target=es2022 --outfile=examples/camstreamerlib.js",
+    "copyPackage": "cp -f LICENSE dist/ && cp -f README.md dist/ && cp -f package.json dist/ && cp -r -f examples dist/",
+    "publishPackage": "./publish.sh",
+    "lint": "eslint \"src/**/*.ts\"",
+    "lint:fix": "eslint \"src/**/*.ts\" --fix",
+    "pretty": "prettier --write \"./{{src,doc}/**/*.{ts,tsx,md},README.md}\"",
+    "pretty:check": "prettier --check \"./{{src,doc}/**/*.{ts,tsx,md},README.md}\"",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "audit": "npm audit --audit-level=high"
+  },
+  "files": [
+    "/**/*.js",
+    "/**/*.ts",
+    "/examples/**/*"
+  ],
+  "main": "./cjs/index.js",
+  "module": "./esm/index.js",
+  "types": "types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./cjs/index.js",
+      "types": "./types/index.d.ts"
     },
-    "dependencies": {
-        "adm-zip": "^0.6.0",
-        "eventemitter2": "^5.0.1",
-        "fast-xml-parser": "^5.3.6",
-        "type-fest": "^4.41.0",
-        "undici": "^6.28.1",
-        "ws": "^8.18.0",
-        "zod": "^3.25.76"
+    "./web": {
+      "import": "./esm/web/index.js",
+      "require": "./cjs/web/index.js",
+      "types": "./types/web/index.d.ts"
     },
-    "devDependencies": {
-        "@camstreamer/eslint-config": "^1.0.10",
-        "@camstreamer/prettier-config": "^2.0.4",
-        "@eslint/js": "^10.0.1",
-        "@types/adm-zip": "^0.5.5",
-        "@types/jest": "^30.0.0",
-        "@types/node": "^18.19.127",
-        "@types/ws": "^8.5.10",
-        "esbuild": "^0.28.2",
-        "eslint": "^10.12.0",
-        "eslint-plugin-unused-imports": "^4.4.1",
-        "globals": "^17.13.0",
-        "jest": "^30.5.2",
-        "npm-run-all": "^4.1.5",
-        "prettier": "^2.7.1",
-        "ts-jest": "^29.4.14",
-        "ts-node": "^10.7.0",
-        "typescript": "5.3.3",
-        "typescript-eslint": "^8.71.2"
+    "./node": {
+      "import": "./esm/node/index.js",
+      "require": "./cjs/node/index.js",
+      "types": "./types/node/index.d.ts"
     },
-    "overrides": {
-        "js-yaml": "^4.3.2",
-        "browserslist": "^4.28.7"
+    "./cjs/index": {
+      "import": "./esm/index.js",
+      "require": "./cjs/index.js",
+      "types": "./types/index.d.ts"
     },
-    "scripts": {
-        "clean": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\"",
-        "build": "npm-run-all clean build:cjs build:esm copyPackage",
-        "build:cjs": "tsc --project tsconfig.cjs.json",
-        "build:esm": "tsc --project tsconfig.esm.json",
-        "build:browser": "esbuild src/browser.index.ts --bundle --format=esm --platform=browser --target=es2022 --outfile=examples/camstreamerlib.js",
-        "copyPackage": "cp -f LICENSE dist/ && cp -f README.md dist/ && cp -f package.json dist/ && cp -r -f examples dist/",
-        "publishPackage": "./publish.sh",
-        "lint": "eslint \"src/**/*.ts\"",
-        "lint:fix": "eslint \"src/**/*.ts\" --fix",
-        "pretty": "prettier --write \"./{{src,doc}/**/*.{ts,tsx,md},README.md}\"",
-        "pretty:check": "prettier --check \"./{{src,doc}/**/*.{ts,tsx,md},README.md}\"",
-        "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
-        "audit": "npm audit --audit-level=high"
+    "./cjs/node": {
+      "import": "./esm/node/index.js",
+      "require": "./cjs/node/index.js",
+      "types": "./types/node/index.js"
     },
-    "files": [
-        "/**/*.js",
-        "/**/*.ts",
-        "/examples/**/*"
-    ],
-    "main": "./cjs/index.js",
-    "module": "./esm/index.js",
-    "types": "types/index.d.ts",
-    "exports": {
-        ".": {
-            "import": "./esm/index.js",
-            "require": "./cjs/index.js",
-            "types": "./types/index.d.ts"
-        },
-        "./web": {
-            "import": "./esm/web/index.js",
-            "require": "./cjs/web/index.js",
-            "types": "./types/web/index.d.ts"
-        },
-        "./node": {
-            "import": "./esm/node/index.js",
-            "require": "./cjs/node/index.js",
-            "types": "./types/node/index.d.ts"
-        },
-        "./cjs/index": {
-            "import": "./esm/index.js",
-            "require": "./cjs/index.js",
-            "types": "./types/index.d.ts"
-        },
-        "./cjs/node": {
-            "import": "./esm/node/index.js",
-            "require": "./cjs/node/index.js",
-            "types": "./types/node/index.js"
-        },
-        "./cjs/node/index": {
-            "import": "./esm/node/index.js",
-            "require": "./cjs/node/index.js",
-            "types": "./types/node/index.js"
-        }
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/CamStreamer/CamStreamerLib.git"
-    },
-    "keywords": [
-        "CamStreamer",
-        "CamOverlay",
-        "CamScripter",
-        "Camera",
-        "Axis"
-    ],
-    "author": "CamStreamer s.r.o",
-    "license": "ISC",
-    "bugs": {
-        "url": "https://github.com/CamStreamer/CamStreamerLib/issues"
-    },
-    "homepage": "https://github.com/CamStreamer/CamStreamerLib#readme"
+    "./cjs/node/index": {
+      "import": "./esm/node/index.js",
+      "require": "./cjs/node/index.js",
+      "types": "./types/node/index.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/CamStreamer/CamStreamerLib.git"
+  },
+  "keywords": [
+    "CamStreamer",
+    "CamOverlay",
+    "CamScripter",
+    "Camera",
+    "Axis"
+  ],
+  "author": "CamStreamer s.r.o",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/CamStreamer/CamStreamerLib/issues"
+  },
+  "homepage": "https://github.com/CamStreamer/CamStreamerLib#readme"
 }