@evercam/api 1.0.0-003291add

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

@@ -0,0 +1,74 @@
+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;
+};
+export type ForgeAccAlignmentData = {
+    bbox: {
+        min: Point2D;
+        max: Point2D;
+    };
+    transform: number[];
+};
+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[];
+    isEvercamAccount?: boolean;
+    accDrawingsAlignments?: Record<string, ForgeAccAlignmentData>;
+    timeline?: TimelineItem[];
+    savedView?: ForgeView;
+    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/smartSeach.d.ts

@@ -0,0 +1,5 @@
+import { CameraExid } from "@evercam/api/types";
+export type SmartSearchQueriesRequestPayload = {
+    camerasExid: CameraExid[];
+    name?: string;
+};

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

@@ -0,0 +1,91 @@
+import { CameraExid, DateType, PaginationParams, Schedule } from "@evercam/api/types";
+export type SnapshotExtractionQyeryParams = PaginationParams & {
+    camera: string;
+    cameraExid: CameraExid;
+    status: SnapshotExtractionStatus;
+};
+export declare enum SnapshotExtractionStatus {
+    Completed = "completed",
+    Failed = "failed",
+    Processing = "processing"
+}
+export declare enum SnapshotExtractionType {
+    Cloud = "cloud",
+    Local = "local",
+    Timelapse = "timelapse"
+}
+export type SnapshotExtraction = {
+    id: number;
+    cameraId: number;
+    cameraExid: CameraExid;
+    cameraName: string;
+    fromDate: DateType;
+    toDate: DateType;
+    type: SnapshotExtractionType;
+    notes: string;
+    status: SnapshotExtractionStatus;
+    interval: number;
+    requestor: string;
+    jpegsToDropbox: boolean;
+    injectTo_cr: Boolean;
+    schedule: Schedule;
+    created_at: DateType;
+};
+export type SnapshotTestPayload = {
+    cameraExid?: CameraExid;
+    camUsername: string;
+    camPassword: string;
+    externalUrl: string;
+    jpgUrl: string;
+};
+export type SnapshotTestResponse = {
+    status: string;
+    data: string;
+};
+export type DeleteSnapshotQueryParams = {
+    fromDate: DateType;
+    toDate: DateType;
+    adminEmail: string;
+    adminFullname: string;
+};
+export type SnapshotTransfer = {
+    id: number;
+    sourceCamera: SnapshotTransferCamera;
+    targetCamera: SnapshotTransferCamera;
+    fromDate: DateType;
+    toDate: DateType;
+    overwriteExisting?: boolean | null;
+    deleteSource?: boolean | null;
+    requestor: SnapshotTransferRequestor;
+    status: SnapshotTransferStatus;
+    insertedAt: DateType;
+    attempts?: number | null;
+    errorMessage?: string | null;
+    snapshotsTransferred?: number | null;
+};
+export type SnapshotTransferCamera = {
+    id: number;
+    exid: CameraExid;
+    name: string;
+};
+export type SnapshotTransferRequestor = {
+    email: string;
+    firstname: string;
+    lastname: string;
+};
+export declare enum SnapshotTransferStatus {
+    Completed = "completed",
+    Failed = "failed",
+    Processing = "processing",
+    Pending = "pending",
+    Cancelled = "cancelled"
+}
+export type TransferCloudRecordingsQueryParams = PaginationParams & {
+    targetCameraExid: CameraExid;
+    fromDate: DateType;
+    toDate: DateType;
+    overwriteExisting?: boolean;
+    deleteSource?: boolean;
+    adminEmail?: string;
+    adminFullname?: string;
+};

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

@@ -0,0 +1,55 @@
+export type SsoProvider = {
+    id: number;
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};
+export type SsoUpdatePayload = {
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};
+export type SsoCreatePayload = {
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};

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

@@ -0,0 +1,19 @@
+import type { DateType } from "@evercam/api/types";
+export type StorageProvider = {
+    id?: number;
+    cameraId: number;
+    type: string;
+    provider: string;
+    url: string;
+    startDate: DateType;
+    endDate: DateType;
+    config: Record<string, any>;
+    insertedAt?: DateType;
+};
+export type StorageProvidersResponsePayload = {
+    providers: StorageProvider[];
+};
+export declare enum ProjectStorageProvider {
+    Seaweedfs = "seaweedfs",
+    S3 = "s3"
+}

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

@@ -0,0 +1,40 @@
+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;
+    name: string;
+    slug: string;
+    fullSlug: string;
+    content: TContent;
+    createdAt: string;
+    publishedAt: string | null;
+    updatedAt: string;
+    position: number;
+    tagList: string[];
+    isStartpage: boolean;
+    parentId: number | null;
+    groupId: string;
+    firstPublishedAt: string | null;
+    releaseId: number | null;
+    lang: string;
+    path: string;
+};
+export type StoryblokResponse<TContent extends JsonObject = JsonObject> = {
+    story: StoryblokStory<TContent>;
+    cv: number;
+    rels: JsonValue[];
+    links: JsonValue[];
+};

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

@@ -0,0 +1,97 @@
+import { KitMetricData } from "@evercam/api/types";
+export type ExNvrLoginResponse = {
+    accessToken: string;
+};
+export type ExNvrRecordingInterval = {
+    active: boolean;
+    startDate: string;
+    endDate: string;
+};
+export type ExNvrDeviceConfig = {
+    id: string;
+    name: string;
+    type: string;
+    state: ExNvrDeviceState;
+    credentials: {
+        password: string;
+        username: string;
+    };
+    mac: string;
+    url: string;
+    insertedAt: string;
+    updatedAt: string;
+    settings: {
+        storageAddress: string;
+        overrideOnFullDisk: boolean;
+        overrideOnFullDiskThreshold: number;
+        generateBif: boolean;
+    };
+    vendor: string;
+    model: string;
+    streamConfig: {
+        filename: string | null;
+        duration: string | null;
+        temporaryPath: string | null;
+        snapshotUri: string;
+        streamUri: string;
+        subStreamUri: string;
+    };
+    timezone: string;
+};
+export declare enum ExNvrFootageAvailableStatus {
+    Available = "Available",
+    NotAvailable = "Not Available"
+}
+export declare enum ExNvrDeviceState {
+    Recording = "recording",
+    Failed = "failed",
+    Stopped = "stopped"
+}
+export type ExNvrCpuStatus = {
+    load: number[];
+    numCores: number;
+};
+export type ExNvrMemoryStatus = {
+    systemTotalMemory: number;
+    freeMemory: number;
+    totalMemory: number;
+    bufferedMemory: number;
+    cachedMemory: number;
+    totalSwap: number;
+    freeSwap: number;
+    availableMemory: number;
+};
+export type ExNvrSolarChargerStatus = {
+    v: number;
+    vpv: number;
+    ppv: number;
+    i: number;
+    il: number;
+    load: string;
+    relayState: string;
+    offReason: number;
+    h19: number;
+    h20: number;
+    h21: number;
+    h22: number;
+    h23: number;
+    err: number;
+    cs: string;
+    fw: string;
+    pid: string;
+    serialNumber: string;
+};
+export type ExNvrSystemStatus = {
+    version: string;
+    cpu: ExNvrCpuStatus;
+    memory: ExNvrMemoryStatus;
+    solarCharger: ExNvrSolarChargerStatus;
+};
+export declare enum ExNvrMetricId {
+    CpuLoad = "cpu_load",
+    RamUsage = "ram_usage"
+}
+export type ExNvrMetric = KitMetricData & {
+    metricId: ExNvrMetricId;
+    value: number;
+};

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

@@ -0,0 +1,11 @@
+export declare enum PerformanceStatus {
+    Pending = "pending",
+    Done = "done"
+}
+export declare enum WebGLExtensions {
+    OESTextureFloat = "OES_texture_float",
+    EXTFloatBlend = "EXT_float_blend",
+    EXTTextureFilterAnisotropic = "EXT_texture_filter_anisotropic",
+    OESElementIndexUint = "OES_element_index_uint",
+    WEBGLDebugRendererInfo = "WEBGL_debug_renderer_info"
+}

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

@@ -0,0 +1,12 @@
+import { Kit } from "@evercam/api/types/kit";
+export type Tag<T = string> = {
+    id?: number;
+    name: T;
+    description?: string;
+    createdAt?: string;
+    updatedAt?: string;
+};
+export type KitTag = {
+    kit: Kit;
+    tag: Tag;
+};

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

@@ -0,0 +1,7 @@
+import { Moment } from "moment-timezone";
+export type DateType = Date | string | number;
+export type ExtendedDateType = Moment | DateType;
+export type DateRangeFilter = {
+    fromDate: DateType;
+    toDate: DateType;
+};

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

@@ -0,0 +1,106 @@
+import { DateType, Schedule } from "@evercam/api/types";
+export declare enum TimelapseStatus {
+    Pending = 11,
+    Completed = 5,
+    Failed = 7
+}
+export declare enum TimelapseDuration {
+    ThirtySeconds = 30,
+    SixtySeconds = 60,
+    NintySeconds = 90,
+    TwoMinutes = 120
+}
+export type TimelapseVideoOptions = {
+    width?: number;
+    height?: number;
+    removeTimestamp: boolean;
+    smoothTransition: boolean;
+    evercamWatermark: boolean;
+    sectionBlur?: boolean;
+    timestampPosition?: TimestampPositionCoordinates;
+    blurRegions?: BlurRegionCoordinates[];
+};
+export type TimestampPositionCoordinates = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+};
+export type BlurRegionPoint = {
+    x: number;
+    y: number;
+};
+export type BlurRegionCoordinates = BlurRegionPoint[];
+export type TimelapseLogoOptions = {
+    id?: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export declare enum TimelapseScheduleType {
+    Continuous = "continuous",
+    WorkingHours = "workingHours",
+    Custom = "custom"
+}
+export declare enum TimelapsePeriod {
+    Day = 1,
+    Week = 7,
+    Month = 30,
+    WholeProject = "whole_project",
+    Custom = "custom"
+}
+export declare enum TimelapseType {
+    Hour = "hour",
+    Day = "day",
+    Week = "week",
+    Month = "month",
+    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;
+    fromDatetime: string;
+    toDatetime: string;
+    cameraExid: string;
+    schedule: Schedule;
+    videoOptions: TimelapseVideoOptions;
+    logo?: TimelapseLogoOptions;
+};
+export type TimelapseCreationResponsePayload = {
+    Timelapse: {
+        camera: string;
+        createdAt: string;
+        fromDate: string;
+        id: number;
+        duration: number;
+        requestor: string;
+        schedule: Schedule;
+        status: number;
+        toDate: string;
+        updatedAt: string;
+    };
+};
+export type TimelapseSnapshotRequestPayload = {
+    from: string;
+    to: string;
+    schedule: string;
+    count: number;
+};
+export type TimelapseSnapshotResponsePayload = {
+    snapshots: string[];
+};
+export declare enum TimelapseExportStep {
+    Format = 1,
+    Effects = 2,
+    Confirm = 3,
+    Finish = 4
+}