@evercam/api 1.0.0-c65b4959f → 1.0.0-cb5ac4ad5

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

@@ -1,25 +1,56 @@
-import { AdminCamera, Camera, CameraExid, DateTime, DateType, EntityByExid, Exid, PaginationParams } from "@/types";
+import { AdminCamera, Camera, CameraExid, DateType, EntityByExid, Exid, Operator, PaginationParams } from "@evercam/api/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;
-    userId?: number;
+    archiveTier?: ProjectArchiveTier;
     cameras?: Array<Camera | AdminCamera>;
-    unrestrictedCameras?: Array<Camera | AdminCamera>;
+    camerasCount?: number;
+    camerasRestrictionType?: string;
+    companyId: number;
+    endDate: string;
+    exid: ProjectExid;
     featureFlags: Array<ProjectFeatureFlag>;
+    geographicBounds?: unknown;
+    id: string | number;
+    insertedAt?: string;
+    name: string;
     owner?: {
         email?: string;
     };
     ownerEmail?: string;
     ownerName?: string;
-    camerasRestrictionType?: string;
+    startedAt?: string;
+    status?: ProjectStatus;
+    timezone?: string;
+    unrestrictedCameras?: Camera[];
+    userId?: number;
+    zohoId?: string;
+};
+export type AdminProjectCameraRef = {
+    exid: string;
+    name: string;
+};
+export type AdminProjectListItem = {
+    id: number;
+    name: string;
+    status: ProjectStatus | string;
+    insertedAt: string;
+    timezone: string | null;
+    exid: ProjectExid;
+    endDate: string | null;
+    startDate: string | null;
+    archiveTier: ProjectArchiveTier | null;
+    featureFlags: Array<ProjectFeatureFlag | string>;
+    zohoId: string | null;
+    ownerEmail: string | null;
+    companyId: number | null;
+    companyName: string | null;
+    ownerName: string | null;
+    archived: boolean;
+    cameras?: AdminProjectCameraRef[];
+};
+export type AdminProjectDetail = AdminProjectListItem & {
+    userId: number;
 };
 export declare enum ProjectStatus {
     ToStart = "To Start",
@@ -31,15 +62,22 @@ export declare enum ProjectArchiveTier {
     Full = "Full",
     Partial = "Partial",
     Minimal = "Minimal",
-    ScheduledForDeletion = "Scheduled for Deletion"
+    ScheduledForDeletion = "Scheduled for Deletion",
+    No = "No"
 }
-export type ProjectResponsePayload = {
-    data?: Project[];
-};
 export type UpdateCameraRestrictionPayload = {
     isAccessRestricted?: boolean;
 };
+export type CameraPosition = {
+    cameraExid: CameraExid;
+    position: number;
+};
+export type ReorderCamerasPayload = {
+    positions: CameraPosition[];
+};
 export type Logo = {
+    id: number;
+    projectId: number;
     name: string;
     url: string;
 };
@@ -53,7 +91,6 @@ 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",
@@ -61,7 +98,9 @@ export declare enum ProjectFeatureFlag {
     NoLicensePlate = "no_license_plate",
     DefaultToProjectApp = "default_to_project_app",
     SmartSearch = "smart_search",
-    PpeMonitoring = "ppe_monitoring"
+    PpeMonitoring = "ppe_monitoring",
+    NoGdpr = "no_gdpr",
+    Chat = "chat"
 }
 export type ProjectBatteryReading = {
     exid: number;
@@ -79,6 +118,7 @@ export type ProjectsQueryParams = PaginationParams & {
     status: ProjectStatus;
     cameras: string;
     featureFlags: Array<ProjectFeatureFlag>;
+    featureFlagsOperator?: Operator;
     archived: string;
 };
 export type ProjectCreateRequestPayload = {
@@ -117,7 +157,7 @@ export type ProjectUserProperty = {
     eventsCount: number;
     fullname: string;
     id: number;
-    lastSeenAt: DateTime;
+    lastSeenAt: string;
     persona: string;
 };
 export type ProjectUsers = {
@@ -127,3 +167,94 @@ export type ProjectUsers = {
     }[];
     users: Record<string, ProjectUserProperty[]>;
 };
+export type ProjectRole = {
+    id: number;
+    name: string;
+};
+export type ProjectMember = {
+    id: string;
+    key?: string;
+    email: string;
+    fullname: string;
+    lastSeenAt?: string;
+    role: ProjectRole;
+    permissions?: string[];
+    subRoles?: Array<{
+        resourceId: string;
+        roleId: number;
+    }>;
+    company?: {
+        name: string;
+    } | null;
+};
+export type ProjectInvite = {
+    id?: string;
+    email: string;
+    role?: ProjectRole;
+    permissions?: string[];
+    subRoles?: Array<{
+        resourceId: string;
+        roleId: number;
+    }>;
+    invitedAt?: string;
+};
+export type ProjectMembersResponsePayload = {
+    users: ProjectMember[];
+    invites: ProjectInvite[];
+    errors: ProjectUserError[];
+};
+export type ProjectMembersRequestPayload = {
+    roleId: number;
+    emails: string[];
+    message?: string;
+    overrideRole?: Partial<{
+        permissions?: string[];
+        subRoles?: Array<{
+            resourceId: string;
+            roleId: number;
+        }>;
+    }>;
+};
+export type ProjectInviteMembersResponsePayload = {
+    users: ProjectMember[];
+    invites: ProjectInvite[];
+};
+export type PlaceholderThumbnailData = {
+    placeholder: string;
+};
+export type ProjectUserError = {
+    email: string;
+    error: Record<string, string[]>;
+};
+export type ProjectUsersResponsePayload = {
+    users: ProjectMember[];
+    invites: ProjectInvite[];
+    errors: ProjectUserError[];
+};
+export type MentionableUser = {
+    id: number;
+    fullname: string;
+    email: string;
+};
+export type ProjectStorageQueryParams = PaginationParams & {
+    cameraName: string;
+    cameraExid: CameraExid;
+    status: ProjectStorageStatus;
+};
+export type ProjectStorage = {
+    id: number;
+    cameraExid: CameraExid;
+    cameraName: string;
+    projectExid: string;
+    projectName: string;
+    status: ProjectStorageStatus;
+    requestor: string;
+    created_at: DateType;
+};
+export declare enum ProjectStorageStatus {
+    New = "new",
+    Pending = "pending",
+    Processing = "processing",
+    Completed = "completed",
+    Failed = "failed"
+}

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

@@ -1,21 +1,24 @@
-import { ApiCredentials } from "@/types";
+import { ApiCredentials, PaginationParams } from "@evercam/api/types";
 import { CancelToken } from "axios";
 export type Snapshot = {
     createdAt: string;
     data: string;
     status?: string;
 };
-export type NearestSnapshotRequestPayload = {
+export type SnapshotRequestPayload = {
     apiKey?: string;
     apiId?: string;
     token?: string;
     cancelToken?: object;
+    includeImage?: boolean;
+    view?: boolean;
 };
 export type AvailableDaysRequestPayload = {
     cameraId: string;
     year: string;
     month: string;
     payload?: ApiCredentials;
+    cancelToken?: CancelToken;
 };
 export type AvailableDaysResponsePayload = {
     days: Array<number>;
@@ -38,11 +41,9 @@ export type NearestSnapshotResponsePayload = {
         notes?: string;
     }>;
 };
-export type SnapshotRangeRequestPayload = {
+export type SnapshotRangeRequestPayload = PaginationParams & {
     from: string;
     to: string;
-    limit?: number;
-    page?: number;
     schedule?: boolean;
     count?: number;
 };
@@ -55,8 +56,7 @@ export type SnapshotRangeResponsePayload = {
     snapshots: Array<SnapshotInstance>;
 };
 export declare enum BrainTool {
-    Detections = "detections",
-    Segmentation = "sam"
+    Detections = "detections"
 }
 export declare enum CloudRecordingFrequency {
     EverySecond = 60,
@@ -76,6 +76,7 @@ export declare enum CloudRecordingDuration {
     Month = 30,
     ThreeMonths = 90
 }
+export declare const CloudRecordingDurationLabel: Record<CloudRecordingDuration, string>;
 export declare enum CloudRecordingStatus {
     On = "on",
     Off = "off",
@@ -103,13 +104,6 @@ export declare enum SnapshotExtractionInterval {
 }
 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",
@@ -119,5 +113,6 @@ export declare enum VpnServer {
     WireGuard7 = "WireGuard7",
     WireGuard8 = "WireGuard8",
     WireGuard9 = "WireGuard9",
-    WireGuard10 = "WireGuard10"
+    WireGuard10 = "WireGuard10",
+    WgHub = "WgHub"
 }

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

@@ -1,4 +1,4 @@
-import type { DateType, PaginationParams } from "@/types";
+import type { DateType, PaginationParams } from "@evercam/api/types";
 export type RecycleBin = {
     id?: number;
     exid: string;

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

@@ -0,0 +1,53 @@
+export type RingCompleteLinkingPayload = {
+    nonce: string;
+    time: string;
+};
+/** The only auto-import status complete-linking returns today. */
+export declare const RING_AUTO_IMPORT_QUEUED = "queued";
+export type RingAutoImportStatus = typeof RING_AUTO_IMPORT_QUEUED;
+export type RingCompleteLinkingResponsePayload = {
+    status: string;
+    /** Absent when the API did not schedule an import. */
+    autoImport?: RingAutoImportStatus;
+};
+export type RingDevice = {
+    deviceId: string;
+    name: string;
+    /** Resolved from Ring's `device-status`; null when Ring did not return it. */
+    online: boolean | null;
+    deviceType: string | null;
+    firmwareVersion: string | null;
+    /** Always null — Ring's API does not expose device power level. */
+    batteryLife: number | null;
+    location: string | null;
+    imported: boolean;
+    cameraExid?: string;
+    projectExid?: string;
+    projectName?: string;
+};
+export type RingDevicesResponsePayload = {
+    devices: RingDevice[];
+};
+export type RingMoveDevicePayload = {
+    projectExid: string;
+};
+export type RingMoveDeviceResponsePayload = {
+    status: string;
+    cameraExid: string;
+    projectExid: string;
+};
+export type RingLiveViewPayload = {
+    sdpOffer: string;
+};
+export type RingLiveViewResponse = {
+    sdpAnswer: string;
+    sessionUrl: string;
+    iceServers: Array<{
+        urls: string;
+        username?: string;
+        credential?: string;
+    }>;
+};
+export type RingStopLiveViewResponse = {
+    status: string;
+};

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

@@ -3,23 +3,15 @@ export declare enum RoiType {
     AnprContext = "anpr_context",
     ExclusionZone = "exclusion_zone",
     WorkflowArea = "workflow_area",
-    SiteAnalytics = "site_analytics"
+    SiteAnalytics = "site_analytics",
+    Ppe = "ppe_roi"
 }
 export declare enum RoiShapeType {
     Polygon = "polygon",
     Line = "line",
     Direction = "direction",
-    Rectangle = "rectangle",
-    ROIBox = "ROIBox"
+    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",

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

@@ -1,6 +1,7 @@
 export type RouteParams = {
     projectExid?: string;
     cameraExid?: string;
+    mediaExid?: string;
     timestamp?: string;
     fromDate?: string;
     toDate?: string;

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

@@ -1,4 +1,4 @@
-import { Camera, PaginationParams, Project, Sim } from "@/types";
+import { Camera, PaginationParams, Project, Sim } from "@evercam/api/types";
 export type RouterBillPayer = {
     name: string;
 };
@@ -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/api/types/shared.d.ts

@@ -1,7 +1,17 @@
-import { DateType } from "@/types";
+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;
@@ -53,7 +63,7 @@ export declare enum UnitSystem {
     Metric = "metric"
 }
 export type Timestamp = string | number;
-export type Schedule = {
+export type ScheduleUppercase = {
     Friday: string[];
     Monday: string[];
     Saturday: string[];
@@ -71,6 +81,7 @@ export type ScheduleLowercase = {
     tuesday: string[];
     wednesday: string[];
 };
+export type Schedule = ScheduleUppercase | ScheduleLowercase;
 export type PaginationParams = {
     sort?: SortingUrlParam;
     page?: number;
@@ -105,18 +116,6 @@ export declare enum DownloadFileType {
     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];
@@ -126,6 +125,21 @@ 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 TuplePoint3D = [number, 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 = {
@@ -152,16 +166,6 @@ export declare enum TimelinePrecision {
     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",

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

@@ -1,4 +1,4 @@
-import type { CameraExid, DateTime, DateType } from "@/types";
+import type { DateType } from "@evercam/api/types";
 export type ShareRequest = {
     cameraId: string;
     createdAt: DateType | number;
@@ -24,19 +24,6 @@ export type Share = {
     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;
@@ -46,151 +33,13 @@ 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 InviteStatus {
+    Pending = 0,
+    Cancelled = -1,
+    Used = 1,
+    Failed = -2
 }
-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;
-};