camstreamerlib 4.0.0-beta.3 → 4.0.0-beta.31

package/esm/types/VapixAPI.js

@@ -19,15 +19,8 @@ export const APP_IDS = [
     'CamScripter',
     'PlaneTracker',
     'Ndihxplugin',
+    'SportTracker',
 ];
-export const applicationListSchema = z.object({
-    reply: z.object({
-        $: z.object({ result: z.string() }),
-        application: z.array(z.object({
-            $: applicationSchema,
-        })),
-    }),
-});
 export const guardTourSchema = z.object({
     id: z.string(),
     camNbr: z.unknown(),
@@ -67,7 +60,7 @@ export const audioDeviceSignalingChannelTypeSchema = z.object({
 });
 export const audioDeviceSignalingTypeSchema = z.object({
     id: z.string(),
-    powerType: z.string(),
+    powerType: z.string().optional(),
     channels: z.array(audioDeviceSignalingChannelTypeSchema),
 });
 export const audioDeviceConnectionTypeSchema = z.object({
@@ -94,15 +87,19 @@ const audioDeviceFromRequestSchema = z.object({
     inputs: z.array(audioDeviceInputOutputSchema).optional(),
     outputs: z.array(audioDeviceInputOutputSchema).optional(),
 });
-export const audioDeviceRequestSchema = z.object({ devices: z.array(audioDeviceFromRequestSchema) });
+export const audioDeviceRequestSchema = z.object({
+    data: z.object({ devices: z.array(audioDeviceFromRequestSchema) }),
+});
 export const maxFpsResponseSchema = z.object({
-    data: z.array(z.object({
+    data: z
+        .array(z.object({
         channel: z.number(),
         captureMode: z.array(z.object({
             enabled: z.boolean(),
             maxFPS: z.number().optional(),
         })),
-    })),
+    }))
+        .optional(),
 });
 export const dateTimeinfoSchema = z.object({
     data: z.object({
@@ -110,20 +107,61 @@ export const dateTimeinfoSchema = z.object({
         dstEnabled: z.boolean(),
         localDateTime: z.string(),
         posixTimeZone: z.string(),
-        timeZone: z.string(),
+        timeZone: z.string().optional(),
     }),
 });
+export const timeZoneSchema = z.discriminatedUnion('status', [
+    z.object({
+        status: z.literal('success'),
+        data: z.object({
+            activeTimeZone: z.string(),
+        }),
+    }),
+    z.object({
+        status: z.literal('error'),
+        error: z.object({
+            message: z.string(),
+        }),
+    }),
+]);
 export const audioSampleRatesResponseSchema = z.object({
     data: z.object({
-        encoders: z.union([
-            z.object({
-                aac: z.array(audioSampleRatesSchema),
-                AAC: z.undefined(),
-            }),
-            z.object({
-                AAC: z.array(audioSampleRatesSchema),
-                aac: z.undefined(),
-            }),
-        ]),
+        encoders: z
+            .object({
+            aac: z.array(audioSampleRatesSchema),
+            AAC: z.array(audioSampleRatesSchema),
+        })
+            .partial(),
     }),
 });
+export const portStatusSchema = z.object({
+    port: z.string(),
+    state: z.enum(['open', 'closed']),
+    configurable: z.boolean(),
+    readonly: z.boolean().optional(),
+    usage: z.string(),
+    direction: z.enum(['input', 'output']),
+    name: z.string(),
+    normalState: z.enum(['open', 'closed']),
+});
+export const getPortsResponseSchema = z.object({
+    apiVersion: z.string(),
+    context: z.string(),
+    method: z.literal('getPorts'),
+    data: z.object({
+        numberOfPorts: z.number(),
+        items: z.array(portStatusSchema),
+    }),
+});
+export const portSetSchema = z.object({
+    port: z.string(),
+    state: z.enum(['open', 'closed']),
+    usage: z.string().optional(),
+    direction: z.enum(['input', 'output']).optional(),
+    name: z.string().optional(),
+    normalState: z.enum(['open', 'closed']).optional(),
+});
+export const portSequenceStateSchema = z.object({
+    state: z.enum(['open', 'closed']),
+    time: z.number().min(0).max(65535),
+});

package/esm/types/common.d.ts

@@ -11,27 +11,36 @@ export declare const networkCameraListSchema: z.ZodArray<z.ZodObject<{
     name: z.ZodString;
     ip: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    ip: string;
     name: string;
-}, {
     ip: string;
+}, {
     name: string;
+    ip: string;
 }>, "many">;
 export type TNetworkCamera = z.infer<typeof networkCameraListSchema>[number];
 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 type TProxyParam = {
+export type TProxyTarget = {
     ip: string;
     mdnsName: string;
     port: number;
     user: string;
     pass: string;
-} | null;
+};
+export type TProxyParams = {
+    path: string;
+    target: TProxyTarget;
+};
+export type THttpRequestOptions = {
+    timeout?: number;
+    proxyParams?: TProxyParams;
+};
 export type TCameraImageConfig = {
     camera?: string;
     resolution?: string;
     compression?: number;
-    overlays?: 'off';
+    overlays?: string;
+    [key: string]: string | number | undefined;
 };

package/esm/web/DefaultClient.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="node" />
-import { IClient, TParameters } from '../internal/common';
-export declare class DefaultClient implements IClient {
-    get(url: string, parameters?: TParameters, headers?: Record<string, string>): Promise<Response>;
-    post(url: string, data: string | Buffer | FormData, parameters?: TParameters, headers?: Record<string, string>): Promise<Response>;
+import { IClient, TGetParams, TPostParams } from '../internal/types';
+export declare class DefaultClient implements IClient<Response> {
+    get: (params: TGetParams) => Promise<Response>;
+    post: (params: TPostParams) => Promise<Response>;
+    private fetchWithTimeout;
 }

package/esm/web/DefaultClient.js

@@ -1,16 +1,28 @@
 import { addParametersToPath } from '../internal/utils';
 export class DefaultClient {
-    get(url, parameters, headers) {
-        return fetch(addParametersToPath(url, parameters), {
+    get = (params) => {
+        return this.fetchWithTimeout(addParametersToPath(params.path, params.parameters), {
             method: 'GET',
-            headers: headers,
-        });
-    }
-    post(url, data, parameters, headers) {
-        return fetch(addParametersToPath(url, parameters), {
+            headers: params.headers,
+        }, params.timeout);
+    };
+    post = (params) => {
+        return this.fetchWithTimeout(addParametersToPath(params.path, params.parameters), {
             method: 'POST',
-            body: data,
-            headers: headers,
-        });
+            body: params.data,
+            headers: params.headers,
+        }, params.timeout);
+    };
+    async fetchWithTimeout(url, options, timeout) {
+        const controller = new AbortController();
+        const timeoutId = timeout !== undefined ? setTimeout(() => controller.abort(), timeout) : null;
+        try {
+            return await fetch(url, { ...options, signal: controller.signal });
+        }
+        finally {
+            if (timeoutId) {
+                clearTimeout(timeoutId);
+            }
+        }
     }
 }

package/esm/web/WsClient.js

@@ -27,7 +27,7 @@ export class WsClient {
         };
         ws.onmessage = (e) => this.onmessage(e);
         ws.onclose = () => {
-            this.restartTimeout = setTimeout(() => this.init(), REFRESH_TIMEOUT);
+            this.restartTimeout = window.setTimeout(() => this.init(), REFRESH_TIMEOUT);
         };
         this.ws = ws;
     }
@@ -40,7 +40,7 @@ export class WsClient {
         this.destroyWebsocket();
     };
     destroyWebsocket() {
-        if (this.restartTimeout) {
+        if (this.restartTimeout !== null) {
             clearTimeout(this.restartTimeout);
             this.restartTimeout = null;
         }

package/package.json

@@ -1,31 +1,30 @@
 {
     "name": "camstreamerlib",
-    "version": "4.0.0-beta.3",
+    "version": "4.0.0-beta.31",
     "description": "Helper library for CamStreamer ACAP applications.",
     "prettier": "@camstreamer/prettier-config",
+    "engine": {
+        "node": ">=18.0.0"
+    },
     "dependencies": {
         "adm-zip": "^0.5.9",
         "eventemitter2": "^5.0.1",
+        "fast-xml-parser": "^5.2.5",
         "lodash": "^4.17.21",
         "prettify-xml": "^1.2.0",
         "type-fest": "^4.41.0",
         "undici": "^6.21.3",
         "ws": "^8.18.0",
-        "xml2js": "^0.5.0",
         "zod": "^3.24.3"
     },
-    "engine": {
-        "node": ">=18.0.0"
-    },
     "devDependencies": {
         "@camstreamer/eslint-config": "^1.0.2",
         "@camstreamer/prettier-config": "^2.0.4",
         "@types/adm-zip": "^0.5.5",
         "@types/jest": "^28.0.0",
         "@types/lodash": "^4.17.18",
-        "@types/node": "^18.19.39",
+        "@types/node": "^18.19.127",
         "@types/ws": "^8.5.10",
-        "@types/xml2js": "^0.4.14",
         "@typescript-eslint/eslint-plugin": "^6.8.0",
         "@typescript-eslint/parser": "^6.8.0",
         "eslint": "^8.51.0",
@@ -44,11 +43,13 @@
         "build:cjs": "tsc --project tsconfig.cjs.json",
         "build:esm": "tsc --project tsconfig.esm.json",
         "copyPackage": "cp -f LICENSE dist/ && cp -f README.md dist/ && cp -f package.json dist/",
+        "prepublish": "npm run build",
         "lint": "eslint \"src/**/*.ts\"",
         "lint:fix": "eslint \"src/**/*.ts\" --fix",
         "pretty": "prettier --write \"./{{src,doc}/**/*.{ts,tsx,md},README.md}\"",
         "pretty:check": "prettier --check \"./{{src,doc}/**/*.{ts,tsx,md},README.md}\"",
-        "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
+        "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+        "audit": "npm audit --audit-level=high"
     },
     "files": [
         "/**/*.js",

package/cjs/internal/common.d.ts

@@ -1,39 +0,0 @@
-/// <reference types="node" />
-type Options = {
-    ip?: string;
-    port?: number;
-    user?: string;
-    pass?: string;
-    tls?: boolean;
-    tlsInsecure?: boolean;
-};
-export type HttpOptions = Options & {
-    keepAlive?: boolean;
-};
-export type WsOptions = Options;
-export type TResponse = {
-    ok: boolean;
-    json: () => Promise<any>;
-    text: () => Promise<string>;
-    status: number;
-    body: any | null;
-};
-export type TParameters = Record<string, string | number | boolean | null | undefined>;
-export type TGetFunction = (url: string, parameters?: TParameters, headers?: Record<string, string>) => Promise<TResponse>;
-export type TPostFunction = (url: string, data: string | Buffer | FormData, parameters?: TParameters, headers?: Record<string, string>) => Promise<TResponse>;
-export interface IClient {
-    get: TGetFunction;
-    post: TPostFunction;
-}
-export interface IWebsocket<Event extends {
-    readonly data: string;
-}> {
-    destroy: () => void;
-    onmessage: null | ((event: Event) => void);
-    send: (data: string) => void;
-}
-export declare function isClient(arg?: Options | IClient): arg is IClient;
-export declare function responseStringify(res: TResponse): Promise<string>;
-export declare function pad(num: number, size: number): string;
-export declare function isNullish<T>(value: T | undefined | null): value is undefined | null;
-export {};

package/cjs/internal/common.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNullish = exports.pad = exports.responseStringify = exports.isClient = void 0;
-function isClient(arg = {}) {
-    return 'get' in arg && 'post' in arg;
-}
-exports.isClient = isClient;
-async function responseStringify(res) {
-    return JSON.stringify({
-        status: res.status,
-        body: await res.text(),
-    });
-}
-exports.responseStringify = responseStringify;
-function pad(num, size) {
-    const sign = Math.sign(num) === -1 ? '-' : '';
-    return (sign +
-        new Array(size)
-            .concat([Math.abs(num)])
-            .join('0')
-            .slice(-size));
-}
-exports.pad = pad;
-function isNullish(value) {
-    return value === null || value === undefined;
-}
-exports.isNullish = isNullish;

package/cjs/node/WsEventClient.d.ts

@@ -1,13 +0,0 @@
-import { IWebsocket } from '../internal/common';
-import { WsClientOptions } from './WsClient';
-type TEvent = {
-    data: string;
-};
-export declare class WsEventClient implements IWebsocket<TEvent> {
-    private wsClient;
-    constructor(options: WsClientOptions);
-    send: (data: string) => void;
-    destroy: () => void;
-    onmessage: ((event: TEvent) => void) | null;
-}
-export {};

package/cjs/node/WsEventClient.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WsEventClient = void 0;
-const WsClient_1 = require("./WsClient");
-class WsEventClient {
-    wsClient;
-    constructor(options) {
-        this.wsClient = new WsClient_1.WsClient(options);
-        this.wsClient.on('message', (data) => {
-            this.onmessage?.({ data: data.toString() });
-        });
-    }
-    send = (data) => {
-        this.wsClient.send(data);
-    };
-    destroy = () => {
-        this.wsClient.close();
-        this.onmessage = null;
-    };
-    onmessage = null;
-}
-exports.WsEventClient = WsEventClient;

package/cjs/types/CamOverlayAPI.d.ts

@@ -1,188 +0,0 @@
-import { HttpOptions } from '../internal/common';
-import { z } from 'zod';
-export type CamOverlayOptions = HttpOptions;
-export type TFileType = 'image' | 'font';
-export type TCoordinates = 'top_left' | 'top_right' | 'top' | 'bottom_left' | 'bottom_right' | 'bottom' | 'left' | 'right' | 'center' | '';
-export declare const serviceSchema: z.ZodRecord<z.ZodString, z.ZodAny>;
-export type TService = z.infer<typeof serviceSchema>;
-export type TServiceList = {
-    services: TService[];
-};
-export declare const fieldSchema: z.ZodObject<{
-    field_name: z.ZodString;
-    text: z.ZodString;
-    color: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    field_name: string;
-    text: string;
-    color?: string | undefined;
-}, {
-    field_name: string;
-    text: string;
-    color?: string | undefined;
-}>;
-export type TField = z.infer<typeof fieldSchema>;
-export declare const fileSchema: z.ZodObject<{
-    name: z.ZodString;
-    path: z.ZodString;
-    storage: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    path: string;
-    name: string;
-    storage: string;
-}, {
-    path: string;
-    name: string;
-    storage: string;
-}>;
-export type TFile = z.infer<typeof fileSchema>;
-export declare const fileListSchema: z.ZodArray<z.ZodObject<{
-    name: z.ZodString;
-    path: z.ZodString;
-    storage: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    path: string;
-    name: string;
-    storage: string;
-}, {
-    path: string;
-    name: string;
-    storage: string;
-}>, "many">;
-export type TFileList = z.infer<typeof fileListSchema>;
-export declare enum ImageType {
-    PNG = 0,
-    JPEG = 1
-}
-export declare const fontStorageSchema: z.ZodTuple<[z.ZodObject<{
-    type: z.ZodLiteral<"SD0">;
-    state: z.ZodLiteral<"SD Card">;
-}, "strip", z.ZodTypeAny, {
-    type: "SD0";
-    state: "SD Card";
-}, {
-    type: "SD0";
-    state: "SD Card";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"flash">;
-    state: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: "flash";
-    state: string;
-}, {
-    type: "flash";
-    state: string;
-}>], null>;
-export type TFontStorage = z.infer<typeof fontStorageSchema>;
-export declare const imageStorageSchema: z.ZodTuple<[z.ZodObject<{
-    type: z.ZodLiteral<"SD0">;
-    state: z.ZodLiteral<"SD Card">;
-}, "strip", z.ZodTypeAny, {
-    type: "SD0";
-    state: "SD Card";
-}, {
-    type: "SD0";
-    state: "SD Card";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"flash">;
-    state: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: "flash";
-    state: string;
-}, {
-    type: "flash";
-    state: string;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"samba">;
-    state: z.ZodLiteral<"Microsoft Network Share">;
-}, "strip", z.ZodTypeAny, {
-    type: "samba";
-    state: "Microsoft Network Share";
-}, {
-    type: "samba";
-    state: "Microsoft Network Share";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"url">;
-    state: z.ZodLiteral<"URL">;
-}, "strip", z.ZodTypeAny, {
-    type: "url";
-    state: "URL";
-}, {
-    type: "url";
-    state: "URL";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"ftp">;
-    state: z.ZodLiteral<"FTP">;
-}, "strip", z.ZodTypeAny, {
-    type: "ftp";
-    state: "FTP";
-}, {
-    type: "ftp";
-    state: "FTP";
-}>], null>;
-export type TImageStorage = z.infer<typeof imageStorageSchema>;
-export declare const storageSchema: z.ZodUnion<[z.ZodTuple<[z.ZodObject<{
-    type: z.ZodLiteral<"SD0">;
-    state: z.ZodLiteral<"SD Card">;
-}, "strip", z.ZodTypeAny, {
-    type: "SD0";
-    state: "SD Card";
-}, {
-    type: "SD0";
-    state: "SD Card";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"flash">;
-    state: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: "flash";
-    state: string;
-}, {
-    type: "flash";
-    state: string;
-}>], null>, z.ZodTuple<[z.ZodObject<{
-    type: z.ZodLiteral<"SD0">;
-    state: z.ZodLiteral<"SD Card">;
-}, "strip", z.ZodTypeAny, {
-    type: "SD0";
-    state: "SD Card";
-}, {
-    type: "SD0";
-    state: "SD Card";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"flash">;
-    state: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: "flash";
-    state: string;
-}, {
-    type: "flash";
-    state: string;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"samba">;
-    state: z.ZodLiteral<"Microsoft Network Share">;
-}, "strip", z.ZodTypeAny, {
-    type: "samba";
-    state: "Microsoft Network Share";
-}, {
-    type: "samba";
-    state: "Microsoft Network Share";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"url">;
-    state: z.ZodLiteral<"URL">;
-}, "strip", z.ZodTypeAny, {
-    type: "url";
-    state: "URL";
-}, {
-    type: "url";
-    state: "URL";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"ftp">;
-    state: z.ZodLiteral<"FTP">;
-}, "strip", z.ZodTypeAny, {
-    type: "ftp";
-    state: "FTP";
-}, {
-    type: "ftp";
-    state: "FTP";
-}>], null>]>;
-export type TStorage = z.infer<typeof storageSchema>;

package/cjs/types/CamOverlayAPI.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.storageSchema = exports.imageStorageSchema = exports.fontStorageSchema = exports.ImageType = exports.fileListSchema = exports.fileSchema = exports.fieldSchema = exports.serviceSchema = void 0;
-const zod_1 = require("zod");
-exports.serviceSchema = zod_1.z.record(zod_1.z.string(), zod_1.z.any());
-exports.fieldSchema = zod_1.z.object({
-    field_name: zod_1.z.string(),
-    text: zod_1.z.string(),
-    color: zod_1.z.string().optional(),
-});
-exports.fileSchema = zod_1.z.object({
-    name: zod_1.z.string(),
-    path: zod_1.z.string(),
-    storage: zod_1.z.string(),
-});
-exports.fileListSchema = zod_1.z.array(exports.fileSchema);
-var ImageType;
-(function (ImageType) {
-    ImageType[ImageType["PNG"] = 0] = "PNG";
-    ImageType[ImageType["JPEG"] = 1] = "JPEG";
-})(ImageType || (exports.ImageType = ImageType = {}));
-exports.fontStorageSchema = zod_1.z.tuple([
-    zod_1.z.object({
-        type: zod_1.z.literal('SD0'),
-        state: zod_1.z.literal('SD Card'),
-    }),
-    zod_1.z.object({
-        type: zod_1.z.literal('flash'),
-        state: zod_1.z.string(),
-    }),
-]);
-exports.imageStorageSchema = zod_1.z.tuple([
-    ...exports.fontStorageSchema.items,
-    zod_1.z.object({
-        type: zod_1.z.literal('samba'),
-        state: zod_1.z.literal('Microsoft Network Share'),
-    }),
-    zod_1.z.object({
-        type: zod_1.z.literal('url'),
-        state: zod_1.z.literal('URL'),
-    }),
-    zod_1.z.object({
-        type: zod_1.z.literal('ftp'),
-        state: zod_1.z.literal('FTP'),
-    }),
-]);
-exports.storageSchema = zod_1.z.union([exports.fontStorageSchema, exports.imageStorageSchema]);

package/esm/internal/common.d.ts

@@ -1,39 +0,0 @@
-/// <reference types="node" />
-type Options = {
-    ip?: string;
-    port?: number;
-    user?: string;
-    pass?: string;
-    tls?: boolean;
-    tlsInsecure?: boolean;
-};
-export type HttpOptions = Options & {
-    keepAlive?: boolean;
-};
-export type WsOptions = Options;
-export type TResponse = {
-    ok: boolean;
-    json: () => Promise<any>;
-    text: () => Promise<string>;
-    status: number;
-    body: any | null;
-};
-export type TParameters = Record<string, string | number | boolean | null | undefined>;
-export type TGetFunction = (url: string, parameters?: TParameters, headers?: Record<string, string>) => Promise<TResponse>;
-export type TPostFunction = (url: string, data: string | Buffer | FormData, parameters?: TParameters, headers?: Record<string, string>) => Promise<TResponse>;
-export interface IClient {
-    get: TGetFunction;
-    post: TPostFunction;
-}
-export interface IWebsocket<Event extends {
-    readonly data: string;
-}> {
-    destroy: () => void;
-    onmessage: null | ((event: Event) => void);
-    send: (data: string) => void;
-}
-export declare function isClient(arg?: Options | IClient): arg is IClient;
-export declare function responseStringify(res: TResponse): Promise<string>;
-export declare function pad(num: number, size: number): string;
-export declare function isNullish<T>(value: T | undefined | null): value is undefined | null;
-export {};