camstreamerlib 4.0.5 → 4.0.7

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, TTypePriorityList, 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>;
@@ -185,14 +186,31 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
     startTrackingPlane(icao: ICAO, options?: THttpRequestOptions): Promise<void>;
     stopTrackingPlane(options?: THttpRequestOptions): Promise<void>;
     getIcao(by: TGetIcaoByOption, value: string, options?: THttpRequestOptions): Promise<string>;
-    getPriorityList(options?: THttpRequestOptions): Promise<string[]>;
-    setPriorityList(priorityList: TPriorityList['priorityList'], options?: THttpRequestOptions): Promise<void>;
-    getTypePriorityList(options?: THttpRequestOptions): Promise<string[]>;
-    setTypePriorityList(typePriorityList: TTypePriorityList['typePriorityList'], options?: THttpRequestOptions): Promise<void>;
-    getWhiteList(options?: THttpRequestOptions): Promise<string[]>;
-    setWhiteList(whiteList: TWhiteList['whiteList'], options?: THttpRequestOptions): Promise<void>;
-    getBlackList(options?: THttpRequestOptions): Promise<string[]>;
-    setBlackList(blackList: TBlackList['blackList'], options?: THttpRequestOptions): Promise<void>;
+    getPriorityList(options?: THttpRequestOptions): Promise<{
+        list: {
+            priority: number;
+            domain: "adsb" | "remoteId";
+            idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+            idValue: string;
+        }[];
+    }>;
+    setPriorityList(priorityList: TPriorityList, options?: THttpRequestOptions): Promise<void>;
+    getWhiteList(options?: THttpRequestOptions): Promise<{
+        list: {
+            domain: "adsb" | "remoteId";
+            idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+            idValue: string;
+        }[];
+    }>;
+    setWhiteList(whiteList: TWhiteList, options?: THttpRequestOptions): Promise<void>;
+    getBlackList(options?: THttpRequestOptions): Promise<{
+        list: {
+            domain: "adsb" | "remoteId";
+            idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+            idValue: string;
+        }[];
+    }>;
+    setBlackList(blackList: TBlackList, options?: THttpRequestOptions): Promise<void>;
     fetchMapInfo(options?: THttpRequestOptions): Promise<{
         minZoom: number;
         maxZoom: number;

package/cjs/PlaneTrackerAPI.js

@@ -121,31 +121,24 @@ class PlaneTrackerAPI extends BasicAPI_1.BasicAPI {
     }
     async getPriorityList(options) {
         const res = await this._getJson(`${BASE_PATH}/package/getPriorityList.cgi`, undefined, options);
-        return PlaneTrackerAPI_1.priorityListSchema.parse(res).priorityList;
+        return PlaneTrackerAPI_1.priorityListSchema.parse(res);
     }
     async setPriorityList(priorityList, options) {
-        await this._postJsonEncoded(`${BASE_PATH}/package/setPriorityList.cgi`, { priorityList }, this.apiUser, options);
-    }
-    async getTypePriorityList(options) {
-        const res = await this._getJson(`${BASE_PATH}/package/getTypePriorityList.cgi`, undefined, options);
-        return PlaneTrackerAPI_1.typePriorityListSchema.parse(res).typePriorityList;
-    }
-    async setTypePriorityList(typePriorityList, options) {
-        await this._postJsonEncoded(`${BASE_PATH}/package/setTypePriorityList.cgi`, { typePriorityList }, this.apiUser, options);
+        await this._postJsonEncoded(`${BASE_PATH}/package/setPriorityList.cgi`, priorityList, this.apiUser, options);
     }
     async getWhiteList(options) {
         const res = await this._getJson(`${BASE_PATH}/package/getWhiteList.cgi`, undefined, options);
-        return PlaneTrackerAPI_1.whiteListSchema.parse(res).whiteList;
+        return PlaneTrackerAPI_1.whiteListSchema.parse(res);
     }
     async setWhiteList(whiteList, options) {
-        await this._postJsonEncoded(`${BASE_PATH}/package/setWhiteList.cgi`, { whiteList }, this.apiUser, options);
+        await this._postJsonEncoded(`${BASE_PATH}/package/setWhiteList.cgi`, whiteList, this.apiUser, options);
     }
     async getBlackList(options) {
         const res = await this._getJson(`${BASE_PATH}/package/getBlackList.cgi`, undefined, options);
-        return PlaneTrackerAPI_1.blackListSchema.parse(res).blackList;
+        return PlaneTrackerAPI_1.blackListSchema.parse(res);
     }
     async setBlackList(blackList, options) {
-        await this._postJsonEncoded(`${BASE_PATH}/package/setBlackList.cgi`, { blackList }, this.apiUser, options);
+        await this._postJsonEncoded(`${BASE_PATH}/package/setBlackList.cgi`, blackList, this.apiUser, options);
     }
     async fetchMapInfo(options) {
         const res = await this._getJson(`${BASE_PATH}/package/getMapInfo.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;
@@ -804,38 +799,132 @@ export declare const flightInfoSchema: z.ZodObject<{
     }[] | undefined;
 }>;
 export type TFlightInfo = z.infer<typeof flightInfoSchema>;
-export declare const typePriorityListSchema: z.ZodObject<{
-    typePriorityList: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+export declare const listEntryDomainSchema: z.ZodEnum<["adsb", "remoteId"]>;
+export declare const listEntryIdTypeSchema: z.ZodEnum<["icao", "type_icao", "drone_mac", "operator_mac", "category"]>;
+export type TListEntryDomain = z.infer<typeof listEntryDomainSchema>;
+export type TListEntryIdType = z.infer<typeof listEntryIdTypeSchema>;
+export declare const listEntrySchema: z.ZodObject<{
+    domain: z.ZodEnum<["adsb", "remoteId"]>;
+    idType: z.ZodEnum<["icao", "type_icao", "drone_mac", "operator_mac", "category"]>;
+    idValue: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    typePriorityList: string[];
+    domain: "adsb" | "remoteId";
+    idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+    idValue: string;
 }, {
-    typePriorityList?: string[] | undefined;
+    domain: "adsb" | "remoteId";
+    idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+    idValue: string;
 }>;
-export type TTypePriorityList = z.infer<typeof typePriorityListSchema>;
-export declare const priorityListSchema: z.ZodObject<{
-    priorityList: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+export declare const priorityListEntrySchema: z.ZodObject<{
+    domain: z.ZodEnum<["adsb", "remoteId"]>;
+    idType: z.ZodEnum<["icao", "type_icao", "drone_mac", "operator_mac", "category"]>;
+    idValue: z.ZodString;
+} & {
+    priority: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    priorityList: string[];
+    priority: number;
+    domain: "adsb" | "remoteId";
+    idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+    idValue: string;
 }, {
-    priorityList?: string[] | undefined;
+    priority: number;
+    domain: "adsb" | "remoteId";
+    idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+    idValue: string;
 }>;
-export type TPriorityList = z.infer<typeof priorityListSchema>;
+export type TListEntry = z.infer<typeof listEntrySchema>;
+export type TPriorityListEntry = z.infer<typeof priorityListEntrySchema>;
 export declare const whiteListSchema: z.ZodObject<{
-    whiteList: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    list: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        domain: z.ZodEnum<["adsb", "remoteId"]>;
+        idType: z.ZodEnum<["icao", "type_icao", "drone_mac", "operator_mac", "category"]>;
+        idValue: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }, {
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }>, "many">>;
 }, "strip", z.ZodTypeAny, {
-    whiteList: string[];
+    list: {
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }[];
 }, {
-    whiteList?: string[] | undefined;
+    list?: {
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }[] | undefined;
 }>;
-export type TWhiteList = z.infer<typeof whiteListSchema>;
 export declare const blackListSchema: z.ZodObject<{
-    blackList: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    list: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        domain: z.ZodEnum<["adsb", "remoteId"]>;
+        idType: z.ZodEnum<["icao", "type_icao", "drone_mac", "operator_mac", "category"]>;
+        idValue: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }, {
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    list: {
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }[];
+}, {
+    list?: {
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }[] | undefined;
+}>;
+export declare const priorityListSchema: z.ZodObject<{
+    list: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        domain: z.ZodEnum<["adsb", "remoteId"]>;
+        idType: z.ZodEnum<["icao", "type_icao", "drone_mac", "operator_mac", "category"]>;
+        idValue: z.ZodString;
+    } & {
+        priority: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        priority: number;
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }, {
+        priority: number;
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }>, "many">>;
 }, "strip", z.ZodTypeAny, {
-    blackList: string[];
+    list: {
+        priority: number;
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }[];
 }, {
-    blackList?: string[] | undefined;
+    list?: {
+        priority: number;
+        domain: "adsb" | "remoteId";
+        idType: "icao" | "type_icao" | "drone_mac" | "operator_mac" | "category";
+        idValue: string;
+    }[] | undefined;
 }>;
+export type TWhiteList = z.infer<typeof whiteListSchema>;
 export type TBlackList = z.infer<typeof blackListSchema>;
+export type TPriorityList = z.infer<typeof priorityListSchema>;
 export declare const mapTypeSchema: z.ZodEnum<["roadmap", "satellite"]>;
 export type TMapType = z.infer<typeof mapTypeSchema>;
 export declare const mapInfoSchema: z.ZodObject<{
@@ -946,4 +1035,43 @@ 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>;
+export type TCategoryIcon = 'small' | 'large' | 'heavy' | 'helicopter' | 'drone' | 'operator' | 'unknown';
+export type TCategoryDescriptor = {
+    categoryId: string;
+    uiName: string;
+    icon: TCategoryIcon;
+};
+export type TDomainDescriptor = {
+    uiName: string;
+    icon: TCategoryIcon;
+    categoryList: TCategoryDescriptor[];
+};
+export type TDomainList = Record<TDomainId, TDomainDescriptor>;
+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.blackListSchema = exports.whiteListSchema = exports.priorityListSchema = exports.typePriorityListSchema = 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.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(),
@@ -280,17 +280,24 @@ exports.flightInfoSchema = zod_1.z.object({
     }))
         .optional(),
 });
-exports.typePriorityListSchema = zod_1.z.object({
-    typePriorityList: zod_1.z.array(zod_1.z.string()).default([]),
+exports.listEntryDomainSchema = zod_1.z.enum(['adsb', 'remoteId']);
+exports.listEntryIdTypeSchema = zod_1.z.enum(['icao', 'type_icao', 'drone_mac', 'operator_mac', 'category']);
+exports.listEntrySchema = zod_1.z.object({
+    domain: exports.listEntryDomainSchema,
+    idType: exports.listEntryIdTypeSchema,
+    idValue: zod_1.z.string().min(1),
 });
-exports.priorityListSchema = zod_1.z.object({
-    priorityList: zod_1.z.array(zod_1.z.string()).default([]),
+exports.priorityListEntrySchema = exports.listEntrySchema.extend({
+    priority: zod_1.z.number().int().min(1),
 });
 exports.whiteListSchema = zod_1.z.object({
-    whiteList: zod_1.z.array(zod_1.z.string()).default([]),
+    list: zod_1.z.array(exports.listEntrySchema).default([]),
 });
 exports.blackListSchema = zod_1.z.object({
-    blackList: zod_1.z.array(zod_1.z.string()).default([]),
+    list: zod_1.z.array(exports.listEntrySchema).default([]),
+});
+exports.priorityListSchema = zod_1.z.object({
+    list: zod_1.z.array(exports.priorityListEntrySchema).default([]),
 });
 exports.mapTypeSchema = zod_1.z.enum(['roadmap', 'satellite']);
 exports.mapInfoSchema = zod_1.z.object({
@@ -319,3 +326,29 @@ exports.zonesSchema = zod_1.z.object({
     }))
         .default([]),
 });
+exports.domainIdSchema = zod_1.z.enum(['adsb', 'remoteId']);
+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',
+};