camstreamerlib 4.0.0-beta.39 → 4.0.0-beta.40

package/README.md

@@ -15,37 +15,65 @@ Examples of CamScripter packages can be found at https://github.com/CamStreamer/
 npm install camstreamerlib
 ```
 
-# Documentation for ACAP and Camera API
+## Documentation for ACAP and Camera API
 
--   [VapixAPI](doc/VapixAPI.md) is a module to access Axis camera VAPIX interface.
 
--   [CamStreamerAPI](doc/CamStreamerAPI.md) is a module for easy control of video streaming in the CamStreamer ACAP application (RTMP, HLS, SRT and MPEG-TS protocols).
+| API  | Description |
+| ------------- | ------------- |
+| [VapixAPI](doc/VapixAPI.md)  | Module to access Axis camera VAPIX interface. |
+| [CamStreamerAPI](doc/CamStreamerAPI.md)  | Module for easy control of video streaming in the CamStreamer ACAP application (RTMP, HLS, SRT and MPEG-TS protocols). |
+| [CamOverlayAPI](doc/CamOverlayAPI.md)  | Module to access CamOverlay API. |
+| [CamScripterAPI](doc/CamScripterAPI.md)  | Module to access CamScripter API. |
+| [CamSwitcherAPI](doc/CamSwitcherAPI.md)  | Module to access CamSwitcher API. |
+| [PlaneTrackerAPI](doc/PlaneTrackerAPI.md)  | Module to access PlaneTracker API. |
 
--   [CamOverlayAPI](doc/CamOverlayAPI.md) is a module to access CamOverlay API.
+## Documentation for Node.js modules
 
--   [CamScripterAPI](doc/CamScripterAPI.md) is a module to access CamScripter API.
+| Module  | Description |
+| ------------- | ------------- |
+| [HttpServer](doc/HttpServer.md)  | Module for processing HTTP requests in your scripts. It also automatically serves up the content from html directory or you can register paths which you can process by your own (e.g. `http://$CAMERA_IP/local/camscripter/proxy/$MY_PACKAGE_NAME/control.cgi`). |
+| [VapixEvents](doc/VapixEvents.md) | Module which allows receiving camera events from the VAPIX API. |
+| [CamOverlayDrawingAPI](doc/CamOverlayDrawingAPI.md) | Module for easy control of CamOverlay drawing API. For more details on supported video overlay drawing functions see https://camstreamer.com/camoverlay-api1 |
+| [CamOverlayPainter](doc/CamOverlayPainter.md) | Contains three modules which makes easier to use CamOverlayDrawingAPI. |
+| [CamScripterAPICameraEventsGenerator](doc/CamScripterAPICameraEventsGenerator.md) | Module which allows generating events on an Axis camera. These events can be used for triggers in the Axis camera rule engine (events/actions). It is also an easy way how to integrate events and metadata in VMS systems which support Axis camera events. |
+| [CamSwitcherEvents](doc/CamSwitcherEvents.md) | Module which allows receiving events from CamSwitcher ACAP application. |
+| [GenetecAgent](doc/GenetecAgent.md) | Module which allows receiving and sending data to Genetec VMS. |
 
--   [CamSwitcherAPI](doc/CamSwitcherAPI.md) is a module to access CamSwitcher API.
 
--   [PlaneTrackerAPI](doc/PlaneTrackerAPI.md) is a module to access PlaneTracker API.
+## Breaking changes when moving from version 3.\*.\* to 4.\*.\* (latest)
 
-# Documentation for Node.js modules
-
--   [HttpServer](doc/HttpServer.md) is a module for processing HTTP requests in your scripts. It also automatically serves up the content from html directory or you can register paths which you can process by your own (e.g. http://$CAMERA_IP/local/camscripter/proxy/$MY_PACKAGE_NAME/control.cgi).
+...
 
--   [VapixEvents](doc/VapixEvents.md) is a module which allows receiving camera events from the VAPIX API.
 
--   [CamOverlayDrawingAPI](doc/CamOverlayDrawingAPI.md) is a module for easy control of CamOverlay drawing API. For more details on supported video overlay drawing functions see https://camstreamer.com/camoverlay-api1
+## Breaking changes when moving from version 2.\*.\* to 3.\*.\*
 
--   [CamOverlayPainter/](doc/CamOverlayPainter.md) contains three modules which makes easier to use CamOverlayDrawingAPI.
+-   CamStreamerlib requiers Node.js version 18 or higher.
+-   CamOverlayDrawingAPI tries to reconnect when the websocket is closed. You don't have to do it manually.
+> [!NOTE]
+> However, events `open` and `close` are still emitted in case you need to react to them.
+-   Files `common.ts`, `Digest.ts`, `HttpRequest.ts` and `WsClient.ts` moved to a folder internal.
+-   Removed function `httpRequest()`. Use `sendRequest()` instead. It uses the same interface except for the "noWaitForData" parameter.
+> [!IMPORTANT]
+> It returns (Response object)[https://developer.mozilla.org/en-US/docs/Web/API/Response] which doesn't contain data by default.
+> If you need to wait for data, you can call for example the function `await res.text()`.
+> This change affects the function `vapixGet` from (CameraVapix)[doc/CameraVapix.md] too.
 
--   [CamScripterAPICameraEventsGenerator](doc/CamScripterAPICameraEventsGenerator.md) is a module which allows generating events on an Axis camera. These events can be used for triggers in the Axis camera rule engine (events/actions). It is also an easy way how to integrate events and metadata in VMS systems which support Axis camera events.
+## Breaking changes when moving from version 1.\*.\* to 2.\*.\*
 
--   [CamSwitcherEvents](doc/CamSwitcherEvents.md) is a module which allows receiving events from CamSwitcher ACAP application.
+-   Renamed file HTTPRequest.ts to HttpRequest.ts
+-   Removed deprecated protocol attribute from all options objects (use tls instead).
+-   Removed RTSP
+> [!IMPORTANT]
+> Previously CameraVapix.ts supported both WebSocket and RTSP.
+> Starting with version 2.0.0, it supports WebSocket only.
+-   ServiceID shouldn't be passed to CamOverlayAPI by the options object. Pass it as a parameter.
+-   Renamed CamOverlayDrawingAPI event msg to message.
+-   Drawing services extracted from CamOverlayAPI.ts to a separate file.
+> [!IMPORTANT]
+> Please read [CamOverlayAPI](doc/CamOverlayAPI.md) and [CamOverlayDrawingAPI](doc/CamOverlayDrawingAPI.md) for more information.
 
--   [GenetecAgent](doc/GenetecAgent.md) is a module which allows receiving and sending data to Genetec VMS.
 
-## For Developers
+# For Developers
 
 ### Publishing to npm repository
 
@@ -81,36 +109,4 @@ The zip package is created in the current directory. You can choose different lo
 "scripts": {
     "create-package": "node node_modules/camstreamerlib/bin/CreatePackage.js -i -e=react"
 }
-```
-
-### Breaking changes when moving from version 3.\*.\* to 4.\*.\*
-
-...
-
-
-### Breaking changes when moving from version 2.\*.\* to 3.\*.\*
-
--   CamStreamerlib requiers Node.js version 18 or higher.
--   CamOverlayDrawingAPI tries to reconnect when the websocket is closed. You don't have to do it manually.
-> [!IMPORTANT]
-> However, events `open` and `close` are still emitted in case you need to react to them.
--   Files common.ts, Digest.ts, HttpRequest.ts and WsClient.ts moved to a folder internal.
--   Removed function httpRequest(). Use sendRequest() instead. It uses the same interface except for the "noWaitForData" parameter.
-> [!IMPORTANT]
-> It returns (Response object)[https://developer.mozilla.org/en-US/docs/Web/API/Response] which doesn't contain data by default.
-> If you need to wait for data, you can call for example the function `await res.text()`.
-> This change affects the function `vapixGet` from (CameraVapix)[doc/CameraVapix.md] too.
-
-### Breaking changes when moving from version 1.\*.\* to 2.\*.\*
-
--   Renamed file HTTPRequest.ts to HttpRequest.ts
--   Removed deprecated protocol attribute from all options objects (use tls instead).
--   Removed RTSP
-> [!IMPORTANT]
-> Previously CameraVapix.ts supported both WebSocket and RTSP.
-> Starting with version 2.0.0, it supports WebSocket only.
--   ServiceID shouldn't be passed to CamOverlayAPI by the options object. Pass it as a parameter.
--   Renamed CamOverlayDrawingAPI event msg to message.
--   Drawing services extracted from CamOverlayAPI.ts to a separate file.
-> [!IMPORTANT]
-> Please read [CamOverlayAPI](doc/CamOverlayAPI.md) and [CamOverlayDrawingAPI](doc/CamOverlayDrawingAPI.md) for more information.
+```

package/cjs/CamOverlayAPI.js

@@ -53,7 +53,7 @@ class CamOverlayAPI {
     async getFileStorage(fileType, options) {
         const res = await this._getJson(`${BASE_PATH}/upload_${fileType}.cgi`, { action: 'get_storage' }, options);
         if (res.code !== 200) {
-            throw new Error('Error occured while fetching file storage data');
+            throw new errors_1.StorageDataFetchError(res);
         }
         return CamOverlayAPI_1.storageDataListSchema.parse(res.list);
     }
@@ -68,7 +68,11 @@ class CamOverlayAPI {
     }
     async isEnabled(serviceId, options) {
         const agent = this.getClient(options?.proxyParams);
-        const res = await agent.get({ path: `${BASE_PATH}/services.cgi?action=get`, timeout: options?.timeout });
+        const res = await agent.get({
+            path: `${BASE_PATH}/services.cgi`,
+            parameters: { action: 'get' },
+            timeout: options?.timeout,
+        });
         if (res.ok) {
             const data = JSON.parse(await res.text());
             for (const service of data.services) {
@@ -145,7 +149,7 @@ class CamOverlayAPI {
     async promiseCGUpdate(serviceId, action, params = {}, contentType, data, options) {
         const path = `${BASE_PATH}/customGraphics.cgi`;
         let headers = {};
-        if (contentType !== undefined && data) {
+        if (contentType !== undefined && data !== undefined) {
             headers = { 'Content-Type': contentType };
         }
         const agent = this.getClient(options?.proxyParams);

package/cjs/CamScripterAPI.js

@@ -25,41 +25,36 @@ class CamScripterAPI {
     }
     async getStorageInfo(options) {
         const res = await this._getJson(`${BASE_PATH}/package/get_storage.cgi`, undefined, options);
-        return CamScripterAPI_1.storageSchema.parse(res);
+        return CamScripterAPI_1.cameraStorageSchema.parse(res);
     }
     async getPackageList(options) {
         const res = await this._getJson(`${BASE_PATH}/package/list.cgi`, undefined, options);
         return CamScripterAPI_1.packageInfoListSchema.parse(res);
     }
     async installPackages(formData, storage, options) {
-        const res = await this._post(`${BASE_PATH}/package/install.cgi`, formData, { storage: storage }, options);
-        return CamScripterAPI_1.camscripterApiResponseSchema.parse(res);
+        await this._post(`${BASE_PATH}/package/install.cgi`, formData, { storage: storage }, options);
     }
     async uninstallPackage(packageId, options) {
-        const res = await this._getJson(`${BASE_PATH}/package/remove.cgi`, { package_name: packageId }, options);
-        return CamScripterAPI_1.camscripterApiResponseSchema.parse(res);
+        await this._getJson(`${BASE_PATH}/package/remove.cgi`, { package_name: packageId }, options);
     }
     async importSettings(packageId, formData, options) {
-        const res = await this._post(`${BASE_PATH}/package/data.cgi`, formData, {
+        await this._post(`${BASE_PATH}/package/data.cgi`, formData, {
             action: 'IMPORT',
             package_name: packageId,
         }, options);
-        return CamScripterAPI_1.camscripterApiResponseSchema.parse(res);
     }
     async exportSettings(packageId, formData, options) {
-        const res = await this._post(`${BASE_PATH}/package/data.cgi`, formData, {
+        await this._post(`${BASE_PATH}/package/data.cgi`, formData, {
             action: 'EXPORT',
             package_name: packageId,
         }, options);
-        return CamScripterAPI_1.camscripterApiResponseSchema.parse(res);
     }
     async getNodejsStatus(options) {
         const res = await this._getJson(`${BASE_PATH}/diagnostics.cgi`, undefined, options);
         return CamScripterAPI_1.nodeStateSchema.parse(res);
     }
     async installNodejs(storage, options) {
-        const res = await this._getJson(`${BASE_PATH}/node_update.cgi`, { storage: storage }, options);
-        return CamScripterAPI_1.camscripterApiResponseSchema.parse(res);
+        await this._getJson(`${BASE_PATH}/node_update.cgi`, { storage: storage }, options);
     }
     async _getJson(path, parameters, options) {
         const agent = this.getClient(options?.proxyParams);

package/cjs/CamStreamerAPI.js

@@ -5,6 +5,7 @@ const zod_1 = require("zod");
 const ProxyClient_1 = require("./internal/ProxyClient");
 const utils_1 = require("./internal/utils");
 const CamStreamerAPI_1 = require("./types/CamStreamerAPI");
+const errors_1 = require("./errors/errors");
 const BASE_PATH = '/local/camstreamer';
 class CamStreamerAPI {
     client;
@@ -17,14 +18,14 @@ class CamStreamerAPI {
     async wsAuthorization(options) {
         const res = await this._getJson(`${BASE_PATH}/ws_authorization.cgi`, undefined, options);
         if (res.status !== 200) {
-            throw new Error(`Server error on ws authorization: ${res.message}`);
+            throw new errors_1.WsAuthorizationError(res.message);
         }
         return zod_1.z.string().parse(res.data);
     }
     async getUtcTime(options) {
         const res = await this._getJson(`${BASE_PATH}/get_utc_time.cgi`, undefined, options);
         if (res.status !== 200) {
-            throw new Error(`Server error on get UTC time: ${res.message}`);
+            throw new errors_1.UtcTimeFetchError(res.message);
         }
         return zod_1.z.number().parse(res.data);
     }
@@ -49,7 +50,7 @@ class CamStreamerAPI {
     }
     async setStream(streamId, params, options) {
         const { streamDelay, startTime, stopTime, ...rest } = params;
-        return await this._getJson(`${BASE_PATH}/stream/set.cgi`, {
+        await this._getJson(`${BASE_PATH}/stream/set.cgi`, {
             stream_id: streamId,
             streamDelay: streamDelay ?? '',
             startTime: startTime ?? null,
@@ -58,7 +59,7 @@ class CamStreamerAPI {
         }, options);
     }
     async setStreamParameter(streamId, paramName, value, options) {
-        return await this._getJson(`${BASE_PATH}/stream/set.cgi`, { stream_id: streamId, [paramName]: value }, options);
+        await this._getJson(`${BASE_PATH}/stream/set.cgi`, { stream_id: streamId, [paramName]: value }, options);
     }
     async isStreaming(streamId, options) {
         const res = await this._getJson(`${BASE_PATH}/get_streamstat.cgi`, { stream_id: streamId }, options);

package/cjs/CamSwitcherAPI.js

@@ -26,6 +26,14 @@ class CamSwitcherAPI {
     getClient(proxyParams) {
         return proxyParams ? new ProxyClient_1.ProxyClient(this.client, proxyParams) : this.client;
     }
+    async checkCameraTime(options) {
+        const res = await this._getJson(`${BASE_PATH}/camera_time.cgi`, undefined, options);
+        return zod_1.z.boolean().parse(res.data);
+    }
+    async getNetworkCameraList(options) {
+        const res = await this._getJson(`${BASE_PATH}/network_camera_list.cgi`, undefined, options);
+        return common_1.networkCameraListSchema.parse(res.data);
+    }
     async generateSilence(sampleRate, channels, options) {
         const agent = this.getClient(options?.proxyParams);
         await agent.get({
@@ -37,14 +45,6 @@ class CamSwitcherAPI {
             timeout: options?.timeout,
         });
     }
-    async checkCameraTime(options) {
-        const res = await this._getJson(`${BASE_PATH}/camera_time.cgi`, undefined, options);
-        return zod_1.z.boolean().parse(res.data);
-    }
-    async getNetworkCameraList(options) {
-        const res = await this._getJson(`${BASE_PATH}/network_camera_list.cgi`, undefined, options);
-        return common_1.networkCameraListSchema.parse(res.data);
-    }
     async getMaxFps(source, options) {
         const res = await this._getJson(`${BASE_PATH}/get_max_framerate.cgi`, {
             video_source: source,
@@ -84,16 +84,16 @@ class CamSwitcherAPI {
         return CamSwitcherAPI_1.trackerSaveLoadSchema.parse(res.data);
     }
     async setStreamSaveList(data, options) {
-        return await this._post(`${BASE_PATH}/streams.cgi`, data, { action: 'set' }, options);
+        await this._post(`${BASE_PATH}/streams.cgi`, data, { action: 'set' }, options);
     }
     async setClipSaveList(data, options) {
-        return await this._post(`${BASE_PATH}/clips.cgi`, data, { action: 'set' }, options);
+        await this._post(`${BASE_PATH}/clips.cgi`, data, { action: 'set' }, options);
     }
     async setPlaylistSaveList(data, options) {
-        return await this._post(`${BASE_PATH}/playlists.cgi`, data, { action: 'set' }, options);
+        await this._post(`${BASE_PATH}/playlists.cgi`, data, { action: 'set' }, options);
     }
     async setTrackerSaveList(data, options) {
-        return await this._post(`${BASE_PATH}/trackers.cgi`, data, { action: 'set' }, options);
+        await this._post(`${BASE_PATH}/trackers.cgi`, data, { action: 'set' }, options);
     }
     async playlistSwitch(playlistName, options) {
         await this._getJson(`${BASE_PATH}/playlist_switch.cgi`, { playlist_name: playlistName }, options);
@@ -131,8 +131,8 @@ class CamSwitcherAPI {
             throw new errors_1.AddNewClipError(output.message);
         }
     }
-    removeClip(clipId, storage, options) {
-        return this._getJson(`${BASE_PATH}/clip_remove.cgi`, { clip_name: clipId, storage }, options);
+    async removeClip(clipId, storage, options) {
+        await this._getJson(`${BASE_PATH}/clip_remove.cgi`, { clip_name: clipId, storage }, options);
     }
     async getClipList(options) {
         const res = await this._getJson(`${BASE_PATH}/clip_list.cgi`, undefined, options);
@@ -293,10 +293,10 @@ class CamSwitcherAPI {
                 }
             }
             catch {
-                throw new Error('Error: in JSON parsing of ' + paramName + '. Cannot parse: ' + data[paramName]);
+                throw new errors_1.JsonParseError(paramName, data[paramName]);
             }
         }
-        throw new Error("Error: no parametr '" + paramName + "' was found");
+        throw new errors_1.ParameterNotFoundError(paramName);
     }
 }
 exports.CamSwitcherAPI = CamSwitcherAPI;

package/cjs/PlaneTrackerAPI.js

@@ -25,7 +25,7 @@ class PlaneTrackerAPI {
     }
     async resetPtzCalibration(options) {
         const agent = this.getClient(options?.proxyParams);
-        return await agent.get({
+        await agent.get({
             path: `${BASE_PATH}/package/resetPtzCalibration.cgi`,
             parameters: this.apiUser,
             timeout: options?.timeout,
@@ -33,7 +33,7 @@ class PlaneTrackerAPI {
     }
     async resetFocusCalibration(options) {
         const agent = this.getClient(options?.proxyParams);
-        return await agent.get({
+        await agent.get({
             path: `${BASE_PATH}/package/resetFocusCalibration.cgi`,
             parameters: this.apiUser,
             timeout: options?.timeout,
@@ -41,11 +41,11 @@ class PlaneTrackerAPI {
     }
     async serverRunCheck(options) {
         const agent = this.getClient(options?.proxyParams);
-        return await agent.get({ path: `${BASE_PATH}/package/serverRunCheck.cgi`, timeout: options?.timeout });
+        await agent.get({ path: `${BASE_PATH}/package/serverRunCheck.cgi`, timeout: options?.timeout });
     }
     async getLiveViewAlias(rtspUrl, options) {
         const agent = this.getClient(options?.proxyParams);
-        return await agent.get({
+        await agent.get({
             path: `${BASE_PATH}/getLiveViewAlias.cgi`,
             parameters: { rtsp_url: rtspUrl },
             timeout: options?.timeout,
@@ -55,8 +55,8 @@ class PlaneTrackerAPI {
         const res = await this._getJson(`${BASE_PATH}/package_camera_settings.cgi`, { action: 'get' }, options);
         return PlaneTrackerAPI_1.cameraSettingsSchema.parse(res);
     }
-    async setCameraSettings(settingsJsonString, options) {
-        return await this._postJsonEncoded(`${BASE_PATH}/package_camera_settings.cgi`, settingsJsonString, {
+    async setCameraSettings(settings, options) {
+        await this._postJsonEncoded(`${BASE_PATH}/package_camera_settings.cgi`, settings, {
             action: 'set',
         }, options);
     }
@@ -69,7 +69,7 @@ class PlaneTrackerAPI {
     }
     async importAppSettings(dataType, formData, options) {
         const agent = this.getClient(options?.proxyParams);
-        return await agent.post({
+        await agent.post({
             path: `${BASE_PATH}/package_data.cgi`,
             data: formData,
             parameters: { action: 'IMPORT', dataType },
@@ -85,11 +85,11 @@ class PlaneTrackerAPI {
         return PlaneTrackerAPI_1.trackingModeSchema.parse(res);
     }
     async setTrackingMode(mode, options) {
-        return await this._postJsonEncoded(`${BASE_PATH}/package/setTrackingMode.cgi`, { mode }, this.apiUser, options);
+        await this._postJsonEncoded(`${BASE_PATH}/package/setTrackingMode.cgi`, { mode }, this.apiUser, options);
     }
     async startTrackingPlane(icao, options) {
         const agent = this.getClient(options?.proxyParams);
-        return await agent.get({
+        await agent.get({
             path: `${BASE_PATH}/package/trackIcao.cgi`,
             parameters: { icao, ...this.apiUser },
             timeout: options?.timeout,
@@ -97,7 +97,7 @@ class PlaneTrackerAPI {
     }
     async stopTrackingPlane(options) {
         const agent = this.getClient(options?.proxyParams);
-        return await agent.get({
+        await agent.get({
             path: `${BASE_PATH}/package/resetIcao.cgi`,
             parameters: this.apiUser,
             timeout: options?.timeout,
@@ -108,21 +108,21 @@ class PlaneTrackerAPI {
         return PlaneTrackerAPI_1.priorityListSchema.parse(res);
     }
     async setPriorityList(priorityList, options) {
-        return await this._postJsonEncoded(`${BASE_PATH}/package/setPriorityList.cgi`, { priorityList }, this.apiUser, options);
+        await this._postJsonEncoded(`${BASE_PATH}/package/setPriorityList.cgi`, { priorityList }, this.apiUser, options);
     }
     async getWhiteList(options) {
         const res = await this._getJson(`${BASE_PATH}/package/getWhiteList.cgi`, undefined, options);
         return PlaneTrackerAPI_1.whiteListSchema.parse(res);
     }
     async setWhiteList(whiteList, options) {
-        return await this._postJsonEncoded(`${BASE_PATH}/package/setWhiteList.cgi`, { whiteList }, this.apiUser, options);
+        await this._postJsonEncoded(`${BASE_PATH}/package/setWhiteList.cgi`, { whiteList }, this.apiUser, options);
     }
     async getBlackList(options) {
         const res = await this._getJson(`${BASE_PATH}/package/getBlackList.cgi`, undefined, options);
         return PlaneTrackerAPI_1.blackListSchema.parse(res);
     }
     async setBlackList(blackList, options) {
-        return await this._postJsonEncoded(`${BASE_PATH}/package/setBlackList.cgi`, { blackList }, this.apiUser, options);
+        await this._postJsonEncoded(`${BASE_PATH}/package/setBlackList.cgi`, { blackList }, this.apiUser, options);
     }
     async fetchMapInfo(options) {
         const res = await this._getJson(`${BASE_PATH}/package/getMapInfo.cgi`, undefined, options);
@@ -133,18 +133,18 @@ class PlaneTrackerAPI {
         return PlaneTrackerAPI_1.zonesSchema.parse(res);
     }
     async setZones(zones, options) {
-        return await this._postJsonEncoded(`${BASE_PATH}/package/setZones.cgi`, { zones }, this.apiUser, options);
+        await this._postJsonEncoded(`${BASE_PATH}/package/setZones.cgi`, { zones }, this.apiUser, options);
     }
     async goToCoordinates(lat, lon, alt, options) {
         const agent = this.getClient(options?.proxyParams);
-        return await agent.get({
+        await agent.get({
             path: `${BASE_PATH}/package/goToCoordinates.cgi`,
             parameters: { lat, lon, alt, ...this.apiUser },
             timeout: options?.timeout,
         });
     }
     async checkGenetecConnection(params, options) {
-        return await this._postUrlEncoded(`${BASE_PATH}/package/checkGenetecConnection.cgi`, '', params, options);
+        await this._postUrlEncoded(`${BASE_PATH}/package/checkGenetecConnection.cgi`, '', params, options);
     }
     async getGenetecCameraList(params, options) {
         const res = await this._postUrlEncoded(`${BASE_PATH}/package/getGenetecCameraList.cgi`, '', params, options);

package/cjs/VapixAPI.js

@@ -195,7 +195,7 @@ class VapixAPI {
             const json = await resV2.json();
             const data = VapixAPI_1.timeZoneSchema.parse(json);
             if (data.status === 'error') {
-                throw new Error(data.error.message);
+                throw new errors_1.TimezoneFetchError(data.error.message);
             }
             return data.data.activeTimeZone;
         }
@@ -205,7 +205,7 @@ class VapixAPI {
         }
         const data = await this.getDateTimeInfo(options);
         if (data.data.timeZone === undefined) {
-            throw new Error('Time zone not setup on the device');
+            throw new errors_1.TimezoneNotSetupError();
         }
         return zod_1.z.string().parse(data.data.timeZone);
     }
@@ -255,7 +255,7 @@ class VapixAPI {
         }, undefined, options);
         const responseText = await res.text();
         if (responseText.startsWith('# Error')) {
-            throw new Error(responseText);
+            throw new errors_1.SettingParameterError(responseText);
         }
     }
     async getGuardTourList(options) {
@@ -479,7 +479,7 @@ class VapixAPI {
         }
         const text = await res.text();
         if (text.length > 5) {
-            throw new Error('installing error: ' + text);
+            throw new errors_1.ApplicationAPIError('INSTALL', text);
         }
     }
     static parseParameters = (response) => {

package/cjs/errors/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PtzNotSupportedError = exports.AddNewClipError = exports.FetchDeviceInfoError = exports.NoDeviceInfoError = exports.MaxFPSError = exports.SDCardJobError = exports.SDCardActionError = exports.ApplicationAPIError = exports.ParsingBlobError = exports.ServiceNotFoundError = exports.ServiceUnavailableError = void 0;
+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 = void 0;
 class ServiceUnavailableError extends Error {
     constructor() {
         super('Service is unavailable.');
@@ -22,6 +22,27 @@ class ParsingBlobError extends Error {
     }
 }
 exports.ParsingBlobError = ParsingBlobError;
+class JsonParseError extends Error {
+    constructor(paramName, data) {
+        super(`Error: in JSON parsing of ${paramName}. Cannot parse: ${data}`);
+        this.name = 'JsonParseError';
+    }
+}
+exports.JsonParseError = JsonParseError;
+class ParameterNotFoundError extends Error {
+    constructor(paramName) {
+        super(`Error: no parameter '${paramName}' was found`);
+        this.name = 'ParameterNotFoundError';
+    }
+}
+exports.ParameterNotFoundError = ParameterNotFoundError;
+class SettingParameterError extends Error {
+    constructor(message) {
+        super(`Error setting parameter to camera: ${message}`);
+        this.name = 'SettingParameterError';
+    }
+}
+exports.SettingParameterError = SettingParameterError;
 class ApplicationAPIError extends Error {
     constructor(action, res) {
         super(`[APP ${action}] Error: ` + res);
@@ -84,3 +105,38 @@ class PtzNotSupportedError extends Error {
     }
 }
 exports.PtzNotSupportedError = PtzNotSupportedError;
+class StorageDataFetchError extends Error {
+    constructor(err) {
+        super('Error fetching storage data: ' + err);
+        this.name = 'StorageDataFetchError';
+    }
+}
+exports.StorageDataFetchError = StorageDataFetchError;
+class WsAuthorizationError extends Error {
+    constructor(message) {
+        super('Server error on ws authorization: ' + message);
+        this.name = 'WsAuthorizationError';
+    }
+}
+exports.WsAuthorizationError = WsAuthorizationError;
+class UtcTimeFetchError extends Error {
+    constructor(message) {
+        super('Server error on get UTC time: ' + message);
+        this.name = 'UtcTimeFetchError';
+    }
+}
+exports.UtcTimeFetchError = UtcTimeFetchError;
+class TimezoneNotSetupError extends Error {
+    constructor() {
+        super('Time zone not setup on the device');
+        this.name = 'TimezoneNotSetupError';
+    }
+}
+exports.TimezoneNotSetupError = TimezoneNotSetupError;
+class TimezoneFetchError extends Error {
+    constructor(err) {
+        super('Error fetching time zone information: ' + err);
+        this.name = 'TimezoneFetchError';
+    }
+}
+exports.TimezoneFetchError = TimezoneFetchError;

package/cjs/index.js

@@ -14,29 +14,31 @@ 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 });
-exports.PlaneTrackerAPI = exports.CamStreamerAPI = exports.CamScripterAPI = exports.CamOverlayAPI = exports.VapixAPI = exports.CamSwitcherEvents = exports.CamSwitcherAPI = void 0;
+exports.VapixAPI = exports.PlaneTrackerAPI = exports.CamSwitcherEvents = exports.CamSwitcherAPI = exports.CamStreamerAPI = exports.CamScripterAPI = exports.CamOverlayAPI = void 0;
 __exportStar(require("./internal/types"), exports);
 __exportStar(require("./internal/constants"), exports);
 __exportStar(require("./internal/utils"), exports);
 __exportStar(require("./internal/versionCompare"), exports);
 __exportStar(require("./internal/ProxyClient"), exports);
 __exportStar(require("./types/common"), exports);
-var CamSwitcherAPI_1 = require("./CamSwitcherAPI");
-Object.defineProperty(exports, "CamSwitcherAPI", { enumerable: true, get: function () { return CamSwitcherAPI_1.CamSwitcherAPI; } });
-var CamSwitcherEvents_1 = require("./CamSwitcherEvents");
-Object.defineProperty(exports, "CamSwitcherEvents", { enumerable: true, get: function () { return CamSwitcherEvents_1.CamSwitcherEvents; } });
-var VapixAPI_1 = require("./VapixAPI");
-Object.defineProperty(exports, "VapixAPI", { enumerable: true, get: function () { return VapixAPI_1.VapixAPI; } });
 var CamOverlayAPI_1 = require("./CamOverlayAPI");
 Object.defineProperty(exports, "CamOverlayAPI", { enumerable: true, get: function () { return CamOverlayAPI_1.CamOverlayAPI; } });
+__exportStar(require("./types/CamOverlayAPI"), exports);
 var CamScripterAPI_1 = require("./CamScripterAPI");
 Object.defineProperty(exports, "CamScripterAPI", { enumerable: true, get: function () { return CamScripterAPI_1.CamScripterAPI; } });
+__exportStar(require("./types/CamScripterAPI"), exports);
 var CamStreamerAPI_1 = require("./CamStreamerAPI");
 Object.defineProperty(exports, "CamStreamerAPI", { enumerable: true, get: function () { return CamStreamerAPI_1.CamStreamerAPI; } });
+__exportStar(require("./types/CamStreamerAPI"), exports);
+var CamSwitcherAPI_1 = require("./CamSwitcherAPI");
+Object.defineProperty(exports, "CamSwitcherAPI", { enumerable: true, get: function () { return CamSwitcherAPI_1.CamSwitcherAPI; } });
+__exportStar(require("./types/CamSwitcherAPI"), exports);
+var CamSwitcherEvents_1 = require("./CamSwitcherEvents");
+Object.defineProperty(exports, "CamSwitcherEvents", { enumerable: true, get: function () { return CamSwitcherEvents_1.CamSwitcherEvents; } });
+__exportStar(require("./types/CamSwitcherEvents"), exports);
 var PlaneTrackerAPI_1 = require("./PlaneTrackerAPI");
 Object.defineProperty(exports, "PlaneTrackerAPI", { enumerable: true, get: function () { return PlaneTrackerAPI_1.PlaneTrackerAPI; } });
-__exportStar(require("./types/CamSwitcherEvents"), exports);
-__exportStar(require("./types/CamSwitcherAPI"), exports);
-__exportStar(require("./types/VapixAPI"), exports);
-__exportStar(require("./types/CamOverlayAPI"), exports);
 __exportStar(require("./types/PlaneTrackerAPI"), exports);
+var VapixAPI_1 = require("./VapixAPI");
+Object.defineProperty(exports, "VapixAPI", { enumerable: true, get: function () { return VapixAPI_1.VapixAPI; } });
+__exportStar(require("./types/VapixAPI"), exports);

package/cjs/node/index.js

@@ -18,8 +18,10 @@ exports.VapixEvents = exports.CamScripterAPICameraEventsGenerator = exports.CamO
 __exportStar(require("./DefaultClient"), exports);
 __exportStar(require("./WsClient"), exports);
 __exportStar(require("./HttpServer"), exports);
+__exportStar(require("./HttpRequestSender"), exports);
 __exportStar(require("./events/AxisCameraStationEvents"), exports);
 __exportStar(require("./events/GenetecAgent"), exports);
+__exportStar(require("../types/GenetecAgent"), exports);
 var ResourceManager_1 = require("./CamOverlayPainter/ResourceManager");
 Object.defineProperty(exports, "ResourceManager", { enumerable: true, get: function () { return ResourceManager_1.ResourceManager; } });
 var Painter_1 = require("./CamOverlayPainter/Painter");

package/cjs/types/CamOverlayAPI/CamOverlayAPI.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fileDataSchema = exports.fileListSchema = exports.fileSchema = exports.storageResponseSchema = exports.storageDataListSchema = exports.storageSchema = exports.ImageType = exports.isScoreOverview = exports.isBaseballScoreBoardAutomatic = exports.isBaseballScoreBoard = exports.isScoreBoard = exports.isWebCameraSharing = exports.isScreenSharing = exports.isPtz = exports.isPtzCompass = exports.isPip = exports.isInfoticker = exports.isImages = exports.isCustomGraphics = exports.isAccuweather = exports.serviceListSchema = exports.servicesSchema = exports.wsResponseSchema = void 0;
+exports.fileDataSchema = exports.fileListSchema = exports.fileSchema = exports.storageResponseSchema = exports.storageDataListSchema = exports.fileStorageTypeSchema = exports.ImageType = exports.isScoreOverview = exports.isBaseballScoreBoardAutomatic = exports.isBaseballScoreBoard = exports.isScoreBoard = exports.isWebCameraSharing = exports.isScreenSharing = exports.isPtz = exports.isPtzCompass = exports.isPip = exports.isInfoticker = exports.isImages = exports.isCustomGraphics = exports.isAccuweather = exports.serviceListSchema = exports.servicesSchema = exports.wsResponseSchema = void 0;
 const zod_1 = require("zod");
 const infotickerSchema_1 = require("./infotickerSchema");
 const accuweatherSchema_1 = require("./accuweatherSchema");
@@ -65,7 +65,7 @@ var ImageType;
     ImageType[ImageType["PNG"] = 0] = "PNG";
     ImageType[ImageType["JPEG"] = 1] = "JPEG";
 })(ImageType || (exports.ImageType = ImageType = {}));
-exports.storageSchema = zod_1.z.union([
+exports.fileStorageTypeSchema = zod_1.z.union([
     zod_1.z.literal('flash'),
     zod_1.z.literal('SD0'),
     zod_1.z.literal('ftp'),
@@ -73,7 +73,7 @@ exports.storageSchema = zod_1.z.union([
     zod_1.z.literal('url'),
 ]);
 exports.storageDataListSchema = zod_1.z.array(zod_1.z.object({
-    type: exports.storageSchema,
+    type: exports.fileStorageTypeSchema,
     state: zod_1.z.string(),
 }));
 exports.storageResponseSchema = zod_1.z.object({
@@ -83,7 +83,7 @@ exports.storageResponseSchema = zod_1.z.object({
 exports.fileSchema = zod_1.z.object({
     name: zod_1.z.string(),
     path: zod_1.z.string().url(),
-    storage: exports.storageSchema,
+    storage: exports.fileStorageTypeSchema,
 });
 exports.fileListSchema = zod_1.z.array(exports.fileSchema);
 exports.fileDataSchema = zod_1.z.object({