@evercam/api 1.0.0-7efbe5a66 → 1.0.0-7f2a06308

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.
@@ -1,4 +1,4 @@
1
- import { AnprDirection, CameraExid, Date_HH, Date_YYYY, Date_YYYY_MM, Date_YYYY_MM_DD, DateTime, DateTimeSpaceSeparated, DateType, PaginatedItems, PaginationParams, ProjectExid, ProjectFeatureFlag, Timestamp } from "@/types";
1
+ import { AnprDirection, CameraExid, Date_HH, Date_YYYY, Date_YYYY_MM, Date_YYYY_MM_DD, DateTime, DateTimeSpaceSeparated, DateType, PaginatedItems, PaginationParams, ProjectExid, Timestamp } from "@/types";
2
2
  export declare enum GateReportDetectionType {
3
3
  Auto = "auto",
4
4
  Manual = "manual",
@@ -59,16 +59,19 @@ export declare enum DetectionLabel {
59
59
  ConcreteBlock = "concrete_block",
60
60
  ConcretePipe = "concrete_pipe",
61
61
  ConcreteSlab = "concrete_slab",
62
+ Door = "door",
62
63
  PlasticWrap = "plastic_wrap",
63
64
  ContainerOffice = "container_office",
64
65
  ElectricalPole = "electrical_pole",
65
66
  ElectricalBox = "electrical_box",
66
67
  FireHydrant = "fire_hydrant",
68
+ FireExtinguisher = "fire-extinguisher",
67
69
  HoseReel = "hose_reel",
68
70
  Ladder = "ladder",
69
71
  MetalBeam = "metal_beam",
70
72
  MetalPipe = "metal_pipe",
71
73
  Pallet = "pallet",
74
+ Person = "person",
72
75
  Pillar = "pillar",
73
76
  PlasticBin = "plastic_bin",
74
77
  PlasticBucket = "plastic_bucket",
@@ -214,24 +217,6 @@ export type EventCountResponsePayload = {
214
217
  months?: MonthlyEventCount[];
215
218
  years?: YearlyEventCount[];
216
219
  };
217
- export type ProcessedDaysRequestPayload = {
218
- apiId?: string;
219
- apiKey?: string;
220
- isPublic?: Boolean;
221
- };
222
- export type EventsRequestPayload = {
223
- apiId?: string;
224
- apiKey?: string;
225
- camerasExid?: CameraExid[];
226
- cameras?: string[];
227
- eventType?: GateReportEventType;
228
- fromDate?: DateTime;
229
- isPublic?: boolean;
230
- toDate?: DateTime;
231
- truckTypes?: GateReportVehicleType[];
232
- vehicleTypes?: string[];
233
- } & PaginationParams;
234
- export type EventsResponsePayload = PaginatedItems<GateReportEvent>;
235
220
  export declare enum GateReportDataSource {
236
221
  Anpr = "anpr",
237
222
  Events = "events"
@@ -311,52 +296,6 @@ export type GateReportCamera = {
311
296
  last_published_day: DateType;
312
297
  last_processed_day: DateType;
313
298
  };
314
- export type GateReportProject = {
315
- exid: string;
316
- name: string;
317
- status: string;
318
- featureFlags: ProjectFeatureFlag;
319
- cameras: GateReportCamera[];
320
- };
321
- export type AnalyticsParameters = {
322
- id: number;
323
- cameraex: string;
324
- processingType: string;
325
- startDate: DateTime;
326
- endDate: DateTime;
327
- skipWeekend: boolean;
328
- hourSiteOpening: number;
329
- hourSiteClosure: number;
330
- gateReportActive: boolean;
331
- countingActive: boolean;
332
- queueSystem: string;
333
- reprocess: boolean;
334
- framesToSkip: number;
335
- detection_model: string;
336
- detectionThreshold: number;
337
- printLogsFrame: number;
338
- crossingVectorAngleLimit: number;
339
- minTruckLife: number;
340
- insideMinTime: number;
341
- trackerMaxAge: number;
342
- trackerMinHit: number;
343
- snapshotUpload: boolean;
344
- snapshotPerSecond: number;
345
- detectionClasses: string;
346
- deepEventEndpointUrl: string;
347
- timestampCalculation: string;
348
- matchingEmbeddedDstCoeff: number;
349
- matchingTimeCoeff: number;
350
- matchingQueueOrderCoeff: number;
351
- rabbitmqServerUrl: string;
352
- rabbitmqEventsQueue: string;
353
- rabbitmqEventsExchange: string;
354
- rabbitmqCountingQueue: string;
355
- rabbitmqCountingExchange: string;
356
- dangerZones: boolean;
357
- workflows: boolean;
358
- linkedAnprCameras: Record<string, unknown>;
359
- };
360
299
  export type VerifiedDaysQueryParams = PaginationParams & {
361
300
  projectExid: ProjectExid;
362
301
  camerasExid: CameraExid[];
@@ -366,30 +305,6 @@ export type VerifiedDaysQueryParams = PaginationParams & {
366
305
  updatedAt: DateTime[];
367
306
  day: string;
368
307
  };
369
- export type EventUpdateRequestPayload = {
370
- cameraex: string;
371
- roiId: number;
372
- eventType: string;
373
- eventTime: "2024-12-13T14:25:58.066Z";
374
- truckType: string;
375
- isPublic: boolean;
376
- boundingBox: {
377
- additionalProp1: number;
378
- additionalProp2: number;
379
- additionalProp3: number;
380
- };
381
- valid: boolean;
382
- loadState: string;
383
- embeddingId: number;
384
- embedding: number[];
385
- similarityDst: number;
386
- detectionType: string;
387
- trackingId: number;
388
- deliveriesId: number;
389
- edited: boolean;
390
- isDeleted: boolean;
391
- modelVersion: string;
392
- };
393
308
  export type VerifyDayUpdateRequestPayload = {
394
309
  camerasExid: string[];
395
310
  projectExid: string;
@@ -402,18 +317,6 @@ export type ProcessedDaysQueryParams = {
402
317
  isPublic: boolean;
403
318
  eventType: GateReportEventType;
404
319
  };
405
- export type SecurityMeasurementQueryParams = {
406
- cameraex: string;
407
- timestamp: DateTime;
408
- prompt: string;
409
- snapshotUrl: string;
410
- };
411
- export type ObjectDetectionQueryParams = {
412
- cameraex: string;
413
- timestamp: DateTime;
414
- base64Img: string;
415
- snapshotUrl: string;
416
- };
417
320
  export type RoisQueryParams = {
418
321
  cameraExid: string;
419
322
  id: number;
@@ -355,3 +355,22 @@ export type KitAlarmItem = {
355
355
  startDate: DateTime;
356
356
  endDate: DateTime | null;
357
357
  };
358
+ export type KitBox = {
359
+ id: string;
360
+ gatewaySerial: string;
361
+ gatewayMac: string;
362
+ gatewayConfig: Record<string, unknown> | null;
363
+ insertedAt: DateTime;
364
+ updatedAt: DateTime;
365
+ };
366
+ export type KitBoxCreatePayload = {
367
+ id?: string;
368
+ gatewaySerial: string;
369
+ gatewayMac: string;
370
+ gatewayConfig?: Record<string, unknown>;
371
+ };
372
+ export type KitBoxQueryParams = PaginationParams & {
373
+ id: string;
374
+ gatewaySerial: string;
375
+ gatewayMac: string;
376
+ };
@@ -53,7 +53,6 @@ export declare enum ProjectFeatureFlag {
53
53
  ThreeSixtyView = "360_view",
54
54
  NdaMc = "NDA/MC",
55
55
  GateReport = "gate_report",
56
- GateReportAutoVerify = "auto_publish",
57
56
  GateReportMotionDetection = "motion_detection",
58
57
  FullEmpty = "full_empty",
59
58
  MediaHubSharing = "archives_sharing",
@@ -139,7 +138,13 @@ export type ProjectMember = {
139
138
  id: string;
140
139
  email: string;
141
140
  fullname: string;
141
+ lastSeenAt?: DateTime;
142
142
  role: ProjectRole;
143
+ permissions?: string[];
144
+ subRoles?: Array<{
145
+ resourceId: string;
146
+ roleId: number;
147
+ }>;
143
148
  };
144
149
  export type ProjectInvite = {
145
150
  id?: string;
@@ -47,6 +47,10 @@ export declare enum RouterStatus {
47
47
  Active = "active",
48
48
  Inactive = "inactive"
49
49
  }
50
+ export declare enum RouterScanInputMode {
51
+ Qr = "qr",
52
+ Manual = "manual"
53
+ }
50
54
  export type RouterQueryParams = PaginationParams & {
51
55
  routerType: string;
52
56
  vpnServer: string;
@@ -65,3 +69,18 @@ export type RouterCreatePayload = {
65
69
  vpnServer?: string;
66
70
  netbirdUrl?: string;
67
71
  };
72
+ export type RouterQRScanResult = {
73
+ raw: string;
74
+ timestamp: string;
75
+ sn?: string;
76
+ m?: string;
77
+ u?: string;
78
+ pw?: string;
79
+ t?: string;
80
+ s?: string;
81
+ p?: string;
82
+ i?: string;
83
+ b?: string;
84
+ boxId?: string;
85
+ isDuplicate?: boolean;
86
+ };
@@ -1,4 +1,4 @@
1
- import type { CameraExid, DateTime, DateType } from "@/types";
1
+ import type { DateType } from "@/types";
2
2
  export type ShareRequest = {
3
3
  cameraId: string;
4
4
  createdAt: DateType | number;
@@ -24,19 +24,6 @@ export type Share = {
24
24
  userId: number;
25
25
  isUserAccessRestricted: boolean;
26
26
  };
27
- export type ShareRequestsResponsePayload = {
28
- shareRequests: ShareRequest[];
29
- };
30
- export type ShareOwner = {
31
- email: string;
32
- fullname: string;
33
- lastSeenAt: DateType;
34
- sessionCount: number;
35
- };
36
- export type SharesResponsePayload = {
37
- owner: ShareOwner;
38
- shares: Share[];
39
- };
40
27
  export type ShareDeletionRequestPayload = {
41
28
  email?: string;
42
29
  key?: string;
@@ -54,143 +41,18 @@ export type ShareCreateRequestPayload = {
54
41
  apiId?: string;
55
42
  apiKey?: string;
56
43
  };
57
- export type ShareProjectCamerasRequestPayload = {
58
- email: string[];
59
- cameraExids: CameraExid[];
60
- message: string;
61
- permission?: string;
62
- rights: string;
63
- };
64
- export type UpdateUserRestrictionPayload = {
65
- email: string[];
66
- isUserAccessRestricted: boolean;
67
- };
68
44
  export type ShareCreateResponsePayload = {
69
45
  shares: Share[];
70
46
  shareRequests: ShareRequest[];
71
47
  };
72
- export type ShareRequestByKeyResponsePayload = {
73
- shareRequests: Array<{
74
- id: string;
75
- email: string;
76
- rights: string;
77
- cameraId: string;
78
- sharerName: string;
79
- userId: string;
80
- sharerEmail: string;
81
- createdAt: DateType;
82
- }>;
83
- };
84
- export type ResendShareRequestPayload = {
85
- email: string;
86
- apiId?: string;
87
- apiKey?: string;
88
- };
89
- export declare enum SharePermission {
90
- Minimum = "minimum",
91
- Share = "minimal+share",
92
- Full = "full",
93
- Custom = "custom"
94
- }
95
- export declare enum ShareType {
96
- Share = "share",
97
- Request = "request"
98
- }
99
- export declare enum ShareRequestStatus {
100
- Pending = -1,
101
- Cancelled = -2,
102
- Failed = -3,
103
- Used = 1
48
+ export declare enum InviteStatus {
49
+ Pending = 0,
50
+ Cancelled = -1,
51
+ Used = 1,
52
+ Failed = -2
104
53
  }
105
54
  export declare enum ShareVisibility {
106
55
  PublicDiscoverable = "publicDiscoverable",
107
56
  PublicUndiscoverable = "publicUndiscoverable",
108
57
  Private = "private"
109
58
  }
110
- export type ProjectShare = {
111
- id: number;
112
- projectId: string;
113
- userId: number;
114
- email: string;
115
- fullname: string;
116
- sharerId: number;
117
- sharerEmail: string;
118
- sharerName: string;
119
- role: "member" | "admin";
120
- cameras: Record<string, string>;
121
- message: string | null;
122
- updatedAt: DateType;
123
- insertedAt: DateType;
124
- };
125
- export type ProjectShareRequest = ProjectShare;
126
- export type ProjectShareResponse = {
127
- projectShares: ProjectShare[];
128
- projectShareRequests: ProjectShareRequest[];
129
- };
130
- export type AdminShare = {
131
- sharerId: number;
132
- sharerFullname: string;
133
- sharerApiId: string;
134
- sharerApiKey: string;
135
- shareeId: number;
136
- shareeFullname: string;
137
- shareeApiId: string;
138
- shareeApiKey: string;
139
- shareeEmail: string;
140
- cameraId: number;
141
- exid: string;
142
- projectId: string;
143
- name: string;
144
- id: number;
145
- message: string;
146
- createdAt: DateType;
147
- };
148
- export type CameraShareRequestPayload = {
149
- email: string[];
150
- rights: string;
151
- message?: string;
152
- };
153
- export type ShareQueryParams = {
154
- exid: string;
155
- sharerFullname: string;
156
- shareeFullname: string;
157
- shareeEmail: string;
158
- };
159
- export type CameraShare = {
160
- sharerId: number;
161
- sharerFullname: string;
162
- sharerApiId: string;
163
- sharerApiKey: string;
164
- shareeId: number;
165
- shareeFullname: string;
166
- shareeApiId: string;
167
- shareeApiKey: string;
168
- shareeEmail: string;
169
- cameraId: number;
170
- exid: string;
171
- projectId: string;
172
- name: string;
173
- id: number;
174
- message: string;
175
- createdAt: DateTime;
176
- };
177
- export type CameraShareRequestsQueryParams = {
178
- shareeEmail: string;
179
- camera: string;
180
- sharer: string;
181
- status: string;
182
- };
183
- export type CameraShareRequest = {
184
- id: number;
185
- shareeEmail: string;
186
- camera: string;
187
- sharer: string;
188
- message: number;
189
- rights: string;
190
- status: number;
191
- projectId: string;
192
- cameraExid: string;
193
- apiId: string;
194
- apiKey: number;
195
- createdAt: DateTime;
196
- };
@@ -1,34 +1,33 @@
1
- import type { BBox, BoundingBox, DateType, Schedule, CameraExid, DateTime, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter } 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 SmartSearchQueryPartData = {
7
+ export type SmartSearchPart = {
8
8
  id?: string;
9
- type: SmartSearchQueryPartType;
9
+ type: SmartSearchPartType;
10
10
  value: DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | SmartSearchCondition | SmartSearchDateRange | string;
11
11
  };
12
- export type SmartSearchQueryPart = SmartSearchQueryPartData | SmartSearchQueryPartData[];
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",
18
+ View = "view",
20
19
  DateRange = "date_range",
21
20
  Heatmap = "heatmap"
22
21
  }
23
- export type SmartSearchQueryPartType = SmartSearchQueryComponentType | SmartSearchCondition;
22
+ export type SmartSearchPartType = SmartSearchComponentType | SmartSearchCondition;
24
23
  export type SmartSearchDateRange = {
25
24
  start: DateType;
26
25
  end: DateType;
27
26
  };
28
- export type SmartSearchQueryComponentData = {
27
+ export type SmartSearchComponentData = {
29
28
  id: string;
30
- type: SmartSearchQueryComponentType;
31
- parts: SmartSearchQueryPart;
29
+ type: SmartSearchComponentType;
30
+ parts: SmartSearchPart[];
32
31
  };
33
32
  export declare enum SmartSearchCondition {
34
33
  InArea = "in_area",
@@ -39,33 +38,33 @@ export type SmartSearchConditionData = {
39
38
  condition: SmartSearchCondition;
40
39
  value: string | BoundingBox | DetectionLabel | Date;
41
40
  };
42
- export type SmartSearchQueryCondition = {
43
- type: SmartSearchQueryConditionTypes;
44
- target: SmartSearchQueryTargets;
45
- operator?: SmartSearchQueryOperators;
41
+ export type SmartSearchBackendQueryCondition = {
42
+ type: SmartSearchConditionTypes;
43
+ target: SmartSearchTargets;
44
+ operator?: SmartSearchOperators;
46
45
  attribute?: string;
47
46
  value: string | number | string[];
48
47
  reference?: {
49
- target: SmartSearchQueryTargets;
48
+ target: SmartSearchTargets;
50
49
  attribute: string;
51
50
  value: string | number | string[];
52
51
  };
53
52
  polygon?: BBox;
54
53
  };
55
- export type SmartSearchQuery = {
56
- returnTargets: SmartSearchQueryTargets[];
54
+ export type SmartSearchBackendQuery = {
55
+ returnTargets: SmartSearchTargets[];
57
56
  rulesLogic: SmartSearchOperatorType;
58
57
  rules: {
59
58
  logic: SmartSearchOperatorType;
60
- conditions: SmartSearchQueryCondition[];
59
+ conditions: SmartSearchBackendQueryCondition[];
61
60
  }[];
62
- returnType: SmartSearchQueryReturnType;
61
+ returnType: SmartSearchReturnType;
63
62
  };
64
- export declare enum SmartSearchQueryTargets {
63
+ export declare enum SmartSearchTargets {
65
64
  Tracking = "tracking",
66
65
  Segments = "segments"
67
66
  }
68
- export declare enum SmartSearchQueryReturnType {
67
+ export declare enum SmartSearchReturnType {
69
68
  All = "all",
70
69
  FirstLastSeen = "first_last_seen"
71
70
  }
@@ -73,7 +72,7 @@ export declare enum SmartSearchOperatorType {
73
72
  And = "AND",
74
73
  Or = "OR"
75
74
  }
76
- export declare enum SmartSearchQueryOperators {
75
+ export declare enum SmartSearchOperators {
77
76
  Near = "near",
78
77
  Far = "far",
79
78
  Intersects = "intersects",
@@ -85,21 +84,22 @@ export declare enum SmartSearchQueryOperators {
85
84
  Area = "in_area",
86
85
  Equal = "="
87
86
  }
88
- export declare enum SmartSearchQueryConditionTypes {
87
+ export declare enum SmartSearchConditionTypes {
89
88
  Selection = "selection",
90
89
  Spatial = "spatial",
91
90
  Area = "area",
91
+ GeoArea = "in_geo_area",
92
92
  Iou = "iou",
93
93
  Near = "near",
94
94
  Far = "far"
95
95
  }
96
96
  export type SmartSearchOptionValue = DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData;
97
- export type SmartSearchQueryParams = {
97
+ export type SmartSearchBackendQueryPayload = {
98
98
  cameraExid: string;
99
99
  name: string;
100
100
  description: string;
101
101
  query: {
102
- req: SmartSearchQuery;
102
+ req: SmartSearchBackendQuery;
103
103
  timeSchedule?: Schedule | undefined;
104
104
  };
105
105
  fromDate?: DateType;
@@ -112,11 +112,11 @@ export type SavedQuery = {
112
112
  description: string;
113
113
  id: number;
114
114
  query: {
115
- req: SmartSearchQuery;
115
+ req: SmartSearchBackendQuery;
116
116
  timeSchedule?: Schedule | undefined;
117
117
  };
118
118
  params: Record<string, string>;
119
- components?: Omit<SmartSearchQueryPartData, "id">[];
119
+ components?: Omit<SmartSearchPart, "id">[];
120
120
  toDate?: DateType;
121
121
  createdAt?: DateType;
122
122
  cameraExid: string;
@@ -161,3 +161,87 @@ export type SmartSearchSidebarItem = {
161
161
  data: SmartSearchHeatmapData;
162
162
  imagePath?: string;
163
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 {};