@evercam/api 1.0.0-57d7783ef → 1.0.0-5841dedff

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 (51) hide show
  1. package/dist/api/api/3dFirebaseApi.d.ts +6 -0
  2. package/dist/api/api/adminApi.d.ts +2 -1
  3. package/dist/api/api/aiApi.d.ts +48 -2
  4. package/dist/api/api/authzApi.d.ts +4 -1
  5. package/dist/api/api/evercamApi.d.ts +16 -5
  6. package/dist/api/api/ingestApi.d.ts +4 -2
  7. package/dist/api/types/360.d.ts +28 -31
  8. package/dist/api/types/aiConfigs.d.ts +99 -11
  9. package/dist/api/types/analytics.d.ts +6 -0
  10. package/dist/api/types/authz.d.ts +46 -0
  11. package/dist/api/types/automation.d.ts +23 -4
  12. package/dist/api/types/axios.d.ts +1 -4
  13. package/dist/api/types/bim.d.ts +3 -5
  14. package/dist/api/types/camera.d.ts +2 -7
  15. package/dist/api/types/connector.d.ts +1 -0
  16. package/dist/api/types/copilot.d.ts +0 -3
  17. package/dist/api/types/detections.d.ts +1 -0
  18. package/dist/api/types/drone.d.ts +1 -1
  19. package/dist/api/types/errors.d.ts +2 -1
  20. package/dist/api/types/gateReport.d.ts +0 -11
  21. package/dist/api/types/gateReportManagement.d.ts +2 -7
  22. package/dist/api/types/hammertech.d.ts +98 -0
  23. package/dist/api/types/index.d.ts +4 -1
  24. package/dist/api/types/ingest.d.ts +2 -1
  25. package/dist/api/types/kit.d.ts +30 -49
  26. package/dist/api/types/media.d.ts +2 -1
  27. package/dist/api/types/notification.d.ts +12 -2
  28. package/dist/api/types/observationEvents.d.ts +61 -0
  29. package/dist/api/types/observations.d.ts +85 -0
  30. package/dist/api/types/planner.d.ts +0 -8
  31. package/dist/api/types/project.d.ts +7 -0
  32. package/dist/api/types/recording.d.ts +2 -4
  33. package/dist/api/types/ring.d.ts +16 -16
  34. package/dist/api/types/roi.d.ts +0 -9
  35. package/dist/api/types/routeParams.d.ts +1 -0
  36. package/dist/api/types/shared.d.ts +0 -19
  37. package/dist/api/types/shares.d.ts +0 -13
  38. package/dist/api/types/siteAnalytics.d.ts +1 -3
  39. package/dist/api/types/siteAnalyticsManagement.d.ts +29 -4
  40. package/dist/api/types/socket.d.ts +4 -0
  41. package/dist/api/types/storyblok.d.ts +0 -13
  42. package/dist/api/types/timelapse.d.ts +1 -8
  43. package/dist/index.js +912 -628
  44. package/dist/index.js.map +1 -1
  45. package/dist/index.umd.cjs +1 -1
  46. package/dist/index.umd.cjs.map +1 -1
  47. package/dist/shared/types/components.d.ts +64 -28
  48. package/dist/shared/types/index.d.ts +1 -0
  49. package/dist/shared/types/observations.d.ts +21 -0
  50. package/package.json +1 -1
  51. package/dist/api/types/vendorModel.d.ts +0 -15
@@ -1,8 +1,23 @@
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
+ };
1
13
  export type RingDevice = {
2
14
  deviceId: string;
3
15
  name: string;
4
- deviceType: string;
16
+ /** Resolved from Ring's `device-status`; null when Ring did not return it. */
17
+ online: boolean | null;
18
+ deviceType: string | null;
5
19
  firmwareVersion: string | null;
20
+ /** Always null — Ring's API does not expose device power level. */
6
21
  batteryLife: number | null;
7
22
  location: string | null;
8
23
  imported: boolean;
@@ -13,21 +28,6 @@ export type RingDevice = {
13
28
  export type RingDevicesResponsePayload = {
14
29
  devices: RingDevice[];
15
30
  };
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
31
  export type RingMoveDevicePayload = {
32
32
  projectExid: string;
33
33
  };
@@ -12,15 +12,6 @@ export declare enum RoiShapeType {
12
12
  Direction = "direction",
13
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
- points?: [number, number][];
23
- };
24
15
  export declare enum RoiDirection {
25
16
  Arrived = "arrived",
26
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;
@@ -128,15 +128,6 @@ export type FeedbackPayload = {
128
128
  messageId?: number;
129
129
  conversationId?: number;
130
130
  };
131
- export type Stringified<T> = string & {
132
- [P in keyof T]: {
133
- "_ value": T[P];
134
- };
135
- };
136
- export interface JSON {
137
- stringify<T>(value: T, replacer?: (key: string, value: unknown) => unknown, space?: string | number): string & Stringified<T>;
138
- parse<T>(text: Stringified<T>, reviver?: (key: unknown, value: unknown) => unknown): T;
139
- }
140
131
  export type TuplePoint2D = [number, number];
141
132
  export type TuplePoint3D = [number, number, number];
142
133
  export type Point2D = {
@@ -178,16 +169,6 @@ export declare enum TimelinePrecision {
178
169
  Minute = "minute",
179
170
  Events = "events"
180
171
  }
181
- export type EntityStatsQueryParams = {
182
- period: "day" | "week" | "month";
183
- startDate: string;
184
- endDate: string;
185
- };
186
- export type EntityStat = {
187
- period: string;
188
- name: string;
189
- count: number;
190
- };
191
172
  export declare enum TaskStatus {
192
173
  Idle = "idle",
193
174
  Loading = "loading",
@@ -33,14 +33,6 @@ export type SharedUsersResponsePayload = Array<{
33
33
  email: string;
34
34
  name: string;
35
35
  }>;
36
- export type ShareCreateRequestPayload = {
37
- email: string[] | string;
38
- message?: string;
39
- permission?: string;
40
- rights: string;
41
- apiId?: string;
42
- apiKey?: string;
43
- };
44
36
  export type ShareCreateResponsePayload = {
45
37
  shares: Share[];
46
38
  shareRequests: ShareRequest[];
@@ -51,8 +43,3 @@ export declare enum InviteStatus {
51
43
  Used = 1,
52
44
  Failed = -2
53
45
  }
54
- export declare enum ShareVisibility {
55
- PublicDiscoverable = "publicDiscoverable",
56
- PublicUndiscoverable = "publicUndiscoverable",
57
- Private = "private"
58
- }
@@ -232,7 +232,7 @@ export type SiteAnalyticsProcessingStatus = {
232
232
  feature: CameraFeatureFlag;
233
233
  processedIntervals: TimelineDateInterval[];
234
234
  };
235
- export type SmartSearchRequestPayload = {
235
+ export type SmartSearchRequestPayload = PaginationParams & {
236
236
  cameraExids?: CameraExid[];
237
237
  drawingIds?: _360FloorId[];
238
238
  walkIds?: string[];
@@ -240,8 +240,6 @@ export type SmartSearchRequestPayload = {
240
240
  payload: SmartSearchBackendQuery;
241
241
  fromDate?: string;
242
242
  toDate?: string;
243
- page?: number;
244
- limit?: number;
245
243
  threshold?: number;
246
244
  };
247
245
  type SmartSearchResultItemBase = {
@@ -1,4 +1,4 @@
1
- import { CameraExid, DateType, ProjectExid } from "@evercam/api/types";
1
+ import { CameraExid, DateType, PaginationParams, ProjectExid } from "@evercam/api/types";
2
2
  export type SiteAnalyticsCoolifyStatus = {
3
3
  appUuid: string | null;
4
4
  name: string | null;
@@ -35,6 +35,9 @@ export type SiteAnalyticsManagedApp = {
35
35
  source: string;
36
36
  override: boolean;
37
37
  timeIncreaseFrequency: number;
38
+ skipWeekends: boolean;
39
+ tracking: boolean;
40
+ observations: boolean;
38
41
  insertedAt: DateType | null;
39
42
  updatedAt: DateType | null;
40
43
  coolify: SiteAnalyticsCoolifyStatus | null;
@@ -54,7 +57,11 @@ export type CreateSiteAnalyticsAppPayload = {
54
57
  endHour?: number;
55
58
  source?: string;
56
59
  override?: boolean;
60
+ skipWeekends?: boolean;
57
61
  timeIncreaseFrequency?: number;
62
+ tracking?: boolean;
63
+ observations?: boolean;
64
+ observationPromptId?: number | null;
58
65
  };
59
66
  export type UpdateSiteAnalyticsAppPayload = Partial<Omit<CreateSiteAnalyticsAppPayload, "projectExid" | "cameraExid" | "coolifyServerUuid">>;
60
67
  export type ModelOption = {
@@ -71,12 +78,11 @@ export type SiteAnalyticsAppConfigFormValue = {
71
78
  source: string;
72
79
  override: boolean;
73
80
  timeIncreaseFrequency: number;
81
+ skipWeekends: boolean;
74
82
  };
75
- export type SiteAnalyticsManagementListParams = {
83
+ export type SiteAnalyticsManagementListParams = PaginationParams & {
76
84
  projectExid?: ProjectExid;
77
85
  includeStatus?: boolean;
78
- page?: number;
79
- limit?: number;
80
86
  };
81
87
  export type CreateSiteAnalyticsAppResponse = {
82
88
  created: boolean;
@@ -90,3 +96,22 @@ export type DeleteSiteAnalyticsAppResponse = {
90
96
  count: number;
91
97
  message: string;
92
98
  };
99
+ export type ObservationConfigActivity = {
100
+ observationTypeId: number;
101
+ every: number | null;
102
+ };
103
+ export type ObservationConfig = {
104
+ id: number;
105
+ cameraExid: CameraExid;
106
+ projectExid: ProjectExid | null;
107
+ enabled: boolean;
108
+ activities: ObservationConfigActivity[];
109
+ createdBy: string | null;
110
+ insertedAt: DateType | null;
111
+ updatedAt: DateType | null;
112
+ };
113
+ export type UpsertObservationConfigPayload = {
114
+ projectExid?: ProjectExid;
115
+ enabled: boolean;
116
+ activities: ObservationConfigActivity[];
117
+ };
@@ -0,0 +1,4 @@
1
+ export type SocketAuthResponsePayload = {
2
+ wsToken: string;
3
+ expiresIn: number;
4
+ };
@@ -1,17 +1,4 @@
1
1
  import type { JsonObject, JsonValue } from "@evercam/api/types";
2
- export type StoryblokAsset = {
3
- id: number | null;
4
- alt: string | null;
5
- name: string;
6
- focus: string | null;
7
- title: string | null;
8
- filename: string;
9
- copyright: string | null;
10
- fieldtype: "asset";
11
- source?: string;
12
- metaData?: JsonObject;
13
- isExternalUrl?: boolean;
14
- };
15
2
  export type StoryblokStory<TContent extends JsonObject = JsonObject> = {
16
3
  id: number;
17
4
  uuid: string;
@@ -1,4 +1,4 @@
1
- import { DateType, Point2D, Schedule } from "@evercam/api/types";
1
+ import { Point2D, Schedule } from "@evercam/api/types";
2
2
  export declare enum TimelapseStatus {
3
3
  Pending = 11,
4
4
  Completed = 5,
@@ -54,13 +54,6 @@ export declare enum TimelapseType {
54
54
  Year = "year",
55
55
  FullProject = "full_project"
56
56
  }
57
- export type TimelapseFilterQueryParams = {
58
- from?: DateType;
59
- to?: DateType;
60
- period?: TimelapsePeriod;
61
- duration?: number;
62
- schedule?: Schedule;
63
- };
64
57
  export type TimelapseCreationRequestPayload = {
65
58
  title: string;
66
59
  duration: number;