@evercam/api 1.0.0-2c312017b → 1.0.0-2c3eef808

package/dist/api/types/planner.d.ts

@@ -1,3 +1,33 @@
+import { GeoPoint, TuplePoint2D } from "./shared";
+import { MapType } from "./map";
+export type PlannerListItem = {
+    id: string;
+    projectId: string;
+    projectName: string;
+    projectLocation: string;
+    createdDate: string;
+    updatedDate: string;
+    owner?: string;
+    lastUpdatedBy?: string;
+    camerasCount?: number;
+    hasPlan?: boolean;
+    thumbnailUrl?: string;
+    projectMapType?: MapType;
+    sessionId?: string;
+};
+export type PolygonPath = TuplePoint2D[];
+export type PolygonCoordinates = PolygonPath[];
+export interface GeoJSONPolygon {
+    type: "Polygon";
+    coordinates: PolygonCoordinates;
+}
+export declare enum PlannerUrlParams {
+    SitePlanId = "site_plan_id",
+    IsNewSitePlan = "is_new_site_plan",
+    IsBoundsMode = "is_bounds_mode",
+    ProjectPosition = "project_position",
+    DealId = "deal_id"
+}
 export declare enum EDistortImageModes {
     FreeRotate = "freeRotate",
     Lock = "lock",
@@ -33,3 +63,70 @@ export declare enum ERoles {
     Admin = "admin",
     User = "user"
 }
+export type PlannerOverlay = {
+    imageUrl?: string;
+    corners?: {
+        topLeft: GeoPoint;
+        topRight: GeoPoint;
+        bottomLeft: GeoPoint;
+        bottomRight: GeoPoint;
+    } | null;
+};
+export type PlannerCameraMarker = {
+    name?: string;
+    location?: GeoPoint;
+    heading?: number;
+    fovAngle?: number;
+    fovRadius?: number;
+    isVisible?: boolean;
+    color?: string;
+};
+export type SitePlanBounds = {
+    northEast: GeoPoint;
+    southWest: GeoPoint;
+};
+export type SitePlan = {
+    id?: string;
+    projectId?: string;
+    owner?: string;
+    lastUpdatedBy?: string;
+    projectName?: string;
+    projectLocation?: string;
+    projectMapType?: EMapTypes;
+    projectBounds?: SitePlanBounds;
+    overlay?: PlannerOverlay;
+    markers?: PlannerCameraMarker[];
+    thumbnailUrl?: string;
+    createdDate?: string;
+    updatedDate?: string;
+};
+export interface IDrawControl {
+    _toolbars: {
+        draw: {
+            _activeMode: {
+                handler: {
+                    disable(): void;
+                    completeShape(): void;
+                };
+            };
+            _modes: {
+                polygon: {
+                    handler: {
+                        enable(): void;
+                    };
+                };
+            };
+        };
+        edit: {
+            _modes: {
+                edit: {
+                    handler: {
+                        enable(): void;
+                        disable(): void;
+                        save(): void;
+                    };
+                };
+            };
+        };
+    };
+}

package/dist/api/types/posthog.d.ts

@@ -16,6 +16,26 @@ export declare enum ActiveUsersMetric {
     WAU = "wau",
     MAU = "mau"
 }
+export type PosthogUser = {
+    id: string;
+    email: string;
+    isWeeklyActiveUser: number;
+    isMonthlyActiveUser: number;
+    eventsCount: number;
+};
+export type PosthogUsersRequestParams = {
+    companyExid?: string;
+    projectExid?: string;
+    cameraExid?: string;
+    productsActivityOnly?: boolean;
+    afterId?: string;
+    size?: number;
+};
+export type PosthogUsersResponse = {
+    data: PosthogUser[];
+    hasMore: boolean;
+    size: number;
+};
 export type PosthogUserParams = {
     firstname?: string;
     lastname?: string;

package/dist/api/types/project.d.ts

@@ -1,4 +1,4 @@
-import { AdminCamera, Camera, CameraExid, DateType, EntityByExid, Exid, PaginationParams } from "@evercam/api/types";
+import { AdminCamera, Camera, CameraExid, DateType, EntityByExid, Exid, Operator, PaginationParams } from "@evercam/api/types";
 export type ProjectExid = Exid;
 export type ProjectsByExid = EntityByExid<Project>;
 export type Project = {
@@ -62,7 +62,8 @@ export declare enum ProjectArchiveTier {
     Full = "Full",
     Partial = "Partial",
     Minimal = "Minimal",
-    ScheduledForDeletion = "Scheduled for Deletion"
+    ScheduledForDeletion = "Scheduled for Deletion",
+    No = "No"
 }
 export type UpdateCameraRestrictionPayload = {
     isAccessRestricted?: boolean;
@@ -91,8 +92,7 @@ export declare enum ProjectFeatureFlag {
     DefaultToProjectApp = "default_to_project_app",
     SmartSearch = "smart_search",
     PpeMonitoring = "ppe_monitoring",
-    NoGdpr = "no_gdpr",
-    NoLiveView = "no_live_view"
+    NoGdpr = "no_gdpr"
 }
 export type ProjectBatteryReading = {
     exid: number;
@@ -110,6 +110,7 @@ export type ProjectsQueryParams = PaginationParams & {
     status: ProjectStatus;
     cameras: string;
     featureFlags: Array<ProjectFeatureFlag>;
+    featureFlagsOperator?: Operator;
     archived: string;
 };
 export type ProjectCreateRequestPayload = {
@@ -164,6 +165,7 @@ export type ProjectRole = {
 };
 export type ProjectMember = {
     id: string;
+    key?: string;
     email: string;
     fullname: string;
     lastSeenAt?: string;
@@ -173,7 +175,9 @@ export type ProjectMember = {
         resourceId: string;
         roleId: number;
     }>;
-    company?: string | null;
+    company?: {
+        name: string;
+    } | null;
 };
 export type ProjectInvite = {
     id?: string;
@@ -194,6 +198,7 @@ export type ProjectMembersResponsePayload = {
 export type ProjectMembersRequestPayload = {
     roleId: number;
     emails: string[];
+    message?: string;
     overrideRole?: Partial<{
         permissions?: string[];
         subRoles?: Array<{

package/dist/api/types/recording.d.ts

@@ -5,18 +5,20 @@ export type Snapshot = {
     data: string;
     status?: string;
 };
-export type NearestSnapshotRequestPayload = {
+export type SnapshotRequestPayload = {
     apiKey?: string;
     apiId?: string;
     token?: string;
     cancelToken?: object;
     includeImage?: boolean;
+    view?: boolean;
 };
 export type AvailableDaysRequestPayload = {
     cameraId: string;
     year: string;
     month: string;
     payload?: ApiCredentials;
+    cancelToken?: CancelToken;
 };
 export type AvailableDaysResponsePayload = {
     days: Array<number>;
@@ -76,6 +78,7 @@ export declare enum CloudRecordingDuration {
     Month = 30,
     ThreeMonths = 90
 }
+export declare const CloudRecordingDurationLabel: Record<CloudRecordingDuration, string>;
 export declare enum CloudRecordingStatus {
     On = "on",
     Off = "off",
@@ -103,13 +106,6 @@ export declare enum SnapshotExtractionInterval {
 }
 export declare enum VpnServer {
     None = "None",
-    OpenVPN1 = "OpenVPN1",
-    OpenVPN2 = "OpenVPN2",
-    OpenVPN3 = "OpenVPN3",
-    OpenVPN4 = "OpenVPN4",
-    OpenVPN5 = "OpenVPN5",
-    PPTP1 = "PPTP1",
-    PPTP2 = "PPTP2",
     WireGuard1 = "WireGuard1",
     WireGuard2 = "WireGuard2",
     WireGuard3 = "WireGuard3",
@@ -119,5 +115,6 @@ export declare enum VpnServer {
     WireGuard7 = "WireGuard7",
     WireGuard8 = "WireGuard8",
     WireGuard9 = "WireGuard9",
-    WireGuard10 = "WireGuard10"
+    WireGuard10 = "WireGuard10",
+    WgHub = "WgHub"
 }

package/dist/api/types/ring.d.ts

@@ -0,0 +1,53 @@
+export type RingDevice = {
+    deviceId: string;
+    name: string;
+    deviceType: string;
+    firmwareVersion: string | null;
+    batteryLife: number | null;
+    location: string | null;
+    imported: boolean;
+    cameraExid?: string;
+    projectExid?: string;
+    projectName?: string;
+};
+export type RingDevicesResponsePayload = {
+    devices: RingDevice[];
+};
+export type RingImportDevicesPayload = {
+    deviceIds: string[];
+    projectExid: string;
+    deviceNames?: Record<string, string>;
+};
+export type RingImportResponsePayload = {
+    cameras: Array<{
+        exid: string;
+        name: string;
+    }>;
+    project: {
+        exid: string;
+        name: string;
+    };
+};
+export type RingMoveDevicePayload = {
+    projectExid: string;
+};
+export type RingMoveDeviceResponsePayload = {
+    status: string;
+    cameraExid: string;
+    projectExid: string;
+};
+export type RingLiveViewPayload = {
+    sdpOffer: string;
+};
+export type RingLiveViewResponse = {
+    sdpAnswer: string;
+    sessionUrl: string;
+    iceServers: Array<{
+        urls: string;
+        username?: string;
+        credential?: string;
+    }>;
+};
+export type RingStopLiveViewResponse = {
+    status: string;
+};

package/dist/api/types/roi.d.ts

@@ -3,14 +3,14 @@ export declare enum RoiType {
     AnprContext = "anpr_context",
     ExclusionZone = "exclusion_zone",
     WorkflowArea = "workflow_area",
-    SiteAnalytics = "site_analytics"
+    SiteAnalytics = "site_analytics",
+    Ppe = "ppe_roi"
 }
 export declare enum RoiShapeType {
     Polygon = "polygon",
     Line = "line",
     Direction = "direction",
-    Rectangle = "rectangle",
-    ROIBox = "ROIBox"
+    Rectangle = "rectangle"
 }
 export type RoiShape = {
     id: number | null;
@@ -19,6 +19,7 @@ export type RoiShape = {
     x2: number;
     y1: number;
     y2: number;
+    points?: [number, number][];
 };
 export declare enum RoiDirection {
     Arrived = "arrived",

package/dist/api/types/shared.d.ts

@@ -1,4 +1,8 @@
 import { DateType } from "@evercam/api/types";
+export declare enum Operator {
+    AND = "and",
+    OR = "or"
+}
 type sortby = string;
 type sortDirection = "asc" | "desc";
 export type SortingUrlParam = `${sortby}|${sortDirection}`;
@@ -133,6 +137,21 @@ export interface JSON {
     stringify<T>(value: T, replacer?: (key: string, value: unknown) => unknown, space?: string | number): string & Stringified<T>;
     parse<T>(text: Stringified<T>, reviver?: (key: unknown, value: unknown) => unknown): T;
 }
+export type TuplePoint2D = [number, number];
+export type TuplePoint3D = [number, number, number];
+export type Point2D = {
+    x: number;
+    y: number;
+};
+export type Point3D = {
+    x: number;
+    y: number;
+    z: number;
+};
+export type GeoPoint = {
+    lat: number;
+    lng: number;
+};
 export type Exid = string;
 export type EntityByExid<Entity extends unknown> = Record<Exid, Entity>;
 export type BatteryVoltage = {

package/dist/api/types/siteAnalytics.d.ts

@@ -1,4 +1,4 @@
-import { BBox, BoundingBox, DateType, Schedule, ScheduleLowercase, CameraExid, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter, CameraFeatureFlag, TimelineDateInterval, Camera, AdminCamera, _360FloorV2, _360FloorId, PaginatedItems, DateRangeFilter } from "@evercam/api/types";
+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";
 import { DetectionLabel, DownloadFileType } from "@evercam/api/types";
 export declare enum SiteAnalyticsMode {
     Detections = "detections",
@@ -184,7 +184,7 @@ export type DetectionsExportRequestParams = DetectionsRequestParams & {
     directDownload?: boolean;
 };
 export type SmartSearchHeatmapPoint = {
-    coordinates: [number, number];
+    coordinates: TuplePoint2D;
     detectionsCount: number;
 };
 export type SmartSearchHeatmapData = {
@@ -241,7 +241,7 @@ export type SmartSearchRequestPayload = {
     fromDate?: string;
     toDate?: string;
     page?: number;
-    pageSize?: number;
+    limit?: number;
     threshold?: number;
 };
 type SmartSearchResultItemBase = {

package/dist/api/types/siteAnalyticsManagement.d.ts

@@ -0,0 +1,92 @@
+import { CameraExid, DateType, ProjectExid } from "@evercam/api/types";
+export type SiteAnalyticsCoolifyStatus = {
+    appUuid: string | null;
+    name: string | null;
+    serverUuid: string | null;
+    serverName: string | null;
+    appUrl: string | null;
+    status: string | null;
+    isRunning: boolean;
+    updatedAt: string | null;
+};
+export type SiteAnalyticsProjectMeta = {
+    exid: ProjectExid;
+    name: string | null;
+    timezone: string | null;
+    featureFlags: string[] | null;
+};
+export type SiteAnalyticsCameraMeta = {
+    exid: CameraExid;
+    name: string | null;
+    status: string | null;
+    featureFlags: string[] | null;
+};
+export type SiteAnalyticsManagedApp = {
+    id: number;
+    projectExid: ProjectExid;
+    cameraExid: CameraExid;
+    coolifyAppId: string | null;
+    appVersion: string;
+    modelId: number | null;
+    startDate: DateType | null;
+    endDate: DateType | null;
+    startHour: number;
+    endHour: number;
+    source: string;
+    override: boolean;
+    timeIncreaseFrequency: number;
+    insertedAt: DateType | null;
+    updatedAt: DateType | null;
+    coolify: SiteAnalyticsCoolifyStatus | null;
+    project: SiteAnalyticsProjectMeta | null;
+    camera: SiteAnalyticsCameraMeta | null;
+    lastTrackingAt: DateType | null;
+};
+export type CreateSiteAnalyticsAppPayload = {
+    projectExid: ProjectExid;
+    cameraExid: CameraExid;
+    coolifyServerUuid: string;
+    appVersion?: string;
+    modelId?: number | null;
+    startDate?: DateType | null;
+    endDate?: DateType | null;
+    startHour?: number;
+    endHour?: number;
+    source?: string;
+    override?: boolean;
+    timeIncreaseFrequency?: number;
+};
+export type UpdateSiteAnalyticsAppPayload = Partial<Omit<CreateSiteAnalyticsAppPayload, "projectExid" | "cameraExid" | "coolifyServerUuid">>;
+export type ModelOption = {
+    modelId: number;
+    version: string;
+};
+export type SiteAnalyticsAppConfigFormValue = {
+    appVersion: string;
+    modelId: number | null;
+    startDate: string | null;
+    endDate: string | null;
+    startHour: number;
+    endHour: number;
+    source: string;
+    override: boolean;
+    timeIncreaseFrequency: number;
+};
+export type SiteAnalyticsManagementListParams = {
+    projectExid?: ProjectExid;
+    includeStatus?: boolean;
+    page?: number;
+    limit?: number;
+};
+export type CreateSiteAnalyticsAppResponse = {
+    created: boolean;
+    id: number | null;
+    data: SiteAnalyticsManagedApp | null;
+    count: number | null;
+    message: string;
+};
+export type DeleteSiteAnalyticsAppResponse = {
+    deleted: boolean;
+    count: number;
+    message: string;
+};

package/dist/api/types/siteView.d.ts

@@ -0,0 +1,73 @@
+import { ForgeView } from "@evercam/api/types/360";
+import { Point2D, Point3D } from "@evercam/api/types/shared";
+export declare enum SiteViewSoftwareType {
+    Revit = "Revit",
+    Navisworks = "Navisworks",
+    Drone = "Drone",
+    Synchro = "Synchro"
+}
+export declare enum SiteViewerType {
+    ITwin = "iTwin",
+    Cesium = "Cesium",
+    Forge = "Forge"
+}
+export type SiteViewCameraListItem = {
+    projectId: string;
+    projectName: string;
+    software: SiteViewSoftwareType;
+    type: SiteViewerType;
+    uniqueId: string;
+    integrationType?: string;
+};
+export type ForgeUrn = {
+    displayName: string;
+    urn: string;
+    isModelHostedByEvercamACC?: boolean;
+};
+export type ForgeAccAlignmentData = {
+    bbox: {
+        min: Point2D;
+        max: Point2D;
+    };
+    transform: number[];
+};
+export type TimelineItem = {
+    taskNumber: number;
+    taskID: string;
+    actualStartDate: string;
+    actualEndDate: string;
+    plannedStartDate: string;
+    plannedEndDate: string;
+    objectIDs: number[];
+};
+export type ForgeMarkerTransform = {
+    default: {
+        position: Point3D;
+        type: string;
+    };
+};
+export type ForgeMarker = {
+    name: string;
+    cameraExid: string;
+    transforms: ForgeMarkerTransform;
+};
+export type ForgeProjectData = {
+    urns?: ForgeUrn[];
+    accDrawingsAlignments?: Record<string, ForgeAccAlignmentData>;
+    timeline?: TimelineItem[];
+    savedView?: ForgeView;
+    markers?: ForgeMarker[];
+};
+export type ItwinModel = {
+    name: string;
+    iTwinId: string;
+    iModelId: string;
+    changeSetId?: string;
+    isIModel: boolean;
+    height?: number;
+    cesiumId?: number;
+    markerDistanceThreshold: number;
+};
+export type ItwinProjectData = {
+    models: ItwinModel[];
+};

package/dist/api/types/snapshots.d.ts

@@ -5,8 +5,11 @@ export type SnapshotExtractionQyeryParams = PaginationParams & {
     status: SnapshotExtractionStatus;
 };
 export declare enum SnapshotExtractionStatus {
+    Cancelling = "canceling",
+    Cancelled = "cancelled",
     Completed = "completed",
     Failed = "failed",
+    Pending = "pending",
     Processing = "processing"
 }
 export declare enum SnapshotExtractionType {
@@ -30,6 +33,8 @@ export type SnapshotExtraction = {
     injectTo_cr: Boolean;
     schedule: Schedule;
     created_at: DateType;
+    jpegCount?: number;
+    obanJobId?: number;
 };
 export type SnapshotTestPayload = {
     cameraExid?: CameraExid;
@@ -42,18 +47,58 @@ export type SnapshotTestResponse = {
     status: string;
     data: string;
 };
+export type SnapshotEmailDeliveryRequestPayload = {
+    snapshot: string;
+    recipients?: string[];
+    message?: string;
+};
+export type SnapshotEmailDeliveryResponsePayload = {
+    warning?: string;
+};
 export type DeleteSnapshotQueryParams = {
     fromDate: DateType;
     toDate: DateType;
     adminEmail: string;
     adminFullname: string;
 };
-export type TransferCloudRecordingsQueryParams = {
+export type SnapshotTransfer = {
+    id: number;
+    sourceCamera: SnapshotTransferCamera;
+    targetCamera: SnapshotTransferCamera;
+    fromDate: DateType;
+    toDate: DateType;
+    overwriteExisting?: boolean | null;
+    deleteSource?: boolean | null;
+    requestor: SnapshotTransferRequestor;
+    status: SnapshotTransferStatus;
+    insertedAt: DateType;
+    attempts?: number | null;
+    errorMessage?: string | null;
+    snapshotsTransferred?: number | null;
+};
+export type SnapshotTransferCamera = {
+    id: number;
+    exid: CameraExid;
+    name: string;
+};
+export type SnapshotTransferRequestor = {
+    email: string;
+    firstname: string;
+    lastname: string;
+};
+export declare enum SnapshotTransferStatus {
+    Completed = "completed",
+    Failed = "failed",
+    Processing = "processing",
+    Pending = "pending",
+    Cancelled = "cancelled"
+}
+export type TransferCloudRecordingsQueryParams = PaginationParams & {
     targetCameraExid: CameraExid;
     fromDate: DateType;
     toDate: DateType;
-    overwriteExistingSnapshots?: boolean;
-    keepSourceSnapshots?: boolean;
+    overwriteExisting?: boolean;
+    deleteSource?: boolean;
     adminEmail?: string;
     adminFullname?: string;
 };

package/dist/api/types/storageProvider.d.ts

@@ -0,0 +1,19 @@
+import type { DateType } from "@evercam/api/types";
+export type StorageProvider = {
+    id?: number;
+    cameraId: number;
+    type: string;
+    provider: string;
+    url: string;
+    startDate: DateType;
+    endDate: DateType;
+    config: Record<string, any>;
+    insertedAt?: DateType;
+};
+export type StorageProvidersResponsePayload = {
+    providers: StorageProvider[];
+};
+export declare enum ProjectStorageProvider {
+    Seaweedfs = "seaweedfs",
+    S3 = "s3"
+}

package/dist/api/types/timelapse.d.ts

@@ -1,4 +1,4 @@
-import { DateType, Schedule } from "@evercam/api/types";
+import { DateType, Point2D, Schedule } from "@evercam/api/types";
 export declare enum TimelapseStatus {
     Pending = 11,
     Completed = 5,
@@ -7,7 +7,8 @@ export declare enum TimelapseStatus {
 export declare enum TimelapseDuration {
     ThirtySeconds = 30,
     SixtySeconds = 60,
-    NintySeconds = 90
+    NintySeconds = 90,
+    TwoMinutes = 120
 }
 export type TimelapseVideoOptions = {
     width?: number;
@@ -15,7 +16,9 @@ export type TimelapseVideoOptions = {
     removeTimestamp: boolean;
     smoothTransition: boolean;
     evercamWatermark: boolean;
+    sectionBlur?: boolean;
     timestampPosition?: TimestampPositionCoordinates;
+    blurRegions?: BlurRegionCoordinates[];
 };
 export type TimestampPositionCoordinates = {
     x: number;
@@ -23,6 +26,7 @@ export type TimestampPositionCoordinates = {
     w: number;
     h: number;
 };
+export type BlurRegionCoordinates = Point2D[];
 export type TimelapseLogoOptions = {
     id?: number;
     x: number;