camstreamerlib 4.0.6 → 4.0.8

package/cjs/PlaneTrackerAPI.d.ts

@@ -1,10 +1,11 @@
 import { IClient, TResponse } from './internal/types';
-import { ICAO, TApiUser, TBlackList, TCameraSettings, TExportDataType, TGetIcaoByOption, TImportDataType, TPriorityList, TTrackingMode, TWhiteList, TZones } from './types/PlaneTrackerAPI';
+import { ICAO, TBlackList, TCameraSettings, TExportDataType, TGetIcaoByOption, TImportDataType, TPriorityList, TTrackingMode, TWhiteList, TZones } from './types/PlaneTrackerAPI';
 import { THttpRequestOptions } from './types/common';
 import { BasicAPI } from './internal/BasicAPI';
+import { TApiUser } from './types/ws/PlaneTrackerEvents';
 export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> extends BasicAPI<Client> {
     private apiUser;
-    constructor(client: Client, apiUser: TApiUser);
+    constructor(client: Client, apiUser: Omit<TApiUser, 'ip'>);
     static getProxyPath: () => string;
     static getWsEventsPath: () => string;
     checkAPIAvailable(options?: THttpRequestOptions): Promise<void>;
@@ -157,7 +158,16 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
     }>;
     exportAppSettings(dataType: TExportDataType, options?: THttpRequestOptions): Promise<ReturnType<Awaited<ReturnType<Client["get"]>>["blob"]>>;
     importAppSettings(dataType: TImportDataType, formData: Parameters<Client['post']>[0]['data'], options?: THttpRequestOptions): Promise<void>;
-    fetchFlightInfo(icao: ICAO, options?: THttpRequestOptions): Promise<{
+    getDomainList(options?: THttpRequestOptions): Promise<Partial<Record<"adsb" | "remoteId", {
+        uiName: string;
+        icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+        categoryList: {
+            categoryId: string;
+            uiName: string;
+            icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+        }[];
+    }>>>;
+    fetchFlightInfo(targetId: string, options?: THttpRequestOptions): Promise<{
         destinationAirport: {
             icao?: string | undefined;
             iata?: string | undefined;
@@ -184,6 +194,8 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
     setTrackingMode(mode: TTrackingMode['mode'], options?: THttpRequestOptions): Promise<void>;
     startTrackingPlane(icao: ICAO, options?: THttpRequestOptions): Promise<void>;
     stopTrackingPlane(options?: THttpRequestOptions): Promise<void>;
+    startTrackingTarget(targetId: string, options?: THttpRequestOptions): Promise<void>;
+    stopTrackingTarget(options?: THttpRequestOptions): Promise<void>;
     getIcao(by: TGetIcaoByOption, value: string, options?: THttpRequestOptions): Promise<string>;
     getPriorityList(options?: THttpRequestOptions): Promise<{
         list: {

package/cjs/PlaneTrackerAPI.js

@@ -88,8 +88,12 @@ class PlaneTrackerAPI extends BasicAPI_1.BasicAPI {
             throw new errors_1.ImportSettingsError(res);
         }
     }
-    async fetchFlightInfo(icao, options) {
-        const res = await this._getJson(`${BASE_PATH}/package/flightInfo.cgi`, { icao }, options);
+    async getDomainList(options) {
+        const res = await this._getJson(`${BASE_PATH}/getDomainList.cgi`, { action: 'get' }, options);
+        return PlaneTrackerAPI_1.domainListSchema.parse(res);
+    }
+    async fetchFlightInfo(targetId, options) {
+        const res = await this._getJson(`${BASE_PATH}/package/flightInfo.cgi`, { targetId }, options);
         return PlaneTrackerAPI_1.flightInfoSchema.parse(res);
     }
     async getTrackingMode(options) {
@@ -115,9 +119,25 @@ class PlaneTrackerAPI extends BasicAPI_1.BasicAPI {
             timeout: options?.timeout,
         });
     }
+    async startTrackingTarget(targetId, options) {
+        const agent = this.getClient(options?.proxyParams);
+        await agent.get({
+            path: `${BASE_PATH}/package/trackTarget.cgi`,
+            parameters: { targetId, ...this.apiUser },
+            timeout: options?.timeout,
+        });
+    }
+    async stopTrackingTarget(options) {
+        const agent = this.getClient(options?.proxyParams);
+        await agent.get({
+            path: `${BASE_PATH}/package/resetTarget.cgi`,
+            parameters: this.apiUser,
+            timeout: options?.timeout,
+        });
+    }
     async getIcao(by, value, options) {
         const res = await this._getJson(`${BASE_PATH}/package/getIcao.cgi`, { [by]: value }, options);
-        return PlaneTrackerAPI_1.getIcaoSchema.parse(res).icao;
+        return PlaneTrackerAPI_1.getIcaoSchema.parse(res).targetId;
     }
     async getPriorityList(options) {
         const res = await this._getJson(`${BASE_PATH}/package/getPriorityList.cgi`, undefined, options);

package/cjs/types/PlaneTrackerAPI.d.ts

@@ -1,11 +1,6 @@
 import { z } from 'zod';
 export type TImportDataType = 'MAP_DATA' | 'SERVER_DATA' | 'ALL';
 export type TExportDataType = 'NIGHT_SKY_CALIBRATION_DATA' | 'ALL';
-export type TApiUser = {
-    userId: string;
-    userName: string;
-    userPriority: number;
-};
 export declare const wsAliasResponseSchema: z.ZodObject<{
     alias: z.ZodString;
     ws: z.ZodString;
@@ -706,10 +701,13 @@ export type TServerSettings = z.infer<typeof serverSettingsSchema>;
 export type ICAO = string;
 export declare const getIcaoSchema: z.ZodObject<{
     icao: z.ZodString;
+    targetId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     icao: string;
+    targetId: string;
 }, {
     icao: string;
+    targetId: string;
 }>;
 export type TGetIcaoByOption = 'registration' | 'callsign';
 export declare const trackingModeSchema: z.ZodObject<{
@@ -1040,4 +1038,115 @@ export declare const zonesSchema: z.ZodObject<{
     }[] | undefined;
 }>;
 export type TZones = z.infer<typeof zonesSchema>;
+export declare const domainIdSchema: z.ZodEnum<["adsb", "remoteId"]>;
+export type TDomainId = z.infer<typeof domainIdSchema>;
+declare const categoryIconSchema: z.ZodEnum<["small", "large", "heavy", "helicopter", "drone", "operator", "unknown"]>;
+export type TCategoryIcon = z.infer<typeof categoryIconSchema>;
+declare const categoryDescriptorSchema: z.ZodObject<{
+    categoryId: z.ZodString;
+    uiName: z.ZodString;
+    icon: z.ZodEnum<["small", "large", "heavy", "helicopter", "drone", "operator", "unknown"]>;
+}, "strip", z.ZodTypeAny, {
+    categoryId: string;
+    uiName: string;
+    icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+}, {
+    categoryId: string;
+    uiName: string;
+    icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+}>;
+export type TCategoryDescriptor = z.infer<typeof categoryDescriptorSchema>;
+declare const domainDescriptorSchema: z.ZodObject<{
+    uiName: z.ZodString;
+    icon: z.ZodEnum<["small", "large", "heavy", "helicopter", "drone", "operator", "unknown"]>;
+    categoryList: z.ZodArray<z.ZodObject<{
+        categoryId: z.ZodString;
+        uiName: z.ZodString;
+        icon: z.ZodEnum<["small", "large", "heavy", "helicopter", "drone", "operator", "unknown"]>;
+    }, "strip", z.ZodTypeAny, {
+        categoryId: string;
+        uiName: string;
+        icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    }, {
+        categoryId: string;
+        uiName: string;
+        icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    uiName: string;
+    icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    categoryList: {
+        categoryId: string;
+        uiName: string;
+        icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    }[];
+}, {
+    uiName: string;
+    icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    categoryList: {
+        categoryId: string;
+        uiName: string;
+        icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    }[];
+}>;
+export type TDomainDescriptor = z.infer<typeof domainDescriptorSchema>;
+export declare const domainListSchema: z.ZodRecord<z.ZodEnum<["adsb", "remoteId"]>, z.ZodObject<{
+    uiName: z.ZodString;
+    icon: z.ZodEnum<["small", "large", "heavy", "helicopter", "drone", "operator", "unknown"]>;
+    categoryList: z.ZodArray<z.ZodObject<{
+        categoryId: z.ZodString;
+        uiName: z.ZodString;
+        icon: z.ZodEnum<["small", "large", "heavy", "helicopter", "drone", "operator", "unknown"]>;
+    }, "strip", z.ZodTypeAny, {
+        categoryId: string;
+        uiName: string;
+        icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    }, {
+        categoryId: string;
+        uiName: string;
+        icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    uiName: string;
+    icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    categoryList: {
+        categoryId: string;
+        uiName: string;
+        icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    }[];
+}, {
+    uiName: string;
+    icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    categoryList: {
+        categoryId: string;
+        uiName: string;
+        icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator";
+    }[];
+}>>;
+export type TDomainList = z.infer<typeof domainListSchema>;
+export declare const ADSB_CATEGORY_IDS: {
+    readonly A_LIGHT: "A_LIGHT";
+    readonly A_SMALL: "A_SMALL";
+    readonly A_LARGE: "A_LARGE";
+    readonly A_HIGH_VORTEX: "A_HIGH_VORTEX";
+    readonly A_HEAVY: "A_HEAVY";
+    readonly A_HIGH_PERF: "A_HIGH_PERF";
+    readonly A_ROTORCRAFT: "A_ROTORCRAFT";
+    readonly B_GLIDER: "B_GLIDER";
+    readonly B_LIGHTER_THAN_AIR: "B_LIGHTER_THAN_AIR";
+    readonly B_PARACHUTIST: "B_PARACHUTIST";
+    readonly B_ULTRALIGHT: "B_ULTRALIGHT";
+    readonly B_UAV: "B_UAV";
+    readonly B_SPACE: "B_SPACE";
+    readonly C_SURFACE_EMERGENCY: "C_SURFACE_EMERGENCY";
+    readonly C_SERVICE_VEHICLE: "C_SERVICE_VEHICLE";
+    readonly C_POINT_OBSTACLE: "C_POINT_OBSTACLE";
+    readonly C_CLUSTER_OBSTACLE: "C_CLUSTER_OBSTACLE";
+    readonly C_LINE_OBSTACLE: "C_LINE_OBSTACLE";
+    readonly UNKNOWN: "UNKNOWN";
+};
+export declare const REMOTE_ID_CATEGORY_IDS: {
+    readonly DRONE: "DRONE";
+    readonly OPERATOR: "OPERATOR";
+};
 export {};

package/cjs/types/PlaneTrackerAPI.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.zonesSchema = exports.mapInfoSchema = exports.mapTypeSchema = 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.connectionSchema = exports.wsAliasResponseSchema = void 0;
+exports.REMOTE_ID_CATEGORY_IDS = exports.ADSB_CATEGORY_IDS = exports.domainListSchema = exports.domainIdSchema = exports.zonesSchema = exports.mapInfoSchema = exports.mapTypeSchema = 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.connectionSchema = exports.wsAliasResponseSchema = void 0;
 const zod_1 = require("zod");
 exports.wsAliasResponseSchema = zod_1.z.object({
     alias: zod_1.z.string(),
@@ -251,6 +251,7 @@ exports.serverSettingsSchema = zod_1.z.object({
 });
 exports.getIcaoSchema = zod_1.z.object({
     icao: zod_1.z.string(),
+    targetId: zod_1.z.string(),
 });
 exports.trackingModeSchema = zod_1.z.object({
     mode: zod_1.z.union([zod_1.z.literal('MANUAL'), zod_1.z.literal('AUTOMATIC')]).default('AUTOMATIC'),
@@ -326,3 +327,41 @@ exports.zonesSchema = zod_1.z.object({
     }))
         .default([]),
 });
+exports.domainIdSchema = zod_1.z.enum(['adsb', 'remoteId']);
+const categoryIconSchema = zod_1.z.enum(['small', 'large', 'heavy', 'helicopter', 'drone', 'operator', 'unknown']);
+const categoryDescriptorSchema = zod_1.z.object({
+    categoryId: zod_1.z.string(),
+    uiName: zod_1.z.string(),
+    icon: categoryIconSchema,
+});
+const domainDescriptorSchema = zod_1.z.object({
+    uiName: zod_1.z.string(),
+    icon: categoryIconSchema,
+    categoryList: zod_1.z.array(categoryDescriptorSchema),
+});
+exports.domainListSchema = zod_1.z.record(exports.domainIdSchema, domainDescriptorSchema);
+exports.ADSB_CATEGORY_IDS = {
+    A_LIGHT: 'A_LIGHT',
+    A_SMALL: 'A_SMALL',
+    A_LARGE: 'A_LARGE',
+    A_HIGH_VORTEX: 'A_HIGH_VORTEX',
+    A_HEAVY: 'A_HEAVY',
+    A_HIGH_PERF: 'A_HIGH_PERF',
+    A_ROTORCRAFT: 'A_ROTORCRAFT',
+    B_GLIDER: 'B_GLIDER',
+    B_LIGHTER_THAN_AIR: 'B_LIGHTER_THAN_AIR',
+    B_PARACHUTIST: 'B_PARACHUTIST',
+    B_ULTRALIGHT: 'B_ULTRALIGHT',
+    B_UAV: 'B_UAV',
+    B_SPACE: 'B_SPACE',
+    C_SURFACE_EMERGENCY: 'C_SURFACE_EMERGENCY',
+    C_SERVICE_VEHICLE: 'C_SERVICE_VEHICLE',
+    C_POINT_OBSTACLE: 'C_POINT_OBSTACLE',
+    C_CLUSTER_OBSTACLE: 'C_CLUSTER_OBSTACLE',
+    C_LINE_OBSTACLE: 'C_LINE_OBSTACLE',
+    UNKNOWN: 'UNKNOWN',
+};
+exports.REMOTE_ID_CATEGORY_IDS = {
+    DRONE: 'DRONE',
+    OPERATOR: 'OPERATOR',
+};