@evercam/api 1.0.0-213bdb2b3

package/dist/types/project.d.ts

@@ -0,0 +1,120 @@
+import { AdminCamera, Camera, CameraExid, DateTime, DateType, EntityByExid, Exid, PaginationParams } from "@/types";
+export type ProjectExid = Exid;
+export type ProjectsByExid = EntityByExid<Project>;
+export type Project = {
+    id: string | number;
+    exid: ProjectExid;
+    name: string;
+    status?: ProjectStatus;
+    insertedAt?: string;
+    startedAt?: string;
+    timezone?: string;
+    zohoId?: string;
+    cameras?: Array<Camera | AdminCamera>;
+    featureFlags: Array<ProjectFeatureFlag>;
+    owner?: {
+        email?: string;
+    };
+};
+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"
+}
+export type ProjectResponsePayload = {
+    data?: Project[];
+};
+export type Logo = {
+    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",
+    GateReportAutoVerify = "auto_publish",
+    GateReportMotionDetection = "motion_detection",
+    FullEmpty = "full_empty",
+    MediaHubSharing = "archives_sharing",
+    GateReportAnprBased = "anpr_sourced",
+    NoLicensePlate = "no_license_plate",
+    DefaultToProjectApp = "default_to_project_app",
+    Go = "evercam_go"
+}
+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>;
+    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: DateTime;
+    persona: string;
+};
+export type ProjectUsers = {
+    cameras: {
+        exid: string;
+        name: string;
+    }[];
+    users: Record<string, ProjectUserProperty[]>;
+};

package/dist/types/recording.d.ts

@@ -0,0 +1,124 @@
+import { ApiCredentials } from "@/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;
+};
+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",
+    Segmentation = "sam",
+    DepthAnalysis = "depthAnalysis"
+}
+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 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"
+}

package/dist/types/roi.d.ts

@@ -0,0 +1,26 @@
+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;
+};
+export declare enum RoiDirection {
+    Arrived = "arrived",
+    Left = "left",
+    Bidirectional = "arrived,left"
+}

package/dist/types/routeParams.d.ts

@@ -0,0 +1,50 @@
+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",
+    BeforeTimestamp = "beforeTimestamp",
+    OverlayType = "overlayType",
+    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"
+}
+export type TimelineUrlParams = Record<TimelineUrlParam | TimelineMediaUrlParams | TimelineBimUrlParams | TimelineExNvrRecordingsUrlParams | TimelineAnprUrlParams | TimelineMobileCaptureUrlParams | TimelineCommentsUrlParams, string | null>;

package/dist/types/router.d.ts

@@ -0,0 +1,67 @@
+import { Camera, PaginationParams, Project, Sim } from "@/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 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;
+};

package/dist/types/shared.d.ts

@@ -0,0 +1,208 @@
+import { DateType } from "@/types";
+type sortby = string;
+type sortDirection = "asc" | "desc";
+export type SortingUrlParam = `${sortby}|${sortDirection}`;
+export type BatteryReading = {
+    id: number;
+    voltage: number;
+    datetime: DateType;
+    serialNo: string;
+    iValue: number;
+    vpvValue: number;
+    ppvValue: number;
+    csValue: number;
+    errValue: number;
+    h19Value: number;
+    h20Value: number;
+    h21Value: number;
+    h22Value: number;
+    h23Value: number;
+    ilValue: number;
+    mpptValue: number;
+    loadValue: number;
+    pValue: number;
+    consumedAmphours: number;
+    socValue: number;
+    timeToGo: number;
+    alarm: string;
+    relay: string;
+    arValue: number;
+    bmvValue: number;
+    h1Value: number;
+    h2Value: number;
+    h3Value: number;
+    h4Value: number;
+    h5Value: number;
+    h6Value: number;
+    h7Value: number;
+    h8Value: number;
+    h9Value: number;
+    h10Value: number;
+    h11Value: number;
+};
+export interface PaginatedItems<T> {
+    from: number;
+    items: Array<T>;
+    limit: number;
+    page: number;
+    to: number;
+    total: number;
+}
+export declare enum UnitSystem {
+    Imperial = "imperial",
+    Metric = "metric"
+}
+export type Timestamp = string | number;
+export type Schedule = {
+    Friday: string[];
+    Monday: string[];
+    Saturday: string[];
+    Sunday: string[];
+    Thursday: string[];
+    Tuesday: string[];
+    Wednesday: string[];
+};
+export type ScheduleLowercase = {
+    friday: string[];
+    monday: string[];
+    saturday: string[];
+    sunday: string[];
+    thursday: string[];
+    tuesday: string[];
+    wednesday: string[];
+};
+export type PaginationParams = {
+    sort?: SortingUrlParam;
+    page?: number;
+    limit?: number;
+};
+export type LabsPaginationParams = {
+    sortBy?: string;
+    sortDirection?: "asc" | "desc";
+    page?: number;
+    limit?: number;
+};
+export declare enum MobileDevice {
+    Ios = "ios",
+    Android = "android"
+}
+export declare enum _3dViewer {
+    Itwin = "itwin",
+    Cesium = "cesium"
+}
+export declare enum SsoProvider {
+    Microsoft = "microsoft",
+    Google = "google",
+    Evercam = "evercam"
+}
+export declare enum InfoPage {
+    ThreeSixtyView = "360",
+    BIMView = "bim",
+    BimCompare = "bim-compare",
+    GateReport = "gate-report",
+    DroneView = "drone-view",
+    Compare = "compare",
+    Timeline = "timeline",
+    WeatherReport = "weather-report",
+    EvercamGo = "evercam-go"
+}
+export declare enum EvercamGoFeatures {
+    XRay = "xray",
+    MagicWand = "magic-wand",
+    Weather = "weather",
+    DownloadSnapshot = "download-snapshot",
+    LocalRecordings = "local-recordings",
+    MarkupTool = "markup-tool"
+}
+export declare enum DownloadTypes {
+    Jpeg = "jpeg",
+    Pdf = "pdf",
+    Csv = "csv"
+}
+export declare enum FeedbackContext {
+    CopilotMessage = "copilot_message"
+}
+export type FeedbackPayload<T> = {
+    id?: number;
+    user: string;
+    text: string;
+    type: T;
+    context: FeedbackContext;
+    messageId?: number;
+    conversationId?: number;
+};
+export type Stringified<T> = string & {
+    [P in keyof T]: {
+        "_ value": T[P];
+    };
+};
+export interface JSON {
+    stringify<T>(value: T, replacer?: (key: string, value: unknown) => unknown, space?: string | number): string & Stringified<T>;
+    parse<T>(text: Stringified<T>, reviver?: (key: unknown, value: unknown) => unknown): T;
+}
+export type Exid = string;
+export type EntityByExid<Entity extends unknown> = Record<Exid, Entity>;
+export type BatteryVoltage = {
+    date: DateType;
+    max_value: number;
+    min_value: number;
+};
+export type GlobalSearchQueryParams = PaginationParams & {
+    resource: "projects" | "users" | "cameras" | "companies" | "sims" | "routers";
+    term: string;
+    email: string;
+    featureFlag: string;
+};
+export type TimelineDateInterval = {
+    fromDate: string;
+    toDate: string;
+};
+export declare enum TimelinePrecision {
+    Year = "year",
+    Month = "month",
+    Week = "week",
+    Day = "day",
+    Hour = "hour",
+    Minute = "minute",
+    Events = "events"
+}
+export type EntityStatsQueryParams = {
+    period: "day" | "week" | "month";
+    startDate: string;
+    endDate: string;
+};
+export type EntityStat = {
+    period: string;
+    name: string;
+    count: number;
+};
+export declare enum TaskStatus {
+    Idle = "idle",
+    Loading = "loading",
+    Success = "success",
+    Error = "error"
+}
+export type PatchPayload<T> = Partial<T> & {
+    [K in keyof T]?: T[K] | undefined;
+};
+export declare enum PtzDirection {
+    Up = "up",
+    Down = "down",
+    Left = "left",
+    Right = "right"
+}
+export type MoveParams = {
+    cameraExid: string;
+    direction: PtzDirection;
+    isRecordingFromNvr: boolean;
+};
+export declare enum ZoomDirection {
+    In = "in",
+    Out = "out"
+}
+export type ZoomParams = {
+    cameraExid: string;
+    direction: ZoomDirection;
+    isRecordingFromNvr: boolean;
+};
+export {};