@evercam/api 1.0.0-964e29308 → 1.0.0-98fee43f2

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 (64) hide show
  1. package/README.md +1 -0
  2. package/dist/api/api/3dFirebaseApi.d.ts +204 -15
  3. package/dist/api/api/adminApi.d.ts +20 -15
  4. package/dist/api/api/aiApi.d.ts +90 -4
  5. package/dist/api/api/authzApi.d.ts +5 -3
  6. package/dist/api/api/evercamApi.d.ts +32 -12
  7. package/dist/api/api/evercamLabsApi.d.ts +5 -5
  8. package/dist/api/api/ingestApi.d.ts +19 -5
  9. package/dist/api/types/360.d.ts +175 -76
  10. package/dist/api/types/aiConfigs.d.ts +242 -0
  11. package/dist/api/types/analytics.d.ts +34 -15
  12. package/dist/api/types/anpr.d.ts +31 -2
  13. package/dist/api/types/auditLogs.d.ts +18 -0
  14. package/dist/api/types/authz.d.ts +71 -0
  15. package/dist/api/types/automation.d.ts +23 -4
  16. package/dist/api/types/axios.d.ts +9 -9
  17. package/dist/api/types/bim.d.ts +28 -5
  18. package/dist/api/types/camera.d.ts +13 -32
  19. package/dist/api/types/comments.d.ts +10 -7
  20. package/dist/api/types/connector.d.ts +2 -0
  21. package/dist/api/types/copilot.d.ts +0 -3
  22. package/dist/api/types/detections.d.ts +3 -10
  23. package/dist/api/types/drone.d.ts +95 -6
  24. package/dist/api/types/errors.d.ts +13 -1
  25. package/dist/api/types/gateReport.d.ts +7 -22
  26. package/dist/api/types/gateReportManagement.d.ts +170 -0
  27. package/dist/api/types/hammertech.d.ts +98 -0
  28. package/dist/api/types/index.d.ts +8 -1
  29. package/dist/api/types/ingest.d.ts +98 -3
  30. package/dist/api/types/kit.d.ts +41 -51
  31. package/dist/api/types/map.d.ts +12 -0
  32. package/dist/api/types/media.d.ts +8 -2
  33. package/dist/api/types/notification.d.ts +41 -2
  34. package/dist/api/types/observationEvents.d.ts +61 -0
  35. package/dist/api/types/observations.d.ts +85 -0
  36. package/dist/api/types/planner.d.ts +55 -10
  37. package/dist/api/types/posthog.d.ts +20 -0
  38. package/dist/api/types/project.d.ts +11 -2
  39. package/dist/api/types/recording.d.ts +8 -13
  40. package/dist/api/types/ring.d.ts +16 -16
  41. package/dist/api/types/roi.d.ts +3 -11
  42. package/dist/api/types/routeParams.d.ts +1 -0
  43. package/dist/api/types/shared.d.ts +18 -18
  44. package/dist/api/types/shares.d.ts +0 -13
  45. package/dist/api/types/siteAnalytics.d.ts +3 -5
  46. package/dist/api/types/siteAnalyticsManagement.d.ts +117 -0
  47. package/dist/api/types/siteView.d.ts +73 -0
  48. package/dist/api/types/snapshots.d.ts +13 -0
  49. package/dist/api/types/socket.d.ts +4 -0
  50. package/dist/api/types/storyblok.d.ts +0 -13
  51. package/dist/api/types/timelapse.d.ts +4 -8
  52. package/dist/api/types/user.d.ts +1 -4
  53. package/dist/api/utils.d.ts +0 -1
  54. package/dist/index.js +1781 -673
  55. package/dist/index.js.map +1 -1
  56. package/dist/index.umd.cjs +1 -1
  57. package/dist/index.umd.cjs.map +1 -1
  58. package/dist/shared/types/components.d.ts +103 -38
  59. package/dist/shared/types/customDataTableFilters.d.ts +10 -0
  60. package/dist/shared/types/imagePlayer.d.ts +8 -1
  61. package/dist/shared/types/index.d.ts +2 -0
  62. package/dist/shared/types/observations.d.ts +21 -0
  63. package/package.json +4 -2
  64. package/dist/api/types/vendorModel.d.ts +0 -15
@@ -1,4 +1,8 @@
1
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}`;
@@ -124,15 +128,21 @@ export type FeedbackPayload = {
124
128
  messageId?: number;
125
129
  conversationId?: number;
126
130
  };
127
- export type Stringified<T> = string & {
128
- [P in keyof T]: {
129
- "_ value": T[P];
130
- };
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;
131
145
  };
132
- export interface JSON {
133
- stringify<T>(value: T, replacer?: (key: string, value: unknown) => unknown, space?: string | number): string & Stringified<T>;
134
- parse<T>(text: Stringified<T>, reviver?: (key: unknown, value: unknown) => unknown): T;
135
- }
136
146
  export type Exid = string;
137
147
  export type EntityByExid<Entity extends unknown> = Record<Exid, Entity>;
138
148
  export type BatteryVoltage = {
@@ -159,16 +169,6 @@ export declare enum TimelinePrecision {
159
169
  Minute = "minute",
160
170
  Events = "events"
161
171
  }
162
- export type EntityStatsQueryParams = {
163
- period: "day" | "week" | "month";
164
- startDate: string;
165
- endDate: string;
166
- };
167
- export type EntityStat = {
168
- period: string;
169
- name: string;
170
- count: number;
171
- };
172
172
  export declare enum TaskStatus {
173
173
  Idle = "idle",
174
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
- }
@@ -1,4 +1,4 @@
1
- import { BBox, BoundingBox, DateType, Schedule, ScheduleLowercase, CameraExid, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter, CameraFeatureFlag, TimelineDateInterval, Camera, AdminCamera, _360FloorV2, _360FloorId, PaginatedItems, DateRangeFilter } from "@evercam/api/types";
1
+ import { BBox, BoundingBox, DateType, Schedule, ScheduleLowercase, CameraExid, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter, CameraFeatureFlag, TimelineDateInterval, Camera, AdminCamera, _360FloorV2, _360FloorId, PaginatedItems, DateRangeFilter, TuplePoint2D } from "@evercam/api/types";
2
2
  import { DetectionLabel, DownloadFileType } from "@evercam/api/types";
3
3
  export declare enum SiteAnalyticsMode {
4
4
  Detections = "detections",
@@ -184,7 +184,7 @@ export type DetectionsExportRequestParams = DetectionsRequestParams & {
184
184
  directDownload?: boolean;
185
185
  };
186
186
  export type SmartSearchHeatmapPoint = {
187
- coordinates: [number, number];
187
+ coordinates: TuplePoint2D;
188
188
  detectionsCount: number;
189
189
  };
190
190
  export type SmartSearchHeatmapData = {
@@ -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
- pageSize?: number;
245
243
  threshold?: number;
246
244
  };
247
245
  type SmartSearchResultItemBase = {
@@ -0,0 +1,117 @@
1
+ import { CameraExid, DateType, PaginationParams, ProjectExid } from "@evercam/api/types";
2
+ export type SiteAnalyticsCoolifyStatus = {
3
+ appUuid: string | null;
4
+ name: string | null;
5
+ serverUuid: string | null;
6
+ serverName: string | null;
7
+ appUrl: string | null;
8
+ status: string | null;
9
+ isRunning: boolean;
10
+ updatedAt: string | null;
11
+ };
12
+ export type SiteAnalyticsProjectMeta = {
13
+ exid: ProjectExid;
14
+ name: string | null;
15
+ timezone: string | null;
16
+ featureFlags: string[] | null;
17
+ };
18
+ export type SiteAnalyticsCameraMeta = {
19
+ exid: CameraExid;
20
+ name: string | null;
21
+ status: string | null;
22
+ featureFlags: string[] | null;
23
+ };
24
+ export type SiteAnalyticsManagedApp = {
25
+ id: number;
26
+ projectExid: ProjectExid;
27
+ cameraExid: CameraExid;
28
+ coolifyAppId: string | null;
29
+ appVersion: string;
30
+ modelId: number | null;
31
+ startDate: DateType | null;
32
+ endDate: DateType | null;
33
+ startHour: number;
34
+ endHour: number;
35
+ source: string;
36
+ override: boolean;
37
+ timeIncreaseFrequency: number;
38
+ skipWeekends: boolean;
39
+ tracking: boolean;
40
+ observations: boolean;
41
+ insertedAt: DateType | null;
42
+ updatedAt: DateType | null;
43
+ coolify: SiteAnalyticsCoolifyStatus | null;
44
+ project: SiteAnalyticsProjectMeta | null;
45
+ camera: SiteAnalyticsCameraMeta | null;
46
+ lastTrackingAt: DateType | null;
47
+ };
48
+ export type CreateSiteAnalyticsAppPayload = {
49
+ projectExid: ProjectExid;
50
+ cameraExid: CameraExid;
51
+ coolifyServerUuid: string;
52
+ appVersion?: string;
53
+ modelId?: number | null;
54
+ startDate?: DateType | null;
55
+ endDate?: DateType | null;
56
+ startHour?: number;
57
+ endHour?: number;
58
+ source?: string;
59
+ override?: boolean;
60
+ skipWeekends?: boolean;
61
+ timeIncreaseFrequency?: number;
62
+ tracking?: boolean;
63
+ observations?: boolean;
64
+ observationPromptId?: number | null;
65
+ };
66
+ export type UpdateSiteAnalyticsAppPayload = Partial<Omit<CreateSiteAnalyticsAppPayload, "projectExid" | "cameraExid" | "coolifyServerUuid">>;
67
+ export type ModelOption = {
68
+ modelId: number;
69
+ version: string;
70
+ };
71
+ export type SiteAnalyticsAppConfigFormValue = {
72
+ appVersion: string;
73
+ modelId: number | null;
74
+ startDate: string | null;
75
+ endDate: string | null;
76
+ startHour: number;
77
+ endHour: number;
78
+ source: string;
79
+ override: boolean;
80
+ timeIncreaseFrequency: number;
81
+ skipWeekends: boolean;
82
+ };
83
+ export type SiteAnalyticsManagementListParams = PaginationParams & {
84
+ projectExid?: ProjectExid;
85
+ includeStatus?: boolean;
86
+ };
87
+ export type CreateSiteAnalyticsAppResponse = {
88
+ created: boolean;
89
+ id: number | null;
90
+ data: SiteAnalyticsManagedApp | null;
91
+ count: number | null;
92
+ message: string;
93
+ };
94
+ export type DeleteSiteAnalyticsAppResponse = {
95
+ deleted: boolean;
96
+ count: number;
97
+ message: string;
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,73 @@
1
+ import { ForgeView } from "@evercam/api/types/360";
2
+ import { Point2D, Point3D } from "@evercam/api/types/shared";
3
+ export declare enum SiteViewSoftwareType {
4
+ Revit = "Revit",
5
+ Navisworks = "Navisworks",
6
+ Drone = "Drone",
7
+ Synchro = "Synchro"
8
+ }
9
+ export declare enum SiteViewerType {
10
+ ITwin = "iTwin",
11
+ Cesium = "Cesium",
12
+ Forge = "Forge"
13
+ }
14
+ export type SiteViewCameraListItem = {
15
+ projectId: string;
16
+ projectName: string;
17
+ software: SiteViewSoftwareType;
18
+ type: SiteViewerType;
19
+ uniqueId: string;
20
+ integrationType?: string;
21
+ };
22
+ export type ForgeUrn = {
23
+ displayName: string;
24
+ urn: string;
25
+ isModelHostedByEvercamACC?: boolean;
26
+ };
27
+ export type ForgeAccAlignmentData = {
28
+ bbox: {
29
+ min: Point2D;
30
+ max: Point2D;
31
+ };
32
+ transform: number[];
33
+ };
34
+ export type TimelineItem = {
35
+ taskNumber: number;
36
+ taskID: string;
37
+ actualStartDate: string;
38
+ actualEndDate: string;
39
+ plannedStartDate: string;
40
+ plannedEndDate: string;
41
+ objectIDs: number[];
42
+ };
43
+ export type ForgeMarkerTransform = {
44
+ default: {
45
+ position: Point3D;
46
+ type: string;
47
+ };
48
+ };
49
+ export type ForgeMarker = {
50
+ name: string;
51
+ cameraExid: string;
52
+ transforms: ForgeMarkerTransform;
53
+ };
54
+ export type ForgeProjectData = {
55
+ urns?: ForgeUrn[];
56
+ accDrawingsAlignments?: Record<string, ForgeAccAlignmentData>;
57
+ timeline?: TimelineItem[];
58
+ savedView?: ForgeView;
59
+ markers?: ForgeMarker[];
60
+ };
61
+ export type ItwinModel = {
62
+ name: string;
63
+ iTwinId: string;
64
+ iModelId: string;
65
+ changeSetId?: string;
66
+ isIModel: boolean;
67
+ height?: number;
68
+ cesiumId?: number;
69
+ markerDistanceThreshold: number;
70
+ };
71
+ export type ItwinProjectData = {
72
+ models: ItwinModel[];
73
+ };
@@ -5,8 +5,11 @@ export type SnapshotExtractionQyeryParams = PaginationParams & {
5
5
  status: SnapshotExtractionStatus;
6
6
  };
7
7
  export declare enum SnapshotExtractionStatus {
8
+ Cancelling = "canceling",
9
+ Cancelled = "cancelled",
8
10
  Completed = "completed",
9
11
  Failed = "failed",
12
+ Pending = "pending",
10
13
  Processing = "processing"
11
14
  }
12
15
  export declare enum SnapshotExtractionType {
@@ -30,6 +33,8 @@ export type SnapshotExtraction = {
30
33
  injectTo_cr: Boolean;
31
34
  schedule: Schedule;
32
35
  created_at: DateType;
36
+ jpegCount?: number;
37
+ obanJobId?: number;
33
38
  };
34
39
  export type SnapshotTestPayload = {
35
40
  cameraExid?: CameraExid;
@@ -42,6 +47,14 @@ export type SnapshotTestResponse = {
42
47
  status: string;
43
48
  data: string;
44
49
  };
50
+ export type SnapshotEmailDeliveryRequestPayload = {
51
+ snapshot: string;
52
+ recipients?: string[];
53
+ message?: string;
54
+ };
55
+ export type SnapshotEmailDeliveryResponsePayload = {
56
+ warning?: string;
57
+ };
45
58
  export type DeleteSnapshotQueryParams = {
46
59
  fromDate: DateType;
47
60
  toDate: DateType;
@@ -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, 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,
@@ -16,7 +16,9 @@ export type TimelapseVideoOptions = {
16
16
  removeTimestamp: boolean;
17
17
  smoothTransition: boolean;
18
18
  evercamWatermark: boolean;
19
+ sectionBlur?: boolean;
19
20
  timestampPosition?: TimestampPositionCoordinates;
21
+ blurRegions?: BlurRegionCoordinates[];
20
22
  };
21
23
  export type TimestampPositionCoordinates = {
22
24
  x: number;
@@ -24,6 +26,7 @@ export type TimestampPositionCoordinates = {
24
26
  w: number;
25
27
  h: number;
26
28
  };
29
+ export type BlurRegionCoordinates = Point2D[];
27
30
  export type TimelapseLogoOptions = {
28
31
  id?: number;
29
32
  x: number;
@@ -51,13 +54,6 @@ export declare enum TimelapseType {
51
54
  Year = "year",
52
55
  FullProject = "full_project"
53
56
  }
54
- export type TimelapseFilterQueryParams = {
55
- from?: DateType;
56
- to?: DateType;
57
- period?: TimelapsePeriod;
58
- duration?: number;
59
- schedule?: Schedule;
60
- };
61
57
  export type TimelapseCreationRequestPayload = {
62
58
  title: string;
63
59
  duration: number;
@@ -176,7 +176,6 @@ export type SessionActivitiesListRequestPayload = {
176
176
  };
177
177
  export type SignupUserRequestPayload = {
178
178
  telephone: string;
179
- token: string;
180
179
  firstname: string;
181
180
  lastname: string;
182
181
  email: string;
@@ -194,9 +193,6 @@ export type UserUpdateRequestPayload = {
194
193
  country: string;
195
194
  persona: string;
196
195
  };
197
- export type UserDeleteRequestPayload = {
198
- verifEmail: string;
199
- };
200
196
  export type GoogleAuthRequestPayload = {
201
197
  code: string;
202
198
  redirectUri: string;
@@ -338,6 +334,7 @@ export type ProjectUserWithRole = {
338
334
  name: string;
339
335
  exid: string;
340
336
  };
337
+ persona: Persona;
341
338
  permissions: string[];
342
339
  role: Role;
343
340
  subRoles: RoleSubRole[];
@@ -7,4 +7,3 @@ export declare const toQueryString: <T extends Record<string, unknown>>(paramsOb
7
7
  forceArrayBrackets?: boolean | undefined;
8
8
  }) => string | undefined;
9
9
  export declare function queryStringToObject(queryString?: string): QueryParams;
10
- export declare function capitalizeFirstLetter(inputString: string): string;