@evercam/api 1.0.0-6fbecaded → 1.0.0-70861323c

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

@@ -0,0 +1,158 @@
+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",
+    Created = "created",
+    Failed = "failed",
+    Aborted = "aborted",
+    Paused = "paused",
+    InProgress = "inprogress",
+    Pending = "pending"
+}
+export declare enum MobileAssetsType {
+    Audio = "mobile_audios",
+    Photo = "mobile_photos"
+}
+export declare enum IngestVersions {
+    V1 = "v1",
+    V2 = "v2",
+    V3 = "v3",
+    V4 = "v4",
+    V5 = "v5"
+}
+export declare enum IngestTypes {
+    Drone = "drone",
+    ThreeSixty = "360"
+}
+export type DronesQueryParams = Omit<PaginationParams, "sort"> & {
+    projectId: string;
+    consumed: string;
+    token: string;
+    processingStatus: IngestProcessingStatus;
+};
+export type IngestPaginatedResponse<T> = {
+    items: T[];
+    page: number;
+    limit: number;
+    total: number;
+    pageCount?: number;
+};
+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;
+    aerialShots: AerialShotItem[];
+};
+export type DroneUploadsResponse = IngestPaginatedResponse<DroneUploadItem>;
+export type DroneQueueResponse = {
+    size: number;
+    assetsDrone: DroneUploadItem[];
+};
+export type DroneUploadUpdateRequestPayload = {
+    flightMetadata: {
+        dateTime: string;
+        gpsAltitude: string;
+        gpsCoordinates: string;
+    };
+    upload: {
+        url: string;
+        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: 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/{types → api/types}/kit.d.ts

@@ -1,10 +1,10 @@
-import { CountryCode, CountryId, DateType, Nvr, PaginationParams, PowerType, Project, Region, Router, Schedule } 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;
@@ -15,18 +15,52 @@ export type Kit = {
     router: Partial<Router>;
     serial: string;
     status: KitStatus;
+    powerSchedule: Schedule;
+    ups: boolean;
+    boxId: string;
+    tags: Tag[];
+    storages: KitStorage[];
+    createdAt: string;
 };
 export declare enum KitStatus {
     New = "new",
     Active = "active",
     Deployed = "deployed",
-    OfflineScheduled = "offline_scheduled",
     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"
+    NotRecordingCamera = "not_recording_camera",
+    FullSD = "full_sd",
+    FullStorage = "full_storage",
+    HddUnmounted = "hdd_unmounted",
+    NoHdd = "no_hdd",
+    MissingRouterInfo = "missing_router_info",
+    AcFailure = "ac_failure",
+    LowBattery = "low_battery",
+    GeneratorOff = "generator_off"
+}
+export declare enum KitMetricId {
+    SolarCharger = "solar_charger",
+    PanelPower = "panel_power",
+    Fan = "fan",
+    FanTemperature = "fan_temperature"
+}
+export declare enum KitMetricPeriod {
+    Last15Minutes = "now-15m",
+    Last1Hour = "now-1h",
+    Last24Hours = "now-24h",
+    Last7Days = "now-7d",
+    Last30Days = "now-30d",
+    Last90Days = "now-90d"
 }
 export declare enum GrafanaMetricId {
     SbcCpuLoad = "SbcCpuLoad",
@@ -74,7 +108,7 @@ export declare enum GrafanaMetricId {
     ExNvrMemoryUsage = "ExNvrMemoryUsage",
     ExNvrLogs = "ExNvrLogs"
 }
-export declare enum GrafanaChartType {
+export declare enum KitChartType {
     Stat = "stat",
     Gauge = "gauge",
     Graph = "graph",
@@ -101,7 +135,7 @@ export type GrafanaPanel = {
     name: keyof GrafanaMetricId;
     title: string;
     description: string;
-    type: GrafanaChartType;
+    type: KitChartType;
     datasource: GrafanaDataSource;
     targets: GrafanaTarget[];
     maxDataPoints?: number;
@@ -198,21 +232,32 @@ export type GrafanaFrame = {
         nanos?: Array<number[] | null>;
     };
 };
+export type KitMetricData = {
+    type: KitChartType;
+    chartProps?: Record<string, unknown>;
+};
 export type GrafanaQueryResult = {
     status: number;
     frames: GrafanaFrame[];
 };
-export type GrafanaMetricResponse = {
+export type GrafanaMetricData = KitMetricData & {
     results: {
         [key: string]: GrafanaQueryResult;
     };
-    type: GrafanaChartType;
 };
-export type GrafanaKitMetrics = Record<keyof typeof GrafanaMetricId, GrafanaMetricResponse>;
+export type EvercamMetricData = KitMetricData & {
+    stats: EvercamStats[];
+};
+export type GrafanaKitMetrics = Record<keyof typeof GrafanaMetricId, GrafanaMetricData>;
+export type EvercamStats = {
+    [k: string]: number | string;
+    timestamp: string;
+};
 export type KitQueryParams = PaginationParams & {
     name: string;
     serial: string;
     status: KitStatus;
+    tagId: number | number[];
 };
 export type AdminKit = {
     id: number;
@@ -260,9 +305,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;
@@ -270,3 +328,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",
@@ -92,7 +93,7 @@ export type MediaCreateRequestPayload = {
     cameraExid?: string;
     requestedBy?: string;
     notes?: string;
-    category?: ClipsCategory;
+    category?: MediaCategory | ClipsCategory;
     isUrgent?: boolean;
     storeAsType?: MediaType;
 };
@@ -107,6 +108,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

@@ -0,0 +1,57 @@
+export declare enum NotificationType {
+    CameraShare = "camera_share",
+    CameraStatusChange = "camera_status_changed",
+    Mention = "mention",
+    TimelapseCreated = "timelapse_created",
+    TimelapseFailed = "timelapse_failed",
+    DroneProcessing = "drone_processing_done",
+    Processing360 = "three_sixty_done"
+}
+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 type NotificationContext = CameraShareContext | CameraStatusChangeContext | MentionContext | TimelapseCreatedContext | TimelapseFailedContext | DroneProcessingContext | Processing360Context;
+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/{types → api/types}/nvr.d.ts

@@ -14,7 +14,8 @@ export type Nvr = {
 export declare enum NvrDeviceType {
     Rpi4 = "rpi4",
     Rpi5 = "rpi5",
-    OrinNano = "orin_nano"
+    OrinNano = "orin_nano",
+    Giraffe = "giraffe"
 }
 export declare enum NvrHddStatus {
     Error = "error",

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/planner.d.ts

@@ -0,0 +1,132 @@
+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";
+    coordinates: PolygonCoordinates;
+}
+export declare enum PlannerUrlParams {
+    SitePlanId = "site_plan_id",
+    IsNewSitePlan = "is_new_site_plan",
+    IsBoundsMode = "is_bounds_mode",
+    ProjectPosition = "project_position",
+    DealId = "deal_id"
+}
+export declare enum EDistortImageModes {
+    FreeRotate = "freeRotate",
+    Lock = "lock",
+    Rotate = "rotate",
+    Scale = "scale",
+    Pan = "drag"
+}
+export declare enum EMapTypes {
+    Blank = "Blank",
+    Satellite = "Satellite",
+    Street = "Street",
+    GoogleSatellite = "hybrid",
+    GoogleStreet = "roadmap",
+    GoogleTerrain = "terrain"
+}
+export declare enum EMarkers {
+    CameraMarker = "cameraMarker",
+    ThreeSixtyMarker = "threeSixtyMarkers"
+}
+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: {
+            _activeMode: {
+                handler: {
+                    disable(): void;
+                    completeShape(): void;
+                };
+            };
+            _modes: {
+                polygon: {
+                    handler: {
+                        enable(): void;
+                    };
+                };
+            };
+        };
+        edit: {
+            _modes: {
+                edit: {
+                    handler: {
+                        enable(): void;
+                        disable(): void;
+                        save(): void;
+                    };
+                };
+            };
+        };
+    };
+}