@evercam/api 1.0.0-624ff9012 → 1.0.0-62a573190

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

@@ -1,4 +1,5 @@
-import { PaginationParams, DateType } from "@/types";
+import { PaginationParams, DateType, JsonValue, TuplePoint2D } from "@evercam/api/types";
+import type { _360FloorV2, _360WalkV2 } from "@evercam/api/types/360";
 export declare enum IngestProcessingStatus {
     Completed = "completed",
     Uploading = "uploading",
@@ -7,11 +8,23 @@ export declare enum IngestProcessingStatus {
     Aborted = "aborted",
     Paused = "paused",
     InProgress = "inprogress",
-    Pending = "pending"
+    Pending = "pending",
+    Downloading = "downloading"
+}
+export declare enum MobileAssetsType {
+    Audio = "mobile_audios",
+    Photo = "mobile_photos"
 }
 export declare enum IngestVersions {
     V1 = "v1",
-    V2 = "v2"
+    V2 = "v2",
+    V3 = "v3",
+    V4 = "v4",
+    V5 = "v5"
+}
+export declare enum IngestTypes {
+    Drone = "drone",
+    ThreeSixty = "360"
 }
 export type DronesQueryParams = Omit<PaginationParams, "sort"> & {
     projectId: string;
@@ -19,6 +32,111 @@ export type DronesQueryParams = Omit<PaginationParams, "sort"> & {
     token: string;
     processingStatus: IngestProcessingStatus;
 };
+export type IngestPaginatedResponse<T> = {
+    items: T[];
+    page: number;
+    limit: number;
+    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;
+    consumed: boolean;
+    token: string;
+    flightDate: string;
+    flightGeolocation: string;
+    modelZip: string;
+    orthomosaicZip: string;
+    reportPdf: string;
+    processingLog: string;
+    uploadedBy: string;
+    processingStatus: IngestProcessingStatus | string;
+    modelCesiumAssetId: string;
+    updatedAt: string;
+    hasTusLinks: boolean;
+    hasSteps: boolean;
+    aerialShots: AerialShotItem[];
+};
+export type DroneUploadsResponse = IngestPaginatedResponse<DroneUploadItem>;
+export type DroneQueueResponse = {
+    size: number;
+    assetsDrone: DroneUploadItem[];
+};
 export type DroneUploadUpdateRequestPayload = {
     flightMetadata: {
         dateTime: string;
@@ -30,18 +148,87 @@ export type DroneUploadUpdateRequestPayload = {
         title: string;
         fileExtension: string;
     }[];
+    aerialShots: {
+        url: string;
+        title: string;
+        fileExtension: string;
+        gpsLatitude: string;
+        gpsLongitude: string;
+        gpsAltitude: string;
+    }[];
     projectName: string;
 };
 export type CalculateMeasuringOperationRequestPayload = {
     date: DateType;
-    points: [number, number][];
+    points: TuplePoint2D[];
     operation: string;
 };
 export type FlightImagesQueryParams = Partial<Omit<PaginationParams, "sort">> & {
     date: DateType;
 };
+export type AerialShotItem = {
+    id: number;
+    droneUploadId: number;
+    fileLink: string;
+    thumbnailLink: string;
+    gpsLatitude: string;
+    gpsLongitude: string;
+    gpsAltitude: string;
+};
 export type InspectionToolRequestPayload = {
     date: DateType;
     gpsAltitude: string;
     gpsCoordinates: string;
 };
+export type _360AssetsResponse = IngestPaginatedResponse<_360WalkV2>;
+export type _360AssetsCountsDay = {
+    day: number;
+    walks?: number;
+    mobilePhotos?: number;
+    [key: string]: JsonValue | undefined;
+};
+export type _360AssetsCountsResponse = {
+    days: _360AssetsCountsDay[];
+};
+export type _360QueueResponse = {
+    size: number;
+    assets360: _360WalkV2[];
+};
+export type _360FloorsResponse = IngestPaginatedResponse<_360FloorV2>;
+export type BimUploadItem = {
+    id: number;
+    projectId: string;
+    uploadedBy: string;
+    files: string[];
+    updatedAt: string;
+    archive?: string | null;
+};
+export type BimUploadsResponse = IngestPaginatedResponse<BimUploadItem>;
+export type IngestUploadInitResponse = {
+    id: number;
+    projectId: string;
+    token?: string;
+    projectName?: string;
+};
+export type MobileAssetsQueryParams = Partial<Omit<PaginationParams, "sort">> & {
+    projectId?: string;
+    project_id?: string;
+    assetType?: MobileAssetsType | string;
+    date?: DateType;
+    isPaginated?: boolean;
+};
+export type MobileCaptureAssetsResponse = IngestPaginatedResponse<{
+    id: string;
+    projectId?: string;
+    uploadedBy: string;
+    updatedAt: string;
+    assetType: string;
+    thumbnailUrl: string;
+}> | Array<{
+    id: string;
+    projectId?: string;
+    uploadedBy: string;
+    updatedAt: string;
+    assetType: string;
+    thumbnailUrl: string;
+}>;

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

@@ -1,10 +1,10 @@
-import { CountryCode, CountryId, DateTime, 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,22 +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",
     MissingRouterInfo = "missing_router_info",
-    PowerLost = "ac_failure",
-    UpsLowBattery = "low_battery"
+    AcFailure = "ac_failure",
+    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",
@@ -105,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 = {
@@ -292,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;
@@ -310,7 +319,7 @@ export declare enum KitStorageTransport {
 export type KitStorageRequestPayload = {
     kitId: number;
 };
-export type KitStorageResponsePayload = {
+export type KitStorage = {
     id: number;
     serial: string;
     status: string;
@@ -319,10 +328,48 @@ export type KitStorageResponsePayload = {
         formFactor: string;
     };
     model: string;
-    insertedAt: DateTime;
-    updatedAt: DateTime;
+    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

@@ -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

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

@@ -1,17 +1,97 @@
+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 CameraShareContext {
+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;
@@ -23,5 +103,5 @@ export type Notification = {
     targetFullname: string;
     targetEmail: string;
     readTimestamp: string | null;
-    context: CameraShareContext;
+    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;
+};