@evercam/api 1.0.0-545d28907 → 1.0.0-557e15bf7

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 (70) hide show
  1. package/dist/api/api/3dFirebaseApi.d.ts +7 -1
  2. package/dist/api/api/adminApi.d.ts +50 -60
  3. package/dist/api/api/aiApi.d.ts +56 -84
  4. package/dist/api/api/authzApi.d.ts +27 -17
  5. package/dist/api/api/client/axios.d.ts +2 -1
  6. package/dist/api/api/client/swr/Swr.d.ts +1 -1
  7. package/dist/api/api/evercamApi.d.ts +67 -93
  8. package/dist/api/api/evercamLabsApi.d.ts +4 -2
  9. package/dist/api/api/exNvrApi.d.ts +1 -1
  10. package/dist/api/api/ingestApi.d.ts +96 -44
  11. package/dist/api/api/ptzApi.d.ts +12 -3
  12. package/dist/api/api/videoWallApi.d.ts +2 -2
  13. package/dist/api/api/weatherApi.d.ts +2 -2
  14. package/dist/api/types/360.d.ts +139 -5
  15. package/dist/api/types/aconex.d.ts +9 -9
  16. package/dist/api/types/admin.d.ts +51 -0
  17. package/dist/api/types/analytics.d.ts +77 -46
  18. package/dist/api/types/anpr.d.ts +19 -2
  19. package/dist/api/types/auditLogs.d.ts +1 -1
  20. package/dist/api/types/authz.d.ts +44 -6
  21. package/dist/api/types/autodesk.d.ts +7 -7
  22. package/dist/api/types/automation.d.ts +37 -3
  23. package/dist/api/types/axios.d.ts +10 -4
  24. package/dist/api/types/bim.d.ts +11 -5
  25. package/dist/api/types/camera.d.ts +87 -78
  26. package/dist/api/types/comments.d.ts +4 -8
  27. package/dist/api/types/company.d.ts +42 -1
  28. package/dist/api/types/compare.d.ts +20 -5
  29. package/dist/api/types/connector.d.ts +2 -5
  30. package/dist/api/types/coolify.d.ts +18 -2
  31. package/dist/api/types/copilot.d.ts +11 -6
  32. package/dist/api/types/detections.d.ts +17 -8
  33. package/dist/api/types/gateReport.d.ts +46 -150
  34. package/dist/api/types/hdd.d.ts +26 -1
  35. package/dist/api/types/index.d.ts +3 -0
  36. package/dist/api/types/ingest.d.ts +85 -2
  37. package/dist/api/types/kit.d.ts +31 -5
  38. package/dist/api/types/media.d.ts +2 -1
  39. package/dist/api/types/notification.d.ts +32 -2
  40. package/dist/api/types/posthog.d.ts +15 -0
  41. package/dist/api/types/procore.d.ts +13 -6
  42. package/dist/api/types/progressPhoto.d.ts +6 -2
  43. package/dist/api/types/project.d.ts +95 -21
  44. package/dist/api/types/recording.d.ts +2 -3
  45. package/dist/api/types/recycleBin.d.ts +1 -1
  46. package/dist/api/types/router.d.ts +20 -1
  47. package/dist/api/types/shared.d.ts +11 -4
  48. package/dist/api/types/shares.d.ts +6 -144
  49. package/dist/api/types/sim.d.ts +6 -6
  50. package/dist/api/types/siteAnalytics.d.ts +170 -46
  51. package/dist/api/types/smartSeach.d.ts +5 -0
  52. package/dist/api/types/snapshots.d.ts +1 -1
  53. package/dist/api/types/storyblok.d.ts +40 -0
  54. package/dist/api/types/streaming.d.ts +3 -3
  55. package/dist/api/types/tag.d.ts +1 -1
  56. package/dist/api/types/time.d.ts +0 -18
  57. package/dist/api/types/timelapse.d.ts +3 -4
  58. package/dist/api/types/user.d.ts +101 -30
  59. package/dist/api/types/videoWall.d.ts +21 -21
  60. package/dist/api/types/weather.d.ts +75 -11
  61. package/dist/api/types/widget.d.ts +71 -12
  62. package/dist/api/types/xweather.d.ts +4 -4
  63. package/dist/index.js +741 -758
  64. package/dist/index.js.map +1 -1
  65. package/dist/index.umd.cjs +1 -1
  66. package/dist/index.umd.cjs.map +1 -1
  67. package/dist/shared/types/components.d.ts +80 -9
  68. package/dist/shared/types/imagePlayer.d.ts +2 -2
  69. package/dist/shared/types/timeline.d.ts +2 -1
  70. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- import { Automation, AutomationType, DateTime, DateType, PaginationParams } from "@/types";
1
+ import { Automation, AutomationType, DateType, PaginationParams } from "@evercam/api/types";
2
2
  export type ProgressPhotosCreateUpdateRequestPayload = {
3
3
  cameraExids?: string;
4
4
  notifyDays?: string;
@@ -8,6 +8,7 @@ export type ProgressPhotosCreateUpdateRequestPayload = {
8
8
  type?: string;
9
9
  config?: {
10
10
  compareDelay?: AutomationType;
11
+ period?: number;
11
12
  recipients?: string;
12
13
  projectId?: number;
13
14
  companyId?: number;
@@ -24,6 +25,9 @@ export type ProgressPhotosUnSubscribeParams = {
24
25
  export type ProgressPhotosResponsePayload = {
25
26
  progressPhotos: Automation[];
26
27
  };
28
+ export type ProgressPhotoItemResponsePayload = {
29
+ progressPhotos: Automation;
30
+ };
27
31
  export declare enum AutomationDialogType {
28
32
  Create = "create",
29
33
  Edit = "edit",
@@ -70,5 +74,5 @@ export type ProgressPhotosHistory = {
70
74
  cameraIds: string;
71
75
  failedCameraIds: string;
72
76
  subject: string;
73
- recipients: DateTime;
77
+ recipients: string;
74
78
  };
@@ -1,25 +1,56 @@
1
- import { AdminCamera, Camera, CameraExid, DateRangeFilter, DateTime, DateType, EntityByExid, Exid, PaginationParams } from "@/types";
1
+ import { AdminCamera, Camera, CameraExid, DateType, EntityByExid, Exid, PaginationParams } from "@evercam/api/types";
2
2
  export type ProjectExid = Exid;
3
3
  export type ProjectsByExid = EntityByExid<Project>;
4
4
  export type Project = {
5
- id: string | number;
6
- exid: ProjectExid;
7
- name: string;
8
- status?: ProjectStatus;
9
- insertedAt?: string;
10
- startedAt?: string;
11
- timezone?: string;
12
- zohoId?: string;
13
- userId?: number;
5
+ archiveTier?: ProjectArchiveTier;
14
6
  cameras?: Array<Camera | AdminCamera>;
15
- unrestrictedCameras?: Array<Camera | AdminCamera>;
7
+ camerasCount?: number;
8
+ camerasRestrictionType?: string;
9
+ companyId: number;
10
+ endDate: string;
11
+ exid: ProjectExid;
16
12
  featureFlags: Array<ProjectFeatureFlag>;
13
+ geographicBounds?: unknown;
14
+ id: string | number;
15
+ insertedAt?: string;
16
+ name: string;
17
17
  owner?: {
18
18
  email?: string;
19
19
  };
20
20
  ownerEmail?: string;
21
21
  ownerName?: string;
22
- camerasRestrictionType?: string;
22
+ startedAt?: string;
23
+ status?: ProjectStatus;
24
+ timezone?: string;
25
+ unrestrictedCameras?: Camera[];
26
+ userId?: number;
27
+ zohoId?: string;
28
+ };
29
+ export type AdminProjectCameraRef = {
30
+ exid: string;
31
+ name: string;
32
+ };
33
+ export type AdminProjectListItem = {
34
+ id: number;
35
+ name: string;
36
+ status: ProjectStatus | string;
37
+ insertedAt: string;
38
+ timezone: string | null;
39
+ exid: ProjectExid;
40
+ endDate: string | null;
41
+ startDate: string | null;
42
+ archiveTier: ProjectArchiveTier | null;
43
+ featureFlags: Array<ProjectFeatureFlag | string>;
44
+ zohoId: string | null;
45
+ ownerEmail: string | null;
46
+ companyId: number | null;
47
+ companyName: string | null;
48
+ ownerName: string | null;
49
+ archived: boolean;
50
+ cameras?: AdminProjectCameraRef[];
51
+ };
52
+ export type AdminProjectDetail = AdminProjectListItem & {
53
+ userId: number;
23
54
  };
24
55
  export declare enum ProjectStatus {
25
56
  ToStart = "To Start",
@@ -33,13 +64,12 @@ export declare enum ProjectArchiveTier {
33
64
  Minimal = "Minimal",
34
65
  ScheduledForDeletion = "Scheduled for Deletion"
35
66
  }
36
- export type ProjectResponsePayload = {
37
- data?: Project[];
38
- };
39
67
  export type UpdateCameraRestrictionPayload = {
40
68
  isAccessRestricted?: boolean;
41
69
  };
42
70
  export type Logo = {
71
+ id: number;
72
+ projectId: number;
43
73
  name: string;
44
74
  url: string;
45
75
  };
@@ -53,7 +83,6 @@ export declare enum ProjectFeatureFlag {
53
83
  ThreeSixtyView = "360_view",
54
84
  NdaMc = "NDA/MC",
55
85
  GateReport = "gate_report",
56
- GateReportAutoVerify = "auto_publish",
57
86
  GateReportMotionDetection = "motion_detection",
58
87
  FullEmpty = "full_empty",
59
88
  MediaHubSharing = "archives_sharing",
@@ -118,7 +147,7 @@ export type ProjectUserProperty = {
118
147
  eventsCount: number;
119
148
  fullname: string;
120
149
  id: number;
121
- lastSeenAt: DateTime;
150
+ lastSeenAt: string;
122
151
  persona: string;
123
152
  };
124
153
  export type ProjectUsers = {
@@ -128,32 +157,43 @@ export type ProjectUsers = {
128
157
  }[];
129
158
  users: Record<string, ProjectUserProperty[]>;
130
159
  };
131
- export type ProjectDateRangeFilter = DateRangeFilter & {
132
- projectExid: ProjectExid;
133
- };
134
160
  export type ProjectRole = {
135
- id: string;
161
+ id: number;
136
162
  name: string;
137
163
  };
138
164
  export type ProjectMember = {
139
165
  id: string;
140
166
  email: string;
141
167
  fullname: string;
168
+ lastSeenAt?: string;
142
169
  role: ProjectRole;
170
+ permissions?: string[];
171
+ subRoles?: Array<{
172
+ resourceId: string;
173
+ roleId: number;
174
+ }>;
175
+ company?: string | null;
143
176
  };
144
177
  export type ProjectInvite = {
145
178
  id?: string;
146
179
  email: string;
147
180
  role?: ProjectRole;
181
+ permissions?: string[];
182
+ subRoles?: Array<{
183
+ resourceId: string;
184
+ roleId: number;
185
+ }>;
148
186
  invitedAt?: string;
149
187
  };
150
188
  export type ProjectMembersResponsePayload = {
151
189
  users: ProjectMember[];
152
190
  invites: ProjectInvite[];
191
+ errors: ProjectUserError[];
153
192
  };
154
193
  export type ProjectMembersRequestPayload = {
155
194
  roleId: number;
156
195
  emails: string[];
196
+ message?: string;
157
197
  overrideRole?: Partial<{
158
198
  permissions?: string[];
159
199
  subRoles?: Array<{
@@ -166,3 +206,37 @@ export type ProjectInviteMembersResponsePayload = {
166
206
  users: ProjectMember[];
167
207
  invites: ProjectInvite[];
168
208
  };
209
+ export type PlaceholderThumbnailData = {
210
+ placeholder: string;
211
+ };
212
+ export type ProjectUserError = {
213
+ email: string;
214
+ error: Record<string, string[]>;
215
+ };
216
+ export type ProjectUsersResponsePayload = {
217
+ users: ProjectMember[];
218
+ invites: ProjectInvite[];
219
+ errors: ProjectUserError[];
220
+ };
221
+ export type ProjectStorageQueryParams = PaginationParams & {
222
+ cameraName: string;
223
+ cameraExid: CameraExid;
224
+ status: ProjectStorageStatus;
225
+ };
226
+ export type ProjectStorage = {
227
+ id: number;
228
+ cameraExid: CameraExid;
229
+ cameraName: string;
230
+ projectExid: string;
231
+ projectName: string;
232
+ status: ProjectStorageStatus;
233
+ requestor: string;
234
+ created_at: DateType;
235
+ };
236
+ export declare enum ProjectStorageStatus {
237
+ New = "new",
238
+ Pending = "pending",
239
+ Processing = "processing",
240
+ Completed = "completed",
241
+ Failed = "failed"
242
+ }
@@ -1,4 +1,4 @@
1
- import { ApiCredentials } from "@/types";
1
+ import { ApiCredentials } from "@evercam/api/types";
2
2
  import { CancelToken } from "axios";
3
3
  export type Snapshot = {
4
4
  createdAt: string;
@@ -56,8 +56,7 @@ export type SnapshotRangeResponsePayload = {
56
56
  snapshots: Array<SnapshotInstance>;
57
57
  };
58
58
  export declare enum BrainTool {
59
- Detections = "detections",
60
- Segmentation = "sam"
59
+ Detections = "detections"
61
60
  }
62
61
  export declare enum CloudRecordingFrequency {
63
62
  EverySecond = 60,
@@ -1,4 +1,4 @@
1
- import type { DateType, PaginationParams } from "@/types";
1
+ import type { DateType, PaginationParams } from "@evercam/api/types";
2
2
  export type RecycleBin = {
3
3
  id?: number;
4
4
  exid: string;
@@ -1,4 +1,4 @@
1
- import { Camera, PaginationParams, Project, Sim } from "@/types";
1
+ import { Camera, PaginationParams, Project, Sim } from "@evercam/api/types";
2
2
  export type RouterBillPayer = {
3
3
  name: string;
4
4
  };
@@ -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,7 +1,13 @@
1
- import { DateType } from "@/types";
1
+ import { DateType } from "@evercam/api/types";
2
2
  type sortby = string;
3
3
  type sortDirection = "asc" | "desc";
4
4
  export type SortingUrlParam = `${sortby}|${sortDirection}`;
5
+ export type JsonPrimitive = string | number | boolean | null;
6
+ export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
7
+ export type JsonObject = {
8
+ [key: string]: JsonValue;
9
+ };
10
+ export type JsonArray = JsonValue[];
5
11
  export type BatteryReading = {
6
12
  id: number;
7
13
  voltage: number;
@@ -53,7 +59,7 @@ export declare enum UnitSystem {
53
59
  Metric = "metric"
54
60
  }
55
61
  export type Timestamp = string | number;
56
- export type Schedule = {
62
+ export type ScheduleUppercase = {
57
63
  Friday: string[];
58
64
  Monday: string[];
59
65
  Saturday: string[];
@@ -71,6 +77,7 @@ export type ScheduleLowercase = {
71
77
  tuesday: string[];
72
78
  wednesday: string[];
73
79
  };
80
+ export type Schedule = ScheduleUppercase | ScheduleLowercase;
74
81
  export type PaginationParams = {
75
82
  sort?: SortingUrlParam;
76
83
  page?: number;
@@ -108,11 +115,11 @@ export declare enum DownloadFileType {
108
115
  export declare enum FeedbackContext {
109
116
  CopilotMessage = "copilot_message"
110
117
  }
111
- export type FeedbackPayload<T> = {
118
+ export type FeedbackPayload = {
112
119
  id?: number;
113
120
  user: string;
114
121
  text: string;
115
- type: T;
122
+ type: string;
116
123
  context: FeedbackContext;
117
124
  messageId?: number;
118
125
  conversationId?: number;
@@ -1,4 +1,4 @@
1
- import type { CameraExid, DateTime, DateType } from "@/types";
1
+ import type { DateType } from "@evercam/api/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,4 +1,4 @@
1
- import { DateTime, PaginationParams } from "@/types";
1
+ import { PaginationParams } from "@evercam/api/types";
2
2
  export declare enum SmsCommands {
3
3
  Cellular = "cellular",
4
4
  Gpson = "gpson",
@@ -63,7 +63,7 @@ export type Sim = {
63
63
  puk: string;
64
64
  iccid: string;
65
65
  description: string;
66
- lastSmsAt: DateTime;
66
+ lastSmsAt: string;
67
67
  cameras: {
68
68
  name: string;
69
69
  exid: string;
@@ -79,11 +79,11 @@ export type SendSmsResponse = {
79
79
  errorText: string;
80
80
  };
81
81
  export type SmsHistory = {
82
- insertedAt: DateTime;
82
+ insertedAt: string;
83
83
  type: string;
84
84
  status: string;
85
85
  text: string;
86
- deliveryDatetime: DateTime;
86
+ deliveryDatetime: string;
87
87
  };
88
88
  export type SmsHistoryResponse = {
89
89
  singleSimSms: SmsHistory[];
@@ -98,8 +98,8 @@ export type Sms = {
98
98
  status: string;
99
99
  text: string;
100
100
  type: string;
101
- insertedAt: DateTime;
102
- deliveryDatetime: DateTime;
101
+ insertedAt: string;
102
+ deliveryDatetime: string;
103
103
  };
104
104
  export type SmsQueryParams = PaginationParams & {
105
105
  dateRange: string;