@evercam/api 1.0.0-003291add

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

@@ -0,0 +1,535 @@
+import { AuditLogActionType, DateType, EntityByExid, KitAlarm, NvrDeviceType, PaginationParams, PowerSchedule, PowerType, ProjectExid, ProjectFeatureFlag, Schedule, ScheduleLowercase } from "@evercam/api/types";
+import { DateRangeFilter } from "@evercam/api/types/time";
+import { GeoPoint } from "@evercam/api/types/shared";
+export type CameraExid = string;
+export type CamerasByExid = EntityByExid<Camera>;
+export type Camera = {
+    cameraPowerSchedule?: Schedule;
+    camPassword?: string;
+    camUsername?: string;
+    cloudRecordings: {
+        frequency: number;
+        schedule: Schedule;
+        status: string;
+        storageDuration: string;
+    };
+    liveViewFrequency: number | null;
+    createdAt: string;
+    description: string | null;
+    discoverable: boolean;
+    external: {
+        host: string;
+        http: {
+            camera: string;
+            jpg: string;
+            nvrJpg: string;
+            nvrPort: string;
+            port: string;
+        };
+        rtsp: {
+            h264: string;
+            port: string;
+        };
+    };
+    featureFlags: Array<CameraFeatureFlag>;
+    fovAngle: number;
+    fovRadius: number;
+    heading: number;
+    id: CameraExid;
+    exid: CameraExid;
+    isOnline: boolean;
+    isPowerScheduleActive: boolean;
+    isPublic: boolean;
+    lastOnlineAt: string;
+    lastPolledAt: string;
+    location: GeoPoint;
+    modelId: string;
+    modelName: string;
+    name: string;
+    nvrChannel: number;
+    nvrDeviceId: string;
+    nvrHost: string;
+    nvrHttpPort: number;
+    nvrModel: NvrModel;
+    nvrScheme: string;
+    nvrSnapshotEndpoint: string;
+    nvrStreamingEndpoint: string;
+    offlineReason: string;
+    owned: boolean;
+    owner: string;
+    pitch: string | null;
+    project: {
+        id: string;
+        name: string;
+    };
+    proxyUrl: {
+        hls: string;
+        rtmp: string;
+    };
+    ptz: boolean;
+    recordingFromNvr: boolean;
+    model?: CameraModel;
+    roll: string | null;
+    routerId: number;
+    status: CameraStatus;
+    streamingServer: string;
+    thumbnailUrl: string;
+    largeThumbnailUrl?: string;
+    timezone: string;
+    updatedAt: string;
+    vendorName: string;
+    isAccessRestricted?: boolean;
+    kitAlarms?: KitAlarm[];
+};
+export type AdminCamera = {
+    id: number;
+    exid: CameraExid;
+    name: string;
+    status: string;
+    description: string | null;
+    createdAt: string;
+    updatedAt: string;
+    lastOnlineAt: string | null;
+    lastPolledAt: string | null;
+    decommissionedAt: string | null;
+    deletedAt?: string | null;
+    projectId: number | null;
+    projectExid: string | null;
+    projectName: string | null;
+    projectFeatureFlags: Array<ProjectFeatureFlag | string>;
+    userId: number | null;
+    userEmail: string;
+    userFullname: string;
+    userApiId?: string;
+    userApiKey?: string;
+    isPublic: boolean;
+    sharedWithConstruction?: boolean;
+    timezone: string | null;
+    location?: GeoPoint | null;
+    fovAngle?: number | null;
+    fovRadius?: number | null;
+    heading?: number | null;
+    pitch?: number | null;
+    roll?: number | null;
+    cameraModel?: string | null;
+    cameraHost?: string | null;
+    cameraHttpPort?: number | null;
+    cameraRtspPort?: number | null;
+    cameraScheme?: string | null;
+    cameraUsername?: string | null;
+    cameraPassword?: string | null;
+    cameraPictureEndpoint?: string | null;
+    rtspUrl?: string | null;
+    httpUrl?: string | null;
+    deviceId?: string | null;
+    nvrId?: number | null;
+    nvrDeviceId?: string | null;
+    nvrModel?: NvrModel | string | null;
+    nvrHost?: string | null;
+    nvrHttpPort?: number | null;
+    nvrRtspPort?: number | null;
+    nvrScheme?: string | null;
+    nvrUsername?: string | null;
+    nvrPassword?: string | null;
+    nvrPictureEndpoint?: string | null;
+    streamEndpoint?: string | null;
+    routerId?: number | null;
+    kitId?: number | null;
+    powerType?: string | null;
+    powerSchedule?: ScheduleLowercase | Record<string, string[]>;
+    isPowerScheduleActive?: boolean;
+    discoverable?: boolean;
+    recordingFromNvr?: boolean;
+    cloudRecordingFrequency?: number | null;
+    cloudRecordingId?: number | null;
+    cloudRecordingStatus?: string | null;
+    cloudRecordingSchedule?: ScheduleLowercase | null;
+    cloudRecordingStorageDuration?: number | null;
+    liveViewFrequency?: number | null;
+    anprSources?: string[];
+    storageProviders?: string[];
+    featureFlags?: CameraFeatureFlag[];
+    zohoId?: string | null;
+    offlineReason?: string | null;
+    macAddress?: string | null;
+    type?: string[];
+    thumbnailUrl?: string;
+};
+export type CameraMapMarker = {
+    isOnline: boolean;
+    location: GeoPoint;
+    needFov: boolean;
+    rotation: number;
+    fovAngle: number;
+    fovRadius: number;
+};
+export declare enum CameraStatus {
+    Online = "online",
+    Offline = "offline",
+    OfflineScheduled = "offline_scheduled",
+    Decommissioned = "decommissioned",
+    OnHold = "on_hold",
+    Waiting = "waiting",
+    UnderMaintenance = "under_maintenance",
+    WaitingForSiteVisit = "waiting_for_site_visit"
+}
+export declare enum IntensityChange {
+    High = "High",
+    Moderate = "Moderate",
+    Low = "Low",
+    NoChange = "No change",
+    Default = "Default"
+}
+export declare const IntensityChangeColorMap: Record<IntensityChange, string>;
+export declare enum CameraFeatureFlag {
+    EdgeVideo = "edge_video",
+    BimCompare = "bim_compare",
+    TwoDBimCompare = "2d_bim_compare",
+    ForgeBIMCompare = "forge_bim_compare",
+    GateReport = "gate_report",
+    VideoStream = "video_stream",
+    WebRTC = "webrtc",
+    ANPR = "anpr",
+    ReverseANPR = "reverse_anpr",
+    PTZ = "ptz",
+    ObjectDetection = "object_detection",
+    Segmentation = "segmentation",
+    SegmentationAutoLabelling = "segmentation_auto_labelling",
+    PpeMonitoring = "ppe_monitoring",
+    PpeOwlv2 = "ppe_owlv2",
+    PpeGemini = "ppe_gemini",
+    PpeYolo = "ppe_yolo",
+    NoLiveView = "no_live_view",
+    Ring = "ring",
+    CloudOnly = "cloud_only"
+}
+export type CameraLogsRequestPayload = {
+    limit: number;
+    page: number;
+    types: string;
+    from: string;
+    to: string;
+};
+export type CameraUpdateRequestPayload = {
+    status?: string;
+    timezone?: string;
+    isPuclic?: boolean;
+    discoverable?: boolean;
+    fullname?: string;
+    lastOnline?: string;
+    owner?: string;
+    description?: string;
+    cameraPowerSchedule?: Schedule;
+    isPowerScheduleActive?: boolean;
+    powerSchedule?: object;
+    ptz?: boolean;
+    camUsername?: string;
+    camPassword?: string;
+    project?: {
+        id: string;
+        name: string;
+    };
+    modelName?: string;
+    host?: string;
+    nvrChannel?: number;
+    nvrPortHttp?: string;
+    externalRtspPort?: string;
+    name?: string;
+    h264Url?: string;
+    snapshotUrl?: string;
+    nvrSnapshotUrl?: string;
+    routerId?: string | number;
+    coordinates?: Array<number>;
+    heading?: number;
+    fovAngle?: number;
+    fovRadius?: number;
+    featureFlags: CameraFeatureFlag[];
+    isAccessRestricted?: boolean;
+    liveViewFrequency?: number | null;
+};
+export type CamerasResponsePayload = {
+    cameras?: Camera[];
+};
+export type CameraLogsResponsePayload = {
+    cameraExid: string;
+    cameraName: string;
+    logs?: Log[];
+    details?: {
+        customMessage?: string;
+    };
+};
+export type CameraStatusLog = {
+    start: string;
+    end: string;
+    state: CameraStatus;
+};
+export type Log = {
+    details: {
+        agent?: string;
+        country?: string;
+        countryCode?: string;
+        ip?: string;
+        with?: string;
+        message?: string;
+        status?: string;
+        type?: string;
+    };
+    insertedAt: string;
+    type: string;
+    who: string;
+};
+export type NvrConfig = {
+    apiUrl: string;
+    username?: string;
+    password?: string;
+    deviceId: string;
+    streamingUrl: string;
+    snapshotUrl: string;
+    bifUrl: string;
+};
+export declare enum NvrModel {
+    YCam = "y-cam",
+    Axis = "axis",
+    Dahua = "dahua",
+    Mobotix = "mobotix",
+    Hikvision = "hikvision",
+    Avigilion = "avigilion",
+    Hanwha = "hanwha",
+    Nxwitness = "nxwitness",
+    ExNvr = "ex_nvr"
+}
+export declare enum CameraModel {
+    YCam = "y-cam",
+    Axis = "axis",
+    Dahua = "dahua",
+    Mobotix = "mobotix",
+    Milesight = "milesight",
+    Hikvision = "hikvision",
+    Avigilion = "avigilion",
+    Hanwha = "hanwha",
+    Other = "other",
+    Ring = "ring"
+}
+export type Footage = {
+    cameraExid: string;
+    cameraName: string;
+    endDate: string | null;
+    startDate: string | null;
+};
+export type Hdd = {
+    id: number;
+    location: string;
+    serialNumber: string;
+    hddStatus: string;
+    shelfBlock: string;
+    type: string;
+    size: string;
+    format: string;
+    footages: Array<Footage>;
+    reportedCapacity: string;
+    reportedFreeSpace: string;
+    reportedProperty: string;
+    reportedPath: string;
+    reportedHddType: string;
+    errorStatus: string;
+    canExpand: boolean;
+};
+export type CameraPath = {
+    projectExid: ProjectExid;
+    cameraExid: CameraExid;
+};
+export type CheckCameraPortPayload = {
+    address: string;
+    port: number;
+    open: boolean;
+};
+export type CameraCreateRequestPayload = {
+    status: CameraStatus;
+    timezone?: string;
+    powerSchedule?: Schedule;
+    isPowerScheduleActive?: boolean;
+    ptz?: boolean;
+    name: string;
+    coordinates?: [number, number];
+    recordingFromNvr?: boolean;
+    CameraConfig: {
+        model: CameraModel;
+        scheme?: "http" | "https";
+        host: string;
+        httpPort: number;
+        username: string;
+        password: string;
+        rtspPort?: number;
+        pictureEndpoint?: string;
+        streamEndpoint?: string;
+    };
+    nvr?: {
+        model: NvrModel;
+        serial?: string;
+        deviceType?: NvrDeviceType;
+        macAddress?: string;
+        username: string;
+        password: string;
+        httpUrl: string;
+        rtspUrl?: string;
+    };
+    cloudRecording?: {
+        id?: number;
+        frequency: 1 | 2 | 4 | 5 | 6 | 10 | 12 | 30 | 60;
+        storageDuration: -1 | 1 | 7 | 30 | 90;
+        status: "on" | "off" | "paused" | "on_scheduled";
+        schedule: Schedule;
+    };
+    ownerId: number;
+    projectId: number;
+};
+export type CameraDeletePayload = {
+    verify: string;
+    password: string;
+};
+export type SaveNotePayload = {
+    noteType: string;
+    content: string;
+};
+export type CameraNote = {
+    id: number;
+    cameraId: number;
+    noteType: string;
+    content: string;
+    insertedAt: DateType;
+};
+export type CreateCameraNotePayload = {
+    id?: number;
+    cameraExid: CameraExid;
+    customMessage: string;
+    action: string;
+};
+export declare enum HddStatus {
+    Error = "error",
+    Idle = "idle",
+    NotExist = "notExist",
+    Unformatted = "unformatted",
+    Ok = "ok"
+}
+export type NvrQueryParams = PaginationParams & {
+    ownerId: number;
+    cameraName: string;
+    cameraExid: CameraExid;
+    cameraIp: string;
+    hddStatus: HddStatus;
+};
+export type OfflineCamera = {
+    id: number;
+    exid: string;
+    name: string;
+    fullname: string;
+    timezone: string;
+    status: CameraStatus;
+    zohoId: string;
+    externalHost: string;
+    nvrHttpPort: string;
+    externalRtspPort: string;
+    username: string;
+    password: string;
+    createdAt: DateType;
+    lastPolledAt: DateType;
+    lastOnlineAt: DateType;
+    powerType: PowerType;
+    powerSchedule: PowerSchedule;
+    batteryReadingsLastSeen: DateType;
+    batteryReadingsLastVoltage: number;
+    sims: {
+        billPayer: string;
+        number: string;
+        provider: string;
+    }[];
+};
+export type OfflineCameraQueryParams = PaginationParams & {
+    status: CameraStatus;
+    cameraExid: CameraExid;
+    cameraName: string;
+    timezone: string;
+    cameraOwner: string;
+    powerType: PowerType;
+    powerSchedule: PowerSchedule;
+    batteryReadingsLastVoltage: number;
+};
+export type OfflineCameraNote = {
+    action: AuditLogActionType;
+    username: string;
+    insertedAt: DateType;
+    cameraId: number;
+    customMessage: string;
+};
+export type OfflineCameraNoteResponse = {
+    publicNotes: OfflineCameraNote[];
+    privateNotes: OfflineCameraNote[];
+};
+export type SiteVisitCamerasQueryParams = PaginationParams & {
+    cameraOwner: string;
+};
+export type ProjectCamera = {
+    apiId: string;
+    apiKey: string;
+    exid: string;
+    id: number;
+    name: string;
+    ownerEmail: string;
+    ownerFullname: string;
+};
+export declare enum DuplicatedCameraFields {
+    Host = "host",
+    CameraHttpPort = "camera_http_port",
+    NvrHttpPort = "nvr_http_port",
+    NvrDeviceId = "nvr_device_id"
+}
+export type DuplicatedCameraObject = {
+    exid: string;
+    name: string;
+    cameraStatus: string;
+    crStatus: string;
+};
+export type DuplicatedCameraResponse = {
+    cameras: DuplicatedCameraObject[];
+    host: string;
+    cameraHttpPort: number;
+    nvrHttpPort: number;
+    nvrDeviceId: string;
+    count: number;
+};
+export type MergeDuplicatedCameraPayload = {
+    masterCamera: Record<string, unknown>;
+    shareeCameras: Record<string, unknown>;
+};
+export type FetchCameraQueryParams = PaginationParams & {
+    status: CameraStatus;
+    isPublic: boolean;
+    featureFlags: CameraFeatureFlag[];
+    ptz: boolean;
+    frequency: number;
+    channel: number;
+    cameraExid: CameraExid;
+    cameraExids: CameraExid[];
+    cameraName: string;
+    projectName: string;
+    timezone: string;
+    region: string;
+    cameraModel: CameraModel;
+    nvrModel: NvrModel;
+    cameraOwner: string;
+    ownerEmail: string;
+    isRecording: boolean;
+    cloudRecordingStorageDuration: number;
+    cameraIds: string;
+    hasLocation: boolean;
+    externalHttpPort: string;
+    externalRsptPort: string;
+    nvrHttpPort: string;
+};
+export declare enum BimType {
+    TwoD = "2D",
+    Forge = "Forge"
+}
+export type CameraDateRangeFilter = DateRangeFilter & {
+    cameraExid: CameraExid;
+};

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

@@ -0,0 +1,55 @@
+import { CameraExid, DateType, ProjectExid, PaginationParams } from "@evercam/api/types";
+export declare enum CommentsScope {
+    Recordings = "recordings",
+    ThreeSixty = "360",
+    Drone = "drone"
+}
+export declare enum CommentsLabel {
+    Info = "Info",
+    Danger = "Danger",
+    Restricted = "Restricted"
+}
+export type CommentsRequestPayload = {
+    scope: CommentsScope;
+};
+export type CommentsListRequestPayload = PaginationParams & {
+    projectExid?: ProjectExid;
+    cameraExid?: CameraExid;
+    fromDate?: string;
+    toDate?: string;
+    scope?: CommentsScope;
+    creatorEmail?: string;
+    content?: string;
+    includeArchived?: boolean;
+};
+export type Comment = {
+    fromDate?: string;
+    toDate?: string;
+    timestamp: string;
+    projectExid: ProjectExid;
+    updatedAt?: string;
+    id?: number;
+    cameraExid: CameraExid;
+    content: string;
+    createdAt?: string;
+    creatorEmail?: string;
+    creatorName?: string;
+    position2d?: [number, number];
+    position3d?: [number, number, number];
+    context?: Record<string, unknown>;
+    canDelete?: boolean;
+    archivedAt?: string;
+    label?: CommentsLabel;
+};
+export type CommentCreationRequestPayload = {
+    fromDate?: DateType;
+    toDate?: DateType;
+    timestamp?: DateType;
+    scope?: CommentsScope;
+    projectExid: ProjectExid;
+    cameraExid?: CameraExid;
+    content: string;
+    position2d?: number[];
+    position3d?: number[];
+    context?: Record<string, unknown>;
+};

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

@@ -0,0 +1,115 @@
+import type { DateType, PaginationParams } from "@evercam/api/types";
+export type CompanyUser = {
+    id: number;
+    fullname: string;
+    email: string;
+    eventsCount: number;
+    lastSeenAt: string;
+    active: boolean;
+};
+export type AdminCompanyUser = {
+    id: number;
+    email: string;
+    fullname: string;
+    lastLoginAt: string;
+};
+export type CompanyProject = {
+    exid: string;
+    name: string;
+    status: string;
+    startedAt: DateType;
+};
+export type AdminCompanyProject = {
+    id: number;
+    name: string;
+    status: string;
+    insertedAt: DateType;
+    exid: string;
+    endDate: string | null;
+    startDate: string | null;
+    archiveTier: string | null;
+};
+export type CompanyKit = {
+    id: number;
+    name: string;
+    serial: string;
+    status: string;
+    powerType: string;
+    countryName: string;
+    nvrId: string;
+    nvrSerial: string;
+    nvrVersion: string;
+    nvrNerves: boolean;
+    nvrModel: string;
+    nvrDeviceType: string;
+    routerId: string;
+    routerSerial: string;
+    projectExid: string;
+    projectName: string;
+    alarms: Array<string>;
+    sims: Array<{
+        id: number;
+        number: string;
+    }>;
+    cameras: Array<{
+        exid: string;
+        name: string;
+        status: string;
+    }>;
+};
+export type Company = {
+    id: number;
+    exid: string;
+    name: string;
+    zohoId: string;
+    domains: string;
+    linkedinUrl: string;
+    sessions: number;
+    projects: number;
+    cameras: number;
+    users: number;
+    activeUsers: number;
+    insertedAt: DateType;
+};
+export type CompanySummary = {
+    id: number;
+    name: string;
+    users: number;
+    insertedAt: DateType;
+    exid: string;
+    sessions: number;
+    projects: number;
+    zohoId: string;
+    domains: string;
+    linkedinUrl: string | null;
+    ssoProviders: string[];
+    cameras: number;
+    kits: number;
+};
+export type CompanyCameraSummary = {
+    id: number;
+    name: string;
+    status: string;
+    exid: string;
+    projectExid: string | null;
+    ownerEmail: string;
+    ownerFullname: string;
+    usersCount: number;
+};
+export type CompanyQueryParams = PaginationParams & {
+    name: string;
+    exid: string;
+    domains: string;
+    projects: string;
+    cameras: string;
+    users: string;
+    activeUsers: string;
+    sessions: string;
+};
+export type CompanyUpdatePayload = {
+    name: string;
+    exid: string;
+    linkedinUrl?: string;
+    domains?: string;
+    zohoId?: string;
+};