@evercam/api 1.0.0-fbf4f4d51 → 1.0.0-ff3128bbe

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 (43) hide show
  1. package/dist/api/api/adminApi.d.ts +29 -2
  2. package/dist/api/api/aiApi.d.ts +53 -49
  3. package/dist/api/api/evercamApi.d.ts +45 -3
  4. package/dist/api/api/evercamLabsApi.d.ts +1 -2
  5. package/dist/api/api/exNvrApi.d.ts +1 -1
  6. package/dist/api/api/ingestApi.d.ts +44 -41
  7. package/dist/api/types/analytics.d.ts +62 -44
  8. package/dist/api/types/anpr.d.ts +11 -0
  9. package/dist/api/types/authz.d.ts +1 -0
  10. package/dist/api/types/automation.d.ts +11 -2
  11. package/dist/api/types/axios.d.ts +2 -2
  12. package/dist/api/types/camera.d.ts +9 -2
  13. package/dist/api/types/connector.d.ts +1 -0
  14. package/dist/api/types/coolify.d.ts +18 -2
  15. package/dist/api/types/copilot.d.ts +10 -5
  16. package/dist/api/types/detections.d.ts +4 -1
  17. package/dist/api/types/drone.d.ts +1 -0
  18. package/dist/api/types/gateReport.d.ts +16 -24
  19. package/dist/api/types/index.d.ts +4 -1
  20. package/dist/api/types/ingest.d.ts +16 -1
  21. package/dist/api/types/media.d.ts +1 -0
  22. package/dist/api/types/oauth.d.ts +62 -0
  23. package/dist/api/types/planner.d.ts +44 -0
  24. package/dist/api/types/progressPhoto.d.ts +2 -1
  25. package/dist/api/types/project.d.ts +29 -2
  26. package/dist/api/types/recording.d.ts +1 -2
  27. package/dist/api/types/ring.d.ts +53 -0
  28. package/dist/api/types/siteAnalytics.d.ts +4 -14
  29. package/dist/api/types/smartSeach.d.ts +5 -0
  30. package/dist/api/types/snapshots.d.ts +35 -3
  31. package/dist/api/types/storageProvider.d.ts +19 -0
  32. package/dist/api/types/timelapse.d.ts +2 -1
  33. package/dist/api/types/user.d.ts +0 -1
  34. package/dist/index.js +1017 -855
  35. package/dist/index.js.map +1 -1
  36. package/dist/index.umd.cjs +1 -1
  37. package/dist/index.umd.cjs.map +1 -1
  38. package/dist/shared/types/components.d.ts +35 -2
  39. package/dist/shared/types/imagePlayer.d.ts +1 -1
  40. package/dist/shared/types/index.d.ts +1 -0
  41. package/dist/shared/types/rbac.d.ts +67 -0
  42. package/package.json +2 -2
  43. package/dist/api/types/storageServers.d.ts +0 -4
@@ -62,7 +62,8 @@ export declare enum ProjectArchiveTier {
62
62
  Full = "Full",
63
63
  Partial = "Partial",
64
64
  Minimal = "Minimal",
65
- ScheduledForDeletion = "Scheduled for Deletion"
65
+ ScheduledForDeletion = "Scheduled for Deletion",
66
+ No = "No"
66
67
  }
67
68
  export type UpdateCameraRestrictionPayload = {
68
69
  isAccessRestricted?: boolean;
@@ -163,6 +164,7 @@ export type ProjectRole = {
163
164
  };
164
165
  export type ProjectMember = {
165
166
  id: string;
167
+ key?: string;
166
168
  email: string;
167
169
  fullname: string;
168
170
  lastSeenAt?: string;
@@ -172,7 +174,9 @@ export type ProjectMember = {
172
174
  resourceId: string;
173
175
  roleId: number;
174
176
  }>;
175
- company?: string | null;
177
+ company?: {
178
+ name: string;
179
+ } | null;
176
180
  };
177
181
  export type ProjectInvite = {
178
182
  id?: string;
@@ -193,6 +197,7 @@ export type ProjectMembersResponsePayload = {
193
197
  export type ProjectMembersRequestPayload = {
194
198
  roleId: number;
195
199
  emails: string[];
200
+ message?: string;
196
201
  overrideRole?: Partial<{
197
202
  permissions?: string[];
198
203
  subRoles?: Array<{
@@ -217,3 +222,25 @@ export type ProjectUsersResponsePayload = {
217
222
  invites: ProjectInvite[];
218
223
  errors: ProjectUserError[];
219
224
  };
225
+ export type ProjectStorageQueryParams = PaginationParams & {
226
+ cameraName: string;
227
+ cameraExid: CameraExid;
228
+ status: ProjectStorageStatus;
229
+ };
230
+ export type ProjectStorage = {
231
+ id: number;
232
+ cameraExid: CameraExid;
233
+ cameraName: string;
234
+ projectExid: string;
235
+ projectName: string;
236
+ status: ProjectStorageStatus;
237
+ requestor: string;
238
+ created_at: DateType;
239
+ };
240
+ export declare enum ProjectStorageStatus {
241
+ New = "new",
242
+ Pending = "pending",
243
+ Processing = "processing",
244
+ Completed = "completed",
245
+ Failed = "failed"
246
+ }
@@ -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,
@@ -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
+ };
@@ -103,6 +103,7 @@ export type SmartSearchBackendQuery = {
103
103
  conditions: SmartSearchBackendQueryCondition[];
104
104
  }[];
105
105
  returnType: SmartSearchReturnType;
106
+ timeSchedule?: Schedule;
106
107
  };
107
108
  export declare enum SmartSearchTargets {
108
109
  Tracking = "tracking",
@@ -139,13 +140,9 @@ export declare enum SmartSearchConditionTypes {
139
140
  }
140
141
  export type SmartSearchOptionValue = DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | DateRangeFilter | SiteAnalyticsView;
141
142
  export type SmartSearchBackendQueryPayload = {
142
- cameraExid: string;
143
143
  name: string;
144
144
  description: string;
145
- query: {
146
- req: SmartSearchBackendQuery;
147
- timeSchedule?: Schedule | undefined;
148
- };
145
+ query: SmartSearchBackendQuery;
149
146
  fromDate?: DateType;
150
147
  toDate?: DateType;
151
148
  author: string;
@@ -158,10 +155,7 @@ export type SmartSearchBackendQueryPayload = {
158
155
  export type SavedQuery = {
159
156
  description: string;
160
157
  id: number;
161
- query: {
162
- req: SmartSearchBackendQuery;
163
- timeSchedule?: Schedule | undefined;
164
- };
158
+ query: SmartSearchBackendQuery;
165
159
  params: Record<string, string>;
166
160
  components?: Omit<SmartSearchPart, "id">[];
167
161
  toDate?: DateType;
@@ -281,11 +275,7 @@ type SmartSearchResultItemByType = {
281
275
  [SmartSearchReturnType.FirstLastSeen]: SmartSearchResultItemFirstLastSeen;
282
276
  [SmartSearchReturnType.All]: SmartSearchResultItemAll;
283
277
  };
284
- export type SmartSearchResponse<R extends SmartSearchReturnType = SmartSearchReturnType.FirstLastSeen> = {
285
- data: PaginatedItems<SmartSearchResultItemByType[R]>;
286
- message?: string;
287
- success: boolean;
288
- };
278
+ export type SmartSearchResponse<R extends SmartSearchReturnType = SmartSearchReturnType.FirstLastSeen> = PaginatedItems<SmartSearchResultItemByType[R]>;
289
279
  export type SmartSearchMinifiedPart = {
290
280
  t: SmartSearchComponentType;
291
281
  v: unknown;
@@ -0,0 +1,5 @@
1
+ import { CameraExid } from "@evercam/api/types";
2
+ export type SmartSearchQueriesRequestPayload = {
3
+ camerasExid: CameraExid[];
4
+ name?: string;
5
+ };
@@ -48,12 +48,44 @@ export type DeleteSnapshotQueryParams = {
48
48
  adminEmail: string;
49
49
  adminFullname: string;
50
50
  };
51
- export type TransferCloudRecordingsQueryParams = {
51
+ export type SnapshotTransfer = {
52
+ id: number;
53
+ sourceCamera: SnapshotTransferCamera;
54
+ targetCamera: SnapshotTransferCamera;
55
+ fromDate: DateType;
56
+ toDate: DateType;
57
+ overwriteExisting?: boolean | null;
58
+ deleteSource?: boolean | null;
59
+ requestor: SnapshotTransferRequestor;
60
+ status: SnapshotTransferStatus;
61
+ insertedAt: DateType;
62
+ attempts?: number | null;
63
+ errorMessage?: string | null;
64
+ snapshotsTransferred?: number | null;
65
+ };
66
+ export type SnapshotTransferCamera = {
67
+ id: number;
68
+ exid: CameraExid;
69
+ name: string;
70
+ };
71
+ export type SnapshotTransferRequestor = {
72
+ email: string;
73
+ firstname: string;
74
+ lastname: string;
75
+ };
76
+ export declare enum SnapshotTransferStatus {
77
+ Completed = "completed",
78
+ Failed = "failed",
79
+ Processing = "processing",
80
+ Pending = "pending",
81
+ Cancelled = "cancelled"
82
+ }
83
+ export type TransferCloudRecordingsQueryParams = PaginationParams & {
52
84
  targetCameraExid: CameraExid;
53
85
  fromDate: DateType;
54
86
  toDate: DateType;
55
- overwriteExistingSnapshots?: boolean;
56
- keepSourceSnapshots?: boolean;
87
+ overwriteExisting?: boolean;
88
+ deleteSource?: boolean;
57
89
  adminEmail?: string;
58
90
  adminFullname?: string;
59
91
  };
@@ -0,0 +1,19 @@
1
+ import type { DateType } from "@evercam/api/types";
2
+ export type StorageProvider = {
3
+ id?: number;
4
+ cameraId: number;
5
+ type: string;
6
+ provider: string;
7
+ url: string;
8
+ startDate: DateType;
9
+ endDate: DateType;
10
+ config: Record<string, any>;
11
+ insertedAt?: DateType;
12
+ };
13
+ export type StorageProvidersResponsePayload = {
14
+ providers: StorageProvider[];
15
+ };
16
+ export declare enum ProjectStorageProvider {
17
+ Seaweedfs = "seaweedfs",
18
+ S3 = "s3"
19
+ }
@@ -7,7 +7,8 @@ export declare enum TimelapseStatus {
7
7
  export declare enum TimelapseDuration {
8
8
  ThirtySeconds = 30,
9
9
  SixtySeconds = 60,
10
- NintySeconds = 90
10
+ NintySeconds = 90,
11
+ TwoMinutes = 120
11
12
  }
12
13
  export type TimelapseVideoOptions = {
13
14
  width?: number;
@@ -55,7 +55,6 @@ export declare enum UserFeatureFlag {
55
55
  CompanyAdmin = "company-admin",
56
56
  VideoWalls = "video-walls",
57
57
  MassCameraSharing = "mass-camera-sharing",
58
- Copilot = "copilot",
59
58
  ProjectSharing = "project-sharing"
60
59
  }
61
60
  export type ProjectUser = User & {