camstreamerlib 4.0.33-55dd1f0 → 4.0.33-71913af

package/cjs/CamOverlayAPI.d.ts

@@ -14,6 +14,12 @@ export declare class CamOverlayAPI<Client extends IClient<TResponse, any>> exten
     }[]>;
     wsAuthorization(options?: THttpRequestOptions): Promise<string>;
     getMjpegStreamImage(mjpegUrl: string, options?: THttpRequestOptions): Promise<ReturnType<Awaited<ReturnType<Client["get"]>>["blob"]>>;
+    isViewerPassValid(pass: string, options?: THttpRequestOptions): Promise<boolean>;
+    getLiveViewAlias(rtspUrl: string, options?: THttpRequestOptions): Promise<{
+        alias: string;
+        ws: string;
+        ws_initial_message: string;
+    }>;
     listFiles<T extends TFileType>(fileType: T, options?: THttpRequestOptions): Promise<TFileList<T>>;
     uploadFile<T extends TFileType>(fileType: T, formData: Parameters<Client['post']>[0]['data'], storage: TFileStorageType<T>, options?: THttpRequestOptions): Promise<void>;
     removeFile<T extends TFileType>(fileType: T, fileParams: TFile<T>, options?: THttpRequestOptions): Promise<void>;

package/cjs/CamOverlayAPI.js

@@ -29,6 +29,22 @@ class CamOverlayAPI extends BasicAPI_1.BasicAPI {
     async getMjpegStreamImage(mjpegUrl, options) {
         return await this._getBlob(`${BASE_PATH}/fetch_mjpeg_image.cgi`, { mjpeg_url: decodeURIComponent(mjpegUrl) }, options);
     }
+    async isViewerPassValid(pass, options) {
+        const res = await this._getJson(`${BASE_PATH}/check_pass.cgi`, { pass }, options);
+        if (res.status !== 200) {
+            throw new Error(res.message);
+        }
+        return res.data === '1';
+    }
+    async getLiveViewAlias(rtspUrl, options) {
+        const agent = this.getClient(options?.proxyParams);
+        const res = await agent.get({
+            path: `${BASE_PATH}/getLiveViewAlias.cgi`,
+            parameters: { rtsp_url: rtspUrl },
+            timeout: options?.timeout,
+        });
+        return common_1.wsAliasResponseSchema.parse(await res.json());
+    }
     async listFiles(fileType, options) {
         const res = await this._getJson(`${BASE_PATH}/upload_${fileType}.cgi`, { action: 'list' }, options);
         return (0, CamOverlayAPI_1.getFileListSchema)(fileType).parse(res.list);

package/cjs/CamSwitcherAPI.d.ts

@@ -28,9 +28,9 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> exte
     }[]>;
     wsAuthorization(options?: THttpRequestOptions): Promise<string>;
     getOutputInfo(options?: THttpRequestOptions): Promise<{
-        rtspUrl: string;
         ws: string;
         wsInitialMessage: string;
+        rtspUrl: string;
     }>;
     getAudioPushInfo(options?: THttpRequestOptions): Promise<{
         ws: string;

package/cjs/PlaneTrackerAPI.d.ts

@@ -12,9 +12,9 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
     checkCameraTime(options?: THttpRequestOptions): Promise<boolean>;
     serverRunCheck(options?: THttpRequestOptions): Promise<boolean>;
     getLiveViewAlias(rtspUrl: string, options?: THttpRequestOptions): Promise<{
+        alias: string;
         ws: string;
         ws_initial_message: string;
-        alias: string;
     }>;
     resetPtzCalibration(options?: THttpRequestOptions): Promise<void>;
     resetFocusCalibration(options?: THttpRequestOptions): Promise<void>;

package/cjs/PlaneTrackerAPI.js

@@ -4,6 +4,7 @@ exports.PlaneTrackerAPI = void 0;
 const zod_1 = require("zod");
 const PlaneTrackerAPI_1 = require("./types/PlaneTrackerAPI");
 const errors_1 = require("./errors/errors");
+const common_1 = require("./types/common");
 const BasicAPI_1 = require("./internal/BasicAPI");
 const PlaneTrackerEvents_1 = require("./types/ws/PlaneTrackerEvents");
 const BASE_PATH = '/local/planetracker';
@@ -37,7 +38,7 @@ class PlaneTrackerAPI extends BasicAPI_1.BasicAPI {
             parameters: { rtsp_url: rtspUrl },
             timeout: options?.timeout,
         });
-        return PlaneTrackerAPI_1.wsAliasResponseSchema.parse(await res.json());
+        return common_1.wsAliasResponseSchema.parse(await res.json());
     }
     async resetPtzCalibration(options) {
         const agent = this.getClient(options?.proxyParams);

package/cjs/types/CamSwitcherAPI.d.ts

@@ -25,21 +25,21 @@ export declare const outputInfoSchema: z.ZodEffects<z.ZodObject<{
     ws: z.ZodString;
     ws_initial_message: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    rtsp_url: string;
     ws: string;
     ws_initial_message: string;
-}, {
     rtsp_url: string;
+}, {
     ws: string;
     ws_initial_message: string;
+    rtsp_url: string;
 }>, {
-    rtspUrl: string;
     ws: string;
     wsInitialMessage: string;
+    rtspUrl: string;
 }, {
-    rtsp_url: string;
     ws: string;
     ws_initial_message: string;
+    rtsp_url: string;
 }>;
 export type TOutputInfo = z.infer<typeof outputInfoSchema>;
 export declare const audioPushInfoSchema: z.ZodEffects<z.ZodObject<{

package/cjs/types/PlaneTrackerAPI.d.ts

@@ -1,19 +1,6 @@
 import { z } from 'zod';
 export type TImportDataType = 'MAP_DATA' | 'SERVER_DATA' | 'ALL';
 export type TExportDataType = 'NIGHT_SKY_CALIBRATION_DATA' | 'ALL';
-export declare const wsAliasResponseSchema: z.ZodObject<{
-    alias: z.ZodString;
-    ws: z.ZodString;
-    ws_initial_message: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    ws: string;
-    ws_initial_message: string;
-    alias: string;
-}, {
-    ws: string;
-    ws_initial_message: string;
-    alias: string;
-}>;
 export declare const connectionSchema: z.ZodObject<{
     protocol: z.ZodUnion<[z.ZodLiteral<"http">, z.ZodLiteral<"https">, z.ZodLiteral<"https_insecure">]>;
     ip: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;

package/cjs/types/PlaneTrackerAPI.js

@@ -1,12 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REMOTE_ID_CATEGORY_IDS = exports.ADSB_CATEGORY_IDS = exports.domainListSchema = exports.zonesSchema = exports.zonePerimeterSchema = exports.domainIdSchema = exports.mapInfoSchema = exports.mapTypeSchema = exports.friendlyListSchema = exports.priorityListSchema = exports.blackListSchema = exports.whiteListSchema = exports.priorityListEntrySchema = exports.listEntrySchema = exports.listEntryIdTypeSchema = exports.listEntryDomainSchema = exports.flightInfoSchema = exports.trackingModeSchema = exports.getIcaoSchema = exports.serverSettingsSchema = exports.cameraSettingsSchema = exports.widgetSchema = exports.milestoneCameraListSchema = exports.connectionSchema = exports.wsAliasResponseSchema = void 0;
+exports.REMOTE_ID_CATEGORY_IDS = exports.ADSB_CATEGORY_IDS = exports.domainListSchema = exports.zonesSchema = exports.zonePerimeterSchema = exports.domainIdSchema = exports.mapInfoSchema = exports.mapTypeSchema = exports.friendlyListSchema = exports.priorityListSchema = exports.blackListSchema = exports.whiteListSchema = exports.priorityListEntrySchema = exports.listEntrySchema = exports.listEntryIdTypeSchema = exports.listEntryDomainSchema = exports.flightInfoSchema = exports.trackingModeSchema = exports.getIcaoSchema = exports.serverSettingsSchema = exports.cameraSettingsSchema = exports.widgetSchema = exports.milestoneCameraListSchema = exports.connectionSchema = void 0;
 const zod_1 = require("zod");
-exports.wsAliasResponseSchema = zod_1.z.object({
-    alias: zod_1.z.string(),
-    ws: zod_1.z.string(),
-    ws_initial_message: zod_1.z.string(),
-});
 exports.connectionSchema = zod_1.z.object({
     protocol: zod_1.z.union([zod_1.z.literal('http'), zod_1.z.literal('https'), zod_1.z.literal('https_insecure')]),
     ip: zod_1.z.union([zod_1.z.string().ip(), zod_1.z.literal('')]),

package/cjs/types/common.d.ts

@@ -26,6 +26,19 @@ export declare const keyboardShortcutSchema: z.ZodNullable<z.ZodString>;
 export declare const keyboardShortcutsSchema: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
 export type TKeyboardShortcut = z.infer<typeof keyboardShortcutSchema>;
 export type TKeyboardShortcuts = z.infer<typeof keyboardShortcutsSchema>;
+export declare const wsAliasResponseSchema: z.ZodObject<{
+    alias: z.ZodString;
+    ws: z.ZodString;
+    ws_initial_message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    alias: string;
+    ws: string;
+    ws_initial_message: string;
+}, {
+    alias: string;
+    ws: string;
+    ws_initial_message: string;
+}>;
 export type TProxyTarget = {
     ip: string;
     mdnsName: string;

package/cjs/types/common.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fileSchema = exports.bitrateVapixParamsSchema = exports.bitrateModeSchema = exports.keyboardShortcutsSchema = exports.keyboardShortcutSchema = exports.networkCameraListSchema = exports.storageTypeSchema = exports.sdCardStorageTypeSchema = exports.flashStorageTypeSchema = exports.h264ProfileSchema = exports.audioChannelCountSchema = exports.audioChannelSchema = exports.booleanSchema = void 0;
+exports.fileSchema = exports.bitrateVapixParamsSchema = exports.bitrateModeSchema = exports.wsAliasResponseSchema = exports.keyboardShortcutsSchema = exports.keyboardShortcutSchema = exports.networkCameraListSchema = exports.storageTypeSchema = exports.sdCardStorageTypeSchema = exports.flashStorageTypeSchema = exports.h264ProfileSchema = exports.audioChannelCountSchema = exports.audioChannelSchema = exports.booleanSchema = void 0;
 const zod_1 = require("zod");
 exports.booleanSchema = zod_1.z.union([zod_1.z.literal(0), zod_1.z.literal(1)]);
 exports.audioChannelSchema = zod_1.z.union([zod_1.z.literal('mono'), zod_1.z.literal('stereo')]);
@@ -15,6 +15,11 @@ exports.networkCameraListSchema = zod_1.z.array(zod_1.z.object({
 }));
 exports.keyboardShortcutSchema = zod_1.z.string().nullable();
 exports.keyboardShortcutsSchema = zod_1.z.record(exports.keyboardShortcutSchema);
+exports.wsAliasResponseSchema = zod_1.z.object({
+    alias: zod_1.z.string(),
+    ws: zod_1.z.string(),
+    ws_initial_message: zod_1.z.string(),
+});
 exports.bitrateModeSchema = zod_1.z.union([zod_1.z.literal('VBR'), zod_1.z.literal('MBR'), zod_1.z.literal('ABR')]);
 exports.bitrateVapixParamsSchema = zod_1.z.object({
     bitrateMode: exports.bitrateModeSchema,

package/esm/CamOverlayAPI.js

@@ -1,5 +1,5 @@
 import { ErrorWithResponse, ServiceNotFoundError, StorageDataFetchError } from './errors/errors';
-import { networkCameraListSchema } from './types/common';
+import { networkCameraListSchema, wsAliasResponseSchema } from './types/common';
 import { z } from 'zod';
 import { ImageType, serviceListSchema, servicesSchema, wsResponseSchema, getStorageDataListSchema, getFileListSchema, } from './types/CamOverlayAPI';
 import { BasicAPI } from './internal/BasicAPI';
@@ -26,6 +26,22 @@ export class CamOverlayAPI extends BasicAPI {
     async getMjpegStreamImage(mjpegUrl, options) {
         return await this._getBlob(`${BASE_PATH}/fetch_mjpeg_image.cgi`, { mjpeg_url: decodeURIComponent(mjpegUrl) }, options);
     }
+    async isViewerPassValid(pass, options) {
+        const res = await this._getJson(`${BASE_PATH}/check_pass.cgi`, { pass }, options);
+        if (res.status !== 200) {
+            throw new Error(res.message);
+        }
+        return res.data === '1';
+    }
+    async getLiveViewAlias(rtspUrl, options) {
+        const agent = this.getClient(options?.proxyParams);
+        const res = await agent.get({
+            path: `${BASE_PATH}/getLiveViewAlias.cgi`,
+            parameters: { rtsp_url: rtspUrl },
+            timeout: options?.timeout,
+        });
+        return wsAliasResponseSchema.parse(await res.json());
+    }
     async listFiles(fileType, options) {
         const res = await this._getJson(`${BASE_PATH}/upload_${fileType}.cgi`, { action: 'list' }, options);
         return getFileListSchema(fileType).parse(res.list);

package/esm/PlaneTrackerAPI.js

@@ -1,6 +1,7 @@
 import { z } from 'zod';
-import { blackListSchema, cameraSettingsSchema, domainListSchema, flightInfoSchema, getIcaoSchema, mapInfoSchema, milestoneCameraListSchema, priorityListSchema, serverSettingsSchema, trackingModeSchema, whiteListSchema, wsAliasResponseSchema, zonesSchema, } from './types/PlaneTrackerAPI';
+import { blackListSchema, cameraSettingsSchema, domainListSchema, flightInfoSchema, getIcaoSchema, mapInfoSchema, milestoneCameraListSchema, priorityListSchema, serverSettingsSchema, trackingModeSchema, whiteListSchema, zonesSchema, } from './types/PlaneTrackerAPI';
 import { CannotSetCoordsInAutoModeError, ImportSettingsError, InvalidAltitudeError, InvalidLatLngError, ResetCalibrationError, ServerError, BadRequestError, } from './errors/errors';
+import { wsAliasResponseSchema } from './types/common';
 import { BasicAPI } from './internal/BasicAPI';
 import { apiUserInputSchema } from './types/ws/PlaneTrackerEvents';
 const BASE_PATH = '/local/planetracker';

package/esm/types/PlaneTrackerAPI.js

@@ -1,9 +1,4 @@
 import { z } from 'zod';
-export const wsAliasResponseSchema = z.object({
-    alias: z.string(),
-    ws: z.string(),
-    ws_initial_message: z.string(),
-});
 export const connectionSchema = z.object({
     protocol: z.union([z.literal('http'), z.literal('https'), z.literal('https_insecure')]),
     ip: z.union([z.string().ip(), z.literal('')]),

package/esm/types/common.js

@@ -12,6 +12,11 @@ export const networkCameraListSchema = z.array(z.object({
 }));
 export const keyboardShortcutSchema = z.string().nullable();
 export const keyboardShortcutsSchema = z.record(keyboardShortcutSchema);
+export const wsAliasResponseSchema = z.object({
+    alias: z.string(),
+    ws: z.string(),
+    ws_initial_message: z.string(),
+});
 export const bitrateModeSchema = z.union([z.literal('VBR'), z.literal('MBR'), z.literal('ABR')]);
 export const bitrateVapixParamsSchema = z.object({
     bitrateMode: bitrateModeSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "camstreamerlib",
-  "version": "4.0.33-55dd1f0",
+  "version": "4.0.33-71913af",
   "description": "Helper library for CamStreamer ACAP applications.",
   "prettier": "@camstreamer/prettier-config",
   "engine": {

package/types/CamOverlayAPI.d.ts

@@ -14,6 +14,12 @@ export declare class CamOverlayAPI<Client extends IClient<TResponse, any>> exten
     }[]>;
     wsAuthorization(options?: THttpRequestOptions): Promise<string>;
     getMjpegStreamImage(mjpegUrl: string, options?: THttpRequestOptions): Promise<ReturnType<Awaited<ReturnType<Client["get"]>>["blob"]>>;
+    isViewerPassValid(pass: string, options?: THttpRequestOptions): Promise<boolean>;
+    getLiveViewAlias(rtspUrl: string, options?: THttpRequestOptions): Promise<{
+        alias: string;
+        ws: string;
+        ws_initial_message: string;
+    }>;
     listFiles<T extends TFileType>(fileType: T, options?: THttpRequestOptions): Promise<TFileList<T>>;
     uploadFile<T extends TFileType>(fileType: T, formData: Parameters<Client['post']>[0]['data'], storage: TFileStorageType<T>, options?: THttpRequestOptions): Promise<void>;
     removeFile<T extends TFileType>(fileType: T, fileParams: TFile<T>, options?: THttpRequestOptions): Promise<void>;

package/types/CamSwitcherAPI.d.ts

@@ -28,9 +28,9 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> exte
     }[]>;
     wsAuthorization(options?: THttpRequestOptions): Promise<string>;
     getOutputInfo(options?: THttpRequestOptions): Promise<{
-        rtspUrl: string;
         ws: string;
         wsInitialMessage: string;
+        rtspUrl: string;
     }>;
     getAudioPushInfo(options?: THttpRequestOptions): Promise<{
         ws: string;

package/types/PlaneTrackerAPI.d.ts

@@ -12,9 +12,9 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
     checkCameraTime(options?: THttpRequestOptions): Promise<boolean>;
     serverRunCheck(options?: THttpRequestOptions): Promise<boolean>;
     getLiveViewAlias(rtspUrl: string, options?: THttpRequestOptions): Promise<{
+        alias: string;
         ws: string;
         ws_initial_message: string;
-        alias: string;
     }>;
     resetPtzCalibration(options?: THttpRequestOptions): Promise<void>;
     resetFocusCalibration(options?: THttpRequestOptions): Promise<void>;

package/types/types/CamSwitcherAPI.d.ts

@@ -25,21 +25,21 @@ export declare const outputInfoSchema: z.ZodEffects<z.ZodObject<{
     ws: z.ZodString;
     ws_initial_message: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    rtsp_url: string;
     ws: string;
     ws_initial_message: string;
-}, {
     rtsp_url: string;
+}, {
     ws: string;
     ws_initial_message: string;
+    rtsp_url: string;
 }>, {
-    rtspUrl: string;
     ws: string;
     wsInitialMessage: string;
+    rtspUrl: string;
 }, {
-    rtsp_url: string;
     ws: string;
     ws_initial_message: string;
+    rtsp_url: string;
 }>;
 export type TOutputInfo = z.infer<typeof outputInfoSchema>;
 export declare const audioPushInfoSchema: z.ZodEffects<z.ZodObject<{

package/types/types/PlaneTrackerAPI.d.ts

@@ -1,19 +1,6 @@
 import { z } from 'zod';
 export type TImportDataType = 'MAP_DATA' | 'SERVER_DATA' | 'ALL';
 export type TExportDataType = 'NIGHT_SKY_CALIBRATION_DATA' | 'ALL';
-export declare const wsAliasResponseSchema: z.ZodObject<{
-    alias: z.ZodString;
-    ws: z.ZodString;
-    ws_initial_message: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    ws: string;
-    ws_initial_message: string;
-    alias: string;
-}, {
-    ws: string;
-    ws_initial_message: string;
-    alias: string;
-}>;
 export declare const connectionSchema: z.ZodObject<{
     protocol: z.ZodUnion<[z.ZodLiteral<"http">, z.ZodLiteral<"https">, z.ZodLiteral<"https_insecure">]>;
     ip: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;

package/types/types/common.d.ts

@@ -26,6 +26,19 @@ export declare const keyboardShortcutSchema: z.ZodNullable<z.ZodString>;
 export declare const keyboardShortcutsSchema: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
 export type TKeyboardShortcut = z.infer<typeof keyboardShortcutSchema>;
 export type TKeyboardShortcuts = z.infer<typeof keyboardShortcutsSchema>;
+export declare const wsAliasResponseSchema: z.ZodObject<{
+    alias: z.ZodString;
+    ws: z.ZodString;
+    ws_initial_message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    alias: string;
+    ws: string;
+    ws_initial_message: string;
+}, {
+    alias: string;
+    ws: string;
+    ws_initial_message: string;
+}>;
 export type TProxyTarget = {
     ip: string;
     mdnsName: string;