camstreamerlib 4.0.36 → 4.0.37

package/cjs/PlaneTrackerAPI.d.ts

@@ -87,6 +87,7 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
         widget: {
             enabled: boolean;
             scale: number;
+            units: "rotate" | "metric" | "imperial";
             coord: "top_left" | "top_right" | "bottom_left" | "bottom_right";
             posX: number;
             posY: number;
@@ -100,6 +101,8 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
             posY: number;
             showWeather: boolean;
             weatherLocationKey: string;
+            windSpeedUnits: "rotate" | "metric" | "imperial";
+            temperatureUnits: "rotate" | "metric" | "imperial";
         };
         fr24FlightInfoSource: {
             enabled: boolean;

package/cjs/errors/errors.d.ts

@@ -3,7 +3,7 @@ import { TStream } from '../types/CamStreamerAPI';
 import { TOldStream } from '../types/CamStreamerAPI/oldStreamSchema';
 export declare class ErrorWithResponse<T extends TResponse> extends Error {
     res: T;
-    constructor(res: T);
+    constructor(res: T, message?: string);
 }
 export declare class ServiceUnavailableError extends Error {
     constructor();

package/cjs/errors/errors.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MigrationError = exports.BadRequestError = exports.ServerError = exports.InvalidAltitudeError = exports.InvalidLatLngError = exports.CannotSetCoordsInAutoModeError = exports.ImportSettingsError = exports.ResetCalibrationError = exports.TimezoneFetchError = exports.TimezoneNotSetupError = exports.UtcTimeFetchError = exports.WsAuthorizationError = exports.StorageDataFetchError = exports.PtzNotSupportedError = exports.GenerateSilenceError = exports.AddNewClipError = exports.FetchDeviceInfoError = exports.NoDeviceInfoError = exports.MaxFPSError = exports.SDCardJobError = exports.SDCardActionError = exports.ApplicationAPIError = exports.SettingParameterError = exports.ParameterNotFoundError = exports.JsonParseError = exports.ParsingBlobError = exports.ServiceNotFoundError = exports.ServiceUnavailableError = exports.ErrorWithResponse = void 0;
 class ErrorWithResponse extends Error {
     res;
-    constructor(res) {
-        super(res.statusText);
+    constructor(res, message) {
+        super(message ?? res.statusText);
         this.res = res;
         this.name = 'ErrorWithResponse';
     }

package/cjs/node/events/AxisCameraStationEvents.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AxisCameraStationEvents = void 0;
+const errors_1 = require("../../errors/errors");
 const utils_1 = require("../../internal/utils");
 const ProxyClient_1 = require("../../internal/ProxyClient");
 const DefaultClient_1 = require("../DefaultClient");
@@ -36,7 +37,7 @@ class AxisCameraStationEvents {
             timeout: options?.timeout,
         });
         if (!res.ok) {
-            throw new Error(`ACS status code: ${res.status}`);
+            throw new errors_1.ErrorWithResponse(res, `ACS status code: ${res.status}`);
         }
     }
     getDate() {

package/cjs/types/PlaneTrackerAPI.d.ts

@@ -54,6 +54,8 @@ export declare const widgetSchema: z.ZodObject<{
     posY: number;
     enabled?: boolean | undefined;
 }>;
+declare const widgetUnitsSchema: z.ZodUnion<[z.ZodLiteral<"metric">, z.ZodLiteral<"imperial">, z.ZodLiteral<"rotate">]>;
+export type TWidgetUnits = z.infer<typeof widgetUnitsSchema>;
 declare const labelOptionsSchema: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
 export type TLabelOption = z.infer<typeof labelOptionsSchema>;
 declare const droneLabelOptionsSchema: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"remote_id">]>;
@@ -313,9 +315,12 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         posX: z.ZodNumber;
         posY: z.ZodNumber;
         scale: z.ZodNumber;
+    } & {
+        units: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"metric">, z.ZodLiteral<"imperial">, z.ZodLiteral<"rotate">]>>;
     }, "strip", z.ZodTypeAny, {
         enabled: boolean;
         scale: number;
+        units: "rotate" | "metric" | "imperial";
         coord: "top_left" | "top_right" | "bottom_left" | "bottom_right";
         posX: number;
         posY: number;
@@ -325,6 +330,7 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         posX: number;
         posY: number;
         enabled?: boolean | undefined;
+        units?: "rotate" | "metric" | "imperial" | undefined;
     }>>;
     airportWidget: z.ZodDefault<z.ZodObject<{
         enabled: z.ZodDefault<z.ZodBoolean>;
@@ -336,6 +342,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         showWeather: z.ZodDefault<z.ZodBoolean>;
         weatherLocationKey: z.ZodDefault<z.ZodString>;
         weatherLocationName: z.ZodDefault<z.ZodString>;
+        windSpeedUnits: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"metric">, z.ZodLiteral<"imperial">, z.ZodLiteral<"rotate">]>>;
+        temperatureUnits: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"metric">, z.ZodLiteral<"imperial">, z.ZodLiteral<"rotate">]>>;
     }, "strip", z.ZodTypeAny, {
         enabled: boolean;
         scale: number;
@@ -345,6 +353,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         posY: number;
         showWeather: boolean;
         weatherLocationKey: string;
+        windSpeedUnits: "rotate" | "metric" | "imperial";
+        temperatureUnits: "rotate" | "metric" | "imperial";
     }, {
         scale: number;
         coord: "top_left" | "top_right" | "bottom_left" | "bottom_right";
@@ -354,6 +364,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         weatherLocationName?: string | undefined;
         showWeather?: boolean | undefined;
         weatherLocationKey?: string | undefined;
+        windSpeedUnits?: "rotate" | "metric" | "imperial" | undefined;
+        temperatureUnits?: "rotate" | "metric" | "imperial" | undefined;
     }>>;
     fr24FlightInfoSource: z.ZodDefault<z.ZodObject<{
         enabled: z.ZodDefault<z.ZodBoolean>;
@@ -614,6 +626,7 @@ export declare const cameraSettingsSchema: z.ZodObject<{
     widget: {
         enabled: boolean;
         scale: number;
+        units: "rotate" | "metric" | "imperial";
         coord: "top_left" | "top_right" | "bottom_left" | "bottom_right";
         posX: number;
         posY: number;
@@ -627,6 +640,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         posY: number;
         showWeather: boolean;
         weatherLocationKey: string;
+        windSpeedUnits: "rotate" | "metric" | "imperial";
+        temperatureUnits: "rotate" | "metric" | "imperial";
     };
     fr24FlightInfoSource: {
         enabled: boolean;
@@ -802,6 +817,7 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         posX: number;
         posY: number;
         enabled?: boolean | undefined;
+        units?: "rotate" | "metric" | "imperial" | undefined;
     } | undefined;
     airportWidget?: {
         scale: number;
@@ -812,6 +828,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         weatherLocationName?: string | undefined;
         showWeather?: boolean | undefined;
         weatherLocationKey?: string | undefined;
+        windSpeedUnits?: "rotate" | "metric" | "imperial" | undefined;
+        temperatureUnits?: "rotate" | "metric" | "imperial" | undefined;
     } | undefined;
     fr24FlightInfoSource?: {
         enabled?: boolean | undefined;

package/cjs/types/PlaneTrackerAPI.js

@@ -28,6 +28,7 @@ exports.widgetSchema = zod_1.z.object({
     posY: zod_1.z.number().nonnegative(),
     scale: zod_1.z.number().positive(),
 });
+const widgetUnitsSchema = zod_1.z.union([zod_1.z.literal('metric'), zod_1.z.literal('imperial'), zod_1.z.literal('rotate')]);
 const labelOptionsSchema = zod_1.z.union([
     zod_1.z.literal('blank'),
     zod_1.z.literal('registration'),
@@ -189,18 +190,25 @@ exports.cameraSettingsSchema = zod_1.z.object({
         displaySystemInfo: zod_1.z.boolean().optional(),
     })
         .optional(),
-    widget: exports.widgetSchema.default({
+    widget: exports.widgetSchema
+        .extend({
+        units: widgetUnitsSchema.default('rotate'),
+    })
+        .default({
         enabled: true,
         coord: 'top_right',
         posX: 10,
         posY: 10,
         scale: 100,
+        units: 'rotate',
     }),
     airportWidget: exports.widgetSchema
         .extend({
         showWeather: zod_1.z.boolean().default(false),
         weatherLocationKey: zod_1.z.string().default(''),
         weatherLocationName: zod_1.z.string().default(''),
+        windSpeedUnits: widgetUnitsSchema.default('rotate'),
+        temperatureUnits: widgetUnitsSchema.default('rotate'),
     })
         .default({
         enabled: true,
@@ -211,6 +219,8 @@ exports.cameraSettingsSchema = zod_1.z.object({
         showWeather: false,
         weatherLocationKey: '',
         weatherLocationName: '',
+        windSpeedUnits: 'rotate',
+        temperatureUnits: 'rotate',
     }),
     fr24FlightInfoSource: zod_1.z
         .object({

package/cjs/types/PlaneTrackerAPI.test.js

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

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/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/PlaneTrackerAPI.js

@@ -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'),
@@ -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({

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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "camstreamerlib",
-    "version": "4.0.36",
+    "version": "4.0.37",
     "description": "Helper library for CamStreamer ACAP applications.",
     "prettier": "@camstreamer/prettier-config",
     "engine": {

package/types/PlaneTrackerAPI.d.ts

@@ -87,6 +87,7 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
         widget: {
             enabled: boolean;
             scale: number;
+            units: "rotate" | "metric" | "imperial";
             coord: "top_left" | "top_right" | "bottom_left" | "bottom_right";
             posX: number;
             posY: number;
@@ -100,6 +101,8 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
             posY: number;
             showWeather: boolean;
             weatherLocationKey: string;
+            windSpeedUnits: "rotate" | "metric" | "imperial";
+            temperatureUnits: "rotate" | "metric" | "imperial";
         };
         fr24FlightInfoSource: {
             enabled: boolean;

package/types/errors/errors.d.ts

@@ -3,7 +3,7 @@ import { TStream } from '../types/CamStreamerAPI';
 import { TOldStream } from '../types/CamStreamerAPI/oldStreamSchema';
 export declare class ErrorWithResponse<T extends TResponse> extends Error {
     res: T;
-    constructor(res: T);
+    constructor(res: T, message?: string);
 }
 export declare class ServiceUnavailableError extends Error {
     constructor();

package/types/types/PlaneTrackerAPI.d.ts

@@ -54,6 +54,8 @@ export declare const widgetSchema: z.ZodObject<{
     posY: number;
     enabled?: boolean | undefined;
 }>;
+declare const widgetUnitsSchema: z.ZodUnion<[z.ZodLiteral<"metric">, z.ZodLiteral<"imperial">, z.ZodLiteral<"rotate">]>;
+export type TWidgetUnits = z.infer<typeof widgetUnitsSchema>;
 declare const labelOptionsSchema: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"registration">, z.ZodLiteral<"call_sign">, z.ZodLiteral<"flight_number">, z.ZodLiteral<"icao">]>;
 export type TLabelOption = z.infer<typeof labelOptionsSchema>;
 declare const droneLabelOptionsSchema: z.ZodUnion<[z.ZodLiteral<"blank">, z.ZodLiteral<"remote_id">]>;
@@ -313,9 +315,12 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         posX: z.ZodNumber;
         posY: z.ZodNumber;
         scale: z.ZodNumber;
+    } & {
+        units: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"metric">, z.ZodLiteral<"imperial">, z.ZodLiteral<"rotate">]>>;
     }, "strip", z.ZodTypeAny, {
         enabled: boolean;
         scale: number;
+        units: "rotate" | "metric" | "imperial";
         coord: "top_left" | "top_right" | "bottom_left" | "bottom_right";
         posX: number;
         posY: number;
@@ -325,6 +330,7 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         posX: number;
         posY: number;
         enabled?: boolean | undefined;
+        units?: "rotate" | "metric" | "imperial" | undefined;
     }>>;
     airportWidget: z.ZodDefault<z.ZodObject<{
         enabled: z.ZodDefault<z.ZodBoolean>;
@@ -336,6 +342,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         showWeather: z.ZodDefault<z.ZodBoolean>;
         weatherLocationKey: z.ZodDefault<z.ZodString>;
         weatherLocationName: z.ZodDefault<z.ZodString>;
+        windSpeedUnits: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"metric">, z.ZodLiteral<"imperial">, z.ZodLiteral<"rotate">]>>;
+        temperatureUnits: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"metric">, z.ZodLiteral<"imperial">, z.ZodLiteral<"rotate">]>>;
     }, "strip", z.ZodTypeAny, {
         enabled: boolean;
         scale: number;
@@ -345,6 +353,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         posY: number;
         showWeather: boolean;
         weatherLocationKey: string;
+        windSpeedUnits: "rotate" | "metric" | "imperial";
+        temperatureUnits: "rotate" | "metric" | "imperial";
     }, {
         scale: number;
         coord: "top_left" | "top_right" | "bottom_left" | "bottom_right";
@@ -354,6 +364,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         weatherLocationName?: string | undefined;
         showWeather?: boolean | undefined;
         weatherLocationKey?: string | undefined;
+        windSpeedUnits?: "rotate" | "metric" | "imperial" | undefined;
+        temperatureUnits?: "rotate" | "metric" | "imperial" | undefined;
     }>>;
     fr24FlightInfoSource: z.ZodDefault<z.ZodObject<{
         enabled: z.ZodDefault<z.ZodBoolean>;
@@ -614,6 +626,7 @@ export declare const cameraSettingsSchema: z.ZodObject<{
     widget: {
         enabled: boolean;
         scale: number;
+        units: "rotate" | "metric" | "imperial";
         coord: "top_left" | "top_right" | "bottom_left" | "bottom_right";
         posX: number;
         posY: number;
@@ -627,6 +640,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         posY: number;
         showWeather: boolean;
         weatherLocationKey: string;
+        windSpeedUnits: "rotate" | "metric" | "imperial";
+        temperatureUnits: "rotate" | "metric" | "imperial";
     };
     fr24FlightInfoSource: {
         enabled: boolean;
@@ -802,6 +817,7 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         posX: number;
         posY: number;
         enabled?: boolean | undefined;
+        units?: "rotate" | "metric" | "imperial" | undefined;
     } | undefined;
     airportWidget?: {
         scale: number;
@@ -812,6 +828,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
         weatherLocationName?: string | undefined;
         showWeather?: boolean | undefined;
         weatherLocationKey?: string | undefined;
+        windSpeedUnits?: "rotate" | "metric" | "imperial" | undefined;
+        temperatureUnits?: "rotate" | "metric" | "imperial" | undefined;
     } | undefined;
     fr24FlightInfoSource?: {
         enabled?: boolean | undefined;