camstreamerlib 4.0.0-beta.36 → 4.0.0-beta.38

package/cjs/types/VapixAPI.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.portSequenceStateSchema = exports.portSetSchema = exports.getPortsResponseSchema = exports.portStatusSchema = exports.audioSampleRatesResponseSchema = exports.timeZoneSchema = exports.dateTimeinfoSchema = exports.maxFpsResponseSchema = exports.audioDeviceRequestSchema = exports.audioDeviceSchema = exports.audioDeviceInputOutputSchema = exports.audioDeviceConnectionTypeSchema = exports.audioDeviceSignalingTypeSchema = exports.audioDeviceSignalingChannelTypeSchema = exports.cameraPTZItemSchema = exports.cameraPTZItemDataSchema = exports.PtzOverviewSchema = exports.sdCardWatchedStatuses = exports.guardTourSchema = exports.APP_IDS = exports.applicationSchema = void 0;
+exports.portSequenceStateSchema = exports.portSetSchema = exports.getPortsResponseSchema = exports.portStatusSchema = exports.audioSampleRatesResponseSchema = exports.timeZoneSchema = exports.dateTimeinfoSchema = exports.maxFpsResponseSchema = exports.audioDeviceRequestSchema = exports.audioDeviceSchema = exports.audioDeviceInputOutputSchema = exports.audioDeviceConnectionTypeSchema = exports.audioDeviceSignalingTypeSchema = exports.audioDeviceSignalingChannelTypeSchema = exports.cameraPTZItemSchema = exports.cameraPTZItemDataSchema = exports.ptzOverviewSchema = exports.sdCardInfoSchema = exports.sdCardWatchedStatuses = exports.guardTourSchema = exports.APP_IDS = exports.applicationListSchema = exports.applicationSchema = void 0;
 const zod_1 = require("zod");
 const transformers_1 = require("../internal/transformers");
 exports.applicationSchema = zod_1.z.object({
@@ -15,6 +15,19 @@ exports.applicationSchema = zod_1.z.object({
     VendorHomePage: zod_1.z.string().optional(),
     LicenseName: zod_1.z.string().optional(),
 });
+exports.applicationListSchema = zod_1.z.array(exports.applicationSchema.extend({
+    appId: zod_1.z
+        .union([
+        zod_1.z.literal('CamStreamer'),
+        zod_1.z.literal('CamSwitcher'),
+        zod_1.z.literal('CamOverlay'),
+        zod_1.z.literal('CamScripter'),
+        zod_1.z.literal('PlaneTracker'),
+        zod_1.z.literal('Ndihxplugin'),
+        zod_1.z.literal('SportTracker'),
+    ])
+        .nullable(),
+}));
 exports.APP_IDS = [
     'CamStreamer',
     'CamSwitcher',
@@ -45,7 +58,12 @@ const audioSampleRatesSchema = zod_1.z.object({
 });
 const audioSampleRatesOutSchema = audioSampleRatesSchema.transform(transformers_1.toCamelCaseDeep);
 exports.sdCardWatchedStatuses = ['OK', 'connected', 'disconnected'];
-exports.PtzOverviewSchema = zod_1.z.record(zod_1.z.number(), zod_1.z.array(zod_1.z.object({ id: zod_1.z.number(), name: zod_1.z.string() })));
+exports.sdCardInfoSchema = zod_1.z.object({
+    status: zod_1.z.enum(exports.sdCardWatchedStatuses),
+    totalSize: zod_1.z.number(),
+    freeSize: zod_1.z.number(),
+});
+exports.ptzOverviewSchema = zod_1.z.record(zod_1.z.number(), zod_1.z.array(zod_1.z.object({ id: zod_1.z.number(), name: zod_1.z.string() })));
 exports.cameraPTZItemDataSchema = zod_1.z.object({
     pan: zod_1.z.number().optional(),
     tilt: zod_1.z.number().optional(),

package/cjs/types/VapixEvents.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/esm/CamOverlayAPI.js

@@ -3,7 +3,7 @@ import { ParsingBlobError, ServiceNotFoundError } from './errors/errors';
 import { networkCameraListSchema } from './types/common';
 import { z } from 'zod';
 import { ProxyClient } from './internal/ProxyClient';
-import { fileListSchema, ImageType, storageDataListSchema, widgetsSchema, WSResponseSchema, } from './types/CamOverlayAPI';
+import { fileListSchema, ImageType, storageDataListSchema, serviceListSchema, servicesSchema, wsResponseSchema, } from './types/CamOverlayAPI';
 const BASE_PATH = '/local/camoverlay/api';
 export class CamOverlayAPI {
     client;
@@ -17,68 +17,51 @@ export class CamOverlayAPI {
         return proxyParams ? new ProxyClient(this.client, proxyParams) : this.client;
     }
     async checkCameraTime(options) {
-        const response = await this._get({ path: `${BASE_PATH}/camera_time.cgi` }, options);
-        return z.boolean().parse(response.state);
+        const res = await this._getJson(`${BASE_PATH}/camera_time.cgi`, undefined, options);
+        return z.boolean().parse(res.state);
     }
     async getNetworkCameraList(options) {
-        const response = await this._get({ path: `${BASE_PATH}/network_camera_list.cgi` }, options);
-        return networkCameraListSchema.parse(response.camera_list);
+        const res = await this._getJson(`${BASE_PATH}/network_camera_list.cgi`, undefined, options);
+        return networkCameraListSchema.parse(res.camera_list);
     }
     async wsAuthorization(options) {
-        const response = await this._get({ path: `${BASE_PATH}/ws_authorization.cgi` }, options);
-        return WSResponseSchema.parse(response).message;
+        const res = await this._getJson(`${BASE_PATH}/ws_authorization.cgi`, undefined, options);
+        return wsResponseSchema.parse(res).message;
     }
     async getMjpegStreamImage(mjpegUrl, options) {
-        return await this._getBlob({
-            path: `${BASE_PATH}/fetch_mjpeg_image.cgi?mjpeg_url=${encodeURIComponent(decodeURIComponent(mjpegUrl))}`,
-        }, options);
+        return await this._getBlob(`${BASE_PATH}/fetch_mjpeg_image.cgi`, { mjpeg_url: decodeURIComponent(mjpegUrl) }, options);
     }
     async listFiles(fileType, options) {
-        const files = await this._get({
-            path: `${BASE_PATH}/upload_${fileType}.cgi`,
-            parameters: {
-                action: 'list',
-            },
-        }, options);
-        return fileListSchema.parse(files.list);
+        const res = await this._getJson(`${BASE_PATH}/upload_${fileType}.cgi`, { action: 'list' }, options);
+        return fileListSchema.parse(res.list);
     }
     async uploadFile(fileType, formData, storage, options) {
-        await this._post({
-            path: `${BASE_PATH}/upload_${fileType}.cgi`,
-            data: formData,
-            parameters: {
-                action: 'upload',
-                storage: storage,
-            },
+        await this._post(`${BASE_PATH}/upload_${fileType}.cgi`, formData, {
+            action: 'upload',
+            storage: storage,
         }, options);
     }
     async removeFile(fileType, fileParams, options) {
-        const path = `${BASE_PATH}/upload_${fileType}.cgi`;
-        await this._postUrlEncoded(path, {
+        await this._postUrlEncoded(`${BASE_PATH}/upload_${fileType}.cgi`, {
             action: 'remove',
             ...fileParams,
-        }, undefined, options);
+        }, options, undefined);
     }
     async getFileStorage(fileType, options) {
-        const data = await this._get({
-            path: `${BASE_PATH}/upload_${fileType}.cgi`,
-            parameters: {
-                action: 'get_storage',
-            },
-        }, options);
-        if (data.code !== 200) {
+        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');
         }
-        return storageDataListSchema.parse(data.list);
+        return storageDataListSchema.parse(res.list);
     }
     async getFilePreviewFromCamera(path, options) {
-        return await this._getBlob({ path: CamOverlayAPI.getFilePreviewPath(path) }, options);
+        return await this._getBlob(CamOverlayAPI.getFilePreviewPath(path), undefined, options);
     }
     async updateInfoticker(serviceId, text, options) {
-        await this._get({ path: `${BASE_PATH}/infoticker.cgi?service_id=${serviceId}&text=${text}` }, options);
+        await this._getJson(`${BASE_PATH}/infoticker.cgi`, { service_id: serviceId, text: text }, options);
     }
     async setEnabled(serviceId, enabled, options) {
-        await this._post({ path: `${BASE_PATH}/enabled.cgi?id_${serviceId}=${enabled ? 1 : 0}`, data: '' }, options);
+        await this._post(`${BASE_PATH}/enabled.cgi`, '', { [`id_${serviceId}`]: enabled ? 1 : 0 }, options);
     }
     async isEnabled(serviceId, options) {
         const agent = this.getClient(options?.proxyParams);
@@ -96,44 +79,34 @@ export class CamOverlayAPI {
             throw new Error(await responseStringify(res));
         }
     }
-    async getSingleWidget(serviceId, options) {
-        const data = await this._get({
-            path: `${BASE_PATH}/services.cgi`,
-            parameters: {
-                action: 'get',
-                service_id: serviceId.toString(),
-            },
-        }, options);
-        return widgetsSchema.parse(data);
-    }
-    async getWidgets(options) {
-        const widgetList = await this._get({
-            path: `${BASE_PATH}/services.cgi`,
-            parameters: {
-                action: 'get',
-            },
+    async getSingleService(serviceId, options) {
+        const res = await this._getJson(`${BASE_PATH}/services.cgi`, {
+            action: 'get',
+            service_id: serviceId,
         }, options);
-        const widgets = widgetList.services;
-        widgets.forEach((widget) => {
-            const parsedWidget = widgetsSchema.safeParse(widget);
-            if (!parsedWidget.success) {
-                console.warn(`[SERVICE SCHEMA MISMATCH]: Service ${widget.name} (${widget.id}) does not match the current schema, or is a hidden service.`);
+        return servicesSchema.parse(res);
+    }
+    async getServices(options) {
+        const res = await this._getJson(`${BASE_PATH}/services.cgi`, { action: 'get' }, options);
+        const services = serviceListSchema.parse(res).services;
+        services.forEach((service) => {
+            const parsedService = servicesSchema.safeParse(service);
+            if (!parsedService.success) {
+                console.warn(`[SERVICE SCHEMA MISMATCH]: Service ${service.name} (${service.id}) does not match the current schema, or is a hidden service.`);
             }
         });
-        return widgets;
+        return services;
     }
-    async updateSingleWidget(widget, options) {
-        const path = `${BASE_PATH}/services.cgi`;
-        await this._postJsonEncoded(path, JSON.stringify(widget), {
+    async updateSingleService(service, options) {
+        await this._postJsonEncoded(`${BASE_PATH}/services.cgi`, JSON.stringify(service), {
             action: 'set',
-            service_id: widget.id.toString(),
-        }, undefined, options);
+            service_id: service.id,
+        }, options, undefined);
     }
-    async updateWidgets(widgets, options) {
-        const path = `${BASE_PATH}/services.cgi`;
-        await this._postJsonEncoded(path, JSON.stringify({ services: widgets }), {
+    async updateServices(services, options) {
+        await this._postJsonEncoded(`${BASE_PATH}/services.cgi`, JSON.stringify({ services: services }), {
             action: 'set',
-        }, undefined, options);
+        }, options, undefined);
     }
     updateCGText(serviceId, fields, options) {
         const params = {};
@@ -194,9 +167,9 @@ export class CamOverlayAPI {
             throw new Error(await responseStringify(res));
         }
     }
-    async _get(params, options) {
+    async _getJson(path, parameters, options) {
         const agent = this.getClient(options?.proxyParams);
-        const res = await agent.get({ ...params, timeout: options?.timeout });
+        const res = await agent.get({ path, parameters, timeout: options?.timeout });
         if (res.ok) {
             return await res.json();
         }
@@ -204,9 +177,9 @@ export class CamOverlayAPI {
             throw new Error(await responseStringify(res));
         }
     }
-    async _post(params, options) {
+    async _post(path, data, parameters, options, headers) {
         const agent = this.getClient(options?.proxyParams);
-        const res = await agent.post({ ...params, timeout: options?.timeout });
+        const res = await agent.post({ path, data, parameters, headers, timeout: options?.timeout });
         if (res.ok) {
             return await res.json();
         }
@@ -214,9 +187,9 @@ export class CamOverlayAPI {
             throw new Error(await responseStringify(res));
         }
     }
-    async _getBlob(params, options) {
+    async _getBlob(path, parameters, options) {
         const agent = this.getClient(options?.proxyParams);
-        const res = await agent.get({ ...params, timeout: options?.timeout });
+        const res = await agent.get({ path, parameters, timeout: options?.timeout });
         if (res.ok) {
             return await this.parseBlobResponse(res);
         }
@@ -232,13 +205,13 @@ export class CamOverlayAPI {
             throw new ParsingBlobError(err);
         }
     }
-    async _postUrlEncoded(path, params, headers, options) {
-        const data = paramToUrl(params);
+    async _postUrlEncoded(path, parameters, options, headers) {
+        const data = paramToUrl(parameters);
         const baseHeaders = { 'Content-Type': 'application/x-www-form-urlencoded' };
-        return this._post({ path, data, headers: { ...baseHeaders, ...headers } }, options);
+        return this._post(path, data, undefined, options, { ...baseHeaders, ...headers });
     }
-    async _postJsonEncoded(path, data, parameters, headers, options) {
+    async _postJsonEncoded(path, data, parameters, options, headers) {
         const baseHeaders = { 'Accept': 'application/json', 'Content-Type': 'application/json' };
-        return this._post({ path, data, parameters, headers: { ...baseHeaders, ...headers } }, options);
+        return this._post(path, data, parameters, options, { ...baseHeaders, ...headers });
     }
 }

package/esm/CamScripterAPI.js

@@ -8,51 +8,57 @@ export class CamScripterAPI {
     constructor(client) {
         this.client = client;
     }
-    static getProxyUrlPath = () => `${BASE_PATH}/proxy.cgi`;
+    static getProxyPath = () => `${BASE_PATH}/proxy.cgi`;
     getClient(proxyParams) {
         return proxyParams ? new ProxyClient(this.client, proxyParams) : this.client;
     }
     async checkCameraTime(options) {
-        const data = await this.get(`${BASE_PATH}/camera_time.cgi`, undefined, options);
-        return cameraTimeResponseSchema.parse(data).state;
+        const res = await this._getJson(`${BASE_PATH}/camera_time.cgi`, undefined, options);
+        return cameraTimeResponseSchema.parse(res).state;
     }
     async getNetworkCameraList(options) {
-        const data = await this.get(`${BASE_PATH}/network_camera_list.cgi`, undefined, options);
-        return networkCameraListSchema.parse(data.camera_list);
+        const res = await this._getJson(`${BASE_PATH}/network_camera_list.cgi`, undefined, options);
+        return networkCameraListSchema.parse(res.camera_list);
     }
     async getStorageInfo(options) {
-        const data = await this.get(`${BASE_PATH}/package/get_storage.cgi`, undefined, options);
-        return storageSchema.parse(data);
+        const res = await this._getJson(`${BASE_PATH}/package/get_storage.cgi`, undefined, options);
+        return storageSchema.parse(res);
     }
     async getPackageList(options) {
-        const data = await this.get(`${BASE_PATH}/package/list.cgi`, undefined, options);
-        return packageInfoListSchema.parse(data);
+        const res = await this._getJson(`${BASE_PATH}/package/list.cgi`, undefined, options);
+        return packageInfoListSchema.parse(res);
     }
     async installPackages(formData, storage, options) {
-        const data = await this.post(`${BASE_PATH}/package/install.cgi?storage=${storage}`, formData, undefined, options);
-        return camscripterApiResponseSchema.parse(data);
+        const res = await this._post(`${BASE_PATH}/package/install.cgi`, formData, { storage: storage }, options);
+        return camscripterApiResponseSchema.parse(res);
     }
     async uninstallPackage(packageId, options) {
-        const data = await this.get(`${BASE_PATH}/package/remove.cgi?package_name=${packageId}`, undefined, options);
-        return camscripterApiResponseSchema.parse(data);
+        const res = await this._getJson(`${BASE_PATH}/package/remove.cgi`, { package_name: packageId }, options);
+        return camscripterApiResponseSchema.parse(res);
     }
     async importSettings(packageId, formData, options) {
-        const data = await this.post(`${BASE_PATH}/package/data.cgi?action=IMPORT&package_name=${packageId}`, formData, undefined, options);
-        return camscripterApiResponseSchema.parse(data);
+        const res = await this._post(`${BASE_PATH}/package/data.cgi`, formData, {
+            action: 'IMPORT',
+            package_name: packageId,
+        }, options);
+        return camscripterApiResponseSchema.parse(res);
     }
     async exportSettings(packageId, formData, options) {
-        const data = await this.post(`${BASE_PATH}/package/data.cgi?action=EXPORT&package_name=${packageId}`, formData, undefined, options);
-        return camscripterApiResponseSchema.parse(data);
+        const res = await this._post(`${BASE_PATH}/package/data.cgi`, formData, {
+            action: 'EXPORT',
+            package_name: packageId,
+        }, options);
+        return camscripterApiResponseSchema.parse(res);
     }
     async getNodejsStatus(options) {
-        const data = await this.get(`${BASE_PATH}/diagnostics.cgi`, undefined, options);
-        return nodeStateSchema.parse(data);
+        const res = await this._getJson(`${BASE_PATH}/diagnostics.cgi`, undefined, options);
+        return nodeStateSchema.parse(res);
     }
     async installNodejs(storage, options) {
-        const data = await this.get(`${BASE_PATH}/node_update.cgi?storage=${storage}`, undefined, options);
-        return camscripterApiResponseSchema.parse(data);
+        const res = await this._getJson(`${BASE_PATH}/node_update.cgi`, { storage: storage }, options);
+        return camscripterApiResponseSchema.parse(res);
     }
-    async get(path, parameters, options) {
+    async _getJson(path, parameters, options) {
         const agent = this.getClient(options?.proxyParams);
         const res = await agent.get({ path, parameters, timeout: options?.timeout });
         if (res.ok) {
@@ -62,9 +68,9 @@ export class CamScripterAPI {
             throw new Error(await responseStringify(res));
         }
     }
-    async post(path, data, parameters, options) {
+    async _post(path, data, parameters, options, headers) {
         const agent = this.getClient(options?.proxyParams);
-        const res = await agent.post({ path, data, parameters, timeout: options?.timeout });
+        const res = await agent.post({ path, data, parameters, headers, timeout: options?.timeout });
         if (res.ok) {
             return await res.json();
         }

package/esm/CamStreamerAPI.js

@@ -1,4 +1,4 @@
-import z from 'zod';
+import { z } from 'zod';
 import { ProxyClient } from './internal/ProxyClient';
 import { responseStringify } from './internal/utils';
 import { cameraStreamSchema } from './types/CamStreamerAPI';
@@ -11,28 +11,42 @@ export class CamStreamerAPI {
     getClient(proxyParams) {
         return proxyParams ? new ProxyClient(this.client, proxyParams) : this.client;
     }
+    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}`);
+        }
+        return 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}`);
+        }
+        return z.number().parse(res.data);
+    }
     async getStreamList(options) {
-        const streamListRes = await this.get(`${BASE_PATH}/stream/list.cgi`, undefined, options);
-        const list = z.record(z.string(), cameraStreamSchema).parse(streamListRes.data);
-        const res = {};
+        const res = await this._getJson(`${BASE_PATH}/stream/list.cgi`, undefined, options);
+        const list = z.record(z.string(), cameraStreamSchema).parse(res.data);
+        const streamList = {};
         for (const [key, data] of Object.entries(list)) {
             const streamId = parseInt(key);
-            res[streamId] = parseCameraStreamResponse(data);
+            streamList[streamId] = parseCameraStreamResponse(data);
         }
-        return res;
+        return streamList;
     }
     async getStream(streamId, options) {
-        const stream = await this.get(`${BASE_PATH}/stream/get.cgi?stream_id=${streamId}`, undefined, options);
-        const cameraData = cameraStreamSchema.parse(stream.data);
+        const res = await this._getJson(`${BASE_PATH}/stream/get.cgi`, { stream_id: streamId }, options);
+        const cameraData = cameraStreamSchema.parse(res.data);
         return parseCameraStreamResponse(cameraData);
     }
     async getStreamParameter(streamId, paramName, options) {
-        const stream = await this.get(`${BASE_PATH}/stream/get.cgi?stream_id=${streamId}`, undefined, options);
-        return stream.data[paramName];
+        const res = await this._getJson(`${BASE_PATH}/stream/get.cgi`, { stream_id: streamId }, options);
+        return z.string().parse(res.data[paramName]);
     }
     async setStream(streamId, params, options) {
         const { streamDelay, startTime, stopTime, ...rest } = params;
-        return await this.get(`${BASE_PATH}/stream/set.cgi`, {
+        return await this._getJson(`${BASE_PATH}/stream/set.cgi`, {
             stream_id: streamId,
             streamDelay: streamDelay ?? '',
             startTime: startTime ?? null,
@@ -41,31 +55,17 @@ export class CamStreamerAPI {
         }, options);
     }
     async setStreamParameter(streamId, paramName, value, options) {
-        return await this.get(`${BASE_PATH}/stream/set.cgi?stream_id=${streamId}&${paramName}=${value}`, undefined, options);
+        return await this._getJson(`${BASE_PATH}/stream/set.cgi`, { stream_id: streamId, [paramName]: value }, options);
     }
     async isStreaming(streamId, options) {
-        const response = await this.get(`${BASE_PATH}/get_streamstat.cgi?stream_id=${streamId}`, undefined, options);
-        return response.data.is_streaming === 1;
+        const res = await this._getJson(`${BASE_PATH}/get_streamstat.cgi`, { stream_id: streamId }, options);
+        return res.data.is_streaming === 1;
     }
     async deleteStream(streamId, options) {
-        const res = await this.get(`${BASE_PATH}/stream/remove.cgi`, { stream_id: streamId }, options);
+        const res = await this._getJson(`${BASE_PATH}/stream/remove.cgi`, { stream_id: streamId }, options);
         return res.data.status === 200;
     }
-    async getWsAuthorization(options) {
-        const res = await this.get(`${BASE_PATH}/ws_authorization.cgi`, undefined, options);
-        if (res.status !== 200) {
-            throw new Error(`Server error on ws authorization: ${res.message}`);
-        }
-        return res.data;
-    }
-    async getUtcTime(options) {
-        const res = await this.get(`${BASE_PATH}/get_utc_time.cgi`, undefined, options);
-        if (res.status !== 200) {
-            throw new Error(`Server error on get UTC time: ${res.message}`);
-        }
-        return res.data;
-    }
-    async get(path, parameters, options) {
+    async _getJson(path, parameters, options) {
         const agent = this.getClient(options?.proxyParams);
         const res = await agent.get({ path, parameters, timeout: options?.timeout });
         if (res.ok) {