@evercam/api 1.0.0-a0da75d2b → 1.0.0-a1265cf0a

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,38 @@ export type Kit = {
     serial: string;
     status: KitStatus;
     powerSchedule: Schedule;
+    ups: boolean;
+    boxId: string;
     tags: Tag[];
+    storages: KitStorage[];
+    createdAt: string;
+};
+export declare enum KitSupportCheckId {
+    RouterSmsRoundTrip = "router_sms_round_trip",
+    NvrRecordingAllCameras = "nvr_recording_all_cameras",
+    CamerasHaveDeviceId = "cameras_have_device_id",
+    CamerasRecording = "cameras_recording"
+}
+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 +55,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 {
-    BatteryStats = "battery",
-    PanelPowerStats = "panel_power"
+    SolarCharger = "solar_charger",
+    PanelPower = "panel_power",
+    Fan = "fan",
+    FanTemperature = "fan_temperature"
 }
 export declare enum KitMetricPeriod {
     Last15Minutes = "now-15m",
@@ -105,55 +145,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 +283,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;
@@ -302,3 +306,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,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,67 @@
+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",
+    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"
+}
+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;
+}
+export type NotificationContext = CameraShareContext | CameraStatusChangeContext | MentionContext | TimelapseCreatedContext | TimelapseFailedContext | DroneProcessingContext | Processing360Context | ExportNotificationContext;
+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/observations.d.ts

@@ -0,0 +1,85 @@
+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;
+};
+export type ObservationEvent = {
+    id: number;
+    cameraExid: CameraExid;
+    projectExid: ProjectExid;
+    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;
+    reason: string | null;
+    isApproved: boolean | null;
+};
+export type ObservationEventsQueryParams = {
+    cameraExid?: CameraExid;
+    fromDate?: string;
+    toDate?: string;
+    required?: string;
+    compliant?: boolean;
+    hasHelmet?: boolean;
+    hasHighVisVest?: boolean;
+    hasGloves?: boolean;
+    hasGlasses?: boolean;
+    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;
+    fromDate?: string;
+    toDate?: string;
+    required?: string;
+    compliant?: boolean;
+    hasHelmet?: boolean;
+    hasHighVisVest?: boolean;
+    hasGloves?: boolean;
+    hasGlasses?: boolean;
+    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

@@ -0,0 +1,124 @@
+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 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;
+                    };
+                };
+            };
+        };
+    };
+}

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

@@ -0,0 +1,53 @@
+export type ActiveUsersRequestPayload = {
+    from?: string;
+    to?: string;
+    companyExid?: string;
+    projectExid?: string;
+    cameraExid?: string;
+};
+export type ActiveUsersResponsePayload = Array<{
+    date?: string;
+    dau?: number;
+    wau?: number;
+    mau?: number;
+}>;
+export declare enum ActiveUsersMetric {
+    DAU = "dau",
+    WAU = "wau",
+    MAU = "mau"
+}
+export type PosthogUser = {
+    id: string;
+    email: string;
+    isWeeklyActiveUser: number;
+    isMonthlyActiveUser: number;
+    eventsCount: number;
+};
+export type PosthogUsersRequestParams = {
+    companyExid?: string;
+    projectExid?: string;
+    cameraExid?: string;
+    productsActivityOnly?: boolean;
+    afterId?: string;
+    size?: number;
+};
+export type PosthogUsersResponse = {
+    data: PosthogUser[];
+    hasMore: boolean;
+    size: number;
+};
+export type PosthogUserParams = {
+    firstname?: string;
+    lastname?: string;
+    email: string;
+    telephone?: string;
+    country?: string;
+    isAdmin?: boolean;
+    persona?: string;
+    companyExid: string;
+    companyName: string;
+    isImpersonationLogin: boolean;
+    ImpersonatedUserEmail?: string;
+    ImpersonatedUserFirstname?: string;
+    impersonatedUserLastname?: string;
+};