@evercam/api 1.0.0-533505ee2 → 1.0.0-53d3bfead

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

@@ -8,7 +8,8 @@ export declare enum IngestProcessingStatus {
     Aborted = "aborted",
     Paused = "paused",
     InProgress = "inprogress",
-    Pending = "pending"
+    Pending = "pending",
+    Downloading = "downloading"
 }
 export declare enum MobileAssetsType {
     Audio = "mobile_audios",
@@ -38,6 +39,80 @@ export type IngestPaginatedResponse<T> = {
     total: number;
     pageCount?: number;
 };
+export declare enum IngestProcessingStepStatus {
+    Running = "running",
+    Completed = "completed",
+    Failed = "failed",
+    Skipped = "skipped"
+}
+export declare enum IngestProcessingRunStatus {
+    Processing = "processing",
+    Completed = "completed",
+    Failed = "failed"
+}
+export type IngestProcessingMetricStat = {
+    avg?: number;
+    peak?: number;
+};
+export type IngestProcessingStepMetrics = {
+    cpu?: IngestProcessingMetricStat;
+    ram?: IngestProcessingMetricStat;
+    gpuUtil?: IngestProcessingMetricStat;
+    gpuMemDevice?: IngestProcessingMetricStat;
+    gpuMemStep?: IngestProcessingMetricStat;
+    ramTotalMb?: number;
+    diskTotalMb?: number;
+};
+export type IngestProcessingStepDetail = {
+    input?: Record<string, JsonValue>;
+    params?: Record<string, JsonValue>;
+    output?: Record<string, JsonValue>;
+    metrics?: IngestProcessingStepMetrics;
+    error?: string;
+};
+export type IngestProcessingStep = {
+    name: string;
+    tool?: string;
+    status: IngestProcessingStepStatus | string;
+    startedAt?: string;
+    endedAt?: string;
+    durationSec?: number;
+    durationPct?: number;
+    detail?: IngestProcessingStepDetail;
+};
+export type IngestProcessingDiskUsage = {
+    sourceMb?: number;
+    framesMb?: number;
+    resultMb?: number;
+    totalMb?: number;
+};
+export type IngestProcessingPeakUsage = {
+    cpu?: number;
+    ram?: number;
+    gpuUtil?: number;
+    gpuMemDevice?: number;
+    gpuMemStep?: number;
+};
+export type IngestProcessingFootprint = {
+    disk?: IngestProcessingDiskUsage;
+    peak?: IngestProcessingPeakUsage;
+};
+export type IngestProcessingProgress = {
+    available: boolean;
+    status?: IngestProcessingRunStatus | string;
+    processingStatus?: IngestProcessingStatus | string;
+    currentStep?: string | null;
+    error?: string | null;
+    startedAt?: string;
+    steps: IngestProcessingStep[];
+    footprint?: IngestProcessingFootprint;
+};
+export type IngestTrackedAsset = {
+    id: number;
+    projectId: string;
+    name?: string;
+    processingStatus?: IngestProcessingStatus | string;
+};
 export type DroneUploadItem = {
     id: number;
     projectId: string;
@@ -54,6 +129,7 @@ export type DroneUploadItem = {
     modelCesiumAssetId: string;
     updatedAt: string;
     hasTusLinks: boolean;
+    hasSteps: boolean;
     aerialShots: AerialShotItem[];
 };
 export type DroneUploadsResponse = IngestPaginatedResponse<DroneUploadItem>;

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",
@@ -118,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 = {

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",

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,84 @@
+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 | null;
+    capturedAt: DateType;
+    endTime: DateType | null;
+    confidence: number | null;
+    status: ObservationEventStatus;
+    isApproved: ObservationApproval;
+    reason: string | 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;
+    missingItems?: string;
+    status?: ObservationEventStatus;
+    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;
+    observationCode?: string;
+    fromDate?: string;
+    toDate?: string;
+    missingItems?: string;
+    status?: ObservationEventStatus;
+    granularity?: ObservationCountsGranularity;
+};
+export type ObservationEventCount = {
+    bucket: DateType;
+    total: number;
+};
+export declare enum ObservationRequiredItem {
+    Helmet = "has_helmet",
+    HighVisVest = "has_high_vis_vest"
+}

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

@@ -51,14 +51,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;

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

@@ -128,15 +128,6 @@ export type FeedbackPayload = {
     messageId?: number;
     conversationId?: number;
 };
-export type Stringified<T> = string & {
-    [P in keyof T]: {
-        "_ value": T[P];
-    };
-};
-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 = {
@@ -178,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

@@ -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;
-    limit?: number;
     threshold?: number;
 };
 type SmartSearchResultItemBase = {

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

@@ -1,4 +1,4 @@
-import { CameraExid, DateType, ProjectExid } from "@evercam/api/types";
+import { CameraExid, DateType, PaginationParams, ProjectExid } from "@evercam/api/types";
 export type SiteAnalyticsCoolifyStatus = {
     appUuid: string | null;
     name: string | null;
@@ -35,6 +35,9 @@ export type SiteAnalyticsManagedApp = {
     source: string;
     override: boolean;
     timeIncreaseFrequency: number;
+    skipWeekends: boolean;
+    tracking: boolean;
+    observations: boolean;
     insertedAt: DateType | null;
     updatedAt: DateType | null;
     coolify: SiteAnalyticsCoolifyStatus | null;
@@ -54,7 +57,11 @@ export type CreateSiteAnalyticsAppPayload = {
     endHour?: number;
     source?: string;
     override?: boolean;
+    skipWeekends?: boolean;
     timeIncreaseFrequency?: number;
+    tracking?: boolean;
+    observations?: boolean;
+    observationPromptId?: number | null;
 };
 export type UpdateSiteAnalyticsAppPayload = Partial<Omit<CreateSiteAnalyticsAppPayload, "projectExid" | "cameraExid" | "coolifyServerUuid">>;
 export type ModelOption = {
@@ -71,12 +78,11 @@ export type SiteAnalyticsAppConfigFormValue = {
     source: string;
     override: boolean;
     timeIncreaseFrequency: number;
+    skipWeekends: boolean;
 };
-export type SiteAnalyticsManagementListParams = {
+export type SiteAnalyticsManagementListParams = PaginationParams & {
     projectExid?: ProjectExid;
     includeStatus?: boolean;
-    page?: number;
-    limit?: number;
 };
 export type CreateSiteAnalyticsAppResponse = {
     created: boolean;
@@ -90,3 +96,22 @@ export type DeleteSiteAnalyticsAppResponse = {
     count: number;
     message: string;
 };
+export type ObservationConfigActivity = {
+    observationTypeId: number;
+    every: number | null;
+};
+export type ObservationConfig = {
+    id: number;
+    cameraExid: CameraExid;
+    projectExid: ProjectExid | null;
+    enabled: boolean;
+    activities: ObservationConfigActivity[];
+    createdBy: string | null;
+    insertedAt: DateType | null;
+    updatedAt: DateType | null;
+};
+export type UpsertObservationConfigPayload = {
+    projectExid?: ProjectExid;
+    enabled: boolean;
+    activities: ObservationConfigActivity[];
+};

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

@@ -0,0 +1,4 @@
+export type SocketAuthResponsePayload = {
+    wsToken: string;
+    expiresIn: number;
+};

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

@@ -1,17 +1,4 @@
 import type { JsonObject, JsonValue } from "@evercam/api/types";
-export type StoryblokAsset = {
-    id: number | null;
-    alt: string | null;
-    name: string;
-    focus: string | null;
-    title: string | null;
-    filename: string;
-    copyright: string | null;
-    fieldtype: "asset";
-    source?: string;
-    metaData?: JsonObject;
-    isExternalUrl?: boolean;
-};
 export type StoryblokStory<TContent extends JsonObject = JsonObject> = {
     id: number;
     uuid: string;