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

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

@@ -22,6 +22,36 @@ export type Kit = {
     storages: KitStorage[];
     createdAt: string;
 };
+export declare enum KitSupportCheckId {
+    RouterSmsRoundTrip = "router_sms_round_trip",
+    NvrRecordingAllCameras = "nvr_recording_all_cameras",
+    NvrRecordingThirdStream = "nvr_recording_third_stream",
+    CamerasHaveDeviceId = "cameras_have_device_id",
+    CamerasRecording = "cameras_recording",
+    CamerasSdCardMounted = "cameras_sd_card_mounted",
+    BatteryReadings = "battery_readings"
+}
+export declare enum KitSupportCheckStatus {
+    Passed = "passed",
+    Failed = "failed",
+    Skipped = "skipped"
+}
+export type KitSupportCheck = {
+    id: KitSupportCheckId;
+    name: string;
+    status: KitSupportCheckStatus;
+    error: string | null;
+};
+export type KitSupportChecklist = {
+    checks: KitSupportCheck[];
+};
+export type KitDiagnosticRun = {
+    kitId: number;
+    kitSerial: string;
+    checks: KitSupportCheck[];
+    ranAt: string;
+    isSeen: boolean;
+};
 export declare enum KitStatus {
     New = "new",
     Active = "active",
@@ -45,11 +75,14 @@ export declare enum KitAlarm {
     NoHdd = "no_hdd",
     MissingRouterInfo = "missing_router_info",
     AcFailure = "ac_failure",
-    LowBattery = "low_battery"
+    LowBattery = "low_battery",
+    GeneratorOff = "generator_off"
 }
 export declare enum KitMetricId {
     SolarCharger = "solar_charger",
-    PanelPower = "panel_power"
+    PanelPower = "panel_power",
+    Fan = "fan",
+    FanTemperature = "fan_temperature"
 }
 export declare enum KitMetricPeriod {
     Last15Minutes = "now-15m",
@@ -115,55 +148,6 @@ export declare enum KitChartType {
     TimeSeries = "timeseries",
     BarChart = "barchart"
 }
-export type GrafanaDataSource = {
-    type: string;
-    uid: string;
-};
-export type GrafanaTarget = {
-    expr: string;
-    refId: string;
-    datasourceId?: string;
-    intervalMs?: number;
-    maxDataPoints?: number;
-};
-export type GrafanaPanel = {
-    [key: string]: unknown;
-    id: GrafanaMetricId;
-    name: keyof GrafanaMetricId;
-    title: string;
-    description: string;
-    type: KitChartType;
-    datasource: GrafanaDataSource;
-    targets: GrafanaTarget[];
-    maxDataPoints?: number;
-    interval?: string;
-    timeFrom?: string;
-    timeShift?: string;
-    options?: {
-        maxDataPoints?: number;
-        interval?: string;
-    };
-};
-export type GrafanaDashboard = {
-    [key: string]: unknown;
-    panels: GrafanaPanel[];
-    time?: {
-        from: string;
-        to: string;
-    };
-    timepicker?: {
-        refresh_intervals: string[];
-        time_options: string[];
-    };
-};
-export type GrafanaQueryOptions = {
-    metricId: GrafanaMetricId;
-    host: string;
-    job?: string;
-    from?: string;
-    to?: string;
-    variables?: Record<string, string>;
-};
 export type GrafanaTimeSeriesValue = number | string | null;
 export type GrafanaTimeSeriesValues = GrafanaTimeSeriesValue[][];
 export type GrafanaFieldConfig = {
@@ -312,6 +296,12 @@ export type KitMetricStatsEntry = {
     panelVoltage: number;
     panelPower: number;
 };
+export type KitFanStatsEntry = {
+    timestamp: string;
+    speed: number;
+    internalTemperature: number;
+    externalTemperature: number | null;
+};
 export type KitUpdatePayload = {
     countryId: number;
     name: string;

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,26 @@ 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",
+    WeatherExportReady = "weather_export_ready",
+    WeatherExportFailed = "weather_export_failed",
+    CompareReady = "compare_ready",
+    CompareFailed = "compare_failed",
+    ClipExportReady = "clip_export_ready",
+    ClipExportFailed = "clip_export_failed",
+    NvrClipReady = "nvr_clip_ready",
+    NvrClipFailed = "nvr_clip_failed",
+    UploadComplete = "upload_complete",
+    UploadFailed = "upload_failed",
+    RingCamerasImported = "ring_cameras_imported",
+    StorageWarning = "storage_warning",
+    Other = "other"
 }
 export interface NotificationContextBase {
     cameraExid?: string;
@@ -41,7 +60,27 @@ 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;
+    compareExid?: string;
+}
+export interface UploadNotificationContext extends NotificationContextBase {
+    projectExid: string;
+}
+export interface RingCamerasImportedContext extends NotificationContextBase {
+    projectExid: string;
+    projectName: string;
+    cameras: Array<{
+        exid: string;
+        name: string;
+    }>;
+}
+export interface StorageWarningContext extends NotificationContextBase {
+    projectExid: string;
+    cameraName: string;
+}
+export type NotificationContext = CameraShareContext | CameraStatusChangeContext | MentionContext | TimelapseCreatedContext | TimelapseFailedContext | DroneProcessingContext | Processing360Context | ExportNotificationContext | UploadNotificationContext | RingCamerasImportedContext | StorageWarningContext;
 export type Notification = {
     id: number;
     type: NotificationType;

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

@@ -0,0 +1,61 @@
+export declare enum ObservationEventStatus {
+    Detected = "detected",
+    Approved = "approved",
+    Disapproved = "disapproved",
+    Unsure = "unsure"
+}
+export interface ObservationEventStatusConfig {
+    bg: string;
+    fg: string;
+    border: string;
+    label: string;
+}
+export declare const OBSERVATION_EVENT_STATUS_CONFIGS: Record<ObservationEventStatus, ObservationEventStatusConfig>;
+export interface SiteAnalyticsObservationEvent {
+    id: number;
+    observationTypeId: number;
+    observationName: string | null;
+    observationCode: string | null;
+    cameraExid: string;
+    projectExid: string | null;
+    startTime: string;
+    endTime: string | null;
+    confidence: number | null;
+    status: ObservationEventStatus;
+    aiEvidence: string | null;
+    bbox: number[] | null;
+    model: string | null;
+    promptId: number | null;
+    observationMetadata: Record<string, unknown> | null;
+    trigger: string;
+    reviewedBy: string | null;
+    reviewedAt: string | null;
+    insertedAt: string;
+}
+export type ObservationEventQueryParams = {
+    cameraExid?: string;
+    projectExid?: string;
+    observationTypeIds?: string;
+    status?: ObservationEventStatus | string;
+    sortBy?: string;
+    sortDir?: "asc" | "desc";
+    page?: number;
+    limit?: number;
+};
+export interface ObservationEventListResponse {
+    items: SiteAnalyticsObservationEvent[];
+    total: number;
+    page: number;
+    limit: number;
+    from: number;
+    to: number;
+}
+export type ObservationEventVerdict = ObservationEventStatus.Approved | ObservationEventStatus.Disapproved | ObservationEventStatus.Unsure;
+export interface ObservationEventReviewPayload {
+    status: ObservationEventVerdict;
+}
+export interface ObservationEventReviewResponse {
+    updated: boolean;
+    id: number | string;
+    message: string;
+}

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 = {
@@ -62,11 +62,19 @@ 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;
 };
+export type CameraPosition = {
+    cameraExid: CameraExid;
+    position: number;
+};
+export type ReorderCamerasPayload = {
+    positions: CameraPosition[];
+};
 export type Logo = {
     id: number;
     projectId: number;
@@ -109,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;
 };
@@ -76,6 +76,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 +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",
@@ -119,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;