@evercam/api 1.0.0-e03adefb8 → 1.0.0-e405b2c39

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 (59) hide show
  1. package/README.md +3 -0
  2. package/dist/api/api/3dFirebaseApi.d.ts +17 -1
  3. package/dist/api/api/adminApi.d.ts +67 -33
  4. package/dist/api/api/aiApi.d.ts +26 -45
  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/client/swr/Swr.d.ts +14 -0
  8. package/dist/api/api/client/swr/SwrStore.d.ts +10 -0
  9. package/dist/api/api/evercamApi.d.ts +42 -44
  10. package/dist/api/api/evercamLabsApi.d.ts +5 -2
  11. package/dist/api/api/ingestApi.d.ts +40 -12
  12. package/dist/api/api/ptzApi.d.ts +4 -0
  13. package/dist/api/api/videoWallApi.d.ts +7 -7
  14. package/dist/api/types/360.d.ts +188 -3
  15. package/dist/api/types/aconex.d.ts +102 -4
  16. package/dist/api/types/analytics.d.ts +89 -6
  17. package/dist/api/types/anpr.d.ts +5 -11
  18. package/dist/api/types/authz.d.ts +23 -0
  19. package/dist/api/types/automation.d.ts +51 -0
  20. package/dist/api/types/axios.d.ts +15 -0
  21. package/dist/api/types/camera.d.ts +23 -6
  22. package/dist/api/types/comments.d.ts +18 -2
  23. package/dist/api/types/company.d.ts +29 -1
  24. package/dist/api/types/coolify.d.ts +2 -0
  25. package/dist/api/types/countries.d.ts +0 -7
  26. package/dist/api/types/credentials.d.ts +1 -0
  27. package/dist/api/types/detections.d.ts +5 -20
  28. package/dist/api/types/errors.d.ts +1 -0
  29. package/dist/api/types/gateReport.d.ts +4 -101
  30. package/dist/api/types/index.d.ts +3 -0
  31. package/dist/api/types/ingest.d.ts +4 -0
  32. package/dist/api/types/kit.d.ts +55 -7
  33. package/dist/api/types/planner.d.ts +4 -1
  34. package/dist/api/types/procore.d.ts +13 -10
  35. package/dist/api/types/progressPhoto.d.ts +5 -23
  36. package/dist/api/types/project.d.ts +47 -3
  37. package/dist/api/types/recording.d.ts +1 -0
  38. package/dist/api/types/recycleBin.d.ts +14 -0
  39. package/dist/api/types/routeParams.d.ts +2 -1
  40. package/dist/api/types/router.d.ts +19 -0
  41. package/dist/api/types/shared.d.ts +1 -6
  42. package/dist/api/types/shares.d.ts +6 -144
  43. package/dist/api/types/siteAnalytics.d.ts +135 -29
  44. package/dist/api/types/snapshots.d.ts +9 -0
  45. package/dist/api/types/sso.d.ts +55 -0
  46. package/dist/api/types/streaming.d.ts +1 -2
  47. package/dist/api/types/time.d.ts +4 -0
  48. package/dist/api/types/user.d.ts +4 -0
  49. package/dist/api/types/videoWall.d.ts +34 -1
  50. package/dist/api/types/weather.d.ts +2 -0
  51. package/dist/api/types/widget.d.ts +27 -6
  52. package/dist/api/utils.d.ts +1 -0
  53. package/dist/index.js +1227 -866
  54. package/dist/index.js.map +1 -1
  55. package/dist/index.umd.cjs +1 -1
  56. package/dist/index.umd.cjs.map +1 -1
  57. package/dist/shared/types/components.d.ts +18 -3
  58. package/dist/shared/types/imagePlayer.d.ts +1 -1
  59. package/package.json +5 -4
@@ -1,10 +1,10 @@
1
- import { CountryCode, CountryId, DateTime, DateType, Nvr, PaginationParams, PowerType, Project, Region, Router, Schedule, Tag } from "@/types";
1
+ import { CameraExid, CountryCode, CountryId, DateTime, DateType, Nvr, PaginationParams, PowerType, Project, Router, Schedule, Tag } from "@/types";
2
2
  export type Kit = {
3
3
  alarms: KitAlarm[];
4
4
  countryCode: CountryCode;
5
5
  countryId: CountryId;
6
6
  countryName: string;
7
- countryRegion: Region;
7
+ countryRegion: KitRegion;
8
8
  id?: number;
9
9
  jobId: number;
10
10
  name: string;
@@ -16,7 +16,11 @@ export type Kit = {
16
16
  serial: string;
17
17
  status: KitStatus;
18
18
  powerSchedule: Schedule;
19
+ ups: boolean;
20
+ boxId: string;
19
21
  tags: Tag[];
22
+ storages: KitStorage[];
23
+ createdAt: string;
20
24
  };
21
25
  export declare enum KitStatus {
22
26
  New = "new",
@@ -24,18 +28,24 @@ export declare enum KitStatus {
24
28
  Deployed = "deployed",
25
29
  Decommissioned = "decommissioned"
26
30
  }
31
+ export declare enum KitRegion {
32
+ APAC = "apac",
33
+ EMEA = "emea",
34
+ LATAM = "latam",
35
+ US = "na"
36
+ }
27
37
  export declare enum KitAlarm {
28
38
  NvrOffline = "nvr_offline",
39
+ OfflineScheduled = "offline_scheduled",
29
40
  UnknownCamera = "unknown_camera",
30
41
  NotRecordingCamera = "not_recording_camera",
31
- OfflineScheduled = "offline_scheduled",
32
42
  FullSD = "full_sd",
33
43
  FullStorage = "full_storage",
34
44
  HddUnmounted = "hdd_unmounted",
35
45
  NoHdd = "no_hdd",
36
46
  MissingRouterInfo = "missing_router_info",
37
- PowerLost = "ac_failure",
38
- UpsLowBattery = "low_battery"
47
+ AcFailure = "ac_failure",
48
+ LowBattery = "low_battery"
39
49
  }
40
50
  export declare enum KitMetricId {
41
51
  SolarCharger = "solar_charger",
@@ -292,7 +302,7 @@ export type KitCreatePayload = {
292
302
  status: KitStatus;
293
303
  powerType: PowerType;
294
304
  config: {
295
- region: Region;
305
+ region: KitRegion;
296
306
  };
297
307
  };
298
308
  export type KitUpdatePayload = {
@@ -310,7 +320,7 @@ export declare enum KitStorageTransport {
310
320
  export type KitStorageRequestPayload = {
311
321
  kitId: number;
312
322
  };
313
- export type KitStorageResponsePayload = {
323
+ export type KitStorage = {
314
324
  id: number;
315
325
  serial: string;
316
326
  status: string;
@@ -324,5 +334,43 @@ export type KitStorageResponsePayload = {
324
334
  vendor: string;
325
335
  kitId: number;
326
336
  capacity: number;
337
+ freeSpace: number;
327
338
  tran: KitStorageTransport;
328
339
  };
340
+ export type KitFootageRequestPayload = {
341
+ cameraId: CameraExid;
342
+ storageId: number;
343
+ };
344
+ export type KitFootage = {
345
+ id: number;
346
+ startDate: string;
347
+ endDate: string;
348
+ cameraId: number;
349
+ storageId: number;
350
+ };
351
+ export type KitAlarmItem = {
352
+ id: number;
353
+ kitId: number;
354
+ alarm: KitAlarm;
355
+ startDate: DateTime;
356
+ endDate: DateTime | null;
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
+ };
@@ -1,6 +1,9 @@
1
1
  export declare enum EDistortImageModes {
2
2
  FreeRotate = "freeRotate",
3
- Lock = "lock"
3
+ Lock = "lock",
4
+ Rotate = "rotate",
5
+ Scale = "scale",
6
+ Pan = "drag"
4
7
  }
5
8
  export declare enum EMapTypes {
6
9
  Blank = "Blank",
@@ -176,11 +176,14 @@ export type ProcoreObservationCustomField = {
176
176
  optionsUrl: string | null;
177
177
  defaultValue: string | null;
178
178
  };
179
+ export type ProcoreNextObservationAvailableNumber = {
180
+ nextAvailableNumber: number;
181
+ };
179
182
  export declare enum ProcoreObservationCustomFieldDataType {
180
183
  RichText = "rich_text",
181
184
  Date = "date",
182
185
  DateTime = "datetime",
183
- LovEnty = "lov_entry",
186
+ LovEntry = "lov_entry",
184
187
  LovEntries = "lov_entries",
185
188
  Boolean = "boolean",
186
189
  Vendor = "vendor",
@@ -194,17 +197,17 @@ export declare enum ProcoreObservationDefaultFieldNames {
194
197
  Number = "number",
195
198
  Name = "name",
196
199
  Status = "status",
197
- Trade = "trade_id",
198
- Assignee = "assignee_id",
199
- DueDate = "due_date",
200
- SpecificationSection = "specification_section_id",
200
+ Trade = "tradeId",
201
+ Assignee = "assigneeId",
202
+ DueDate = "dueDate",
203
+ SpecificationSection = "specificationSectionId",
201
204
  Priority = "priority",
202
- Location = "location_id",
203
- DistributionMembers = "distribution_member_ids",
205
+ Location = "locationId",
206
+ DistributionMembers = "distributionMemberIds",
204
207
  Personal = "personal",
205
- Hazard = "hazard_id",
206
- ContributingBehavior = "contributing_behavior_id",
207
- ContributingCondition = "contributing_condition_id",
208
+ Hazard = "hazardId",
209
+ ContributingBehavior = "contributingBehaviorId",
210
+ ContributingCondition = "contributingConditionId",
208
211
  Description = "description"
209
212
  }
210
213
  export declare enum ProcoreTools {
@@ -1,31 +1,13 @@
1
- import { DateTime, DateType, PaginationParams } from "@/types";
2
- export type ProgressPhoto = {
3
- cameraIds: string;
4
- cameraNames: number;
5
- createdAt: string;
6
- id: number;
7
- provider: string;
8
- type: string;
9
- config: Partial<{
10
- recipients: string;
11
- projectId: number;
12
- companyId: number;
13
- }>;
14
- isPaused: boolean;
15
- notifyDays: string;
16
- notifyTime: string;
17
- requesterEmail: string;
18
- requesterName: string;
19
- timezone: string;
20
- title: string;
21
- };
1
+ import { Automation, AutomationType, DateTime, DateType, PaginationParams } from "@/types";
22
2
  export type ProgressPhotosCreateUpdateRequestPayload = {
23
3
  cameraExids?: string;
24
4
  notifyDays?: string;
5
+ compareDelay?: AutomationType;
25
6
  notifyTime?: string;
26
7
  provider?: string;
27
8
  type?: string;
28
9
  config?: {
10
+ compareDelay?: AutomationType;
29
11
  recipients?: string;
30
12
  projectId?: number;
31
13
  companyId?: number;
@@ -40,9 +22,9 @@ export type ProgressPhotosUnSubscribeParams = {
40
22
  token?: string;
41
23
  };
42
24
  export type ProgressPhotosResponsePayload = {
43
- progressPhotos: ProgressPhoto[];
25
+ progressPhotos: Automation[];
44
26
  };
45
- export declare enum ProgressPhotoDialogType {
27
+ export declare enum AutomationDialogType {
46
28
  Create = "create",
47
29
  Edit = "edit",
48
30
  Pause = "pause"
@@ -1,4 +1,4 @@
1
- import { AdminCamera, Camera, CameraExid, DateTime, DateType, EntityByExid, Exid, PaginationParams } from "@/types";
1
+ import { AdminCamera, Camera, CameraExid, DateRangeFilter, DateTime, DateType, EntityByExid, Exid, PaginationParams } from "@/types";
2
2
  export type ProjectExid = Exid;
3
3
  export type ProjectsByExid = EntityByExid<Project>;
4
4
  export type Project = {
@@ -12,6 +12,7 @@ export type Project = {
12
12
  zohoId?: string;
13
13
  userId?: number;
14
14
  cameras?: Array<Camera | AdminCamera>;
15
+ unrestrictedCameras?: Array<Camera | AdminCamera>;
15
16
  featureFlags: Array<ProjectFeatureFlag>;
16
17
  owner?: {
17
18
  email?: string;
@@ -52,7 +53,6 @@ export declare enum ProjectFeatureFlag {
52
53
  ThreeSixtyView = "360_view",
53
54
  NdaMc = "NDA/MC",
54
55
  GateReport = "gate_report",
55
- GateReportAutoVerify = "auto_publish",
56
56
  GateReportMotionDetection = "motion_detection",
57
57
  FullEmpty = "full_empty",
58
58
  MediaHubSharing = "archives_sharing",
@@ -60,7 +60,8 @@ export declare enum ProjectFeatureFlag {
60
60
  NoLicensePlate = "no_license_plate",
61
61
  DefaultToProjectApp = "default_to_project_app",
62
62
  SmartSearch = "smart_search",
63
- PpeMonitoring = "ppe_monitoring"
63
+ PpeMonitoring = "ppe_monitoring",
64
+ NoGdpr = "no_gdpr"
64
65
  }
65
66
  export type ProjectBatteryReading = {
66
67
  exid: number;
@@ -126,3 +127,46 @@ export type ProjectUsers = {
126
127
  }[];
127
128
  users: Record<string, ProjectUserProperty[]>;
128
129
  };
130
+ export type ProjectDateRangeFilter = DateRangeFilter & {
131
+ projectExid: ProjectExid;
132
+ };
133
+ export type ProjectRole = {
134
+ id: string;
135
+ name: string;
136
+ };
137
+ export type ProjectMember = {
138
+ id: string;
139
+ email: string;
140
+ fullname: string;
141
+ role: ProjectRole;
142
+ permissions?: string[];
143
+ subRoles?: Array<{
144
+ resourceId: string;
145
+ roleId: number;
146
+ }>;
147
+ };
148
+ export type ProjectInvite = {
149
+ id?: string;
150
+ email: string;
151
+ role?: ProjectRole;
152
+ invitedAt?: string;
153
+ };
154
+ export type ProjectMembersResponsePayload = {
155
+ users: ProjectMember[];
156
+ invites: ProjectInvite[];
157
+ };
158
+ export type ProjectMembersRequestPayload = {
159
+ roleId: number;
160
+ emails: string[];
161
+ overrideRole?: Partial<{
162
+ permissions?: string[];
163
+ subRoles?: Array<{
164
+ resourceId: string;
165
+ roleId: number;
166
+ }>;
167
+ }>;
168
+ };
169
+ export type ProjectInviteMembersResponsePayload = {
170
+ users: ProjectMember[];
171
+ invites: ProjectInvite[];
172
+ };
@@ -10,6 +10,7 @@ export type NearestSnapshotRequestPayload = {
10
10
  apiId?: string;
11
11
  token?: string;
12
12
  cancelToken?: object;
13
+ includeImage?: boolean;
13
14
  };
14
15
  export type AvailableDaysRequestPayload = {
15
16
  cameraId: string;
@@ -0,0 +1,14 @@
1
+ import type { DateType, PaginationParams } from "@/types";
2
+ export type RecycleBin = {
3
+ id?: number;
4
+ exid: string;
5
+ name: string;
6
+ type: string;
7
+ deletedBy: string;
8
+ deletedAt: DateType;
9
+ };
10
+ export type RecycleBinQueryParams = PaginationParams & {
11
+ name: string;
12
+ type: string;
13
+ deletedBy: string;
14
+ };
@@ -46,6 +46,7 @@ export declare enum TimelineMobileCaptureUrlParams {
46
46
  ShowMobileCapture = "showMobileCapture"
47
47
  }
48
48
  export declare enum TimelineCommentsUrlParams {
49
- ShowComments = "showComments"
49
+ ShowComments = "showComments",
50
+ SelectedCommentId = "selectedCommentId"
50
51
  }
51
52
  export type TimelineUrlParams = Record<TimelineUrlParam | TimelineMediaUrlParams | TimelineBimUrlParams | TimelineExNvrRecordingsUrlParams | TimelineAnprUrlParams | TimelineMobileCaptureUrlParams | TimelineCommentsUrlParams, string | null>;
@@ -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
+ };
@@ -90,11 +90,6 @@ export declare enum _3dViewer {
90
90
  Itwin = "itwin",
91
91
  Cesium = "cesium"
92
92
  }
93
- export declare enum SsoProvider {
94
- Microsoft = "microsoft",
95
- Google = "google",
96
- Evercam = "evercam"
97
- }
98
93
  export declare enum InfoPage {
99
94
  ThreeSixtyView = "360",
100
95
  BIMView = "bim",
@@ -105,7 +100,7 @@ export declare enum InfoPage {
105
100
  Timeline = "timeline",
106
101
  WeatherReport = "weather-report"
107
102
  }
108
- export declare enum DownloadTypes {
103
+ export declare enum DownloadFileType {
109
104
  Jpeg = "jpeg",
110
105
  Pdf = "pdf",
111
106
  Csv = "csv"
@@ -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
- };