@evercam/api 1.0.0-003291add

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

@@ -0,0 +1,247 @@
+import { AdminCamera, Camera, CameraExid, DateType, EntityByExid, Exid, Operator, PaginationParams } from "@evercam/api/types";
+export type ProjectExid = Exid;
+export type ProjectsByExid = EntityByExid<Project>;
+export type Project = {
+    archiveTier?: ProjectArchiveTier;
+    cameras?: Array<Camera | AdminCamera>;
+    camerasCount?: number;
+    camerasRestrictionType?: string;
+    companyId: number;
+    endDate: string;
+    exid: ProjectExid;
+    featureFlags: Array<ProjectFeatureFlag>;
+    geographicBounds?: unknown;
+    id: string | number;
+    insertedAt?: string;
+    name: string;
+    owner?: {
+        email?: string;
+    };
+    ownerEmail?: string;
+    ownerName?: string;
+    startedAt?: string;
+    status?: ProjectStatus;
+    timezone?: string;
+    unrestrictedCameras?: Camera[];
+    userId?: number;
+    zohoId?: string;
+};
+export type AdminProjectCameraRef = {
+    exid: string;
+    name: string;
+};
+export type AdminProjectListItem = {
+    id: number;
+    name: string;
+    status: ProjectStatus | string;
+    insertedAt: string;
+    timezone: string | null;
+    exid: ProjectExid;
+    endDate: string | null;
+    startDate: string | null;
+    archiveTier: ProjectArchiveTier | null;
+    featureFlags: Array<ProjectFeatureFlag | string>;
+    zohoId: string | null;
+    ownerEmail: string | null;
+    companyId: number | null;
+    companyName: string | null;
+    ownerName: string | null;
+    archived: boolean;
+    cameras?: AdminProjectCameraRef[];
+};
+export type AdminProjectDetail = AdminProjectListItem & {
+    userId: number;
+};
+export declare enum ProjectStatus {
+    ToStart = "To Start",
+    InProgress = "In Progress",
+    Completed = "Completed",
+    NotAplicable = "Not Applicable"
+}
+export declare enum ProjectArchiveTier {
+    Full = "Full",
+    Partial = "Partial",
+    Minimal = "Minimal",
+    ScheduledForDeletion = "Scheduled for Deletion",
+    No = "No"
+}
+export type UpdateCameraRestrictionPayload = {
+    isAccessRestricted?: boolean;
+};
+export type Logo = {
+    id: number;
+    projectId: number;
+    name: string;
+    url: string;
+};
+export type ProjectLogoResponsePayload = Logo[];
+export declare enum ProjectFeatureFlag {
+    AnprLegacy = "anpr_legacy",
+    DroneView = "drone_view",
+    Bim = "4d_bim",
+    BimItwin = "4d_bim_itwin",
+    BimForge = "4d_bim_forge",
+    ThreeSixtyView = "360_view",
+    NdaMc = "NDA/MC",
+    GateReport = "gate_report",
+    GateReportMotionDetection = "motion_detection",
+    FullEmpty = "full_empty",
+    MediaHubSharing = "archives_sharing",
+    GateReportAnprBased = "anpr_sourced",
+    NoLicensePlate = "no_license_plate",
+    DefaultToProjectApp = "default_to_project_app",
+    SmartSearch = "smart_search",
+    PpeMonitoring = "ppe_monitoring",
+    NoGdpr = "no_gdpr"
+}
+export type ProjectBatteryReading = {
+    exid: number;
+    voltage: number;
+    lastSeen: DateType;
+};
+export type ThumbnailData = {
+    cameraExid: CameraExid;
+    custom: boolean;
+    image: string;
+};
+export type ProjectsQueryParams = PaginationParams & {
+    name: string;
+    exid: string;
+    status: ProjectStatus;
+    cameras: string;
+    featureFlags: Array<ProjectFeatureFlag>;
+    featureFlagsOperator?: Operator;
+    archived: string;
+};
+export type ProjectCreateRequestPayload = {
+    projectExid?: string;
+    projectName: string;
+    ownerId: number;
+    cameras: string[];
+};
+export type ProjectCreateResponse = {
+    name: string;
+    exid: string;
+    id: number;
+    userId: number;
+    zohoId: string;
+};
+export type ProjectUpdateRequestPayload = {
+    name: string;
+    timezone: string;
+    featureFlags: ProjectFeatureFlag[];
+    cameras: string[];
+};
+export type ProjectStatusStats = {
+    nil: number;
+    Completed: number;
+    "In Progress": number;
+    "Not Applicable": number;
+    "To Start": number;
+};
+export type ProjectUserProperty = {
+    active: boolean;
+    activeOneMonth: boolean;
+    cameraExid: string;
+    cameraName: string;
+    cameraRights: string;
+    email: string;
+    eventsCount: number;
+    fullname: string;
+    id: number;
+    lastSeenAt: string;
+    persona: string;
+};
+export type ProjectUsers = {
+    cameras: {
+        exid: string;
+        name: string;
+    }[];
+    users: Record<string, ProjectUserProperty[]>;
+};
+export type ProjectRole = {
+    id: number;
+    name: string;
+};
+export type ProjectMember = {
+    id: string;
+    key?: string;
+    email: string;
+    fullname: string;
+    lastSeenAt?: string;
+    role: ProjectRole;
+    permissions?: string[];
+    subRoles?: Array<{
+        resourceId: string;
+        roleId: number;
+    }>;
+    company?: {
+        name: string;
+    } | null;
+};
+export type ProjectInvite = {
+    id?: string;
+    email: string;
+    role?: ProjectRole;
+    permissions?: string[];
+    subRoles?: Array<{
+        resourceId: string;
+        roleId: number;
+    }>;
+    invitedAt?: string;
+};
+export type ProjectMembersResponsePayload = {
+    users: ProjectMember[];
+    invites: ProjectInvite[];
+    errors: ProjectUserError[];
+};
+export type ProjectMembersRequestPayload = {
+    roleId: number;
+    emails: string[];
+    message?: string;
+    overrideRole?: Partial<{
+        permissions?: string[];
+        subRoles?: Array<{
+            resourceId: string;
+            roleId: number;
+        }>;
+    }>;
+};
+export type ProjectInviteMembersResponsePayload = {
+    users: ProjectMember[];
+    invites: ProjectInvite[];
+};
+export type PlaceholderThumbnailData = {
+    placeholder: string;
+};
+export type ProjectUserError = {
+    email: string;
+    error: Record<string, string[]>;
+};
+export type ProjectUsersResponsePayload = {
+    users: ProjectMember[];
+    invites: ProjectInvite[];
+    errors: ProjectUserError[];
+};
+export type ProjectStorageQueryParams = PaginationParams & {
+    cameraName: string;
+    cameraExid: CameraExid;
+    status: ProjectStorageStatus;
+};
+export type ProjectStorage = {
+    id: number;
+    cameraExid: CameraExid;
+    cameraName: string;
+    projectExid: string;
+    projectName: string;
+    status: ProjectStorageStatus;
+    requestor: string;
+    created_at: DateType;
+};
+export declare enum ProjectStorageStatus {
+    New = "new",
+    Pending = "pending",
+    Processing = "processing",
+    Completed = "completed",
+    Failed = "failed"
+}

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

@@ -0,0 +1,125 @@
+import { ApiCredentials } from "@evercam/api/types";
+import { CancelToken } from "axios";
+export type Snapshot = {
+    createdAt: string;
+    data: string;
+    status?: string;
+};
+export type NearestSnapshotRequestPayload = {
+    apiKey?: string;
+    apiId?: string;
+    token?: string;
+    cancelToken?: object;
+    includeImage?: boolean;
+};
+export type AvailableDaysRequestPayload = {
+    cameraId: string;
+    year: string;
+    month: string;
+    payload?: ApiCredentials;
+};
+export type AvailableDaysResponsePayload = {
+    days: Array<number>;
+};
+export type AvailableHoursRequestPayload = {
+    cameraId: string;
+    year: string;
+    month: string;
+    day: string;
+    payload?: ApiCredentials;
+    cancelToken?: CancelToken;
+};
+export type AvailableHoursResponsePayload = {
+    hours: Array<number>;
+};
+export type NearestSnapshotResponsePayload = {
+    snapshots: Array<{
+        createdAt: string;
+        data: string;
+        notes?: string;
+    }>;
+};
+export type SnapshotRangeRequestPayload = {
+    from: string;
+    to: string;
+    limit?: number;
+    page?: number;
+    schedule?: boolean;
+    count?: number;
+};
+export type SnapshotInstance = {
+    createdAt: string;
+    notes?: string;
+    data?: string;
+};
+export type SnapshotRangeResponsePayload = {
+    snapshots: Array<SnapshotInstance>;
+};
+export declare enum BrainTool {
+    Detections = "detections"
+}
+export declare enum CloudRecordingFrequency {
+    EverySecond = 60,
+    Every2Seconds = 30,
+    Every5Seconds = 12,
+    Every10Seconds = 6,
+    Every15Seconds = 4,
+    Every30Seconds = 2,
+    Every60Seconds = 1,
+    Every5Minutes = 5,
+    Every10Minutes = 10
+}
+export declare enum CloudRecordingDuration {
+    Infinity = -1,
+    Day = 1,
+    Week = 7,
+    Month = 30,
+    ThreeMonths = 90
+}
+export declare const CloudRecordingDurationLabel: Record<CloudRecordingDuration, string>;
+export declare enum CloudRecordingStatus {
+    On = "on",
+    Off = "off",
+    Paused = "paused",
+    OnScheduled = "on-scheduled"
+}
+export declare enum SnapshotExtractionInterval {
+    EverySecond = 1,
+    Every5Seconds = 5,
+    Every10Seconds = 10,
+    Every15Seconds = 15,
+    Every20Seconds = 20,
+    Every30Second = 30,
+    EveryMinute = 60,
+    Every5Minutes = 300,
+    Every10Minutes = 600,
+    Every15Minutes = 900,
+    Every20Minutes = 1200,
+    Every30Minutes = 1800,
+    EveryHour = 3600,
+    Every2Hours = 7200,
+    Every6Hours = 21600,
+    Every12Hours = 43200,
+    Every24Hours = 86400
+}
+export declare enum VpnServer {
+    None = "None",
+    OpenVPN1 = "OpenVPN1",
+    OpenVPN2 = "OpenVPN2",
+    OpenVPN3 = "OpenVPN3",
+    OpenVPN4 = "OpenVPN4",
+    OpenVPN5 = "OpenVPN5",
+    PPTP1 = "PPTP1",
+    PPTP2 = "PPTP2",
+    WireGuard1 = "WireGuard1",
+    WireGuard2 = "WireGuard2",
+    WireGuard3 = "WireGuard3",
+    WireGuard4 = "WireGuard4",
+    WireGuard5 = "WireGuard5",
+    WireGuard6 = "WireGuard6",
+    WireGuard7 = "WireGuard7",
+    WireGuard8 = "WireGuard8",
+    WireGuard9 = "WireGuard9",
+    WireGuard10 = "WireGuard10",
+    WgHub = "WgHub"
+}

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

@@ -0,0 +1,14 @@
+import type { DateType, PaginationParams } from "@evercam/api/types";
+export type RecycleBin = {
+    id?: number;
+    exid: string;
+    name: string;
+    type: string;
+    deletedBy: string;
+    deletedAt: DateType;
+};
+export type RecycleBinQueryParams = PaginationParams & {
+    name: string;
+    type: string;
+    deletedBy: string;
+};

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

@@ -0,0 +1,53 @@
+export type RingDevice = {
+    deviceId: string;
+    name: string;
+    deviceType: string;
+    firmwareVersion: string | null;
+    batteryLife: number | null;
+    location: string | null;
+    imported: boolean;
+    cameraExid?: string;
+    projectExid?: string;
+    projectName?: string;
+};
+export type RingDevicesResponsePayload = {
+    devices: RingDevice[];
+};
+export type RingImportDevicesPayload = {
+    deviceIds: string[];
+    projectExid: string;
+    deviceNames?: Record<string, string>;
+};
+export type RingImportResponsePayload = {
+    cameras: Array<{
+        exid: string;
+        name: string;
+    }>;
+    project: {
+        exid: string;
+        name: string;
+    };
+};
+export type RingMoveDevicePayload = {
+    projectExid: string;
+};
+export type RingMoveDeviceResponsePayload = {
+    status: string;
+    cameraExid: string;
+    projectExid: string;
+};
+export type RingLiveViewPayload = {
+    sdpOffer: string;
+};
+export type RingLiveViewResponse = {
+    sdpAnswer: string;
+    sessionUrl: string;
+    iceServers: Array<{
+        urls: string;
+        username?: string;
+        credential?: string;
+    }>;
+};
+export type RingStopLiveViewResponse = {
+    status: string;
+};

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

@@ -0,0 +1,27 @@
+export declare enum RoiType {
+    Gate = "gate",
+    AnprContext = "anpr_context",
+    ExclusionZone = "exclusion_zone",
+    WorkflowArea = "workflow_area",
+    SiteAnalytics = "site_analytics"
+}
+export declare enum RoiShapeType {
+    Polygon = "polygon",
+    Line = "line",
+    Direction = "direction",
+    Rectangle = "rectangle"
+}
+export type RoiShape = {
+    id: number | null;
+    name: string;
+    x1: number;
+    x2: number;
+    y1: number;
+    y2: number;
+    points?: [number, number][];
+};
+export declare enum RoiDirection {
+    Arrived = "arrived",
+    Left = "left",
+    Bidirectional = "arrived,left"
+}

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

@@ -0,0 +1,52 @@
+export type RouteParams = {
+    projectExid?: string;
+    cameraExid?: string;
+    timestamp?: string;
+    fromDate?: string;
+    toDate?: string;
+};
+export declare enum UrlParamValue {
+    True = "true",
+    False = "false"
+}
+export declare enum TimelineUrlParam {
+    CameraExid = "cameraExid",
+    Timestamp = "timestamp",
+    FromDate = "fromDate",
+    ToDate = "toDate",
+    Live = "live",
+    Video = "video",
+    OverlayType = "overlayType",
+    ShowOverlay = "showOverlay",
+    ShowCompare = "showCompare",
+    Sidebar = "sidebar",
+    ThreeSixtyId = "_360Id",
+    DroneId = "droneId",
+    MediaId = "mediaId"
+}
+export declare enum Timeline360UrlParams {
+    Show360 = "show360"
+}
+export declare enum TimelineDroneUrlParams {
+    ShowDrone = "showDrone"
+}
+export declare enum TimelineMediaUrlParams {
+    ShowMedia = "showMedia"
+}
+export declare enum TimelineBimUrlParams {
+    ShowBim = "showBim"
+}
+export declare enum TimelineExNvrRecordingsUrlParams {
+    ShowExNvrRecordings = "showExNvrRecordings"
+}
+export declare enum TimelineAnprUrlParams {
+    ShowAnpr = "showAnpr"
+}
+export declare enum TimelineMobileCaptureUrlParams {
+    ShowMobileCapture = "showMobileCapture"
+}
+export declare enum TimelineCommentsUrlParams {
+    ShowComments = "showComments",
+    SelectedCommentId = "selectedCommentId"
+}
+export type TimelineUrlParams = Record<TimelineUrlParam | TimelineMediaUrlParams | TimelineBimUrlParams | TimelineExNvrRecordingsUrlParams | TimelineAnprUrlParams | TimelineMobileCaptureUrlParams | TimelineCommentsUrlParams, string | null>;

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

@@ -0,0 +1,86 @@
+import { Camera, PaginationParams, Project, Sim } from "@evercam/api/types";
+export type RouterBillPayer = {
+    name: string;
+};
+export type SimProvider = {
+    name: string;
+};
+export type Router = {
+    id?: number;
+    kitId: number | null;
+    routerType: string;
+    routerUserId: string;
+    routerPassword: string;
+    serialNumber: number | null;
+    rmsUrl?: string;
+    externalHost?: string;
+    routerHttpPort: number | null;
+    vpnPassword: string;
+    vpnUserId: string;
+    vpnServer: string;
+    netbirdUrl: string;
+    status: RouterStatus;
+    powerType: PowerType;
+    powerSchedule: string;
+    battery?: {
+        lastVoltage: number;
+        lastSeen: string;
+    };
+    sims: Array<Pick<Sim, "id" | "number">>;
+    billPayers?: Array<RouterBillPayer>;
+    simProviders?: Array<SimProvider>;
+    projects?: Pick<Project, "exid" | "id" | "name">[];
+    cameras?: Pick<Camera, "id" | "name">[];
+};
+export declare enum PowerType {
+    Mains = "mains",
+    Battery = "battery",
+    Solar = "solar",
+    Generator = "generator",
+    Other = "other"
+}
+export declare enum PowerSchedule {
+    Schedule = "schedule",
+    FullTime = "24/7"
+}
+export declare enum RouterStatus {
+    Active = "active",
+    Inactive = "inactive"
+}
+export declare enum RouterScanInputMode {
+    Qr = "qr",
+    Manual = "manual"
+}
+export type RouterQueryParams = PaginationParams & {
+    routerType: string;
+    vpnServer: string;
+    serialNumber: string;
+};
+export type RouterCreatePayload = {
+    serialNumber: number;
+    vpnUserId?: string;
+    vpnPassword?: string;
+    routerType: string;
+    routerUserId?: string;
+    routerPassword?: string;
+    routerHttpPort: number;
+    powerType: PowerType;
+    powerSchedule: PowerSchedule;
+    vpnServer?: string;
+    netbirdUrl?: string;
+};
+export type RouterQRScanResult = {
+    raw: string;
+    timestamp: string;
+    sn?: string;
+    m?: string;
+    u?: string;
+    pw?: string;
+    t?: string;
+    s?: string;
+    p?: string;
+    i?: string;
+    b?: string;
+    boxId?: string;
+    isDuplicate?: boolean;
+};