@evercam/api 1.0.0-9cdcb2c4a → 1.0.0-9dffa9592

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 (96) hide show
  1. package/README.md +4 -0
  2. package/dist/api/api/3dFirebaseApi.d.ts +210 -10
  3. package/dist/api/api/adminApi.d.ts +140 -96
  4. package/dist/api/api/aiApi.d.ts +153 -82
  5. package/dist/api/api/authzApi.d.ts +34 -15
  6. package/dist/api/api/client/axios.d.ts +2 -1
  7. package/dist/api/api/client/swr/Swr.d.ts +1 -1
  8. package/dist/api/api/evercamApi.d.ts +148 -102
  9. package/dist/api/api/evercamLabsApi.d.ts +9 -7
  10. package/dist/api/api/exNvrApi.d.ts +1 -1
  11. package/dist/api/api/ingestApi.d.ts +125 -33
  12. package/dist/api/api/ptzApi.d.ts +12 -3
  13. package/dist/api/api/videoWallApi.d.ts +7 -7
  14. package/dist/api/api/weatherApi.d.ts +2 -2
  15. package/dist/api/types/360.d.ts +291 -16
  16. package/dist/api/types/aconex.d.ts +104 -6
  17. package/dist/api/types/admin.d.ts +51 -0
  18. package/dist/api/types/aiConfigs.d.ts +242 -0
  19. package/dist/api/types/analytics.d.ts +174 -43
  20. package/dist/api/types/anpr.d.ts +53 -13
  21. package/dist/api/types/auditLogs.d.ts +19 -1
  22. package/dist/api/types/authz.d.ts +107 -0
  23. package/dist/api/types/autodesk.d.ts +7 -7
  24. package/dist/api/types/automation.d.ts +105 -1
  25. package/dist/api/types/axios.d.ts +19 -14
  26. package/dist/api/types/bim.d.ts +38 -9
  27. package/dist/api/types/camera.d.ts +111 -99
  28. package/dist/api/types/comments.d.ts +26 -11
  29. package/dist/api/types/company.d.ts +43 -2
  30. package/dist/api/types/compare.d.ts +20 -5
  31. package/dist/api/types/connector.d.ts +5 -5
  32. package/dist/api/types/coolify.d.ts +20 -2
  33. package/dist/api/types/copilot.d.ts +11 -9
  34. package/dist/api/types/credentials.d.ts +1 -0
  35. package/dist/api/types/detections.d.ts +23 -32
  36. package/dist/api/types/drone.d.ts +96 -6
  37. package/dist/api/types/errors.d.ts +14 -1
  38. package/dist/api/types/gateReport.d.ts +49 -168
  39. package/dist/api/types/gateReportManagement.d.ts +170 -0
  40. package/dist/api/types/hammertech.d.ts +98 -0
  41. package/dist/api/types/hdd.d.ts +26 -1
  42. package/dist/api/types/index.d.ts +17 -2
  43. package/dist/api/types/ingest.d.ts +191 -4
  44. package/dist/api/types/kit.d.ts +83 -57
  45. package/dist/api/types/map.d.ts +12 -0
  46. package/dist/api/types/media.d.ts +10 -3
  47. package/dist/api/types/notification.d.ts +72 -3
  48. package/dist/api/types/oauth.d.ts +62 -0
  49. package/dist/api/types/observationEvents.d.ts +61 -0
  50. package/dist/api/types/observations.d.ts +85 -0
  51. package/dist/api/types/planner.d.ts +101 -9
  52. package/dist/api/types/posthog.d.ts +35 -0
  53. package/dist/api/types/procore.d.ts +13 -6
  54. package/dist/api/types/progressPhoto.d.ts +6 -31
  55. package/dist/api/types/project.d.ts +144 -18
  56. package/dist/api/types/recording.d.ts +10 -15
  57. package/dist/api/types/recycleBin.d.ts +14 -0
  58. package/dist/api/types/ring.d.ts +53 -0
  59. package/dist/api/types/roi.d.ts +3 -11
  60. package/dist/api/types/routeParams.d.ts +3 -1
  61. package/dist/api/types/router.d.ts +20 -1
  62. package/dist/api/types/shared.d.ts +29 -27
  63. package/dist/api/types/shares.d.ts +6 -157
  64. package/dist/api/types/sim.d.ts +6 -6
  65. package/dist/api/types/siteAnalytics.d.ts +189 -46
  66. package/dist/api/types/siteAnalyticsManagement.d.ts +117 -0
  67. package/dist/api/types/siteView.d.ts +73 -0
  68. package/dist/api/types/smartSeach.d.ts +5 -0
  69. package/dist/api/types/snapshots.d.ts +55 -1
  70. package/dist/api/types/socket.d.ts +4 -0
  71. package/dist/api/types/sso.d.ts +55 -0
  72. package/dist/api/types/storageProvider.d.ts +19 -0
  73. package/dist/api/types/storyblok.d.ts +27 -0
  74. package/dist/api/types/streaming.d.ts +3 -3
  75. package/dist/api/types/tag.d.ts +1 -1
  76. package/dist/api/types/time.d.ts +4 -18
  77. package/dist/api/types/timelapse.d.ts +7 -11
  78. package/dist/api/types/user.d.ts +106 -35
  79. package/dist/api/types/videoWall.d.ts +47 -14
  80. package/dist/api/types/weather.d.ts +77 -11
  81. package/dist/api/types/widget.d.ts +96 -16
  82. package/dist/api/types/xweather.d.ts +4 -4
  83. package/dist/index.js +2454 -1020
  84. package/dist/index.js.map +1 -1
  85. package/dist/index.umd.cjs +1 -1
  86. package/dist/index.umd.cjs.map +1 -1
  87. package/dist/shared/types/components.d.ts +211 -35
  88. package/dist/shared/types/customDataTableFilters.d.ts +10 -0
  89. package/dist/shared/types/imagePlayer.d.ts +10 -3
  90. package/dist/shared/types/index.d.ts +3 -0
  91. package/dist/shared/types/observations.d.ts +21 -0
  92. package/dist/shared/types/rbac.d.ts +67 -0
  93. package/dist/shared/types/timeline.d.ts +2 -1
  94. package/package.json +6 -4
  95. package/dist/api/types/storageServers.d.ts +0 -4
  96. package/dist/api/types/vendorModel.d.ts +0 -15
@@ -0,0 +1,53 @@
1
+ export type RingCompleteLinkingPayload = {
2
+ nonce: string;
3
+ time: string;
4
+ };
5
+ /** The only auto-import status complete-linking returns today. */
6
+ export declare const RING_AUTO_IMPORT_QUEUED = "queued";
7
+ export type RingAutoImportStatus = typeof RING_AUTO_IMPORT_QUEUED;
8
+ export type RingCompleteLinkingResponsePayload = {
9
+ status: string;
10
+ /** Absent when the API did not schedule an import. */
11
+ autoImport?: RingAutoImportStatus;
12
+ };
13
+ export type RingDevice = {
14
+ deviceId: string;
15
+ name: string;
16
+ /** Resolved from Ring's `device-status`; null when Ring did not return it. */
17
+ online: boolean | null;
18
+ deviceType: string | null;
19
+ firmwareVersion: string | null;
20
+ /** Always null — Ring's API does not expose device power level. */
21
+ batteryLife: number | null;
22
+ location: string | null;
23
+ imported: boolean;
24
+ cameraExid?: string;
25
+ projectExid?: string;
26
+ projectName?: string;
27
+ };
28
+ export type RingDevicesResponsePayload = {
29
+ devices: RingDevice[];
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
+ };
@@ -3,23 +3,15 @@ export declare enum RoiType {
3
3
  AnprContext = "anpr_context",
4
4
  ExclusionZone = "exclusion_zone",
5
5
  WorkflowArea = "workflow_area",
6
- SiteAnalytics = "site_analytics"
6
+ SiteAnalytics = "site_analytics",
7
+ Ppe = "ppe_roi"
7
8
  }
8
9
  export declare enum RoiShapeType {
9
10
  Polygon = "polygon",
10
11
  Line = "line",
11
12
  Direction = "direction",
12
- Rectangle = "rectangle",
13
- ROIBox = "ROIBox"
13
+ Rectangle = "rectangle"
14
14
  }
15
- export type RoiShape = {
16
- id: number | null;
17
- name: string;
18
- x1: number;
19
- x2: number;
20
- y1: number;
21
- y2: number;
22
- };
23
15
  export declare enum RoiDirection {
24
16
  Arrived = "arrived",
25
17
  Left = "left",
@@ -1,6 +1,7 @@
1
1
  export type RouteParams = {
2
2
  projectExid?: string;
3
3
  cameraExid?: string;
4
+ mediaExid?: string;
4
5
  timestamp?: string;
5
6
  fromDate?: string;
6
7
  toDate?: string;
@@ -46,6 +47,7 @@ export declare enum TimelineMobileCaptureUrlParams {
46
47
  ShowMobileCapture = "showMobileCapture"
47
48
  }
48
49
  export declare enum TimelineCommentsUrlParams {
49
- ShowComments = "showComments"
50
+ ShowComments = "showComments",
51
+ SelectedCommentId = "selectedCommentId"
50
52
  }
51
53
  export type TimelineUrlParams = Record<TimelineUrlParam | TimelineMediaUrlParams | TimelineBimUrlParams | TimelineExNvrRecordingsUrlParams | TimelineAnprUrlParams | TimelineMobileCaptureUrlParams | TimelineCommentsUrlParams, string | null>;
@@ -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,17 @@
1
- import { DateType } from "@/types";
1
+ import { DateType } from "@evercam/api/types";
2
+ export declare enum Operator {
3
+ AND = "and",
4
+ OR = "or"
5
+ }
2
6
  type sortby = string;
3
7
  type sortDirection = "asc" | "desc";
4
8
  export type SortingUrlParam = `${sortby}|${sortDirection}`;
9
+ export type JsonPrimitive = string | number | boolean | null;
10
+ export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
11
+ export type JsonObject = {
12
+ [key: string]: JsonValue;
13
+ };
14
+ export type JsonArray = JsonValue[];
5
15
  export type BatteryReading = {
6
16
  id: number;
7
17
  voltage: number;
@@ -53,7 +63,7 @@ export declare enum UnitSystem {
53
63
  Metric = "metric"
54
64
  }
55
65
  export type Timestamp = string | number;
56
- export type Schedule = {
66
+ export type ScheduleUppercase = {
57
67
  Friday: string[];
58
68
  Monday: string[];
59
69
  Saturday: string[];
@@ -71,6 +81,7 @@ export type ScheduleLowercase = {
71
81
  tuesday: string[];
72
82
  wednesday: string[];
73
83
  };
84
+ export type Schedule = ScheduleUppercase | ScheduleLowercase;
74
85
  export type PaginationParams = {
75
86
  sort?: SortingUrlParam;
76
87
  page?: number;
@@ -90,11 +101,6 @@ export declare enum _3dViewer {
90
101
  Itwin = "itwin",
91
102
  Cesium = "cesium"
92
103
  }
93
- export declare enum SsoProvider {
94
- Microsoft = "microsoft",
95
- Google = "google",
96
- Evercam = "evercam"
97
- }
98
104
  export declare enum InfoPage {
99
105
  ThreeSixtyView = "360",
100
106
  BIMView = "bim",
@@ -113,24 +119,30 @@ export declare enum DownloadFileType {
113
119
  export declare enum FeedbackContext {
114
120
  CopilotMessage = "copilot_message"
115
121
  }
116
- export type FeedbackPayload<T> = {
122
+ export type FeedbackPayload = {
117
123
  id?: number;
118
124
  user: string;
119
125
  text: string;
120
- type: T;
126
+ type: string;
121
127
  context: FeedbackContext;
122
128
  messageId?: number;
123
129
  conversationId?: number;
124
130
  };
125
- export type Stringified<T> = string & {
126
- [P in keyof T]: {
127
- "_ value": T[P];
128
- };
131
+ export type TuplePoint2D = [number, number];
132
+ export type TuplePoint3D = [number, number, number];
133
+ export type Point2D = {
134
+ x: number;
135
+ y: number;
136
+ };
137
+ export type Point3D = {
138
+ x: number;
139
+ y: number;
140
+ z: number;
141
+ };
142
+ export type GeoPoint = {
143
+ lat: number;
144
+ lng: number;
129
145
  };
130
- export interface JSON {
131
- stringify<T>(value: T, replacer?: (key: string, value: unknown) => unknown, space?: string | number): string & Stringified<T>;
132
- parse<T>(text: Stringified<T>, reviver?: (key: unknown, value: unknown) => unknown): T;
133
- }
134
146
  export type Exid = string;
135
147
  export type EntityByExid<Entity extends unknown> = Record<Exid, Entity>;
136
148
  export type BatteryVoltage = {
@@ -157,16 +169,6 @@ export declare enum TimelinePrecision {
157
169
  Minute = "minute",
158
170
  Events = "events"
159
171
  }
160
- export type EntityStatsQueryParams = {
161
- period: "day" | "week" | "month";
162
- startDate: string;
163
- endDate: string;
164
- };
165
- export type EntityStat = {
166
- period: string;
167
- name: string;
168
- count: number;
169
- };
170
172
  export declare enum TaskStatus {
171
173
  Idle = "idle",
172
174
  Loading = "loading",
@@ -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;
@@ -46,151 +33,13 @@ export type SharedUsersResponsePayload = Array<{
46
33
  email: string;
47
34
  name: string;
48
35
  }>;
49
- export type ShareCreateRequestPayload = {
50
- email: string[] | string;
51
- message?: string;
52
- permission?: string;
53
- rights: string;
54
- apiId?: string;
55
- apiKey?: string;
56
- };
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
36
  export type ShareCreateResponsePayload = {
69
37
  shares: Share[];
70
38
  shareRequests: ShareRequest[];
71
39
  };
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"
40
+ export declare enum InviteStatus {
41
+ Pending = 0,
42
+ Cancelled = -1,
43
+ Used = 1,
44
+ Failed = -2
94
45
  }
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
104
- }
105
- export declare enum ShareVisibility {
106
- PublicDiscoverable = "publicDiscoverable",
107
- PublicUndiscoverable = "publicUndiscoverable",
108
- Private = "private"
109
- }
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;