@evercam/api 1.0.0-ca4bfd0ab → 1.0.0-cc52e4032

package/dist/{types → api/types}/project.d.ts

@@ -1,4 +1,4 @@
-import { AdminCamera, Camera, CameraExid, DateTime, DateType, EntityByExid, Exid, PaginationParams } from "@/types";
+import { AdminCamera, Camera, CameraExid, DateRangeFilter, DateTime, DateType, EntityByExid, Exid, PaginationParams } from "@/types";
 export type ProjectExid = Exid;
 export type ProjectsByExid = EntityByExid<Project>;
 export type Project = {
@@ -10,11 +10,16 @@ export type Project = {
     startedAt?: string;
     timezone?: string;
     zohoId?: string;
+    userId?: number;
     cameras?: Array<Camera | AdminCamera>;
+    unrestrictedCameras?: Array<Camera | AdminCamera>;
     featureFlags: Array<ProjectFeatureFlag>;
     owner?: {
         email?: string;
     };
+    ownerEmail?: string;
+    ownerName?: string;
+    camerasRestrictionType?: string;
 };
 export declare enum ProjectStatus {
     ToStart = "To Start",
@@ -31,6 +36,9 @@ export declare enum ProjectArchiveTier {
 export type ProjectResponsePayload = {
     data?: Project[];
 };
+export type UpdateCameraRestrictionPayload = {
+    isAccessRestricted?: boolean;
+};
 export type Logo = {
     name: string;
     url: string;
@@ -51,7 +59,9 @@ export declare enum ProjectFeatureFlag {
     MediaHubSharing = "archives_sharing",
     GateReportAnprBased = "anpr_sourced",
     NoLicensePlate = "no_license_plate",
-    DefaultToProjectApp = "default_to_project_app"
+    DefaultToProjectApp = "default_to_project_app",
+    SmartSearch = "smart_search",
+    PpeMonitoring = "ppe_monitoring"
 }
 export type ProjectBatteryReading = {
     exid: number;
@@ -117,3 +127,41 @@ export type ProjectUsers = {
     }[];
     users: Record<string, ProjectUserProperty[]>;
 };
+export type ProjectDateRangeFilter = DateRangeFilter & {
+    projectExid: ProjectExid;
+};
+export type ProjectRole = {
+    id: string;
+    name: string;
+};
+export type ProjectMember = {
+    id: string;
+    email: string;
+    fullname: string;
+    role: ProjectRole;
+};
+export type ProjectInvite = {
+    id?: string;
+    email: string;
+    role?: ProjectRole;
+    invitedAt?: string;
+};
+export type ProjectMembersResponsePayload = {
+    users: ProjectMember[];
+    invites: ProjectInvite[];
+};
+export type ProjectMembersRequestPayload = {
+    roleId: number;
+    emails: string[];
+    overrideRole?: Partial<{
+        permissions?: string[];
+        subRoles?: Array<{
+            resourceId: string;
+            roleId: number;
+        }>;
+    }>;
+};
+export type ProjectInviteMembersResponsePayload = {
+    users: ProjectMember[];
+    invites: ProjectInvite[];
+};

package/dist/{types → api/types}/recording.d.ts

@@ -56,8 +56,7 @@ export type SnapshotRangeResponsePayload = {
 };
 export declare enum BrainTool {
     Detections = "detections",
-    Segmentation = "sam",
-    DepthAnalysis = "depthAnalysis"
+    Segmentation = "sam"
 }
 export declare enum CloudRecordingFrequency {
     EverySecond = 60,

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

@@ -0,0 +1,14 @@
+import type { DateType, PaginationParams } from "@/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/{types → api/types}/roi.d.ts

@@ -9,7 +9,8 @@ export declare enum RoiShapeType {
     Polygon = "polygon",
     Line = "line",
     Direction = "direction",
-    Rectangle = "rectangle"
+    Rectangle = "rectangle",
+    ROIBox = "ROIBox"
 }
 export type RoiShape = {
     id: number | null;

package/dist/{types → api/types}/routeParams.d.ts

@@ -16,8 +16,9 @@ export declare enum TimelineUrlParam {
     ToDate = "toDate",
     Live = "live",
     Video = "video",
-    BeforeTimestamp = "beforeTimestamp",
     OverlayType = "overlayType",
+    ShowOverlay = "showOverlay",
+    ShowCompare = "showCompare",
     Sidebar = "sidebar",
     ThreeSixtyId = "_360Id",
     DroneId = "droneId",
@@ -45,6 +46,7 @@ export declare enum TimelineMobileCaptureUrlParams {
     ShowMobileCapture = "showMobileCapture"
 }
 export declare enum TimelineCommentsUrlParams {
-    ShowComments = "showComments"
+    ShowComments = "showComments",
+    SelectedCommentId = "selectedCommentId"
 }
 export type TimelineUrlParams = Record<TimelineUrlParam | TimelineMediaUrlParams | TimelineBimUrlParams | TimelineExNvrRecordingsUrlParams | TimelineAnprUrlParams | TimelineMobileCaptureUrlParams | TimelineCommentsUrlParams, string | null>;

package/dist/{types → api/types}/shared.d.ts

@@ -90,11 +90,6 @@ 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",
@@ -105,7 +100,7 @@ export declare enum InfoPage {
     Timeline = "timeline",
     WeatherReport = "weather-report"
 }
-export declare enum DownloadTypes {
+export declare enum DownloadFileType {
     Jpeg = "jpeg",
     Pdf = "pdf",
     Csv = "csv"

package/dist/{types → api/types}/shares.d.ts

@@ -22,6 +22,7 @@ export type Share = {
     sharerId: number;
     sharerName: string;
     userId: number;
+    isUserAccessRestricted: boolean;
 };
 export type ShareRequestsResponsePayload = {
     shareRequests: ShareRequest[];
@@ -60,6 +61,10 @@ export type ShareProjectCamerasRequestPayload = {
     permission?: string;
     rights: string;
 };
+export type UpdateUserRestrictionPayload = {
+    email: string[];
+    isUserAccessRestricted: boolean;
+};
 export type ShareCreateResponsePayload = {
     shares: Share[];
     shareRequests: ShareRequest[];
@@ -92,7 +97,6 @@ export declare enum ShareType {
     Request = "request"
 }
 export declare enum ShareRequestStatus {
-    All = "",
     Pending = -1,
     Cancelled = -2,
     Failed = -3,

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

@@ -0,0 +1,163 @@
+import type { BBox, BoundingBox, DateType, Schedule, CameraExid, DateTime, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter } from "@evercam/api/types";
+import { DetectionLabel, DownloadFileType } from "@evercam/api/types";
+export declare enum SiteAnalyticsMode {
+    Detections = "detections",
+    Segments = "segments"
+}
+export type SmartSearchQueryPartData = {
+    id?: string;
+    type: SmartSearchQueryPartType;
+    value: DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | SmartSearchCondition | SmartSearchDateRange | string;
+};
+export type SmartSearchQueryPart = SmartSearchQueryPartData | SmartSearchQueryPartData[];
+export declare enum SmartSearchQueryComponentType {
+    Condition = "condition",
+    Object = "object",
+    Area = "in_area",
+    Time = "time",
+    Operator = "operator",
+    Camera = "camera",
+    DateRange = "date_range",
+    Heatmap = "heatmap"
+}
+export type SmartSearchQueryPartType = SmartSearchQueryComponentType | SmartSearchCondition;
+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<SmartSearchQueryPartData, "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;
+};
+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;
+};

package/dist/{types → api/types}/snapshots.d.ts

@@ -48,3 +48,12 @@ export type DeleteSnapshotQueryParams = {
     adminEmail: string;
     adminFullname: string;
 };
+export type TransferCloudRecordingsQueryParams = {
+    targetCameraExid: CameraExid;
+    fromDate: DateType;
+    toDate: DateType;
+    overwriteExistingSnapshots?: boolean;
+    keepSourceSnapshots?: boolean;
+    adminEmail?: string;
+    adminFullname?: string;
+};

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

@@ -0,0 +1,55 @@
+export type SsoProvider = {
+    id: number;
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};
+export type SsoUpdatePayload = {
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};
+export type SsoCreatePayload = {
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};

package/dist/{types → api/types}/streaming.d.ts

@@ -1,24 +1,4 @@
-import { MilesightCameraNetworkConfiguration, MilesightCameraOsdConfiguration, MilesightCameraSdCardInfo, MilesightCameraSystemSettings, MilesightCameraTimeInfo, MilesightCameraVideoConfig, TaskStatus, DateTime_Z_micros, KitMetricData } from "@/types";
-export declare enum ExNvrHealthCheckTaskId {
-    ExNvrLogin = "exNvrLogin",
-    ExNvrConfigCheck = "exNvrGetDeviceInfo",
-    ExNvrSystemStatus = "exNvrSystemStatus",
-    ExNvrRecordings = "exNvrGetRecordings",
-    CameraSystemConfigCheck = "getCameraSystemInfo",
-    CameraTimeConfigCheck = "getCameraTimeInfo",
-    CameraStreamsConfigCheck = "getCameraStreamsInfo",
-    CameraNetworkConfigCheck = "getCameraNetworkInfo",
-    CameraOsdConfigCheck = "getCameraOsdInfo",
-    CameraStorageConfigCheck = "getCameraStorageInfo"
-}
-export type ExNvrHealthCheckTaskResult<T extends ExNvrHealthCheckTaskId> = T extends ExNvrHealthCheckTaskId.ExNvrLogin ? ExNvrLoginResponse : T extends ExNvrHealthCheckTaskId.ExNvrConfigCheck ? ExNvrDeviceConfig : T extends ExNvrHealthCheckTaskId.ExNvrSystemStatus ? ExNvrSystemStatus : T extends ExNvrHealthCheckTaskId.ExNvrRecordings ? ExNvrRecordingInterval[] : T extends ExNvrHealthCheckTaskId.CameraStreamsConfigCheck ? MilesightCameraVideoConfig : T extends ExNvrHealthCheckTaskId.CameraSystemConfigCheck ? MilesightCameraSystemSettings : T extends ExNvrHealthCheckTaskId.CameraTimeConfigCheck ? MilesightCameraTimeInfo : T extends ExNvrHealthCheckTaskId.CameraNetworkConfigCheck ? MilesightCameraNetworkConfiguration : T extends ExNvrHealthCheckTaskId.CameraOsdConfigCheck ? MilesightCameraOsdConfiguration : T extends ExNvrHealthCheckTaskId.CameraStorageConfigCheck ? MilesightCameraSdCardInfo : never;
-export type ExNvrHealthCheckTask<T extends ExNvrHealthCheckTaskId> = {
-    id: T;
-    status: TaskStatus;
-    duration?: number;
-    result?: ExNvrHealthCheckTaskResult<T>;
-    error?: Error;
-};
+import { DateTime_Z_micros, KitMetricData } from "@/types";
 export type ExNvrLoginResponse = {
     accessToken: string;
 };
@@ -59,8 +39,7 @@ export type ExNvrDeviceConfig = {
     timezone: string;
 };
 export declare enum ExNvrFootageAvailableStatus {
-    Active = "Active",
-    NotActive = "Not Active",
+    Available = "Available",
     NotAvailable = "Not Available"
 }
 export declare enum ExNvrDeviceState {

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

@@ -0,0 +1,11 @@
+export declare enum PerformanceStatus {
+    Pending = "pending",
+    Done = "done"
+}
+export declare enum WebGLExtensions {
+    OESTextureFloat = "OES_texture_float",
+    EXTFloatBlend = "EXT_float_blend",
+    EXTTextureFilterAnisotropic = "EXT_texture_filter_anisotropic",
+    OESElementIndexUint = "OES_element_index_uint",
+    WEBGLDebugRendererInfo = "WEBGL_debug_renderer_info"
+}

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

@@ -0,0 +1,12 @@
+import { Kit } from "@/types/kit";
+export type Tag<T = string> = {
+    id?: number;
+    name: T;
+    description?: string;
+    createdAt?: string;
+    updatedAt?: string;
+};
+export type KitTag = {
+    kit: Kit;
+    tag: Tag;
+};

package/dist/{types → api/types}/time.d.ts

@@ -1,4 +1,6 @@
+import { Moment } from "moment-timezone";
 export type DateType = Date | string | number;
+export type ExtendedDateType = Moment | DateType;
 type YYYY = number;
 type MM = number;
 type DD = number;
@@ -16,4 +18,8 @@ export type DateTime_tz = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}${"+" | "-"}${HH}:
 export type DateTime_Z = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}Z` | string;
 export type DateTime_Z_micros = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}.${microS}Z` | string;
 export type DateTimeSpaceSeparated = `${Date_YYYY_MM_DD} ${Time_HH_mm_ss}` | string;
+export type DateRangeFilter = {
+    fromDate: DateType;
+    toDate: DateType;
+};
 export {};

package/dist/{types → api/types}/user.d.ts

@@ -34,12 +34,7 @@ export type AdminUser = {
     countryName: string;
     createdAt: DateTime;
     integrations: string[];
-    lastEventBrowser: string;
-    lastEvenCreatedAt: DateTime;
-    lastEventId: number;
-    lastEventIpAddress: string;
-    lastEventName: string;
-    lastEventOs: string;
+    lastSeenAt: DateTime;
     lastLoginAt: string;
     lastname: string;
     persona: string;
@@ -64,6 +59,10 @@ export type ProjectUser = User & {
     cameraExid: string;
     cameraRights: string;
 };
+export declare enum ContactRole {
+    SalesExecutive = "Sales Executive",
+    CustomerSuccessManager = "Customer Success Manager"
+}
 export declare enum Persona {
     HQ = "HQ",
     PM = "PM",

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

@@ -0,0 +1,66 @@
+import { Camera, Media, PaginationParams } from "@/types";
+export declare enum VideoWallItemType {
+    LiveView = "live",
+    Video = "video",
+    Image = "image"
+}
+export type VideoWallItem<T extends Camera | Media> = {
+    value: T;
+    type: VideoWallItemType;
+};
+export type VideoWallPresetItemConfig = {
+    camera: Camera;
+    h: number;
+    i: string | number;
+    moved: boolean;
+    w: number;
+    x: number;
+    y: number;
+};
+export type VideoWallPreset = {
+    name?: string;
+    configuration: Array<VideoWallPresetItemConfig>;
+};
+export type VideoWallPresetItem = {
+    i: string | number;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    camera: Camera;
+    weather?: Record<string, unknown>;
+    media?: Media;
+};
+export type VideoWallSource = "default" | "widget";
+export interface VideoWall {
+    id: number;
+    exid: string;
+    name: string;
+    source: VideoWallSource;
+    config: Record<string, any>;
+    inserted_at: string;
+    updated_at: string;
+    user: {
+        id: number;
+        firstname: string;
+        lastname: string;
+        email: string;
+    };
+}
+export interface ListParams extends PaginationParams {
+    project_exid?: string;
+    id?: number;
+    exid?: string;
+    project_id?: number;
+    user_id?: number;
+    name?: string;
+    project?: string;
+    user?: string;
+    source?: VideoWallSource;
+}
+export type VideoWallCreateUpdatePayload = {
+    project_exid: string;
+    name: string;
+    source?: VideoWallSource;
+    config: Record<string, unknown>;
+};

package/dist/{types → api/types}/weather.d.ts

@@ -1,6 +1,12 @@
 import { Date_YYYY_MM_DD, DateType } from "@/types/time";
 export type HistoryWeatherRequestPayload = {
     day: string;
+    provider: WeatherProvider;
+};
+export type CurrentWeatherRequestPayload = {
+    provider: WeatherProvider;
+    includeForecast?: boolean;
+    forecastDays?: number;
 };
 export type WeatherResponsePayload = Array<{
     hour?: number;
@@ -26,8 +32,8 @@ export type HourlyReading = {
     "3h"?: number;
 };
 export declare enum WeatherProvider {
-    WeatherStack = "WeatherStack",
-    AerisWeather = "AerisWeather"
+    WeatherStack = "weather_stack",
+    XWeather = "xweather"
 }
 export type Weatherstatus = {
     description: string;