@evercam/api 1.0.0-df2365728 → 1.0.0-df4ccc18e

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 (97) hide show
  1. package/README.md +4 -0
  2. package/dist/api/api/3dFirebaseApi.d.ts +203 -10
  3. package/dist/api/api/adminApi.d.ts +145 -101
  4. package/dist/api/api/aiApi.d.ts +190 -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 +154 -103
  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 +127 -34
  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 -23
  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 +244 -0
  19. package/dist/api/types/analytics.d.ts +177 -51
  20. package/dist/api/types/anpr.d.ts +53 -13
  21. package/dist/api/types/auditLogs.d.ts +19 -2
  22. package/dist/api/types/authz.d.ts +132 -0
  23. package/dist/api/types/autodesk.d.ts +7 -7
  24. package/dist/api/types/automation.d.ts +114 -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 +133 -113
  28. package/dist/api/types/comments.d.ts +32 -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 +95 -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 +85 -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 +83 -3
  48. package/dist/api/types/oauth.d.ts +62 -0
  49. package/dist/api/types/observationEvents.d.ts +141 -0
  50. package/dist/api/types/observations.d.ts +84 -0
  51. package/dist/api/types/planner.d.ts +102 -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 -32
  55. package/dist/api/types/project.d.ts +149 -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 +127 -0
  67. package/dist/api/types/siteView.d.ts +78 -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 +121 -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/api/utils.d.ts +1 -0
  84. package/dist/index.js +2618 -1098
  85. package/dist/index.js.map +1 -1
  86. package/dist/index.umd.cjs +1 -1
  87. package/dist/index.umd.cjs.map +1 -1
  88. package/dist/shared/types/components.d.ts +237 -35
  89. package/dist/shared/types/customDataTableFilters.d.ts +10 -0
  90. package/dist/shared/types/imagePlayer.d.ts +10 -3
  91. package/dist/shared/types/index.d.ts +3 -0
  92. package/dist/shared/types/observations.d.ts +25 -0
  93. package/dist/shared/types/rbac.d.ts +67 -0
  94. package/dist/shared/types/timeline.d.ts +2 -1
  95. package/package.json +6 -4
  96. package/dist/api/types/storageServers.d.ts +0 -4
  97. package/dist/api/types/vendorModel.d.ts +0 -15
@@ -0,0 +1,141 @@
1
+ import type { VisionProvider } from "@evercam/api/types";
2
+ export declare enum ObservationEventStatus {
3
+ Detected = "detected",
4
+ Approved = "approved",
5
+ Disapproved = "disapproved",
6
+ Unsure = "unsure"
7
+ }
8
+ export interface ObservationEventStatusConfig {
9
+ bg: string;
10
+ fg: string;
11
+ border: string;
12
+ label: string;
13
+ }
14
+ export declare const OBSERVATION_EVENT_STATUS_CONFIGS: Record<ObservationEventStatus, ObservationEventStatusConfig>;
15
+ export interface SiteAnalyticsObservationEvent {
16
+ id: number;
17
+ sourceType?: ObservationSourceType;
18
+ sessionId?: string | null;
19
+ markerId?: string | null;
20
+ drawingId?: string | null;
21
+ drawingName?: string | null;
22
+ walkName?: string | null;
23
+ sightings?: Array<Record<string, unknown>> | null;
24
+ observationTypeId: number;
25
+ observationName: string | null;
26
+ observationCode: string | null;
27
+ cameraExid: string;
28
+ projectExid: string | null;
29
+ startTime: string;
30
+ endTime: string | null;
31
+ confidence: number | null;
32
+ status: ObservationEventStatus;
33
+ aiEvidence: string | null;
34
+ bbox: number[] | null;
35
+ model: string | null;
36
+ promptId: number | null;
37
+ observationMetadata: Record<string, unknown> | null;
38
+ trigger: ObservationEventTrigger | string;
39
+ reviewedBy: string | null;
40
+ reviewedAt: string | null;
41
+ insertedAt: string;
42
+ }
43
+ export type ObservationEventQueryParams = {
44
+ cameraExid?: string;
45
+ projectExid?: string;
46
+ observationTypeIds?: string;
47
+ status?: ObservationEventStatus | string;
48
+ sourceType?: ObservationSourceType | string;
49
+ modelName?: string;
50
+ sortBy?: string;
51
+ sortDir?: "asc" | "desc";
52
+ page?: number;
53
+ limit?: number;
54
+ };
55
+ export interface ObservationModelOption {
56
+ modelName: string;
57
+ total: number;
58
+ }
59
+ export interface ObservationEventListResponse {
60
+ items: SiteAnalyticsObservationEvent[];
61
+ total: number;
62
+ page: number;
63
+ limit: number;
64
+ from: number;
65
+ to: number;
66
+ }
67
+ export type ObservationEventVerdict = ObservationEventStatus.Approved | ObservationEventStatus.Disapproved | ObservationEventStatus.Unsure;
68
+ export interface ObservationEventReviewPayload {
69
+ status: ObservationEventVerdict;
70
+ }
71
+ export interface ObservationEventReviewResponse {
72
+ updated: boolean;
73
+ id: number | string;
74
+ message: string;
75
+ }
76
+ export declare enum ObservationSourceType {
77
+ Camera = "camera",
78
+ Walk360 = "walk360",
79
+ Drone = "drone"
80
+ }
81
+ export declare enum ObservationEventTrigger {
82
+ CameraDetection = "camera_detection",
83
+ Walk = "walk"
84
+ }
85
+ export declare enum Walk360ProcessedSessionStatus {
86
+ Done = "done",
87
+ Processing = "processing",
88
+ Retryable = "retryable",
89
+ Error = "error"
90
+ }
91
+ export interface Walk360Activity {
92
+ observationTypeId: number;
93
+ }
94
+ export interface Walk360WorkerInfo {
95
+ coolifyAppId?: string | null;
96
+ workerStatus?: string | null;
97
+ workerIsRunning?: boolean;
98
+ appUrl?: string | null;
99
+ visionProvider?: VisionProvider;
100
+ }
101
+ export interface Walk360Config extends Walk360WorkerInfo {
102
+ projectExid: string;
103
+ enabled: boolean;
104
+ startDate: string | null;
105
+ activities: Walk360Activity[];
106
+ configured: boolean;
107
+ maxParallelWalks?: number;
108
+ }
109
+ export interface Walk360ConfigSummary extends Walk360WorkerInfo {
110
+ projectExid: string;
111
+ projectName?: string | null;
112
+ enabled: boolean;
113
+ startDate: string | null;
114
+ activities: Walk360Activity[];
115
+ maxParallelWalks: number;
116
+ walksDone: number;
117
+ walksProcessing: number;
118
+ walksRetryable: number;
119
+ eventsCreated: number;
120
+ lastProcessedAt: string | null;
121
+ updatedAt: string | null;
122
+ }
123
+ export interface Walk360WorkerAction {
124
+ projectExid: string;
125
+ appUuid: string | null;
126
+ message: string;
127
+ state: string;
128
+ }
129
+ export interface Walk360ProcessedSession {
130
+ id: number;
131
+ projectExid: string;
132
+ sourceType: ObservationSourceType;
133
+ sessionId: string;
134
+ status: Walk360ProcessedSessionStatus;
135
+ markersTotal: number | null;
136
+ markersProcessed: number | null;
137
+ eventsCreated: number | null;
138
+ error: string | null;
139
+ startedAt: string;
140
+ finishedAt: string | null;
141
+ }
@@ -0,0 +1,84 @@
1
+ import { type ProjectExid, type CameraExid, type DateType, type BBox, AiObservationFeasibilityStatus, ObservationEventStatus, DownloadFileType } from "@evercam/api/types";
2
+ export type ObservationApproval = boolean | ObservationEventStatus.Unsure | null;
3
+ export type ObservationEvent = {
4
+ id: number;
5
+ observationTypeId: number;
6
+ observationCode: string | null;
7
+ cameraExid: CameraExid;
8
+ projectExid: ProjectExid | null;
9
+ capturedAt: DateType;
10
+ endTime: DateType | null;
11
+ confidence: number | null;
12
+ status: ObservationEventStatus;
13
+ isApproved: ObservationApproval;
14
+ reason: string | null;
15
+ personBbox: BBox | null;
16
+ modelVersion: string | null;
17
+ observationMetadata: Record<string, unknown> | null;
18
+ trigger: string;
19
+ reviewedBy: string | null;
20
+ reviewedAt: DateType | null;
21
+ };
22
+ export type ObservationType = {
23
+ id: number;
24
+ observationCode: string;
25
+ name: string;
26
+ description: string | null;
27
+ type: string;
28
+ severity: number | null;
29
+ feasibilityStatus: AiObservationFeasibilityStatus;
30
+ };
31
+ export declare enum ObservationMissingItem {
32
+ Helmet = "helmet",
33
+ HighVisVest = "high_vis_vest",
34
+ Gloves = "gloves",
35
+ Glasses = "glasses"
36
+ }
37
+ export type ObservationEventsQueryParams = {
38
+ cameraExid?: CameraExid;
39
+ observationCode?: string;
40
+ fromDate?: string;
41
+ toDate?: string;
42
+ missingItems?: string;
43
+ status?: ObservationEventStatus;
44
+ sort?: string;
45
+ page?: number;
46
+ limit?: number;
47
+ };
48
+ export type ObservationEventsExportQueryParams = {
49
+ cameraExid?: CameraExid;
50
+ fromDate: string;
51
+ toDate: string;
52
+ required?: string;
53
+ compliant?: boolean;
54
+ fileType: DownloadFileType;
55
+ directDownload?: boolean;
56
+ includeInvalid?: boolean;
57
+ };
58
+ export type ObservationApprovalUpdateResponse = {
59
+ updated: boolean;
60
+ id: number | string | null;
61
+ message: string;
62
+ };
63
+ export declare enum ObservationCountsGranularity {
64
+ Day = "day",
65
+ Week = "week",
66
+ Month = "month"
67
+ }
68
+ export type ObservationEventsCountsQueryParams = {
69
+ cameraExid?: CameraExid;
70
+ observationCode?: string;
71
+ fromDate?: string;
72
+ toDate?: string;
73
+ missingItems?: string;
74
+ status?: ObservationEventStatus;
75
+ granularity?: ObservationCountsGranularity;
76
+ };
77
+ export type ObservationEventCount = {
78
+ bucket: DateType;
79
+ total: number;
80
+ };
81
+ export declare enum ObservationRequiredItem {
82
+ Helmet = "has_helmet",
83
+ HighVisVest = "has_high_vis_vest"
84
+ }
@@ -1,6 +1,40 @@
1
+ import { GeoPoint, TuplePoint2D } from "./shared";
2
+ import { MapType } from "./map";
3
+ export type PlannerListItem = {
4
+ id: string;
5
+ projectId: string;
6
+ projectName: string;
7
+ projectLocation: string;
8
+ createdDate: string;
9
+ updatedDate: string;
10
+ owner?: string;
11
+ lastUpdatedBy?: string;
12
+ camerasCount?: number;
13
+ hasPlan?: boolean;
14
+ thumbnailUrl?: string;
15
+ projectMapType?: MapType;
16
+ sessionId?: string;
17
+ };
18
+ export type PolygonPath = TuplePoint2D[];
19
+ export type PolygonCoordinates = PolygonPath[];
20
+ export interface GeoJSONPolygon {
21
+ type: "Polygon";
22
+ coordinates: PolygonCoordinates;
23
+ }
24
+ export declare enum PlannerUrlParams {
25
+ SitePlanId = "site_plan_id",
26
+ IsNewSitePlan = "is_new_site_plan",
27
+ IsBoundsMode = "is_bounds_mode",
28
+ ProjectPosition = "project_position",
29
+ DealId = "deal_id"
30
+ }
1
31
  export declare enum EDistortImageModes {
32
+ Edit = "edit",
2
33
  FreeRotate = "freeRotate",
3
- Lock = "lock"
34
+ Lock = "lock",
35
+ Rotate = "rotate",
36
+ Scale = "scale",
37
+ Pan = "drag"
4
38
  }
5
39
  export declare enum EMapTypes {
6
40
  Blank = "Blank",
@@ -18,15 +52,74 @@ export declare enum EPageType {
18
52
  List = "list",
19
53
  Item = "item"
20
54
  }
21
- export declare enum EPaths {
22
- Home = "/",
23
- Session = "/session"
24
- }
25
- export declare enum EProjectItems {
26
- Camera = "camera",
27
- Overlay = "overlay"
28
- }
29
55
  export declare enum ERoles {
30
56
  Admin = "admin",
31
57
  User = "user"
32
58
  }
59
+ export type PlannerOverlay = {
60
+ imageUrl?: string;
61
+ corners?: {
62
+ topLeft: GeoPoint;
63
+ topRight: GeoPoint;
64
+ bottomLeft: GeoPoint;
65
+ bottomRight: GeoPoint;
66
+ } | null;
67
+ };
68
+ export type PlannerCameraMarker = {
69
+ name?: string;
70
+ location?: GeoPoint;
71
+ heading?: number;
72
+ fovAngle?: number;
73
+ fovRadius?: number;
74
+ isVisible?: boolean;
75
+ color?: string;
76
+ };
77
+ export type SitePlanBounds = {
78
+ northEast: GeoPoint;
79
+ southWest: GeoPoint;
80
+ };
81
+ export type SitePlan = {
82
+ id?: string;
83
+ projectId?: string;
84
+ owner?: string;
85
+ lastUpdatedBy?: string;
86
+ projectName?: string;
87
+ projectLocation?: string;
88
+ projectMapType?: EMapTypes;
89
+ projectBounds?: SitePlanBounds;
90
+ overlay?: PlannerOverlay;
91
+ markers?: PlannerCameraMarker[];
92
+ thumbnailUrl?: string;
93
+ createdDate?: string;
94
+ updatedDate?: string;
95
+ };
96
+ export interface IDrawControl {
97
+ _toolbars: {
98
+ draw: {
99
+ _activeMode: {
100
+ handler: {
101
+ disable(): void;
102
+ completeShape(): void;
103
+ };
104
+ };
105
+ _modes: {
106
+ polygon: {
107
+ handler: {
108
+ enable(): void;
109
+ };
110
+ };
111
+ };
112
+ };
113
+ edit: {
114
+ _modes: {
115
+ edit: {
116
+ handler: {
117
+ enable(): void;
118
+ disable(): void;
119
+ save(): void;
120
+ };
121
+ };
122
+ };
123
+ };
124
+ };
125
+ }
@@ -16,3 +16,38 @@ 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
+ };
39
+ export type PosthogUserParams = {
40
+ firstname?: string;
41
+ lastname?: string;
42
+ email: string;
43
+ telephone?: string;
44
+ country?: string;
45
+ isAdmin?: boolean;
46
+ persona?: string;
47
+ companyExid: string;
48
+ companyName: string;
49
+ isImpersonationLogin: boolean;
50
+ ImpersonatedUserEmail?: string;
51
+ ImpersonatedUserFirstname?: string;
52
+ impersonatedUserLastname?: string;
53
+ };
@@ -44,7 +44,7 @@ export type ProcoreObservationSpecificationSection = {
44
44
  label: string;
45
45
  currentRevisionId: number;
46
46
  };
47
- export type ProcoreUserProjectsResponsePayload = Array<{
47
+ export type ProcoreUserProject = {
48
48
  accountingProjectNumber?: number;
49
49
  active: boolean;
50
50
  address: string;
@@ -85,7 +85,8 @@ export type ProcoreUserProjectsResponsePayload = Array<{
85
85
  totalValue: string;
86
86
  updatedAt: string;
87
87
  zip: number;
88
- }>;
88
+ };
89
+ export type ProcoreUserProjectsResponsePayload = Array<ProcoreUserProject>;
89
90
  export type ProcoreToolUserAccessLevel = {
90
91
  id: ProcoreToolUserAccessLevelIds;
91
92
  name: string;
@@ -120,7 +121,7 @@ export type ProcoreEditedImageUploadRequestPayload = {
120
121
  snapshot: string;
121
122
  categoryId?: number;
122
123
  };
123
- export type ProcoreProjectsAlbumsPayload = Array<{
124
+ export type ProcoreProjectAlbum = {
124
125
  count: number;
125
126
  coverPhoto: string | null;
126
127
  createdAt: string;
@@ -134,8 +135,9 @@ export type ProcoreProjectsAlbumsPayload = Array<{
134
135
  position: number;
135
136
  private: boolean;
136
137
  updatedAt: string;
137
- }>;
138
- export type ProcoreObservationTypesResponsePayload = Array<{
138
+ };
139
+ export type ProcoreProjectsAlbumsPayload = Array<ProcoreProjectAlbum>;
140
+ export type ProcoreObservationType = {
139
141
  id: number;
140
142
  name: string;
141
143
  localizedName: string;
@@ -147,12 +149,17 @@ export type ProcoreObservationTypesResponsePayload = Array<{
147
149
  parentInactive: boolean;
148
150
  isUse: boolean;
149
151
  nameTranslations: string;
150
- }>;
152
+ };
153
+ export type ProcoreObservationTypesResponsePayload = Array<ProcoreObservationType>;
151
154
  export type ProcoreObservationFormRequestPayload = {
152
155
  projectId: number;
153
156
  companyId: number;
154
157
  observationType: string;
155
158
  };
159
+ export type ProcoreCustomFieldOptionsRequestPayload = {
160
+ optionsUrl: string;
161
+ companyId: number;
162
+ };
156
163
  export type ProcoreObservationForm = Record<string, ProcoreObservationField | ProcoreObservationCustomField>;
157
164
  export type ProcoreObservationField = {
158
165
  name: string;
@@ -1,34 +1,4 @@
1
- import { AutomationType, DateTime, DateType, PaginationParams } from "@/types";
2
- export type Automation = {
3
- name?: string;
4
- cameraIds: string;
5
- cameraNames: number;
6
- cameraExids?: string[];
7
- createdAt: string;
8
- id: number;
9
- provider: string;
10
- type: AutomationType;
11
- config: Partial<{
12
- recipients: string | Record<string, string>[];
13
- companyId: number;
14
- compareDelay: number;
15
- categoryId: string;
16
- hubId: string;
17
- folderId: string;
18
- projectId: number;
19
- }>;
20
- isPaused: boolean;
21
- notifyDays: string | string[];
22
- notifyTime: string;
23
- requesterEmail: string;
24
- requesterName: string;
25
- timezone: string;
26
- title: string;
27
- compareDelay?: number;
28
- selectedProvider?: string;
29
- restrictedCameraExids?: string[];
30
- recipients?: string | string[];
31
- };
1
+ import { Automation, AutomationType, DateType, PaginationParams } from "@evercam/api/types";
32
2
  export type ProgressPhotosCreateUpdateRequestPayload = {
33
3
  cameraExids?: string;
34
4
  notifyDays?: string;
@@ -38,6 +8,7 @@ export type ProgressPhotosCreateUpdateRequestPayload = {
38
8
  type?: string;
39
9
  config?: {
40
10
  compareDelay?: AutomationType;
11
+ period?: number;
41
12
  recipients?: string;
42
13
  projectId?: number;
43
14
  companyId?: number;
@@ -54,6 +25,9 @@ export type ProgressPhotosUnSubscribeParams = {
54
25
  export type ProgressPhotosResponsePayload = {
55
26
  progressPhotos: Automation[];
56
27
  };
28
+ export type ProgressPhotoItemResponsePayload = {
29
+ progressPhotos: Automation;
30
+ };
57
31
  export declare enum AutomationDialogType {
58
32
  Create = "create",
59
33
  Edit = "edit",
@@ -100,5 +74,5 @@ export type ProgressPhotosHistory = {
100
74
  cameraIds: string;
101
75
  failedCameraIds: string;
102
76
  subject: string;
103
- recipients: DateTime;
77
+ recipients: string;
104
78
  };