camstreamerlib 4.0.13 → 4.0.15

package/cjs/CamStreamerAPI.js

@@ -37,6 +37,9 @@ class CamStreamerAPI extends BasicAPI_1.BasicAPI {
     }
     async isCSPassValid(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 getCamStreamerAppLog(options) {
@@ -44,6 +47,9 @@ class CamStreamerAPI extends BasicAPI_1.BasicAPI {
     }
     async getStreamList(options) {
         const res = await this._getJson(`${BASE_PATH}/stream_list.cgi`, { action: 'get' }, options);
+        if (res.status !== 200) {
+            throw new Error(res.message);
+        }
         const oldStreamListRecord = zod_1.z.record(zod_1.z.string(), oldStreamSchema_1.oldStringStreamSchema).safeParse(res.data);
         if (oldStreamListRecord.success) {
             const data = Object.entries(oldStreamListRecord.data).map(([streamId, streamData]) => ({
@@ -88,6 +94,9 @@ class CamStreamerAPI extends BasicAPI_1.BasicAPI {
     }
     async getStream(streamId, options) {
         const res = await this._getJson(`${BASE_PATH}/stream_list.cgi`, { action: 'get', stream_id: streamId }, options);
+        if (res.status !== 200) {
+            throw new Error(res.message);
+        }
         const newStream = CamStreamerAPI_1.streamSchema.safeParse(res.data);
         if (newStream.success) {
             return newStream.data;

package/cjs/VapixAPI.d.ts

@@ -101,10 +101,9 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> extends Ba
         usage: string;
         normalState: "open" | "closed";
         readonly?: boolean | undefined;
-    }[] | undefined>;
+    }[]>;
     setPorts(ports: TPortSetSchema[], options?: THttpRequestOptions): Promise<void>;
     setPortStateSequence(port: number, sequence: TPortSequenceStateSchema[], options?: THttpRequestOptions): Promise<void>;
-    private checkPortsAvailable;
     addCameraUser(username: string, pass: string, sgrp: string, comment?: string, options?: THttpRequestOptions): Promise<void>;
     getCameraUsers(options?: THttpRequestOptions): Promise<string[]>;
     editCameraUser(username: string, pass: string, options?: THttpRequestOptions): Promise<void>;

package/cjs/VapixAPI.js

@@ -408,51 +408,66 @@ class VapixAPI extends BasicAPI_1.BasicAPI {
             return portResponseParsed.data.items ?? [];
         }
         catch (error) {
-            await this.checkPortsAvailable(error);
+            if (error instanceof errors_1.ErrorWithResponse && error.res.status === 404) {
+                console.warn(error, 'Error while fetching ports, trying param.cgi directly');
+                const ports = await this.getParameter([constants_1.PORT_PARAMS.inputNbr, constants_1.PORT_PARAMS.outputNbr]);
+                const nbrOfPorts = Number(ports[constants_1.PORT_PARAMS.inputNbr] ?? 0) + Number(ports[constants_1.PORT_PARAMS.outputNbr] ?? 0);
+                if (nbrOfPorts === 0) {
+                    return [];
+                }
+                const items = [];
+                for (let i = 0; i < nbrOfPorts; i++) {
+                    const portDirection = (await this.getParameter([constants_1.PORT_PARAMS.direction(i)]))[constants_1.PORT_PARAMS.direction(i)];
+                    if (portDirection === undefined) {
+                        continue;
+                    }
+                    const info = await this.getParameter([
+                        constants_1.PORT_PARAMS.configurable(i),
+                        constants_1.PORT_PARAMS.usage(i),
+                        portDirection === 'input' ? constants_1.PORT_PARAMS.inputState(i) : constants_1.PORT_PARAMS.outputState(i),
+                        portDirection === 'input' ? constants_1.PORT_PARAMS.inputName(i) : constants_1.PORT_PARAMS.outputName(i),
+                    ]);
+                    const portState = portDirection === 'input'
+                        ? info[constants_1.PORT_PARAMS.inputState(i)] === 'open'
+                            ? 'closed'
+                            : 'open'
+                        : info[constants_1.PORT_PARAMS.outputState(i)] === 'open'
+                            ? 'closed'
+                            : 'open';
+                    items.push({
+                        port: String(i),
+                        state: portState,
+                        configurable: info[constants_1.PORT_PARAMS.configurable(i)] !== 'no',
+                        usage: info[constants_1.PORT_PARAMS.usage(i)] ?? '',
+                        direction: portDirection,
+                        name: portDirection === 'input'
+                            ? info[constants_1.PORT_PARAMS.inputName(i)] ?? 'Port ' + i
+                            : info[constants_1.PORT_PARAMS.outputName(i)] ?? 'Port ' + i,
+                        normalState: portState,
+                    });
+                }
+                return items;
+            }
+            else {
+                throw error;
+            }
         }
     }
     async setPorts(ports, options) {
-        try {
-            await this._postJsonEncoded('/axis-cgi/io/portmanagement.cgi', {
-                apiVersion: '1.0',
-                context: '',
-                method: 'setPorts',
-                params: { ports },
-            }, undefined, options);
-        }
-        catch (error) {
-            await this.checkPortsAvailable(error);
-        }
+        await this._postJsonEncoded('/axis-cgi/io/portmanagement.cgi', {
+            apiVersion: '1.0',
+            context: '',
+            method: 'setPorts',
+            params: { ports },
+        }, undefined, options);
     }
     async setPortStateSequence(port, sequence, options) {
-        try {
-            await this._postJsonEncoded('/axis-cgi/io/portmanagement.cgi', {
-                apiVersion: '1.0',
-                context: '',
-                method: 'setStateSequence',
-                params: { port, sequence },
-            }, undefined, options);
-        }
-        catch (error) {
-            await this.checkPortsAvailable(error);
-        }
-    }
-    async checkPortsAvailable(error) {
-        if (error instanceof errors_1.ErrorWithResponse && error.res.status === 404) {
-            const ports = await this.getParameter([constants_1.PORT_PARAMS.inputNbr, constants_1.PORT_PARAMS.outputNbr]);
-            const inputPorts = ports[constants_1.PORT_PARAMS.inputNbr];
-            const outputPorts = ports[constants_1.PORT_PARAMS.outputNbr];
-            if ((inputPorts === undefined || inputPorts === '0') &&
-                (outputPorts === undefined || outputPorts === '0')) {
-                return [];
-            }
-            else {
-                throw new errors_1.PortManagementError(inputPorts, outputPorts);
-            }
-        }
-        else {
-            throw error;
-        }
+        await this._postJsonEncoded('/axis-cgi/io/portmanagement.cgi', {
+            apiVersion: '1.0',
+            context: '',
+            method: 'setStateSequence',
+            params: { port, sequence },
+        }, undefined, options);
     }
     async addCameraUser(username, pass, sgrp, comment, options) {
         const res = await this._postUrlEncoded('/axis-cgi/pwdgrp.cgi', {

package/cjs/errors/errors.d.ts

@@ -105,11 +105,4 @@ export declare class MigrationError extends Error {
         platform: string;
     }[]);
 }
-export declare class PortManagementError extends Error {
-    readonly ports: {
-        inputPorts?: string;
-        outputPorts?: string;
-    };
-    constructor(nbrOfInputPorts?: string, nbrOfOutputPorts?: string);
-}
 export {};

package/cjs/errors/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PortManagementError = 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.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;
+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.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) {
@@ -219,15 +219,3 @@ class MigrationError extends Error {
     }
 }
 exports.MigrationError = MigrationError;
-class PortManagementError extends Error {
-    ports;
-    constructor(nbrOfInputPorts, nbrOfOutputPorts) {
-        super('Failed to fetch ports using portmanagement.cgi');
-        this.name = 'PortManagementError';
-        this.ports = {
-            inputPorts: nbrOfInputPorts,
-            outputPorts: nbrOfOutputPorts,
-        };
-    }
-}
-exports.PortManagementError = PortManagementError;

package/cjs/internal/constants.d.ts

@@ -3,4 +3,11 @@ export declare const FIRMWARE_WITH_OVERLAYS_SUPPORT = "10.7.0";
 export declare const PORT_PARAMS: {
     readonly inputNbr: "Input.NbrOfInputs";
     readonly outputNbr: "Output.NbrOfOutputs";
+    readonly inputName: (port: number) => string;
+    readonly outputName: (port: number) => string;
+    readonly inputState: (port: number) => string;
+    readonly outputState: (port: number) => string;
+    readonly configurable: (port: number) => string;
+    readonly usage: (port: number) => string;
+    readonly direction: (port: number) => string;
 };

package/cjs/internal/constants.js

@@ -6,4 +6,11 @@ exports.FIRMWARE_WITH_OVERLAYS_SUPPORT = '10.7.0';
 exports.PORT_PARAMS = {
     inputNbr: 'Input.NbrOfInputs',
     outputNbr: 'Output.NbrOfOutputs',
+    inputName: (port) => `IOPort.I${port}.Input.Name`,
+    outputName: (port) => `IOPort.I${port}.Output.Name`,
+    inputState: (port) => `IOPort.I${port}.Input.Trig`,
+    outputState: (port) => `IOPort.I${port}.Output.Active`,
+    configurable: (port) => `IOPort.I${port}.Configurable`,
+    usage: (port) => `IOPort.I${port}.Usage`,
+    direction: (port) => `IOPort.I${port}.Direction`,
 };

package/esm/CamStreamerAPI.js

@@ -34,6 +34,9 @@ export class CamStreamerAPI extends BasicAPI {
     }
     async isCSPassValid(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 getCamStreamerAppLog(options) {
@@ -41,6 +44,9 @@ export class CamStreamerAPI extends BasicAPI {
     }
     async getStreamList(options) {
         const res = await this._getJson(`${BASE_PATH}/stream_list.cgi`, { action: 'get' }, options);
+        if (res.status !== 200) {
+            throw new Error(res.message);
+        }
         const oldStreamListRecord = z.record(z.string(), oldStringStreamSchema).safeParse(res.data);
         if (oldStreamListRecord.success) {
             const data = Object.entries(oldStreamListRecord.data).map(([streamId, streamData]) => ({
@@ -85,6 +91,9 @@ export class CamStreamerAPI extends BasicAPI {
     }
     async getStream(streamId, options) {
         const res = await this._getJson(`${BASE_PATH}/stream_list.cgi`, { action: 'get', stream_id: streamId }, options);
+        if (res.status !== 200) {
+            throw new Error(res.message);
+        }
         const newStream = streamSchema.safeParse(res.data);
         if (newStream.success) {
             return newStream.data;

package/esm/VapixAPI.js

@@ -1,6 +1,6 @@
 import { arrayToUrl, isNullish, paramToUrl } from './internal/utils';
 import { sdCardWatchedStatuses, maxFpsResponseSchema, dateTimeinfoSchema, audioDeviceRequestSchema, audioSampleRatesResponseSchema, timeZoneSchema, getPortsResponseSchema, guardTourSchema, ptzOverviewSchema, cameraPTZItemDataSchema, applicationListSchema, sdCardInfoSchema, ALL_APP_IDS, allDateTimeInfoSchema, } from './types/VapixAPI';
-import { ApplicationAPIError, MaxFPSError, NoDeviceInfoError, PtzNotSupportedError, ErrorWithResponse, SDCardActionError, SDCardJobError, SettingParameterError, TimezoneFetchError, PortManagementError, } from './errors/errors';
+import { ApplicationAPIError, MaxFPSError, NoDeviceInfoError, PtzNotSupportedError, ErrorWithResponse, SDCardActionError, SDCardJobError, SettingParameterError, TimezoneFetchError, } from './errors/errors';
 import { z } from 'zod';
 import { XMLParser } from 'fast-xml-parser';
 import { BasicAPI } from './internal/BasicAPI';
@@ -405,51 +405,66 @@ export class VapixAPI extends BasicAPI {
             return portResponseParsed.data.items ?? [];
         }
         catch (error) {
-            await this.checkPortsAvailable(error);
+            if (error instanceof ErrorWithResponse && error.res.status === 404) {
+                console.warn(error, 'Error while fetching ports, trying param.cgi directly');
+                const ports = await this.getParameter([PORT_PARAMS.inputNbr, PORT_PARAMS.outputNbr]);
+                const nbrOfPorts = Number(ports[PORT_PARAMS.inputNbr] ?? 0) + Number(ports[PORT_PARAMS.outputNbr] ?? 0);
+                if (nbrOfPorts === 0) {
+                    return [];
+                }
+                const items = [];
+                for (let i = 0; i < nbrOfPorts; i++) {
+                    const portDirection = (await this.getParameter([PORT_PARAMS.direction(i)]))[PORT_PARAMS.direction(i)];
+                    if (portDirection === undefined) {
+                        continue;
+                    }
+                    const info = await this.getParameter([
+                        PORT_PARAMS.configurable(i),
+                        PORT_PARAMS.usage(i),
+                        portDirection === 'input' ? PORT_PARAMS.inputState(i) : PORT_PARAMS.outputState(i),
+                        portDirection === 'input' ? PORT_PARAMS.inputName(i) : PORT_PARAMS.outputName(i),
+                    ]);
+                    const portState = portDirection === 'input'
+                        ? info[PORT_PARAMS.inputState(i)] === 'open'
+                            ? 'closed'
+                            : 'open'
+                        : info[PORT_PARAMS.outputState(i)] === 'open'
+                            ? 'closed'
+                            : 'open';
+                    items.push({
+                        port: String(i),
+                        state: portState,
+                        configurable: info[PORT_PARAMS.configurable(i)] !== 'no',
+                        usage: info[PORT_PARAMS.usage(i)] ?? '',
+                        direction: portDirection,
+                        name: portDirection === 'input'
+                            ? info[PORT_PARAMS.inputName(i)] ?? 'Port ' + i
+                            : info[PORT_PARAMS.outputName(i)] ?? 'Port ' + i,
+                        normalState: portState,
+                    });
+                }
+                return items;
+            }
+            else {
+                throw error;
+            }
         }
     }
     async setPorts(ports, options) {
-        try {
-            await this._postJsonEncoded('/axis-cgi/io/portmanagement.cgi', {
-                apiVersion: '1.0',
-                context: '',
-                method: 'setPorts',
-                params: { ports },
-            }, undefined, options);
-        }
-        catch (error) {
-            await this.checkPortsAvailable(error);
-        }
+        await this._postJsonEncoded('/axis-cgi/io/portmanagement.cgi', {
+            apiVersion: '1.0',
+            context: '',
+            method: 'setPorts',
+            params: { ports },
+        }, undefined, options);
     }
     async setPortStateSequence(port, sequence, options) {
-        try {
-            await this._postJsonEncoded('/axis-cgi/io/portmanagement.cgi', {
-                apiVersion: '1.0',
-                context: '',
-                method: 'setStateSequence',
-                params: { port, sequence },
-            }, undefined, options);
-        }
-        catch (error) {
-            await this.checkPortsAvailable(error);
-        }
-    }
-    async checkPortsAvailable(error) {
-        if (error instanceof ErrorWithResponse && error.res.status === 404) {
-            const ports = await this.getParameter([PORT_PARAMS.inputNbr, PORT_PARAMS.outputNbr]);
-            const inputPorts = ports[PORT_PARAMS.inputNbr];
-            const outputPorts = ports[PORT_PARAMS.outputNbr];
-            if ((inputPorts === undefined || inputPorts === '0') &&
-                (outputPorts === undefined || outputPorts === '0')) {
-                return [];
-            }
-            else {
-                throw new PortManagementError(inputPorts, outputPorts);
-            }
-        }
-        else {
-            throw error;
-        }
+        await this._postJsonEncoded('/axis-cgi/io/portmanagement.cgi', {
+            apiVersion: '1.0',
+            context: '',
+            method: 'setStateSequence',
+            params: { port, sequence },
+        }, undefined, options);
     }
     async addCameraUser(username, pass, sgrp, comment, options) {
         const res = await this._postUrlEncoded('/axis-cgi/pwdgrp.cgi', {

package/esm/errors/errors.js

@@ -188,14 +188,3 @@ export class MigrationError extends Error {
         this.unknown = unknown;
     }
 }
-export class PortManagementError extends Error {
-    ports;
-    constructor(nbrOfInputPorts, nbrOfOutputPorts) {
-        super('Failed to fetch ports using portmanagement.cgi');
-        this.name = 'PortManagementError';
-        this.ports = {
-            inputPorts: nbrOfInputPorts,
-            outputPorts: nbrOfOutputPorts,
-        };
-    }
-}

package/esm/internal/constants.js

@@ -3,4 +3,11 @@ export const FIRMWARE_WITH_OVERLAYS_SUPPORT = '10.7.0';
 export const PORT_PARAMS = {
     inputNbr: 'Input.NbrOfInputs',
     outputNbr: 'Output.NbrOfOutputs',
+    inputName: (port) => `IOPort.I${port}.Input.Name`,
+    outputName: (port) => `IOPort.I${port}.Output.Name`,
+    inputState: (port) => `IOPort.I${port}.Input.Trig`,
+    outputState: (port) => `IOPort.I${port}.Output.Active`,
+    configurable: (port) => `IOPort.I${port}.Configurable`,
+    usage: (port) => `IOPort.I${port}.Usage`,
+    direction: (port) => `IOPort.I${port}.Direction`,
 };

package/package.json

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

package/types/VapixAPI.d.ts

@@ -101,10 +101,9 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> extends Ba
         usage: string;
         normalState: "open" | "closed";
         readonly?: boolean | undefined;
-    }[] | undefined>;
+    }[]>;
     setPorts(ports: TPortSetSchema[], options?: THttpRequestOptions): Promise<void>;
     setPortStateSequence(port: number, sequence: TPortSequenceStateSchema[], options?: THttpRequestOptions): Promise<void>;
-    private checkPortsAvailable;
     addCameraUser(username: string, pass: string, sgrp: string, comment?: string, options?: THttpRequestOptions): Promise<void>;
     getCameraUsers(options?: THttpRequestOptions): Promise<string[]>;
     editCameraUser(username: string, pass: string, options?: THttpRequestOptions): Promise<void>;

package/types/errors/errors.d.ts

@@ -105,11 +105,4 @@ export declare class MigrationError extends Error {
         platform: string;
     }[]);
 }
-export declare class PortManagementError extends Error {
-    readonly ports: {
-        inputPorts?: string;
-        outputPorts?: string;
-    };
-    constructor(nbrOfInputPorts?: string, nbrOfOutputPorts?: string);
-}
 export {};

package/types/internal/constants.d.ts

@@ -3,4 +3,11 @@ export declare const FIRMWARE_WITH_OVERLAYS_SUPPORT = "10.7.0";
 export declare const PORT_PARAMS: {
     readonly inputNbr: "Input.NbrOfInputs";
     readonly outputNbr: "Output.NbrOfOutputs";
+    readonly inputName: (port: number) => string;
+    readonly outputName: (port: number) => string;
+    readonly inputState: (port: number) => string;
+    readonly outputState: (port: number) => string;
+    readonly configurable: (port: number) => string;
+    readonly usage: (port: number) => string;
+    readonly direction: (port: number) => string;
 };