@evercam/api 1.0.0-003291add

package/dist/api/api/evercamLabsApi.d.ts

@@ -0,0 +1,45 @@
+import { CameraExid, CopilotConversation, CopilotMessage, CopilotMessageStep, FeedbackPayload, GrafanaKitMetrics, LabsPaginationParams, LuminanceReading, PaginatedItems, ActiveUsersResponsePayload, ActiveUsersRequestPayload, HeatmapIntersectionsRequestParams, SmartSearchHeatmapPoint, SiteAnalyticsProcessingStatusPayload, SiteAnalyticsProcessingStatus } from "@evercam/api/types";
+import { GrafanaMetricId, KitMetricPeriod } from "@evercam/api/types";
+import type { SwrRequestConfig } from "@evercam/api/types";
+export declare function getLabsBaseUrl(): string | null | undefined;
+export declare const EvercamLabsApi: {
+    posthog: {
+        getEvents(params: any): Promise<PaginatedItems<any>>;
+        getUsers(params: any): Promise<any>;
+        getActiveUsers(params: ActiveUsersRequestPayload): Promise<ActiveUsersResponsePayload>;
+    };
+    copilot: {
+        getAllConversations(params: LabsPaginationParams & {
+            cameraExid?: string;
+            projectExid?: string;
+            user?: string;
+        }): Promise<PaginatedItems<CopilotConversation>>;
+        getOneConversation(conversationId: number): Promise<PaginatedItems<CopilotConversation>>;
+        getConversationMessages(conversationId: number, params: LabsPaginationParams): Promise<PaginatedItems<CopilotMessage>>;
+        getMessageSteps(message: CopilotMessage): Promise<CopilotMessageStep[]>;
+        submitMessageFeedback({ conversationId, messageId, ...params }: FeedbackPayload): Promise<import("axios").AxiosResponse<any, any>>;
+    };
+    siteAnalytics: {
+        getProcessingStatus(params?: SiteAnalyticsProcessingStatusPayload, config?: SwrRequestConfig<SiteAnalyticsProcessingStatus[]>): Promise<SiteAnalyticsProcessingStatus[]>;
+        getIntersectionsHeatmapData(params: HeatmapIntersectionsRequestParams): Promise<SmartSearchHeatmapPoint[]>;
+    };
+    googleCloudStorage: {
+        listFiles(prefix?: string): Promise<{
+            files: string[];
+            folders: string[];
+        }>;
+        getSignedUrl(fileName: string): Promise<{
+            url: string;
+        }>;
+    };
+    luminance: {
+        getReadings(params: {
+            cameraExid: CameraExid;
+            fromDate: string;
+            toDate: string;
+        }): Promise<LuminanceReading[]>;
+    };
+    kits: {
+        getMetrics(kitId: string, metrics: GrafanaMetricId[], period?: KitMetricPeriod): Promise<GrafanaKitMetrics>;
+    };
+};

package/dist/api/api/exNvrApi.d.ts

@@ -0,0 +1,43 @@
+import { ExNvrDeviceConfig, ExNvrLoginResponse, ExNvrRecordingInterval, ExNvrSystemStatus } from "@evercam/api/types";
+export declare const ExNvrApi: {
+    users: {
+        login({ apiUrl, username, password, }: {
+            apiUrl: string;
+            username: string;
+            password: string;
+        }, config?: {
+            timing?: boolean;
+        }): Promise<ExNvrLoginResponse>;
+    };
+    devices: {
+        getDevices({ apiUrl, token, }: {
+            apiUrl: string;
+            token: string;
+        }): Promise<ExNvrDeviceConfig>;
+        getSystemStatus({ apiUrl, token }: {
+            apiUrl: string;
+            token: string;
+        }, config?: Record<string, string>): Promise<ExNvrSystemStatus>;
+        getDeviceConfig({ apiUrl, deviceId, token, }: {
+            apiUrl: string;
+            deviceId: string;
+            token: string;
+        }, config?: {
+            timing?: boolean;
+        }): Promise<ExNvrDeviceConfig>;
+        getAvailableRecordings({ apiUrl, deviceId, token, }: {
+            apiUrl: string;
+            deviceId: string;
+            token: string;
+        }, config?: {
+            timing?: boolean;
+        }): Promise<ExNvrRecordingInterval[]>;
+        downloadFootage({ apiUrl, deviceId, token, startDate, duration, }: {
+            apiUrl: string;
+            deviceId: string;
+            token: string;
+            startDate: string;
+            duration: number;
+        }): Promise<Blob>;
+    };
+};

package/dist/api/api/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./client";
+export * from "./adminApi";
+export * from "./videoWallApi";
+export * from "./3dFirebaseApi";
+export * from "./aiApi";
+export * from "./webRtcApi";
+export * from "./weatherApi";
+export * from "./evercamLabsApi";
+export * from "./evercamApi";
+export * from "./ptzApi";
+export * from "./ingestApi";
+export * from "./exNvrApi";
+export * from "./authzApi";

package/dist/api/api/ingestApi.d.ts

@@ -0,0 +1,148 @@
+import type { AxiosRequestConfig } from "axios";
+import type { SwrRequestConfig } from "@evercam/api/types";
+import type { _360AssetsQueryParams, _360AssetsRequestPayload, _360QueueQueryParams, _360AssetsUploadPayload, _360AssetsResponse, _360AssetsCountsResponse, _360QueueResponse, _360FloorsResponse, DroneQueueResponse, DroneUploadsResponse, IngestUploadInitResponse, BimUploadsResponse, MobileAssetsQueryParams, MobileCaptureAssetsResponse, BimUploadPayload, BimUploadsQueryParams, CalculateMeasuringOperationRequestPayload, DrawingsRequestPayload, DronesQueryParams, DroneUploadUpdateRequestPayload, FlightImagesQueryParams, Generate360MapRequestPayload, GenerateFloorPayload, InspectionToolRequestPayload, JsonObject, _360WalkV2, _360FloorV2 } from "@evercam/api/types";
+import { IngestVersions, IngestTypes } from "@evercam/api/types";
+export declare const getIngestApiUrls: (type: string) => string[];
+export declare const IngestApi: {
+    drone: {
+        createUpload(projectId: string, params: {
+            uploadedBy: string;
+        }): Promise<IngestUploadInitResponse>;
+        reprocessDrone(id: number, params?: JsonObject): Promise<void>;
+        getDrones(params: {
+            params: Partial<DronesQueryParams>;
+        }): Promise<DroneUploadsResponse>;
+        getArchive(id: number, params: {
+            dataType: string;
+        }): Promise<Blob>;
+        deleteUpload(id: number): Promise<void>;
+        prepareForUpload(projectId: string, params: {
+            uploadedBy: string;
+            token: string;
+        }): Promise<void>;
+        upload(projectId: string, params: {
+            uploadedBy: string;
+            token: string;
+        }, payload: DroneUploadUpdateRequestPayload): Promise<void>;
+        verifyToken(projectId: string, params: {
+            token: string;
+        }): Promise<JsonObject>;
+        calculateMeasuringOperation(projectId: string, params: CalculateMeasuringOperationRequestPayload): Promise<JsonObject>;
+        inspectionTool(projectId: string, params: InspectionToolRequestPayload): Promise<JsonObject>;
+        isInspectionEnabled(projectId: string, params?: JsonObject): Promise<JsonObject>;
+        getDroneQueueSize(droneUrl: string): Promise<DroneQueueResponse>;
+        getFlightImages(projectId: string, params: FlightImagesQueryParams): Promise<JsonObject>;
+        checkFlightAvailableFeatures(projectId: string, params: JsonObject): Promise<JsonObject>;
+    };
+    assets360: {
+        get360Assets(params: {
+            params: Partial<_360AssetsQueryParams>;
+        }): Promise<_360AssetsResponse>;
+        get360AssetsCounts(projectId: string, params: {
+            uploadedBy: string;
+        }): Promise<_360AssetsCountsResponse>;
+        get360AssetLink(projectId: string, date: string, floor: string, assetType: string, drawingId: string, marker: string | null): Promise<string>;
+        update360(id: number, payload: _360AssetsRequestPayload): Promise<_360WalkV2>;
+        update360ByProjectDateName(projectId: string, date: string, floor: string, payload: _360AssetsRequestPayload): Promise<_360WalkV2>;
+        deleteUpload(id: number): Promise<void>;
+        getArchive(id: number, params: {
+            dateType: string;
+        }): Promise<Blob>;
+        createUpload(projectId: string, params: _360AssetsRequestPayload): Promise<IngestUploadInitResponse>;
+        upload(id: number, params: JsonObject, payload: _360AssetsUploadPayload): Promise<_360WalkV2>;
+        reprocess360(id: number): Promise<void>;
+        drawingExists(payload: {
+            params: {
+                name: string;
+                project_id: string;
+            };
+        }): Promise<JsonObject>;
+        getDrawings(payload: {
+            params: DrawingsRequestPayload;
+            config?: SwrRequestConfig<_360FloorsResponse>;
+        }): Promise<_360FloorsResponse>;
+        getDrawingById(id: number, projectExid: string): Promise<_360FloorV2>;
+        updateDrawing(id: number, projectExid: string, payload: GenerateFloorPayload): Promise<_360FloorV2>;
+        deleteDrawing(id: number): Promise<void>;
+        transferWalks(sourceId: number, targetId: number, projectExid: string): Promise<void>;
+        createDrawing(projectExid: string, payload: GenerateFloorPayload, createdBy: string): Promise<_360FloorV2>;
+        fetchDrawingOverlay(id: number, params: {
+            view: boolean;
+        }, onDownloadProgress: (progress: ProgressEvent) => void): Promise<Blob>;
+        getFloorArchive(id: number): Promise<string>;
+        generate360map(projectId: string, params: Generate360MapRequestPayload): Promise<JsonObject>;
+        get360QueueSize(ingestUrl: string, params?: _360QueueQueryParams): Promise<_360QueueResponse>;
+    };
+    bim: {
+        createUpload(projectId: string, params: {
+            uploadedBy: string;
+        }): Promise<IngestUploadInitResponse>;
+        getBIMs(params: {
+            params: Partial<BimUploadsQueryParams>;
+        }): Promise<BimUploadsResponse>;
+        getArchive(id: number): Promise<Blob>;
+        deleteUpload(id: number): Promise<void>;
+        upload(projectId: string, params: {
+            id: string;
+            name: string;
+        }, payload: BimUploadPayload): Promise<void>;
+    };
+    mobileCapture: {
+        getProjectMobileAssets(params: MobileAssetsQueryParams, extraConfig?: AxiosRequestConfig): Promise<MobileCaptureAssetsResponse>;
+        getMobileAssetPhoto(assetId: string | number, params: {
+            projectId?: string;
+            project_id?: string;
+            isThumbnail?: boolean;
+            is_thumbnail?: boolean;
+        }): Promise<string>;
+        deleteAsset(assetId: string | number): Promise<void>;
+    };
+    utils: {
+        loadAllAssetsInQueue(): Promise<({
+            ingestVersion: string;
+            id: number;
+            projectId: string;
+            consumed: boolean;
+            token: string;
+            flightDate: string;
+            flightGeolocation: string;
+            modelZip: string;
+            orthomosaicZip: string;
+            reportPdf: string;
+            uploadedBy: string;
+            processingStatus: import("@evercam/api/types").IngestProcessingStatus | string;
+            modelCesiumAssetId: string;
+            updatedAt: string;
+            hasTusLinks: boolean;
+        } | {
+            ingestVersion: string;
+            archive: string;
+            date: string;
+            deviceSerial: string | null;
+            endPosition: unknown | null;
+            floor: string;
+            floorId: number;
+            id: number;
+            images: string[];
+            insertedAt: string;
+            mobileAudios: string[];
+            mobileAudiosArchive: string;
+            mobilePhotos: string[];
+            mobilePhotosArchive: string;
+            model: string;
+            name: string;
+            processingStatus: string;
+            projectId: string;
+            report: string;
+            route: unknown | null;
+            startPosition: unknown | null;
+            tusLinks: unknown | null;
+            updatedAt: string;
+            uploadedBy: string;
+            videoArchive: string;
+            videos: string[];
+        })[]>;
+        getIngestVersion(ingestUrl: string): IngestVersions;
+        chooseIngestApiUrl(type: IngestTypes): Promise<string>;
+    };
+};

package/dist/api/api/ptzApi.d.ts

@@ -0,0 +1,45 @@
+import { MoveParams, ZoomParams } from "@evercam/api/types";
+export declare const PtzApi: {
+    presets: {
+        index({ cameraExid, }: {
+            cameraExid: string;
+        }): Promise<{
+            presets: Array<{
+                name: string;
+                token: string;
+            }>;
+        }>;
+        go({ cameraExid, presetId, }: {
+            cameraExid: string;
+            presetId: string | number;
+        }): Promise<import("axios").AxiosResponse<any, any>>;
+        home({ cameraExid, isRecordingFromNvr, }: {
+            cameraExid: string;
+            isRecordingFromNvr: boolean;
+        }): Promise<import("axios").AxiosResponse<any, any>>;
+        create({ cameraExid, presetName, }: {
+            cameraExid: string;
+            presetName: string;
+        }): Promise<import("axios").AxiosResponse<any, any>>;
+        update({ cameraExid, presetId, presetName, }: {
+            cameraExid: string;
+            presetId: string | number;
+            presetName: string;
+        }): Promise<import("axios").AxiosResponse<any, any>>;
+        updateHome({ cameraExid, presetName, }: {
+            cameraExid: string;
+            presetName: string;
+        }): Promise<import("axios").AxiosResponse<any, any>>;
+        delete({ cameraExid, presetId, }: {
+            cameraExid: string;
+            presetId: string | number;
+        }): Promise<import("axios").AxiosResponse<any, any>>;
+    };
+    controls: {
+        move({ cameraExid, direction, useContinuous }: MoveParams): Promise<import("axios").AxiosResponse<any, any>>;
+        zoom({ cameraExid, direction, isRecordingFromNvr }: ZoomParams): Promise<import("axios").AxiosResponse<any, any>>;
+        stop({ cameraExid }: {
+            cameraExid: string;
+        }): Promise<import("axios").AxiosResponse<any, any>>;
+    };
+};

package/dist/api/api/videoWallApi.d.ts

@@ -0,0 +1,9 @@
+import { type PaginatedItems } from "@evercam/shared/types";
+import { VideoWall, VideoWallListParams, VideoWallCreateUpdatePayload } from "@evercam/api/types/videoWall";
+export declare const VideoWallApi: {
+    list(params?: VideoWallListParams): Promise<import("axios").AxiosResponse<PaginatedItems<VideoWall>, any>>;
+    create(body: VideoWallCreateUpdatePayload): Promise<import("axios").AxiosResponse<VideoWall, any>>;
+    get(exid: string | number): Promise<import("axios").AxiosResponse<VideoWall, any>>;
+    update(exid: string | number, body: Partial<VideoWallCreateUpdatePayload>): Promise<import("axios").AxiosResponse<VideoWall, any>>;
+    delete(exid: string | number): Promise<import("axios").AxiosResponse<any, any>>;
+};

package/dist/api/api/weatherApi.d.ts

@@ -0,0 +1,9 @@
+import { CurrentWeatherRequestPayload, HistoryWeatherRequestPayload, WeatherDataResponse, WeatherReportRequestPayload, WeatherResponsePayload } from "@evercam/api/types";
+import { AxiosRequestConfig } from "axios";
+export declare const WeatherApi: {
+    current(projectExid: string, payload: CurrentWeatherRequestPayload): Promise<WeatherResponsePayload> | undefined;
+    historical(projectExid: string, payload: HistoryWeatherRequestPayload): Promise<WeatherResponsePayload> | undefined;
+    report(projectExid: string, payload: WeatherReportRequestPayload, config?: AxiosRequestConfig): Promise<{
+        data: WeatherDataResponse[];
+    }> | undefined;
+};

package/dist/api/api/webRtcApi.d.ts

@@ -0,0 +1,22 @@
+export declare const WebRtcApi: {
+    webRtc: {
+        requestIceServers({ url, token }: {
+            url: string;
+            token: string;
+        }): import("axios").AxiosPromise<any>;
+        sendLocalOffer({ url, token, data, }: {
+            url: string;
+            token: string;
+            data: {
+                sdp: string;
+                type: string;
+            };
+        }): import("axios").AxiosPromise<any>;
+        sendLocalCandidates({ url, token, data, tag, }: {
+            url: string;
+            token: string;
+            data: Record<string, unknown>;
+            tag: string;
+        }): import("axios").AxiosPromise<any>;
+    };
+};

package/dist/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./api";
+export * from "./types";
+export * from "./utils";

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

@@ -0,0 +1,281 @@
+import { DateType } from "@evercam/api/types/time";
+import { GeoPoint, Point3D } from "@evercam/api/types/shared";
+export type _360OverlayPosition = {
+    northEast: GeoPoint;
+    northWest: GeoPoint;
+    southEast: GeoPoint;
+    southWest: GeoPoint;
+};
+export type ForgeViewport = {
+    name: string;
+    eye: number[];
+    target: number[];
+    worldUpVector?: number[];
+};
+export type ForgeView = {
+    name: string;
+    viewport: ForgeViewport;
+    timestamp: string;
+};
+export type _360CameraRotation = {
+    azimuthAngle: number;
+    polarAngle: number;
+};
+export type _360Geolocation = {
+    latitude: number;
+    longitude: number;
+};
+export type _360Marker3D = {
+    cameraPosition: Point3D;
+    geolocation: _360Geolocation;
+    nextRoomId: _360MakerId;
+    position: Point3D;
+    rotation: {
+        _order: "XYZ" | string;
+        _x: number;
+        _y: number;
+        _z: number;
+        isEuler: boolean;
+    };
+};
+export type _360Tag = {
+    id: string;
+    tagType: string;
+    comment: string;
+    creationDate: number;
+    currentRoom: _360MakerId;
+    position: Point3D;
+    cameraRotation: _360CameraRotation;
+};
+export type _360FloorId = string | number;
+export type _360Walk = Record<_360FloorId, _360Floor>;
+export type _360MakerId = string;
+export type _360Floor = {
+    _3DMarkers: _360Marker3D[];
+    cameraRotation: _360CameraRotation;
+    fbxModel: string;
+    fbxModelHQ?: string;
+    pointCloudModelHQ?: string;
+    initialMarker: _360MakerId;
+    modelViewerFeatureFlag: boolean;
+    imagesOnlyFeatureFlag?: boolean;
+    forgeBIMFeatureFlag?: boolean;
+    isForgeGravityEnabled?: boolean;
+    initialForgeView?: ForgeView | null;
+    enhancedLightFeatureFlag?: boolean;
+    calibrationDetails?: Record<string, unknown>;
+    route: {
+        cameraHeadingOffset: string;
+        overlayID: number;
+        track: string;
+    };
+    sceneScale: number;
+    steps: number;
+    tags?: Record<string, _360Tag>;
+};
+export type _360WalkV2 = {
+    archive: string;
+    date: string;
+    deviceSerial: string | null;
+    endPosition: unknown | null;
+    floor: string;
+    floorId: number;
+    id: number;
+    images: string[];
+    insertedAt: string;
+    mobileAudios: string[];
+    mobileAudiosArchive: string;
+    mobilePhotos: string[];
+    mobilePhotosArchive: string;
+    model: string;
+    name: string;
+    processingStatus: string;
+    projectId: string;
+    report: string;
+    route: unknown | null;
+    startPosition: unknown | null;
+    tusLinks: unknown | null;
+    updatedAt: string;
+    uploadedBy: string;
+    videoArchive: string;
+    videos: string[];
+};
+export type _360FloorV2 = {
+    id: _360FloorId;
+    assets: _360WalkV2[];
+    projectId: string;
+    name: string;
+    mapStyle: string;
+    hasOverlay: boolean;
+    isCalibrated: boolean;
+    createdBy: string | null;
+    overlayPosition: _360OverlayPosition;
+    insertedAt: string;
+    updatedAt: string;
+};
+export type _360Scene = {
+    date: string;
+    dateID: number;
+    floors: {
+        floorID: _360FloorId;
+        name: string;
+    }[];
+    polarAngle: number;
+    azimuthAngle: number;
+};
+export declare enum _360PinType {
+    Default = "Default"
+}
+export type _360Pin = {
+    position: Point3D;
+    pinType: _360PinType;
+    pinId?: string;
+    cameraExid?: string;
+    name: string;
+    currentRoom?: _360MakerId;
+    cameraRotation?: _360CameraRotation;
+};
+export type _360SceneRoute = {
+    cameraHeadingOffset?: number;
+    overlayID?: number;
+    track?: string;
+};
+export type _360ProjectListItem = {
+    integrationType: string;
+    projectId: string;
+    projectName: string;
+    providerID: string;
+    providerPrefix: string;
+    providerSuffix: string;
+    timeline: string;
+    uniqueId: string;
+};
+export type _360FullProject = {
+    dates: _360SceneWithFloors[];
+    integrationType: string;
+    projectId: string;
+    projectName: string;
+    providerID: string;
+    providerPrefix: string;
+    providerSuffix: string;
+    timeline: string;
+    uniqueId: string;
+};
+export type _360FullFloor = _360Floor & {
+    id: _360FloorId;
+    name: string;
+};
+export type _360SceneWithFloors = _360Scene & {
+    floors: _360FullFloor[];
+};
+export type _360ProjectJsonResponse = {
+    dates: _360Scene[];
+    [key: string]: any;
+};
+export type MobileCaptureSnapshot = {
+    id: string | number;
+    projectId?: string;
+    uploadedBy: string;
+    updatedAt: string;
+    assetType: string;
+    thumbnailUrl: string;
+};
+export declare enum _360UrlParams {
+    DateId = "date_id",
+    Date = "date",
+    Floor = "floor",
+    Marker = "marker",
+    PolarAngle = "polarAngle",
+    AzimuthAngle = "azimuthAngle"
+}
+export declare enum _360AssetType {
+    Video = "video",
+    Image = "image",
+    Model = "model",
+    Route = "route",
+    MobilePhoto = "mobile_photos",
+    MobileAudio = "mobile_audios"
+}
+export declare enum _360AssetLabel {
+    Walks = "walks",
+    MobilePhotos = "mobilePhotos"
+}
+export declare enum _360Feature {
+    BIM = "BIM",
+    Minimap = "Minimap",
+    Minimodel = "Minimodel"
+}
+export declare enum _360IntergrationType {
+    Evercam = "Evercam",
+    Matterport = "Matterport",
+    OpenSpace = "Openspace",
+    HoloBuilder = "Holobuilder",
+    DroneDeploy = "Dronedeploy"
+}
+export declare enum PathMarkerColor {
+    Start = "#00e74c",
+    End = "#fd7567",
+    Default = "#2196F3"
+}
+export type _360AssetsQueryParams = {
+    page: number;
+    limit: number;
+    projectID: string;
+    date: DateType;
+    floor: string;
+    id: string;
+};
+export type _360AssetsRequestPayload = {
+    projectId: string;
+    date: DateType;
+    floor: string;
+    uploadedBy?: string;
+};
+export type DrawingsRequestPayload = {
+    projectId?: string;
+    name?: string;
+    changedBy?: string;
+    mapStyle?: string;
+    startDate?: string;
+    endDate?: string;
+    id?: number;
+    page?: number;
+    limit?: number;
+    paginate?: boolean;
+    withAsset?: boolean;
+};
+export type GenerateFloorPayload = {
+    overlay?: {
+        url: string;
+        title: string;
+        fileExtension: string;
+    };
+    changedBy: string;
+    name?: string;
+    mapStyle?: string;
+    overlayPositionCorners: _360OverlayPosition;
+};
+export type _360QueueQueryParams = {
+    projectId?: string;
+};
+export type _360AssetsUploadPayload = {
+    targetPointsCount: number;
+    assetType: string;
+    upload: {
+        url: string;
+        title: string;
+        fileExtension: string;
+    }[];
+    deviceSerial: string;
+    startPosition: string;
+    endPosition: string;
+    isTimelapse: boolean;
+    isImagesOnly: boolean;
+};
+export type Generate360MapRequestPayload = {
+    dateId: string;
+    floorId: string;
+    cameraOffset: string;
+    startPoint: string;
+    endPoint: string;
+};