camstreamerlib 4.0.17-dev-milestone.0 → 4.0.17-dev-milestone.2

package/cjs/PlaneTrackerAPI.d.ts

@@ -1,5 +1,5 @@
 import { IClient, TResponse } from './internal/types';
-import { ICAO, TBlackList, TCameraSettings, TExportDataType, TGetIcaoByOption, TImportDataType, TPriorityList, TTrackingMode, TWhiteList, TZones } from './types/PlaneTrackerAPI';
+import { ICAO, TBlackList, TCameraSettings, TConnection, TExportDataType, TGetIcaoByOption, TImportDataType, TMilestoneCameraOption, TPriorityList, TTrackingMode, TWhiteList, TZones } from './types/PlaneTrackerAPI';
 import { THttpRequestOptions } from './types/common';
 import { BasicAPI } from './internal/BasicAPI';
 import { TApiUser } from './types/ws/PlaneTrackerEvents';
@@ -259,5 +259,7 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
     }>;
     setZones(zones: TZones, options?: THttpRequestOptions): Promise<void>;
     goToCoordinates(lat: number, lon: number, alt?: number, options?: THttpRequestOptions): Promise<void>;
+    checkMilestoneConnection(params: TConnection, options?: THttpRequestOptions): Promise<boolean>;
+    getMilestoneCameraList(params: TConnection, options?: THttpRequestOptions): Promise<TMilestoneCameraOption[]>;
     downloadReport(options?: THttpRequestOptions): Promise<string>;
 }

package/cjs/PlaneTrackerAPI.js

@@ -196,6 +196,19 @@ class PlaneTrackerAPI extends BasicAPI_1.BasicAPI {
             }
         }
     }
+    async checkMilestoneConnection(params, options) {
+        try {
+            await this._postUrlEncoded(`${BASE_PATH}/package/checkMilestoneConnection.cgi`, { ...params }, options);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    async getMilestoneCameraList(params, options) {
+        const res = await this._postUrlEncoded(`${BASE_PATH}/package/getMilestoneCameraList.cgi`, { ...params }, options);
+        return PlaneTrackerAPI_1.milestoneCameraListSchema.parse(await res.json());
+    }
     downloadReport(options) {
         return this._getText(`${BASE_PATH}/report.cgi`, undefined, options);
     }

package/cjs/node/events/MilestoneAgent.js

@@ -27,11 +27,11 @@ class MilestoneAgent {
     }
     async checkConnection() {
         await this.getToken(true);
-        await this.getCamerasPage(1, 1);
+        await this.getCamerasPage(0, 1);
     }
     async getAllCameras() {
         const cameras = [];
-        let page = 1;
+        let page = 0;
         for (;;) {
             const pageCameras = await this.getCamerasPage(page, PAGE_SIZE);
             cameras.push(...pageCameras);
@@ -55,9 +55,9 @@ class MilestoneAgent {
             throw new errors_1.ErrorWithResponse(res);
         }
     }
-    async getCamerasPage(page, itemsPerPage) {
+    async getCamerasPage(page, size) {
         const token = await this.getToken();
-        const res = await this.sender.sendRequest(this.getRequestOptions('GET', `/api/rest/v1/cameras?page=${page}&itemsPerPage=${itemsPerPage}`, token));
+        const res = await this.sender.sendRequest(this.getRequestOptions('GET', `/api/rest/v1/cameras?page=${page}&size=${size}`, token));
         if (!res.ok) {
             throw new errors_1.ErrorWithResponse(res);
         }

package/cjs/types/PlaneTrackerAPI.d.ts

@@ -33,6 +33,21 @@ export declare const connectionSchema: z.ZodObject<{
     user: string;
     protocol: "https" | "http" | "https_insecure";
 }>;
+export type TConnection = z.infer<typeof connectionSchema>;
+export declare const milestoneCameraListSchema: z.ZodArray<z.ZodObject<{
+    index: z.ZodNumber;
+    value: z.ZodString;
+    label: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    label: string;
+    index: number;
+}, {
+    value: string;
+    label: string;
+    index: number;
+}>, "many">;
+export type TMilestoneCameraOption = z.infer<typeof milestoneCameraListSchema>[number];
 export declare const widgetSchema: z.ZodObject<{
     enabled: z.ZodDefault<z.ZodBoolean>;
     coord: z.ZodUnion<[z.ZodLiteral<"top_left">, z.ZodLiteral<"top_right">, z.ZodLiteral<"bottom_left">, z.ZodLiteral<"bottom_right">]>;

package/cjs/types/PlaneTrackerAPI.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+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.milestoneCameraListSchema = exports.connectionSchema = exports.wsAliasResponseSchema = void 0;
 const zod_1 = require("zod");
 exports.wsAliasResponseSchema = zod_1.z.object({
     alias: zod_1.z.string(),
@@ -14,6 +14,13 @@ exports.connectionSchema = zod_1.z.object({
     user: zod_1.z.string(),
     pass: zod_1.z.string(),
 });
+exports.milestoneCameraListSchema = zod_1.z
+    .object({
+    index: zod_1.z.number(),
+    value: zod_1.z.string(),
+    label: zod_1.z.string(),
+})
+    .array();
 exports.widgetSchema = zod_1.z.object({
     enabled: zod_1.z.boolean().default(true),
     coord: zod_1.z.union([

package/esm/PlaneTrackerAPI.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { blackListSchema, cameraSettingsSchema, domainListSchema, flightInfoSchema, getIcaoSchema, mapInfoSchema, priorityListSchema, serverSettingsSchema, trackingModeSchema, whiteListSchema, wsAliasResponseSchema, zonesSchema, } from './types/PlaneTrackerAPI';
+import { blackListSchema, cameraSettingsSchema, domainListSchema, flightInfoSchema, getIcaoSchema, mapInfoSchema, milestoneCameraListSchema, priorityListSchema, serverSettingsSchema, trackingModeSchema, whiteListSchema, wsAliasResponseSchema, zonesSchema, } from './types/PlaneTrackerAPI';
 import { CannotSetCoordsInAutoModeError, ImportSettingsError, InvalidAltitudeError, InvalidLatLngError, ResetCalibrationError, ServerError, BadRequestError, } from './errors/errors';
 import { BasicAPI } from './internal/BasicAPI';
 const BASE_PATH = '/local/planetracker';
@@ -193,6 +193,19 @@ export class PlaneTrackerAPI extends BasicAPI {
             }
         }
     }
+    async checkMilestoneConnection(params, options) {
+        try {
+            await this._postUrlEncoded(`${BASE_PATH}/package/checkMilestoneConnection.cgi`, { ...params }, options);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    async getMilestoneCameraList(params, options) {
+        const res = await this._postUrlEncoded(`${BASE_PATH}/package/getMilestoneCameraList.cgi`, { ...params }, options);
+        return milestoneCameraListSchema.parse(await res.json());
+    }
     downloadReport(options) {
         return this._getText(`${BASE_PATH}/report.cgi`, undefined, options);
     }

package/esm/node/events/MilestoneAgent.js

@@ -24,11 +24,11 @@ export class MilestoneAgent {
     }
     async checkConnection() {
         await this.getToken(true);
-        await this.getCamerasPage(1, 1);
+        await this.getCamerasPage(0, 1);
     }
     async getAllCameras() {
         const cameras = [];
-        let page = 1;
+        let page = 0;
         for (;;) {
             const pageCameras = await this.getCamerasPage(page, PAGE_SIZE);
             cameras.push(...pageCameras);
@@ -52,9 +52,9 @@ export class MilestoneAgent {
             throw new ErrorWithResponse(res);
         }
     }
-    async getCamerasPage(page, itemsPerPage) {
+    async getCamerasPage(page, size) {
         const token = await this.getToken();
-        const res = await this.sender.sendRequest(this.getRequestOptions('GET', `/api/rest/v1/cameras?page=${page}&itemsPerPage=${itemsPerPage}`, token));
+        const res = await this.sender.sendRequest(this.getRequestOptions('GET', `/api/rest/v1/cameras?page=${page}&size=${size}`, token));
         if (!res.ok) {
             throw new ErrorWithResponse(res);
         }

package/esm/types/PlaneTrackerAPI.js

@@ -11,6 +11,13 @@ export const connectionSchema = z.object({
     user: z.string(),
     pass: z.string(),
 });
+export const milestoneCameraListSchema = z
+    .object({
+    index: z.number(),
+    value: z.string(),
+    label: z.string(),
+})
+    .array();
 export const widgetSchema = z.object({
     enabled: z.boolean().default(true),
     coord: z.union([

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "camstreamerlib",
-    "version": "4.0.17-dev-milestone.0",
+    "version": "4.0.17-dev-milestone.2",
     "description": "Helper library for CamStreamer ACAP applications.",
     "prettier": "@camstreamer/prettier-config",
     "engine": {

package/types/PlaneTrackerAPI.d.ts

@@ -1,5 +1,5 @@
 import { IClient, TResponse } from './internal/types';
-import { ICAO, TBlackList, TCameraSettings, TExportDataType, TGetIcaoByOption, TImportDataType, TPriorityList, TTrackingMode, TWhiteList, TZones } from './types/PlaneTrackerAPI';
+import { ICAO, TBlackList, TCameraSettings, TConnection, TExportDataType, TGetIcaoByOption, TImportDataType, TMilestoneCameraOption, TPriorityList, TTrackingMode, TWhiteList, TZones } from './types/PlaneTrackerAPI';
 import { THttpRequestOptions } from './types/common';
 import { BasicAPI } from './internal/BasicAPI';
 import { TApiUser } from './types/ws/PlaneTrackerEvents';
@@ -259,5 +259,7 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
     }>;
     setZones(zones: TZones, options?: THttpRequestOptions): Promise<void>;
     goToCoordinates(lat: number, lon: number, alt?: number, options?: THttpRequestOptions): Promise<void>;
+    checkMilestoneConnection(params: TConnection, options?: THttpRequestOptions): Promise<boolean>;
+    getMilestoneCameraList(params: TConnection, options?: THttpRequestOptions): Promise<TMilestoneCameraOption[]>;
     downloadReport(options?: THttpRequestOptions): Promise<string>;
 }

package/types/types/PlaneTrackerAPI.d.ts

@@ -33,6 +33,21 @@ export declare const connectionSchema: z.ZodObject<{
     user: string;
     protocol: "https" | "http" | "https_insecure";
 }>;
+export type TConnection = z.infer<typeof connectionSchema>;
+export declare const milestoneCameraListSchema: z.ZodArray<z.ZodObject<{
+    index: z.ZodNumber;
+    value: z.ZodString;
+    label: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    label: string;
+    index: number;
+}, {
+    value: string;
+    label: string;
+    index: number;
+}>, "many">;
+export type TMilestoneCameraOption = z.infer<typeof milestoneCameraListSchema>[number];
 export declare const widgetSchema: z.ZodObject<{
     enabled: z.ZodDefault<z.ZodBoolean>;
     coord: z.ZodUnion<[z.ZodLiteral<"top_left">, z.ZodLiteral<"top_right">, z.ZodLiteral<"bottom_left">, z.ZodLiteral<"bottom_right">]>;

package/cjs/node/events/MilestoneAgent.test.d.ts

@@ -1 +0,0 @@
-export {};

package/cjs/node/events/MilestoneAgent.test.js

@@ -1,102 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const globals_1 = require("@jest/globals");
-const HttpRequestSender_1 = require("../HttpRequestSender");
-const MilestoneAgent_1 = require("./MilestoneAgent");
-globals_1.jest.mock('../HttpRequestSender');
-function jsonResponse(body, status = 200) {
-    return {
-        ok: status >= 200 && status < 300,
-        status,
-        statusText: 'OK',
-        text: () => Promise.resolve(JSON.stringify(body)),
-    };
-}
-const TOKEN_BODY = { access_token: 'abc123', expires_in: 3600, token_type: 'Bearer', scope: 'managementserver' };
-(0, globals_1.describe)('MilestoneAgent', () => {
-    const MockedSender = globals_1.jest.mocked(HttpRequestSender_1.HttpRequestSender);
-    let sendRequest;
-    (0, globals_1.beforeEach)(() => {
-        sendRequest = globals_1.jest.fn();
-        MockedSender.mockImplementation(() => ({ sendRequest }));
-    });
-    function callsTo(prefix) {
-        return sendRequest.mock.calls.filter((c) => c[0].path.startsWith(prefix));
-    }
-    function routeByPath(handlers) {
-        sendRequest.mockImplementation((...args) => {
-            const options = args[0];
-            if (options.path === '/idp/connect/token') {
-                return Promise.resolve(jsonResponse(TOKEN_BODY));
-            }
-            for (const [prefix, handler] of Object.entries(handlers)) {
-                if (options.path.startsWith(prefix)) {
-                    if (typeof handler === 'function') {
-                        const page = Number(new URLSearchParams(options.path.split('?')[1]).get('page'));
-                        return Promise.resolve(handler(page));
-                    }
-                    return Promise.resolve(handler);
-                }
-            }
-            throw new Error(`Unexpected path ${options.path}`);
-        });
-    }
-    (0, globals_1.test)('fetches a bearer token before listing cameras and sends it in the header', async () => {
-        routeByPath({ '/api/rest/v1/cameras': jsonResponse({ array: [{ id: 'cam-1', displayName: 'Cam 1' }] }) });
-        const agent = new MilestoneAgent_1.MilestoneAgent({ ip: '1.2.3.4' });
-        const cameras = await agent.getAllCameras();
-        (0, globals_1.expect)(cameras).toEqual([{ id: 'cam-1', displayName: 'Cam 1' }]);
-        const tokenCalls = callsTo('/idp/connect/token');
-        (0, globals_1.expect)(tokenCalls.length).toBe(1);
-        (0, globals_1.expect)(tokenCalls[0][0].method).toBe('POST');
-        const camerasCall = callsTo('/api/rest/v1/cameras')[0];
-        (0, globals_1.expect)(camerasCall[0].headers.Authorization).toBe('Bearer abc123');
-    });
-    (0, globals_1.test)('reuses the cached token across calls', async () => {
-        routeByPath({ '/api/rest/v1/cameras': jsonResponse({ array: [] }) });
-        const agent = new MilestoneAgent_1.MilestoneAgent({ ip: '1.2.3.4' });
-        await agent.getAllCameras();
-        await agent.getAllCameras();
-        (0, globals_1.expect)(callsTo('/idp/connect/token').length).toBe(1);
-    });
-    (0, globals_1.test)('pages through cameras until a non-full page is returned', async () => {
-        const fullPage = (page) => jsonResponse({ array: Array.from({ length: 100 }, (_, i) => ({ id: `p${page}-${i}` })) });
-        routeByPath({
-            '/api/rest/v1/cameras': (page) => page < 3 ? fullPage(page) : jsonResponse({ array: [{ id: 'last' }] }),
-        });
-        const agent = new MilestoneAgent_1.MilestoneAgent({ ip: '1.2.3.4' });
-        const cameras = await agent.getAllCameras();
-        (0, globals_1.expect)(cameras.length).toBe(201);
-        (0, globals_1.expect)(cameras[cameras.length - 1]).toEqual({ id: 'last' });
-    });
-    (0, globals_1.test)('sends a bookmark with the camera devicePath', async () => {
-        routeByPath({ '/api/rest/v1/bookmarks': jsonResponse({ result: {} }, 201) });
-        const agent = new MilestoneAgent_1.MilestoneAgent({ ip: '1.2.3.4' });
-        await agent.sendBookmark('cam-guid', {
-            header: 'Airbus A320',
-            description: 'ICAO BC4AA',
-            timeBegin: '2026-04-16T10:25:00.000Z',
-            timeEnd: '2026-04-16T10:25:00.000Z',
-            timeTriggered: '2026-04-16T10:25:00.000Z',
-            reference: 'BC4AA',
-        });
-        const call = callsTo('/api/rest/v1/bookmarks')[0];
-        (0, globals_1.expect)(call).toBeDefined();
-        const body = JSON.parse(call[1]);
-        (0, globals_1.expect)(body.devicePath).toEqual({ type: 'cameras', id: 'cam-guid' });
-        (0, globals_1.expect)(body.header).toBe('Airbus A320');
-        (0, globals_1.expect)(body.description).toBe('ICAO BC4AA');
-    });
-    (0, globals_1.test)('throws on a non-ok bookmark response', async () => {
-        routeByPath({ '/api/rest/v1/bookmarks': jsonResponse({ error: 'nope' }, 500) });
-        const agent = new MilestoneAgent_1.MilestoneAgent({ ip: '1.2.3.4' });
-        await (0, globals_1.expect)(agent.sendBookmark('cam-guid', {
-            header: 'h',
-            description: 'd',
-            timeBegin: 't',
-            timeEnd: 't',
-            timeTriggered: 't',
-            reference: 'r',
-        })).rejects.toThrow();
-    });
-});

package/esm/node/events/MilestoneAgent.test.js

@@ -1,100 +0,0 @@
-import { describe, test, expect, beforeEach, jest } from '@jest/globals';
-import { HttpRequestSender } from '../HttpRequestSender';
-import { MilestoneAgent } from './MilestoneAgent';
-jest.mock('../HttpRequestSender');
-function jsonResponse(body, status = 200) {
-    return {
-        ok: status >= 200 && status < 300,
-        status,
-        statusText: 'OK',
-        text: () => Promise.resolve(JSON.stringify(body)),
-    };
-}
-const TOKEN_BODY = { access_token: 'abc123', expires_in: 3600, token_type: 'Bearer', scope: 'managementserver' };
-describe('MilestoneAgent', () => {
-    const MockedSender = jest.mocked(HttpRequestSender);
-    let sendRequest;
-    beforeEach(() => {
-        sendRequest = jest.fn();
-        MockedSender.mockImplementation(() => ({ sendRequest }));
-    });
-    function callsTo(prefix) {
-        return sendRequest.mock.calls.filter((c) => c[0].path.startsWith(prefix));
-    }
-    function routeByPath(handlers) {
-        sendRequest.mockImplementation((...args) => {
-            const options = args[0];
-            if (options.path === '/idp/connect/token') {
-                return Promise.resolve(jsonResponse(TOKEN_BODY));
-            }
-            for (const [prefix, handler] of Object.entries(handlers)) {
-                if (options.path.startsWith(prefix)) {
-                    if (typeof handler === 'function') {
-                        const page = Number(new URLSearchParams(options.path.split('?')[1]).get('page'));
-                        return Promise.resolve(handler(page));
-                    }
-                    return Promise.resolve(handler);
-                }
-            }
-            throw new Error(`Unexpected path ${options.path}`);
-        });
-    }
-    test('fetches a bearer token before listing cameras and sends it in the header', async () => {
-        routeByPath({ '/api/rest/v1/cameras': jsonResponse({ array: [{ id: 'cam-1', displayName: 'Cam 1' }] }) });
-        const agent = new MilestoneAgent({ ip: '1.2.3.4' });
-        const cameras = await agent.getAllCameras();
-        expect(cameras).toEqual([{ id: 'cam-1', displayName: 'Cam 1' }]);
-        const tokenCalls = callsTo('/idp/connect/token');
-        expect(tokenCalls.length).toBe(1);
-        expect(tokenCalls[0][0].method).toBe('POST');
-        const camerasCall = callsTo('/api/rest/v1/cameras')[0];
-        expect(camerasCall[0].headers.Authorization).toBe('Bearer abc123');
-    });
-    test('reuses the cached token across calls', async () => {
-        routeByPath({ '/api/rest/v1/cameras': jsonResponse({ array: [] }) });
-        const agent = new MilestoneAgent({ ip: '1.2.3.4' });
-        await agent.getAllCameras();
-        await agent.getAllCameras();
-        expect(callsTo('/idp/connect/token').length).toBe(1);
-    });
-    test('pages through cameras until a non-full page is returned', async () => {
-        const fullPage = (page) => jsonResponse({ array: Array.from({ length: 100 }, (_, i) => ({ id: `p${page}-${i}` })) });
-        routeByPath({
-            '/api/rest/v1/cameras': (page) => page < 3 ? fullPage(page) : jsonResponse({ array: [{ id: 'last' }] }),
-        });
-        const agent = new MilestoneAgent({ ip: '1.2.3.4' });
-        const cameras = await agent.getAllCameras();
-        expect(cameras.length).toBe(201);
-        expect(cameras[cameras.length - 1]).toEqual({ id: 'last' });
-    });
-    test('sends a bookmark with the camera devicePath', async () => {
-        routeByPath({ '/api/rest/v1/bookmarks': jsonResponse({ result: {} }, 201) });
-        const agent = new MilestoneAgent({ ip: '1.2.3.4' });
-        await agent.sendBookmark('cam-guid', {
-            header: 'Airbus A320',
-            description: 'ICAO BC4AA',
-            timeBegin: '2026-04-16T10:25:00.000Z',
-            timeEnd: '2026-04-16T10:25:00.000Z',
-            timeTriggered: '2026-04-16T10:25:00.000Z',
-            reference: 'BC4AA',
-        });
-        const call = callsTo('/api/rest/v1/bookmarks')[0];
-        expect(call).toBeDefined();
-        const body = JSON.parse(call[1]);
-        expect(body.devicePath).toEqual({ type: 'cameras', id: 'cam-guid' });
-        expect(body.header).toBe('Airbus A320');
-        expect(body.description).toBe('ICAO BC4AA');
-    });
-    test('throws on a non-ok bookmark response', async () => {
-        routeByPath({ '/api/rest/v1/bookmarks': jsonResponse({ error: 'nope' }, 500) });
-        const agent = new MilestoneAgent({ ip: '1.2.3.4' });
-        await expect(agent.sendBookmark('cam-guid', {
-            header: 'h',
-            description: 'd',
-            timeBegin: 't',
-            timeEnd: 't',
-            timeTriggered: 't',
-            reference: 'r',
-        })).rejects.toThrow();
-    });
-});

package/types/node/events/MilestoneAgent.test.d.ts

@@ -1 +0,0 @@
-export {};