@evercam/api 1.0.0-ee9739480 → 1.0.0-eea993f14

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,7 +10,9 @@ 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;
@@ -51,14 +53,15 @@ export declare enum ProjectFeatureFlag {
     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",
-    SmartSearch = "smart_search"
+    SmartSearch = "smart_search",
+    PpeMonitoring = "ppe_monitoring",
+    NoGdpr = "no_gdpr"
 }
 export type ProjectBatteryReading = {
     exid: number;
@@ -124,3 +127,47 @@ 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;
+    lastSeenAt?: DateTime;
+    role: ProjectRole;
+    permissions?: string[];
+    subRoles?: Array<{
+        resourceId: string;
+        roleId: number;
+    }>;
+};
+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

@@ -10,6 +10,7 @@ export type NearestSnapshotRequestPayload = {
     apiId?: string;
     token?: string;
     cancelToken?: object;
+    includeImage?: boolean;
 };
 export type AvailableDaysRequestPayload = {
     cameraId: string;
@@ -56,8 +57,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}/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}/router.d.ts

@@ -47,6 +47,10 @@ export declare enum RouterStatus {
     Active = "active",
     Inactive = "inactive"
 }
+export declare enum RouterScanInputMode {
+    Qr = "qr",
+    Manual = "manual"
+}
 export type RouterQueryParams = PaginationParams & {
     routerType: string;
     vpnServer: string;
@@ -65,3 +69,18 @@ export type RouterCreatePayload = {
     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;
+};

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/api/types/shares.d.ts

@@ -0,0 +1,58 @@
+import type { 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 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/siteAnalytics.d.ts

@@ -0,0 +1,247 @@
+import { BBox, BoundingBox, DateType, Schedule, CameraExid, DateTime, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter, CameraFeatureFlag, TimelineDateInterval, Camera, AdminCamera, _360FullProject, _360FloorId, PaginatedItems } from "@evercam/api/types";
+import { DetectionLabel, DownloadFileType } from "@evercam/api/types";
+export declare enum SiteAnalyticsMode {
+    Detections = "detections",
+    Segments = "segments"
+}
+export type SmartSearchPart = {
+    id?: string;
+    type: SmartSearchPartType;
+    value: DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | SmartSearchCondition | SmartSearchDateRange | string;
+};
+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 SmartSearchDateRange = {
+    start: DateType;
+    end: DateType;
+};
+export type SmartSearchComponentData = {
+    id: string;
+    type: SmartSearchComponentType;
+    parts: SmartSearchPart[];
+};
+export declare enum SmartSearchCondition {
+    InArea = "in_area",
+    Intersects = "intersects",
+    Time = "time"
+}
+export type SmartSearchConditionData = {
+    condition: SmartSearchCondition;
+    value: string | BoundingBox | DetectionLabel | Date;
+};
+export type SmartSearchBackendQueryCondition = {
+    type: SmartSearchConditionTypes;
+    target: SmartSearchTargets;
+    operator?: SmartSearchOperators;
+    attribute?: string;
+    value: string | number | string[];
+    reference?: {
+        target: SmartSearchTargets;
+        attribute: string;
+        value: string | number | string[];
+    };
+    polygon?: BBox;
+};
+export type SmartSearchBackendQuery = {
+    returnTargets: SmartSearchTargets[];
+    rulesLogic: SmartSearchOperatorType;
+    rules: {
+        logic: SmartSearchOperatorType;
+        conditions: SmartSearchBackendQueryCondition[];
+    }[];
+    returnType: SmartSearchReturnType;
+};
+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;
+export type SmartSearchBackendQueryPayload = {
+    cameraExid: string;
+    name: string;
+    description: string;
+    query: {
+        req: SmartSearchBackendQuery;
+        timeSchedule?: Schedule | undefined;
+    };
+    fromDate?: DateType;
+    toDate?: DateType;
+    author: string;
+    createdAt: DateType;
+    params?: Record<string, unknown>;
+};
+export type SavedQuery = {
+    description: string;
+    id: number;
+    query: {
+        req: SmartSearchBackendQuery;
+        timeSchedule?: Schedule | undefined;
+    };
+    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?: 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;
+};
+export declare enum SiteAnalyticsViewType {
+    Camera = "camera",
+    ThreeSixty = "360"
+}
+type SiteAnalyticsViewByType = {
+    [SiteAnalyticsViewType.Camera]: Camera | AdminCamera;
+    [SiteAnalyticsViewType.ThreeSixty]: _360FullProject;
+};
+export type SiteAnalyticsView<T extends SiteAnalyticsViewType = SiteAnalyticsViewType.Camera> = {
+    type: SiteAnalyticsViewType;
+    value: SiteAnalyticsViewByType[T];
+};
+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> = {
+    data: PaginatedItems<SmartSearchResultItemByType[R]>;
+    message?: string;
+    success: boolean;
+};
+export type SmartSearchMinifiedPart = {
+    t: SmartSearchComponentType;
+    v: unknown;
+};
+export type SmartSearchMinifiedComponent = {
+    t: SmartSearchComponentType;
+    p: SmartSearchMinifiedPart[];
+};
+export {};

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

@@ -39,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/{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

@@ -1,4 +1,4 @@
-import type { DateTime, PaginationParams } from "@/types";
+import { DateTime, PaginationParams, BaseRole, SubRole } from "@/types";
 export type User = {
     id?: number;
     fullname?: string;
@@ -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",
@@ -274,3 +273,16 @@ export type Suppression = {
     insertedAt: DateTime;
     updatedAt: DateTime;
 };
+export type ProjectUserWithRole = {
+    id: number;
+    email: string;
+    fullname: string;
+    company: {
+        id: number;
+        name: string;
+        exid: string;
+    };
+    permissions: string[];
+    role: BaseRole;
+    subRoles: SubRole[];
+};

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>;
+};