@evercam/api 1.0.0-003291add

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

@@ -0,0 +1,219 @@
+import { DateType } from "@evercam/api/types";
+export declare enum Operator {
+    AND = "and",
+    OR = "or"
+}
+type sortby = string;
+type sortDirection = "asc" | "desc";
+export type SortingUrlParam = `${sortby}|${sortDirection}`;
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+export type JsonObject = {
+    [key: string]: JsonValue;
+};
+export type JsonArray = JsonValue[];
+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 ScheduleUppercase = {
+    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 Schedule = ScheduleUppercase | ScheduleLowercase;
+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 = {
+    id?: number;
+    user: string;
+    text: string;
+    type: string;
+    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 TuplePoint2D = [number, number];
+export type Point2D = {
+    x: number;
+    y: number;
+};
+export type Point3D = {
+    x: number;
+    y: number;
+    z: number;
+};
+export type GeoPoint = {
+    lat: number;
+    lng: number;
+};
+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,58 @@
+import type { DateType } from "@evercam/api/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 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 ShareCreateResponsePayload = {
+    shares: Share[];
+    shareRequests: ShareRequest[];
+};
+export declare enum InviteStatus {
+    Pending = 0,
+    Cancelled = -1,
+    Used = 1,
+    Failed = -2
+}
+export declare enum ShareVisibility {
+    PublicDiscoverable = "publicDiscoverable",
+    PublicUndiscoverable = "publicUndiscoverable",
+    Private = "private"
+}

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

@@ -0,0 +1,114 @@
+import { PaginationParams } from "@evercam/api/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: string;
+    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: string;
+    type: string;
+    status: string;
+    text: string;
+    deliveryDatetime: string;
+};
+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: string;
+    deliveryDatetime: string;
+};
+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,287 @@
+import { BBox, BoundingBox, DateType, Schedule, ScheduleLowercase, CameraExid, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter, CameraFeatureFlag, TimelineDateInterval, Camera, AdminCamera, _360FloorV2, _360FloorId, PaginatedItems, DateRangeFilter } from "@evercam/api/types";
+import { DetectionLabel, DownloadFileType } from "@evercam/api/types";
+export declare enum SiteAnalyticsMode {
+    Detections = "detections",
+    Segments = "segments"
+}
+export type SmartSearchObjectPart = {
+    id?: string;
+    type: SmartSearchComponentType.Object;
+    value: DetectionLabel;
+};
+export type SmartSearchOperatorPart = {
+    id?: string;
+    type: SmartSearchComponentType.Operator;
+    value: SmartSearchOperatorType;
+};
+export type SmartSearchConditionPart = {
+    id?: string;
+    type: SmartSearchComponentType.Condition;
+    value: SmartSearchCondition | SmartSearchConditionData;
+};
+export type SmartSearchViewPart = {
+    id?: string;
+    type: SmartSearchComponentType.View;
+    value: SiteAnalyticsView;
+};
+export type SmartSearchAreaPart = {
+    id?: string;
+    type: SmartSearchComponentType.Area;
+    value: BBox;
+};
+export type SmartSearchTimePart = {
+    id?: string;
+    type: SmartSearchComponentType.Time;
+    value: Schedule | ScheduleLowercase;
+};
+export type SmartSearchDateRangePart = {
+    id?: string;
+    type: SmartSearchComponentType.DateRange;
+    value: DateRangeFilter;
+};
+export type SmartSearchPart = SmartSearchObjectPart | SmartSearchOperatorPart | SmartSearchConditionPart | SmartSearchViewPart | SmartSearchAreaPart | SmartSearchTimePart | SmartSearchDateRangePart;
+export type SmartSearchPartOrGroup = SmartSearchPart | SmartSearchPart[];
+export declare enum SmartSearchComponentType {
+    Condition = "condition",
+    Object = "object",
+    Area = "in_area",
+    Time = "time",
+    Operator = "operator",
+    View = "view",
+    DateRange = "date_range",
+    Heatmap = "heatmap"
+}
+export type SmartSearchPartType = SmartSearchComponentType | SmartSearchCondition;
+export type SmartSearchComponentData = {
+    id: string;
+    type: SmartSearchComponentType;
+    parts: SmartSearchPartOrGroup[];
+};
+export declare enum SmartSearchCondition {
+    InArea = "in_area",
+    Intersects = "intersects",
+    Time = "time"
+}
+export type SmartSearchConditionData = {
+    condition: SmartSearchCondition;
+    value: string | BoundingBox | DetectionLabel | Date;
+};
+type SmartSearchBackendConditionBase = {
+    target: SmartSearchTargets;
+};
+export type SmartSearchSelectionCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Selection;
+    operator: SmartSearchOperators;
+    attribute: string;
+    value: string | number | string[];
+};
+export type SmartSearchSpatialCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Spatial;
+    operator: SmartSearchOperators;
+    reference: {
+        target: SmartSearchTargets;
+        attribute: string;
+        value: string | number | string[];
+    };
+};
+export type SmartSearchAreaCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Area;
+    operator: SmartSearchOperators;
+    polygon: BBox;
+};
+export type SmartSearchGeoAreaCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.GeoArea;
+    operator: SmartSearchOperators;
+    polygon: BBox;
+};
+export type SmartSearchBackendQueryCondition = SmartSearchSelectionCondition | SmartSearchSpatialCondition | SmartSearchAreaCondition | SmartSearchGeoAreaCondition;
+export type SmartSearchBackendQuery = {
+    returnTargets: SmartSearchTargets[];
+    rulesLogic: SmartSearchOperatorType;
+    rules: {
+        logic: SmartSearchOperatorType;
+        conditions: SmartSearchBackendQueryCondition[];
+    }[];
+    returnType: SmartSearchReturnType;
+    timeSchedule?: Schedule;
+};
+export declare enum SmartSearchTargets {
+    Tracking = "tracking",
+    Segments = "segments"
+}
+export declare enum SmartSearchReturnType {
+    All = "all",
+    FirstLastSeen = "first_last_seen"
+}
+export declare enum SmartSearchOperatorType {
+    And = "AND",
+    Or = "OR"
+}
+export declare enum SmartSearchOperators {
+    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 SmartSearchConditionTypes {
+    Selection = "selection",
+    Spatial = "spatial",
+    Area = "area",
+    GeoArea = "in_geo_area",
+    Iou = "iou",
+    Near = "near",
+    Far = "far"
+}
+export type SmartSearchOptionValue = DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | DateRangeFilter | SiteAnalyticsView;
+export type SmartSearchBackendQueryPayload = {
+    name: string;
+    description: string;
+    query: SmartSearchBackendQuery;
+    fromDate?: DateType;
+    toDate?: DateType;
+    author: string;
+    createdAt: DateType;
+    params?: {
+        start: string;
+        end: string;
+    };
+};
+export type SavedQuery = {
+    description: string;
+    id: number;
+    query: SmartSearchBackendQuery;
+    params: Record<string, string>;
+    components?: Omit<SmartSearchPart, "id">[];
+    toDate?: DateType;
+    createdAt?: DateType;
+    cameraExid: string;
+    name: string;
+    fromDate?: DateType;
+    author?: string;
+};
+export type DetectionsRequestParams = {
+    projectExid: ProjectExid;
+    cameraExids: CameraExid[];
+    fromDate?: string;
+    toDate?: string;
+    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;
+};
+export type SmartSearchHeatmapPoint = {
+    coordinates: [number, number];
+    detectionsCount: number;
+};
+export type SmartSearchHeatmapData = {
+    label: string;
+    points: SmartSearchHeatmapPoint[];
+};
+export type SmartSearchNearConfig = {
+    sourceLabels: DetectionLabel[];
+    targetLabel?: DetectionLabel;
+};
+export type HeatmapIntersectionsRequestParams = CameraDateRangeFilter & SmartSearchNearConfig;
+export type SmartSearchSidebarItem = {
+    key: string;
+    displayLabel: string;
+    data: SmartSearchHeatmapData;
+    imagePath?: string;
+};
+export declare enum SiteAnalyticsViewType {
+    Camera = "camera",
+    ThreeSixty = "360"
+}
+export type SiteAnalyticsCameraView = {
+    type: SiteAnalyticsViewType.Camera;
+    id: CameraExid;
+    value: Camera | AdminCamera;
+};
+export type SiteAnalytics360View = {
+    type: SiteAnalyticsViewType.ThreeSixty;
+    id: _360FloorId;
+    value: _360FloorV2;
+};
+export type SiteAnalyticsView = SiteAnalyticsCameraView | SiteAnalytics360View;
+export type SiteAnalyticsProcessingStatusPayload = {
+    projectExid?: ProjectExid;
+    fromDate?: DateType;
+    toDate?: DateType;
+    cameraExid?: CameraExid;
+    drawingId?: string;
+    features?: CameraFeatureFlag[];
+};
+export type SiteAnalyticsProcessingStatus = {
+    projectExid: ProjectExid;
+    viewType: SiteAnalyticsViewType;
+    viewId: string;
+    feature: CameraFeatureFlag;
+    processedIntervals: TimelineDateInterval[];
+};
+export type SmartSearchRequestPayload = {
+    cameraExids?: CameraExid[];
+    drawingIds?: _360FloorId[];
+    walkIds?: string[];
+    markerIds?: string[];
+    payload: SmartSearchBackendQuery;
+    fromDate?: string;
+    toDate?: string;
+    page?: number;
+    pageSize?: number;
+    threshold?: number;
+};
+type SmartSearchResultItemBase = {
+    area: number;
+    bbox: BBox;
+    cameraExid?: CameraExid;
+    centroid: number[];
+    confidenceScore: number;
+    drawingId?: _360FloorId;
+    label: DetectionLabel;
+    modelId: DetectionModel;
+    projectExid: ProjectExid;
+    segmentId?: number;
+    trackId: number;
+    walkId?: string | number;
+};
+export type SmartSearchResultItemFirstLastSeen = SmartSearchResultItemBase & {
+    firstSeen: DateType;
+    firstSeenMarkerId?: string | number;
+    lastSeen: DateType;
+    lastSeenMarkerId?: string | number;
+};
+export type SmartSearchResultItemAll = SmartSearchResultItemBase & {
+    walkId?: string | number;
+    markerId?: string | number;
+    geolocation?: number[];
+    mask?: number[][];
+    timestamp: DateType;
+};
+type SmartSearchResultItemByType = {
+    [SmartSearchReturnType.FirstLastSeen]: SmartSearchResultItemFirstLastSeen;
+    [SmartSearchReturnType.All]: SmartSearchResultItemAll;
+};
+export type SmartSearchResponse<R extends SmartSearchReturnType = SmartSearchReturnType.FirstLastSeen> = PaginatedItems<SmartSearchResultItemByType[R]>;
+export type SmartSearchMinifiedPart = {
+    t: SmartSearchComponentType;
+    v: unknown;
+};
+export type SmartSearchMinifiedComponent = {
+    t: SmartSearchComponentType;
+    p: SmartSearchMinifiedPart[];
+};
+export {};