@evercam/api 1.0.0-45ea32a9b → 1.0.0-4691f88e3

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 (55) hide show
  1. package/README.md +3 -0
  2. package/dist/api/api/3dFirebaseApi.d.ts +16 -1
  3. package/dist/api/api/adminApi.d.ts +65 -32
  4. package/dist/api/api/aiApi.d.ts +25 -44
  5. package/dist/api/api/authzApi.d.ts +10 -1
  6. package/dist/api/api/client/axios.d.ts +1 -0
  7. package/dist/api/api/evercamApi.d.ts +24 -14
  8. package/dist/api/api/evercamLabsApi.d.ts +5 -2
  9. package/dist/api/api/ingestApi.d.ts +39 -11
  10. package/dist/api/api/ptzApi.d.ts +4 -0
  11. package/dist/api/api/videoWallApi.d.ts +7 -7
  12. package/dist/api/types/360.d.ts +188 -3
  13. package/dist/api/types/aconex.d.ts +102 -4
  14. package/dist/api/types/analytics.d.ts +78 -6
  15. package/dist/api/types/anpr.d.ts +5 -11
  16. package/dist/api/types/authz.d.ts +23 -0
  17. package/dist/api/types/automation.d.ts +51 -0
  18. package/dist/api/types/axios.d.ts +3 -0
  19. package/dist/api/types/camera.d.ts +20 -3
  20. package/dist/api/types/comments.d.ts +18 -2
  21. package/dist/api/types/company.d.ts +1 -1
  22. package/dist/api/types/coolify.d.ts +2 -0
  23. package/dist/api/types/credentials.d.ts +1 -0
  24. package/dist/api/types/detections.d.ts +5 -20
  25. package/dist/api/types/errors.d.ts +1 -0
  26. package/dist/api/types/gateReport.d.ts +4 -101
  27. package/dist/api/types/index.d.ts +3 -0
  28. package/dist/api/types/ingest.d.ts +4 -0
  29. package/dist/api/types/kit.d.ts +47 -5
  30. package/dist/api/types/planner.d.ts +4 -1
  31. package/dist/api/types/progressPhoto.d.ts +1 -30
  32. package/dist/api/types/project.d.ts +47 -3
  33. package/dist/api/types/recording.d.ts +1 -0
  34. package/dist/api/types/recycleBin.d.ts +14 -0
  35. package/dist/api/types/routeParams.d.ts +2 -1
  36. package/dist/api/types/router.d.ts +19 -0
  37. package/dist/api/types/shared.d.ts +0 -5
  38. package/dist/api/types/shares.d.ts +5 -5
  39. package/dist/api/types/siteAnalytics.d.ts +132 -27
  40. package/dist/api/types/snapshots.d.ts +9 -0
  41. package/dist/api/types/sso.d.ts +55 -0
  42. package/dist/api/types/streaming.d.ts +1 -2
  43. package/dist/api/types/time.d.ts +4 -0
  44. package/dist/api/types/user.d.ts +4 -0
  45. package/dist/api/types/videoWall.d.ts +34 -1
  46. package/dist/api/types/weather.d.ts +2 -0
  47. package/dist/api/types/widget.d.ts +27 -6
  48. package/dist/api/utils.d.ts +1 -0
  49. package/dist/index.js +1083 -860
  50. package/dist/index.js.map +1 -1
  51. package/dist/index.umd.cjs +1 -1
  52. package/dist/index.umd.cjs.map +1 -1
  53. package/dist/shared/types/components.d.ts +9 -2
  54. package/dist/shared/types/imagePlayer.d.ts +1 -1
  55. package/package.json +4 -4
@@ -1,32 +1,33 @@
1
- import type { BBox, BoundingBox, DateType, Schedule, CameraExid, DateTime, DetectionModel, PaginationParams, PpeLabel, ProjectExid } from "@evercam/api/types";
1
+ import { BBox, BoundingBox, DateType, Schedule, CameraExid, DateTime, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter, CameraFeatureFlag, TimelineDateInterval, Camera, AdminCamera, _360FullProject, _360FloorId, PaginatedItems } from "@evercam/api/types";
2
2
  import { DetectionLabel, DownloadFileType } from "@evercam/api/types";
3
3
  export declare enum SiteAnalyticsMode {
4
4
  Detections = "detections",
5
5
  Segments = "segments"
6
6
  }
7
- export type SmartSearchOptionData = {
7
+ export type SmartSearchPart = {
8
8
  id?: string;
9
- type: SmartSearchQueryComponentType;
9
+ type: SmartSearchPartType;
10
10
  value: DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | SmartSearchCondition | SmartSearchDateRange | string;
11
11
  };
12
- export type SmartSearchQueryPart = SmartSearchOptionData | [SmartSearchQueryPart] | SmartSearchQueryPart[];
13
- export declare enum SmartSearchQueryComponentType {
12
+ export declare enum SmartSearchComponentType {
14
13
  Condition = "condition",
15
14
  Object = "object",
16
15
  Area = "in_area",
17
16
  Time = "time",
18
17
  Operator = "operator",
19
- Camera = "camera",
20
- DateRange = "date_range"
18
+ View = "view",
19
+ DateRange = "date_range",
20
+ Heatmap = "heatmap"
21
21
  }
22
+ export type SmartSearchPartType = SmartSearchComponentType | SmartSearchCondition;
22
23
  export type SmartSearchDateRange = {
23
24
  start: DateType;
24
25
  end: DateType;
25
26
  };
26
- export type SmartSearchQueryComponentData = {
27
+ export type SmartSearchComponentData = {
27
28
  id: string;
28
- type: SmartSearchQueryComponentType;
29
- parts: [SmartSearchQueryPart];
29
+ type: SmartSearchComponentType;
30
+ parts: SmartSearchPart[];
30
31
  };
31
32
  export declare enum SmartSearchCondition {
32
33
  InArea = "in_area",
@@ -37,33 +38,33 @@ export type SmartSearchConditionData = {
37
38
  condition: SmartSearchCondition;
38
39
  value: string | BoundingBox | DetectionLabel | Date;
39
40
  };
40
- export type SmartSearchQueryCondition = {
41
- type: SmartSearchQueryConditionTypes;
42
- target: SmartSearchQueryTargets;
43
- operator?: SmartSearchQueryOperators;
41
+ export type SmartSearchBackendQueryCondition = {
42
+ type: SmartSearchConditionTypes;
43
+ target: SmartSearchTargets;
44
+ operator?: SmartSearchOperators;
44
45
  attribute?: string;
45
46
  value: string | number | string[];
46
47
  reference?: {
47
- target: SmartSearchQueryTargets;
48
+ target: SmartSearchTargets;
48
49
  attribute: string;
49
50
  value: string | number | string[];
50
51
  };
51
52
  polygon?: BBox;
52
53
  };
53
- export type SmartSearchQuery = {
54
- returnTargets: SmartSearchQueryTargets[];
54
+ export type SmartSearchBackendQuery = {
55
+ returnTargets: SmartSearchTargets[];
55
56
  rulesLogic: SmartSearchOperatorType;
56
57
  rules: {
57
58
  logic: SmartSearchOperatorType;
58
- conditions: SmartSearchQueryCondition[];
59
+ conditions: SmartSearchBackendQueryCondition[];
59
60
  }[];
60
- returnType: SmartSearchQueryReturnType;
61
+ returnType: SmartSearchReturnType;
61
62
  };
62
- export declare enum SmartSearchQueryTargets {
63
+ export declare enum SmartSearchTargets {
63
64
  Tracking = "tracking",
64
65
  Segments = "segments"
65
66
  }
66
- export declare enum SmartSearchQueryReturnType {
67
+ export declare enum SmartSearchReturnType {
67
68
  All = "all",
68
69
  FirstLastSeen = "first_last_seen"
69
70
  }
@@ -71,7 +72,7 @@ export declare enum SmartSearchOperatorType {
71
72
  And = "AND",
72
73
  Or = "OR"
73
74
  }
74
- export declare enum SmartSearchQueryOperators {
75
+ export declare enum SmartSearchOperators {
75
76
  Near = "near",
76
77
  Far = "far",
77
78
  Intersects = "intersects",
@@ -83,21 +84,22 @@ export declare enum SmartSearchQueryOperators {
83
84
  Area = "in_area",
84
85
  Equal = "="
85
86
  }
86
- export declare enum SmartSearchQueryConditionTypes {
87
+ export declare enum SmartSearchConditionTypes {
87
88
  Selection = "selection",
88
89
  Spatial = "spatial",
89
90
  Area = "area",
91
+ GeoArea = "in_geo_area",
90
92
  Iou = "iou",
91
93
  Near = "near",
92
94
  Far = "far"
93
95
  }
94
96
  export type SmartSearchOptionValue = DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData;
95
- export type SmartSearchQueryParams = {
97
+ export type SmartSearchBackendQueryPayload = {
96
98
  cameraExid: string;
97
99
  name: string;
98
100
  description: string;
99
101
  query: {
100
- req: SmartSearchQuery;
102
+ req: SmartSearchBackendQuery;
101
103
  timeSchedule?: Schedule | undefined;
102
104
  };
103
105
  fromDate?: DateType;
@@ -110,11 +112,11 @@ export type SavedQuery = {
110
112
  description: string;
111
113
  id: number;
112
114
  query: {
113
- req: SmartSearchQuery;
115
+ req: SmartSearchBackendQuery;
114
116
  timeSchedule?: Schedule | undefined;
115
117
  };
116
118
  params: Record<string, string>;
117
- components?: Omit<SmartSearchOptionData, "id">[];
119
+ components?: Omit<SmartSearchPart, "id">[];
118
120
  toDate?: DateType;
119
121
  createdAt?: DateType;
120
122
  cameraExid: string;
@@ -140,3 +142,106 @@ export type DetectionsExportRequestParams = DetectionsRequestParams & {
140
142
  columns?: string[];
141
143
  directDownload?: boolean;
142
144
  };
145
+ export type SmartSearchHeatmapPoint = {
146
+ coordinates: [number, number];
147
+ detectionsCount: number;
148
+ };
149
+ export type SmartSearchHeatmapData = {
150
+ label: string;
151
+ points: SmartSearchHeatmapPoint[];
152
+ };
153
+ export type SmartSearchNearConfig = {
154
+ sourceLabels: DetectionLabel[];
155
+ targetLabel?: DetectionLabel;
156
+ };
157
+ export type HeatmapIntersectionsRequestParams = CameraDateRangeFilter & SmartSearchNearConfig;
158
+ export type SmartSearchSidebarItem = {
159
+ key: string;
160
+ displayLabel: string;
161
+ data: SmartSearchHeatmapData;
162
+ imagePath?: string;
163
+ };
164
+ export declare enum SiteAnalyticsViewType {
165
+ Camera = "camera",
166
+ ThreeSixty = "360"
167
+ }
168
+ type SiteAnalyticsViewByType = {
169
+ [SiteAnalyticsViewType.Camera]: Camera | AdminCamera;
170
+ [SiteAnalyticsViewType.ThreeSixty]: _360FullProject;
171
+ };
172
+ export type SiteAnalyticsView<T extends SiteAnalyticsViewType = SiteAnalyticsViewType.Camera> = {
173
+ type: SiteAnalyticsViewType;
174
+ value: SiteAnalyticsViewByType[T];
175
+ };
176
+ export type SiteAnalyticsProcessingStatusPayload = {
177
+ projectExid?: ProjectExid;
178
+ fromDate?: DateType;
179
+ toDate?: DateType;
180
+ cameraExid?: CameraExid;
181
+ drawingId?: string;
182
+ features?: CameraFeatureFlag[];
183
+ };
184
+ export type SiteAnalyticsProcessingStatus = {
185
+ projectExid: ProjectExid;
186
+ viewType: SiteAnalyticsViewType;
187
+ viewId: string;
188
+ feature: CameraFeatureFlag;
189
+ processedIntervals: TimelineDateInterval[];
190
+ };
191
+ export type SmartSearchRequestPayload = {
192
+ cameraExids?: CameraExid[];
193
+ drawingIds?: _360FloorId[];
194
+ walkIds?: string[];
195
+ markerIds?: string[];
196
+ payload: SmartSearchBackendQuery;
197
+ fromDate?: string;
198
+ toDate?: string;
199
+ page?: number;
200
+ pageSize?: number;
201
+ threshold?: number;
202
+ };
203
+ type SmartSearchResultItemBase = {
204
+ area: number;
205
+ bbox: BBox;
206
+ cameraExid?: CameraExid;
207
+ centroid: number[];
208
+ confidenceScore: number;
209
+ drawingId?: _360FloorId;
210
+ label: DetectionLabel;
211
+ modelId: DetectionModel;
212
+ projectExid: ProjectExid;
213
+ segmentId?: number;
214
+ trackId: number;
215
+ walkId?: string | number;
216
+ };
217
+ export type SmartSearchResultItemFirstLastSeen = SmartSearchResultItemBase & {
218
+ firstSeen: DateType;
219
+ firstSeenMarkerId?: string | number;
220
+ lastSeen: DateType;
221
+ lastSeenMarkerId?: string | number;
222
+ };
223
+ export type SmartSearchResultItemAll = SmartSearchResultItemBase & {
224
+ walkId?: string | number;
225
+ markerId?: string | number;
226
+ geolocation?: number[];
227
+ mask?: number[][];
228
+ timestamp: DateType;
229
+ };
230
+ type SmartSearchResultItemByType = {
231
+ [SmartSearchReturnType.FirstLastSeen]: SmartSearchResultItemFirstLastSeen;
232
+ [SmartSearchReturnType.All]: SmartSearchResultItemAll;
233
+ };
234
+ export type SmartSearchResponse<R extends SmartSearchReturnType = SmartSearchReturnType.FirstLastSeen> = {
235
+ data: PaginatedItems<SmartSearchResultItemByType[R]>;
236
+ message?: string;
237
+ success: boolean;
238
+ };
239
+ export type SmartSearchMinifiedPart = {
240
+ t: SmartSearchComponentType;
241
+ v: unknown;
242
+ };
243
+ export type SmartSearchMinifiedComponent = {
244
+ t: SmartSearchComponentType;
245
+ p: SmartSearchMinifiedPart[];
246
+ };
247
+ export {};
@@ -48,3 +48,12 @@ export type DeleteSnapshotQueryParams = {
48
48
  adminEmail: string;
49
49
  adminFullname: string;
50
50
  };
51
+ export type TransferCloudRecordingsQueryParams = {
52
+ targetCameraExid: CameraExid;
53
+ fromDate: DateType;
54
+ toDate: DateType;
55
+ overwriteExistingSnapshots?: boolean;
56
+ keepSourceSnapshots?: boolean;
57
+ adminEmail?: string;
58
+ adminFullname?: string;
59
+ };
@@ -0,0 +1,55 @@
1
+ export type SsoProvider = {
2
+ id: number;
3
+ name: string;
4
+ exid: string;
5
+ clientId: string;
6
+ clientSecret: string;
7
+ scope: string;
8
+ responseType: string;
9
+ loginUrl: string;
10
+ iconUrl: string;
11
+ options: {
12
+ showOnLogin: boolean;
13
+ showOnSignup: boolean;
14
+ };
15
+ tokenUri: string;
16
+ tokenIntrospectionUri: string;
17
+ userInfoUri: string;
18
+ enabled: boolean;
19
+ };
20
+ export type SsoUpdatePayload = {
21
+ name: string;
22
+ exid: string;
23
+ clientId: string;
24
+ clientSecret: string;
25
+ scope: string;
26
+ responseType: string;
27
+ loginUrl: string;
28
+ iconUrl: string;
29
+ options: {
30
+ showOnLogin: boolean;
31
+ showOnSignup: boolean;
32
+ };
33
+ tokenUri: string;
34
+ tokenIntrospectionUri: string;
35
+ userInfoUri: string;
36
+ enabled: boolean;
37
+ };
38
+ export type SsoCreatePayload = {
39
+ name: string;
40
+ exid: string;
41
+ clientId: string;
42
+ clientSecret: string;
43
+ scope: string;
44
+ responseType: string;
45
+ loginUrl: string;
46
+ iconUrl: string;
47
+ options: {
48
+ showOnLogin: boolean;
49
+ showOnSignup: boolean;
50
+ };
51
+ tokenUri: string;
52
+ tokenIntrospectionUri: string;
53
+ userInfoUri: string;
54
+ enabled: boolean;
55
+ };
@@ -39,8 +39,7 @@ export type ExNvrDeviceConfig = {
39
39
  timezone: string;
40
40
  };
41
41
  export declare enum ExNvrFootageAvailableStatus {
42
- Active = "Active",
43
- NotActive = "Not Active",
42
+ Available = "Available",
44
43
  NotAvailable = "Not Available"
45
44
  }
46
45
  export declare enum ExNvrDeviceState {
@@ -18,4 +18,8 @@ export type DateTime_tz = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}${"+" | "-"}${HH}:
18
18
  export type DateTime_Z = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}Z` | string;
19
19
  export type DateTime_Z_micros = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}.${microS}Z` | string;
20
20
  export type DateTimeSpaceSeparated = `${Date_YYYY_MM_DD} ${Time_HH_mm_ss}` | string;
21
+ export type DateRangeFilter = {
22
+ fromDate: DateType;
23
+ toDate: DateType;
24
+ };
21
25
  export {};
@@ -59,6 +59,10 @@ export type ProjectUser = User & {
59
59
  cameraExid: string;
60
60
  cameraRights: string;
61
61
  };
62
+ export declare enum ContactRole {
63
+ SalesExecutive = "Sales Executive",
64
+ CustomerSuccessManager = "Customer Success Manager"
65
+ }
62
66
  export declare enum Persona {
63
67
  HQ = "HQ",
64
68
  PM = "PM",
@@ -1,4 +1,4 @@
1
- import { Camera, Media } from "@/types";
1
+ import { Camera, Media, PaginationParams } from "@/types";
2
2
  export declare enum VideoWallItemType {
3
3
  LiveView = "live",
4
4
  Video = "video",
@@ -31,3 +31,36 @@ export type VideoWallPresetItem = {
31
31
  weather?: Record<string, unknown>;
32
32
  media?: Media;
33
33
  };
34
+ export type VideoWallSource = "default" | "widget";
35
+ export interface VideoWall {
36
+ id: number;
37
+ exid: string;
38
+ name: string;
39
+ source: VideoWallSource;
40
+ config: Record<string, any>;
41
+ inserted_at: string;
42
+ updated_at: string;
43
+ user: {
44
+ id: number;
45
+ firstname: string;
46
+ lastname: string;
47
+ email: string;
48
+ };
49
+ }
50
+ export interface ListParams extends PaginationParams {
51
+ project_exid?: string;
52
+ id?: number;
53
+ exid?: string;
54
+ project_id?: number;
55
+ user_id?: number;
56
+ name?: string;
57
+ project?: string;
58
+ user?: string;
59
+ source?: VideoWallSource;
60
+ }
61
+ export type VideoWallCreateUpdatePayload = {
62
+ project_exid: string;
63
+ name: string;
64
+ source?: VideoWallSource;
65
+ config: Record<string, unknown>;
66
+ };
@@ -5,6 +5,8 @@ export type HistoryWeatherRequestPayload = {
5
5
  };
6
6
  export type CurrentWeatherRequestPayload = {
7
7
  provider: WeatherProvider;
8
+ includeForecast?: boolean;
9
+ forecastDays?: number;
8
10
  };
9
11
  export type WeatherResponsePayload = Array<{
10
12
  hour?: number;
@@ -53,6 +53,19 @@ export declare enum VideoWallWidgetSettingsKeys {
53
53
  Height = "height",
54
54
  HeightResolution = "heightResolution"
55
55
  }
56
+ export declare enum ThreeSixtyKeys {
57
+ DateId = "dateId",
58
+ DateLocked = "dateLocked",
59
+ FloorId = "floorId",
60
+ FloorLocked = "floorLocked",
61
+ Marker = "markerId",
62
+ MarkerLocked = "markerLocked",
63
+ MediaLocked = "mediaLocked",
64
+ Width = "width",
65
+ WidthResolution = "resolution",
66
+ Height = "height",
67
+ HeightResolution = "heightResolution"
68
+ }
56
69
  export type CommonWidgetSettings = {
57
70
  width: number;
58
71
  resolution: string;
@@ -65,6 +78,8 @@ export type RecordingsWidgetSettings = CommonWidgetSettings & {
65
78
  hasDelay: boolean;
66
79
  delay: number;
67
80
  delayUnit: DelayUnit;
81
+ hasRange: boolean;
82
+ dateRange: [DateTime, DateTime] | null;
68
83
  };
69
84
  export type LiveViewWidgetSettings = CommonWidgetSettings & {
70
85
  fullscreen: boolean;
@@ -81,12 +96,18 @@ export type VideoWallWidgetSettings = CommonWidgetSettings & {
81
96
  preset: VideoWallPresetItemConfig;
82
97
  refreshRate: number;
83
98
  };
84
- export type WidgetSettings = RecordingsWidgetSettings | LiveViewWidgetSettings | BimCompareWidgetSettings | VideoWallWidgetSettings;
99
+ export type ThreeSixtyWidgetSettings = CommonWidgetSettings & {
100
+ dateId: string;
101
+ floorId: string;
102
+ markerId: string;
103
+ };
104
+ export type WidgetSettings = RecordingsWidgetSettings | LiveViewWidgetSettings | BimCompareWidgetSettings | VideoWallWidgetSettings | ThreeSixtyWidgetSettings;
85
105
  export declare enum WidgetType {
86
106
  LiveWidget = "Live View",
87
107
  Recording = "Recordings",
88
108
  BimCompare = "BIM Compare",
89
- VideoWall = "Video Wall"
109
+ VideoWall = "Video Wall",
110
+ ThreeSixty = "360"
90
111
  }
91
112
  export declare const WidgetTypesByResource: {
92
113
  camera: WidgetType[];
@@ -99,7 +120,7 @@ export type WidgetsListRequestPayload = PaginationParams & {
99
120
  active: boolean;
100
121
  settings: WidgetSettings;
101
122
  widgetType: WidgetType;
102
- isPublic: boolean;
123
+ domainRestricted: boolean;
103
124
  allowedOrigin: string;
104
125
  };
105
126
  export type Widget = {
@@ -119,7 +140,7 @@ export type Widget = {
119
140
  widgetType: WidgetType;
120
141
  settings: WidgetSettings;
121
142
  allowedOrigin: string;
122
- isPublic: boolean;
143
+ domainRestricted: boolean;
123
144
  active: boolean;
124
145
  user: {
125
146
  id: number;
@@ -155,7 +176,7 @@ export type WidgetFull = {
155
176
  settings: WidgetSettings;
156
177
  sessionSettings: any;
157
178
  allowedOrigin: string;
158
- isPublic: boolean;
179
+ domainRestricted: boolean;
159
180
  insertedAt: DateTime;
160
181
  updatedAt: DateTime;
161
182
  };
@@ -167,6 +188,6 @@ export type WidgetPayload = {
167
188
  widgetType: WidgetType;
168
189
  active: boolean;
169
190
  settings: WidgetSettings;
170
- isPublic: boolean;
191
+ domainRestricted: boolean;
171
192
  allowedOrigin: string;
172
193
  };
@@ -7,3 +7,4 @@ export declare const toQueryString: <T extends Record<string, unknown>>(paramsOb
7
7
  forceArrayBrackets?: boolean | undefined;
8
8
  }) => string | undefined;
9
9
  export declare function queryStringToObject(queryString?: string): QueryParams;
10
+ export declare function capitalizeFirstLetter(inputString: string): string;