@evercam/api 1.0.0-000bac2be

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

@@ -0,0 +1,375 @@
+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: KitRegion;
+    id?: number;
+    jobId: number;
+    name: string;
+    nvr: Nvr;
+    powerType: PowerType;
+    project: Project;
+    projectId: number;
+    router: Partial<Router>;
+    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",
+    Active = "active",
+    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",
+    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",
+    SbcSystemLoad5MnAvg = "SbcSystemLoad5MnAvg",
+    SbcSystemLoad15MnAvg = "SbcSystemLoad15MnAvg",
+    SbcRamUsed = "SbcRamUsed",
+    SbcSwapUsed = "SbcSwapUsed",
+    SbcRootFsUsed = "SbcRootFsUsed",
+    SbcCpuCoresTotal = "SbcCpuCoresTotal",
+    SbcRamTotal = "SbcRamTotal",
+    SbcSwapTotal = "SbcSwapTotal",
+    SbcRootFsTotal = "SbcRootFsTotal",
+    SbcUptime = "SbcUptime",
+    SbcCpuStats = "SbcCpuStats",
+    SbcRamStats = "SbcRamStats",
+    SbcNetworkStats = "SbcNetworkStats",
+    SbcTimeSyncStats = "SbcTimeSyncStats",
+    SbcTemperatureStats = "SbcTemperatureStats",
+    SbcTimeSyncDriftStats = "SbcTimeSyncDriftStats",
+    CameraInfo = "CameraInfo",
+    CameraRecordingStateTimeline = "CameraRecordingStateTimeline",
+    CameraStreamInfo = "CameraStreamInfo",
+    LocalStorage = "LocalStorage",
+    StorageSpaceUsed = "StorageSpaceUsed",
+    RouterTemperature = "RouterTemperature",
+    RouterCpuLoad = "RouterCpuLoad",
+    RouterRamUsed = "RouterRamUsed",
+    RouterSystemLoad5MnAvg = "RouterSystemLoad5MnAvg",
+    RouterSwapTotal = "RouterSwapTotal",
+    RouterRamTotal = "RouterRamTotal",
+    RouterUptime = "RouterUptime",
+    RouterCpuCoresTotal = "RouterCpuCoresTotal",
+    RouterSignalReliability = "RouterSignalReliability",
+    RouterSINR = "RouterSINR",
+    RouterRSRP = "RouterRSRP",
+    RouterRSRQ = "RouterRSRQ",
+    RouterRSSI = "RouterRSSI",
+    RouterSignalStrengthStats = "RouterSignalStrengthStats",
+    RouterSignalQualityStats = "RouterSignalQualityStats",
+    RouterDataConsumptionStats = "RouterDataConsumptionStats",
+    BatteryVoltageAndCurrentStats = "BatteryVoltageAndCurrentStats",
+    PanelVoltageAndPowerStats = "PanelVoltageAndPowerStats",
+    ExNvrStatus = "ExNvrStatus",
+    ExNvrVersion = "ExNvrVersion",
+    ExNvrMemoryUsage = "ExNvrMemoryUsage",
+    ExNvrLogs = "ExNvrLogs"
+}
+export declare enum KitChartType {
+    Stat = "stat",
+    Gauge = "gauge",
+    Graph = "graph",
+    Table = "table",
+    StateTimeline = "state-timeline",
+    Logs = "logs",
+    TimeSeries = "timeseries",
+    BarChart = "barchart"
+}
+export type GrafanaTimeSeriesValue = number | string | null;
+export type GrafanaTimeSeriesValues = GrafanaTimeSeriesValue[][];
+export type GrafanaFieldConfig = {
+    displayNameFromDS?: string;
+    links?: string[];
+    color?: string;
+    custom?: {
+        lineInterpolation?: string;
+        fillOpacity?: number;
+        gradientMode?: string;
+        lineWidth?: number;
+        spanNulls?: boolean;
+        resultType?: string;
+    };
+    thresholds?: {
+        mode: string;
+        steps: Array<{
+            color: string;
+            value: number | null;
+        }>;
+    };
+    unit?: string;
+    decimals?: number;
+    interval?: number;
+};
+export type GrafanaField = {
+    name: string;
+    type: string;
+    typeInfo: {
+        frame: string;
+        nullable?: boolean;
+    };
+    config: GrafanaFieldConfig;
+    labels?: {
+        [key: string]: string;
+    };
+    values?: GrafanaTimeSeriesValues;
+};
+export type GrafanaSchemaMeta = {
+    type?: string;
+    typeVersion?: number[];
+    custom?: {
+        resultType?: string;
+        frameType?: string;
+    };
+    stats?: Array<{
+        displayName: string;
+        value: number;
+        unit?: string;
+    }>;
+    executedQueryString?: string;
+};
+export type GrafanaSchema = {
+    name?: string;
+    refId: string;
+    meta: GrafanaSchemaMeta;
+    fields: GrafanaField[];
+};
+export type GrafanaFrame = {
+    schema: GrafanaSchema;
+    data: {
+        values: GrafanaTimeSeriesValues;
+        nanos?: Array<number[] | null>;
+    };
+};
+export type KitMetricData = {
+    type: KitChartType;
+    chartProps?: Record<string, unknown>;
+};
+export type GrafanaQueryResult = {
+    status: number;
+    frames: GrafanaFrame[];
+};
+export type GrafanaMetricData = KitMetricData & {
+    results: {
+        [key: string]: GrafanaQueryResult;
+    };
+};
+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;
+    name: string;
+    serial: string;
+    status: string;
+    powerType: PowerType;
+    location: string;
+    countryId: number;
+    countryName: string;
+    countryRegion: string;
+    nvr: Nvr;
+    router: {
+        id: number;
+        serialNumber: number;
+        vpnUserId: string;
+        vpnPassword: string;
+        routerType: string;
+        routerUserId: string;
+        routerPassword: string;
+        routerHttpPort: number;
+        powerType: PowerType;
+        powerSchedule: Schedule;
+        vpnServer: string;
+        netbirdUrl: string;
+        sims: {
+            id: number;
+            number: string;
+        }[];
+    };
+    project: {
+        id: number;
+        exid: string;
+        name: string;
+        timezone: string;
+        status: string;
+        zohoId: string;
+        insertedAt: DateType;
+    };
+};
+export type KitCreatePayload = {
+    projectId?: number;
+    countryCode?: string;
+    name: string;
+    status: KitStatus;
+    powerType: PowerType;
+    config: {
+        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;
+    kitSerial: string;
+    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/api/types/media.d.ts

@@ -0,0 +1,120 @@
+import type { CameraExid, Exid, DateType } from "@evercam/api/types";
+export type MediaExid = Exid;
+export type Media = {
+    project_exid?: string;
+    cameraExid?: CameraExid;
+    cameraName: string;
+    cameraTimezone: string;
+    createdAt: string;
+    fromDate: string;
+    id: number;
+    requesterEmail: string;
+    requesterName: string;
+    title: string;
+    toDate: string;
+    url?: string;
+    exid?: MediaExid;
+    embedCode?: string;
+    fileName?: string;
+    format?: string;
+    frames?: number;
+    link?: string;
+    public?: boolean;
+    type: MediaType;
+    status?: MediaStatus;
+    projectExid?: string;
+    thumbnailUrl?: string;
+    mediaUrl?: string;
+    camera?: string;
+};
+export declare enum MediaType {
+    EditedImage = "edit",
+    ExternalUrl = "url",
+    Clip = "clip",
+    File = "file",
+    LocalClip = "local_clip",
+    XRay = "x-ray",
+    Timelapse = "timelapse",
+    Compare = "compare",
+    MobileAsset = "mobile-asset"
+}
+export declare enum MediaFileType {
+    Gif = "gif",
+    Mp4 = "mp4",
+    Png = "png",
+    Pdf = "pdf",
+    Jpeg = "jpeg",
+    Csv = "csv"
+}
+export declare enum MediaStatus {
+    Pending = "Pending",
+    Creating = "Creating",
+    Processing = "Processing",
+    Extracting = "Extracting",
+    Uploading = "Uploading",
+    Completed = "Completed",
+    Failed = "Failed",
+    NoData = "No Data"
+}
+export declare enum MediaStatusId {
+    Pending = 0,
+    Processing = 1,
+    Completed = 2,
+    Failed = 3
+}
+export type MediaFilterQueryParams = {
+    title?: string;
+    sort?: string;
+    sortBy?: string;
+    dateRange?: string | string[];
+    fromDate?: string;
+    toDate?: string;
+    cameraName?: string;
+    requesterEmail?: string;
+    type?: MediaType;
+    cameraExid?: string;
+    page?: number;
+    limit?: number;
+    camera?: string;
+};
+export type MediaUpdateRequestPayload = {
+    name?: string;
+    title?: string;
+    public?: boolean;
+};
+export type MediaCreateRequestPayload = {
+    fromDate: DateType;
+    toDate: DateType;
+    title: string;
+    type: MediaType;
+    fileUrl?: string;
+    fileExtension?: string;
+    url?: string;
+    content?: string;
+    cameraExid?: string;
+    requestedBy?: string;
+    notes?: string;
+    category?: MediaCategory | ClipsCategory;
+    isUrgent?: boolean;
+    storeAsType?: MediaType;
+};
+export type MediaUsersResponsePayload = Array<{
+    id: number;
+    email: string;
+    name: string;
+}>;
+export declare enum ClipsCategory {
+    HealthSafetySecurity = "health_safety_security",
+    Legal = "legal",
+    Marketing = "marketing",
+    BestPracticies = "best_practices"
+}
+export declare enum MediaCategory {
+    Weather = "weather",
+    SmartSearch = "smart_search"
+}
+export type MediaDeleteRequestPayload = {
+    timelapseIds: (string | number)[];
+    compareIds: (string | number)[];
+    archiveIds: (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/nvr.d.ts

@@ -0,0 +1,36 @@
+import type { NvrModel } from "@evercam/api/types";
+export type Nvr = {
+    id?: number;
+    deviceType: NvrDeviceType;
+    serial: string;
+    model: NvrModel;
+    httpUrl: string;
+    rtspUrl: string;
+    macAddress: string;
+    username: string;
+    password: string;
+    nerves: boolean;
+};
+export declare enum NvrDeviceType {
+    Rpi4 = "rpi4",
+    Rpi5 = "rpi5",
+    OrinNano = "orin_nano",
+    Giraffe = "giraffe"
+}
+export declare enum NvrHddStatus {
+    Error = "error",
+    Idle = "idle",
+    NotExist = "notexist",
+    Ok = "ok",
+    Unformatted = "unformatted"
+}
+export type NvrCreatePayload = {
+    serial?: string;
+    httpUrl: string;
+    rtspUrl?: string;
+    deviceType?: NvrDeviceType;
+    model: NvrModel;
+    username: string;
+    password: string;
+    kitId?: number;
+};

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;
+};