@evercam/api 1.0.0-a6868d86c → 1.0.0-a85cb7fae

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 (78) hide show
  1. package/dist/api/api/3dFirebaseApi.d.ts +1 -0
  2. package/dist/api/api/adminApi.d.ts +67 -58
  3. package/dist/api/api/aiApi.d.ts +57 -53
  4. package/dist/api/api/authzApi.d.ts +27 -17
  5. package/dist/api/api/client/axios.d.ts +1 -1
  6. package/dist/api/api/client/swr/Swr.d.ts +1 -1
  7. package/dist/api/api/evercamApi.d.ts +110 -94
  8. package/dist/api/api/evercamLabsApi.d.ts +4 -5
  9. package/dist/api/api/exNvrApi.d.ts +1 -1
  10. package/dist/api/api/ingestApi.d.ts +99 -47
  11. package/dist/api/api/ptzApi.d.ts +9 -4
  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 +4 -2
  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 +84 -45
  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 +45 -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 -6
  24. package/dist/api/types/bim.d.ts +11 -5
  25. package/dist/api/types/camera.d.ts +87 -74
  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 +3 -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 +20 -8
  33. package/dist/api/types/drone.d.ts +1 -0
  34. package/dist/api/types/gateReport.d.ts +43 -50
  35. package/dist/api/types/hdd.d.ts +26 -1
  36. package/dist/api/types/index.d.ts +6 -1
  37. package/dist/api/types/ingest.d.ts +90 -2
  38. package/dist/api/types/kit.d.ts +14 -7
  39. package/dist/api/types/media.d.ts +2 -1
  40. package/dist/api/types/notification.d.ts +32 -2
  41. package/dist/api/types/oauth.d.ts +62 -0
  42. package/dist/api/types/planner.d.ts +44 -0
  43. package/dist/api/types/posthog.d.ts +15 -0
  44. package/dist/api/types/procore.d.ts +13 -6
  45. package/dist/api/types/progressPhoto.d.ts +6 -2
  46. package/dist/api/types/project.d.ts +98 -20
  47. package/dist/api/types/recording.d.ts +2 -3
  48. package/dist/api/types/recycleBin.d.ts +1 -1
  49. package/dist/api/types/ring.d.ts +53 -0
  50. package/dist/api/types/router.d.ts +1 -1
  51. package/dist/api/types/shared.d.ts +11 -4
  52. package/dist/api/types/shares.d.ts +6 -144
  53. package/dist/api/types/sim.d.ts +6 -6
  54. package/dist/api/types/siteAnalytics.d.ts +79 -39
  55. package/dist/api/types/smartSeach.d.ts +5 -0
  56. package/dist/api/types/snapshots.d.ts +36 -4
  57. package/dist/api/types/storageProvider.d.ts +19 -0
  58. package/dist/api/types/storyblok.d.ts +40 -0
  59. package/dist/api/types/streaming.d.ts +3 -3
  60. package/dist/api/types/tag.d.ts +1 -1
  61. package/dist/api/types/time.d.ts +0 -18
  62. package/dist/api/types/timelapse.d.ts +3 -4
  63. package/dist/api/types/user.d.ts +101 -31
  64. package/dist/api/types/videoWall.d.ts +21 -21
  65. package/dist/api/types/weather.d.ts +75 -11
  66. package/dist/api/types/widget.d.ts +71 -12
  67. package/dist/api/types/xweather.d.ts +4 -4
  68. package/dist/index.js +926 -784
  69. package/dist/index.js.map +1 -1
  70. package/dist/index.umd.cjs +1 -1
  71. package/dist/index.umd.cjs.map +1 -1
  72. package/dist/shared/types/components.d.ts +113 -9
  73. package/dist/shared/types/imagePlayer.d.ts +1 -1
  74. package/dist/shared/types/index.d.ts +1 -0
  75. package/dist/shared/types/rbac.d.ts +67 -0
  76. package/dist/shared/types/timeline.d.ts +2 -1
  77. package/package.json +2 -2
  78. package/dist/api/types/storageServers.d.ts +0 -4
@@ -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
  };
@@ -117,7 +147,7 @@ export type ProjectUserProperty = {
117
147
  eventsCount: number;
118
148
  fullname: string;
119
149
  id: number;
120
- lastSeenAt: DateTime;
150
+ lastSeenAt: string;
121
151
  persona: string;
122
152
  };
123
153
  export type ProjectUsers = {
@@ -127,32 +157,46 @@ export type ProjectUsers = {
127
157
  }[];
128
158
  users: Record<string, ProjectUserProperty[]>;
129
159
  };
130
- export type ProjectDateRangeFilter = DateRangeFilter & {
131
- projectExid: ProjectExid;
132
- };
133
160
  export type ProjectRole = {
134
- id: string;
161
+ id: number;
135
162
  name: string;
136
163
  };
137
164
  export type ProjectMember = {
138
165
  id: string;
166
+ key?: string;
139
167
  email: string;
140
168
  fullname: string;
169
+ lastSeenAt?: string;
141
170
  role: ProjectRole;
171
+ permissions?: string[];
172
+ subRoles?: Array<{
173
+ resourceId: string;
174
+ roleId: number;
175
+ }>;
176
+ company?: {
177
+ name: string;
178
+ } | null;
142
179
  };
143
180
  export type ProjectInvite = {
144
181
  id?: string;
145
182
  email: string;
146
183
  role?: ProjectRole;
184
+ permissions?: string[];
185
+ subRoles?: Array<{
186
+ resourceId: string;
187
+ roleId: number;
188
+ }>;
147
189
  invitedAt?: string;
148
190
  };
149
191
  export type ProjectMembersResponsePayload = {
150
192
  users: ProjectMember[];
151
193
  invites: ProjectInvite[];
194
+ errors: ProjectUserError[];
152
195
  };
153
196
  export type ProjectMembersRequestPayload = {
154
197
  roleId: number;
155
198
  emails: string[];
199
+ message?: string;
156
200
  overrideRole?: Partial<{
157
201
  permissions?: string[];
158
202
  subRoles?: Array<{
@@ -165,3 +209,37 @@ export type ProjectInviteMembersResponsePayload = {
165
209
  users: ProjectMember[];
166
210
  invites: ProjectInvite[];
167
211
  };
212
+ export type PlaceholderThumbnailData = {
213
+ placeholder: string;
214
+ };
215
+ export type ProjectUserError = {
216
+ email: string;
217
+ error: Record<string, string[]>;
218
+ };
219
+ export type ProjectUsersResponsePayload = {
220
+ users: ProjectMember[];
221
+ invites: ProjectInvite[];
222
+ errors: ProjectUserError[];
223
+ };
224
+ export type ProjectStorageQueryParams = PaginationParams & {
225
+ cameraName: string;
226
+ cameraExid: CameraExid;
227
+ status: ProjectStorageStatus;
228
+ };
229
+ export type ProjectStorage = {
230
+ id: number;
231
+ cameraExid: CameraExid;
232
+ cameraName: string;
233
+ projectExid: string;
234
+ projectName: string;
235
+ status: ProjectStorageStatus;
236
+ requestor: string;
237
+ created_at: DateType;
238
+ };
239
+ export declare enum ProjectStorageStatus {
240
+ New = "new",
241
+ Pending = "pending",
242
+ Processing = "processing",
243
+ Completed = "completed",
244
+ Failed = "failed"
245
+ }
@@ -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;
@@ -0,0 +1,53 @@
1
+ export type RingDevice = {
2
+ deviceId: string;
3
+ name: string;
4
+ deviceType: string;
5
+ firmwareVersion: string | null;
6
+ batteryLife: number | null;
7
+ location: string | null;
8
+ imported: boolean;
9
+ cameraExid?: string;
10
+ projectExid?: string;
11
+ projectName?: string;
12
+ };
13
+ export type RingDevicesResponsePayload = {
14
+ devices: RingDevice[];
15
+ };
16
+ export type RingImportDevicesPayload = {
17
+ deviceIds: string[];
18
+ projectExid: string;
19
+ deviceNames?: Record<string, string>;
20
+ };
21
+ export type RingImportResponsePayload = {
22
+ cameras: Array<{
23
+ exid: string;
24
+ name: string;
25
+ }>;
26
+ project: {
27
+ exid: string;
28
+ name: string;
29
+ };
30
+ };
31
+ export type RingMoveDevicePayload = {
32
+ projectExid: string;
33
+ };
34
+ export type RingMoveDeviceResponsePayload = {
35
+ status: string;
36
+ cameraExid: string;
37
+ projectExid: string;
38
+ };
39
+ export type RingLiveViewPayload = {
40
+ sdpOffer: string;
41
+ };
42
+ export type RingLiveViewResponse = {
43
+ sdpAnswer: string;
44
+ sessionUrl: string;
45
+ iceServers: Array<{
46
+ urls: string;
47
+ username?: string;
48
+ credential?: string;
49
+ }>;
50
+ };
51
+ export type RingStopLiveViewResponse = {
52
+ status: string;
53
+ };
@@ -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
  };
@@ -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;