@evercam/api 1.0.0-1b8a09aec → 1.0.0-1bc49e878

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

@@ -0,0 +1,61 @@
+export declare enum RoleResourceType {
+    App = "app",
+    Camera = "camera",
+    Project = "project"
+}
+export type RoleSubRole = {
+    resourceId: string;
+    roleId: number;
+    roleName?: string;
+    permissions?: string[];
+};
+export type Role = {
+    id: number;
+    name: string;
+    description?: string | null;
+    resource?: string;
+    resourceType: RoleResourceType;
+    resourceId?: string | null;
+    permissions: string[];
+    subRoles?: RoleSubRole[];
+    isDefault?: boolean;
+};
+export type ProjectResourceRole = Role & {
+    resourceType: RoleResourceType.Project;
+};
+export type CameraResourceRole = Omit<Role, "subRoles"> & {
+    resourceType: RoleResourceType.Camera;
+};
+export type ProjectRoleRequestPayload = {
+    name: string;
+    permissions: string[];
+    subRoles?: RoleSubRole[];
+};
+export type AuthzRoleUser = {
+    email: string;
+    resourceId: string;
+};
+export type AuthzUserRolesResponse = {
+    roles: Role[];
+};
+export type AuthzScopePermission = {
+    id: number;
+    action: string;
+    exid: string;
+};
+export type AuthzScope = {
+    id: number;
+    name: string;
+    description: string | null;
+    permissions: AuthzScopePermission[];
+    app: string;
+    exid: string;
+};
+export type AuthzScopeCreatePayload = {
+    name: string;
+    description?: string;
+    permissions: string[];
+};
+export type AuthzScopeUpdatePayload = Partial<AuthzScopeCreatePayload>;
+export declare function isProjectRole(role: Role): role is ProjectResourceRole;
+export declare function isCameraRole(role: Role): role is CameraResourceRole;

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

@@ -1,20 +1,20 @@
-export type AutodeskUserHubsResponsePayload = Array<{
+export type AutodeskUserHub = {
     text: string;
     value: string;
-}>;
-export type AutodeskProjectsResponsePayload = Array<{
+};
+export type AutodeskProject = {
     text: string;
     value: string;
-}>;
-export type AutodeskFolderResponsePayload = {
+};
+export type AutodeskFolder = {
     text: string;
     value: string;
     allowedFileType: string;
     allowedFolderType: string;
-    children: Array<AutodeskFolderResponsePayload>;
+    children: Array<AutodeskFolder>;
     parentName?: string;
 };
-export type AutodeskUploadSnapshotPayload = {
+export type AutodeskSnapshot = {
     projectId: string;
     folderId: string;
     accFileType: string;

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

@@ -1,3 +1,4 @@
+import { AconexIdentifiers, CameraExid } from "@evercam/api/types";
 export declare enum AutomationProvider {
     Aconex = "aconex",
     Procore = "procore",
@@ -6,5 +7,89 @@ export declare enum AutomationProvider {
 }
 export declare enum AutomationType {
     Photo = "photo",
-    Compare = "compare"
+    Compare = "compare",
+    GateReport = "gate_report"
 }
+export type AutomationCompareConfig = {
+    compareDelay: number;
+};
+export type AutomationEmailRecipient = string | {
+    email: string;
+};
+export type AutomationGateReportConfig = {
+    projectExid: string;
+    vehicleTypes: string[];
+    fileType: string;
+    period: number;
+    columns: string[];
+    recipients: string | string[];
+};
+export type AutomationEmailProviderConfig = {
+    cameraExids?: CameraExid[];
+    recipients: string | AutomationEmailRecipient[];
+};
+export type AutomationProcoreProviderConfig = {
+    companyId: number;
+    companyName: string;
+    projectId: number;
+    projectName: string;
+    categoryId: number;
+    categoryName: string;
+};
+export type AutomationAconexProviderConfig = {
+    projectId: number;
+    projectName: string;
+} & Partial<Record<AconexIdentifiers, string | number | boolean>>;
+export type AutomationAutodeskProviderConfig = {
+    hubId: number;
+    hubName: string;
+    projectId: number;
+    projectName: string;
+    folderId: number;
+    accFileType: string;
+    accFolderType: string;
+    folderName: string;
+};
+export type AutomationProviderConfig = AutomationEmailProviderConfig | AutomationProcoreProviderConfig | AutomationAconexProviderConfig | AutomationAutodeskProviderConfig;
+export type AutomationOptionsConfig = AutomationCompareConfig | AutomationGateReportConfig | {};
+export type AutomationConfig = AutomationProviderConfig & AutomationOptionsConfig;
+export type Automation = {
+    id?: number;
+    cameraExids: CameraExid[];
+    name: string;
+    subject?: string;
+    provider: AutomationProvider;
+    type: AutomationType;
+    config: AutomationConfig;
+    notifyDays: string[];
+    notifyTime: string;
+    timezone: string;
+    isPaused: boolean;
+    restrictedCameraExids?: string[];
+};
+export declare enum AutomationConfigStep {
+    Type = "type",
+    Cameras = "cameras",
+    Settings = "settings",
+    Destination = "destination"
+}
+export type AutomationProviderOption = {
+    labelTranslationKey: string;
+    descriptionTranslationKey: string;
+    value: AutomationProvider;
+    icon: string;
+    iconSize?: string;
+    requiresConnection: boolean;
+};
+export type FormattedAutomation = {
+    cameraExids: string;
+    name: string;
+    subject: string;
+    provider: AutomationProvider;
+    type: AutomationType;
+    config: Partial<AutomationProviderConfig> & Partial<AutomationOptionsConfig>;
+    notifyDays: string;
+    notifyTime: string;
+    timezone: string;
+    isPaused: boolean;
+};

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

@@ -1,4 +1,5 @@
 import type { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelTokenSource, CancelTokenStatic } from "axios";
+import { Swr } from "@evercam/api/api/client/swr/Swr";
 export type TimedRequest<T> = Promise<AxiosResponse<T> & {
     duration: number;
     error?: AxiosError;
@@ -7,38 +8,55 @@ export type AxiosEnvironment = {
     baseUrl?: string | null;
     stagingAiApiUrl?: string | null;
     aiApiUrl?: string | null;
-    ingestApiUrl?: string | null;
+    ingestDroneApi?: string | null;
+    ingest360Api?: string | null;
     ingestGpuApiUrl?: string | null;
     posthogApiUrl?: string | null;
     posthogProjectId?: string | null;
-    posthogPrivateApiKey?: string | null;
     firebaseVideowallUrl?: string | null;
     weatherApiBaseUrl?: string | null;
     evercamLabsUrl?: string | null;
     firebaseDbLink?: string | null;
+    firebaseStorageUrl?: string | null;
+    firebaseStorageToken?: string | null;
+    forgeTokenServerUrl?: string | null;
     snapshotsURL?: string | null;
     app?: string | null;
     getAuthToken?: () => string | null;
     errorLogger?: (error: AxiosError) => void;
+    swrKey?: string;
 };
 export type RequestInterceptor = (req: AxiosRequestConfig, env: AxiosEnvironment) => AxiosRequestConfig & any;
 export type ResponseInterceptor = (res: AxiosResponse, env: AxiosEnvironment) => AxiosResponse & any;
 export type ErrorInterceptor = (error: any, env: AxiosEnvironment) => any;
+export type RequestManager = {
+    createToken: (key: string) => CancelTokenSource["token"];
+    cancelToken: (key: string) => void;
+    cancelAll: () => void;
+};
 export interface ExtendedAxiosInstance extends AxiosInstance {
     CancelToken: CancelTokenStatic;
-    isCancel: (value: AxiosResponse | AxiosError | never) => boolean;
+    isCancel: (value: AxiosResponse | AxiosError | unknown) => boolean;
     setToken: (token: string) => void;
     setHeader: (headerName: string, value: any) => void;
-    generateCancelTokenSource: () => CancelTokenSource;
-    addCancelToken: (token: CancelTokenSource) => void;
-    resetCancelTokens: () => void;
-    cancelRequests: () => void;
+    createRequestManager: () => RequestManager;
+    requestManager: RequestManager;
     env: AxiosEnvironment;
     addEnvironmentVariables: (vars: Record<string, any>) => void;
     addRequestInterceptor: (interceptor: RequestInterceptor, errorInterceptor?: ErrorInterceptor) => void;
     addResponseInterceptor: (interceptor: ResponseInterceptor, errorInterceptor?: ErrorInterceptor) => void;
     addErrorInterceptor: (interceptor: ErrorInterceptor) => void;
+    swr: Swr;
 }
+export type ResponseValue<T> = T | undefined;
+export type SwrResponse<T> = {
+    cachedValue: ResponseValue<T>;
+    freshPromise: Promise<ResponseValue<T>>;
+};
+export type SwrRequestConfig<T> = Omit<AxiosRequestConfig, "onSwrHit" | "onSwrRefresh"> & {
+    onSwrHit?: (data: T) => unknown;
+    onSwrRefresh?: (data: T) => unknown;
+};
 declare module "axios" {
     interface AxiosRequestConfig {
         raw?: boolean;
@@ -47,5 +65,9 @@ declare module "axios" {
         _metadata?: {
             startTime: number;
         };
+        swr?: boolean;
+        onSwrHit?: (data: any) => unknown;
+        onSwrRefresh?: (data: any) => unknown;
+        onSwrError?: (error: Error) => unknown;
     }
 }

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

@@ -1,4 +1,4 @@
-import { DateTime, DateType } from "@/types";
+import { CompareLogoPosition, DateType } from "@evercam/api/types";
 export declare enum BimModelType {
     Architectural = "Architectural",
     Structural = "Structural",
@@ -48,14 +48,15 @@ export type BimCompareExportRequestPayload = {
     layerId?: number;
     maskId?: number;
     evercamWatermark?: boolean;
+    logo?: CompareLogoPosition;
 };
 export type BimLayerResponsePayload = {
     id: number;
     name: string;
-    insertedAt: DateTime;
-    updatedAt: DateTime;
+    insertedAt: string;
+    updatedAt: string;
     shapes: string;
-    startAt: DateTime;
+    startAt: string;
 };
 export declare enum BimUploadStatus {
     Initial = 0,
@@ -78,13 +79,18 @@ export type BimCreationPayload = {
 };
 export declare enum BIMLayerTypes {
     Mask = "mask",
+    BimMask = "bim_mask",
     MeasuringGrid = "measuring_grid",
     BimArchitectural = "bim_architectural",
     BimStructural = "bim_structural",
     Bim4D = "bim_4d",
     BimMep = "bim_mep",
     RecordingsTag = "recordings_tag",
-    Milestone = "milestone"
+    Milestone = "milestone",
+    ForgeBimArchitectural = "forge_bim_architectural",
+    ForgeBimStructural = "forge_bim_structural",
+    ForgeBim4D = "forge_bim_4d",
+    ForgeBimMep = "forge_bim_mep"
 }
 export type BimLayersQueryParams = {
     layerType: BIMLayerTypes;
@@ -145,3 +151,28 @@ export type BimUploadPayload = {
         fileExtension: string;
     }[];
 };
+export declare enum ForgeBimUploadMethod {
+    FileUpload = "file_upload",
+    AutodeskAcc = "autodesk_acc"
+}
+export declare enum ForgeBimFileRejectionReason {
+    InvalidType = "invalid_type",
+    ExceedsSizeLimit = "exceeds_size_limit"
+}
+export declare enum ForgeBimUploadStage {
+    TusUpload = "tus_upload",
+    IngestUpload = "ingest_upload"
+}
+export declare enum ForgeBimDialogTrigger {
+    UpdateModel = "update_model",
+    AddModel = "add_model",
+    InitialSetup = "initial_setup"
+}
+export type BimUpdatedWebhookPayload = {
+    eventName: "bim.updated";
+    projectId: string;
+    data: {
+        updatedAt: string;
+        bimIdentifier: string;
+    };
+};

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,98 @@ 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;
 };
 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 +174,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,7 +196,14 @@ 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",
+    Ring = "ring",
+    CloudOnly = "cloud_only"
 }
 export type CameraLogsRequestPayload = {
     limit: number;
@@ -234,6 +247,7 @@ export type CameraUpdateRequestPayload = {
     fovRadius?: number;
     featureFlags: CameraFeatureFlag[];
     isAccessRestricted?: boolean;
+    liveViewFrequency?: number | null;
 };
 export type CamerasResponsePayload = {
     cameras?: Camera[];
@@ -295,14 +309,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 +343,7 @@ export type CameraPath = {
 export type CheckCameraPortPayload = {
     address: string;
     port: number;
+    open: boolean;
 };
 export type CameraCreateRequestPayload = {
     status: CameraStatus;
@@ -342,7 +352,7 @@ export type CameraCreateRequestPayload = {
     isPowerScheduleActive?: boolean;
     ptz?: boolean;
     name: string;
-    coordinates?: [number, number];
+    coordinates?: TuplePoint2D;
     recordingFromNvr?: boolean;
     CameraConfig: {
         model: CameraModel;
@@ -518,3 +528,10 @@ export type FetchCameraQueryParams = PaginationParams & {
     externalRsptPort: string;
     nvrHttpPort: string;
 };
+export declare enum BimType {
+    TwoD = "2D",
+    Forge = "Forge"
+}
+export type CameraDateRangeFilter = DateRangeFilter & {
+    cameraExid: CameraExid;
+};