@evercam/api 1.0.0-ff3128bbe → 1.0.0-ff34bc64c

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

@@ -1,22 +1,24 @@
-import { ApiCredentials } from "@evercam/api/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>;
@@ -39,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;
 };
@@ -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/ring.d.ts

@@ -1,8 +1,23 @@
+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;
-    deviceType: 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;
@@ -13,21 +28,6 @@ export type RingDevice = {
 export type RingDevicesResponsePayload = {
     devices: RingDevice[];
 };
-export type RingImportDevicesPayload = {
-    deviceIds: string[];
-    projectExid: string;
-    deviceNames?: Record<string, string>;
-};
-export type RingImportResponsePayload = {
-    cameras: Array<{
-        exid: string;
-        name: string;
-    }>;
-    project: {
-        exid: string;
-        name: string;
-    };
-};
 export type RingMoveDevicePayload = {
     projectExid: 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/shared.d.ts

@@ -1,4 +1,8 @@
 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}`;
@@ -105,25 +109,18 @@ export declare enum InfoPage {
     DroneView = "drone-view",
     Compare = "compare",
     Timeline = "timeline",
-    WeatherReport = "weather-report"
+    WeatherReport = "weather-report",
+    Cameras = "cameras"
 }
 export declare enum DownloadFileType {
     Jpeg = "jpeg",
     Pdf = "pdf",
     Csv = "csv"
 }
-export declare enum FeedbackContext {
-    CopilotMessage = "copilot_message"
+export declare enum PromiseSettledStatus {
+    Fulfilled = "fulfilled",
+    Rejected = "rejected"
 }
-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];
@@ -133,6 +130,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 = {
@@ -159,16 +171,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

@@ -33,14 +33,6 @@ 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[];
@@ -51,8 +43,3 @@ export declare enum InviteStatus {
     Used = 1,
     Failed = -2
 }
-export declare enum ShareVisibility {
-    PublicDiscoverable = "publicDiscoverable",
-    PublicUndiscoverable = "publicUndiscoverable",
-    Private = "private"
-}

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

@@ -1,4 +1,4 @@
-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 { BBox, BoundingBox, DateType, Schedule, ScheduleLowercase, CameraExid, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter, CameraFeatureFlag, TimelineDateInterval, Camera, AdminCamera, _360FloorV2, _360FloorId, PaginatedItems, DateRangeFilter, TuplePoint2D } from "@evercam/api/types";
 import { DetectionLabel, DownloadFileType } from "@evercam/api/types";
 export declare enum SiteAnalyticsMode {
     Detections = "detections",
@@ -184,7 +184,7 @@ export type DetectionsExportRequestParams = DetectionsRequestParams & {
     directDownload?: boolean;
 };
 export type SmartSearchHeatmapPoint = {
-    coordinates: [number, number];
+    coordinates: TuplePoint2D;
     detectionsCount: number;
 };
 export type SmartSearchHeatmapData = {
@@ -232,7 +232,7 @@ export type SiteAnalyticsProcessingStatus = {
     feature: CameraFeatureFlag;
     processedIntervals: TimelineDateInterval[];
 };
-export type SmartSearchRequestPayload = {
+export type SmartSearchRequestPayload = PaginationParams & {
     cameraExids?: CameraExid[];
     drawingIds?: _360FloorId[];
     walkIds?: string[];
@@ -240,8 +240,6 @@ export type SmartSearchRequestPayload = {
     payload: SmartSearchBackendQuery;
     fromDate?: string;
     toDate?: string;
-    page?: number;
-    pageSize?: number;
     threshold?: number;
 };
 type SmartSearchResultItemBase = {

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

@@ -0,0 +1,127 @@
+import { CameraExid, DateType, PaginationParams, ProjectExid } from "@evercam/api/types";
+export declare enum VisionProvider {
+    Gemini = "gemini",
+    Gemma = "gemma"
+}
+export declare const VISION_PROVIDER_OPTIONS: {
+    text: string;
+    value: VisionProvider;
+}[];
+export type SiteAnalyticsCoolifyStatus = {
+    appUuid: string | null;
+    name: string | null;
+    serverUuid: string | null;
+    serverName: string | null;
+    appUrl: string | null;
+    status: string | null;
+    isRunning: boolean;
+    updatedAt: string | null;
+};
+export type SiteAnalyticsProjectMeta = {
+    exid: ProjectExid;
+    name: string | null;
+    timezone: string | null;
+    featureFlags: string[] | null;
+};
+export type SiteAnalyticsCameraMeta = {
+    exid: CameraExid;
+    name: string | null;
+    status: string | null;
+    featureFlags: string[] | null;
+};
+export type SiteAnalyticsManagedApp = {
+    id: number;
+    projectExid: ProjectExid;
+    cameraExid: CameraExid;
+    coolifyAppId: string | null;
+    appVersion: string;
+    modelId: number | null;
+    startDate: DateType | null;
+    endDate: DateType | null;
+    startHour: number;
+    endHour: number;
+    source: string;
+    override: boolean;
+    timeIncreaseFrequency: number;
+    skipWeekends: boolean;
+    tracking: boolean;
+    observations: boolean;
+    visionProvider?: VisionProvider | null;
+    insertedAt: DateType | null;
+    updatedAt: DateType | null;
+    coolify: SiteAnalyticsCoolifyStatus | null;
+    project: SiteAnalyticsProjectMeta | null;
+    camera: SiteAnalyticsCameraMeta | null;
+    lastTrackingAt: DateType | null;
+};
+export type CreateSiteAnalyticsAppPayload = {
+    projectExid: ProjectExid;
+    cameraExid: CameraExid;
+    coolifyServerUuid: string;
+    appVersion?: string;
+    modelId?: number | null;
+    startDate?: DateType | null;
+    endDate?: DateType | null;
+    startHour?: number;
+    endHour?: number;
+    source?: string;
+    override?: boolean;
+    skipWeekends?: boolean;
+    timeIncreaseFrequency?: number;
+    tracking?: boolean;
+    observations?: boolean;
+    observationPromptId?: number | null;
+    visionProvider?: VisionProvider;
+};
+export type UpdateSiteAnalyticsAppPayload = Partial<Omit<CreateSiteAnalyticsAppPayload, "projectExid" | "cameraExid" | "coolifyServerUuid">>;
+export type ModelOption = {
+    modelId: number;
+    version: string;
+};
+export type SiteAnalyticsAppConfigFormValue = {
+    appVersion: string;
+    modelId: number | null;
+    startDate: string | null;
+    endDate: string | null;
+    startHour: number;
+    endHour: number;
+    source: string;
+    override: boolean;
+    timeIncreaseFrequency: number;
+    skipWeekends: boolean;
+};
+export type SiteAnalyticsManagementListParams = PaginationParams & {
+    projectExid?: ProjectExid;
+    includeStatus?: boolean;
+};
+export type CreateSiteAnalyticsAppResponse = {
+    created: boolean;
+    id: number | null;
+    data: SiteAnalyticsManagedApp | null;
+    count: number | null;
+    message: string;
+};
+export type DeleteSiteAnalyticsAppResponse = {
+    deleted: boolean;
+    count: number;
+    message: string;
+};
+export type ObservationConfigActivity = {
+    observationTypeId: number;
+    every: number | null;
+};
+export type ObservationConfig = {
+    id: number;
+    cameraExid: CameraExid;
+    projectExid: ProjectExid | null;
+    enabled: boolean;
+    activities: ObservationConfigActivity[];
+    createdBy: string | null;
+    insertedAt: DateType | null;
+    updatedAt: DateType | null;
+};
+export type UpsertObservationConfigPayload = {
+    projectExid?: ProjectExid;
+    enabled: boolean;
+    activities: ObservationConfigActivity[];
+};

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

@@ -0,0 +1,78 @@
+import { ForgeView } from "@evercam/api/types/360";
+import { Point2D, Point3D } from "@evercam/api/types/shared";
+export declare enum SiteViewSoftwareType {
+    Revit = "Revit",
+    Navisworks = "Navisworks",
+    Drone = "Drone",
+    Synchro = "Synchro"
+}
+export declare enum SiteViewerType {
+    ITwin = "iTwin",
+    Cesium = "Cesium",
+    Forge = "Forge"
+}
+export type SiteViewCameraListItem = {
+    projectId: string;
+    projectName: string;
+    software: SiteViewSoftwareType;
+    type: SiteViewerType;
+    uniqueId: string;
+    integrationType?: string;
+};
+export type ForgeUrn = {
+    displayName: string;
+    urn: string;
+    isModelHostedByEvercamACC?: boolean;
+    savedViews?: Record<string, ForgeView>;
+};
+export type ForgeAccAlignmentData = {
+    bbox: {
+        min: Point2D;
+        max: Point2D;
+    };
+    transform: number[];
+    coordinateSystem?: {
+        context?: {
+            type?: string;
+        };
+    } | null;
+};
+export type TimelineItem = {
+    taskNumber: number;
+    taskID: string;
+    actualStartDate: string;
+    actualEndDate: string;
+    plannedStartDate: string;
+    plannedEndDate: string;
+    objectIDs: number[];
+};
+export type ForgeMarkerTransform = {
+    default: {
+        position: Point3D;
+        type: string;
+    };
+};
+export type ForgeMarker = {
+    name: string;
+    cameraExid: string;
+    transforms: ForgeMarkerTransform;
+};
+export type ForgeProjectData = {
+    urns?: ForgeUrn[];
+    accDrawingsAlignments?: Record<string, ForgeAccAlignmentData>;
+    timeline?: TimelineItem[];
+    markers?: ForgeMarker[];
+};
+export type ItwinModel = {
+    name: string;
+    iTwinId: string;
+    iModelId: string;
+    changeSetId?: string;
+    isIModel: boolean;
+    height?: number;
+    cesiumId?: number;
+    markerDistanceThreshold: number;
+};
+export type ItwinProjectData = {
+    models: ItwinModel[];
+};

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

@@ -5,8 +5,11 @@ export type SnapshotExtractionQyeryParams = PaginationParams & {
     status: SnapshotExtractionStatus;
 };
 export declare enum SnapshotExtractionStatus {
+    Cancelling = "canceling",
+    Cancelled = "cancelled",
     Completed = "completed",
     Failed = "failed",
+    Pending = "pending",
     Processing = "processing"
 }
 export declare enum SnapshotExtractionType {
@@ -30,6 +33,8 @@ export type SnapshotExtraction = {
     injectTo_cr: Boolean;
     schedule: Schedule;
     created_at: DateType;
+    jpegCount?: number;
+    obanJobId?: number;
 };
 export type SnapshotTestPayload = {
     cameraExid?: CameraExid;
@@ -42,6 +47,14 @@ export type SnapshotTestResponse = {
     status: string;
     data: string;
 };
+export type SnapshotEmailDeliveryRequestPayload = {
+    snapshot: string;
+    recipients?: string[];
+    message?: string;
+};
+export type SnapshotEmailDeliveryResponsePayload = {
+    warning?: string;
+};
 export type DeleteSnapshotQueryParams = {
     fromDate: DateType;
     toDate: DateType;

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

@@ -0,0 +1,4 @@
+export type SocketAuthResponsePayload = {
+    wsToken: string;
+    expiresIn: number;
+};

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

@@ -1,17 +1,4 @@
 import type { JsonObject, JsonValue } from "@evercam/api/types";
-export type StoryblokAsset = {
-    id: number | null;
-    alt: string | null;
-    name: string;
-    focus: string | null;
-    title: string | null;
-    filename: string;
-    copyright: string | null;
-    fieldtype: "asset";
-    source?: string;
-    metaData?: JsonObject;
-    isExternalUrl?: boolean;
-};
 export type StoryblokStory<TContent extends JsonObject = JsonObject> = {
     id: number;
     uuid: string;

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

@@ -1,4 +1,4 @@
-import { DateType, Schedule } from "@evercam/api/types";
+import { Point2D, Schedule } from "@evercam/api/types";
 export declare enum TimelapseStatus {
     Pending = 11,
     Completed = 5,
@@ -16,7 +16,9 @@ export type TimelapseVideoOptions = {
     removeTimestamp: boolean;
     smoothTransition: boolean;
     evercamWatermark: boolean;
+    sectionBlur?: boolean;
     timestampPosition?: TimestampPositionCoordinates;
+    blurRegions?: BlurRegionCoordinates[];
 };
 export type TimestampPositionCoordinates = {
     x: number;
@@ -24,6 +26,7 @@ export type TimestampPositionCoordinates = {
     w: number;
     h: number;
 };
+export type BlurRegionCoordinates = Point2D[];
 export type TimelapseLogoOptions = {
     id?: number;
     x: number;
@@ -51,13 +54,6 @@ export declare enum TimelapseType {
     Year = "year",
     FullProject = "full_project"
 }
-export type TimelapseFilterQueryParams = {
-    from?: DateType;
-    to?: DateType;
-    period?: TimelapsePeriod;
-    duration?: number;
-    schedule?: Schedule;
-};
 export type TimelapseCreationRequestPayload = {
     title: string;
     duration: number;

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

@@ -151,6 +151,21 @@ export type SessionsListRequestPayload = {
     limit: number;
     page: number;
 };
+export type AuthorizedApp = {
+    id: number;
+    clientId: string;
+    clientName: string;
+    clientDescription: string | null;
+    logoUrl: string | null;
+    scopes: string[];
+    grantedAt: string;
+};
+export type AuthorizedAppsListRequestPayload = {
+    search?: string;
+    sort?: string;
+    limit?: number;
+    page?: number;
+};
 export type SessionActivityCamSettingsDetail = {
     new: any;
     old: any;
@@ -176,7 +191,6 @@ export type SessionActivitiesListRequestPayload = {
 };
 export type SignupUserRequestPayload = {
     telephone: string;
-    token: string;
     firstname: string;
     lastname: string;
     email: string;
@@ -194,9 +208,6 @@ export type UserUpdateRequestPayload = {
     country: string;
     persona: string;
 };
-export type UserDeleteRequestPayload = {
-    verifEmail: string;
-};
 export type GoogleAuthRequestPayload = {
     code: string;
     redirectUri: string;
@@ -338,6 +349,7 @@ export type ProjectUserWithRole = {
         name: string;
         exid: string;
     };
+    persona: Persona;
     permissions: string[];
     role: Role;
     subRoles: RoleSubRole[];