@evercam/api 1.0.0-e6c3bb6ca → 1.0.0-e8fa39610

package/dist/{types → api/types}/shared.d.ts

@@ -1,7 +1,17 @@
-import { DateType } from "@/types";
+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}`;
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+export type JsonObject = {
+    [key: string]: JsonValue;
+};
+export type JsonArray = JsonValue[];
 export type BatteryReading = {
     id: number;
     voltage: number;
@@ -53,7 +63,7 @@ export declare enum UnitSystem {
     Metric = "metric"
 }
 export type Timestamp = string | number;
-export type Schedule = {
+export type ScheduleUppercase = {
     Friday: string[];
     Monday: string[];
     Saturday: string[];
@@ -71,6 +81,7 @@ export type ScheduleLowercase = {
     tuesday: string[];
     wednesday: string[];
 };
+export type Schedule = ScheduleUppercase | ScheduleLowercase;
 export type PaginationParams = {
     sort?: SortingUrlParam;
     page?: number;
@@ -90,11 +101,6 @@ export declare enum _3dViewer {
     Itwin = "itwin",
     Cesium = "cesium"
 }
-export declare enum SsoProvider {
-    Microsoft = "microsoft",
-    Google = "google",
-    Evercam = "evercam"
-}
 export declare enum InfoPage {
     ThreeSixtyView = "360",
     BIMView = "bim",
@@ -105,7 +111,7 @@ export declare enum InfoPage {
     Timeline = "timeline",
     WeatherReport = "weather-report"
 }
-export declare enum DownloadTypes {
+export declare enum DownloadFileType {
     Jpeg = "jpeg",
     Pdf = "pdf",
     Csv = "csv"
@@ -113,11 +119,11 @@ export declare enum DownloadTypes {
 export declare enum FeedbackContext {
     CopilotMessage = "copilot_message"
 }
-export type FeedbackPayload<T> = {
+export type FeedbackPayload = {
     id?: number;
     user: string;
     text: string;
-    type: T;
+    type: string;
     context: FeedbackContext;
     messageId?: number;
     conversationId?: number;
@@ -131,6 +137,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 = {

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

@@ -0,0 +1,58 @@
+import type { DateType } from "@evercam/api/types";
+export type ShareRequest = {
+    cameraId: string;
+    createdAt: DateType | number;
+    email: string;
+    id: number;
+    rights: string;
+    sharerEmail: string;
+    sharerName: string;
+    userId: number;
+};
+export type Share = {
+    cameraId: string;
+    createdAt: DateType | number;
+    email: string;
+    fullname: string;
+    id: number;
+    lastSeenAt: DateType;
+    rights: string;
+    sessionCount: number;
+    sharerEmail: string;
+    sharerId: number;
+    sharerName: string;
+    userId: number;
+    isUserAccessRestricted: boolean;
+};
+export type ShareDeletionRequestPayload = {
+    email?: string;
+    key?: string;
+    origin?: string;
+};
+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[];
+};
+export declare enum InviteStatus {
+    Pending = 0,
+    Cancelled = -1,
+    Used = 1,
+    Failed = -2
+}
+export declare enum ShareVisibility {
+    PublicDiscoverable = "publicDiscoverable",
+    PublicUndiscoverable = "publicUndiscoverable",
+    Private = "private"
+}

package/dist/{types → api/types}/sim.d.ts

@@ -1,4 +1,4 @@
-import { DateTime, PaginationParams } from "@/types";
+import { PaginationParams } from "@evercam/api/types";
 export declare enum SmsCommands {
     Cellular = "cellular",
     Gpson = "gpson",
@@ -63,7 +63,7 @@ export type Sim = {
     puk: string;
     iccid: string;
     description: string;
-    lastSmsAt: DateTime;
+    lastSmsAt: string;
     cameras: {
         name: string;
         exid: string;
@@ -79,11 +79,11 @@ export type SendSmsResponse = {
     errorText: string;
 };
 export type SmsHistory = {
-    insertedAt: DateTime;
+    insertedAt: string;
     type: string;
     status: string;
     text: string;
-    deliveryDatetime: DateTime;
+    deliveryDatetime: string;
 };
 export type SmsHistoryResponse = {
     singleSimSms: SmsHistory[];
@@ -98,8 +98,8 @@ export type Sms = {
     status: string;
     text: string;
     type: string;
-    insertedAt: DateTime;
-    deliveryDatetime: DateTime;
+    insertedAt: string;
+    deliveryDatetime: string;
 };
 export type SmsQueryParams = PaginationParams & {
     dateRange: string;

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

@@ -0,0 +1,287 @@
+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",
+    Segments = "segments"
+}
+export type SmartSearchObjectPart = {
+    id?: string;
+    type: SmartSearchComponentType.Object;
+    value: DetectionLabel;
+};
+export type SmartSearchOperatorPart = {
+    id?: string;
+    type: SmartSearchComponentType.Operator;
+    value: SmartSearchOperatorType;
+};
+export type SmartSearchConditionPart = {
+    id?: string;
+    type: SmartSearchComponentType.Condition;
+    value: SmartSearchCondition | SmartSearchConditionData;
+};
+export type SmartSearchViewPart = {
+    id?: string;
+    type: SmartSearchComponentType.View;
+    value: SiteAnalyticsView;
+};
+export type SmartSearchAreaPart = {
+    id?: string;
+    type: SmartSearchComponentType.Area;
+    value: BBox;
+};
+export type SmartSearchTimePart = {
+    id?: string;
+    type: SmartSearchComponentType.Time;
+    value: Schedule | ScheduleLowercase;
+};
+export type SmartSearchDateRangePart = {
+    id?: string;
+    type: SmartSearchComponentType.DateRange;
+    value: DateRangeFilter;
+};
+export type SmartSearchPart = SmartSearchObjectPart | SmartSearchOperatorPart | SmartSearchConditionPart | SmartSearchViewPart | SmartSearchAreaPart | SmartSearchTimePart | SmartSearchDateRangePart;
+export type SmartSearchPartOrGroup = SmartSearchPart | SmartSearchPart[];
+export declare enum SmartSearchComponentType {
+    Condition = "condition",
+    Object = "object",
+    Area = "in_area",
+    Time = "time",
+    Operator = "operator",
+    View = "view",
+    DateRange = "date_range",
+    Heatmap = "heatmap"
+}
+export type SmartSearchPartType = SmartSearchComponentType | SmartSearchCondition;
+export type SmartSearchComponentData = {
+    id: string;
+    type: SmartSearchComponentType;
+    parts: SmartSearchPartOrGroup[];
+};
+export declare enum SmartSearchCondition {
+    InArea = "in_area",
+    Intersects = "intersects",
+    Time = "time"
+}
+export type SmartSearchConditionData = {
+    condition: SmartSearchCondition;
+    value: string | BoundingBox | DetectionLabel | Date;
+};
+type SmartSearchBackendConditionBase = {
+    target: SmartSearchTargets;
+};
+export type SmartSearchSelectionCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Selection;
+    operator: SmartSearchOperators;
+    attribute: string;
+    value: string | number | string[];
+};
+export type SmartSearchSpatialCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Spatial;
+    operator: SmartSearchOperators;
+    reference: {
+        target: SmartSearchTargets;
+        attribute: string;
+        value: string | number | string[];
+    };
+};
+export type SmartSearchAreaCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Area;
+    operator: SmartSearchOperators;
+    polygon: BBox;
+};
+export type SmartSearchGeoAreaCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.GeoArea;
+    operator: SmartSearchOperators;
+    polygon: BBox;
+};
+export type SmartSearchBackendQueryCondition = SmartSearchSelectionCondition | SmartSearchSpatialCondition | SmartSearchAreaCondition | SmartSearchGeoAreaCondition;
+export type SmartSearchBackendQuery = {
+    returnTargets: SmartSearchTargets[];
+    rulesLogic: SmartSearchOperatorType;
+    rules: {
+        logic: SmartSearchOperatorType;
+        conditions: SmartSearchBackendQueryCondition[];
+    }[];
+    returnType: SmartSearchReturnType;
+    timeSchedule?: Schedule;
+};
+export declare enum SmartSearchTargets {
+    Tracking = "tracking",
+    Segments = "segments"
+}
+export declare enum SmartSearchReturnType {
+    All = "all",
+    FirstLastSeen = "first_last_seen"
+}
+export declare enum SmartSearchOperatorType {
+    And = "AND",
+    Or = "OR"
+}
+export declare enum SmartSearchOperators {
+    Near = "near",
+    Far = "far",
+    Intersects = "intersects",
+    DoesNotIntersect = "does_not_intersect",
+    Inside = "inside",
+    Outside = "outside",
+    DistanceBelow = "distance_below",
+    DistanceAbove = "distance_above",
+    Area = "in_area",
+    Equal = "="
+}
+export declare enum SmartSearchConditionTypes {
+    Selection = "selection",
+    Spatial = "spatial",
+    Area = "area",
+    GeoArea = "in_geo_area",
+    Iou = "iou",
+    Near = "near",
+    Far = "far"
+}
+export type SmartSearchOptionValue = DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | DateRangeFilter | SiteAnalyticsView;
+export type SmartSearchBackendQueryPayload = {
+    name: string;
+    description: string;
+    query: SmartSearchBackendQuery;
+    fromDate?: DateType;
+    toDate?: DateType;
+    author: string;
+    createdAt: DateType;
+    params?: {
+        start: string;
+        end: string;
+    };
+};
+export type SavedQuery = {
+    description: string;
+    id: number;
+    query: SmartSearchBackendQuery;
+    params: Record<string, string>;
+    components?: Omit<SmartSearchPart, "id">[];
+    toDate?: DateType;
+    createdAt?: DateType;
+    cameraExid: string;
+    name: string;
+    fromDate?: DateType;
+    author?: string;
+};
+export type DetectionsRequestParams = {
+    projectExid: ProjectExid;
+    cameraExids: CameraExid[];
+    fromDate?: string;
+    toDate?: string;
+    labels?: Array<DetectionLabel | PpeLabel>;
+    modelId?: DetectionModel;
+    trackId?: number;
+    thresholds?: string[];
+    excludeLabels?: Array<DetectionLabel | PpeLabel>;
+    mergedClasses?: Array<string>;
+    confidenceThreshold?: number;
+} & PaginationParams;
+export type DetectionsExportRequestParams = DetectionsRequestParams & {
+    fileType: DownloadFileType;
+    columns?: string[];
+    directDownload?: boolean;
+};
+export type SmartSearchHeatmapPoint = {
+    coordinates: TuplePoint2D;
+    detectionsCount: number;
+};
+export type SmartSearchHeatmapData = {
+    label: string;
+    points: SmartSearchHeatmapPoint[];
+};
+export type SmartSearchNearConfig = {
+    sourceLabels: DetectionLabel[];
+    targetLabel?: DetectionLabel;
+};
+export type HeatmapIntersectionsRequestParams = CameraDateRangeFilter & SmartSearchNearConfig;
+export type SmartSearchSidebarItem = {
+    key: string;
+    displayLabel: string;
+    data: SmartSearchHeatmapData;
+    imagePath?: string;
+};
+export declare enum SiteAnalyticsViewType {
+    Camera = "camera",
+    ThreeSixty = "360"
+}
+export type SiteAnalyticsCameraView = {
+    type: SiteAnalyticsViewType.Camera;
+    id: CameraExid;
+    value: Camera | AdminCamera;
+};
+export type SiteAnalytics360View = {
+    type: SiteAnalyticsViewType.ThreeSixty;
+    id: _360FloorId;
+    value: _360FloorV2;
+};
+export type SiteAnalyticsView = SiteAnalyticsCameraView | SiteAnalytics360View;
+export type SiteAnalyticsProcessingStatusPayload = {
+    projectExid?: ProjectExid;
+    fromDate?: DateType;
+    toDate?: DateType;
+    cameraExid?: CameraExid;
+    drawingId?: string;
+    features?: CameraFeatureFlag[];
+};
+export type SiteAnalyticsProcessingStatus = {
+    projectExid: ProjectExid;
+    viewType: SiteAnalyticsViewType;
+    viewId: string;
+    feature: CameraFeatureFlag;
+    processedIntervals: TimelineDateInterval[];
+};
+export type SmartSearchRequestPayload = {
+    cameraExids?: CameraExid[];
+    drawingIds?: _360FloorId[];
+    walkIds?: string[];
+    markerIds?: string[];
+    payload: SmartSearchBackendQuery;
+    fromDate?: string;
+    toDate?: string;
+    page?: number;
+    limit?: number;
+    threshold?: number;
+};
+type SmartSearchResultItemBase = {
+    area: number;
+    bbox: BBox;
+    cameraExid?: CameraExid;
+    centroid: number[];
+    confidenceScore: number;
+    drawingId?: _360FloorId;
+    label: DetectionLabel;
+    modelId: DetectionModel;
+    projectExid: ProjectExid;
+    segmentId?: number;
+    trackId: number;
+    walkId?: string | number;
+};
+export type SmartSearchResultItemFirstLastSeen = SmartSearchResultItemBase & {
+    firstSeen: DateType;
+    firstSeenMarkerId?: string | number;
+    lastSeen: DateType;
+    lastSeenMarkerId?: string | number;
+};
+export type SmartSearchResultItemAll = SmartSearchResultItemBase & {
+    walkId?: string | number;
+    markerId?: string | number;
+    geolocation?: number[];
+    mask?: number[][];
+    timestamp: DateType;
+};
+type SmartSearchResultItemByType = {
+    [SmartSearchReturnType.FirstLastSeen]: SmartSearchResultItemFirstLastSeen;
+    [SmartSearchReturnType.All]: SmartSearchResultItemAll;
+};
+export type SmartSearchResponse<R extends SmartSearchReturnType = SmartSearchReturnType.FirstLastSeen> = PaginatedItems<SmartSearchResultItemByType[R]>;
+export type SmartSearchMinifiedPart = {
+    t: SmartSearchComponentType;
+    v: unknown;
+};
+export type SmartSearchMinifiedComponent = {
+    t: SmartSearchComponentType;
+    p: SmartSearchMinifiedPart[];
+};
+export {};

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,99 @@
+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 SnapshotEmailDeliveryRequestPayload = {
+    snapshot: string;
+    recipients?: string[];
+    message?: string;
+};
+export type SnapshotEmailDeliveryResponsePayload = {
+    warning?: 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;
+};