camstreamerlib 4.0.34 → 4.0.35-64a81fd

package/cjs/CamOverlayAPI.d.ts

@@ -14,6 +14,12 @@ export declare class CamOverlayAPI<Client extends IClient<TResponse, any>> exten
     }[]>;
     wsAuthorization(options?: THttpRequestOptions): Promise<string>;
     getMjpegStreamImage(mjpegUrl: string, options?: THttpRequestOptions): Promise<ReturnType<Awaited<ReturnType<Client["get"]>>["blob"]>>;
+    isViewerPassValid(pass: string, options?: THttpRequestOptions): Promise<boolean>;
+    getLiveViewAlias(rtspUrl: string, options?: THttpRequestOptions): Promise<{
+        alias: string;
+        ws: string;
+        ws_initial_message: string;
+    }>;
     listFiles<T extends TFileType>(fileType: T, options?: THttpRequestOptions): Promise<TFileList<T>>;
     uploadFile<T extends TFileType>(fileType: T, formData: Parameters<Client['post']>[0]['data'], storage: TFileStorageType<T>, options?: THttpRequestOptions): Promise<void>;
     removeFile<T extends TFileType>(fileType: T, fileParams: TFile<T>, options?: THttpRequestOptions): Promise<void>;

package/cjs/CamOverlayAPI.js

@@ -29,6 +29,22 @@ class CamOverlayAPI extends BasicAPI_1.BasicAPI {
     async getMjpegStreamImage(mjpegUrl, options) {
         return await this._getBlob(`${BASE_PATH}/fetch_mjpeg_image.cgi`, { mjpeg_url: decodeURIComponent(mjpegUrl) }, options);
     }
+    async isViewerPassValid(pass, options) {
+        const res = await this._getJson(`${BASE_PATH}/check_pass.cgi`, { pass }, options);
+        if (res.status !== 200) {
+            throw new Error(res.message);
+        }
+        return res.data === '1';
+    }
+    async getLiveViewAlias(rtspUrl, options) {
+        const agent = this.getClient(options?.proxyParams);
+        const res = await agent.get({
+            path: `${BASE_PATH}/getLiveViewAlias.cgi`,
+            parameters: { rtsp_url: rtspUrl },
+            timeout: options?.timeout,
+        });
+        return common_1.wsAliasResponseSchema.parse(await res.json());
+    }
     async listFiles(fileType, options) {
         const res = await this._getJson(`${BASE_PATH}/upload_${fileType}.cgi`, { action: 'list' }, options);
         return (0, CamOverlayAPI_1.getFileListSchema)(fileType).parse(res.list);

package/cjs/CamSwitcherAPI.d.ts

@@ -28,9 +28,9 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> exte
     }[]>;
     wsAuthorization(options?: THttpRequestOptions): Promise<string>;
     getOutputInfo(options?: THttpRequestOptions): Promise<{
-        rtspUrl: string;
         ws: string;
         wsInitialMessage: string;
+        rtspUrl: string;
     }>;
     getAudioPushInfo(options?: THttpRequestOptions): Promise<{
         ws: string;

package/cjs/PlaneTrackerAPI.d.ts

@@ -12,9 +12,9 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
     checkCameraTime(options?: THttpRequestOptions): Promise<boolean>;
     serverRunCheck(options?: THttpRequestOptions): Promise<boolean>;
     getLiveViewAlias(rtspUrl: string, options?: THttpRequestOptions): Promise<{
+        alias: string;
         ws: string;
         ws_initial_message: string;
-        alias: string;
     }>;
     resetPtzCalibration(options?: THttpRequestOptions): Promise<void>;
     resetFocusCalibration(options?: THttpRequestOptions): Promise<void>;
@@ -45,8 +45,23 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
             focusCalibrationPoints: string;
         };
         cameraConfig: {
-            defaultCaptureSizeMeters: number;
-            captureSizeExtensionMeters: number;
+            aircraft: {
+                defaultCaptureSizeMeters: number;
+                captureSizeExtensionMeters: number;
+            };
+            drone: {
+                defaultCaptureSizeMeters: number;
+                captureSizeExtensionMeters: number;
+            };
+        } | {
+            aircraft: {
+                defaultCaptureSizeMeters: number;
+                captureSizeExtensionMeters: number;
+            };
+            drone: {
+                defaultCaptureSizeMeters: number;
+                captureSizeExtensionMeters: number;
+            };
         };
         stream: {
             width: number;
@@ -99,11 +114,29 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
             priority: number;
         };
         identificationLabel: {
-            firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
-            secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
-            thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
-            fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
-            opacity: number;
+            aircraft: {
+                firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                opacity: number;
+            };
+            drone: {
+                firstRow: "blank" | "remote_id";
+                opacity: number;
+            };
+        } | {
+            aircraft: {
+                firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                opacity: number;
+            };
+            drone: {
+                firstRow: "blank" | "remote_id";
+                opacity: number;
+            };
         };
         acs: {
             ip: string;
@@ -181,11 +214,11 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
     importAppSettings(dataType: TImportDataType, formData: Parameters<Client['post']>[0]['data'], options?: THttpRequestOptions): Promise<void>;
     getDomainList(options?: THttpRequestOptions): Promise<Partial<Record<"adsb" | "remoteId", {
         uiName: string;
-        icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
+        icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
         categoryList: {
             categoryId: string;
             uiName: string;
-            icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
+            icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
         }[];
     }>>>;
     fetchFlightInfo(targetId: string, options?: THttpRequestOptions): Promise<{

package/cjs/PlaneTrackerAPI.js

@@ -4,6 +4,7 @@ exports.PlaneTrackerAPI = void 0;
 const zod_1 = require("zod");
 const PlaneTrackerAPI_1 = require("./types/PlaneTrackerAPI");
 const errors_1 = require("./errors/errors");
+const common_1 = require("./types/common");
 const BasicAPI_1 = require("./internal/BasicAPI");
 const PlaneTrackerEvents_1 = require("./types/ws/PlaneTrackerEvents");
 const BASE_PATH = '/local/planetracker';
@@ -37,7 +38,7 @@ class PlaneTrackerAPI extends BasicAPI_1.BasicAPI {
             parameters: { rtsp_url: rtspUrl },
             timeout: options?.timeout,
         });
-        return PlaneTrackerAPI_1.wsAliasResponseSchema.parse(await res.json());
+        return common_1.wsAliasResponseSchema.parse(await res.json());
     }
     async resetPtzCalibration(options) {
         const agent = this.getClient(options?.proxyParams);

package/cjs/VapixAPI.js

@@ -93,7 +93,9 @@ class VapixAPI extends BasicAPI_1.BasicAPI {
             };
             await this._postJsonEncoded('/axis-cgi/opticscontrol.cgi', data, undefined, options);
         }
-        catch {
+        catch (error) {
+            console.warn('Failed to perform autofocus: ', error instanceof Error ? error.message : String(error));
+            console.warn('Falling back to deprecated optics setup API');
             await this._postUrlEncoded('/axis-cgi/opticssetup.cgi', {
                 autofocus: 'perform',
                 source: '1',
@@ -144,7 +146,7 @@ class VapixAPI extends BasicAPI_1.BasicAPI {
             return data.data.activeTimeZone;
         }
         catch (error) {
-            console.warn('Failed to fetch time zone data from time API v2:', error instanceof Error ? error.message : JSON.stringify(error));
+            console.warn('Failed to fetch time zone data from time API v2:', error instanceof Error ? error.message : String(error));
             console.warn('Falling back to deprecated time API v1');
         }
         try {
@@ -563,17 +565,21 @@ class VapixAPI extends BasicAPI_1.BasicAPI {
             allowBooleanAttributes: true,
         });
         const result = parser.parse(xml);
-        let apps = result.reply.application ?? [];
-        if (!Array.isArray(apps)) {
-            apps = [apps];
-        }
-        const appList = apps.map((app) => {
-            return {
-                ...app,
-                appId: VapixAPI_1.ALL_APP_IDS.find((id) => id.toLowerCase() === app.Name.toLowerCase()) ?? null,
-            };
-        });
-        return VapixAPI_1.applicationListSchema.parse(appList);
+        const rawApps = result.reply.application ?? [];
+        const apps = Array.isArray(rawApps) ? rawApps : [rawApps];
+        const appList = [];
+        for (const app of apps) {
+            const parsedApp = VapixAPI_1.applicationSchema.safeParse(app);
+            if (!parsedApp.success) {
+                console.debug('Skipping invalid application entry:', app, parsedApp.error.issues);
+                continue;
+            }
+            appList.push({
+                ...parsedApp.data,
+                appId: VapixAPI_1.ALL_APP_IDS.find((id) => id.toLowerCase() === parsedApp.data.Name.toLowerCase()) ?? null,
+            });
+        }
+        return appList;
     }
     async startApplication(applicationId, options) {
         const agent = this.getClient(options?.proxyParams);

package/cjs/VapixAPI.test.d.ts

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

package/cjs/VapixAPI.test.js

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const VapixAPI_1 = require("./VapixAPI");
+const globals_1 = require("@jest/globals");
+const createApi = (xml) => {
+    const client = {
+        get: () => Promise.resolve(new Response(xml)),
+        post: () => Promise.reject(new Error('unused')),
+    };
+    return new VapixAPI_1.VapixAPI(client);
+};
+(0, globals_1.describe)('VapixAPI', () => {
+    (0, globals_1.describe)('getApplicationList', () => {
+        (0, globals_1.afterEach)(() => {
+            globals_1.jest.restoreAllMocks();
+        });
+        (0, globals_1.test)('skips the nameless entry of the live camera list', async () => {
+            const debugSpy = globals_1.jest.spyOn(console, 'debug').mockImplementation(() => { });
+            const api = createApi(`<reply result="ok">
+ <application Name="camstreamer" NiceName="CamStreamer App" Vendor="CamStreamer" Version="5.0-15" ApplicationID="413135" License="None" Status="Running" ConfigurationPage="local/camstreamer/settings.html" />
+ <application Name="" License="None" Status="Stopped" />
+ <application Name="vmd" NiceName="AXIS Video Motion Detection" Vendor="Axis Communications" Version="4.4-5" ApplicationID="143440" License="None" Status="Stopped" ConfigurationPage="local/vmd/config.html" VendorHomePage="http://www.axis.com" LicenseName="Proprietary" />
+</reply>`);
+            await (0, globals_1.expect)(api.getApplicationList()).resolves.toEqual([
+                {
+                    Name: 'camstreamer',
+                    NiceName: 'CamStreamer App',
+                    Vendor: 'CamStreamer',
+                    Version: '5.0-15',
+                    ApplicationID: '413135',
+                    License: 'None',
+                    Status: 'Running',
+                    ConfigurationPage: 'local/camstreamer/settings.html',
+                    appId: 'CamStreamer',
+                },
+                {
+                    Name: 'vmd',
+                    NiceName: 'AXIS Video Motion Detection',
+                    Vendor: 'Axis Communications',
+                    Version: '4.4-5',
+                    ApplicationID: '143440',
+                    License: 'None',
+                    Status: 'Stopped',
+                    ConfigurationPage: 'local/vmd/config.html',
+                    VendorHomePage: 'http://www.axis.com',
+                    LicenseName: 'Proprietary',
+                    appId: null,
+                },
+            ]);
+            (0, globals_1.expect)(debugSpy).toHaveBeenCalledTimes(1);
+            (0, globals_1.expect)(debugSpy.mock.calls[0]).toContainEqual({ Name: '', License: 'None', Status: 'Stopped' });
+        });
+        globals_1.test.each([
+            {
+                name: 'an entry without a name',
+                xml: '<reply result="ok"><application Name="vmd" NiceName="AXIS Video Motion Detection" Vendor="Axis Communications" Version="4.4-5" License="None" Status="Stopped" /><application License="None" Status="Stopped" /></reply>',
+                expected: [
+                    {
+                        Name: 'vmd',
+                        NiceName: 'AXIS Video Motion Detection',
+                        Vendor: 'Axis Communications',
+                        Version: '4.4-5',
+                        License: 'None',
+                        Status: 'Stopped',
+                        appId: null,
+                    },
+                ],
+            },
+            {
+                name: 'a named entry missing informational fields',
+                xml: '<reply result="ok"><application Name="vmd" NiceName="AXIS Video Motion Detection" Vendor="Axis Communications" Version="4.4-5" License="None" Status="Stopped" /><application Name="broken" License="None" Status="Stopped" /></reply>',
+                expected: [
+                    {
+                        Name: 'vmd',
+                        NiceName: 'AXIS Video Motion Detection',
+                        Vendor: 'Axis Communications',
+                        Version: '4.4-5',
+                        License: 'None',
+                        Status: 'Stopped',
+                        appId: null,
+                    },
+                ],
+            },
+        ])('skips invalid entries individually: $name', async ({ xml, expected }) => {
+            const debugSpy = globals_1.jest.spyOn(console, 'debug').mockImplementation(() => { });
+            await (0, globals_1.expect)(createApi(xml).getApplicationList()).resolves.toEqual(expected);
+            (0, globals_1.expect)(debugSpy).toHaveBeenCalledTimes(1);
+        });
+        globals_1.test.each([
+            {
+                name: 'drops attributes outside the schema',
+                xml: '<reply result="ok"><application Name="camoverlay" NiceName="CamOverlay App" Vendor="CamStreamer" Version="3.0-1" License="None" Status="Running" Unexpected="value" /></reply>',
+                expected: [
+                    {
+                        Name: 'camoverlay',
+                        NiceName: 'CamOverlay App',
+                        Vendor: 'CamStreamer',
+                        Version: '3.0-1',
+                        License: 'None',
+                        Status: 'Running',
+                        appId: 'CamOverlay',
+                    },
+                ],
+            },
+            {
+                name: 'maps an application outside the core CamStreamer apps to its appId',
+                xml: '<reply result="ok"><application Name="sporttracker" NiceName="SportTracker App" Vendor="CamStreamer" Version="1.0-1" License="None" Status="Running" /></reply>',
+                expected: [
+                    {
+                        Name: 'sporttracker',
+                        NiceName: 'SportTracker App',
+                        Vendor: 'CamStreamer',
+                        Version: '1.0-1',
+                        License: 'None',
+                        Status: 'Running',
+                        appId: 'SportTracker',
+                    },
+                ],
+            },
+            {
+                name: 'maps a capitalised application name to its appId',
+                xml: '<reply result="ok"><application Name="CamOverlay" NiceName="CamOverlay App" Vendor="CamStreamer" Version="3.0-1" License="None" Status="Running" /></reply>',
+                expected: [
+                    {
+                        Name: 'CamOverlay',
+                        NiceName: 'CamOverlay App',
+                        Vendor: 'CamStreamer',
+                        Version: '3.0-1',
+                        License: 'None',
+                        Status: 'Running',
+                        appId: 'CamOverlay',
+                    },
+                ],
+            },
+            {
+                name: 'returns an empty list when the camera has no applications',
+                xml: '<reply result="ok"></reply>',
+                expected: [],
+            },
+        ])('returns every valid entry with its appId and logs nothing: $name', async ({ xml, expected }) => {
+            const debugSpy = globals_1.jest.spyOn(console, 'debug').mockImplementation(() => { });
+            await (0, globals_1.expect)(createApi(xml).getApplicationList()).resolves.toEqual(expected);
+            (0, globals_1.expect)(debugSpy).not.toHaveBeenCalled();
+        });
+    });
+});

package/cjs/errors/errors.js

@@ -26,7 +26,7 @@ class ServiceNotFoundError extends Error {
 exports.ServiceNotFoundError = ServiceNotFoundError;
 class ParsingBlobError extends Error {
     constructor(err) {
-        super('Error parsing response as Blob: ' + err);
+        super('Error parsing response as Blob: ' + String(err));
         this.name = 'ParsingBlobError';
     }
 }
@@ -99,7 +99,7 @@ class NoDeviceInfoError extends Error {
 exports.NoDeviceInfoError = NoDeviceInfoError;
 class FetchDeviceInfoError extends Error {
     constructor(err) {
-        super('Error fetching remote camera data: ' + err);
+        super('Error fetching remote camera data: ' + String(err));
         this.name = 'NoDeviceInfoFromCameraError';
     }
 }
@@ -127,7 +127,7 @@ class PtzNotSupportedError extends Error {
 exports.PtzNotSupportedError = PtzNotSupportedError;
 class StorageDataFetchError extends Error {
     constructor(err) {
-        super('Error fetching storage data: ' + err);
+        super('Error fetching storage data: ' + String(err));
         this.name = 'StorageDataFetchError';
     }
 }
@@ -155,7 +155,7 @@ class TimezoneNotSetupError extends Error {
 exports.TimezoneNotSetupError = TimezoneNotSetupError;
 class TimezoneFetchError extends Error {
     constructor(err) {
-        super('Error fetching time zone information: ' + err);
+        super('Error fetching time zone information: ' + String(err));
         this.name = 'TimezoneFetchError';
     }
 }

package/cjs/types/CamSwitcherAPI.d.ts

@@ -25,21 +25,21 @@ export declare const outputInfoSchema: z.ZodEffects<z.ZodObject<{
     ws: z.ZodString;
     ws_initial_message: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    rtsp_url: string;
     ws: string;
     ws_initial_message: string;
-}, {
     rtsp_url: string;
+}, {
     ws: string;
     ws_initial_message: string;
+    rtsp_url: string;
 }>, {
-    rtspUrl: string;
     ws: string;
     wsInitialMessage: string;
+    rtspUrl: string;
 }, {
-    rtsp_url: string;
     ws: string;
     ws_initial_message: string;
+    rtsp_url: string;
 }>;
 export type TOutputInfo = z.infer<typeof outputInfoSchema>;
 export declare const audioPushInfoSchema: z.ZodEffects<z.ZodObject<{