@evercam/api 1.0.0-a405572ff → 1.0.0-a99b6a77f

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 +1 -1
  2. package/dist/api/adminApi.d.ts +51 -24
  3. package/dist/api/aiApi.d.ts +38 -1
  4. package/dist/api/client/interceptors.d.ts +2 -1
  5. package/dist/api/evercamApi.d.ts +19 -14
  6. package/dist/api/evercamLabsApi.d.ts +7 -7
  7. package/dist/api/ingestApi.d.ts +2 -1
  8. package/dist/api/ptzApi.d.ts +1 -1
  9. package/dist/api/weatherApi.d.ts +7 -23
  10. package/dist/index.js +776 -638
  11. package/dist/index.js.map +1 -1
  12. package/dist/index.umd.cjs +1 -1
  13. package/dist/index.umd.cjs.map +1 -1
  14. package/dist/types/360.d.ts +2 -2
  15. package/dist/types/analytics.d.ts +28 -59
  16. package/dist/types/anpr.d.ts +10 -7
  17. package/dist/types/axios.d.ts +0 -1
  18. package/dist/types/camera.d.ts +7 -3
  19. package/dist/types/connector.d.ts +2 -1
  20. package/dist/types/coolify.d.ts +18 -0
  21. package/dist/types/copilot.d.ts +11 -9
  22. package/dist/types/detections.d.ts +23 -9
  23. package/dist/types/gateReport.d.ts +50 -1
  24. package/dist/types/hdd.d.ts +63 -0
  25. package/dist/types/index.d.ts +5 -1
  26. package/dist/types/kit.d.ts +41 -8
  27. package/dist/types/nvr.d.ts +2 -1
  28. package/dist/types/{sitePlanner.d.ts → planner.d.ts} +6 -1
  29. package/dist/types/project.d.ts +5 -2
  30. package/dist/types/shared.d.ts +2 -11
  31. package/dist/types/shares.d.ts +5 -1
  32. package/dist/types/siteAnalytics.d.ts +80 -1
  33. package/dist/types/streaming.d.ts +3 -5
  34. package/dist/types/tag.d.ts +12 -0
  35. package/dist/types/timelapse.d.ts +15 -0
  36. package/dist/types/weather.d.ts +6 -2
  37. package/dist/types/widget.d.ts +11 -5
  38. package/dist/types/xweather.d.ts +12 -0
  39. package/package.json +7 -6
@@ -15,6 +15,7 @@ export type Project = {
15
15
  owner?: {
16
16
  email?: string;
17
17
  };
18
+ camerasRestrictionType?: string;
18
19
  };
19
20
  export declare enum ProjectStatus {
20
21
  ToStart = "To Start",
@@ -31,6 +32,9 @@ export declare enum ProjectArchiveTier {
31
32
  export type ProjectResponsePayload = {
32
33
  data?: Project[];
33
34
  };
35
+ export type UpdateCameraRestrictionPayload = {
36
+ isAccessRestricted?: boolean;
37
+ };
34
38
  export type Logo = {
35
39
  name: string;
36
40
  url: string;
@@ -51,8 +55,7 @@ export declare enum ProjectFeatureFlag {
51
55
  MediaHubSharing = "archives_sharing",
52
56
  GateReportAnprBased = "anpr_sourced",
53
57
  NoLicensePlate = "no_license_plate",
54
- DefaultToProjectApp = "default_to_project_app",
55
- Go = "evercam_go"
58
+ DefaultToProjectApp = "default_to_project_app"
56
59
  }
57
60
  export type ProjectBatteryReading = {
58
61
  exid: number;
@@ -103,16 +103,7 @@ export declare enum InfoPage {
103
103
  DroneView = "drone-view",
104
104
  Compare = "compare",
105
105
  Timeline = "timeline",
106
- WeatherReport = "weather-report",
107
- EvercamGo = "evercam-go"
108
- }
109
- export declare enum EvercamGoFeatures {
110
- XRay = "xray",
111
- MagicWand = "magic-wand",
112
- Weather = "weather",
113
- DownloadSnapshot = "download-snapshot",
114
- LocalRecordings = "local-recordings",
115
- MarkupTool = "markup-tool"
106
+ WeatherReport = "weather-report"
116
107
  }
117
108
  export declare enum DownloadTypes {
118
109
  Jpeg = "jpeg",
@@ -194,7 +185,7 @@ export declare enum PtzDirection {
194
185
  export type MoveParams = {
195
186
  cameraExid: string;
196
187
  direction: PtzDirection;
197
- isRecordingFromNvr: boolean;
188
+ useContinuous: boolean;
198
189
  };
199
190
  export declare enum ZoomDirection {
200
191
  In = "in",
@@ -22,6 +22,7 @@ export type Share = {
22
22
  sharerId: number;
23
23
  sharerName: string;
24
24
  userId: number;
25
+ isUserAccessRestricted: boolean;
25
26
  };
26
27
  export type ShareRequestsResponsePayload = {
27
28
  shareRequests: ShareRequest[];
@@ -60,6 +61,10 @@ export type ShareProjectCamerasRequestPayload = {
60
61
  permission?: string;
61
62
  rights: string;
62
63
  };
64
+ export type UpdateUserRestrictionPayload = {
65
+ email: string[];
66
+ isUserAccessRestricted: boolean;
67
+ };
63
68
  export type ShareCreateResponsePayload = {
64
69
  shares: Share[];
65
70
  shareRequests: ShareRequest[];
@@ -92,7 +97,6 @@ export declare enum ShareType {
92
97
  Request = "request"
93
98
  }
94
99
  export declare enum ShareRequestStatus {
95
- All = "",
96
100
  Pending = -1,
97
101
  Cancelled = -2,
98
102
  Failed = -3,
@@ -1,5 +1,84 @@
1
+ import type { BBox, BoundingBox, DetectionLabel } from "@evercam/api/types";
1
2
  export declare enum SiteAnalyticsMode {
2
- Cranes = "cranes",
3
3
  Detections = "detections",
4
4
  Segments = "segments"
5
5
  }
6
+ export type SmartSearchOptionData = {
7
+ id?: string;
8
+ type: SmartSearchQueryComponentType;
9
+ value: DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData;
10
+ };
11
+ export type SmartSearchQueryPart = SmartSearchOptionData | SmartSearchQueryPart[];
12
+ export declare enum SmartSearchQueryComponentType {
13
+ Condition = "condition",
14
+ Object = "object",
15
+ Area = "in_area",
16
+ Time = "time",
17
+ Operator = "operator"
18
+ }
19
+ export type SmartSearchQueryComponentData = {
20
+ id: string;
21
+ type: SmartSearchQueryComponentType;
22
+ parts: SmartSearchQueryPart[];
23
+ };
24
+ export declare enum SmartSearchCondition {
25
+ InArea = "in_area",
26
+ Intersects = "intersects",
27
+ Time = "time"
28
+ }
29
+ export type SmartSearchConditionData = {
30
+ condition: SmartSearchCondition;
31
+ value: string | BoundingBox | DetectionLabel | Date;
32
+ };
33
+ export type SmartSearchQuery = {
34
+ returnTargets: SmartSearchQueryTargets[];
35
+ rulesLogic: SmartSearchOperatorType;
36
+ rules: {
37
+ logic: SmartSearchOperatorType;
38
+ conditions: {
39
+ type: SmartSearchQueryConditionTypes;
40
+ target: SmartSearchQueryTargets;
41
+ operator?: SmartSearchQueryOperators;
42
+ attribute?: string;
43
+ value: string | number | string[];
44
+ reference?: {
45
+ target: SmartSearchQueryTargets;
46
+ attribute: string;
47
+ value: string | number | string[];
48
+ };
49
+ polygon?: BBox;
50
+ }[];
51
+ }[];
52
+ returnType: SmartSearchQueryReturnType;
53
+ };
54
+ export declare enum SmartSearchQueryTargets {
55
+ Tracking = "tracking",
56
+ Segments = "segments"
57
+ }
58
+ export declare enum SmartSearchQueryReturnType {
59
+ All = "all",
60
+ FirstLastSeen = "first_last_seen"
61
+ }
62
+ export declare enum SmartSearchOperatorType {
63
+ And = "AND",
64
+ Or = "OR"
65
+ }
66
+ export declare enum SmartSearchQueryOperators {
67
+ Near = "near",
68
+ Far = "far",
69
+ Intersects = "intersects",
70
+ DoesNotIntersect = "does_not_intersect",
71
+ Inside = "inside",
72
+ Outside = "outside",
73
+ DistanceBelow = "distance_below",
74
+ DistanceAbove = "distance_above",
75
+ Area = "in_area"
76
+ }
77
+ export declare enum SmartSearchQueryConditionTypes {
78
+ Selection = "selection",
79
+ Spatial = "spatial",
80
+ Area = "area",
81
+ Iou = "iou",
82
+ Near = "near",
83
+ Far = "far"
84
+ }
@@ -1,4 +1,4 @@
1
- import { MilesightCameraNetworkConfiguration, MilesightCameraOsdConfiguration, MilesightCameraSdCardInfo, MilesightCameraSystemSettings, MilesightCameraTimeInfo, MilesightCameraVideoConfig, TaskStatus, DateTime_Z_micros, GrafanaChartType } from "@/types";
1
+ import { MilesightCameraNetworkConfiguration, MilesightCameraOsdConfiguration, MilesightCameraSdCardInfo, MilesightCameraSystemSettings, MilesightCameraTimeInfo, MilesightCameraVideoConfig, TaskStatus, DateTime_Z_micros, KitMetricData } from "@/types";
2
2
  export declare enum ExNvrHealthCheckTaskId {
3
3
  ExNvrLogin = "exNvrLogin",
4
4
  ExNvrConfigCheck = "exNvrGetDeviceInfo",
@@ -110,11 +110,9 @@ export type ExNvrSystemStatus = {
110
110
  };
111
111
  export declare enum ExNvrMetricId {
112
112
  CpuLoad = "cpu_load",
113
- RamUsage = "ram_usage",
114
- SwapUsage = "swap_usage"
113
+ RamUsage = "ram_usage"
115
114
  }
116
- export type ExNvrMetric = {
115
+ export type ExNvrMetric = KitMetricData & {
117
116
  metricId: ExNvrMetricId;
118
- type: GrafanaChartType;
119
117
  value: number;
120
118
  };
@@ -0,0 +1,12 @@
1
+ import { Kit } from "@/types/kit";
2
+ export type Tag<T = string> = {
3
+ id?: number;
4
+ name: T;
5
+ description?: string;
6
+ createdAt?: string;
7
+ updatedAt?: string;
8
+ };
9
+ export type KitTag = {
10
+ kit: Kit;
11
+ tag: Tag;
12
+ };
@@ -15,6 +15,13 @@ export type TimelapseVideoOptions = {
15
15
  removeTimestamp: boolean;
16
16
  smoothTransition: boolean;
17
17
  evercamWatermark: boolean;
18
+ timestampPosition?: TimestampPositionCoordinates;
19
+ };
20
+ export type TimestampPositionCoordinates = {
21
+ x: number;
22
+ y: number;
23
+ w: number;
24
+ h: number;
18
25
  };
19
26
  export type TimelapseLogoOptions = {
20
27
  id: number;
@@ -36,6 +43,14 @@ export declare enum TimelapsePeriod {
36
43
  WholeProject = "whole_project",
37
44
  Custom = "custom"
38
45
  }
46
+ export declare enum TimelapseType {
47
+ Hour = "hour",
48
+ Day = "day",
49
+ Week = "week",
50
+ Month = "month",
51
+ Year = "year",
52
+ FullProject = "full_project"
53
+ }
39
54
  export type TimelapseFilterQueryParams = {
40
55
  from?: DateType;
41
56
  to?: DateType;
@@ -1,6 +1,10 @@
1
1
  import { Date_YYYY_MM_DD, DateType } from "@/types/time";
2
2
  export type HistoryWeatherRequestPayload = {
3
3
  day: string;
4
+ provider: WeatherProvider;
5
+ };
6
+ export type CurrentWeatherRequestPayload = {
7
+ provider: WeatherProvider;
4
8
  };
5
9
  export type WeatherResponsePayload = Array<{
6
10
  hour?: number;
@@ -26,8 +30,8 @@ export type HourlyReading = {
26
30
  "3h"?: number;
27
31
  };
28
32
  export declare enum WeatherProvider {
29
- WeatherStack = "WeatherStack",
30
- AerisWeather = "AerisWeather"
33
+ WeatherStack = "weather_stack",
34
+ XWeather = "xweather"
31
35
  }
32
36
  export type Weatherstatus = {
33
37
  description: string;
@@ -1,9 +1,10 @@
1
1
  import type { DateTime } from "@evercam/api/types/time";
2
+ import { PaginationParams } from "@/types";
2
3
  import { VideoWallPresetItemConfig } from "@evercam/api/types/videoWall";
3
4
  export declare enum DelayUnit {
4
- Minute = "minute",
5
- Hour = "hour",
6
- Day = "day"
5
+ Minute = "Minutes",
6
+ Hour = "Hours",
7
+ Day = "Days"
7
8
  }
8
9
  export declare enum CommonWidgetSettingsKeys {
9
10
  Width = "width",
@@ -17,6 +18,8 @@ export declare enum RecordingsWidgetSettingsKeys {
17
18
  HasDelay = "hasDelay",
18
19
  Delay = "delay",
19
20
  DelayUnit = "delayUnit",
21
+ HasRange = "hasRange",
22
+ DateRange = "dateRange",
20
23
  Width = "width",
21
24
  WidthResolution = "resolution",
22
25
  Height = "height",
@@ -35,6 +38,7 @@ export declare enum LiveViewWidgetSettingsKeys {
35
38
  }
36
39
  export declare enum BimCompareWidgetSettingsKeys {
37
40
  Timeline = "timeline",
41
+ Calendar = "calendar",
38
42
  DarkMode = "darkMode",
39
43
  Width = "width",
40
44
  WidthResolution = "resolution",
@@ -84,11 +88,11 @@ export declare enum WidgetType {
84
88
  BimCompare = "BIM Compare",
85
89
  VideoWall = "Video Wall"
86
90
  }
87
- export declare const RessourceByType: {
91
+ export declare const WidgetTypesByResource: {
88
92
  camera: WidgetType[];
89
93
  project: WidgetType[];
90
94
  };
91
- export type WidgetsListRequestPayload = {
95
+ export type WidgetsListRequestPayload = PaginationParams & {
92
96
  userId: number;
93
97
  projectId: number;
94
98
  cameraId: number;
@@ -120,6 +124,8 @@ export type Widget = {
120
124
  user: {
121
125
  id: number;
122
126
  email: string;
127
+ firstname: string;
128
+ lastname: string;
123
129
  };
124
130
  insertedAt: DateTime;
125
131
  updatedAt: DateTime;
@@ -0,0 +1,12 @@
1
+ export type XWeatherCreatePayload = {
2
+ stationId: string;
3
+ clientId: string;
4
+ clientSecret: string;
5
+ };
6
+ export type XWeatherResponse = {
7
+ id: number;
8
+ provider: string;
9
+ config: object;
10
+ insertedAt: string;
11
+ updatedAt: string;
12
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@evercam/api",
3
- "version": "1.0.0-a405572ff",
3
+ "version": "1.0.0-a99b6a77f",
4
4
  "description": "Evercam API client",
5
5
  "repository": {
6
6
  "type": "git",
@@ -11,11 +11,11 @@
11
11
  "private": false,
12
12
  "type": "module",
13
13
  "main": "dist/index.umd.js",
14
- "module": "dist/index.mjs",
14
+ "module": "dist/index.js",
15
15
  "types": "./dist/index.d.ts",
16
16
  "exports": {
17
17
  ".": {
18
- "import": "./dist/index.mjs",
18
+ "import": "./dist/index.js",
19
19
  "require": "./dist/index.umd.js"
20
20
  },
21
21
  "./types": "./dist/src/types.ts"
@@ -32,13 +32,14 @@
32
32
  "typecheck": "tsc --noEmit",
33
33
  "build:types": "tsc --declaration --emitDeclarationOnly",
34
34
  "build": "yarn clean && vite build && yarn build:types",
35
- "ci": "(cd ../..; yarn ci)"
35
+ "ci": "(cd ../..; yarn ci)",
36
+ "publish-api": "cd ../.. && yarn publish-api"
36
37
  },
37
38
  "devDependencies": {
38
- "@types/node": "^22.13.5",
39
+ "@types/node": "^24.0.7",
39
40
  "vite": "latest",
40
41
  "vite-plugin-commonjs": "^0.10.3",
41
- "vite-plugin-dts": "^4.3.0"
42
+ "vite-plugin-dts": "^4.5.4"
42
43
  },
43
44
  "peerDependencies": {
44
45
  "axios": "^1.7.7",