camstreamerlib 1.7.6 → 1.8.1

package/CamOverlayAPI.d.ts

@@ -3,12 +3,14 @@
 import * as EventEmitter from 'events';
 export declare type CamOverlayOptions = {
     protocol?: string;
+    tls?: boolean;
+    tlsInsecure?: boolean;
     ip?: string;
     port?: number;
     auth?: string;
     serviceName?: string;
     serviceID?: number;
-    camera?: number;
+    camera?: number | number[];
 };
 export declare type Field = {
     field_name: string;
@@ -42,19 +44,20 @@ export declare type Service = {
     schedule: string;
     name: string;
     identifier: string;
-    camera: number;
+    cameraList: number[];
 };
 export declare type ServiceList = {
     services: Service[];
 };
 export declare class CamOverlayAPI extends EventEmitter {
-    private protocol;
+    private tls;
+    private tlsInsecure;
     private ip;
     private port;
     private auth;
     private serviceName;
     private serviceID;
-    private camera;
+    private cameraList;
     private callId;
     private sendMessages;
     private ws;
@@ -82,4 +85,6 @@ export declare class CamOverlayAPI extends EventEmitter {
     updateInfoticker(text: string): Promise<void>;
     setEnabled(enabled: boolean): Promise<void>;
     isEnabled(): Promise<boolean>;
+    private getBaseVapixConnectionParams;
+    private compareCameraList;
 }

package/CamOverlayAPI.js

@@ -19,13 +19,23 @@ class CamOverlayAPI extends EventEmitter {
         var _a, _b, _c, _d, _e, _f, _g;
         super();
         this.ws = null;
-        this.protocol = (_a = options === null || options === void 0 ? void 0 : options.protocol) !== null && _a !== void 0 ? _a : 'ws';
-        this.ip = (_b = options === null || options === void 0 ? void 0 : options.ip) !== null && _b !== void 0 ? _b : '127.0.0.1';
-        this.port = ((_c = options === null || options === void 0 ? void 0 : options.port) !== null && _c !== void 0 ? _c : this.protocol == 'ws') ? 80 : 443;
-        this.auth = (_d = options === null || options === void 0 ? void 0 : options.auth) !== null && _d !== void 0 ? _d : '';
-        this.serviceName = (_e = options === null || options === void 0 ? void 0 : options.serviceName) !== null && _e !== void 0 ? _e : '';
-        this.serviceID = (_f = options === null || options === void 0 ? void 0 : options.serviceID) !== null && _f !== void 0 ? _f : -1;
-        this.camera = (_g = options === null || options === void 0 ? void 0 : options.camera) !== null && _g !== void 0 ? _g : 0;
+        this.tls = (_a = options === null || options === void 0 ? void 0 : options.tls) !== null && _a !== void 0 ? _a : false;
+        if ((options === null || options === void 0 ? void 0 : options.tls) === undefined && (options === null || options === void 0 ? void 0 : options.protocol) !== undefined) {
+            this.tls = options.protocol === 'wss';
+        }
+        this.tlsInsecure = (_b = options === null || options === void 0 ? void 0 : options.tlsInsecure) !== null && _b !== void 0 ? _b : false;
+        this.ip = (_c = options === null || options === void 0 ? void 0 : options.ip) !== null && _c !== void 0 ? _c : '127.0.0.1';
+        this.port = (_d = options === null || options === void 0 ? void 0 : options.port) !== null && _d !== void 0 ? _d : (this.tls ? 443 : 80);
+        this.auth = (_e = options === null || options === void 0 ? void 0 : options.auth) !== null && _e !== void 0 ? _e : '';
+        this.serviceName = (_f = options === null || options === void 0 ? void 0 : options.serviceName) !== null && _f !== void 0 ? _f : '';
+        this.serviceID = (_g = options === null || options === void 0 ? void 0 : options.serviceID) !== null && _g !== void 0 ? _g : -1;
+        this.cameraList = [0];
+        if (Array.isArray(options === null || options === void 0 ? void 0 : options.camera)) {
+            this.cameraList = options.camera;
+        }
+        else if (typeof (options === null || options === void 0 ? void 0 : options.camera) === 'number') {
+            this.cameraList = [options.camera];
+        }
         this.callId = 0;
         this.sendMessages = {};
         EventEmitter.call(this);
@@ -33,7 +43,7 @@ class CamOverlayAPI extends EventEmitter {
     connect() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                if (this.serviceID == -1) {
+                if (this.serviceID === -1) {
                     this.serviceID = yield this.createService();
                 }
                 yield this.openWebsocket();
@@ -47,12 +57,9 @@ class CamOverlayAPI extends EventEmitter {
     createService() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const options = {
-                host: this.ip,
-                port: this.port,
-                path: '/local/camoverlay/api/services.cgi?action=get',
-                auth: this.auth,
-            };
+            const options = this.getBaseVapixConnectionParams();
+            options.method = 'GET';
+            options.path = '/local/camoverlay/api/services.cgi?action=get';
             const response = (yield (0, HTTPRequest_1.httpRequest)(options));
             let servicesJson;
             try {
@@ -69,14 +76,14 @@ class CamOverlayAPI extends EventEmitter {
                 if (s.id > maxID) {
                     maxID = s.id;
                 }
-                if (s.identifier == this.serviceName && s.name == 'scripter') {
+                if (s.identifier === this.serviceName && s.name === 'scripter') {
                     service = s;
                     break;
                 }
             }
-            if (service != null) {
-                if (service.camera == undefined || service.camera != this.camera) {
-                    service.camera = this.camera;
+            if (service !== null) {
+                if (service.cameraList === undefined || !this.compareCameraList(service.cameraList)) {
+                    service.cameraList = this.cameraList;
                     yield this.updateServices(servicesJson);
                     return service.id;
                 }
@@ -92,7 +99,7 @@ class CamOverlayAPI extends EventEmitter {
                     schedule: '',
                     name: 'scripter',
                     identifier: this.serviceName,
-                    camera: this.camera,
+                    cameraList: this.cameraList,
                 };
                 servicesJson.services.push(service);
                 yield this.updateServices(servicesJson);
@@ -102,25 +109,23 @@ class CamOverlayAPI extends EventEmitter {
     }
     updateServices(servicesJson) {
         return __awaiter(this, void 0, void 0, function* () {
-            const options = {
-                method: 'POST',
-                host: this.ip,
-                port: this.port,
-                path: '/local/camoverlay/api/services.cgi?action=set',
-                auth: this.auth,
-            };
+            const options = this.getBaseVapixConnectionParams();
+            options.method = 'POST';
+            options.path = '/local/camoverlay/api/services.cgi?action=set';
             yield (0, HTTPRequest_1.httpRequest)(options, JSON.stringify(servicesJson));
         });
     }
     openWebsocket(digestHeader) {
         let promise = new Promise((resolve, reject) => {
-            let userPass = this.auth.split(':');
-            let addr = `${this.protocol}://${this.ip}:${this.port}/local/camoverlay/ws`;
-            let options = {
+            const userPass = this.auth.split(':');
+            const protocol = this.tls ? 'wss' : 'ws';
+            const addr = `${protocol}://${this.ip}:${this.port}/local/camoverlay/ws`;
+            const options = {
                 auth: this.auth,
+                rejectUnauthorized: !this.tlsInsecure,
                 headers: {},
             };
-            if (digestHeader != undefined) {
+            if (digestHeader !== undefined) {
                 options.headers['Authorization'] = Digest_1.Digest.getAuthHeader(userPass[0], userPass[1], 'GET', '/local/camoverlay/ws', digestHeader);
             }
             this.ws = new WebSocket(addr, 'cairo-api', options);
@@ -143,7 +148,7 @@ class CamOverlayAPI extends EventEmitter {
                 }
             });
             this.ws.on('unexpected-response', (req, res) => __awaiter(this, void 0, void 0, function* () {
-                if (res.statusCode == 401 && res.headers['www-authenticate'] != undefined)
+                if (res.statusCode === 401 && res.headers['www-authenticate'] !== undefined)
                     this.openWebsocket(res.headers['www-authenticate']).then(resolve, reject);
                 else {
                     reject('Error: status code: ' + res.statusCode + ', ' + res.data);
@@ -221,14 +226,14 @@ class CamOverlayAPI extends EventEmitter {
         for (let field of fields) {
             const name = field.field_name;
             field_specs += `&${name}=${field.text}`;
-            if (field.color != undefined) {
+            if (field.color !== undefined) {
                 field_specs += `&${name}_color=${field.color}`;
             }
         }
         return this.promiseCGUpdate('update_text', field_specs);
     }
     formCoordinates(coordinates, x, y) {
-        return coordinates != '' ? `&coord_system=${coordinates}&pos_x=${x}&pos_y=${y}` : '';
+        return coordinates !== '' ? `&coord_system=${coordinates}&pos_x=${x}&pos_y=${y}` : '';
     }
     updateCGImage(path, coordinates = '', x = 0, y = 0) {
         const coord = this.formCoordinates(coordinates, x, y);
@@ -241,62 +246,55 @@ class CamOverlayAPI extends EventEmitter {
     }
     promiseCGUpdate(action, params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const path = encodeURI(`/local/camoverlay/api/customGraphics.cgi?action=${action}&service_id=${this.serviceID}${params}`);
-            const options = {
-                method: 'POST',
-                host: this.ip,
-                port: this.port,
-                path: path,
-                auth: this.auth,
-            };
+            const options = this.getBaseVapixConnectionParams();
+            options.method = 'POST';
+            options.path = encodeURI(`/local/camoverlay/api/customGraphics.cgi?action=${action}&service_id=${this.serviceID}${params}`);
             yield (0, HTTPRequest_1.httpRequest)(options, '');
         });
     }
     updateInfoticker(text) {
         return __awaiter(this, void 0, void 0, function* () {
-            const path = `/local/camoverlay/api/infoticker.cgi?service_id=${this.serviceID}&text=${text}`;
-            const options = {
-                method: 'GET',
-                host: this.ip,
-                port: this.port,
-                path: path,
-                auth: this.auth,
-            };
+            const options = this.getBaseVapixConnectionParams();
+            options.method = 'GET';
+            options.path = `/local/camoverlay/api/infoticker.cgi?service_id=${this.serviceID}&text=${text}`;
             yield (0, HTTPRequest_1.httpRequest)(options, '');
         });
     }
     setEnabled(enabled) {
         return __awaiter(this, void 0, void 0, function* () {
-            const value = enabled ? 1 : 0;
-            const path = encodeURI(`/local/camoverlay/api/enabled.cgi?id_${this.serviceID}=${value}`);
-            const options = {
-                method: 'POST',
-                host: this.ip,
-                port: this.port,
-                path: path,
-                auth: this.auth,
-            };
+            const options = this.getBaseVapixConnectionParams();
+            options.method = 'POST';
+            options.path = encodeURI(`/local/camoverlay/api/enabled.cgi?id_${this.serviceID}=${enabled ? 1 : 0}`);
             yield (0, HTTPRequest_1.httpRequest)(options, '');
         });
     }
     isEnabled() {
         return __awaiter(this, void 0, void 0, function* () {
-            const options = {
-                method: 'GET',
-                host: this.ip,
-                port: this.port,
-                path: '/local/camoverlay/api/services.cgi?action=get',
-                auth: this.auth,
-            };
+            const options = this.getBaseVapixConnectionParams();
+            options.method = 'GET';
+            options.path = '/local/camoverlay/api/services.cgi?action=get';
             const response = (yield (0, HTTPRequest_1.httpRequest)(options, ''));
             const data = JSON.parse(response);
             for (let service of data.services) {
-                if (service.id == this.serviceID) {
-                    return service.enabled == 1;
+                if (service.id === this.serviceID) {
+                    return service.enabled === 1;
                 }
             }
             throw new Error('Service not found.');
         });
     }
+    getBaseVapixConnectionParams() {
+        return {
+            protocol: this.tls ? 'https:' : 'http:',
+            host: this.ip,
+            port: this.port,
+            auth: this.auth,
+            rejectUnauthorized: !this.tlsInsecure,
+        };
+    }
+    compareCameraList(cameraList) {
+        return (this.cameraList.length === cameraList.length &&
+            this.cameraList.every((element, index) => element === cameraList[index]));
+    }
 }
 exports.CamOverlayAPI = CamOverlayAPI;

package/CamStreamerAPI.d.ts

@@ -1,11 +1,14 @@
 export declare type CamStreamerAPIOptions = {
     protocol?: string;
+    tls?: boolean;
+    tlsInsecure?: boolean;
     ip?: string;
     port?: number;
     auth?: string;
 };
 export declare class CamStreamerAPI {
-    private protocol;
+    private tls;
+    private tlsInsecure;
     private ip;
     private port;
     private auth;

package/CamStreamerAPI.js

@@ -13,11 +13,15 @@ exports.CamStreamerAPI = void 0;
 const HTTPRequest_1 = require("./HTTPRequest");
 class CamStreamerAPI {
     constructor(options) {
-        var _a, _b, _c, _d;
-        this.protocol = (_a = options === null || options === void 0 ? void 0 : options.protocol) !== null && _a !== void 0 ? _a : 'http';
-        this.ip = (_b = options === null || options === void 0 ? void 0 : options.ip) !== null && _b !== void 0 ? _b : '127.0.0.1';
-        this.port = ((_c = options === null || options === void 0 ? void 0 : options.port) !== null && _c !== void 0 ? _c : this.protocol == 'http') ? 80 : 443;
-        this.auth = (_d = options === null || options === void 0 ? void 0 : options.auth) !== null && _d !== void 0 ? _d : '';
+        var _a, _b, _c, _d, _e;
+        this.tls = (_a = options === null || options === void 0 ? void 0 : options.tls) !== null && _a !== void 0 ? _a : false;
+        if ((options === null || options === void 0 ? void 0 : options.tls) === undefined && (options === null || options === void 0 ? void 0 : options.protocol) !== undefined) {
+            this.tls = options.protocol === 'https';
+        }
+        this.tlsInsecure = (_b = options === null || options === void 0 ? void 0 : options.tlsInsecure) !== null && _b !== void 0 ? _b : false;
+        this.ip = (_c = options === null || options === void 0 ? void 0 : options.ip) !== null && _c !== void 0 ? _c : '127.0.0.1';
+        this.port = (_d = options === null || options === void 0 ? void 0 : options.port) !== null && _d !== void 0 ? _d : (this.tls ? 443 : 80);
+        this.auth = (_e = options === null || options === void 0 ? void 0 : options.auth) !== null && _e !== void 0 ? _e : '';
     }
     getStreamList() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -52,10 +56,11 @@ class CamStreamerAPI {
     }
     getBaseConnectionParams() {
         return {
-            protocol: this.protocol + ':',
+            protocol: this.tls ? 'https:' : 'http:',
             host: this.ip,
             port: this.port,
             auth: this.auth,
+            rejectUnauthorized: !this.tlsInsecure,
         };
     }
 }

package/CamSwitcherAPI.d.ts

@@ -1,11 +1,15 @@
 /// <reference types="node" />
 import * as EventEmitter from 'events';
 export declare type CamSwitcherAPIOptions = {
+    tls?: boolean;
+    tlsInsecure?: boolean;
     ip?: string;
     port?: number;
     auth?: string;
 };
 export declare class CamSwitcherAPI extends EventEmitter {
+    private tls;
+    private tlsInsecure;
     private ip;
     private port;
     private auth;

package/CamSwitcherAPI.js

@@ -15,18 +15,23 @@ const EventEmitter = require("events");
 const HTTPRequest_1 = require("./HTTPRequest");
 class CamSwitcherAPI extends EventEmitter {
     constructor(options) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e;
         super();
-        this.ip = (_a = options === null || options === void 0 ? void 0 : options.ip) !== null && _a !== void 0 ? _a : '127.0.0.1';
-        this.port = (_b = options === null || options === void 0 ? void 0 : options.port) !== null && _b !== void 0 ? _b : 80;
-        this.auth = (_c = options === null || options === void 0 ? void 0 : options.auth) !== null && _c !== void 0 ? _c : '';
+        this.tls = (_a = options === null || options === void 0 ? void 0 : options.tls) !== null && _a !== void 0 ? _a : false;
+        this.tlsInsecure = (_b = options === null || options === void 0 ? void 0 : options.tlsInsecure) !== null && _b !== void 0 ? _b : false;
+        this.ip = (_c = options === null || options === void 0 ? void 0 : options.ip) !== null && _c !== void 0 ? _c : '127.0.0.1';
+        this.port = (_d = options === null || options === void 0 ? void 0 : options.port) !== null && _d !== void 0 ? _d : 80;
+        this.auth = (_e = options === null || options === void 0 ? void 0 : options.auth) !== null && _e !== void 0 ? _e : '';
         EventEmitter.call(this);
     }
     connect() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const token = yield this.get('/local/camswitcher/ws_authorization.cgi');
-                this.ws = new WebSocket(`ws://${this.ip}:${this.port}/local/camswitcher/events`, 'events');
+                const protocol = this.tls ? 'wss' : 'ws';
+                this.ws = new WebSocket(`${protocol}://${this.ip}:${this.port}/local/camswitcher/events`, 'events', {
+                    rejectUnauthorized: !this.tlsInsecure,
+                });
                 this.pingTimer = null;
                 this.ws.on('open', () => {
                     this.ws.send(JSON.stringify({ authorization: token }));
@@ -109,10 +114,11 @@ class CamSwitcherAPI extends EventEmitter {
     }
     getBaseConnectionParams() {
         return {
-            protocol: 'http:',
+            protocol: this.tls ? 'https:' : 'http:',
             host: this.ip,
             port: this.port,
             auth: this.auth,
+            rejectUnauthorized: !this.tlsInsecure,
         };
     }
 }

package/CameraVapix.d.ts

@@ -4,6 +4,8 @@ import * as http from 'http';
 import { EventEmitter2 as EventEmitter } from 'eventemitter2';
 export declare type CameraVapixOptions = {
     protocol?: string;
+    tls?: boolean;
+    tlsInsecure?: boolean;
     ip?: string;
     port?: number;
     auth?: string;
@@ -46,7 +48,8 @@ export declare type GuardTour = {
     }[];
 };
 export declare class CameraVapix extends EventEmitter {
-    private protocol;
+    private tls;
+    private tlsInsecure;
     private ip;
     private port;
     private auth;

package/CameraVapix.js

@@ -19,14 +19,18 @@ const RtspClient_1 = require("./RtspClient");
 const HTTPRequest_1 = require("./HTTPRequest");
 class CameraVapix extends eventemitter2_1.EventEmitter2 {
     constructor(options) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         super();
         this.rtsp = null;
         this.ws = null;
-        this.protocol = (_a = options === null || options === void 0 ? void 0 : options.protocol) !== null && _a !== void 0 ? _a : 'http';
-        this.ip = (_b = options === null || options === void 0 ? void 0 : options.ip) !== null && _b !== void 0 ? _b : '127.0.0.1';
-        this.port = (_c = options === null || options === void 0 ? void 0 : options.port) !== null && _c !== void 0 ? _c : (this.protocol == 'http' ? 80 : 443);
-        this.auth = (_d = options === null || options === void 0 ? void 0 : options.auth) !== null && _d !== void 0 ? _d : '';
+        this.tls = (_a = options === null || options === void 0 ? void 0 : options.tls) !== null && _a !== void 0 ? _a : false;
+        if ((options === null || options === void 0 ? void 0 : options.tls) === undefined && (options === null || options === void 0 ? void 0 : options.protocol) !== undefined) {
+            this.tls = options.protocol === 'https';
+        }
+        this.tlsInsecure = (_b = options === null || options === void 0 ? void 0 : options.tlsInsecure) !== null && _b !== void 0 ? _b : false;
+        this.ip = (_c = options === null || options === void 0 ? void 0 : options.ip) !== null && _c !== void 0 ? _c : '127.0.0.1';
+        this.port = (_d = options === null || options === void 0 ? void 0 : options.port) !== null && _d !== void 0 ? _d : (this.tls ? 443 : 80);
+        this.auth = (_e = options === null || options === void 0 ? void 0 : options.auth) !== null && _e !== void 0 ? _e : '';
     }
     getParameterGroup(groupNames) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -318,10 +322,11 @@ class CameraVapix extends eventemitter2_1.EventEmitter2 {
     }
     getBaseVapixConnectionParams() {
         return {
-            protocol: this.protocol + ':',
+            protocol: this.tls ? 'https:' : 'http:',
             host: this.ip,
             port: this.port,
             auth: this.auth,
+            rejectUnauthorized: !this.tlsInsecure,
         };
     }
 }

package/HTTPRequest.d.ts

@@ -11,5 +11,6 @@ export declare type HttpRequestOptions = {
     headers?: {
         'Content-Type'?: string;
     };
+    rejectUnauthorized?: boolean;
 };
 export declare function httpRequest(options: HttpRequestOptions, postData?: string, noWaitForData?: boolean): Promise<string | http.IncomingMessage>;

package/HTTPRequest.js

@@ -49,7 +49,7 @@ function request(options, postData, digestHeader, noWaitForData) {
         var _a, _b;
         if (digestHeader != undefined) {
             if (options.auth == undefined) {
-                reject('No credentials found');
+                reject(new Error('No credentials found'));
             }
             const auth = options.auth.split(':');
             delete options.auth;

package/README.md

@@ -197,7 +197,7 @@ Module for easy control of CamOverlay drawing API. For more details on supported
 
 ### methods
 #### CameraVapix(options)
-Options parameter contains access to the camera, service name, service ID and camera. If service ID is not specified, service is automatically created/selected based on serviceName. Specify video channel using parameter camera (in which View Area overlay will be shown). If omitted the default value camera=0 is used.
+Options parameter contains access to the camera, service name, service ID and camera. If service ID is not specified, service is automatically created/selected based on serviceName. Specify video channel using parameter camera (in which View Area overlay will be shown). If you need to specify multiple video channels, you can use an array: `camera=[0,1]`. If omitted the default value `camera=0` is used.
 ```javascript
 options = {
   'ip': '127.0.0.1',

package/package.json

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