camstreamerlib 4.0.0-beta.10 → 4.0.0-beta.12

package/cjs/CamOverlayAPI.d.ts

@@ -1,19 +1,19 @@
 /// <reference types="node" />
-import { IClient } from './internal/common';
+import { IClient, TBlobResponse, TResponse } from './internal/types';
 import { ImageType, TCoordinates, TField, TFile, TFileType, TStorage, TWidget } from './types/CamOverlayAPI';
 export declare const BASE_URL = "/local/camoverlay/api";
-export declare class CamOverlayAPI<Client extends IClient = IClient> {
-    client: Client;
+export declare class CamOverlayAPI<Client extends IClient<TResponse> = IClient<TResponse>> {
+    private client;
     constructor(client: Client);
     static getProxyUrlPath: () => string;
     static getFilePreviewPath: (path: string) => string;
     checkCameraTime(): Promise<boolean>;
     getNetworkCameraList(): Promise<{
-        ip: string;
         name: string;
+        ip: string;
     }[]>;
     wsAuthorization(): Promise<string>;
-    getMjpegStreamImage(mjpegUrl: string): Promise<Blob | import("buffer").Blob>;
+    getMjpegStreamImage(mjpegUrl: string): Promise<TBlobResponse<Client>>;
     listFiles(fileType: TFileType): Promise<{
         path: string;
         name: string;
@@ -25,22 +25,22 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         type: "url" | "flash" | "SD0" | "ftp" | "samba";
         state: string;
     }[]>;
-    getFilePreviewFromCamera(path: string): Promise<Blob | import("buffer").Blob>;
+    getFilePreviewFromCamera(path: string): Promise<TBlobResponse<Client>>;
     updateInfoticker(serviceID: number, text: string): Promise<void>;
     setEnabled(serviceID: number, enabled: boolean): Promise<void>;
     isEnabled(serviceID: number): Promise<boolean>;
     getSingleWidget(serviceId: number): Promise<{
-        id: number;
+        name: "customGraphics";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
-        name: "customGraphics";
         clockFormat: "12h" | "24h";
         background: "custom" | "image";
         image: string;
@@ -50,9 +50,9 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         customAreaCorners: "sharp" | "rounded";
         mappingZones: ({
             type: "plain";
+            name: string;
             pos_x: number;
             pos_y: number;
-            name: string;
             wrapText: boolean;
             textLines: number;
             textWidth: number;
@@ -63,14 +63,14 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
             fontSize: number;
             switchingTime: number;
             text?: {
-                active: boolean;
                 source: string;
+                active: boolean;
             }[] | undefined;
         } | {
             type: "countdown";
+            name: string;
             pos_x: number;
             pos_y: number;
-            name: string;
             wrapText: boolean;
             textLines: number;
             textWidth: number;
@@ -101,8 +101,8 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
                 waitingPeriod: number;
             };
             text?: {
-                active: boolean;
                 source: string;
+                active: boolean;
             }[] | undefined;
         })[];
         schedule?: string | undefined;
@@ -110,22 +110,22 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "images";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
-        name: "images";
         overlayList: {
+            duration: number;
             active: boolean;
             coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
             pos_x: number;
             pos_y: number;
             imgPath: string;
             imgName: string;
-            duration: number;
             scale: number;
             fps?: number | undefined;
         }[];
@@ -134,18 +134,18 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "accuweather";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
         scale: number;
-        name: "accuweather";
         font: string;
         location: string;
         locationName: string;
@@ -161,17 +161,17 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "infoticker";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
+        source: string;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top" | "bottom";
         pos_y: number;
-        name: "infoticker";
-        source: string;
         textColor: string;
         font: string;
         fontSize: number;
@@ -186,26 +186,26 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         numberOfLines: number;
         crawlLeft: boolean;
         crawlSpeed: number;
-        sourceType: "text" | "url";
+        sourceType: "url" | "text";
         schedule?: string | undefined;
         invertInput?: boolean | undefined;
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "pip";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
+        fps: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
         scale: number;
-        fps: number;
         screenSize: number;
-        name: "pip";
         compression: number;
         source_type: "axis_camera" | "mjpeg_url";
         mjpeg_url: string;
@@ -231,18 +231,18 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         zIndex?: number | undefined;
     } | {
         type: "map" | "image" | "compass";
-        id: number;
+        name: "ptzCompass";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
         scale: number;
-        name: "ptzCompass";
         image: string;
         northPan: number;
         cameraPosX: number;
@@ -260,23 +260,23 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         generalIframeHeight?: number | undefined;
         generalAddress?: string | undefined;
     } | {
-        id: number;
+        name: "ptz";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
-        name: "ptz";
         ptz_positions: Record<string, {
             loop: boolean;
             overlayList: {
+                duration: number;
                 coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
                 pos_x: number;
                 pos_y: number;
                 imgPath: string;
                 imgName: string;
-                duration: number;
                 scale: number;
             }[];
         }>;
@@ -285,54 +285,54 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "screenSharing";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
+        fps: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
-        fps: number;
         screenSize: number;
-        name: "screenSharing";
         schedule?: string | undefined;
         invertInput?: boolean | undefined;
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "web_camera";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
+        fps: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
-        fps: number;
         screenSize: number;
-        name: "web_camera";
         schedule?: string | undefined;
         invertInput?: boolean | undefined;
         camera?: number | undefined;
         zIndex?: number | undefined;
     }>;
     getWidgets(): Promise<({
-        id: number;
+        name: "customGraphics";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
-        name: "customGraphics";
         clockFormat: "12h" | "24h";
         background: "custom" | "image";
         image: string;
@@ -342,9 +342,9 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         customAreaCorners: "sharp" | "rounded";
         mappingZones: ({
             type: "plain";
+            name: string;
             pos_x: number;
             pos_y: number;
-            name: string;
             wrapText: boolean;
             textLines: number;
             textWidth: number;
@@ -355,14 +355,14 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
             fontSize: number;
             switchingTime: number;
             text?: {
-                active: boolean;
                 source: string;
+                active: boolean;
             }[] | undefined;
         } | {
             type: "countdown";
+            name: string;
             pos_x: number;
             pos_y: number;
-            name: string;
             wrapText: boolean;
             textLines: number;
             textWidth: number;
@@ -393,8 +393,8 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
                 waitingPeriod: number;
             };
             text?: {
-                active: boolean;
                 source: string;
+                active: boolean;
             }[] | undefined;
         })[];
         schedule?: string | undefined;
@@ -402,22 +402,22 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "images";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
-        name: "images";
         overlayList: {
+            duration: number;
             active: boolean;
             coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
             pos_x: number;
             pos_y: number;
             imgPath: string;
             imgName: string;
-            duration: number;
             scale: number;
             fps?: number | undefined;
         }[];
@@ -426,18 +426,18 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "accuweather";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
         scale: number;
-        name: "accuweather";
         font: string;
         location: string;
         locationName: string;
@@ -453,17 +453,17 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "infoticker";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
+        source: string;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top" | "bottom";
         pos_y: number;
-        name: "infoticker";
-        source: string;
         textColor: string;
         font: string;
         fontSize: number;
@@ -478,26 +478,26 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         numberOfLines: number;
         crawlLeft: boolean;
         crawlSpeed: number;
-        sourceType: "text" | "url";
+        sourceType: "url" | "text";
         schedule?: string | undefined;
         invertInput?: boolean | undefined;
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "pip";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
+        fps: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
         scale: number;
-        fps: number;
         screenSize: number;
-        name: "pip";
         compression: number;
         source_type: "axis_camera" | "mjpeg_url";
         mjpeg_url: string;
@@ -523,18 +523,18 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         zIndex?: number | undefined;
     } | {
         type: "map" | "image" | "compass";
-        id: number;
+        name: "ptzCompass";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
         scale: number;
-        name: "ptzCompass";
         image: string;
         northPan: number;
         cameraPosX: number;
@@ -552,23 +552,23 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         generalIframeHeight?: number | undefined;
         generalAddress?: string | undefined;
     } | {
-        id: number;
+        name: "ptz";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
-        name: "ptz";
         ptz_positions: Record<string, {
             loop: boolean;
             overlayList: {
+                duration: number;
                 coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
                 pos_x: number;
                 pos_y: number;
                 imgPath: string;
                 imgName: string;
-                duration: number;
                 scale: number;
             }[];
         }>;
@@ -577,37 +577,37 @@ export declare class CamOverlayAPI<Client extends IClient = IClient> {
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "screenSharing";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
+        fps: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
-        fps: number;
         screenSize: number;
-        name: "screenSharing";
         schedule?: string | undefined;
         invertInput?: boolean | undefined;
         camera?: number | undefined;
         zIndex?: number | undefined;
     } | {
-        id: number;
+        name: "web_camera";
         enabled: 0 | 1;
+        id: number;
+        width: number;
+        height: number;
+        fps: number;
         automationType: "time" | "manual" | "schedule" | `input${number}`;
         cameraList: number[];
         customName: string;
-        width: number;
-        height: number;
         coordSystem: "top_left" | "top" | "top_right" | "left" | "center" | "right" | "bottom_left" | "bottom" | "bottom_right";
         pos_x: number;
         pos_y: number;
-        fps: number;
         screenSize: number;
-        name: "web_camera";
         schedule?: string | undefined;
         invertInput?: boolean | undefined;
         camera?: number | undefined;

package/cjs/CamOverlayAPI.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CamOverlayAPI = exports.BASE_URL = void 0;
-const common_1 = require("./internal/common");
+const utils_1 = require("./internal/utils");
 const CamOverlayAPI_1 = require("./types/CamOverlayAPI");
 const errors_1 = require("./errors/errors");
-const common_2 = require("./types/common");
+const common_1 = require("./types/common");
 const zod_1 = require("zod");
 const widgetsSchema_1 = require("./models/CamOverlayAPI/widgetsSchema");
 const fileSchema_1 = require("./models/CamOverlayAPI/fileSchema");
-const utils_1 = require("./internal/utils");
 exports.BASE_URL = '/local/camoverlay/api';
 class CamOverlayAPI {
     client;
@@ -43,7 +42,7 @@ class CamOverlayAPI {
     }
     async getNetworkCameraList() {
         const response = await this._get(`${exports.BASE_URL}/network_camera_list.cgi`);
-        return common_2.networkCameraListSchema.parse(response.camera_list);
+        return common_1.networkCameraListSchema.parse(response.camera_list);
     }
     async wsAuthorization() {
         const responseSchema = zod_1.z.object({
@@ -119,7 +118,7 @@ class CamOverlayAPI {
             throw new errors_1.ServiceNotFoundError();
         }
         else {
-            throw new Error(await (0, common_1.responseStringify)(res));
+            throw new Error(await (0, utils_1.responseStringify)(res));
         }
     }
     async getSingleWidget(serviceId) {
@@ -204,7 +203,7 @@ class CamOverlayAPI {
             ...params,
         }, headers);
         if (!res.ok) {
-            throw new Error(await (0, common_1.responseStringify)(res));
+            throw new Error(await (0, utils_1.responseStringify)(res));
         }
     }
     async _get(...args) {
@@ -213,7 +212,7 @@ class CamOverlayAPI {
             return (await res.json());
         }
         else {
-            throw new Error(await (0, common_1.responseStringify)(res));
+            throw new Error(await (0, utils_1.responseStringify)(res));
         }
     }
     async _post(...args) {
@@ -222,7 +221,7 @@ class CamOverlayAPI {
             return (await res.json());
         }
         else {
-            throw new Error(await (0, common_1.responseStringify)(res));
+            throw new Error(await (0, utils_1.responseStringify)(res));
         }
     }
     async _getBlob(...args) {
@@ -231,12 +230,12 @@ class CamOverlayAPI {
             return await this.parseBlobResponse(res);
         }
         else {
-            throw new Error(await (0, common_1.responseStringify)(res));
+            throw new Error(await (0, utils_1.responseStringify)(res));
         }
     }
     async parseBlobResponse(response) {
         try {
-            return await response.blob();
+            return (await response.blob());
         }
         catch (err) {
             throw new errors_1.ParsingBlobError(err);

package/cjs/CamOverlayDrawingAPI.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import * as EventEmitter from 'events';
-import { WsOptions } from './internal/common';
+import { WsOptions } from './internal/types';
 export type CamOverlayDrawingOptions = WsOptions & {
     camera?: number | number[];
     zIndex?: number;

package/cjs/CamScripterAPI.d.ts

@@ -1,7 +1,7 @@
-import { IClient } from './internal/common';
+import { IClient, TResponse } from './internal/types';
 import { TNodeState, TPackageInfoList, TStorage, TStorageType } from './types/CamScripterAPI';
 import { TNetworkCamera } from './types/common';
-export declare class CamOverlayAPI<Client extends IClient = IClient> {
+export declare class CamOverlayAPI<Client extends IClient<TResponse> = IClient<TResponse>> {
     client: Client;
     constructor(client: Client);
     checkCameraTime(): Promise<boolean>;