camstreamerlib 3.4.0 → 3.5.0

package/CamScripterAPICameraEventsGenerator.d.ts

@@ -1,9 +1,7 @@
 /// <reference types="node" />
 import * as EventEmitter from 'events';
 import { WsOptions } from './internal/common';
-export type CamScripterOptions = WsOptions & {
-    camScripterAcapName?: string;
-};
+export type CamScripterOptions = WsOptions;
 export type TDeclaration = {
     type?: '' | 'SOURCE' | 'DATA';
     namespace: string;
@@ -54,7 +52,6 @@ export declare class CamScripterAPICameraEventsGenerator extends EventEmitter {
     private port;
     private user;
     private pass;
-    private camScripterAcapName;
     private callId;
     private sendMessages;
     private timeoutCheckTimer;

package/CamScripterAPICameraEventsGenerator.js

@@ -5,7 +5,7 @@ const EventEmitter = require("events");
 const WsClient_1 = require("./internal/WsClient");
 class CamScripterAPICameraEventsGenerator extends EventEmitter {
     constructor(options) {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f;
         super();
         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;
@@ -13,7 +13,6 @@ class CamScripterAPICameraEventsGenerator extends EventEmitter {
         this.port = (_d = options === null || options === void 0 ? void 0 : options.port) !== null && _d !== void 0 ? _d : (this.tls ? 443 : 80);
         this.user = (_e = options === null || options === void 0 ? void 0 : options.user) !== null && _e !== void 0 ? _e : '';
         this.pass = (_f = options === null || options === void 0 ? void 0 : options.pass) !== null && _f !== void 0 ? _f : '';
-        this.camScripterAcapName = (_g = options === null || options === void 0 ? void 0 : options.camScripterAcapName) !== null && _g !== void 0 ? _g : 'camscripter';
         this.callId = 0;
         this.sendMessages = {};
         this.wsConnected = false;
@@ -57,7 +56,7 @@ class CamScripterAPICameraEventsGenerator extends EventEmitter {
             tls: this.tls,
             ip: this.ip,
             port: this.port,
-            address: `/local/${this.camScripterAcapName}/ws`,
+            address: `/local/camscripter/ws`,
             protocol: 'camera-events',
         };
         this.ws = new WsClient_1.WsClient(options);

package/HttpServer.d.ts

@@ -3,10 +3,12 @@
 import * as http from 'http';
 import * as EventEmitter from 'events';
 export type HttpServerOptions = {
+    host?: string;
     port?: number;
 };
 type TOnRequestCallback = (req: http.IncomingMessage, res: http.ServerResponse) => void;
 export declare class HttpServer extends EventEmitter {
+    private host;
     private port;
     private registeredPaths;
     private server;

package/HttpServer.js

@@ -8,9 +8,10 @@ const path = require("path");
 const EventEmitter = require("events");
 class HttpServer extends EventEmitter {
     constructor(options) {
-        var _a, _b;
+        var _a, _b, _c, _d;
         super();
-        this.port = (_a = options === null || options === void 0 ? void 0 : options.port) !== null && _a !== void 0 ? _a : parseInt((_b = process.env.HTTP_PORT) !== null && _b !== void 0 ? _b : '80');
+        this.host = (_b = (_a = options === null || options === void 0 ? void 0 : options.host) !== null && _a !== void 0 ? _a : process.env.HTTP_HOST) !== null && _b !== void 0 ? _b : '0.0.0.0';
+        this.port = (_c = options === null || options === void 0 ? void 0 : options.port) !== null && _c !== void 0 ? _c : parseInt((_d = process.env.HTTP_PORT) !== null && _d !== void 0 ? _d : '80');
         this.registeredPaths = new Map();
         this.server = http.createServer((req, res) => {
             var _a, _b;
@@ -66,7 +67,7 @@ class HttpServer extends EventEmitter {
         this.server.on('error', (err) => {
             this.emit('error', err);
         });
-        this.server.listen(this.port);
+        this.server.listen(this.port, this.host);
         this.sockets = {};
         let idTracker = 0;
         this.server.on('connection', (socket) => {

package/README.md

@@ -31,6 +31,8 @@ npm install camstreamerlib
 
 -   [VapixEvents](doc/VapixEvents.md) is a module which allows receiving camera events from the VAPIX API.
 
+-   [GenetecAgent](doc/GenetecAgent.md) is a module which allows receiving and sending data to Genetec VMS.
+
 ## For Developers
 
 ### Publishing to npm repository

package/events/AxisCameraStationEvents.d.ts

@@ -5,4 +5,5 @@ export declare class AxisCameraStationEvents {
     private client;
     constructor(sourceKey: string, opt?: AcsEventsOptions | IClient);
     sendEvent(data: Record<string, string>, eventType: string): Promise<void>;
+    private getDate;
 }

package/events/AxisCameraStationEvents.js

@@ -12,24 +12,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AxisCameraStationEvents = void 0;
 const DefaultAgent_1 = require("../DefaultAgent");
 const common_1 = require("../internal/common");
-function pad(num, size) {
-    const sign = Math.sign(num) === -1 ? '-' : '';
-    return (sign +
-        new Array(size)
-            .concat([Math.abs(num)])
-            .join('0')
-            .slice(-size));
-}
-function getDate() {
-    const date = new Date();
-    const year = date.getUTCFullYear();
-    const month = pad(date.getUTCMonth() + 1, 2);
-    const day = pad(date.getUTCDate(), 2);
-    const hours = pad(date.getUTCHours(), 2);
-    const minutes = pad(date.getUTCMinutes(), 2);
-    const seconds = pad(date.getUTCSeconds(), 2);
-    return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`;
-}
 class AxisCameraStationEvents {
     constructor(sourceKey, opt = {}) {
         this.sourceKey = sourceKey;
@@ -42,7 +24,7 @@ class AxisCameraStationEvents {
     }
     sendEvent(data, eventType) {
         return __awaiter(this, void 0, void 0, function* () {
-            const dateString = getDate();
+            const dateString = this.getDate();
             const event = {
                 addExternalDataRequest: {
                     occurrenceTime: dateString,
@@ -61,5 +43,15 @@ class AxisCameraStationEvents {
             }
         });
     }
+    getDate() {
+        const date = new Date();
+        const year = date.getUTCFullYear();
+        const month = (0, common_1.pad)(date.getUTCMonth() + 1, 2);
+        const day = (0, common_1.pad)(date.getUTCDate(), 2);
+        const hours = (0, common_1.pad)(date.getUTCHours(), 2);
+        const minutes = (0, common_1.pad)(date.getUTCMinutes(), 2);
+        const seconds = (0, common_1.pad)(date.getUTCSeconds(), 2);
+        return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`;
+    }
 }
 exports.AxisCameraStationEvents = AxisCameraStationEvents;

package/events/GenetecAgent.d.ts

@@ -0,0 +1,133 @@
+/// <reference types="node" />
+import { z } from 'zod';
+declare const cameraGuidsResponseSchema: z.ZodObject<{
+    Rsp: z.ZodObject<{
+        Status: z.ZodString;
+        Result: z.ZodArray<z.ZodObject<{
+            Guid: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            Guid: string;
+        }, {
+            Guid: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        Status: string;
+        Result: {
+            Guid: string;
+        }[];
+    }, {
+        Status: string;
+        Result: {
+            Guid: string;
+        }[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    Rsp: {
+        Status: string;
+        Result: {
+            Guid: string;
+        }[];
+    };
+}, {
+    Rsp: {
+        Status: string;
+        Result: {
+            Guid: string;
+        }[];
+    };
+}>;
+export type TCameraGuidsResponse = z.infer<typeof cameraGuidsResponseSchema>;
+declare const connectionResponseSchema: z.ZodObject<{
+    Rsp: z.ZodObject<{
+        Status: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        Status: string;
+    }, {
+        Status: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    Rsp: {
+        Status: string;
+    };
+}, {
+    Rsp: {
+        Status: string;
+    };
+}>;
+export type TConnectionResponse = z.infer<typeof connectionResponseSchema>;
+export declare const cameraDetailsResponseSchema: z.ZodObject<{
+    Rsp: z.ZodObject<{
+        Status: z.ZodString;
+        Result: z.ZodArray<z.ZodObject<{
+            Guid: z.ZodOptional<z.ZodString>;
+            Name: z.ZodOptional<z.ZodString>;
+            EntityType: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            Guid?: string | undefined;
+            Name?: string | undefined;
+            EntityType?: string | undefined;
+        }, {
+            Guid?: string | undefined;
+            Name?: string | undefined;
+            EntityType?: string | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        Status: string;
+        Result: {
+            Guid?: string | undefined;
+            Name?: string | undefined;
+            EntityType?: string | undefined;
+        }[];
+    }, {
+        Status: string;
+        Result: {
+            Guid?: string | undefined;
+            Name?: string | undefined;
+            EntityType?: string | undefined;
+        }[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    Rsp: {
+        Status: string;
+        Result: {
+            Guid?: string | undefined;
+            Name?: string | undefined;
+            EntityType?: string | undefined;
+        }[];
+    };
+}, {
+    Rsp: {
+        Status: string;
+        Result: {
+            Guid?: string | undefined;
+            Name?: string | undefined;
+            EntityType?: string | undefined;
+        }[];
+    };
+}>;
+export type TCameraDetailsResponse = z.infer<typeof cameraDetailsResponseSchema>;
+type TParams = Array<'Guid' | 'Name' | 'EntityType'>;
+export type GenetecAgentOptions = {
+    protocol?: 'http' | 'https' | 'https_insecure';
+    ip?: string;
+    port?: number;
+    base_uri?: string;
+    user?: string;
+    pass?: string;
+    app_id?: string;
+};
+export declare class GenetecAgent {
+    private settings;
+    private baseUrl;
+    private credentials;
+    constructor(options?: GenetecAgentOptions);
+    checkConnection(): Promise<TConnectionResponse>;
+    getAllCameraGuids(): Promise<TCameraGuidsResponse>;
+    getCameraDetails(guids: {
+        Guid: string;
+    }[], parameters: TParams): Promise<TCameraDetailsResponse>;
+    sendBookmark(guids: string[], bookmarkText: string): Promise<Response>;
+    private getRequestOptions;
+    private getTimeStamp;
+}
+export {};

package/events/GenetecAgent.js

@@ -0,0 +1,127 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenetecAgent = exports.cameraDetailsResponseSchema = void 0;
+const zod_1 = require("zod");
+const common_1 = require("../internal/common");
+const ACTION = 'AddCameraBookmark';
+const GET_CAMERAS_URL = 'report/EntityConfiguration?q=EntityTypes@Camera';
+const GET_CAMERAS_DETAILS_URL = '/entity?q=';
+const cameraGuidsResponseSchema = zod_1.z.object({
+    Rsp: zod_1.z.object({
+        Status: zod_1.z.string(),
+        Result: zod_1.z.array(zod_1.z.object({ Guid: zod_1.z.string() })),
+    }),
+});
+const connectionResponseSchema = zod_1.z.object({
+    Rsp: zod_1.z.object({
+        Status: zod_1.z.string(),
+    }),
+});
+exports.cameraDetailsResponseSchema = zod_1.z.object({
+    Rsp: zod_1.z.object({
+        Status: zod_1.z.string(),
+        Result: zod_1.z.array(zod_1.z.object({
+            Guid: zod_1.z.string().optional(),
+            Name: zod_1.z.string().optional(),
+            EntityType: zod_1.z.string().optional(),
+        })),
+    }),
+});
+class GenetecAgent {
+    constructor(options = {}) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        this.settings = {
+            protocol: (_a = options.protocol) !== null && _a !== void 0 ? _a : 'http',
+            ip: (_b = options.ip) !== null && _b !== void 0 ? _b : '127.0.0.1',
+            port: (_c = options.port) !== null && _c !== void 0 ? _c : 80,
+            base_uri: (_d = options.base_uri) !== null && _d !== void 0 ? _d : 'WebSdk',
+            user: (_e = options.user) !== null && _e !== void 0 ? _e : 'root',
+            pass: (_f = options.pass) !== null && _f !== void 0 ? _f : '',
+            app_id: (_g = options.app_id) !== null && _g !== void 0 ? _g : '',
+        };
+        this.baseUrl = `${this.settings.protocol}://${this.settings.ip}:${this.settings.port}/${this.settings.base_uri}`;
+        this.credentials = btoa(`${this.settings.user};${this.settings.app_id}:${this.settings.pass}`);
+    }
+    checkConnection() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = this.getRequestOptions('GET');
+            const res = yield fetch(`${this.baseUrl}/`, requestOptions);
+            if (!res.ok) {
+                throw new Error(yield (0, common_1.responseStringify)(res));
+            }
+            return connectionResponseSchema.parse(yield res.json());
+        });
+    }
+    getAllCameraGuids() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = this.getRequestOptions('GET');
+            const res = yield fetch(`${this.baseUrl}/${GET_CAMERAS_URL}`, requestOptions);
+            if (!res.ok) {
+                throw new Error(yield (0, common_1.responseStringify)(res));
+            }
+            return cameraGuidsResponseSchema.parse(yield res.json());
+        });
+    }
+    getCameraDetails(guids, parameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = parameters.join(',');
+            const camerasGuids = guids.map((item) => item.Guid);
+            const camerasDetailsUrl = [];
+            const requestOptions = this.getRequestOptions('GET');
+            for (const guid of camerasGuids) {
+                camerasDetailsUrl.push(`entity=${guid},${params}`);
+            }
+            const res = yield fetch(`${this.baseUrl}/${GET_CAMERAS_DETAILS_URL}${camerasDetailsUrl.join(',')}`, requestOptions);
+            if (!res.ok) {
+                throw new Error(yield (0, common_1.responseStringify)(res));
+            }
+            return exports.cameraDetailsResponseSchema.parse(yield res.json());
+        });
+    }
+    sendBookmark(guids, bookmarkText) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cameraEntitiesUrl = [];
+            const timeStamp = this.getTimeStamp();
+            const requestOptions = this.getRequestOptions('POST');
+            for (const guid of guids) {
+                cameraEntitiesUrl.push(`${ACTION}(${guid},${timeStamp},${bookmarkText})`);
+            }
+            const res = yield fetch(`${this.baseUrl}/action?q=${cameraEntitiesUrl.join(',')}`, requestOptions);
+            if (!res.ok) {
+                throw new Error(yield (0, common_1.responseStringify)(res));
+            }
+            return res;
+        });
+    }
+    getRequestOptions(method) {
+        return {
+            method,
+            headers: new Headers({
+                Authorization: `Basic ${this.credentials}`,
+                Accept: 'text/json',
+            }),
+            redirect: 'follow',
+        };
+    }
+    getTimeStamp() {
+        const date = new Date();
+        const year = date.getUTCFullYear();
+        const month = (0, common_1.pad)(date.getUTCMonth() + 1, 2);
+        const day = (0, common_1.pad)(date.getUTCDate(), 2);
+        const hours = (0, common_1.pad)(date.getUTCHours(), 2);
+        const minutes = (0, common_1.pad)(date.getUTCMinutes(), 2);
+        const seconds = (0, common_1.pad)(date.getUTCSeconds(), 2);
+        const miliSeconds = (0, common_1.pad)(date.getUTCMilliseconds(), 2);
+        return `${year}-${month}-${day}T${hours}:${minutes}:${seconds}.${miliSeconds}Z`;
+    }
+}
+exports.GenetecAgent = GenetecAgent;

package/internal/common.d.ts

@@ -21,4 +21,5 @@ export interface IClient {
 export declare function isClient(arg?: Options | IClient): arg is IClient;
 export declare function isBrowserEnvironment(): boolean;
 export declare function responseStringify(res: Response): Promise<string>;
+export declare function pad(num: number, size: number): string;
 export {};

package/internal/common.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.responseStringify = exports.isBrowserEnvironment = exports.isClient = void 0;
+exports.pad = exports.responseStringify = exports.isBrowserEnvironment = exports.isClient = void 0;
 function isClient(arg = {}) {
     return 'get' in arg && 'post' in arg;
 }
@@ -27,3 +27,12 @@ function responseStringify(res) {
     });
 }
 exports.responseStringify = responseStringify;
+function pad(num, size) {
+    const sign = Math.sign(num) === -1 ? '-' : '';
+    return (sign +
+        new Array(size)
+            .concat([Math.abs(num)])
+            .join('0')
+            .slice(-size));
+}
+exports.pad = pad;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "camstreamerlib",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Helper library for CamStreamer ACAP applications.",
   "prettier": "@camstreamer/prettier-config",
   "dependencies": {
@@ -9,7 +9,8 @@
     "prettify-xml": "^1.2.0",
     "undici": "6.13.0",
     "ws": "^8.18.0",
-    "xml2js": "^0.5.0"
+    "xml2js": "^0.5.0",
+    "zod": "^3.24.3"
   },
   "engine": {
     "node": ">=18.0.0"