camstreamerlib 4.0.0-beta.39 → 4.0.0-beta.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/README.md +46 -50
  2. package/cjs/CamOverlayAPI.js +7 -3
  3. package/cjs/CamScripterAPI.js +6 -11
  4. package/cjs/CamStreamerAPI.js +5 -4
  5. package/cjs/CamSwitcherAPI.js +16 -16
  6. package/cjs/PlaneTrackerAPI.js +16 -16
  7. package/cjs/VapixAPI.js +4 -4
  8. package/cjs/errors/errors.js +57 -1
  9. package/cjs/index.js +13 -11
  10. package/cjs/node/index.js +2 -0
  11. package/cjs/types/CamOverlayAPI/CamOverlayAPI.js +4 -4
  12. package/cjs/types/CamScripterAPI.js +2 -2
  13. package/cjs/types/PlaneTrackerAPI.js +3 -1
  14. package/esm/CamOverlayAPI.js +8 -4
  15. package/esm/CamScripterAPI.js +7 -12
  16. package/esm/CamStreamerAPI.js +5 -4
  17. package/esm/CamSwitcherAPI.js +17 -17
  18. package/esm/PlaneTrackerAPI.js +16 -16
  19. package/esm/VapixAPI.js +5 -5
  20. package/esm/errors/errors.js +48 -0
  21. package/esm/index.js +9 -7
  22. package/esm/node/index.js +2 -0
  23. package/esm/types/CamOverlayAPI/CamOverlayAPI.js +3 -3
  24. package/esm/types/CamScripterAPI.js +1 -1
  25. package/esm/types/PlaneTrackerAPI.js +3 -1
  26. package/package.json +1 -1
  27. package/types/CamOverlayAPI.d.ts +2 -2
  28. package/types/CamScripterAPI.d.ts +7 -22
  29. package/types/CamStreamerAPI.d.ts +3 -9
  30. package/types/CamSwitcherAPI.d.ts +7 -7
  31. package/types/PlaneTrackerAPI.d.ts +18 -16
  32. package/types/VapixAPI.d.ts +1 -1
  33. package/types/errors/errors.d.ts +25 -1
  34. package/types/index.d.ts +9 -7
  35. package/types/node/index.d.ts +2 -0
  36. package/types/types/CamOverlayAPI/CamOverlayAPI.d.ts +2 -2
  37. package/types/types/CamScripterAPI.d.ts +4 -6
  38. package/types/types/CamStreamerAPI.d.ts +0 -2
  39. package/types/types/PlaneTrackerAPI.d.ts +10 -0
@@ -3,7 +3,7 @@ import { IClient, TResponse } from './internal/types';
3
3
  import { TCameraStream, TStream } from './types/CamStreamerAPI';
4
4
  import { THttpRequestOptions, TProxyParams } from './types/common';
5
5
  export declare class CamStreamerAPI<Client extends IClient<TResponse, any>> {
6
- client: Client;
6
+ private client;
7
7
  constructor(client: Client);
8
8
  getClient(proxyParams?: TProxyParams): Client | ProxyClient<Client>;
9
9
  wsAuthorization(options?: THttpRequestOptions): Promise<string>;
@@ -55,14 +55,8 @@ export declare class CamStreamerAPI<Client extends IClient<TResponse, any>> {
55
55
  stopTime: number | null;
56
56
  }>;
57
57
  getStreamParameter(streamId: number, paramName: string, options?: THttpRequestOptions): Promise<string>;
58
- setStream(streamId: number, params: Partial<TStream>, options?: THttpRequestOptions): Promise<{
59
- message: string;
60
- status: number;
61
- }>;
62
- setStreamParameter(streamId: number, paramName: string, value: string, options?: THttpRequestOptions): Promise<{
63
- message: string;
64
- status: number;
65
- }>;
58
+ setStream(streamId: number, params: Partial<TStream>, options?: THttpRequestOptions): Promise<void>;
59
+ setStreamParameter(streamId: number, paramName: string, value: string, options?: THttpRequestOptions): Promise<void>;
66
60
  isStreaming(streamId: number, options?: THttpRequestOptions): Promise<boolean>;
67
61
  deleteStream(streamId: number, options?: THttpRequestOptions): Promise<boolean>;
68
62
  private _getJson;
@@ -3,7 +3,7 @@ import { TStreamSaveList, TTrackerSaveList, TClipSaveList, TPlaylistSaveList, TC
3
3
  import { TAudioChannel, THttpRequestOptions, TProxyParams, TStorageType } from './types/common';
4
4
  import { ProxyClient } from './internal/ProxyClient';
5
5
  export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
6
- client: Client;
6
+ private client;
7
7
  private CustomFormData;
8
8
  private vapixAgent;
9
9
  constructor(client: Client, CustomFormData?: {
@@ -14,12 +14,12 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
14
14
  static getWsEventsPath: () => string;
15
15
  static getClipPreviewPath: (id: string, storage: TStorageType) => string;
16
16
  getClient(proxyParams?: TProxyParams): Client | ProxyClient<Client>;
17
- generateSilence(sampleRate: number, channels: TAudioChannel, options?: THttpRequestOptions): Promise<void>;
18
17
  checkCameraTime(options?: THttpRequestOptions): Promise<boolean>;
19
18
  getNetworkCameraList(options?: THttpRequestOptions): Promise<{
20
19
  name: string;
21
20
  ip: string;
22
21
  }[]>;
22
+ generateSilence(sampleRate: number, channels: TAudioChannel, options?: THttpRequestOptions): Promise<void>;
23
23
  getMaxFps(source: number, options?: THttpRequestOptions): Promise<number>;
24
24
  getStorageInfo(options?: THttpRequestOptions): Promise<{
25
25
  storage: "SD_DISK" | "FLASH";
@@ -110,17 +110,17 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> {
110
110
  }[] | undefined;
111
111
  camera_view_number?: number | undefined;
112
112
  }>>;
113
- setStreamSaveList(data: TStreamSaveList, options?: THttpRequestOptions): Promise<any>;
114
- setClipSaveList(data: TClipSaveList, options?: THttpRequestOptions): Promise<any>;
115
- setPlaylistSaveList(data: TPlaylistSaveList, options?: THttpRequestOptions): Promise<any>;
116
- setTrackerSaveList(data: TTrackerSaveList, options?: THttpRequestOptions): Promise<any>;
113
+ setStreamSaveList(data: TStreamSaveList, options?: THttpRequestOptions): Promise<void>;
114
+ setClipSaveList(data: TClipSaveList, options?: THttpRequestOptions): Promise<void>;
115
+ setPlaylistSaveList(data: TPlaylistSaveList, options?: THttpRequestOptions): Promise<void>;
116
+ setTrackerSaveList(data: TTrackerSaveList, options?: THttpRequestOptions): Promise<void>;
117
117
  playlistSwitch(playlistName: string, options?: THttpRequestOptions): Promise<void>;
118
118
  playlistQueuePush(playlistName: string, options?: THttpRequestOptions): Promise<void>;
119
119
  playlistQueueClear(options?: THttpRequestOptions): Promise<void>;
120
120
  playlistQueueList(options?: THttpRequestOptions): Promise<string[]>;
121
121
  playlistQueuePlayNext(options?: THttpRequestOptions): Promise<void>;
122
122
  addNewClip(file: any, clipType: 'video' | 'audio', storage: TStorageType, clipId: string, fileName?: string, options?: THttpRequestOptions): Promise<void>;
123
- removeClip(clipId: string, storage: TStorageType, options?: THttpRequestOptions): Promise<any>;
123
+ removeClip(clipId: string, storage: TStorageType, options?: THttpRequestOptions): Promise<void>;
124
124
  getClipList(options?: THttpRequestOptions): Promise<Record<string, {
125
125
  storage: "SD_DISK" | "FLASH";
126
126
  stream_list: ({
@@ -1,5 +1,5 @@
1
1
  import { IClient, TBlobResponse, TParameters, TResponse } from './internal/types';
2
- import { ICAO, TApiUser, TBlackList, TExportDataType, TImportDataType, TPriorityList, TTrackingMode, TWhiteList, TZones } from './types/PlaneTrackerAPI';
2
+ import { ICAO, TApiUser, TBlackList, TCameraSettings, TExportDataType, TImportDataType, TPriorityList, TTrackingMode, TWhiteList, TZones } from './types/PlaneTrackerAPI';
3
3
  import { THttpRequestOptions, TProxyParams } from './types/common';
4
4
  import { ProxyClient } from './internal/ProxyClient';
5
5
  export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
@@ -9,10 +9,10 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
9
9
  static getProxyPath: () => string;
10
10
  getClient(proxyParams?: TProxyParams): Client | ProxyClient<Client>;
11
11
  checkCameraTime(options?: THttpRequestOptions): Promise<boolean>;
12
- resetPtzCalibration(options?: THttpRequestOptions): Promise<TResponse>;
13
- resetFocusCalibration(options?: THttpRequestOptions): Promise<TResponse>;
14
- serverRunCheck(options?: THttpRequestOptions): Promise<TResponse>;
15
- getLiveViewAlias(rtspUrl: string, options?: THttpRequestOptions): Promise<TResponse>;
12
+ resetPtzCalibration(options?: THttpRequestOptions): Promise<void>;
13
+ resetFocusCalibration(options?: THttpRequestOptions): Promise<void>;
14
+ serverRunCheck(options?: THttpRequestOptions): Promise<void>;
15
+ getLiveViewAlias(rtspUrl: string, options?: THttpRequestOptions): Promise<void>;
16
16
  fetchCameraSettings(options?: THttpRequestOptions): Promise<{
17
17
  camera: {
18
18
  ip: string;
@@ -51,6 +51,8 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
51
51
  };
52
52
  trackingConfig: {
53
53
  prioritizeEmergency: boolean;
54
+ guardTourEnabled: boolean;
55
+ guardTourId: number;
54
56
  };
55
57
  widget: {
56
58
  enabled: boolean;
@@ -127,7 +129,7 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
127
129
  displayAircraftInfo?: boolean | undefined;
128
130
  } | undefined;
129
131
  }>;
130
- setCameraSettings(settingsJsonString: string, options?: THttpRequestOptions): Promise<any>;
132
+ setCameraSettings(settings: TCameraSettings, options?: THttpRequestOptions): Promise<void>;
131
133
  fetchServerSettings(options?: THttpRequestOptions): Promise<{
132
134
  cameraCalibration: {
133
135
  posLat: number;
@@ -143,7 +145,7 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
143
145
  };
144
146
  }>;
145
147
  exportAppSettings(dataType: TExportDataType, options?: THttpRequestOptions): Promise<TBlobResponse<Client>>;
146
- importAppSettings(dataType: TImportDataType, formData: Parameters<Client['post']>[0]['data'], options?: THttpRequestOptions): Promise<TResponse>;
148
+ importAppSettings(dataType: TImportDataType, formData: Parameters<Client['post']>[0]['data'], options?: THttpRequestOptions): Promise<void>;
147
149
  fetchFlightInfo(icao: ICAO, options?: THttpRequestOptions): Promise<{
148
150
  destinationAirport: {
149
151
  icao?: string | undefined;
@@ -168,21 +170,21 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
168
170
  getTrackingMode(options?: THttpRequestOptions): Promise<{
169
171
  mode: "MANUAL" | "AUTOMATIC";
170
172
  }>;
171
- setTrackingMode(mode: TTrackingMode['mode'], options?: THttpRequestOptions): Promise<any>;
172
- startTrackingPlane(icao: ICAO, options?: THttpRequestOptions): Promise<TResponse>;
173
- stopTrackingPlane(options?: THttpRequestOptions): Promise<TResponse>;
173
+ setTrackingMode(mode: TTrackingMode['mode'], options?: THttpRequestOptions): Promise<void>;
174
+ startTrackingPlane(icao: ICAO, options?: THttpRequestOptions): Promise<void>;
175
+ stopTrackingPlane(options?: THttpRequestOptions): Promise<void>;
174
176
  getPriorityList(options?: THttpRequestOptions): Promise<{
175
177
  priorityList: string[];
176
178
  }>;
177
- setPriorityList(priorityList: TPriorityList['priorityList'], options?: THttpRequestOptions): Promise<any>;
179
+ setPriorityList(priorityList: TPriorityList['priorityList'], options?: THttpRequestOptions): Promise<void>;
178
180
  getWhiteList(options?: THttpRequestOptions): Promise<{
179
181
  whiteList: string[];
180
182
  }>;
181
- setWhiteList(whiteList: TWhiteList['whiteList'], options?: THttpRequestOptions): Promise<any>;
183
+ setWhiteList(whiteList: TWhiteList['whiteList'], options?: THttpRequestOptions): Promise<void>;
182
184
  getBlackList(options?: THttpRequestOptions): Promise<{
183
185
  blackList: string[];
184
186
  }>;
185
- setBlackList(blackList: TBlackList['blackList'], options?: THttpRequestOptions): Promise<any>;
187
+ setBlackList(blackList: TBlackList['blackList'], options?: THttpRequestOptions): Promise<void>;
186
188
  fetchMapInfo(options?: THttpRequestOptions): Promise<{
187
189
  minZoom: number;
188
190
  maxZoom: number;
@@ -207,9 +209,9 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> {
207
209
  maxSpeedKmph?: number | undefined;
208
210
  }[];
209
211
  }>;
210
- setZones(zones: TZones['zones'], options?: THttpRequestOptions): Promise<any>;
211
- goToCoordinates(lat: number, lon: number, alt?: number, options?: THttpRequestOptions): Promise<TResponse>;
212
- checkGenetecConnection(params: TParameters, options?: THttpRequestOptions): Promise<any>;
212
+ setZones(zones: TZones['zones'], options?: THttpRequestOptions): Promise<void>;
213
+ goToCoordinates(lat: number, lon: number, alt?: number, options?: THttpRequestOptions): Promise<void>;
214
+ checkGenetecConnection(params: TParameters, options?: THttpRequestOptions): Promise<void>;
213
215
  getGenetecCameraList(params: TParameters, options?: THttpRequestOptions): Promise<{
214
216
  value: string;
215
217
  index: number;
@@ -3,7 +3,7 @@ import { TAudioDevice, TPortSetSchema, TPortSequenceStateSchema } from './types/
3
3
  import { ProxyClient } from './internal/ProxyClient';
4
4
  import { TCameraImageConfig, THttpRequestOptions, TProxyParams } from './types/common';
5
5
  export declare class VapixAPI<Client extends IClient<TResponse, any>> {
6
- client: Client;
6
+ private client;
7
7
  private CustomFormData;
8
8
  constructor(client: Client, CustomFormData?: {
9
9
  new (form?: HTMLFormElement | undefined, submitter?: HTMLElement | null | undefined): FormData;
@@ -7,7 +7,16 @@ export declare class ServiceNotFoundError extends Error {
7
7
  export declare class ParsingBlobError extends Error {
8
8
  constructor(err: unknown);
9
9
  }
10
- type TApplicationAPIAction = 'START' | 'RESTART' | 'STOP';
10
+ export declare class JsonParseError extends Error {
11
+ constructor(paramName: string, data: unknown);
12
+ }
13
+ export declare class ParameterNotFoundError extends Error {
14
+ constructor(paramName: string);
15
+ }
16
+ export declare class SettingParameterError extends Error {
17
+ constructor(message: string);
18
+ }
19
+ type TApplicationAPIAction = 'START' | 'RESTART' | 'STOP' | 'INSTALL';
11
20
  export declare class ApplicationAPIError extends Error {
12
21
  constructor(action: TApplicationAPIAction, res: string);
13
22
  }
@@ -34,4 +43,19 @@ export declare class AddNewClipError extends Error {
34
43
  export declare class PtzNotSupportedError extends Error {
35
44
  constructor();
36
45
  }
46
+ export declare class StorageDataFetchError extends Error {
47
+ constructor(err: unknown);
48
+ }
49
+ export declare class WsAuthorizationError extends Error {
50
+ constructor(message: string);
51
+ }
52
+ export declare class UtcTimeFetchError extends Error {
53
+ constructor(message: string);
54
+ }
55
+ export declare class TimezoneNotSetupError extends Error {
56
+ constructor();
57
+ }
58
+ export declare class TimezoneFetchError extends Error {
59
+ constructor(err: unknown);
60
+ }
37
61
  export {};
package/types/index.d.ts CHANGED
@@ -4,15 +4,17 @@ export * from './internal/utils';
4
4
  export * from './internal/versionCompare';
5
5
  export * from './internal/ProxyClient';
6
6
  export * from './types/common';
7
- export { CamSwitcherAPI } from './CamSwitcherAPI';
8
- export { CamSwitcherEvents } from './CamSwitcherEvents';
9
- export { VapixAPI } from './VapixAPI';
10
7
  export { CamOverlayAPI } from './CamOverlayAPI';
8
+ export * from './types/CamOverlayAPI';
11
9
  export { CamScripterAPI } from './CamScripterAPI';
10
+ export * from './types/CamScripterAPI';
12
11
  export { CamStreamerAPI } from './CamStreamerAPI';
13
- export { PlaneTrackerAPI } from './PlaneTrackerAPI';
14
- export * from './types/CamSwitcherEvents';
12
+ export * from './types/CamStreamerAPI';
13
+ export { CamSwitcherAPI } from './CamSwitcherAPI';
15
14
  export * from './types/CamSwitcherAPI';
16
- export * from './types/VapixAPI';
17
- export * from './types/CamOverlayAPI';
15
+ export { CamSwitcherEvents } from './CamSwitcherEvents';
16
+ export * from './types/CamSwitcherEvents';
17
+ export { PlaneTrackerAPI } from './PlaneTrackerAPI';
18
18
  export * from './types/PlaneTrackerAPI';
19
+ export { VapixAPI } from './VapixAPI';
20
+ export * from './types/VapixAPI';
@@ -1,8 +1,10 @@
1
1
  export * from './DefaultClient';
2
2
  export * from './WsClient';
3
3
  export * from './HttpServer';
4
+ export * from './HttpRequestSender';
4
5
  export * from './events/AxisCameraStationEvents';
5
6
  export * from './events/GenetecAgent';
7
+ export * from '../types/GenetecAgent';
6
8
  export { ResourceManager } from './CamOverlayPainter/ResourceManager';
7
9
  export { Painter } from './CamOverlayPainter/Painter';
8
10
  export { Frame } from './CamOverlayPainter/Frame';
@@ -4220,8 +4220,8 @@ export declare enum ImageType {
4220
4220
  PNG = 0,
4221
4221
  JPEG = 1
4222
4222
  }
4223
- export declare const storageSchema: z.ZodUnion<[z.ZodLiteral<"flash">, z.ZodLiteral<"SD0">, z.ZodLiteral<"ftp">, z.ZodLiteral<"samba">, z.ZodLiteral<"url">]>;
4224
- export type TStorage = z.infer<typeof storageSchema>;
4223
+ export declare const fileStorageTypeSchema: z.ZodUnion<[z.ZodLiteral<"flash">, z.ZodLiteral<"SD0">, z.ZodLiteral<"ftp">, z.ZodLiteral<"samba">, z.ZodLiteral<"url">]>;
4224
+ export type TFileStorageType = z.infer<typeof fileStorageTypeSchema>;
4225
4225
  export declare const storageDataListSchema: z.ZodArray<z.ZodObject<{
4226
4226
  type: z.ZodUnion<[z.ZodLiteral<"flash">, z.ZodLiteral<"SD0">, z.ZodLiteral<"ftp">, z.ZodLiteral<"samba">, z.ZodLiteral<"url">]>;
4227
4227
  state: z.ZodString;
@@ -1,7 +1,5 @@
1
- import { HttpOptions } from '../internal/types';
2
1
  import { z } from 'zod';
3
- export type CamScripterOptions = HttpOptions;
4
- export type TStorageType = 'INTERNAL' | 'SD_CARD';
2
+ export type TCameraStorageType = 'INTERNAL' | 'SD_CARD';
5
3
  export declare const nodeStateSchema: z.ZodObject<{
6
4
  node_state: z.ZodUnion<[z.ZodLiteral<"OK">, z.ZodLiteral<"NOT_INSTALLED">, z.ZodLiteral<"NOT_FOUND">]>;
7
5
  }, "strip", z.ZodTypeAny, {
@@ -75,7 +73,7 @@ export type TServerPackageData = {
75
73
  version: string;
76
74
  vendor: string;
77
75
  };
78
- export declare const storageSchema: z.ZodUnion<[z.ZodTuple<[z.ZodObject<{
76
+ export declare const cameraStorageSchema: z.ZodUnion<[z.ZodTuple<[z.ZodObject<{
79
77
  type: z.ZodLiteral<"INTERNAL">;
80
78
  capacity_mb: z.ZodNumber;
81
79
  }, "strip", z.ZodTypeAny, {
@@ -103,10 +101,10 @@ export declare const storageSchema: z.ZodUnion<[z.ZodTuple<[z.ZodObject<{
103
101
  type: "INTERNAL";
104
102
  capacity_mb: number;
105
103
  }>], null>]>;
106
- export type TStorage = z.infer<typeof storageSchema>;
104
+ export type TCameraStorage = z.infer<typeof cameraStorageSchema>;
107
105
  export type TStorageParsedData = {
108
106
  size: number;
109
- storageType: TStorageType;
107
+ storageType: TCameraStorageType;
110
108
  }[];
111
109
  export declare const camscripterApiResponseSchema: z.ZodObject<{
112
110
  status: z.ZodNumber;
@@ -1,6 +1,4 @@
1
- import { HttpOptions } from '../internal/types';
2
1
  import { z } from 'zod';
3
- export type CamStreamerAPIOptions = HttpOptions;
4
2
  export declare const cameraStreamSchema: z.ZodObject<{
5
3
  enabled: z.ZodString;
6
4
  active: z.ZodString;
@@ -138,10 +138,16 @@ export declare const cameraSettingsSchema: z.ZodObject<{
138
138
  }>>;
139
139
  trackingConfig: z.ZodDefault<z.ZodObject<{
140
140
  prioritizeEmergency: z.ZodBoolean;
141
+ guardTourEnabled: z.ZodDefault<z.ZodBoolean>;
142
+ guardTourId: z.ZodDefault<z.ZodNumber>;
141
143
  }, "strip", z.ZodTypeAny, {
142
144
  prioritizeEmergency: boolean;
145
+ guardTourEnabled: boolean;
146
+ guardTourId: number;
143
147
  }, {
144
148
  prioritizeEmergency: boolean;
149
+ guardTourEnabled?: boolean | undefined;
150
+ guardTourId?: number | undefined;
145
151
  }>>;
146
152
  overlayText: z.ZodOptional<z.ZodObject<{
147
153
  displayIcao: z.ZodOptional<z.ZodBoolean>;
@@ -389,6 +395,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
389
395
  };
390
396
  trackingConfig: {
391
397
  prioritizeEmergency: boolean;
398
+ guardTourEnabled: boolean;
399
+ guardTourId: number;
392
400
  };
393
401
  widget: {
394
402
  enabled: boolean;
@@ -502,6 +510,8 @@ export declare const cameraSettingsSchema: z.ZodObject<{
502
510
  } | undefined;
503
511
  trackingConfig?: {
504
512
  prioritizeEmergency: boolean;
513
+ guardTourEnabled?: boolean | undefined;
514
+ guardTourId?: number | undefined;
505
515
  } | undefined;
506
516
  overlayText?: {
507
517
  displayIcao?: boolean | undefined;