@evercam/api 1.0.0-79849e0e7 → 1.0.0-7e7332709

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

@@ -2,3 +2,15 @@ export declare enum MapType {
     Hybrid = "hybrid",
     Terrain = "terrain"
 }
+export type MapView = {
+    east?: number;
+    floorID?: string;
+    image?: string;
+    mapStyle?: MapType;
+    name: string;
+    north?: number;
+    projectId: string;
+    projectName: string;
+    south?: number;
+    west?: number;
+};

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

@@ -43,7 +43,8 @@ export declare enum MediaFileType {
     Mp4 = "mp4",
     Png = "png",
     Pdf = "pdf",
-    Jpeg = "jpeg"
+    Jpeg = "jpeg",
+    Csv = "csv"
 }
 export declare enum MediaStatus {
     Pending = "Pending",
@@ -93,7 +94,7 @@ export type MediaCreateRequestPayload = {
     cameraExid?: string;
     requestedBy?: string;
     notes?: string;
-    category?: ClipsCategory;
+    category?: MediaCategory | ClipsCategory;
     isUrgent?: boolean;
     storeAsType?: MediaType;
 };
@@ -108,6 +109,11 @@ export declare enum ClipsCategory {
     Marketing = "marketing",
     BestPracticies = "best_practices"
 }
+export declare enum MediaCategory {
+    Weather = "weather",
+    SmartSearch = "smart_search",
+    Copilot = "copilot"
+}
 export type MediaDeleteRequestPayload = {
     timelapseIds: (string | number)[];
     compareIds: (string | number)[];

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

@@ -5,7 +5,13 @@ export declare enum NotificationType {
     TimelapseCreated = "timelapse_created",
     TimelapseFailed = "timelapse_failed",
     DroneProcessing = "drone_processing_done",
-    Processing360 = "three_sixty_done"
+    Processing360 = "three_sixty_done",
+    SmartSearchExportReady = "smart_search_export_ready",
+    SmartSearchExportFailed = "smart_search_export_failed",
+    GateReportExportReady = "gate_report_export_ready",
+    GateReportExportFailed = "gate_report_export_failed",
+    PpeExportReady = "ppe_export_ready",
+    PpeExportFailed = "ppe_export_failed"
 }
 export interface NotificationContextBase {
     cameraExid?: string;
@@ -41,7 +47,11 @@ export interface Processing360Context extends NotificationContextBase {
     date: string;
     floor: string;
 }
-export type NotificationContext = CameraShareContext | CameraStatusChangeContext | MentionContext | TimelapseCreatedContext | TimelapseFailedContext | DroneProcessingContext | Processing360Context;
+export interface ExportNotificationContext extends NotificationContextBase {
+    projectExid: string;
+    archiveExid?: string;
+}
+export type NotificationContext = CameraShareContext | CameraStatusChangeContext | MentionContext | TimelapseCreatedContext | TimelapseFailedContext | DroneProcessingContext | Processing360Context | ExportNotificationContext;
 export type Notification = {
     id: number;
     type: NotificationType;

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

@@ -0,0 +1,85 @@
+import { type ProjectExid, type CameraExid, type DateType, type BBox, PpeLabel, DownloadFileType } from "@evercam/api/types";
+export declare enum ObservationItemState {
+    Absent = 0,
+    Present = 1,
+    NotVisible = 2
+}
+export type ObservationEventEquipment = {
+    score: number;
+    bbox: BBox;
+};
+export type ObservationEvent = {
+    id: number;
+    cameraExid: CameraExid;
+    projectExid: ProjectExid;
+    capturedAt: DateType;
+    personIndex: number;
+    personBbox: BBox;
+    personScore: number;
+    ppe: Partial<Record<PpeLabel, ObservationEventEquipment>>;
+    hasHelmet: ObservationItemState | null;
+    hasHighVisVest: ObservationItemState | null;
+    hasGloves: ObservationItemState | null;
+    hasGlasses: ObservationItemState | null;
+    modelVersion: string;
+    createdAt: DateType;
+    compliant: boolean;
+    reason: string | null;
+    isApproved: boolean | null;
+};
+export type ObservationEventsQueryParams = {
+    cameraExid?: CameraExid;
+    fromDate?: string;
+    toDate?: string;
+    required?: string;
+    compliant?: boolean;
+    hasHelmet?: boolean;
+    hasHighVisVest?: boolean;
+    hasGloves?: boolean;
+    hasGlasses?: boolean;
+    sort?: string;
+    page?: number;
+    limit?: number;
+};
+export type ObservationEventsExportQueryParams = {
+    cameraExid?: CameraExid;
+    fromDate: string;
+    toDate: string;
+    required?: string;
+    compliant?: boolean;
+    fileType: DownloadFileType;
+    directDownload?: boolean;
+    includeInvalid?: boolean;
+};
+export type ObservationApprovalUpdateResponse = {
+    updated: boolean;
+    id: number | string | null;
+    message: string;
+};
+export declare enum ObservationCountsGranularity {
+    Day = "day",
+    Week = "week",
+    Month = "month"
+}
+export type ObservationEventsCountsQueryParams = {
+    cameraExid?: CameraExid;
+    fromDate?: string;
+    toDate?: string;
+    required?: string;
+    compliant?: boolean;
+    hasHelmet?: boolean;
+    hasHighVisVest?: boolean;
+    hasGloves?: boolean;
+    hasGlasses?: boolean;
+    granularity?: ObservationCountsGranularity;
+};
+export type ObservationEventCount = {
+    bucket: DateType;
+    total: number;
+    compliant: number;
+    nonCompliant: number;
+};
+export declare enum ObservationRequiredItem {
+    Helmet = "has_helmet",
+    HighVisVest = "has_high_vis_vest"
+}

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

@@ -1,5 +1,21 @@
-export type Coordinate = [number, number];
-export type PolygonPath = Coordinate[];
+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";
@@ -35,18 +51,47 @@ export declare enum EPageType {
     List = "list",
     Item = "item"
 }
-export declare enum EPaths {
-    Home = "/",
-    Session = "/session"
-}
-export declare enum EProjectItems {
-    Camera = "camera",
-    Overlay = "overlay"
-}
 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: {

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 = {
@@ -68,6 +68,13 @@ export declare enum ProjectArchiveTier {
 export type UpdateCameraRestrictionPayload = {
     isAccessRestricted?: boolean;
 };
+export type CameraPosition = {
+    cameraExid: CameraExid;
+    position: number;
+};
+export type ReorderCamerasPayload = {
+    positions: CameraPosition[];
+};
 export type Logo = {
     id: number;
     projectId: number;
@@ -110,6 +117,7 @@ export type ProjectsQueryParams = PaginationParams & {
     status: ProjectStatus;
     cameras: string;
     featureFlags: Array<ProjectFeatureFlag>;
+    featureFlagsOperator?: Operator;
     archived: string;
 };
 export type ProjectCreateRequestPayload = {

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

@@ -1,22 +1,24 @@
-import { ApiCredentials } from "@evercam/api/types";
+import { ApiCredentials, PaginationParams } from "@evercam/api/types";
 import { CancelToken } from "axios";
 export type Snapshot = {
     createdAt: string;
     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>;
@@ -39,11 +41,9 @@ export type NearestSnapshotResponsePayload = {
         notes?: string;
     }>;
 };
-export type SnapshotRangeRequestPayload = {
+export type SnapshotRangeRequestPayload = PaginationParams & {
     from: string;
     to: string;
-    limit?: number;
-    page?: number;
     schedule?: boolean;
     count?: number;
 };
@@ -104,13 +104,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",
@@ -120,5 +113,6 @@ export declare enum VpnServer {
     WireGuard7 = "WireGuard7",
     WireGuard8 = "WireGuard8",
     WireGuard9 = "WireGuard9",
-    WireGuard10 = "WireGuard10"
+    WireGuard10 = "WireGuard10",
+    WgHub = "WgHub"
 }

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

@@ -1,8 +1,23 @@
+export type RingCompleteLinkingPayload = {
+    nonce: string;
+    time: string;
+};
+/** The only auto-import status complete-linking returns today. */
+export declare const RING_AUTO_IMPORT_QUEUED = "queued";
+export type RingAutoImportStatus = typeof RING_AUTO_IMPORT_QUEUED;
+export type RingCompleteLinkingResponsePayload = {
+    status: string;
+    /** Absent when the API did not schedule an import. */
+    autoImport?: RingAutoImportStatus;
+};
 export type RingDevice = {
     deviceId: string;
     name: string;
-    deviceType: string;
+    /** Resolved from Ring's `device-status`; null when Ring did not return it. */
+    online: boolean | null;
+    deviceType: string | null;
     firmwareVersion: string | null;
+    /** Always null — Ring's API does not expose device power level. */
     batteryLife: number | null;
     location: string | null;
     imported: boolean;
@@ -13,21 +28,6 @@ export type RingDevice = {
 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;
 };

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

@@ -3,23 +3,15 @@ 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;
-    name: string;
-    x1: number;
-    x2: number;
-    y1: number;
-    y2: number;
-};
 export declare enum RoiDirection {
     Arrived = "arrived",
     Left = "left",

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

@@ -1,6 +1,7 @@
 export type RouteParams = {
     projectExid?: string;
     cameraExid?: string;
+    mediaExid?: string;
     timestamp?: string;
     fromDate?: string;
     toDate?: string;

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}`;
@@ -124,15 +128,21 @@ export type FeedbackPayload = {
     messageId?: number;
     conversationId?: number;
 };
-export type Stringified<T> = string & {
-    [P in keyof T]: {
-        "_ value": T[P];
-    };
+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 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 Exid = string;
 export type EntityByExid<Entity extends unknown> = Record<Exid, Entity>;
 export type BatteryVoltage = {
@@ -159,16 +169,6 @@ export declare enum TimelinePrecision {
     Minute = "minute",
     Events = "events"
 }
-export type EntityStatsQueryParams = {
-    period: "day" | "week" | "month";
-    startDate: string;
-    endDate: string;
-};
-export type EntityStat = {
-    period: string;
-    name: string;
-    count: number;
-};
 export declare enum TaskStatus {
     Idle = "idle",
     Loading = "loading",

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

@@ -33,14 +33,6 @@ export type SharedUsersResponsePayload = Array<{
     email: string;
     name: string;
 }>;
-export type ShareCreateRequestPayload = {
-    email: string[] | string;
-    message?: string;
-    permission?: string;
-    rights: string;
-    apiId?: string;
-    apiKey?: string;
-};
 export type ShareCreateResponsePayload = {
     shares: Share[];
     shareRequests: ShareRequest[];
@@ -51,8 +43,3 @@ export declare enum InviteStatus {
     Used = 1,
     Failed = -2
 }
-export declare enum ShareVisibility {
-    PublicDiscoverable = "publicDiscoverable",
-    PublicUndiscoverable = "publicUndiscoverable",
-    Private = "private"
-}

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 = {
@@ -232,7 +232,7 @@ export type SiteAnalyticsProcessingStatus = {
     feature: CameraFeatureFlag;
     processedIntervals: TimelineDateInterval[];
 };
-export type SmartSearchRequestPayload = {
+export type SmartSearchRequestPayload = PaginationParams & {
     cameraExids?: CameraExid[];
     drawingIds?: _360FloorId[];
     walkIds?: string[];
@@ -240,8 +240,6 @@ export type SmartSearchRequestPayload = {
     payload: SmartSearchBackendQuery;
     fromDate?: string;
     toDate?: string;
-    page?: number;
-    pageSize?: number;
     threshold?: number;
 };
 type SmartSearchResultItemBase = {

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

@@ -0,0 +1,90 @@
+import { CameraExid, DateType, PaginationParams, 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 = PaginationParams & {
+    projectExid?: ProjectExid;
+    includeStatus?: boolean;
+};
+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;
+};