@evercam/api 1.0.0-ae46ef99c → 1.0.0-api-fixes-bdf31a1d5

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 (92) hide show
  1. package/README.md +4 -0
  2. package/dist/api/api/3dFirebaseApi.d.ts +170 -5
  3. package/dist/api/api/adminApi.d.ts +170 -99
  4. package/dist/api/api/aiApi.d.ts +99 -82
  5. package/dist/api/api/authzApi.d.ts +31 -15
  6. package/dist/api/api/client/axios.d.ts +2 -1
  7. package/dist/api/api/client/swr/Swr.d.ts +14 -0
  8. package/dist/api/api/client/swr/SwrStore.d.ts +10 -0
  9. package/dist/api/api/evercamApi.d.ts +158 -116
  10. package/dist/api/api/evercamLabsApi.d.ts +6 -4
  11. package/dist/api/api/exNvrApi.d.ts +1 -1
  12. package/dist/api/api/ingestApi.d.ts +119 -33
  13. package/dist/api/api/ptzApi.d.ts +12 -3
  14. package/dist/api/api/videoWallApi.d.ts +7 -7
  15. package/dist/api/api/weatherApi.d.ts +2 -2
  16. package/dist/api/types/360.d.ts +208 -7
  17. package/dist/api/types/aconex.d.ts +106 -7
  18. package/dist/api/types/admin.d.ts +67 -0
  19. package/dist/api/types/aiConfigs.d.ts +154 -0
  20. package/dist/api/types/analytics.d.ts +172 -41
  21. package/dist/api/types/anpr.d.ts +52 -13
  22. package/dist/api/types/auditLogs.d.ts +63 -38
  23. package/dist/api/types/authz.d.ts +61 -0
  24. package/dist/api/types/autodesk.d.ts +7 -7
  25. package/dist/api/types/automation.d.ts +86 -1
  26. package/dist/api/types/axios.d.ts +28 -7
  27. package/dist/api/types/bim.d.ts +77 -43
  28. package/dist/api/types/camera.d.ts +165 -135
  29. package/dist/api/types/comments.d.ts +43 -21
  30. package/dist/api/types/company.d.ts +91 -11
  31. package/dist/api/types/compare.d.ts +40 -21
  32. package/dist/api/types/connector.d.ts +4 -5
  33. package/dist/api/types/coolify.d.ts +20 -2
  34. package/dist/api/types/copilot.d.ts +11 -6
  35. package/dist/api/types/countries.d.ts +0 -7
  36. package/dist/api/types/credentials.d.ts +1 -0
  37. package/dist/api/types/detections.d.ts +23 -34
  38. package/dist/api/types/drone.d.ts +96 -6
  39. package/dist/api/types/errors.d.ts +12 -0
  40. package/dist/api/types/gateReport.d.ts +50 -158
  41. package/dist/api/types/gateReportManagement.d.ts +175 -0
  42. package/dist/api/types/hdd.d.ts +76 -17
  43. package/dist/api/types/index.d.ts +12 -1
  44. package/dist/api/types/ingest.d.ts +104 -3
  45. package/dist/api/types/kit.d.ts +71 -12
  46. package/dist/api/types/map.d.ts +12 -0
  47. package/dist/api/types/media.d.ts +21 -2
  48. package/dist/api/types/notification.d.ts +50 -14
  49. package/dist/api/types/nvr.d.ts +28 -0
  50. package/dist/api/types/oauth.d.ts +63 -0
  51. package/dist/api/types/planner.d.ts +101 -1
  52. package/dist/api/types/posthog.d.ts +15 -0
  53. package/dist/api/types/procore.d.ts +23 -16
  54. package/dist/api/types/progressPhoto.d.ts +30 -41
  55. package/dist/api/types/project.d.ts +182 -20
  56. package/dist/api/types/recording.d.ts +11 -14
  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 +4 -3
  60. package/dist/api/types/routeParams.d.ts +2 -1
  61. package/dist/api/types/router.d.ts +43 -3
  62. package/dist/api/types/shared.d.ts +81 -53
  63. package/dist/api/types/shares.d.ts +6 -144
  64. package/dist/api/types/sim.d.ts +6 -9
  65. package/dist/api/types/siteAnalytics.d.ts +194 -48
  66. package/dist/api/types/siteView.d.ts +73 -0
  67. package/dist/api/types/smartSeach.d.ts +5 -0
  68. package/dist/api/types/snapshots.d.ts +108 -7
  69. package/dist/api/types/sso.d.ts +55 -0
  70. package/dist/api/types/storageProvider.d.ts +31 -0
  71. package/dist/api/types/storyblok.d.ts +40 -0
  72. package/dist/api/types/streaming.d.ts +4 -5
  73. package/dist/api/types/tag.d.ts +1 -1
  74. package/dist/api/types/time.d.ts +4 -18
  75. package/dist/api/types/timelapse.d.ts +46 -17
  76. package/dist/api/types/user.d.ts +174 -88
  77. package/dist/api/types/videoWall.d.ts +47 -14
  78. package/dist/api/types/weather.d.ts +151 -11
  79. package/dist/api/types/widget.d.ts +143 -54
  80. package/dist/api/types/xweather.d.ts +4 -4
  81. package/dist/index.js +2206 -1029
  82. package/dist/index.js.map +1 -1
  83. package/dist/index.umd.cjs +1 -1
  84. package/dist/index.umd.cjs.map +1 -1
  85. package/dist/shared/types/components.d.ts +163 -18
  86. package/dist/shared/types/customDataTableFilters.d.ts +10 -0
  87. package/dist/shared/types/imagePlayer.d.ts +10 -3
  88. package/dist/shared/types/index.d.ts +2 -0
  89. package/dist/shared/types/rbac.d.ts +67 -0
  90. package/dist/shared/types/timeline.d.ts +2 -1
  91. package/package.json +7 -4
  92. package/dist/api/types/storageServers.d.ts +0 -4
@@ -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
  };
@@ -8,11 +8,14 @@ export type SimProvider = {
8
8
  export type Router = {
9
9
  id?: number;
10
10
  kitId: number | null;
11
+ kitSerial?: string;
12
+ kitName?: string;
11
13
  routerType: string;
12
14
  routerUserId: string;
13
15
  routerPassword: string;
14
16
  serialNumber: number | null;
15
17
  rmsUrl?: string;
18
+ rmsId?: number;
16
19
  externalHost?: string;
17
20
  routerHttpPort: number | null;
18
21
  vpnPassword: string;
@@ -29,8 +32,12 @@ export type Router = {
29
32
  sims: Array<Pick<Sim, "id" | "number">>;
30
33
  billPayers?: Array<RouterBillPayer>;
31
34
  simProviders?: Array<SimProvider>;
32
- projects?: Pick<Project, "exid" | "id" | "name">[];
33
- cameras?: Pick<Camera, "id" | "name">[];
35
+ projects?: Pick<Project, "exid" | "name">[];
36
+ cameras?: Pick<Camera, "id" | "name"> & {
37
+ exid: string;
38
+ }[];
39
+ lastSms?: string;
40
+ lastSmsAt?: string;
34
41
  };
35
42
  export declare enum PowerType {
36
43
  Mains = "mains",
@@ -47,10 +54,28 @@ export declare enum RouterStatus {
47
54
  Active = "active",
48
55
  Inactive = "inactive"
49
56
  }
57
+ export declare enum RouterScanInputMode {
58
+ Qr = "qr",
59
+ Manual = "manual"
60
+ }
50
61
  export type RouterQueryParams = PaginationParams & {
51
62
  routerType: string;
52
63
  vpnServer: string;
53
64
  serialNumber: string;
65
+ kitSerial: string;
66
+ kitName: string;
67
+ cameras: string;
68
+ projects: string;
69
+ sims: string;
70
+ billPayers: string;
71
+ lastSms: string;
72
+ lastSmsAt: string;
73
+ hasBattery: string;
74
+ powerType: PowerType;
75
+ powerSchedule: PowerSchedule;
76
+ status: RouterStatus;
77
+ routerHttpPort: string;
78
+ sort: string;
54
79
  };
55
80
  export type RouterCreatePayload = {
56
81
  serialNumber: number;
@@ -65,3 +90,18 @@ export type RouterCreatePayload = {
65
90
  vpnServer?: string;
66
91
  netbirdUrl?: string;
67
92
  };
93
+ export type RouterQRScanResult = {
94
+ raw: string;
95
+ timestamp: string;
96
+ sn?: string;
97
+ m?: string;
98
+ u?: string;
99
+ pw?: string;
100
+ t?: string;
101
+ s?: string;
102
+ p?: string;
103
+ i?: string;
104
+ b?: string;
105
+ boxId?: string;
106
+ isDuplicate?: boolean;
107
+ };
@@ -1,59 +1,76 @@
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
- id: number;
7
- voltage: number;
8
- datetime: DateType;
9
- serialNo: string;
10
- iValue: number;
11
- vpvValue: number;
12
- ppvValue: number;
13
- csValue: number;
14
- errValue: number;
15
- h19Value: number;
16
- h20Value: number;
17
- h21Value: number;
18
- h22Value: number;
19
- h23Value: number;
20
- ilValue: number;
21
- mpptValue: number;
22
- loadValue: number;
23
- pValue: number;
24
- consumedAmphours: number;
25
- socValue: number;
26
- timeToGo: number;
27
- alarm: string;
28
- relay: string;
29
- arValue: number;
30
- bmvValue: number;
31
- h1Value: number;
32
- h2Value: number;
33
- h3Value: number;
34
- h4Value: number;
35
- h5Value: number;
36
- h6Value: number;
37
- h7Value: number;
38
- h8Value: number;
39
- h9Value: number;
40
- h10Value: number;
41
- h11Value: number;
42
- };
43
- export interface PaginatedItems<T> {
16
+ id?: number;
17
+ voltage?: number;
18
+ datetime?: DateType;
19
+ serialNo?: string;
20
+ iValue?: number;
21
+ vpvValue?: number;
22
+ ppvValue?: number;
23
+ csValue?: number;
24
+ errValue?: number;
25
+ h19Value?: number;
26
+ h20Value?: number;
27
+ h21Value?: number;
28
+ h22Value?: number;
29
+ h23Value?: number;
30
+ ilValue?: number;
31
+ mpptValue?: number;
32
+ loadValue?: number;
33
+ pValue?: number;
34
+ consumedAmphours?: number;
35
+ socValue?: number;
36
+ timeToGo?: number;
37
+ alarm?: string;
38
+ relay?: string;
39
+ arValue?: number;
40
+ bmvValue?: number;
41
+ h1Value?: number;
42
+ h2Value?: number;
43
+ h3Value?: number;
44
+ h4Value?: number;
45
+ h5Value?: number;
46
+ h6Value?: number;
47
+ h7Value?: number;
48
+ h8Value?: number;
49
+ h9Value?: number;
50
+ h10Value?: number;
51
+ h11Value?: number;
52
+ };
53
+ export type BatteryReadingRequestPayload = {
54
+ fromDate: string;
55
+ toDate: string;
56
+ sort?: string;
57
+ page?: number;
58
+ limit?: number;
59
+ };
60
+ export type PaginatedItems<T> = {
44
61
  from: number;
45
62
  items: Array<T>;
46
63
  limit: number;
47
64
  page: number;
48
65
  to: number;
49
66
  total: number;
50
- }
67
+ };
51
68
  export declare enum UnitSystem {
52
69
  Imperial = "imperial",
53
70
  Metric = "metric"
54
71
  }
55
72
  export type Timestamp = string | number;
56
- export type Schedule = {
73
+ export type ScheduleUppercase = {
57
74
  Friday: string[];
58
75
  Monday: string[];
59
76
  Saturday: string[];
@@ -71,6 +88,7 @@ export type ScheduleLowercase = {
71
88
  tuesday: string[];
72
89
  wednesday: string[];
73
90
  };
91
+ export type Schedule = ScheduleUppercase | ScheduleLowercase;
74
92
  export type PaginationParams = {
75
93
  sort?: SortingUrlParam;
76
94
  page?: number;
@@ -90,11 +108,6 @@ export declare enum _3dViewer {
90
108
  Itwin = "itwin",
91
109
  Cesium = "cesium"
92
110
  }
93
- export declare enum SsoProvider {
94
- Microsoft = "microsoft",
95
- Google = "google",
96
- Evercam = "evercam"
97
- }
98
111
  export declare enum InfoPage {
99
112
  ThreeSixtyView = "360",
100
113
  BIMView = "bim",
@@ -105,7 +118,7 @@ export declare enum InfoPage {
105
118
  Timeline = "timeline",
106
119
  WeatherReport = "weather-report"
107
120
  }
108
- export declare enum DownloadTypes {
121
+ export declare enum DownloadFileType {
109
122
  Jpeg = "jpeg",
110
123
  Pdf = "pdf",
111
124
  Csv = "csv"
@@ -113,11 +126,11 @@ export declare enum DownloadTypes {
113
126
  export declare enum FeedbackContext {
114
127
  CopilotMessage = "copilot_message"
115
128
  }
116
- export type FeedbackPayload<T> = {
129
+ export type FeedbackPayload = {
117
130
  id?: number;
118
131
  user: string;
119
132
  text: string;
120
- type: T;
133
+ type: string;
121
134
  context: FeedbackContext;
122
135
  messageId?: number;
123
136
  conversationId?: number;
@@ -131,18 +144,33 @@ export interface JSON {
131
144
  stringify<T>(value: T, replacer?: (key: string, value: unknown) => unknown, space?: string | number): string & Stringified<T>;
132
145
  parse<T>(text: Stringified<T>, reviver?: (key: unknown, value: unknown) => unknown): T;
133
146
  }
147
+ export type TuplePoint2D = [number, number];
148
+ export type TuplePoint3D = [number, number, number];
149
+ export type Point2D = {
150
+ x: number;
151
+ y: number;
152
+ };
153
+ export type Point3D = {
154
+ x: number;
155
+ y: number;
156
+ z: number;
157
+ };
158
+ export type GeoPoint = {
159
+ lat: number;
160
+ lng: number;
161
+ };
134
162
  export type Exid = string;
135
163
  export type EntityByExid<Entity extends unknown> = Record<Exid, Entity>;
136
164
  export type BatteryVoltage = {
137
165
  date: DateType;
138
- max_value: number;
139
- min_value: number;
166
+ maxValue: number;
167
+ minValue: number;
140
168
  };
141
169
  export type GlobalSearchQueryParams = PaginationParams & {
142
170
  resource: "projects" | "users" | "cameras" | "companies" | "sims" | "routers";
143
171
  term: string;
144
- email: string;
145
- featureFlag: string;
172
+ email?: string;
173
+ featureFlag?: string;
146
174
  };
147
175
  export type TimelineDateInterval = {
148
176
  fromDate: string;
@@ -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,14 +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;
87
- };
88
- export type SmsHistoryResponse = {
89
- singleSimSms: SmsHistory[];
86
+ deliveredAt: string;
90
87
  };
91
88
  export type Sms = {
92
89
  id: number;
@@ -98,8 +95,8 @@ export type Sms = {
98
95
  status: string;
99
96
  text: string;
100
97
  type: string;
101
- insertedAt: DateTime;
102
- deliveryDatetime: DateTime;
98
+ insertedAt: string;
99
+ deliveryDatetime: string;
103
100
  };
104
101
  export type SmsQueryParams = PaginationParams & {
105
102
  dateRange: string;