@evercam/api 1.0.0-fefe23b74 → 1.0.0-ff2190f47

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

@@ -1,4 +1,4 @@
-import { CameraExid, CountryCode, CountryId, DateType, Nvr, PaginationParams, PowerType, Project, Router, Schedule, Tag } from "@evercam/api/types";
+import { CameraExid, CountryCode, CountryId, Nvr, PaginationParams, PowerType, Project, Router, Schedule, Tag } from "@evercam/api/types";
 export type Kit = {
     alarms: KitAlarm[];
     countryCode: CountryCode;
@@ -21,12 +21,17 @@ export type Kit = {
     tags: Tag[];
     storages: KitStorage[];
     createdAt: string;
+    decommissionedAt?: string;
+    deletedAt?: 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"
+    CamerasRecording = "cameras_recording",
+    CamerasSdCardMounted = "cameras_sd_card_mounted",
+    BatteryReadings = "battery_readings"
 }
 export declare enum KitSupportCheckStatus {
     Passed = "passed",
@@ -145,55 +150,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 = {
@@ -286,55 +242,6 @@ export type KitQueryParams = PaginationParams & {
     status: KitStatus;
     tagId: number | number[];
 };
-export type AdminKit = {
-    id: number;
-    name: string;
-    serial: string;
-    status: string;
-    powerType: PowerType;
-    location: string;
-    countryId: number;
-    countryName: string;
-    countryRegion: string;
-    nvr: Nvr;
-    router: {
-        id: number;
-        serialNumber: number;
-        vpnUserId: string;
-        vpnPassword: string;
-        routerType: string;
-        routerUserId: string;
-        routerPassword: string;
-        routerHttpPort: number;
-        powerType: PowerType;
-        powerSchedule: Schedule;
-        vpnServer: string;
-        netbirdUrl: string;
-        sims: {
-            id: number;
-            number: string;
-        }[];
-    };
-    project: {
-        id: number;
-        exid: string;
-        name: string;
-        timezone: string;
-        status: string;
-        zohoId: string;
-        insertedAt: DateType;
-    };
-};
-export type KitCreatePayload = {
-    projectId?: number;
-    countryCode?: string;
-    name: string;
-    status: KitStatus;
-    powerType: PowerType;
-    config: {
-        region: KitRegion;
-    };
-};
 export type KitMetricStatsEntry = {
     timestamp: string;
     voltage: number;

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

@@ -111,8 +111,7 @@ export declare enum ClipsCategory {
 }
 export declare enum MediaCategory {
     Weather = "weather",
-    SmartSearch = "smart_search",
-    Copilot = "copilot"
+    SmartSearch = "smart_search"
 }
 export type MediaDeleteRequestPayload = {
     timelapseIds: (string | number)[];

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

@@ -1,11 +1,32 @@
+import { CommentsScope, CommentThreeSixtyContext } from "./comments";
 export declare enum NotificationType {
     CameraShare = "camera_share",
     CameraStatusChange = "camera_status_changed",
     Mention = "mention",
+    CommentMention = "comment_mention",
     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 +62,36 @@ 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 interface CommentMentionContext extends NotificationContextBase {
+    projectExid: string;
+    commentId: number;
+    scope: CommentsScope;
+    commentContext: CommentThreeSixtyContext;
+    content?: string;
+    label?: string;
+    projectName?: string;
+}
+export type NotificationContext = CameraShareContext | CameraStatusChangeContext | MentionContext | TimelapseCreatedContext | TimelapseFailedContext | DroneProcessingContext | Processing360Context | ExportNotificationContext | UploadNotificationContext | RingCamerasImportedContext | StorageWarningContext | CommentMentionContext;
 export type Notification = {
     id: number;
     type: NotificationType;

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

@@ -0,0 +1,141 @@
+import type { VisionProvider } from "@evercam/api/types";
+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;
+    sourceType?: ObservationSourceType;
+    sessionId?: string | null;
+    markerId?: string | null;
+    drawingId?: string | null;
+    drawingName?: string | null;
+    walkName?: string | null;
+    sightings?: Array<Record<string, unknown>> | null;
+    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: ObservationEventTrigger | string;
+    reviewedBy: string | null;
+    reviewedAt: string | null;
+    insertedAt: string;
+}
+export type ObservationEventQueryParams = {
+    cameraExid?: string;
+    projectExid?: string;
+    observationTypeIds?: string;
+    status?: ObservationEventStatus | string;
+    sourceType?: ObservationSourceType | string;
+    modelName?: string;
+    sortBy?: string;
+    sortDir?: "asc" | "desc";
+    page?: number;
+    limit?: number;
+};
+export interface ObservationModelOption {
+    modelName: string;
+    total: 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;
+}
+export declare enum ObservationSourceType {
+    Camera = "camera",
+    Walk360 = "walk360",
+    Drone = "drone"
+}
+export declare enum ObservationEventTrigger {
+    CameraDetection = "camera_detection",
+    Walk = "walk"
+}
+export declare enum Walk360ProcessedSessionStatus {
+    Done = "done",
+    Processing = "processing",
+    Retryable = "retryable",
+    Error = "error"
+}
+export interface Walk360Activity {
+    observationTypeId: number;
+}
+export interface Walk360WorkerInfo {
+    coolifyAppId?: string | null;
+    workerStatus?: string | null;
+    workerIsRunning?: boolean;
+    appUrl?: string | null;
+    visionProvider?: VisionProvider;
+}
+export interface Walk360Config extends Walk360WorkerInfo {
+    projectExid: string;
+    enabled: boolean;
+    startDate: string | null;
+    activities: Walk360Activity[];
+    configured: boolean;
+    maxParallelWalks?: number;
+}
+export interface Walk360ConfigSummary extends Walk360WorkerInfo {
+    projectExid: string;
+    projectName?: string | null;
+    enabled: boolean;
+    startDate: string | null;
+    activities: Walk360Activity[];
+    maxParallelWalks: number;
+    walksDone: number;
+    walksProcessing: number;
+    walksRetryable: number;
+    eventsCreated: number;
+    lastProcessedAt: string | null;
+    updatedAt: string | null;
+}
+export interface Walk360WorkerAction {
+    projectExid: string;
+    appUuid: string | null;
+    message: string;
+    state: string;
+}
+export interface Walk360ProcessedSession {
+    id: number;
+    projectExid: string;
+    sourceType: ObservationSourceType;
+    sessionId: string;
+    status: Walk360ProcessedSessionStatus;
+    markersTotal: number | null;
+    markersProcessed: number | null;
+    eventsCreated: number | null;
+    error: string | null;
+    startedAt: string;
+    finishedAt: string | null;
+}

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

@@ -1,55 +1,59 @@
-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;
-};
+import { type ProjectExid, type CameraExid, type DateType, type BBox, AiObservationFeasibilityStatus, ObservationEventStatus, DownloadFileType } from "@evercam/api/types";
+export type ObservationApproval = boolean | ObservationEventStatus.Unsure | null;
 export type ObservationEvent = {
     id: number;
+    observationTypeId: number;
+    observationCode: string | null;
     cameraExid: CameraExid;
-    projectExid: ProjectExid;
+    projectExid: ProjectExid | null;
     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;
+    endTime: DateType | null;
+    confidence: number | null;
+    status: ObservationEventStatus;
+    isApproved: ObservationApproval;
     reason: string | null;
-    isApproved: boolean | null;
+    personBbox: BBox | null;
+    modelVersion: string | null;
+    observationMetadata: Record<string, unknown> | null;
+    trigger: string;
+    reviewedBy: string | null;
+    reviewedAt: DateType | null;
+};
+export type ObservationType = {
+    id: number;
+    observationCode: string;
+    name: string;
+    description: string | null;
+    type: string;
+    severity: number | null;
+    feasibilityStatus: AiObservationFeasibilityStatus;
 };
+export declare enum ObservationMissingItem {
+    Helmet = "helmet",
+    HighVisVest = "high_vis_vest",
+    Gloves = "gloves",
+    Glasses = "glasses"
+}
 export type ObservationEventsQueryParams = {
     cameraExid?: CameraExid;
+    observationCode?: string;
     fromDate?: string;
     toDate?: string;
-    required?: string;
-    compliant?: boolean;
-    hasHelmet?: boolean;
-    hasHighVisVest?: boolean;
-    hasGloves?: boolean;
-    hasGlasses?: boolean;
+    missingItems?: string;
+    status?: ObservationEventStatus;
     sort?: string;
     page?: number;
     limit?: number;
 };
 export type ObservationEventsExportQueryParams = {
     cameraExid?: CameraExid;
+    observationCode?: string;
+    missingItems?: string;
+    status?: ObservationEventStatus;
     fromDate: string;
     toDate: string;
-    required?: string;
-    compliant?: boolean;
     fileType: DownloadFileType;
     directDownload?: boolean;
-    includeInvalid?: boolean;
 };
 export type ObservationApprovalUpdateResponse = {
     updated: boolean;
@@ -63,23 +67,14 @@ export declare enum ObservationCountsGranularity {
 }
 export type ObservationEventsCountsQueryParams = {
     cameraExid?: CameraExid;
+    observationCode?: string;
     fromDate?: string;
     toDate?: string;
-    required?: string;
-    compliant?: boolean;
-    hasHelmet?: boolean;
-    hasHighVisVest?: boolean;
-    hasGloves?: boolean;
-    hasGlasses?: boolean;
+    missingItems?: string;
+    status?: ObservationEventStatus;
     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

@@ -29,6 +29,7 @@ export declare enum PlannerUrlParams {
     DealId = "deal_id"
 }
 export declare enum EDistortImageModes {
+    Edit = "edit",
     FreeRotate = "freeRotate",
     Lock = "lock",
     Rotate = "rotate",
@@ -51,14 +52,6 @@ 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"

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

@@ -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;
@@ -89,10 +96,10 @@ export declare enum ProjectFeatureFlag {
     MediaHubSharing = "archives_sharing",
     GateReportAnprBased = "anpr_sourced",
     NoLicensePlate = "no_license_plate",
-    DefaultToProjectApp = "default_to_project_app",
     SmartSearch = "smart_search",
     PpeMonitoring = "ppe_monitoring",
-    NoGdpr = "no_gdpr"
+    NoGdpr = "no_gdpr",
+    Chat = "chat"
 }
 export type ProjectBatteryReading = {
     exid: number;
@@ -180,7 +187,7 @@ export type ProjectMember = {
     } | null;
 };
 export type ProjectInvite = {
-    id?: string;
+    id: number;
     email: string;
     role?: ProjectRole;
     permissions?: string[];
@@ -223,6 +230,11 @@ export type ProjectUsersResponsePayload = {
     invites: ProjectInvite[];
     errors: ProjectUserError[];
 };
+export type MentionableUser = {
+    id: number;
+    fullname: string;
+    email: string;
+};
 export type ProjectStorageQueryParams = PaginationParams & {
     cameraName: string;
     cameraExid: CameraExid;

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

@@ -1,4 +1,4 @@
-import { ApiCredentials } from "@evercam/api/types";
+import { ApiCredentials, PaginationParams } from "@evercam/api/types";
 import { CancelToken } from "axios";
 export type Snapshot = {
     createdAt: string;
@@ -41,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;
 };

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

@@ -12,15 +12,6 @@ export declare enum RoiShapeType {
     Direction = "direction",
     Rectangle = "rectangle"
 }
-export type RoiShape = {
-    id: number | null;
-    name: string;
-    x1: number;
-    x2: number;
-    y1: number;
-    y2: number;
-    points?: [number, 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

@@ -109,25 +109,18 @@ export declare enum InfoPage {
     DroneView = "drone-view",
     Compare = "compare",
     Timeline = "timeline",
-    WeatherReport = "weather-report"
+    WeatherReport = "weather-report",
+    Cameras = "cameras"
 }
 export declare enum DownloadFileType {
     Jpeg = "jpeg",
     Pdf = "pdf",
     Csv = "csv"
 }
-export declare enum FeedbackContext {
-    CopilotMessage = "copilot_message"
+export declare enum PromiseSettledStatus {
+    Fulfilled = "fulfilled",
+    Rejected = "rejected"
 }
-export type FeedbackPayload = {
-    id?: number;
-    user: string;
-    text: string;
-    type: string;
-    context: FeedbackContext;
-    messageId?: number;
-    conversationId?: number;
-};
 export type Stringified<T> = string & {
     [P in keyof T]: {
         "_ value": T[P];
@@ -178,16 +171,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",