camstreamerlib 4.0.0-beta.3 → 4.0.0-beta.31

package/cjs/PlaneTrackerAPI.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaneTrackerAPI = void 0;
+const zod_1 = require("zod");
+const utils_1 = require("./internal/utils");
+const errors_1 = require("./errors/errors");
+const ProxyClient_1 = require("./internal/ProxyClient");
+const BASE_PATH = '/local/planetracker';
+class PlaneTrackerAPI {
+    client;
+    apiUser;
+    constructor(client, apiUser) {
+        this.client = client;
+        this.apiUser = apiUser;
+    }
+    static getProxyUrlPath = () => `${BASE_PATH}/proxy.cgi`;
+    getClient(proxyParams) {
+        return proxyParams ? new ProxyClient_1.ProxyClient(this.client, proxyParams) : this.client;
+    }
+    async checkCameraTime(options) {
+        const response = await this._getJson(`${BASE_PATH}/camera_time.cgi`, undefined, options);
+        return zod_1.z.boolean().parse(response.state);
+    }
+    resetPtzCalibration = async (options) => {
+        const agent = this.getClient(options?.proxyParams);
+        return await agent.get({
+            path: `${BASE_PATH}/package/resetPtzCalibration.cgi`,
+            parameters: this.apiUser,
+            timeout: options?.timeout,
+        });
+    };
+    resetFocusCalibration = async (options) => {
+        const agent = this.getClient(options?.proxyParams);
+        return await agent.get({
+            path: `${BASE_PATH}/package/resetFocusCalibration.cgi`,
+            parameters: this.apiUser,
+            timeout: options?.timeout,
+        });
+    };
+    serverRunCheck = async (options) => {
+        const agent = this.getClient(options?.proxyParams);
+        return await agent.get({ path: `${BASE_PATH}/package/serverRunCheck.cgi`, timeout: options?.timeout });
+    };
+    getLiveViewAlias = async (rtspUrl, options) => {
+        const agent = this.getClient(options?.proxyParams);
+        return await agent.get({
+            path: `${BASE_PATH}/getLiveViewAlias.cgi`,
+            parameters: { rtsp_url: rtspUrl },
+            timeout: options?.timeout,
+        });
+    };
+    fetchCameraSettings = async (options) => {
+        return await this._getJson(`${BASE_PATH}/package_camera_settings.cgi`, { action: 'get' }, options);
+    };
+    setCameraSettings = async (settingsJsonString, options) => {
+        return await this._postJsonEncoded(`${BASE_PATH}/package_camera_settings.cgi`, settingsJsonString, {
+            action: 'set',
+        }, options);
+    };
+    fetchServerSettings = async (options) => {
+        return await this._getJson(`${BASE_PATH}/package_server_settings.cgi`, { action: 'get' }, options);
+    };
+    exportAppSettings = async (dataType, options) => {
+        return await this._getBlob(`${BASE_PATH}/package_data.cgi`, { action: 'EXPORT', dataType }, options);
+    };
+    importAppSettings = async (dataType, formData, options) => {
+        const agent = this.getClient(options?.proxyParams);
+        return await agent.post({
+            path: `${BASE_PATH}/package_data.cgi`,
+            data: formData,
+            parameters: { action: 'IMPORT', dataType },
+            timeout: options?.timeout,
+        });
+    };
+    fetchFlightInfo = async (icao, options) => {
+        return await this._getJson(`${BASE_PATH}/package/flightInfo.cgi`, { icao: encodeURIComponent(icao) }, options);
+    };
+    getTrackingMode = async (options) => {
+        return await this._getJson(`${BASE_PATH}/package/getTrackingMode.cgi`, undefined, options);
+    };
+    setTrackingMode = async (modeJsonString, options) => {
+        return await this._postJsonEncoded(`${BASE_PATH}/package/setTrackingMode.cgi`, modeJsonString, this.apiUser, options);
+    };
+    startTrackingPlane = async (icao, options) => {
+        const agent = this.getClient(options?.proxyParams);
+        return await agent.get({
+            path: `${BASE_PATH}/package/trackIcao.cgi`,
+            parameters: { icao, ...this.apiUser },
+            timeout: options?.timeout,
+        });
+    };
+    stopTrackingPlane = async (options) => {
+        const agent = this.getClient(options?.proxyParams);
+        return await agent.get({
+            path: `${BASE_PATH}/package/resetIcao.cgi`,
+            parameters: this.apiUser,
+            timeout: options?.timeout,
+        });
+    };
+    getPriorityList = async (options) => {
+        return await this._getJson(`${BASE_PATH}/package/getPriorityList.cgi`, undefined, options);
+    };
+    setPriorityList = async (priorityListJsonString, options) => {
+        return await this._postJsonEncoded(`${BASE_PATH}/package/setPriorityList.cgi`, priorityListJsonString, this.apiUser, options);
+    };
+    getWhiteList = async (options) => {
+        return await this._getJson(`${BASE_PATH}/package/getWhiteList.cgi`, undefined, options);
+    };
+    setWhiteList = async (whiteListJsonString, options) => {
+        return await this._postJsonEncoded(`${BASE_PATH}/package/setWhiteList.cgi`, whiteListJsonString, this.apiUser, options);
+    };
+    getBlackList = async (options) => {
+        return await this._getJson(`${BASE_PATH}/package/getBlackList.cgi`, undefined, options);
+    };
+    setBlackList = async (blackListJsonString, options) => {
+        return await this._postJsonEncoded(`${BASE_PATH}/package/setBlackList.cgi`, blackListJsonString, this.apiUser, options);
+    };
+    fetchMapInfo = async (options) => {
+        return await this._getJson(`${BASE_PATH}/package/getMapInfo.cgi`, undefined, options);
+    };
+    getZones = async (options) => {
+        return await this._getJson(`${BASE_PATH}/package/getZones.cgi`, undefined, options);
+    };
+    setZones = async (zonesJsonString, options) => {
+        return await this._postJsonEncoded(`${BASE_PATH}/package/setZones.cgi`, zonesJsonString, this.apiUser, options);
+    };
+    goToCoordinates = async (lat, lon, alt, options) => {
+        const agent = this.getClient(options?.proxyParams);
+        return await agent.get({
+            path: `${BASE_PATH}/package/goToCoordinates.cgi`,
+            parameters: { lat, lon, alt, ...this.apiUser },
+            timeout: options?.timeout,
+        });
+    };
+    checkGenetecConnection = async (params, options) => {
+        return await this._postUrlEncoded(`${BASE_PATH}/package/checkGenetecConnection.cgi`, params, options);
+    };
+    getGenetecCameraList = async (params, options) => {
+        const res = await this._postUrlEncoded(`${BASE_PATH}/package/getGenetecCameraList.cgi`, params, options);
+        return await res.json();
+    };
+    async _getJson(path, parameters, options) {
+        const agent = this.getClient(options?.proxyParams);
+        const res = await agent.get({
+            path,
+            parameters,
+            timeout: options?.timeout,
+        });
+        if (res.ok) {
+            return await res.json();
+        }
+        else {
+            throw new Error(await (0, utils_1.responseStringify)(res));
+        }
+    }
+    async _getBlob(path, parameters, options) {
+        const agent = this.getClient(options?.proxyParams);
+        const res = await agent.get({
+            path,
+            parameters,
+            timeout: options?.timeout,
+        });
+        if (res.ok) {
+            return await this.parseBlobResponse(res);
+        }
+        else {
+            throw new Error(await (0, utils_1.responseStringify)(res));
+        }
+    }
+    async parseBlobResponse(response) {
+        try {
+            return (await response.blob());
+        }
+        catch (err) {
+            throw new errors_1.ParsingBlobError(err);
+        }
+    }
+    async _postJsonEncoded(path, data, parameters, options) {
+        const agent = this.getClient(options?.proxyParams);
+        const res = await agent.post({
+            path,
+            data,
+            parameters,
+            headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' },
+            timeout: options?.timeout,
+        });
+        if (res.ok) {
+            return res;
+        }
+        else {
+            throw new Error(await (0, utils_1.responseStringify)(res));
+        }
+    }
+    async _postUrlEncoded(path, params, options) {
+        const data = (0, utils_1.paramToUrl)(params);
+        const agent = this.getClient(options?.proxyParams);
+        const res = await agent.post({
+            path,
+            data,
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            timeout: options?.timeout,
+        });
+        if (res.ok) {
+            return res;
+        }
+        else {
+            throw new Error(await (0, utils_1.responseStringify)(res));
+        }
+    }
+}
+exports.PlaneTrackerAPI = PlaneTrackerAPI;

package/cjs/VapixAPI.d.ts

@@ -1,41 +1,42 @@
-import { IClient, TParameters, TResponse } from './internal/common';
-import { TApplication, TAudioSampleRates, TSDCardInfo, TPtzOverview, TCameraPTZItem, TCameraPTZItemData, TAudioDevice } from './types/VapixAPI';
+import { IClient, TParameters, TResponse } from './internal/types';
+import { TAudioSampleRates, TSDCardInfo, TPtzOverview, TCameraPTZItem, TCameraPTZItemData, TAudioDevice, TPortSetSchema, TPortSequenceStateSchema } from './types/VapixAPI';
 import { ProxyClient } from './internal/ProxyClient';
-import { TCameraImageConfig, TProxyParam } from './types/common';
-export declare class VapixAPI<Client extends IClient = IClient> {
-    client: ProxyClient<Client>;
-    constructor(client: Client, getProxyUrl: () => string);
-    getUrlEncoded(proxy: TProxyParam | undefined, path: string, parameters?: TParameters, headers?: Record<string, string>): Promise<TResponse>;
-    postJson(proxy: TProxyParam | undefined, path: string, jsonData: Record<string, any>, headers?: Record<string, string>): Promise<TResponse>;
-    getCameraImage(params: TCameraImageConfig, proxy?: TProxyParam): Promise<TResponse>;
-    getEventDeclarations(proxy?: TProxyParam): Promise<string>;
-    getSupportedAudioSampleRate(proxy?: TProxyParam): Promise<TAudioSampleRates[]>;
-    performAutofocus(proxy?: TProxyParam): Promise<void>;
-    checkSDCard(proxy?: TProxyParam): Promise<TSDCardInfo>;
-    mountSDCard(proxy?: TProxyParam): Promise<number>;
-    unmountSDCard(proxy?: TProxyParam): Promise<number>;
+import { TCameraImageConfig, THttpRequestOptions, TProxyParams } from './types/common';
+export declare class VapixAPI<Client extends IClient<TResponse> = IClient<TResponse>> {
+    private client;
+    constructor(client: Client);
+    getClient(proxyParams?: TProxyParams): Client | ProxyClient<Client>;
+    postUrlEncoded(path: string, parameters?: TParameters, headers?: Record<string, string>, options?: THttpRequestOptions): Promise<TResponse>;
+    postJson(path: string, jsonData: Record<string, any>, headers?: Record<string, string>, options?: THttpRequestOptions): Promise<TResponse>;
+    getCameraImage(parameters: TCameraImageConfig, options?: THttpRequestOptions): Promise<TResponse>;
+    getEventDeclarations(options?: THttpRequestOptions): Promise<string>;
+    getSupportedAudioSampleRate(options?: THttpRequestOptions): Promise<TAudioSampleRates[]>;
+    performAutofocus(options?: THttpRequestOptions): Promise<void>;
+    checkSDCard(options?: THttpRequestOptions): Promise<TSDCardInfo>;
+    mountSDCard(options?: THttpRequestOptions): Promise<number>;
+    unmountSDCard(options?: THttpRequestOptions): Promise<number>;
     private _doSDCardMountAction;
-    fetchSDCardJobProgress(jobId: number, proxy?: TProxyParam): Promise<number>;
-    downloadCameraReport(proxy?: TProxyParam): Promise<TResponse>;
-    getSystemLog(proxy?: TProxyParam): Promise<TResponse>;
-    getMaxFps(channel: number, proxy?: TProxyParam): Promise<number>;
-    getTimezone(proxy?: TProxyParam): Promise<string>;
-    getDateTimeInfo(proxy?: TProxyParam): Promise<{
+    fetchSDCardJobProgress(jobId: number, options?: THttpRequestOptions): Promise<number>;
+    downloadCameraReport(options?: THttpRequestOptions): Promise<TResponse>;
+    getSystemLog(options?: THttpRequestOptions): Promise<TResponse>;
+    getMaxFps(channel: number, options?: THttpRequestOptions): Promise<number>;
+    getTimezone(options?: THttpRequestOptions): Promise<string>;
+    getDateTimeInfo(options?: THttpRequestOptions): Promise<{
         data: {
             dateTime: string;
             dstEnabled: boolean;
             localDateTime: string;
             posixTimeZone: string;
-            timeZone: string;
+            timeZone?: string | undefined;
         };
     }>;
-    getDevicesSettings(proxy?: TProxyParam): Promise<TAudioDevice[]>;
-    fetchRemoteDeviceInfo<T extends Record<string, any>>(payload: T, proxy?: TProxyParam): Promise<any>;
-    getHeaders(proxy?: TProxyParam): Promise<Record<string, string>>;
-    setHeaders(headers: Record<string, string>, proxy?: TProxyParam): Promise<TResponse>;
-    getParameter(paramNames: string | string[], proxy?: TProxyParam): Promise<Record<string, string>>;
-    setParameter(params: Record<string, string | number | boolean>, proxy?: TProxyParam): Promise<boolean>;
-    getGuardTourList(proxy?: TProxyParam): Promise<{
+    getDevicesSettings(options?: THttpRequestOptions): Promise<TAudioDevice[]>;
+    fetchRemoteDeviceInfo<T extends Record<string, any>>(payload: T, options?: THttpRequestOptions): Promise<any>;
+    getHeaders(options?: THttpRequestOptions): Promise<Record<string, string>>;
+    setHeaders(headers: Record<string, string>, options?: THttpRequestOptions): Promise<TResponse>;
+    getParameter(paramNames: string | string[], options?: THttpRequestOptions): Promise<Record<string, string>>;
+    setParameter(params: Record<string, string | number | boolean>, options?: THttpRequestOptions): Promise<boolean>;
+    getGuardTourList(options?: THttpRequestOptions): Promise<{
         name: string;
         id: string;
         running: string;
@@ -50,17 +51,30 @@ export declare class VapixAPI<Client extends IClient = IClient> {
         randomEnabled?: unknown;
         timeBetweenSequences?: unknown;
     }[]>;
-    setGuardTourEnabled(guardTourID: string, enable: boolean, proxy?: TProxyParam): Promise<boolean>;
-    getPTZPresetList(channel: number, proxy?: TProxyParam): Promise<string[]>;
-    listPTZ(camera: number, proxy?: TProxyParam): Promise<TCameraPTZItem[]>;
-    listPtzVideoSourceOverview(proxy?: TProxyParam): Promise<TPtzOverview>;
-    goToPreset(channel: number, presetName: string, proxy?: TProxyParam): Promise<TResponse>;
-    getPtzPosition(camera: number, proxy?: TProxyParam): Promise<TCameraPTZItemData>;
-    getInputState(port: number, proxy?: TProxyParam): Promise<boolean>;
-    setOutputState(port: number, active: boolean, proxy?: TProxyParam): Promise<TResponse>;
-    getApplicationList(proxy?: TProxyParam): Promise<TApplication[]>;
-    startApplication(applicationID: string, proxy?: TProxyParam): Promise<void>;
-    restartApplication(applicationID: string, proxy?: TProxyParam): Promise<void>;
-    stopApplication(applicationID: string, proxy?: TProxyParam): Promise<void>;
-    installApplication(data: Blob, fileName: string): Promise<void>;
+    setGuardTourEnabled(guardTourID: string, enable: boolean, options?: THttpRequestOptions): Promise<boolean>;
+    getPTZPresetList(channel: number, options?: THttpRequestOptions): Promise<string[]>;
+    listPTZ(camera: number, options?: THttpRequestOptions): Promise<TCameraPTZItem[]>;
+    listPtzVideoSourceOverview(options?: THttpRequestOptions): Promise<TPtzOverview>;
+    goToPreset(channel: number, presetName: string, options?: THttpRequestOptions): Promise<TResponse>;
+    getPtzPosition(camera: number, options?: THttpRequestOptions): Promise<TCameraPTZItemData>;
+    getPorts(options?: THttpRequestOptions): Promise<{
+        name: string;
+        port: string;
+        state: "open" | "closed";
+        configurable: boolean;
+        usage: string;
+        direction: "input" | "output";
+        normalState: "open" | "closed";
+        readonly?: boolean | undefined;
+    }[]>;
+    setPorts(ports: TPortSetSchema[], options?: THttpRequestOptions): Promise<void>;
+    setPortStateSequence(port: number, sequence: TPortSequenceStateSchema[], options?: THttpRequestOptions): Promise<void>;
+    getApplicationList(options?: THttpRequestOptions): Promise<any>;
+    startApplication(applicationID: string, options?: THttpRequestOptions): Promise<void>;
+    restartApplication(applicationID: string, options?: THttpRequestOptions): Promise<void>;
+    stopApplication(applicationID: string, options?: THttpRequestOptions): Promise<void>;
+    installApplication(data: Blob, fileName: string, options?: THttpRequestOptions): Promise<void>;
+    private static parseParameters;
+    private static parseCameraPtzResponse;
+    private static parsePtz;
 }