@evercam/api 1.0.0-abd430c3b → 1.0.0-abf5647b9

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 (49) hide show
  1. package/README.md +1 -0
  2. package/dist/api/api/3dFirebaseApi.d.ts +197 -15
  3. package/dist/api/api/adminApi.d.ts +16 -12
  4. package/dist/api/api/aiApi.d.ts +44 -4
  5. package/dist/api/api/evercamApi.d.ts +16 -7
  6. package/dist/api/api/evercamLabsApi.d.ts +5 -5
  7. package/dist/api/api/ingestApi.d.ts +8 -2
  8. package/dist/api/types/360.d.ts +171 -54
  9. package/dist/api/types/aiConfigs.d.ts +154 -0
  10. package/dist/api/types/analytics.d.ts +27 -11
  11. package/dist/api/types/anpr.d.ts +31 -2
  12. package/dist/api/types/auditLogs.d.ts +18 -0
  13. package/dist/api/types/axios.d.ts +7 -5
  14. package/dist/api/types/bim.d.ts +25 -0
  15. package/dist/api/types/camera.d.ts +11 -25
  16. package/dist/api/types/comments.d.ts +10 -7
  17. package/dist/api/types/connector.d.ts +1 -0
  18. package/dist/api/types/detections.d.ts +2 -10
  19. package/dist/api/types/drone.d.ts +95 -6
  20. package/dist/api/types/errors.d.ts +11 -0
  21. package/dist/api/types/gateReport.d.ts +7 -11
  22. package/dist/api/types/gateReportManagement.d.ts +175 -0
  23. package/dist/api/types/index.d.ts +4 -0
  24. package/dist/api/types/ingest.d.ts +3 -2
  25. package/dist/api/types/kit.d.ts +2 -1
  26. package/dist/api/types/map.d.ts +12 -0
  27. package/dist/api/types/media.d.ts +6 -1
  28. package/dist/api/types/planner.d.ts +55 -2
  29. package/dist/api/types/posthog.d.ts +20 -0
  30. package/dist/api/types/project.d.ts +2 -1
  31. package/dist/api/types/recording.d.ts +5 -9
  32. package/dist/api/types/roi.d.ts +4 -3
  33. package/dist/api/types/shared.d.ts +19 -0
  34. package/dist/api/types/siteAnalytics.d.ts +3 -3
  35. package/dist/api/types/siteAnalyticsManagement.d.ts +92 -0
  36. package/dist/api/types/siteView.d.ts +73 -0
  37. package/dist/api/types/snapshots.d.ts +13 -0
  38. package/dist/api/types/timelapse.d.ts +2 -6
  39. package/dist/api/types/user.d.ts +1 -1
  40. package/dist/api/utils.d.ts +0 -1
  41. package/dist/index.js +1464 -660
  42. package/dist/index.js.map +1 -1
  43. package/dist/index.umd.cjs +1 -1
  44. package/dist/index.umd.cjs.map +1 -1
  45. package/dist/shared/types/components.d.ts +35 -9
  46. package/dist/shared/types/customDataTableFilters.d.ts +10 -0
  47. package/dist/shared/types/imagePlayer.d.ts +8 -1
  48. package/dist/shared/types/index.d.ts +1 -0
  49. package/package.json +4 -2
@@ -16,6 +16,26 @@ export declare enum ActiveUsersMetric {
16
16
  WAU = "wau",
17
17
  MAU = "mau"
18
18
  }
19
+ export type PosthogUser = {
20
+ id: string;
21
+ email: string;
22
+ isWeeklyActiveUser: number;
23
+ isMonthlyActiveUser: number;
24
+ eventsCount: number;
25
+ };
26
+ export type PosthogUsersRequestParams = {
27
+ companyExid?: string;
28
+ projectExid?: string;
29
+ cameraExid?: string;
30
+ productsActivityOnly?: boolean;
31
+ afterId?: string;
32
+ size?: number;
33
+ };
34
+ export type PosthogUsersResponse = {
35
+ data: PosthogUser[];
36
+ hasMore: boolean;
37
+ size: number;
38
+ };
19
39
  export type PosthogUserParams = {
20
40
  firstname?: string;
21
41
  lastname?: string;
@@ -1,4 +1,4 @@
1
- import { AdminCamera, Camera, CameraExid, DateType, EntityByExid, Exid, PaginationParams } from "@evercam/api/types";
1
+ import { AdminCamera, Camera, CameraExid, DateType, EntityByExid, Exid, Operator, PaginationParams } from "@evercam/api/types";
2
2
  export type ProjectExid = Exid;
3
3
  export type ProjectsByExid = EntityByExid<Project>;
4
4
  export type Project = {
@@ -110,6 +110,7 @@ export type ProjectsQueryParams = PaginationParams & {
110
110
  status: ProjectStatus;
111
111
  cameras: string;
112
112
  featureFlags: Array<ProjectFeatureFlag>;
113
+ featureFlagsOperator?: Operator;
113
114
  archived: string;
114
115
  };
115
116
  export type ProjectCreateRequestPayload = {
@@ -5,18 +5,20 @@ export type Snapshot = {
5
5
  data: string;
6
6
  status?: string;
7
7
  };
8
- export type NearestSnapshotRequestPayload = {
8
+ export type SnapshotRequestPayload = {
9
9
  apiKey?: string;
10
10
  apiId?: string;
11
11
  token?: string;
12
12
  cancelToken?: object;
13
13
  includeImage?: boolean;
14
+ view?: boolean;
14
15
  };
15
16
  export type AvailableDaysRequestPayload = {
16
17
  cameraId: string;
17
18
  year: string;
18
19
  month: string;
19
20
  payload?: ApiCredentials;
21
+ cancelToken?: CancelToken;
20
22
  };
21
23
  export type AvailableDaysResponsePayload = {
22
24
  days: Array<number>;
@@ -104,13 +106,6 @@ export declare enum SnapshotExtractionInterval {
104
106
  }
105
107
  export declare enum VpnServer {
106
108
  None = "None",
107
- OpenVPN1 = "OpenVPN1",
108
- OpenVPN2 = "OpenVPN2",
109
- OpenVPN3 = "OpenVPN3",
110
- OpenVPN4 = "OpenVPN4",
111
- OpenVPN5 = "OpenVPN5",
112
- PPTP1 = "PPTP1",
113
- PPTP2 = "PPTP2",
114
109
  WireGuard1 = "WireGuard1",
115
110
  WireGuard2 = "WireGuard2",
116
111
  WireGuard3 = "WireGuard3",
@@ -120,5 +115,6 @@ export declare enum VpnServer {
120
115
  WireGuard7 = "WireGuard7",
121
116
  WireGuard8 = "WireGuard8",
122
117
  WireGuard9 = "WireGuard9",
123
- WireGuard10 = "WireGuard10"
118
+ WireGuard10 = "WireGuard10",
119
+ WgHub = "WgHub"
124
120
  }
@@ -3,14 +3,14 @@ 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
15
  export type RoiShape = {
16
16
  id: number | null;
@@ -19,6 +19,7 @@ export type RoiShape = {
19
19
  x2: number;
20
20
  y1: number;
21
21
  y2: number;
22
+ points?: [number, number][];
22
23
  };
23
24
  export declare enum RoiDirection {
24
25
  Arrived = "arrived",
@@ -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}`;
@@ -133,6 +137,21 @@ export interface JSON {
133
137
  stringify<T>(value: T, replacer?: (key: string, value: unknown) => unknown, space?: string | number): string & Stringified<T>;
134
138
  parse<T>(text: Stringified<T>, reviver?: (key: unknown, value: unknown) => unknown): T;
135
139
  }
140
+ export type TuplePoint2D = [number, number];
141
+ export type TuplePoint3D = [number, number, number];
142
+ export type Point2D = {
143
+ x: number;
144
+ y: number;
145
+ };
146
+ export type Point3D = {
147
+ x: number;
148
+ y: number;
149
+ z: number;
150
+ };
151
+ export type GeoPoint = {
152
+ lat: number;
153
+ lng: number;
154
+ };
136
155
  export type Exid = string;
137
156
  export type EntityByExid<Entity extends unknown> = Record<Exid, Entity>;
138
157
  export type BatteryVoltage = {
@@ -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 = {
@@ -241,7 +241,7 @@ export type SmartSearchRequestPayload = {
241
241
  fromDate?: string;
242
242
  toDate?: string;
243
243
  page?: number;
244
- pageSize?: number;
244
+ limit?: number;
245
245
  threshold?: number;
246
246
  };
247
247
  type SmartSearchResultItemBase = {
@@ -0,0 +1,92 @@
1
+ import { CameraExid, DateType, 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
+ insertedAt: DateType | null;
39
+ updatedAt: DateType | null;
40
+ coolify: SiteAnalyticsCoolifyStatus | null;
41
+ project: SiteAnalyticsProjectMeta | null;
42
+ camera: SiteAnalyticsCameraMeta | null;
43
+ lastTrackingAt: DateType | null;
44
+ };
45
+ export type CreateSiteAnalyticsAppPayload = {
46
+ projectExid: ProjectExid;
47
+ cameraExid: CameraExid;
48
+ coolifyServerUuid: string;
49
+ appVersion?: string;
50
+ modelId?: number | null;
51
+ startDate?: DateType | null;
52
+ endDate?: DateType | null;
53
+ startHour?: number;
54
+ endHour?: number;
55
+ source?: string;
56
+ override?: boolean;
57
+ timeIncreaseFrequency?: number;
58
+ };
59
+ export type UpdateSiteAnalyticsAppPayload = Partial<Omit<CreateSiteAnalyticsAppPayload, "projectExid" | "cameraExid" | "coolifyServerUuid">>;
60
+ export type ModelOption = {
61
+ modelId: number;
62
+ version: string;
63
+ };
64
+ export type SiteAnalyticsAppConfigFormValue = {
65
+ appVersion: string;
66
+ modelId: number | null;
67
+ startDate: string | null;
68
+ endDate: string | null;
69
+ startHour: number;
70
+ endHour: number;
71
+ source: string;
72
+ override: boolean;
73
+ timeIncreaseFrequency: number;
74
+ };
75
+ export type SiteAnalyticsManagementListParams = {
76
+ projectExid?: ProjectExid;
77
+ includeStatus?: boolean;
78
+ page?: number;
79
+ limit?: number;
80
+ };
81
+ export type CreateSiteAnalyticsAppResponse = {
82
+ created: boolean;
83
+ id: number | null;
84
+ data: SiteAnalyticsManagedApp | null;
85
+ count: number | null;
86
+ message: string;
87
+ };
88
+ export type DeleteSiteAnalyticsAppResponse = {
89
+ deleted: boolean;
90
+ count: number;
91
+ message: string;
92
+ };
@@ -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;
@@ -1,4 +1,4 @@
1
- import { DateType, Schedule } from "@evercam/api/types";
1
+ import { DateType, Point2D, Schedule } from "@evercam/api/types";
2
2
  export declare enum TimelapseStatus {
3
3
  Pending = 11,
4
4
  Completed = 5,
@@ -26,11 +26,7 @@ export type TimestampPositionCoordinates = {
26
26
  w: number;
27
27
  h: number;
28
28
  };
29
- export type BlurRegionPoint = {
30
- x: number;
31
- y: number;
32
- };
33
- export type BlurRegionCoordinates = BlurRegionPoint[];
29
+ export type BlurRegionCoordinates = Point2D[];
34
30
  export type TimelapseLogoOptions = {
35
31
  id?: number;
36
32
  x: 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;
@@ -338,6 +337,7 @@ export type ProjectUserWithRole = {
338
337
  name: string;
339
338
  exid: string;
340
339
  };
340
+ persona: Persona;
341
341
  permissions: string[];
342
342
  role: Role;
343
343
  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;