@evercam/api 1.0.0-c1a524a8d → 1.0.0-c526e2564

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

@@ -1,11 +1,8 @@
-import { AuditLogActionType, DateTime_Z_micros, DateType, EntityByExid, NvrDeviceType, PaginationParams, PowerSchedule, PowerType, ProjectExid, Schedule } from "@/types";
+import { AuditLogActionType, DateType, EntityByExid, KitAlarm, NvrDeviceType, PaginationParams, PowerSchedule, PowerType, ProjectExid, ProjectFeatureFlag, Schedule, ScheduleLowercase, TimestampPositionCoordinates } from "@evercam/api/types";
+import { DateRangeFilter } from "@evercam/api/types/time";
+import { GeoPoint, TuplePoint2D } from "@evercam/api/types/shared";
 export type CameraExid = string;
 export type CamerasByExid = EntityByExid<Camera>;
-export type Cartesian3 = {
-    x: number;
-    y: number;
-    z: number;
-};
 export type Camera = {
     cameraPowerSchedule?: Schedule;
     camPassword?: string;
@@ -16,8 +13,9 @@ export type Camera = {
         status: string;
         storageDuration: string;
     };
-    createdAt: DateTime_Z_micros;
-    description: null;
+    liveViewFrequency: number | null;
+    createdAt: string;
+    description: string | null;
     discoverable: boolean;
     external: {
         host: string;
@@ -36,18 +34,15 @@ export type Camera = {
     featureFlags: Array<CameraFeatureFlag>;
     fovAngle: number;
     fovRadius: number;
-    heading: null;
+    heading: number;
     id: CameraExid;
     exid: CameraExid;
     isOnline: boolean;
     isPowerScheduleActive: boolean;
     isPublic: boolean;
-    lastOnlineAt: DateTime_Z_micros;
-    lastPolledAt: DateTime_Z_micros;
-    location: {
-        lat: number;
-        lng: number;
-    };
+    lastOnlineAt: string;
+    lastPolledAt: string;
+    location: GeoPoint;
     modelId: string;
     modelName: string;
     name: string;
@@ -62,7 +57,7 @@ export type Camera = {
     offlineReason: string;
     owned: boolean;
     owner: string;
-    pitch: null;
+    pitch: string | null;
     project: {
         id: string;
         name: string;
@@ -72,95 +67,99 @@ export type Camera = {
         rtmp: string;
     };
     ptz: boolean;
-    rights: string;
-    roll: null;
+    recordingFromNvr: boolean;
+    model?: CameraModel;
+    roll: string | null;
     routerId: number;
     status: CameraStatus;
     streamingServer: string;
     thumbnailUrl: string;
     largeThumbnailUrl?: string;
     timezone: string;
-    updatedAt: DateTime_Z_micros;
+    updatedAt: string;
     vendorName: string;
     isAccessRestricted?: boolean;
-    kitAlarms?: string[];
+    kitAlarms?: KitAlarm[];
+    timestampPosition?: TimestampPositionCoordinates;
+    position?: number | null;
 };
 export type AdminCamera = {
-    cameraHost: string;
-    cameraHttpPort: number;
-    cameraModel: string;
-    cameraPassword: string;
-    cameraPictureEndpoint: string;
-    cameraRtspPort: number;
-    cameraScheme: string;
-    cameraUsername: string;
-    cameraFirmwareVersion: string;
-    cameraTimezone: string;
-    cloudRecordingFrequency: number;
-    cloudRecordingId: number;
-    cloudRecordingSchedule: Schedule;
-    cloudRecordingStatus: string;
-    cloudRecordingStorageDuration: number;
-    createdAt: DateTime_Z_micros;
-    description: null;
-    discoverable: false;
-    exid: CameraExid;
-    featureFlags: CameraFeatureFlag[];
-    fovAngle: 45.0;
-    fovRadius: number;
-    heading: null;
     id: number;
-    isPowerScheduleActive: true;
-    isPublic: false;
-    kitId?: number;
-    lastOnlineAt: DateTime_Z_micros;
-    lastPolledAt: DateTime_Z_micros;
-    location: {
-        lat: number;
-        lng: number;
-    };
-    macAddress: string;
+    exid: CameraExid;
     name: string;
-    nvrChannel: null;
-    nvrDeviceId: string;
-    nvrHost: string;
-    nvrHttpPort: number;
-    nvrModel: NvrModel;
-    nvrPassword: string;
-    nvrPictureEndpoint: string;
-    nvrRtspPort: number;
-    nvrScheme: string;
-    nvrUsername: string;
-    offlineReason: null;
-    pitch: null;
-    powerSchedule: Schedule;
-    projectExid: string;
-    projectFeatureFlags: [];
-    projectId: number;
-    projectName: string;
-    ptz: false;
-    recordingFromNvr: false;
-    roll: null;
-    routerId: number;
     status: string;
-    storageProviders: [];
-    streamEndpoint: string;
-    timezone: string;
-    updatedAt: DateTime_Z_micros;
-    userApiId: string;
-    userApiKey: string;
+    description: string | null;
+    createdAt: string;
+    updatedAt: string;
+    lastOnlineAt: string | null;
+    lastPolledAt: string | null;
+    decommissionedAt: string | null;
+    deletedAt?: string | null;
+    projectId: number | null;
+    projectExid: string | null;
+    projectName: string | null;
+    projectFeatureFlags: Array<ProjectFeatureFlag | string>;
+    userId: number | null;
     userEmail: string;
     userFullname: string;
-    userId: number;
-    zohoId: string;
+    userApiId?: string;
+    userApiKey?: string;
+    isPublic: boolean;
+    sharedWithConstruction?: boolean;
+    timezone: string | null;
+    location?: GeoPoint | null;
+    fovAngle?: number | null;
+    fovRadius?: number | null;
+    heading?: number | null;
+    pitch?: number | null;
+    roll?: number | null;
+    cameraModel?: string | null;
+    cameraHost?: string | null;
+    cameraHttpPort?: number | null;
+    cameraRtspPort?: number | null;
+    cameraScheme?: string | null;
+    cameraUsername?: string | null;
+    cameraPassword?: string | null;
+    cameraPictureEndpoint?: string | null;
+    rtspUrl?: string | null;
+    httpUrl?: string | null;
+    deviceId?: string | null;
+    nvrId?: number | null;
+    nvrDeviceId?: string | null;
+    nvrModel?: NvrModel | string | null;
+    nvrHost?: string | null;
+    nvrHttpPort?: number | null;
+    nvrRtspPort?: number | null;
+    nvrScheme?: string | null;
+    nvrUsername?: string | null;
+    nvrPassword?: string | null;
+    nvrPictureEndpoint?: string | null;
+    streamEndpoint?: string | null;
+    routerId?: number | null;
+    kitId?: number | null;
+    powerType?: string | null;
+    powerSchedule?: ScheduleLowercase | Record<string, string[]>;
+    isPowerScheduleActive?: boolean;
+    discoverable?: boolean;
+    recordingFromNvr?: boolean;
+    cloudRecordingFrequency?: number | null;
+    cloudRecordingId?: number | null;
+    cloudRecordingStatus?: string | null;
+    cloudRecordingSchedule?: ScheduleLowercase | null;
+    cloudRecordingStorageDuration?: number | null;
+    liveViewFrequency?: number | null;
+    anprSources?: string[];
+    storageProviders?: string[];
+    featureFlags?: CameraFeatureFlag[];
+    zohoId?: string | null;
+    offlineReason?: string | null;
+    macAddress?: string | null;
+    type?: string[];
     thumbnailUrl?: string;
 };
 export type CameraMapMarker = {
     isOnline: boolean;
-    location: {
-        lat: number;
-        lng: number;
-    };
+    location: GeoPoint;
     needFov: boolean;
     rotation: number;
     fovAngle: number;
@@ -176,6 +175,14 @@ export declare enum CameraStatus {
     UnderMaintenance = "under_maintenance",
     WaitingForSiteVisit = "waiting_for_site_visit"
 }
+export declare enum IntensityChange {
+    High = "High",
+    Moderate = "Moderate",
+    Low = "Low",
+    NoChange = "No change",
+    Default = "Default"
+}
+export declare const IntensityChangeColorMap: Record<IntensityChange, string>;
 export declare enum CameraFeatureFlag {
     EdgeVideo = "edge_video",
     BimCompare = "bim_compare",
@@ -190,15 +197,16 @@ export declare enum CameraFeatureFlag {
     ObjectDetection = "object_detection",
     Segmentation = "segmentation",
     SegmentationAutoLabelling = "segmentation_auto_labelling",
-    PpeMonitoring = "ppe_monitoring"
+    PpeMonitoring = "ppe_monitoring",
+    PpeOwlv2 = "ppe_owlv2",
+    PpeGemini = "ppe_gemini",
+    PpeYolo = "ppe_yolo",
+    PpeV2 = "ppe_v2",
+    NoLiveView = "no_live_view",
+    NoRecordings = "no_recordings",
+    Ring = "ring",
+    CloudOnly = "cloud_only"
 }
-export type CameraLogsRequestPayload = {
-    limit: number;
-    page: number;
-    types: string;
-    from: string;
-    to: string;
-};
 export type CameraUpdateRequestPayload = {
     status?: string;
     timezone?: string;
@@ -234,17 +242,22 @@ export type CameraUpdateRequestPayload = {
     fovRadius?: number;
     featureFlags: CameraFeatureFlag[];
     isAccessRestricted?: boolean;
+    liveViewFrequency?: number | null;
 };
 export type CamerasResponsePayload = {
     cameras?: Camera[];
 };
-export type CameraLogsResponsePayload = {
-    cameraExid: string;
-    cameraName: string;
-    logs?: Log[];
-    details?: {
-        customMessage?: string;
+export type CameraNoteResponsePayload = {
+    id: number;
+    camera: {
+        exid: string;
+        name: string;
     };
+    who: string;
+    noteType: string;
+    content: string;
+    pinned: boolean;
+    insertedAt: string;
 };
 export type CameraStatusLog = {
     start: string;
@@ -295,14 +308,9 @@ export declare enum CameraModel {
     Hikvision = "hikvision",
     Avigilion = "avigilion",
     Hanwha = "hanwha",
-    Other = "other"
+    Other = "other",
+    Ring = "ring"
 }
-export type DroneCameraTransform = {
-    position: Cartesian3;
-    direction: Cartesian3;
-    up: Cartesian3;
-    right: Cartesian3;
-};
 export type Footage = {
     cameraExid: string;
     cameraName: string;
@@ -334,6 +342,7 @@ export type CameraPath = {
 export type CheckCameraPortPayload = {
     address: string;
     port: number;
+    open: boolean;
 };
 export type CameraCreateRequestPayload = {
     status: CameraStatus;
@@ -342,7 +351,7 @@ export type CameraCreateRequestPayload = {
     isPowerScheduleActive?: boolean;
     ptz?: boolean;
     name: string;
-    coordinates?: [number, number];
+    coordinates?: TuplePoint2D;
     recordingFromNvr?: boolean;
     CameraConfig: {
         model: CameraModel;
@@ -379,22 +388,26 @@ export type CameraDeletePayload = {
     verify: string;
     password: string;
 };
-export type SaveNotePayload = {
-    noteType: string;
-    content: string;
-};
 export type CameraNote = {
     id: number;
     cameraId: number;
+    who: string;
     noteType: string;
     content: string;
+    pinned: boolean;
     insertedAt: DateType;
 };
+export type GetCameraNotesParams = {
+    noteType?: string;
+    pinned?: boolean;
+    sort?: string;
+    page?: number;
+    limit?: number;
+};
 export type CreateCameraNotePayload = {
-    id?: number;
-    cameraExid: CameraExid;
-    customMessage: string;
-    action: string;
+    noteType: string;
+    content: string;
+    pinned?: boolean;
 };
 export declare enum HddStatus {
     Error = "error",
@@ -494,6 +507,8 @@ export type MergeDuplicatedCameraPayload = {
     shareeCameras: Record<string, unknown>;
 };
 export type FetchCameraQueryParams = PaginationParams & {
+    /** Narrows the index to one project. Sent as `project_exid`. */
+    projectExid: ProjectExid;
     status: CameraStatus;
     isPublic: boolean;
     featureFlags: CameraFeatureFlag[];
@@ -518,3 +533,10 @@ export type FetchCameraQueryParams = PaginationParams & {
     externalRsptPort: string;
     nvrHttpPort: string;
 };
+export declare enum BimType {
+    TwoD = "2D",
+    Forge = "Forge"
+}
+export type CameraDateRangeFilter = DateRangeFilter & {
+    cameraExid: CameraExid;
+};

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

@@ -1,15 +1,28 @@
-import { CameraExid, DateType, ProjectExid } from "@/types";
+import { CameraExid, DateType, ProjectExid, PaginationParams, TuplePoint3D, TuplePoint2D, _360CameraRotation } from "@evercam/api/types";
 export declare enum CommentsScope {
     Recordings = "recordings",
-    ThreeSixty = "360"
+    ThreeSixty = "360",
+    Drone = "drone",
+    Timeline = "timeline"
+}
+export declare enum CommentsLabel {
+    Info = "Info",
+    Danger = "Danger",
+    Restricted = "Restricted"
 }
 export type CommentsRequestPayload = {
-    cameraExid: CameraExid;
-    fromDate: string;
-    toDate: string;
     scope: CommentsScope;
-    page?: number;
-    limit?: number;
+    cameraExid?: CameraExid;
+};
+export type CommentsListRequestPayload = PaginationParams & {
+    projectExid?: ProjectExid;
+    cameraExid?: CameraExid;
+    fromDate?: string;
+    toDate?: string;
+    scope?: CommentsScope;
+    creatorEmail?: string;
+    content?: string;
+    includeArchived?: boolean;
 };
 export type Comment = {
     fromDate?: string;
@@ -23,21 +36,29 @@ export type Comment = {
     createdAt?: string;
     creatorEmail?: string;
     creatorName?: string;
-    position2d?: [number, number];
-    position3d?: [number, number, number];
+    position2d?: TuplePoint2D;
+    position3d?: TuplePoint3D;
     context?: Record<string, unknown>;
     canDelete?: boolean;
     archivedAt?: string;
+    label?: CommentsLabel;
 };
 export type CommentCreationRequestPayload = {
     fromDate?: DateType;
     toDate?: DateType;
     timestamp?: DateType;
     scope?: CommentsScope;
-    projectExid: ProjectExid;
+    projectExid?: ProjectExid;
     cameraExid?: CameraExid;
     content: string;
-    position2d?: [number, number];
+    label?: CommentsLabel;
+    position2d?: TuplePoint2D;
     position3d?: [number, number, number];
     context?: Record<string, unknown>;
 };
+export type CommentThreeSixtyContext = {
+    floorId: string;
+    dateId: string;
+    currentRoom: string;
+    cameraRotation: _360CameraRotation;
+};

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

@@ -1,11 +1,16 @@
-import type { DateType, PaginationParams } from "@/types";
+import type { DateType, PaginationParams } from "@evercam/api/types";
 export type CompanyUser = {
     id: number;
     fullname: string;
     email: string;
     eventsCount: number;
-    lastSeenAt: string;
-    active: boolean;
+    lastLoginAt: string;
+};
+export type AdminCompanyUser = {
+    id: number;
+    email: string;
+    fullname: string;
+    lastLoginAt: string;
 };
 export type CompanyProject = {
     exid: string;
@@ -13,6 +18,44 @@ export type CompanyProject = {
     status: string;
     startedAt: DateType;
 };
+export type AdminCompanyProject = {
+    id: number;
+    name: string;
+    status: string;
+    insertedAt: DateType;
+    exid: string;
+    endDate: string | null;
+    startDate: string | null;
+    archiveTier: string | null;
+};
+export type CompanyKit = {
+    id: number;
+    name: string;
+    serial: string;
+    status: string;
+    powerType: string;
+    countryName: string;
+    nvrId: string;
+    nvrSerial: string;
+    nvrVersion: string;
+    nvrNerves: boolean;
+    nvrModel: string;
+    nvrDeviceType: string;
+    routerId: string;
+    routerSerial: string;
+    projectExid: string;
+    projectName: string;
+    alarms: Array<string>;
+    sims: Array<{
+        id: number;
+        number: string;
+    }>;
+    cameras: Array<{
+        exid: string;
+        name: string;
+        status: string;
+    }>;
+};
 export type Company = {
     id: number;
     exid: string;
@@ -25,7 +68,32 @@ export type Company = {
     cameras: number;
     users: number;
     activeUsers: number;
-    createdAt: DateType;
+    insertedAt: DateType;
+};
+export type CompanySummary = {
+    id: number;
+    name: string;
+    users: number;
+    insertedAt: DateType;
+    exid: string;
+    sessions: number;
+    projects: number;
+    zohoId: string;
+    domains: string;
+    linkedinUrl: string | null;
+    ssoProviders: string[];
+    cameras: number;
+    kits: number;
+};
+export type CompanyCameraSummary = {
+    id: number;
+    name: string;
+    status: string;
+    exid: string;
+    projectExid: string | null;
+    ownerEmail: string;
+    ownerFullname: string;
+    usersCount: number;
 };
 export type CompanyQueryParams = PaginationParams & {
     name: string;

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

@@ -1,4 +1,4 @@
-import { DateType, PaginationParams } from "@/types";
+import { DateType, PaginationParams } from "@evercam/api/types";
 export type Compare = {
     cameraExid: string;
     createdAt: string;
@@ -28,14 +28,29 @@ export declare enum CompareStatus {
     Failed = 2
 }
 export type CompareRequestPayload = {
+    compareExid: string;
     name: string;
-    afterDate: string;
     beforeDate: string;
+    afterDate: string;
+    cameraExid: string;
     embed: string;
-    compareExid: string;
-    cameraExid?: string;
+    bim?: boolean;
+    custom?: boolean;
+    options?: {
+        type: string;
+        beforeSnap: string;
+        afterSnap: string;
+    };
     createAnimation: boolean;
-    evercamWatermark?: boolean;
+    evercamWatermark: boolean;
+    logo?: CompareLogoPosition;
+};
+export type CompareLogoPosition = {
+    id?: number;
+    width: number;
+    height: number;
+    x: number;
+    y: number;
 };
 export type AdminCompare = {
     id: number;

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

@@ -1,6 +1,7 @@
 export type ConnectorDetail = {
     login: string;
     hostname: string;
+    provider: string;
 };
 export declare enum Connector {
     Aconex = "aconex",
@@ -8,14 +9,13 @@ export declare enum Connector {
     Autodesk = "autodesk",
     AutodeskViewer = "autodesk_viewer",
     VoyageControl = "voyage_control",
+    Ring = "ring",
+    Email = "email",
+    Hammertech = "hammertech",
     XWeather = "xweather"
 }
 export declare enum ProcoreType {
     Observations = "observations",
     Photos = "photos"
 }
-export type ConnectorResponsePayload = Array<{
-    hostname: string;
-    login: string;
-    provider: string;
-}>;
+export type ConnectorResponsePayload = Array<ConnectorDetail>;

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

@@ -1,11 +1,11 @@
-import { DateType } from "@/types/time";
+import { CameraExid, DateType, ProjectExid } from "@evercam/api/types";
 export type CreateCoolifyAppRequestPayload = {
-    cameraExid: string;
     startDate: DateType;
     modelVersion: string;
     snapshotRequestTimeout: string | number;
     serverUuid: string;
     branch: string;
+    useThirdParty: boolean;
 };
 export type SaveCoolifyAppRequestPayload = {
     contextCameraExid: string;
@@ -15,4 +15,22 @@ export type SaveCoolifyAppRequestPayload = {
     branchName: string;
     snapshotRequestTimeout: string | number;
     serverUuid: string;
+    useThirdParty: boolean;
+};
+export type CoolifyApp = {
+    id: number;
+    projectExid: ProjectExid;
+    anprCameraExid: CameraExid;
+    contextCameraExid: CameraExid;
+    modelVersion: string;
+    isActive: boolean;
+    insertedAt: DateType;
+    updatedAt: DateType;
+};
+export type RegisterCoolifyAppResponsePayload = {
+    created: boolean;
+    id: number;
+    data: CoolifyApp;
+    count: number;
+    message: string;
 };

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

@@ -490,13 +490,6 @@ export declare enum CountryCode {
     Zambia = "zm",
     Zimbabwe = "zw"
 }
-export declare enum Region {
-    Apac = "apac",
-    Emea = "emea",
-    Us = "us",
-    Latam = "latam",
-    Na = "na"
-}
 export declare enum CameraRegion {
     APAC = "apac",
     AU = "au",

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

@@ -2,4 +2,5 @@ export type ApiCredentials = {
     apiKey?: string;
     apiId?: string;
     token?: string;
+    includeImage?: boolean;
 };