@evercam/api 1.0.0-e6c3bb6ca → 1.0.0-e78536009

package/dist/{types → api/types}/kit.d.ts

@@ -1,10 +1,10 @@
-import { CountryCode, CountryId, DateType, Nvr, PaginationParams, PowerType, Project, Region, Router, Schedule, Tag } from "@/types";
+import { CameraExid, CountryCode, CountryId, DateType, Nvr, PaginationParams, PowerType, Project, Router, Schedule, Tag } from "@evercam/api/types";
 export type Kit = {
     alarms: KitAlarm[];
     countryCode: CountryCode;
     countryId: CountryId;
     countryName: string;
-    countryRegion: Region;
+    countryRegion: KitRegion;
     id?: number;
     jobId: number;
     name: string;
@@ -16,7 +16,43 @@ export type Kit = {
     serial: string;
     status: KitStatus;
     powerSchedule: Schedule;
+    ups: boolean;
+    boxId: string;
     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",
+    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",
@@ -24,19 +60,31 @@ export declare enum KitStatus {
     Deployed = "deployed",
     Decommissioned = "decommissioned"
 }
+export declare enum KitRegion {
+    APAC = "apac",
+    EMEA = "emea",
+    LATAM = "latam",
+    US = "na"
+}
 export declare enum KitAlarm {
     NvrOffline = "nvr_offline",
+    OfflineScheduled = "offline_scheduled",
     UnknownCamera = "unknown_camera",
     NotRecordingCamera = "not_recording_camera",
-    OfflineScheduled = "offline_scheduled",
     FullSD = "full_sd",
     FullStorage = "full_storage",
     HddUnmounted = "hdd_unmounted",
-    NoHdd = "no_hdd"
+    NoHdd = "no_hdd",
+    MissingRouterInfo = "missing_router_info",
+    AcFailure = "ac_failure",
+    LowBattery = "low_battery",
+    GeneratorOff = "generator_off"
 }
 export declare enum KitMetricId {
-    BatteryStats = "battery",
-    PanelPowerStats = "panel_power"
+    SolarCharger = "solar_charger",
+    PanelPower = "panel_power",
+    Fan = "fan",
+    FanTemperature = "fan_temperature"
 }
 export declare enum KitMetricPeriod {
     Last15Minutes = "now-15m",
@@ -102,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 = {
@@ -289,9 +288,22 @@ export type KitCreatePayload = {
     status: KitStatus;
     powerType: PowerType;
     config: {
-        region: Region;
+        region: KitRegion;
     };
 };
+export type KitMetricStatsEntry = {
+    timestamp: string;
+    voltage: number;
+    current: number;
+    panelVoltage: number;
+    panelPower: number;
+};
+export type KitFanStatsEntry = {
+    timestamp: string;
+    speed: number;
+    internalTemperature: number;
+    externalTemperature: number | null;
+};
 export type KitUpdatePayload = {
     countryId: number;
     name: string;
@@ -299,3 +311,65 @@ export type KitUpdatePayload = {
     kitStatus: KitStatus;
     type: string;
 };
+export declare enum KitStorageTransport {
+    Sata = "sata",
+    Nvme = "nvme",
+    Usb = "usb"
+}
+export type KitStorageRequestPayload = {
+    kitId: number;
+};
+export type KitStorage = {
+    id: number;
+    serial: string;
+    status: string;
+    type: string;
+    metadata: {
+        formFactor: string;
+    };
+    model: string;
+    insertedAt: string;
+    updatedAt: string;
+    vendor: string;
+    kitId: number;
+    capacity: number;
+    freeSpace: number;
+    tran: KitStorageTransport;
+};
+export type KitFootageRequestPayload = {
+    cameraId: CameraExid;
+    storageId: number;
+};
+export type KitFootage = {
+    id: number;
+    startDate: string;
+    endDate: string;
+    cameraId: number;
+    storageId: number;
+};
+export type KitAlarmItem = {
+    id: number;
+    kitId: number;
+    alarm: KitAlarm;
+    startDate: string;
+    endDate: string | null;
+};
+export type KitBox = {
+    id: string;
+    gatewaySerial: string;
+    gatewayMac: string;
+    gatewayConfig: Record<string, unknown> | null;
+    insertedAt: string;
+    updatedAt: string;
+};
+export type KitBoxCreatePayload = {
+    id?: string;
+    gatewaySerial: string;
+    gatewayMac: string;
+    gatewayConfig?: Record<string, unknown>;
+};
+export type KitBoxQueryParams = PaginationParams & {
+    id: string;
+    gatewaySerial: string;
+    gatewayMac: string;
+};

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

@@ -0,0 +1,16 @@
+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/{types → api/types}/media.d.ts

@@ -1,4 +1,4 @@
-import type { CameraExid, Exid, DateType } from "@/types";
+import type { CameraExid, Exid, DateType } from "@evercam/api/types";
 export type MediaExid = Exid;
 export type Media = {
     project_exid?: string;
@@ -25,6 +25,7 @@ export type Media = {
     projectExid?: string;
     thumbnailUrl?: string;
     mediaUrl?: string;
+    camera?: string;
 };
 export declare enum MediaType {
     EditedImage = "edit",
@@ -42,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",
@@ -92,7 +94,7 @@ export type MediaCreateRequestPayload = {
     cameraExid?: string;
     requestedBy?: string;
     notes?: string;
-    category?: ClipsCategory;
+    category?: MediaCategory | ClipsCategory;
     isUrgent?: boolean;
     storeAsType?: MediaType;
 };
@@ -107,6 +109,10 @@ export declare enum ClipsCategory {
     Marketing = "marketing",
     BestPracticies = "best_practices"
 }
+export declare enum MediaCategory {
+    Weather = "weather",
+    SmartSearch = "smart_search"
+}
 export type MediaDeleteRequestPayload = {
     timelapseIds: (string | number)[];
     compareIds: (string | number)[];

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

@@ -0,0 +1,107 @@
+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",
+    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;
+    projectExid?: string;
+}
+export interface CameraShareContext extends NotificationContextBase {
+    cameraExid: string;
+    projectExid: string;
+    shareId: number;
+}
+export interface CameraStatusChangeContext extends NotificationContextBase {
+    cameraExid: string;
+    projectExid: string;
+    newStatus: string;
+}
+export interface MentionContext extends NotificationContextBase {
+}
+export interface TimelapseCreatedContext extends NotificationContextBase {
+    cameraExid: string;
+    projectExid: string;
+    archiveExid: string;
+}
+export interface TimelapseFailedContext extends NotificationContextBase {
+    cameraExid: string;
+    projectExid: string;
+}
+export interface DroneProcessingContext extends NotificationContextBase {
+    projectExid: string;
+    droneDate: string;
+}
+export interface Processing360Context extends NotificationContextBase {
+    projectExid: string;
+    date: string;
+    floor: string;
+}
+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;
+    insertedAt: string;
+    initiatorId: number;
+    initiatorFullname: string;
+    initiatorEmail: string;
+    targetId: number;
+    targetFullname: string;
+    targetEmail: string;
+    readTimestamp: string | null;
+    context: NotificationContext;
+};

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

@@ -0,0 +1,62 @@
+export type OAuthClient = {
+    id: number;
+    name: string;
+    clientId: string;
+    redirectUris: string[];
+    logoUrl: string | null;
+    scopes: string[];
+    active: boolean;
+    description: string | null;
+    owner: {
+        id: number;
+        name: string;
+        email: string;
+    } | null;
+    createdAt: string;
+    updatedAt: string;
+};
+export type OAuthClientWithSecret = OAuthClient & {
+    clientSecret: string;
+};
+export type CreateOAuthClientPayload = {
+    name: string;
+    redirectUris: string[];
+    scopes?: string[];
+    description?: string;
+    logoUrl?: string;
+};
+export type AdminCreateOAuthClientPayload = CreateOAuthClientPayload & {
+    clientId?: string;
+    clientSecret?: string;
+};
+export type UpdateOAuthClientPayload = {
+    name?: string;
+    redirectUris?: string[];
+    scopes?: string[];
+    description?: string;
+    logoUrl?: string;
+    active?: boolean;
+};
+export type OAuthScopeDetail = {
+    scope: string;
+    description: string;
+    group: string;
+};
+export type OAuthConsentInfo = {
+    client: {
+        name: string;
+        logoUrl: string | null;
+        description: string | null;
+    };
+    scopes: OAuthScopeDetail[];
+};
+export type OAuthConsentPayload = {
+    clientId: string;
+    scope: string;
+    redirectUri: string;
+    state: string;
+    decision: "allow" | "deny";
+};
+export type OAuthConsentResponse = {
+    redirectUrl: string;
+};

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

@@ -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"
+}