@evercam/api 1.0.0-003a1ed80

package/dist/api/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/api/types/shared.d.ts

@@ -0,0 +1,194 @@
+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 InfoPage {
+    ThreeSixtyView = "360",
+    BIMView = "bim",
+    BimCompare = "bim-compare",
+    GateReport = "gate-report",
+    DroneView = "drone-view",
+    Compare = "compare",
+    Timeline = "timeline",
+    WeatherReport = "weather-report"
+}
+export declare enum DownloadFileType {
+    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;
+    useContinuous: boolean;
+};
+export declare enum ZoomDirection {
+    In = "in",
+    Out = "out"
+}
+export type ZoomParams = {
+    cameraExid: string;
+    direction: ZoomDirection;
+    isRecordingFromNvr: boolean;
+};
+export {};

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

@@ -0,0 +1,196 @@
+import type { CameraExid, DateTime, DateType } from "@/types";
+export type ShareRequest = {
+    cameraId: string;
+    createdAt: DateType | number;
+    email: string;
+    id: number;
+    rights: string;
+    sharerEmail: string;
+    sharerName: string;
+    userId: number;
+};
+export type Share = {
+    cameraId: string;
+    createdAt: DateType | number;
+    email: string;
+    fullname: string;
+    id: number;
+    lastSeenAt: DateType;
+    rights: string;
+    sessionCount: number;
+    sharerEmail: string;
+    sharerId: number;
+    sharerName: string;
+    userId: number;
+    isUserAccessRestricted: boolean;
+};
+export type ShareRequestsResponsePayload = {
+    shareRequests: ShareRequest[];
+};
+export type ShareOwner = {
+    email: string;
+    fullname: string;
+    lastSeenAt: DateType;
+    sessionCount: number;
+};
+export type SharesResponsePayload = {
+    owner: ShareOwner;
+    shares: Share[];
+};
+export type ShareDeletionRequestPayload = {
+    email?: string;
+    key?: string;
+    origin?: string;
+};
+export type SharedUsersResponsePayload = Array<{
+    email: string;
+    name: string;
+}>;
+export type ShareCreateRequestPayload = {
+    email: string[] | string;
+    message?: string;
+    permission?: string;
+    rights: string;
+    apiId?: string;
+    apiKey?: string;
+};
+export type ShareProjectCamerasRequestPayload = {
+    email: string[];
+    cameraExids: CameraExid[];
+    message: string;
+    permission?: string;
+    rights: string;
+};
+export type UpdateUserRestrictionPayload = {
+    email: string[];
+    isUserAccessRestricted: boolean;
+};
+export type ShareCreateResponsePayload = {
+    shares: Share[];
+    shareRequests: ShareRequest[];
+};
+export type ShareRequestByKeyResponsePayload = {
+    shareRequests: Array<{
+        id: string;
+        email: string;
+        rights: string;
+        cameraId: string;
+        sharerName: string;
+        userId: string;
+        sharerEmail: string;
+        createdAt: DateType;
+    }>;
+};
+export type ResendShareRequestPayload = {
+    email: string;
+    apiId?: string;
+    apiKey?: string;
+};
+export declare enum SharePermission {
+    Minimum = "minimum",
+    Share = "minimal+share",
+    Full = "full",
+    Custom = "custom"
+}
+export declare enum ShareType {
+    Share = "share",
+    Request = "request"
+}
+export declare enum ShareRequestStatus {
+    Pending = -1,
+    Cancelled = -2,
+    Failed = -3,
+    Used = 1
+}
+export declare enum ShareVisibility {
+    PublicDiscoverable = "publicDiscoverable",
+    PublicUndiscoverable = "publicUndiscoverable",
+    Private = "private"
+}
+export type ProjectShare = {
+    id: number;
+    projectId: string;
+    userId: number;
+    email: string;
+    fullname: string;
+    sharerId: number;
+    sharerEmail: string;
+    sharerName: string;
+    role: "member" | "admin";
+    cameras: Record<string, string>;
+    message: string | null;
+    updatedAt: DateType;
+    insertedAt: DateType;
+};
+export type ProjectShareRequest = ProjectShare;
+export type ProjectShareResponse = {
+    projectShares: ProjectShare[];
+    projectShareRequests: ProjectShareRequest[];
+};
+export type AdminShare = {
+    sharerId: number;
+    sharerFullname: string;
+    sharerApiId: string;
+    sharerApiKey: string;
+    shareeId: number;
+    shareeFullname: string;
+    shareeApiId: string;
+    shareeApiKey: string;
+    shareeEmail: string;
+    cameraId: number;
+    exid: string;
+    projectId: string;
+    name: string;
+    id: number;
+    message: string;
+    createdAt: DateType;
+};
+export type CameraShareRequestPayload = {
+    email: string[];
+    rights: string;
+    message?: string;
+};
+export type ShareQueryParams = {
+    exid: string;
+    sharerFullname: string;
+    shareeFullname: string;
+    shareeEmail: string;
+};
+export type CameraShare = {
+    sharerId: number;
+    sharerFullname: string;
+    sharerApiId: string;
+    sharerApiKey: string;
+    shareeId: number;
+    shareeFullname: string;
+    shareeApiId: string;
+    shareeApiKey: string;
+    shareeEmail: string;
+    cameraId: number;
+    exid: string;
+    projectId: string;
+    name: string;
+    id: number;
+    message: string;
+    createdAt: DateTime;
+};
+export type CameraShareRequestsQueryParams = {
+    shareeEmail: string;
+    camera: string;
+    sharer: string;
+    status: string;
+};
+export type CameraShareRequest = {
+    id: number;
+    shareeEmail: string;
+    camera: string;
+    sharer: string;
+    message: number;
+    rights: string;
+    status: number;
+    projectId: string;
+    cameraExid: string;
+    apiId: string;
+    apiKey: number;
+    createdAt: DateTime;
+};

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

@@ -0,0 +1,114 @@
+import { DateTime, PaginationParams } from "@/types";
+export declare enum SmsCommands {
+    Cellular = "cellular",
+    Gpson = "gpson",
+    GPS = "gps",
+    IPUnblock = "ipunblock",
+    IOStatus = "iostatus",
+    IOSet = "ioset",
+    MonitoringStatus = "monitoring_status",
+    MobileOn = "mobileon",
+    MobileOff = "mobileoff",
+    Reboot = "reboot",
+    Restore = "restore",
+    RmsOn = "rms_on",
+    RmsConnect = "rms_connect",
+    RmsStatus = "rms_status",
+    SwitchSIM = "switch_sim",
+    Status = "status",
+    SshOn = "sshon",
+    SshOff = "sshoff",
+    Uci = "uci",
+    VpnOn = "vpnon",
+    VpnOff = "vpnoff",
+    VpnStatus = "vpnstatus",
+    WifiOn = "wifion",
+    WifiOff = "wifioff",
+    Wakeup = "wakeup",
+    WebOn = "webon",
+    WebOff = "weboff"
+}
+export declare enum SmsStatuses {
+    Delivered = "Delivered",
+    Accepted = "accepted",
+    Pending = "Pending"
+}
+export type SimCreateUpdatePayload = {
+    number: string;
+    simProvider: string;
+    billPayer?: string;
+    pin1?: string;
+    pin2?: string;
+    puk?: string;
+    iccid?: string;
+    description?: string;
+    cameraId: string[];
+};
+export type SimsQueryParams = PaginationParams & {
+    simProvider: string;
+    number: string;
+    billPayer: string;
+    iccid: string;
+    cameraName: string;
+    description: string;
+};
+export type Sim = {
+    id: number;
+    number: string;
+    simProvider: string;
+    billPayer: string;
+    lastSms: string;
+    pin1: string;
+    pin2: string;
+    puk: string;
+    iccid: string;
+    description: string;
+    lastSmsAt: DateTime;
+    cameras: {
+        name: string;
+        exid: string;
+        id: number;
+    }[];
+};
+export type SendSmsPayload = {
+    number: string;
+    smsMessage: string;
+};
+export type SendSmsResponse = {
+    status: number;
+    errorText: string;
+};
+export type SmsHistory = {
+    insertedAt: DateTime;
+    type: string;
+    status: string;
+    text: string;
+    deliveryDatetime: DateTime;
+};
+export type SmsHistoryResponse = {
+    singleSimSms: SmsHistory[];
+};
+export type Sms = {
+    id: number;
+    from: string;
+    fromName: string;
+    to: string;
+    toName: string;
+    messageId: string;
+    status: string;
+    text: string;
+    type: string;
+    insertedAt: DateTime;
+    deliveryDatetime: DateTime;
+};
+export type SmsQueryParams = PaginationParams & {
+    dateRange: string;
+    fromName: string;
+    toName: string;
+    fromNumber: string;
+    toNumber: string;
+    smsText: string;
+    smsType: string;
+    smsStatus: SmsStatuses;
+    deliveryDatetime: string;
+};

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

@@ -0,0 +1,142 @@
+import type { BBox, BoundingBox, DateType, Schedule, CameraExid, DateTime, DetectionModel, PaginationParams, PpeLabel, ProjectExid } from "@evercam/api/types";
+import { DetectionLabel, DownloadFileType } from "@evercam/api/types";
+export declare enum SiteAnalyticsMode {
+    Detections = "detections",
+    Segments = "segments"
+}
+export type SmartSearchOptionData = {
+    id?: string;
+    type: SmartSearchQueryComponentType;
+    value: DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | SmartSearchCondition | SmartSearchDateRange | string;
+};
+export type SmartSearchQueryPart = SmartSearchOptionData | [SmartSearchQueryPart] | SmartSearchQueryPart[];
+export declare enum SmartSearchQueryComponentType {
+    Condition = "condition",
+    Object = "object",
+    Area = "in_area",
+    Time = "time",
+    Operator = "operator",
+    Camera = "camera",
+    DateRange = "date_range"
+}
+export type SmartSearchDateRange = {
+    start: DateType;
+    end: DateType;
+};
+export type SmartSearchQueryComponentData = {
+    id: string;
+    type: SmartSearchQueryComponentType;
+    parts: [SmartSearchQueryPart];
+};
+export declare enum SmartSearchCondition {
+    InArea = "in_area",
+    Intersects = "intersects",
+    Time = "time"
+}
+export type SmartSearchConditionData = {
+    condition: SmartSearchCondition;
+    value: string | BoundingBox | DetectionLabel | Date;
+};
+export type SmartSearchQueryCondition = {
+    type: SmartSearchQueryConditionTypes;
+    target: SmartSearchQueryTargets;
+    operator?: SmartSearchQueryOperators;
+    attribute?: string;
+    value: string | number | string[];
+    reference?: {
+        target: SmartSearchQueryTargets;
+        attribute: string;
+        value: string | number | string[];
+    };
+    polygon?: BBox;
+};
+export type SmartSearchQuery = {
+    returnTargets: SmartSearchQueryTargets[];
+    rulesLogic: SmartSearchOperatorType;
+    rules: {
+        logic: SmartSearchOperatorType;
+        conditions: SmartSearchQueryCondition[];
+    }[];
+    returnType: SmartSearchQueryReturnType;
+};
+export declare enum SmartSearchQueryTargets {
+    Tracking = "tracking",
+    Segments = "segments"
+}
+export declare enum SmartSearchQueryReturnType {
+    All = "all",
+    FirstLastSeen = "first_last_seen"
+}
+export declare enum SmartSearchOperatorType {
+    And = "AND",
+    Or = "OR"
+}
+export declare enum SmartSearchQueryOperators {
+    Near = "near",
+    Far = "far",
+    Intersects = "intersects",
+    DoesNotIntersect = "does_not_intersect",
+    Inside = "inside",
+    Outside = "outside",
+    DistanceBelow = "distance_below",
+    DistanceAbove = "distance_above",
+    Area = "in_area",
+    Equal = "="
+}
+export declare enum SmartSearchQueryConditionTypes {
+    Selection = "selection",
+    Spatial = "spatial",
+    Area = "area",
+    Iou = "iou",
+    Near = "near",
+    Far = "far"
+}
+export type SmartSearchOptionValue = DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData;
+export type SmartSearchQueryParams = {
+    cameraExid: string;
+    name: string;
+    description: string;
+    query: {
+        req: SmartSearchQuery;
+        timeSchedule?: Schedule | undefined;
+    };
+    fromDate?: DateType;
+    toDate?: DateType;
+    author: string;
+    createdAt: DateType;
+    params?: Record<string, unknown>;
+};
+export type SavedQuery = {
+    description: string;
+    id: number;
+    query: {
+        req: SmartSearchQuery;
+        timeSchedule?: Schedule | undefined;
+    };
+    params: Record<string, string>;
+    components?: Omit<SmartSearchOptionData, "id">[];
+    toDate?: DateType;
+    createdAt?: DateType;
+    cameraExid: string;
+    name: string;
+    fromDate?: DateType;
+    author?: string;
+};
+export type DetectionsRequestParams = {
+    projectExid: ProjectExid;
+    cameraExids: CameraExid[];
+    fromDate?: DateTime;
+    toDate?: DateTime;
+    labels?: Array<DetectionLabel | PpeLabel>;
+    modelId?: DetectionModel;
+    trackId?: number;
+    thresholds?: string[];
+    excludeLabels?: Array<DetectionLabel | PpeLabel>;
+    mergedClasses?: Array<string>;
+    confidenceThreshold?: number;
+} & PaginationParams;
+export type DetectionsExportRequestParams = DetectionsRequestParams & {
+    fileType: DownloadFileType;
+    columns?: string[];
+    directDownload?: boolean;
+};