camstreamerlib 4.0.0-beta.40 → 4.0.0-beta.41

package/cjs/PlaneTrackerAPI.js

@@ -25,38 +25,45 @@ class PlaneTrackerAPI {
     }
     async resetPtzCalibration(options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.get({
+        const res = await agent.get({
             path: `${BASE_PATH}/package/resetPtzCalibration.cgi`,
             parameters: this.apiUser,
             timeout: options?.timeout,
         });
+        if (!res.ok) {
+            throw new errors_1.ResetCalibrationError('PTZ', await (0, utils_1.responseStringify)(res));
+        }
     }
     async resetFocusCalibration(options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.get({
+        const res = await agent.get({
             path: `${BASE_PATH}/package/resetFocusCalibration.cgi`,
             parameters: this.apiUser,
             timeout: options?.timeout,
         });
+        if (!res.ok) {
+            throw new errors_1.ResetCalibrationError('FOCUS', await (0, utils_1.responseStringify)(res));
+        }
     }
     async serverRunCheck(options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.get({ path: `${BASE_PATH}/package/serverRunCheck.cgi`, timeout: options?.timeout });
+        return await agent.get({ path: `${BASE_PATH}/package/serverRunCheck.cgi`, timeout: options?.timeout });
     }
     async getLiveViewAlias(rtspUrl, options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.get({
+        const res = await agent.get({
             path: `${BASE_PATH}/getLiveViewAlias.cgi`,
             parameters: { rtsp_url: rtspUrl },
             timeout: options?.timeout,
         });
+        return PlaneTrackerAPI_1.wsAliasResponseSchema.parse(await res.json());
     }
     async fetchCameraSettings(options) {
         const res = await this._getJson(`${BASE_PATH}/package_camera_settings.cgi`, { action: 'get' }, options);
         return PlaneTrackerAPI_1.cameraSettingsSchema.parse(res);
     }
     async setCameraSettings(settings, options) {
-        await this._postJsonEncoded(`${BASE_PATH}/package_camera_settings.cgi`, settings, {
+        return await this._postJsonEncoded(`${BASE_PATH}/package_camera_settings.cgi`, settings, {
             action: 'set',
         }, options);
     }
@@ -69,12 +76,15 @@ class PlaneTrackerAPI {
     }
     async importAppSettings(dataType, formData, options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.post({
+        const res = await agent.post({
             path: `${BASE_PATH}/package_data.cgi`,
             data: formData,
             parameters: { action: 'IMPORT', dataType },
             timeout: options?.timeout,
         });
+        if (!res.ok) {
+            throw new errors_1.ImportSettingsError(await (0, utils_1.responseStringify)(res));
+        }
     }
     async fetchFlightInfo(icao, options) {
         const res = await this._getJson(`${BASE_PATH}/package/flightInfo.cgi`, { icao }, options);
@@ -108,21 +118,21 @@ class PlaneTrackerAPI {
         return PlaneTrackerAPI_1.priorityListSchema.parse(res);
     }
     async setPriorityList(priorityList, options) {
-        await this._postJsonEncoded(`${BASE_PATH}/package/setPriorityList.cgi`, { priorityList }, this.apiUser, options);
+        return 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) {
-        await this._postJsonEncoded(`${BASE_PATH}/package/setWhiteList.cgi`, { whiteList }, this.apiUser, options);
+        return 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) {
-        await this._postJsonEncoded(`${BASE_PATH}/package/setBlackList.cgi`, { blackList }, this.apiUser, options);
+        return 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);
@@ -137,14 +147,14 @@ class PlaneTrackerAPI {
     }
     async goToCoordinates(lat, lon, alt, options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.get({
+        return await agent.get({
             path: `${BASE_PATH}/package/goToCoordinates.cgi`,
             parameters: { lat, lon, alt, ...this.apiUser },
             timeout: options?.timeout,
         });
     }
     async checkGenetecConnection(params, options) {
-        await this._postUrlEncoded(`${BASE_PATH}/package/checkGenetecConnection.cgi`, '', params, options);
+        return 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/errors/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+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 = void 0;
 class ServiceUnavailableError extends Error {
     constructor() {
         super('Service is unavailable.');
@@ -140,3 +140,17 @@ class TimezoneFetchError extends Error {
     }
 }
 exports.TimezoneFetchError = TimezoneFetchError;
+class ResetCalibrationError extends Error {
+    constructor(type, err) {
+        super('Error resetting ' + type.toLowerCase() + ' calibration: ' + err);
+        this.name = 'ResetCalibrationError';
+    }
+}
+exports.ResetCalibrationError = ResetCalibrationError;
+class ImportSettingsError extends Error {
+    constructor(err) {
+        super('Error importing settings: ' + err);
+        this.name = 'ImportSettingsError';
+    }
+}
+exports.ImportSettingsError = ImportSettingsError;

package/cjs/types/PlaneTrackerAPI.js

@@ -1,7 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.zonesSchema = exports.mapInfoSchema = exports.mapTypeSchema = exports.blackListSchema = exports.whiteListSchema = exports.priorityListSchema = exports.flightInfoSchema = exports.trackingModeSchema = exports.serverSettingsSchema = exports.cameraSettingsSchema = exports.widgetSchema = exports.connectionSchema = void 0;
+exports.zonesSchema = exports.mapInfoSchema = exports.mapTypeSchema = exports.blackListSchema = exports.whiteListSchema = exports.priorityListSchema = exports.flightInfoSchema = exports.trackingModeSchema = exports.serverSettingsSchema = exports.cameraSettingsSchema = exports.widgetSchema = exports.connectionSchema = exports.wsAliasResponseSchema = void 0;
 const zod_1 = require("zod");
+exports.wsAliasResponseSchema = zod_1.z.object({
+    alias: zod_1.z.string(),
+    ws: zod_1.z.string(),
+    ws_initial_message: zod_1.z.string(),
+});
 exports.connectionSchema = zod_1.z.object({
     protocol: zod_1.z.union([zod_1.z.literal('http'), zod_1.z.literal('https'), zod_1.z.literal('https_insecure')]),
     ip: zod_1.z.union([zod_1.z.string().ip(), zod_1.z.literal('')]),

package/esm/PlaneTrackerAPI.js

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { responseStringify } from './internal/utils';
-import { blackListSchema, cameraSettingsSchema, flightInfoSchema, mapInfoSchema, priorityListSchema, serverSettingsSchema, trackingModeSchema, whiteListSchema, zonesSchema, } from './types/PlaneTrackerAPI';
-import { ParsingBlobError } from './errors/errors';
+import { blackListSchema, cameraSettingsSchema, flightInfoSchema, mapInfoSchema, priorityListSchema, serverSettingsSchema, trackingModeSchema, whiteListSchema, wsAliasResponseSchema, zonesSchema, } from './types/PlaneTrackerAPI';
+import { ImportSettingsError, ParsingBlobError, ResetCalibrationError } from './errors/errors';
 import { ProxyClient } from './internal/ProxyClient';
 import { cameraListSchema } from './types/GenetecAgent';
 const BASE_PATH = '/local/planetracker';
@@ -22,38 +22,45 @@ export class PlaneTrackerAPI {
     }
     async resetPtzCalibration(options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.get({
+        const res = await agent.get({
             path: `${BASE_PATH}/package/resetPtzCalibration.cgi`,
             parameters: this.apiUser,
             timeout: options?.timeout,
         });
+        if (!res.ok) {
+            throw new ResetCalibrationError('PTZ', await responseStringify(res));
+        }
     }
     async resetFocusCalibration(options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.get({
+        const res = await agent.get({
             path: `${BASE_PATH}/package/resetFocusCalibration.cgi`,
             parameters: this.apiUser,
             timeout: options?.timeout,
         });
+        if (!res.ok) {
+            throw new ResetCalibrationError('FOCUS', await responseStringify(res));
+        }
     }
     async serverRunCheck(options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.get({ path: `${BASE_PATH}/package/serverRunCheck.cgi`, timeout: options?.timeout });
+        return await agent.get({ path: `${BASE_PATH}/package/serverRunCheck.cgi`, timeout: options?.timeout });
     }
     async getLiveViewAlias(rtspUrl, options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.get({
+        const res = await agent.get({
             path: `${BASE_PATH}/getLiveViewAlias.cgi`,
             parameters: { rtsp_url: rtspUrl },
             timeout: options?.timeout,
         });
+        return wsAliasResponseSchema.parse(await res.json());
     }
     async fetchCameraSettings(options) {
         const res = await this._getJson(`${BASE_PATH}/package_camera_settings.cgi`, { action: 'get' }, options);
         return cameraSettingsSchema.parse(res);
     }
     async setCameraSettings(settings, options) {
-        await this._postJsonEncoded(`${BASE_PATH}/package_camera_settings.cgi`, settings, {
+        return await this._postJsonEncoded(`${BASE_PATH}/package_camera_settings.cgi`, settings, {
             action: 'set',
         }, options);
     }
@@ -66,12 +73,15 @@ export class PlaneTrackerAPI {
     }
     async importAppSettings(dataType, formData, options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.post({
+        const res = await agent.post({
             path: `${BASE_PATH}/package_data.cgi`,
             data: formData,
             parameters: { action: 'IMPORT', dataType },
             timeout: options?.timeout,
         });
+        if (!res.ok) {
+            throw new ImportSettingsError(await responseStringify(res));
+        }
     }
     async fetchFlightInfo(icao, options) {
         const res = await this._getJson(`${BASE_PATH}/package/flightInfo.cgi`, { icao }, options);
@@ -105,21 +115,21 @@ export class PlaneTrackerAPI {
         return priorityListSchema.parse(res);
     }
     async setPriorityList(priorityList, options) {
-        await this._postJsonEncoded(`${BASE_PATH}/package/setPriorityList.cgi`, { priorityList }, this.apiUser, options);
+        return 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 whiteListSchema.parse(res);
     }
     async setWhiteList(whiteList, options) {
-        await this._postJsonEncoded(`${BASE_PATH}/package/setWhiteList.cgi`, { whiteList }, this.apiUser, options);
+        return 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 blackListSchema.parse(res);
     }
     async setBlackList(blackList, options) {
-        await this._postJsonEncoded(`${BASE_PATH}/package/setBlackList.cgi`, { blackList }, this.apiUser, options);
+        return 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);
@@ -134,14 +144,14 @@ export class PlaneTrackerAPI {
     }
     async goToCoordinates(lat, lon, alt, options) {
         const agent = this.getClient(options?.proxyParams);
-        await agent.get({
+        return await agent.get({
             path: `${BASE_PATH}/package/goToCoordinates.cgi`,
             parameters: { lat, lon, alt, ...this.apiUser },
             timeout: options?.timeout,
         });
     }
     async checkGenetecConnection(params, options) {
-        await this._postUrlEncoded(`${BASE_PATH}/package/checkGenetecConnection.cgi`, '', params, options);
+        return 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/esm/errors/errors.js

@@ -118,3 +118,15 @@ export class TimezoneFetchError extends Error {
         this.name = 'TimezoneFetchError';
     }
 }
+export class ResetCalibrationError extends Error {
+    constructor(type, err) {
+        super('Error resetting ' + type.toLowerCase() + ' calibration: ' + err);
+        this.name = 'ResetCalibrationError';
+    }
+}
+export class ImportSettingsError extends Error {
+    constructor(err) {
+        super('Error importing settings: ' + err);
+        this.name = 'ImportSettingsError';
+    }
+}

package/esm/types/PlaneTrackerAPI.js

@@ -1,4 +1,9 @@
 import { z } from 'zod';
+export const wsAliasResponseSchema = z.object({
+    alias: z.string(),
+    ws: z.string(),
+    ws_initial_message: z.string(),
+});
 export const connectionSchema = z.object({
     protocol: z.union([z.literal('http'), z.literal('https'), z.literal('https_insecure')]),
     ip: z.union([z.string().ip(), z.literal('')]),

package/package.json

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

package/types/PlaneTrackerAPI.d.ts

@@ -11,8 +11,12 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
     checkCameraTime(options?: THttpRequestOptions): Promise<boolean>;
     resetPtzCalibration(options?: THttpRequestOptions): Promise<void>;
     resetFocusCalibration(options?: THttpRequestOptions): Promise<void>;
-    serverRunCheck(options?: THttpRequestOptions): Promise<void>;
-    getLiveViewAlias(rtspUrl: string, options?: THttpRequestOptions): Promise<void>;
+    serverRunCheck(options?: THttpRequestOptions): Promise<TResponse>;
+    getLiveViewAlias(rtspUrl: string, options?: THttpRequestOptions): Promise<{
+        ws: string;
+        ws_initial_message: string;
+        alias: string;
+    }>;
     fetchCameraSettings(options?: THttpRequestOptions): Promise<{
         camera: {
             ip: string;
@@ -129,7 +133,7 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
             displayAircraftInfo?: boolean | undefined;
         } | undefined;
     }>;
-    setCameraSettings(settings: TCameraSettings, options?: THttpRequestOptions): Promise<void>;
+    setCameraSettings(settings: TCameraSettings, options?: THttpRequestOptions): Promise<any>;
     fetchServerSettings(options?: THttpRequestOptions): Promise<{
         cameraCalibration: {
             posLat: number;
@@ -176,15 +180,15 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
     getPriorityList(options?: THttpRequestOptions): Promise<{
         priorityList: string[];
     }>;
-    setPriorityList(priorityList: TPriorityList['priorityList'], options?: THttpRequestOptions): Promise<void>;
+    setPriorityList(priorityList: TPriorityList['priorityList'], options?: THttpRequestOptions): Promise<any>;
     getWhiteList(options?: THttpRequestOptions): Promise<{
         whiteList: string[];
     }>;
-    setWhiteList(whiteList: TWhiteList['whiteList'], options?: THttpRequestOptions): Promise<void>;
+    setWhiteList(whiteList: TWhiteList['whiteList'], options?: THttpRequestOptions): Promise<any>;
     getBlackList(options?: THttpRequestOptions): Promise<{
         blackList: string[];
     }>;
-    setBlackList(blackList: TBlackList['blackList'], options?: THttpRequestOptions): Promise<void>;
+    setBlackList(blackList: TBlackList['blackList'], options?: THttpRequestOptions): Promise<any>;
     fetchMapInfo(options?: THttpRequestOptions): Promise<{
         minZoom: number;
         maxZoom: number;
@@ -210,8 +214,8 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
         }[];
     }>;
     setZones(zones: TZones['zones'], options?: THttpRequestOptions): Promise<void>;
-    goToCoordinates(lat: number, lon: number, alt?: number, options?: THttpRequestOptions): Promise<void>;
-    checkGenetecConnection(params: TParameters, options?: THttpRequestOptions): Promise<void>;
+    goToCoordinates(lat: number, lon: number, alt?: number, options?: THttpRequestOptions): Promise<TResponse>;
+    checkGenetecConnection(params: TParameters, options?: THttpRequestOptions): Promise<any>;
     getGenetecCameraList(params: TParameters, options?: THttpRequestOptions): Promise<{
         value: string;
         index: number;

package/types/errors/errors.d.ts

@@ -58,4 +58,11 @@ export declare class TimezoneNotSetupError extends Error {
 export declare class TimezoneFetchError extends Error {
     constructor(err: unknown);
 }
+type TCalibrationType = 'PTZ' | 'FOCUS';
+export declare class ResetCalibrationError extends Error {
+    constructor(type: TCalibrationType, err: unknown);
+}
+export declare class ImportSettingsError extends Error {
+    constructor(err: unknown);
+}
 export {};

package/types/types/PlaneTrackerAPI.d.ts

@@ -6,6 +6,19 @@ export type TApiUser = {
     userName: string;
     userPriority: number;
 };
+export declare const wsAliasResponseSchema: z.ZodObject<{
+    alias: z.ZodString;
+    ws: z.ZodString;
+    ws_initial_message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    ws: string;
+    ws_initial_message: string;
+    alias: string;
+}, {
+    ws: string;
+    ws_initial_message: string;
+    alias: string;
+}>;
 export declare const connectionSchema: z.ZodObject<{
     protocol: z.ZodUnion<[z.ZodLiteral<"http">, z.ZodLiteral<"https">, z.ZodLiteral<"https_insecure">]>;
     ip: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;