@evercam/api 1.0.0-fa346266d → 1.0.0-fba4c1b51

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/3dFirebaseApi.d.ts +11 -0
  3. package/dist/api/adminApi.d.ts +92 -26
  4. package/dist/api/aiApi.d.ts +70 -10
  5. package/dist/api/client/customErrors.d.ts +10 -0
  6. package/dist/api/client/interceptors.d.ts +3 -2
  7. package/dist/api/client/swr/Swr.d.ts +14 -0
  8. package/dist/api/client/swr/SwrStore.d.ts +10 -0
  9. package/dist/api/evercamApi.d.ts +78 -31
  10. package/dist/api/evercamLabsApi.d.ts +6 -10
  11. package/dist/api/ingestApi.d.ts +34 -11
  12. package/dist/api/weatherApi.d.ts +7 -23
  13. package/dist/index.js +1380 -788
  14. package/dist/index.js.map +1 -1
  15. package/dist/index.umd.cjs +1 -1
  16. package/dist/index.umd.cjs.map +1 -1
  17. package/dist/types/360.d.ts +60 -2
  18. package/dist/types/aconex.d.ts +1 -1
  19. package/dist/types/analytics.d.ts +86 -69
  20. package/dist/types/anpr.d.ts +16 -17
  21. package/dist/types/automation.d.ts +4 -0
  22. package/dist/types/axios.d.ts +15 -1
  23. package/dist/types/camera.d.ts +26 -57
  24. package/dist/types/comments.d.ts +31 -8
  25. package/dist/types/company.d.ts +29 -1
  26. package/dist/types/connector.d.ts +6 -1
  27. package/dist/types/coolify.d.ts +20 -0
  28. package/dist/types/copilot.d.ts +9 -8
  29. package/dist/types/countries.d.ts +0 -7
  30. package/dist/types/detections.d.ts +60 -7
  31. package/dist/types/errors.d.ts +13 -0
  32. package/dist/types/index.d.ts +8 -2
  33. package/dist/types/ingest.d.ts +4 -0
  34. package/dist/types/kit.d.ts +65 -7
  35. package/dist/types/{sitePlanner.d.ts → planner.d.ts} +8 -2
  36. package/dist/types/posthog.d.ts +18 -0
  37. package/dist/types/procore.d.ts +149 -3
  38. package/dist/types/progressPhoto.d.ts +21 -7
  39. package/dist/types/project.d.ts +10 -1
  40. package/dist/types/recording.d.ts +1 -2
  41. package/dist/types/recycleBin.d.ts +14 -0
  42. package/dist/types/roi.d.ts +2 -1
  43. package/dist/types/routeParams.d.ts +4 -2
  44. package/dist/types/shared.d.ts +2 -16
  45. package/dist/types/shares.d.ts +5 -1
  46. package/dist/types/siteAnalytics.d.ts +77 -20
  47. package/dist/types/snapshots.d.ts +9 -0
  48. package/dist/types/sso.d.ts +55 -0
  49. package/dist/types/streaming.d.ts +3 -25
  50. package/dist/types/systemCheck.d.ts +11 -0
  51. package/dist/types/tag.d.ts +12 -0
  52. package/dist/types/time.d.ts +2 -0
  53. package/dist/types/timelapse.d.ts +15 -0
  54. package/dist/types/user.d.ts +1 -6
  55. package/dist/types/weather.d.ts +8 -2
  56. package/dist/types/widget.d.ts +29 -10
  57. package/dist/types/xweather.d.ts +12 -0
  58. package/package.json +5 -4
  59. package/dist/types/devices.d.ts +0 -228
@@ -1,14 +1,31 @@
1
- import { CameraExid, DateType, ProjectExid } from "@/types";
1
+ import { CameraExid, DateType, ProjectExid, PaginationParams } from "@/types";
2
+ export declare enum CommentsScope {
3
+ Recordings = "recordings",
4
+ ThreeSixty = "360",
5
+ Drone = "drone"
6
+ }
7
+ export declare enum CommentsLabel {
8
+ Info = "Info",
9
+ Danger = "Danger",
10
+ Restricted = "Restricted"
11
+ }
2
12
  export type CommentsRequestPayload = {
3
13
  cameraExid: CameraExid;
4
14
  fromDate: string;
5
15
  toDate: string;
16
+ scope: CommentsScope;
6
17
  page?: number;
7
18
  limit?: number;
8
19
  };
9
- export type CommentPosition = {
10
- coordinates: Array<number>;
11
- type: string;
20
+ export type CommentsListRequestPayload = PaginationParams & {
21
+ projectExid?: ProjectExid;
22
+ cameraExid?: CameraExid;
23
+ fromDate?: string;
24
+ toDate?: string;
25
+ scope?: CommentsScope;
26
+ creatorEmail?: string;
27
+ content?: string;
28
+ includeArchived?: boolean;
12
29
  };
13
30
  export type Comment = {
14
31
  fromDate?: string;
@@ -22,15 +39,21 @@ export type Comment = {
22
39
  createdAt?: string;
23
40
  creatorEmail?: string;
24
41
  creatorName?: string;
25
- position2d: CommentPosition;
42
+ position2d?: [number, number];
43
+ position3d?: [number, number, number];
44
+ context?: Record<string, unknown>;
26
45
  canDelete?: boolean;
46
+ archivedAt?: string;
27
47
  };
28
48
  export type CommentCreationRequestPayload = {
29
49
  fromDate?: DateType;
30
50
  toDate?: DateType;
31
- timestamp: DateType;
51
+ timestamp?: DateType;
52
+ scope?: CommentsScope;
32
53
  projectExid: ProjectExid;
33
- cameraExid: CameraExid;
54
+ cameraExid?: CameraExid;
34
55
  content: string;
35
- position2d: Array<number>;
56
+ position2d?: [number, number];
57
+ position3d?: [number, number, number];
58
+ context?: Record<string, unknown>;
36
59
  };
@@ -13,6 +13,34 @@ export type CompanyProject = {
13
13
  status: string;
14
14
  startedAt: DateType;
15
15
  };
16
+ export type CompanyKit = {
17
+ id: number;
18
+ name: string;
19
+ serial: string;
20
+ status: string;
21
+ powerType: string;
22
+ countryName: string;
23
+ nvrId: string;
24
+ nvrSerial: string;
25
+ nvrVersion: string;
26
+ nvrNerves: boolean;
27
+ nvrModel: string;
28
+ nvrDeviceType: string;
29
+ routerId: string;
30
+ routerSerial: string;
31
+ projectExid: string;
32
+ projectName: string;
33
+ alarms: Array<string>;
34
+ sims: Array<{
35
+ id: number;
36
+ number: string;
37
+ }>;
38
+ cameras: Array<{
39
+ exid: string;
40
+ name: string;
41
+ status: string;
42
+ }>;
43
+ };
16
44
  export type Company = {
17
45
  id: number;
18
46
  exid: string;
@@ -25,7 +53,7 @@ export type Company = {
25
53
  cameras: number;
26
54
  users: number;
27
55
  activeUsers: number;
28
- createdAt: DateType;
56
+ insertedAt: DateType;
29
57
  };
30
58
  export type CompanyQueryParams = PaginationParams & {
31
59
  name: string;
@@ -7,7 +7,12 @@ export declare enum Connector {
7
7
  Procore = "procore",
8
8
  Autodesk = "autodesk",
9
9
  AutodeskViewer = "autodesk_viewer",
10
- VoyageControl = "voyage_control"
10
+ VoyageControl = "voyage_control",
11
+ XWeather = "xweather"
12
+ }
13
+ export declare enum ProcoreType {
14
+ Observations = "observations",
15
+ Photos = "photos"
11
16
  }
12
17
  export type ConnectorResponsePayload = Array<{
13
18
  hostname: string;
@@ -0,0 +1,20 @@
1
+ import { DateType } from "@/types/time";
2
+ export type CreateCoolifyAppRequestPayload = {
3
+ cameraExid: string;
4
+ startDate: DateType;
5
+ modelVersion: string;
6
+ snapshotRequestTimeout: string | number;
7
+ serverUuid: string;
8
+ branch: string;
9
+ useThirdParty: boolean;
10
+ };
11
+ export type SaveCoolifyAppRequestPayload = {
12
+ contextCameraExid: string;
13
+ coolifyServiceId: string;
14
+ modelVersion: string;
15
+ startTime: string;
16
+ branchName: string;
17
+ snapshotRequestTimeout: string | number;
18
+ serverUuid: string;
19
+ useThirdParty: boolean;
20
+ };
@@ -1,7 +1,8 @@
1
1
  import type { AnalyticsEventPageId, CameraExid, CameraFeatureFlag, CameraStatus, ProjectExid, ProjectFeatureFlag, ProjectStatus } from "@/types";
2
2
  export declare enum CopilotMessageAuthor {
3
3
  Copilot = "copilot",
4
- User = "user"
4
+ User = "user",
5
+ System = "system"
5
6
  }
6
7
  export declare enum CopilotMessageType {
7
8
  Text = "text",
@@ -33,12 +34,13 @@ export declare enum CopilotMissingFieldsLabels {
33
34
  FromDate = "Start date",
34
35
  ToDate = "End date"
35
36
  }
36
- export type CopilotMissingField = {
37
+ export type CopilotMissingField<T = any> = {
37
38
  name: string;
38
39
  label: string;
39
40
  value: any;
40
41
  type: string;
41
42
  toolId: string;
43
+ error?: T;
42
44
  };
43
45
  export type CopilotMissingFields = Record<number, CopilotMissingField[]>;
44
46
  export type UserConversations = CopilotConversation & {
@@ -57,7 +59,8 @@ export declare enum CopilotSocketEvent {
57
59
  ChatError = "chat:chatError",
58
60
  MissingFields = "chat:missingFields",
59
61
  MissingFieldsCompleted = "chat:missingFields:completed",
60
- SystemToolCallResponse = "system:toolCall:response"
62
+ SystemToolCallResponse = "system:toolCall:response",
63
+ ChangeProvider = "chat:changeProvider"
61
64
  }
62
65
  export type CopilotConversation = {
63
66
  id: number;
@@ -118,9 +121,6 @@ export type CopilotProject = {
118
121
  featureFlags?: ProjectFeatureFlag[];
119
122
  cameras?: CopilotCamera[];
120
123
  };
121
- export type CopilotConversationContext = {
122
- availableProjects: CopilotProject[];
123
- };
124
124
  export type CopilotMessageContext = {
125
125
  pageId?: AnalyticsEventPageId;
126
126
  selectedCamera?: CopilotCamera;
@@ -129,8 +129,8 @@ export type CopilotMessageContext = {
129
129
  export type CopilotMessageStep = {
130
130
  args: string[];
131
131
  depth: number;
132
- id: number;
133
- message_id: number;
132
+ id?: number;
133
+ message_id?: number;
134
134
  step: CopilotStepId;
135
135
  timestamp: string;
136
136
  };
@@ -154,3 +154,4 @@ export declare enum CopilotMissingFieldType {
154
154
  String = "string",
155
155
  Number = "number"
156
156
  }
157
+ export type CopilotCompletedFields = Record<string, unknown>;
@@ -490,13 +490,6 @@ export declare enum CountryCode {
490
490
  Zambia = "zm",
491
491
  Zimbabwe = "zw"
492
492
  }
493
- export declare enum Region {
494
- Apac = "apac",
495
- Emea = "emea",
496
- Us = "us",
497
- Latam = "latam",
498
- Na = "na"
499
- }
500
493
  export declare enum CameraRegion {
501
494
  APAC = "apac",
502
495
  AU = "au",
@@ -1,11 +1,17 @@
1
- import { type CameraExid, type DateType, DetectionLabel, SegmentLabel, type TimelineDateInterval, TimelinePrecision } from "@/types";
2
- export type DetectionsFilters = {
3
- cameraExid: CameraExid;
1
+ import { type BoundingBox, type ProjectExid, type CameraExid, type DateType, DetectionLabel, SegmentLabel, type TimelineDateInterval, TimelinePrecision } from "@/types";
2
+ export type BaseDetectionsFilters = {
4
3
  fromDate: string | Date;
5
4
  toDate: string | Date;
6
5
  labels: DetectionLabel | DetectionLabel[];
7
6
  trackId?: number;
8
7
  };
8
+ export type DetectionsFilters = BaseDetectionsFilters & {
9
+ projectExid: ProjectExid;
10
+ cameraExids?: CameraExid[];
11
+ };
12
+ export type SegmentsFilters = BaseDetectionsFilters & {
13
+ cameraExid: CameraExid;
14
+ };
9
15
  export type BBox = number[];
10
16
  export type SelectedObjectPath = {
11
17
  label: string;
@@ -16,9 +22,32 @@ export type SelectedObjectPath = {
16
22
  bbox: BBox;
17
23
  }>;
18
24
  };
25
+ export type Label = DetectionLabel | PpeLabel;
19
26
  export type Detection = {
20
27
  bbox: BBox;
21
28
  timestamp: string | Date;
29
+ label: DetectionLabel;
30
+ confidenceScore: number;
31
+ };
32
+ export type DetectionsGroup = {
33
+ timestamp: DateType;
34
+ detections: Detection[];
35
+ };
36
+ export type DetectionsCounts = {
37
+ timestamps: number;
38
+ } & {
39
+ [label in Label]: number;
40
+ };
41
+ export type DetectionsCountsByPeriod = {
42
+ days: Array<{
43
+ day: string;
44
+ } & DetectionsCounts>;
45
+ months: Array<{
46
+ month: string;
47
+ } & DetectionsCounts>;
48
+ years: Array<{
49
+ year: string;
50
+ } & DetectionsCounts>;
22
51
  };
23
52
  export type Tracking = {
24
53
  trackId: number;
@@ -32,9 +61,12 @@ export type SegmentsByLabel = Record<SegmentLabel, Segment[]>;
32
61
  export type SegmentPolygonCoords = number[][];
33
62
  export type Segment = {
34
63
  id: number;
35
- mask: SegmentPolygonCoords;
64
+ mask?: SegmentPolygonCoords;
36
65
  label: string;
37
66
  timestamp: string | Date;
67
+ cameraExid?: CameraExid;
68
+ bbox?: BoundingBox;
69
+ area?: number;
38
70
  };
39
71
  export type SegmentSimilarityResult = {
40
72
  distance: number;
@@ -52,14 +84,20 @@ export type SegmentsSimilaritySearchParams = {
52
84
  fromDate: string;
53
85
  toDate: string;
54
86
  };
55
- export type CountsParams = {
56
- cameraExid: CameraExid;
87
+ export type BaseCountsParams = {
57
88
  fromDate: string | Date;
58
89
  toDate: string | Date;
59
- precision: TimelinePrecision;
90
+ precision: keyof typeof TimelinePrecision;
60
91
  trackId: number;
61
92
  labels: DetectionLabel | DetectionLabel[];
62
93
  };
94
+ export type DetectionsCountsParams = BaseCountsParams & {
95
+ projectExid: ProjectExid;
96
+ cameraExids?: CameraExid[];
97
+ };
98
+ export type SegmentsCountsParams = BaseCountsParams & {
99
+ cameraExid: CameraExid;
100
+ };
63
101
  export type CountByPeriod = {
64
102
  date: string | Date;
65
103
  counts: Record<string, number>;
@@ -71,3 +109,18 @@ export type LuminanceReading = {
71
109
  luminanceDelta: number;
72
110
  luminanceAverage: number;
73
111
  };
112
+ export declare enum PpeLabel {
113
+ Helmet = "helmet",
114
+ HighVisibilityVest = "high-visibility-vest",
115
+ SafetyGlasses = "safety-glasses",
116
+ Person = "person",
117
+ Man = "man",
118
+ Woman = "woman"
119
+ }
120
+ export declare enum DetectionModel {
121
+ Yolov10 = 1,
122
+ Yolov11 = 2,
123
+ Yolov112 = 3,
124
+ GroundingDino = 4,
125
+ Owlv2 = 5
126
+ }
@@ -14,12 +14,25 @@ export declare enum ErrorType {
14
14
  UnhandledRejection = "UnhandledRejection",
15
15
  TypeError = "TypeError"
16
16
  }
17
+ export declare enum ErrorCode {
18
+ InternalServerError = 500,
19
+ BadGatewayError = 502,
20
+ ServiceUnavailableError = 503,
21
+ GatewayTimeoutError = 504,
22
+ BadRequestError = 400,
23
+ UnauthorizedError = 401,
24
+ ForbiddenError = 403,
25
+ NotFoundError = 404,
26
+ ConflictError = 409
27
+ }
17
28
  export declare enum EvercamApiErrorCode {
29
+ IntegrationError = "INTEGRATION_ERROR",
18
30
  BadArgument = "BAD_ARGUMENT",
19
31
  DeviceError = "DEVICE_ERROR",
20
32
  UnsupportedOperation = "UNSUPPORTED_OPERATION",
21
33
  QuotaExceeded = "QUOTA_EXCEEDED",
22
34
  InvalidCredentials = "INVALID_CREDENTIALS",
35
+ InvalidToken = "INVALID_TOKEN",
23
36
  ProviderAuthFailure = "PROVIDER_AUTH_FAILURE",
24
37
  ProviderEmailRequired = "PROVIDER_EMAIL_REQUIRED",
25
38
  PasswordReset = "PASSWORD_RESET",
@@ -9,7 +9,6 @@ export * from "./camera";
9
9
  export * from "./compare";
10
10
  export * from "./copilot";
11
11
  export * from "./credentials";
12
- export * from "./devices";
13
12
  export * from "./drone";
14
13
  export * from "./errors";
15
14
  export * from "./gateReport";
@@ -28,7 +27,8 @@ export * from "./routeParams";
28
27
  export * from "./router";
29
28
  export * from "./shares";
30
29
  export * from "./sim";
31
- export * from "./sitePlanner";
30
+ export * from "./systemCheck";
31
+ export * from "./planner";
32
32
  export * from "./storageServers";
33
33
  export * from "./streaming";
34
34
  export * from "./time";
@@ -50,3 +50,9 @@ export * from "./siteAnalytics";
50
50
  export * from "./widget";
51
51
  export * from "./countries";
52
52
  export * from "./automation";
53
+ export * from "./sso";
54
+ export * from "./coolify";
55
+ export * from "./tag";
56
+ export * from "./xweather";
57
+ export * from "./posthog";
58
+ export * from "./recycleBin";
@@ -9,6 +9,10 @@ export declare enum IngestProcessingStatus {
9
9
  InProgress = "inprogress",
10
10
  Pending = "pending"
11
11
  }
12
+ export declare enum IngestVersions {
13
+ V1 = "v1",
14
+ V2 = "v2"
15
+ }
12
16
  export type DronesQueryParams = Omit<PaginationParams, "sort"> & {
13
17
  projectId: string;
14
18
  consumed: string;
@@ -1,10 +1,10 @@
1
- import { CountryCode, CountryId, DateType, Nvr, PaginationParams, PowerType, Project, Region, Router, Schedule } 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,6 +16,9 @@ export type Kit = {
16
16
  serial: string;
17
17
  status: KitStatus;
18
18
  powerSchedule: Schedule;
19
+ tags: Tag[];
20
+ storages: KitStorage[];
21
+ createdAt: string;
19
22
  };
20
23
  export declare enum KitStatus {
21
24
  New = "new",
@@ -23,17 +26,28 @@ export declare enum KitStatus {
23
26
  Deployed = "deployed",
24
27
  Decommissioned = "decommissioned"
25
28
  }
29
+ export declare enum KitRegion {
30
+ APAC = "apac",
31
+ EMEA = "emea",
32
+ LATAM = "latam",
33
+ US = "na"
34
+ }
26
35
  export declare enum KitAlarm {
27
36
  NvrOffline = "nvr_offline",
37
+ OfflineScheduled = "offline_scheduled",
28
38
  UnknownCamera = "unknown_camera",
29
39
  NotRecordingCamera = "not_recording_camera",
30
- OfflineScheduled = "offline_scheduled",
31
40
  FullSD = "full_sd",
32
- FullStorage = "full_storage"
41
+ FullStorage = "full_storage",
42
+ HddUnmounted = "hdd_unmounted",
43
+ NoHdd = "no_hdd",
44
+ MissingRouterInfo = "missing_router_info",
45
+ AcFailure = "ac_failure",
46
+ LowBattery = "low_battery"
33
47
  }
34
48
  export declare enum KitMetricId {
35
- BatteryStats = "battery",
36
- PanelPowerStats = "panel_power"
49
+ SolarCharger = "solar_charger",
50
+ PanelPower = "panel_power"
37
51
  }
38
52
  export declare enum KitMetricPeriod {
39
53
  Last15Minutes = "now-15m",
@@ -238,6 +252,7 @@ export type KitQueryParams = PaginationParams & {
238
252
  name: string;
239
253
  serial: string;
240
254
  status: KitStatus;
255
+ tagId: number | number[];
241
256
  };
242
257
  export type AdminKit = {
243
258
  id: number;
@@ -285,7 +300,7 @@ export type KitCreatePayload = {
285
300
  status: KitStatus;
286
301
  powerType: PowerType;
287
302
  config: {
288
- region: Region;
303
+ region: KitRegion;
289
304
  };
290
305
  };
291
306
  export type KitUpdatePayload = {
@@ -295,3 +310,46 @@ export type KitUpdatePayload = {
295
310
  kitStatus: KitStatus;
296
311
  type: string;
297
312
  };
313
+ export declare enum KitStorageTransport {
314
+ Sata = "sata",
315
+ Nvme = "nvme",
316
+ Usb = "usb"
317
+ }
318
+ export type KitStorageRequestPayload = {
319
+ kitId: number;
320
+ };
321
+ export type KitStorage = {
322
+ id: number;
323
+ serial: string;
324
+ status: string;
325
+ type: string;
326
+ metadata: {
327
+ formFactor: string;
328
+ };
329
+ model: string;
330
+ insertedAt: DateTime;
331
+ updatedAt: DateTime;
332
+ vendor: string;
333
+ kitId: number;
334
+ capacity: number;
335
+ freeSpace: number;
336
+ tran: KitStorageTransport;
337
+ };
338
+ export type KitFootageRequestPayload = {
339
+ cameraId: CameraExid;
340
+ storageId: number;
341
+ };
342
+ export type KitFootage = {
343
+ id: number;
344
+ startDate: string;
345
+ endDate: string;
346
+ cameraId: number;
347
+ storageId: number;
348
+ };
349
+ export type KitAlarmItem = {
350
+ id: number;
351
+ kitId: number;
352
+ alarm: KitAlarm;
353
+ startDate: DateTime;
354
+ endDate: DateTime | null;
355
+ };
@@ -1,12 +1,18 @@
1
+ export declare enum EDistortImageModes {
2
+ FreeRotate = "freeRotate",
3
+ Lock = "lock"
4
+ }
1
5
  export declare enum EMapTypes {
2
6
  Blank = "Blank",
3
7
  Satellite = "Satellite",
4
8
  Street = "Street",
5
9
  GoogleSatellite = "hybrid",
6
- GoogleStreet = "roadmap"
10
+ GoogleStreet = "roadmap",
11
+ GoogleTerrain = "terrain"
7
12
  }
8
13
  export declare enum EMarkers {
9
- CameraMarker = "cameraMarker"
14
+ CameraMarker = "cameraMarker",
15
+ ThreeSixtyMarker = "threeSixtyMarkers"
10
16
  }
11
17
  export declare enum EPageType {
12
18
  List = "list",
@@ -0,0 +1,18 @@
1
+ export type ActiveUsersRequestPayload = {
2
+ from?: string;
3
+ to?: string;
4
+ companyExid?: string;
5
+ projectExid?: string;
6
+ cameraExid?: string;
7
+ };
8
+ export type ActiveUsersResponsePayload = Array<{
9
+ date?: string;
10
+ dau?: number;
11
+ wau?: number;
12
+ mau?: number;
13
+ }>;
14
+ export declare enum ActiveUsersMetric {
15
+ DAU = "dau",
16
+ WAU = "wau",
17
+ MAU = "mau"
18
+ }