@evercam/api 1.0.0-ca4bfd0ab → 1.0.0-cb5ac4ad5

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

@@ -0,0 +1,3 @@
+export * from "@evercam/api/api";
+import { axios } from "@evercam/api/api";
+export default axios;

package/dist/shared/components/timelinePlayer/providers/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./timelineDataProvider";
+export * from "./timelineAnprProvider";
+export * from "./timelineLuminanceProvider";

package/dist/shared/components/timelinePlayer/providers/timelineAnprProvider.d.ts

@@ -0,0 +1,17 @@
+import { TimelineCountEvent, TimelineEvent } from "@evercam/ui";
+import { CameraExid, ProjectExid, TimelineDateInterval, TimelineProviderRequestParams } from "@evercam/shared/types";
+import { TimelineDataProvider } from "./timelineDataProvider";
+export declare class TimelineAnprProvider extends TimelineDataProvider {
+    readonly projectExid: ProjectExid;
+    readonly cameraExid: CameraExid;
+    readonly token: string;
+    constructor(params: {
+        timezone: string;
+        projectExid: ProjectExid;
+        cameraExid: CameraExid;
+        token: string;
+    });
+    fetchEvents({ fromDate, toDate, }: TimelineDateInterval): Promise<Array<TimelineEvent>>;
+    fetchCounts({ fromDate, toDate, precision, }: TimelineProviderRequestParams): Promise<Array<TimelineCountEvent>>;
+    private getFormattedPlateNumber;
+}

package/dist/shared/components/timelinePlayer/providers/timelineDataProvider.d.ts

@@ -0,0 +1,13 @@
+import { type TimelineCountEvent, type TimelineEvent, type TimelineRangeEvent } from "@evercam/ui";
+import { type TimelineDateInterval, TimelinePrecision, type TimelineProviderRequestParams } from "@evercam/shared/types";
+export declare abstract class TimelineDataProvider {
+    protected timezone: string;
+    constructor(timezone: string);
+    fetch(params: TimelineProviderRequestParams): Promise<Array<TimelineEvent>>;
+    protected abstract fetchEvents(params: TimelineProviderRequestParams): Promise<Array<TimelineEvent>>;
+    protected abstract fetchCounts(params: TimelineProviderRequestParams): Promise<Array<TimelineCountEvent | TimelineRangeEvent>>;
+    formatTimestamp(date: string, format?: string): string;
+    processResponseIntervals(intervals: TimelineDateInterval[], precision: TimelinePrecision): TimelineRangeEvent[];
+    private convertAndRoundIntervals;
+    private groupAdjacentIntervals;
+}

package/dist/shared/components/timelinePlayer/providers/timelineLuminanceProvider.d.ts

@@ -0,0 +1,16 @@
+import { type TimelineCountEvent, type TimelineEvent } from "@evercam/ui";
+import { type CameraExid, type ProjectExid, type TimelineDateInterval, type TimelineProviderRequestParams } from "@evercam/shared/types";
+import { TimelineDataProvider } from "./timelineDataProvider";
+export declare class TimelineLuminanceProvider extends TimelineDataProvider {
+    readonly projectExid: ProjectExid;
+    readonly cameraExid: CameraExid;
+    readonly token: string;
+    constructor(params: {
+        timezone: string;
+        projectExid: ProjectExid;
+        cameraExid: CameraExid;
+        token: string;
+    });
+    fetchEvents({ fromDate, toDate, }: TimelineDateInterval): Promise<Array<TimelineEvent>>;
+    fetchCounts({ fromDate, toDate, }: TimelineProviderRequestParams): Promise<Array<TimelineCountEvent>>;
+}

package/dist/shared/types/components.d.ts

@@ -0,0 +1,512 @@
+import { type _360Scene, type Media, type DroneModel, type MobileCaptureSnapshot, type TimelineDateInterval, type TimelinePrecision, type Comment, type ProcoreUserProject, type ProcoreProjectAlbum, type ProcoreObservationType, type AconexUserProject, type AutodeskUserHub, type AutodeskProject, type AutodeskFolder, type ProcoreType, type HammertechProject, type HammertechIssueType, type HammertechPriority, type HammertechClassification, type HammertechFileFieldValue, Tag, TuplePoint2D, CameraStatus } from "@evercam/shared/types";
+import type { _360AssetType, AdminCamera, Camera, IngestUploadInitResponse } from "@evercam/api/types";
+import type { TimelineChartType, TimelineEvent, TimelineEventsGroup } from "@evercam/ui";
+import { TimelineDataProvider } from "@evercam/shared/components/timelinePlayer/providers";
+import { SeriesOptionsType } from "highcharts";
+export type ReorderableCamera = Camera & {
+    thumbnailSrc?: string;
+    batteryLevel?: {
+        voltage: number;
+        level: string;
+        icon: string;
+        color: string;
+    } | null;
+};
+export type SelectItem = {
+    text: string;
+    value: string | number;
+};
+export type RoiProjectGroup = {
+    exid: string;
+    name: string;
+    cameras: AdminCamera[];
+};
+export declare enum IframeMessageType {
+    LiveView = "liveView",
+    EditSnapshot = "editSnapshot",
+    Weather = "weather",
+    CameraInfo = "cameraInfo",
+    AnalyticsEvent = "analyticsEvent",
+    Ready = "ready",
+    Info = "info",
+    GateReport = "gateReport",
+    CreateCompare = "createCompare",
+    UploadDrone = "uploadDrone",
+    UploadBIM = "uploadBIM",
+    History = "history",
+    PerformanceScore = "performanceScore",
+    ShareLink = "shareLink",
+    LoadForgeModel = "loadForgeModel",
+    LoadPlannerList = "loadPlannerList",
+    SaveProjectBounds = "saveProjectBounds",
+    ArchiveComment = "archiveComment",
+    UnarchiveComment = "unarchiveComment",
+    DeleteComment = "deleteComment",
+    CreateComment = "createComment",
+    RefreshComments = "refreshComments",
+    CommentSyncFailed = "commentSyncFailed",
+    Load360Gallery = "load360Gallery",
+    Upload360 = "upload360",
+    FetchForgeToken = "FetchForgeToken",
+    ForgeTokenResponse = "ForgeTokenResponse",
+    ShowBimUploadChoice = "showBimUploadChoice",
+    ViewerLaunchFlags = "viewerLaunchFlags",
+    Fetch360DrawingIds = "fetch360DrawingIds",
+    DrawingIdsResponse = "drawingIdsResponse",
+    CloseCameraMarkerPreview = "CloseCameraMarkerPreview",
+    ChatInit = "chatInit",
+    ChatToken = "chatToken",
+    ChatContext = "chatContext",
+    ChatTheme = "chatTheme",
+    ChatNavigate = "chatNavigate",
+    ChatConversations = "chatConversations",
+    ChatOpenConversation = "chatOpenConversation",
+    ChatNewConversation = "chatNewConversation",
+    ChatRenameConversation = "chatRenameConversation",
+    ChatDeleteConversation = "chatDeleteConversation",
+    ChatOpenWalkMarker = "chatOpenWalkMarker",
+    ProjectMembers = "projectMembers",
+    FocusComment = "focusComment"
+}
+export declare enum ChatTheme {
+    Dark = "dark",
+    Light = "light"
+}
+export type ChatUser = {
+    email: string;
+    name: string;
+};
+/**
+ * The dashboard's answer to the frame's `Ready`.
+ *
+ * The token travels here and nowhere else — never in the iframe URL, which
+ * would land it in history, referrers and logs.
+ */
+export type ChatInitPayload = {
+    token: string;
+    user: ChatUser;
+    theme: ChatTheme;
+    timezone: string;
+};
+/** Pushed on rotation. A frame holding a mount-time token 401s the moment it changes. */
+export type ChatTokenPayload = {
+    token: string;
+};
+/** Pushed on every dashboard route change. */
+export type ChatContextPayload = {
+    pageId: string;
+    projectExid: string | null;
+    projectName: string | null;
+    cameraExid: string | null;
+    timezone: string;
+    /**
+     * A conversation to open, from `?chat=` on the dashboard's URL.
+     *
+     * Deep-linking lives in the *context* rather than in a message of its own
+     * because it is exactly that — a fact about where the host currently is, sent
+     * on every route change alongside the project and page. `null` means "no
+     * opinion", which is what every other page sends.
+     */
+    chatId: string | null;
+};
+export type ChatThemePayload = {
+    theme: ChatTheme;
+};
+/**
+ * A page id plus params, never a route string — the dashboard owns the
+ * id → route mapping.
+ */
+export type ChatNavigatePayload = {
+    pageId: string;
+    params: Record<string, string>;
+};
+/**
+ * Open a 360-walk marker in the 360 viewer, facing one view.
+ *
+ * Sent by Chat when a `WalkView` in an answer is clicked. The dashboard opens the
+ * 360 app in its own dialog (`Walk360Preview`), outside the chat frame, so the
+ * viewer gets the whole screen. `walkName` and `walkDate` are how the 360 app
+ * knows a walk (its `floor` and `date` URL params); `camera` is the viewer's own
+ * azimuth/polar angles for that view, or null to open at the marker's default.
+ */
+export type ChatOpenWalkMarkerPayload = {
+    projectExid: string;
+    walkId: string;
+    walkName: string;
+    walkDate: string;
+    markerId: string;
+    view: string;
+    camera: {
+        azimuthAngle: number;
+        polarAngle: number;
+    } | null;
+};
+/**
+ * One conversation, as the dashboard's sidebar needs it.
+ *
+ * A deliberate projection of the engine's `ChatSession` — a label and a
+ * timestamp, nothing else. The transcript stays in the frame: mirroring `turns`
+ * would put every message of every conversation on the bridge each time the list
+ * changed, to render a row that shows neither.
+ */
+export type ChatSessionSummary = {
+    id: string;
+    title: string | null;
+    updatedAt: string;
+};
+/**
+ * The frame's conversation list, mirrored up for the left sidebar to draw.
+ *
+ * The frame stays the single owner of this data — it holds the engine client and
+ * the bearer. The host renders and sends intent back; it never fetches.
+ */
+export type ChatConversationsPayload = {
+    sessions: ChatSessionSummary[];
+    openId: string | null;
+    isLoading: boolean;
+};
+export type ChatOpenConversationPayload = {
+    id: string;
+};
+export type ChatRenameConversationPayload = {
+    id: string;
+    title: string;
+};
+export type ChatDeleteConversationPayload = {
+    id: string;
+};
+export declare enum NavigationArrow {
+    Previous = "previous",
+    Next = "next"
+}
+export declare enum WatermarkedImageDownloadOrigin {
+    Drone = "drone",
+    Bim = "BIM",
+    Snapshot = "snapshot",
+    The360 = "360",
+    Planner = "Planner"
+}
+export declare enum PlayerMode {
+    Video = "video",
+    Jpegs = "jpegs"
+}
+export type TimelineProviderRequestParams = TimelineDateInterval & {
+    precision?: TimelinePrecision;
+    labels?: string[];
+    trackId?: number;
+};
+export type TimelinePlayerGroupConfig = {
+    provider?: TimelineDataProvider;
+    events?: Array<TimelineEvent>;
+    getChartType?: (precision: TimelinePrecision) => TimelineChartType;
+} & Omit<TimelineEventsGroup, "events">;
+export type TimelinePlayerConfig = {
+    [groupName: string]: TimelinePlayerGroupConfig;
+};
+export declare enum TimelineGroupId {
+    ThreeSixty = "w360",
+    Drone = "drone",
+    Bim = "bim",
+    Media = "media",
+    Comments = "comments",
+    Anpr = "anpr",
+    MobileCapture = "mobileCapture",
+    ExNvrRecordings = "exNvrRecordings",
+    Luminance = "luminance",
+    ObjectInspector = "objectInspector"
+}
+export type TimelineOverlayType = TimelineGroupId.ThreeSixty | TimelineGroupId.Drone | TimelineGroupId.Media | TimelineGroupId.MobileCapture | TimelineGroupId.Bim | TimelineGroupId.Comments | "compare";
+export type TimelineOverlayData<T extends TimelineOverlayType> = T extends TimelineGroupId.ThreeSixty ? _360Scene : T extends TimelineGroupId.Drone ? DroneModel : T extends TimelineGroupId.Media ? Media : T extends TimelineGroupId.MobileCapture ? MobileCaptureSnapshot : T extends TimelineGroupId.Comments ? Comment : never;
+export declare enum TimelineMarkerId {
+    Xray = "xray",
+    CurrentSnapshot = "current",
+    CompareBeforeSnapshot = "compareBefore",
+    CompareAfterSnapshot = "compareAfter",
+    ObjectInspectorFirstSeen = "firstSeen",
+    ObjectInspectorLastSeen = "lastSeen"
+}
+export type TimelineMediaHubItemsByType = {
+    clip?: Media[];
+    compare?: Media[];
+    edit?: Media[];
+    timelapse?: Media[];
+    xRay?: Media[];
+};
+export declare enum HighchartsStackingBehavior {
+    Overlap = "overlap",
+    Normal = "normal",
+    Percent = "percent",
+    Stream = "stream"
+}
+export declare enum LeaderLinePlugType {
+    Disc = "disc",
+    Square = "square",
+    Arrow1 = "arrow1",
+    Arrow2 = "arrow2",
+    Arrow3 = "arrow3",
+    Hand = "hand",
+    CrossHair = "crosshair",
+    Behind = "behind"
+}
+export declare enum LeaderLinesPathType {
+    Straight = "straight",
+    Arc = "arc",
+    Fluid = "fluid",
+    Magnet = "magnet",
+    Grid = "grid"
+}
+export declare enum LeaderLinesSocketPosition {
+    Top = "top",
+    Right = "right",
+    Bottom = "bottom",
+    Left = "left",
+    Auto = "auto"
+}
+export type LeaderLineOptions = {
+    startSocket?: LeaderLinesSocketPosition;
+    endSocket?: LeaderLinesSocketPosition;
+    color?: string | ((element: any) => string);
+    size?: number;
+    startPlug?: LeaderLinePlugType;
+    endPlug?: LeaderLinePlugType;
+    startPlugSize?: number;
+    endPlugSize?: number;
+    path?: LeaderLinesPathType;
+    startSocketGravity?: TuplePoint2D;
+    endSocketGravity?: TuplePoint2D;
+    dash?: {
+        animation: boolean | {
+            duration: number;
+        };
+    } | ((element: any) => {
+        animation: boolean | {
+            duration: number;
+        };
+    });
+};
+export type CssSelector = string;
+export type LineConfig = {
+    start: CssSelector | CssSelector[];
+    end: CssSelector | CssSelector[];
+    options?: LeaderLineOptions;
+};
+export declare enum ZohoDeskTicketStatus {
+    Closed = "Closed",
+    OnHold = "On Hold",
+    Open = "Open"
+}
+export type TagSelectorItem = Tag & {
+    isExcluded?: boolean;
+};
+export declare enum FormSchemaComponents {
+    SelectField = "SelectField",
+    HierarchicalSelect = "HierarchicalSelectField",
+    MultiOption = "MultiOption",
+    TextField = "TextField",
+    SwitchField = "SwitchField",
+    CheckBox = "CheckBoxField",
+    Date = "DatePickerInput",
+    DateTime = "DateTimeField",
+    Time = "TimeField",
+    TextArea = "Textarea",
+    Search = "Autocomplete",
+    ReadOnly = "ReadOnly",
+    Ratio = "RatioField"
+}
+export declare enum FormSchemaDataType {
+    String = "string",
+    Number = "number",
+    Boolean = "boolean",
+    Date = "date"
+}
+export type FormSchemaOptions = {
+    title: string;
+    value: string;
+    parentId?: string | null;
+};
+export type FormSchemaField = {
+    id: string;
+    component: FormSchemaComponents;
+    required?: boolean;
+    name: string;
+    options?: FormSchemaOptions[];
+    disabled?: boolean;
+    dataType: FormSchemaDataType;
+    multiple?: boolean;
+    defaultValue?: any;
+    columns?: number;
+};
+export type FormSchema = Record<string, FormSchemaField>;
+export type DrawingStats = {
+    overlay: boolean;
+    geolocated: boolean;
+    isCalibrated: boolean;
+    walks: number;
+    markers: number;
+    minimodel: number;
+    bim: number;
+    comments: number;
+    lastCapturedDate: string | null;
+};
+export interface ScrollListener {
+    element: Element | Window;
+    event: "scroll" | "resize";
+    handler: () => void;
+}
+export interface LeaderLineInstance {
+    remove(): void;
+    position(): void;
+}
+export type SnapshotCardItem = {
+    label?: string;
+    title?: string;
+    thumbnailUrl: string;
+    placeholderThumbnailUrl?: string;
+    fallbackThumbnailUrl?: string;
+};
+export type HighchartsSeriesWithData<T extends number = number> = SeriesOptionsType & {
+    data: T[];
+};
+export type NotificationTitleSegment = {
+    text: string;
+    isBold?: boolean;
+};
+export type FormattedNotificationData = {
+    title: string;
+    titleSegments?: NotificationTitleSegment[];
+    link: string;
+    thumbnail?: string;
+    icon: string;
+    excerpt?: string;
+    commentTarget?: {
+        commentId: number;
+        dateId: string | number;
+        floorId: string;
+    };
+};
+export type FormattedNotification = FormattedNotificationData & {
+    date: string;
+    read: boolean;
+    id: number;
+    thumbnailError?: boolean;
+};
+export type ProcoreProjectStepData = {
+    project: ProcoreUserProject | null;
+    album: ProcoreProjectAlbum | null;
+    observationType: ProcoreObservationType | null;
+};
+export type ProcoreUploadFormData = {
+    procoreType: ProcoreType;
+    project: ProcoreUserProject | null;
+    album: ProcoreProjectAlbum | null;
+    observationType: ProcoreObservationType | null;
+    observationForm: Record<string, string | number | boolean | null>;
+};
+export type AconexUploadFormData = {
+    project: AconexUserProject | null;
+    form: Record<string, string | number | boolean | null>;
+};
+export type AutodeskUploadFormData = {
+    hub: AutodeskUserHub | null;
+    project: AutodeskProject | null;
+    folder: AutodeskFolder | null;
+};
+export type HammertechUploadFormData = {
+    project: HammertechProject | null;
+    issueType: HammertechIssueType | null;
+    description: string;
+    priority: HammertechPriority | null;
+    dueDate: string | null;
+    classification: HammertechClassification | null;
+    locationId: string | null;
+    isPositiveObservation: boolean;
+    isPhotoForFixRequired: boolean;
+    customFieldFormId: string | null;
+    customFieldValues: Record<string, unknown>;
+    fileCustomFieldValues: Record<string, HammertechFileFieldValue>;
+};
+export interface MediaHubFilters {
+    title: string;
+    requesterEmail: string | undefined;
+    camera: string | undefined;
+    type: string;
+    fromDate: string;
+    toDate: string;
+    sortBy: string;
+}
+export interface MediaHubSortParameter {
+    label: string;
+    value: string;
+}
+export type TableHeaderParams<TItem = unknown> = {
+    value: string;
+    text: string;
+    align?: string;
+    sortable?: boolean;
+    visible?: boolean;
+    width?: number | string;
+    copyable?: boolean;
+    toStringFn?: (item: TItem, key: string) => any;
+    sort?: (a: unknown, b: unknown) => number;
+};
+export type BimUploadObject = IngestUploadInitResponse & {
+    projectName: string;
+};
+export type BimUploadFileResult = {
+    url: string;
+    title: string;
+    fileExtension: string;
+};
+export type CameraCardItem = {
+    thumbnail: string;
+    title: string;
+    exid: string;
+    status: CameraStatus;
+    disabled: boolean;
+    to: string;
+    isOffline: boolean;
+    isWaiting: boolean;
+    isUnderNda: boolean;
+    isAdmin: boolean;
+    batteryVoltage: number | null;
+};
+export type ThreeSixtyGalleryView = "drawings" | "walks";
+export interface ThreeSixtyWalk {
+    id: string;
+    name: string;
+    date: string;
+    monthKey: string;
+    color: string;
+    dateId: string;
+    floorId: string;
+    commentCount: number;
+    hasBim: boolean;
+    hasMinimodel: boolean;
+}
+export interface ThreeSixtyWalkGroup {
+    date: string;
+    walks: ThreeSixtyWalk[];
+}
+export type ThreeSixtyMediaDownloadOption = {
+    type: _360AssetType;
+    title: string;
+    icon: string;
+};
+export type DrawingSelection = {
+    pageNumber: number;
+    size: number;
+    thumbnail: string | null;
+    pageCount: number;
+};
+export type CommentCardComment = {
+    id?: number | string;
+    content?: string;
+    createdAt?: string;
+    archivedAt?: string;
+    creatorName?: string;
+    label?: string;
+    timestamp?: string;
+    cameraExid?: string;
+    position3d?: number[];
+    canDelete?: boolean;
+};

package/dist/shared/types/customDataTableFilters.d.ts

@@ -0,0 +1,10 @@
+export declare enum CustomDataTableFilterType {
+    Select = "SelectSearchFilter",
+    Text = "TextFieldSearchFilter"
+}
+export interface CustomDataTableFilterField<T = unknown> {
+    component: CustomDataTableFilterType;
+    attributes?: Record<string, unknown>;
+    customFilter?: (item: T, fieldName: string, search: unknown) => boolean;
+}
+export type CustomDataTableFilterFields<T = unknown> = Record<string, CustomDataTableFilterField<T>>;

package/dist/shared/types/imagePlayer.d.ts

@@ -0,0 +1,41 @@
+import type { Timestamp } from "@evercam/shared/types";
+export interface Frame {
+    label: string;
+    src: string;
+    srcSet?: SrcSet;
+    timestamp: Timestamp;
+}
+export interface InfoText {
+    index: string;
+    label: string;
+}
+export type EventMarker<T extends {}> = T & {
+    label: string;
+    thumbnailUrl: string;
+    isActive: boolean;
+    markerType?: RecordingsMarker;
+};
+export type SnapshotEvent<T extends {}> = T & {
+    eventTime: Timestamp;
+};
+export type MatchedSnapshotEvent<T extends {}> = SnapshotEvent<T> & {
+    frameIndex: number;
+    snapshotTimestamp: Timestamp;
+};
+export declare enum RecordingsMarker {
+    Comment = "comment",
+    GateReport = "gate-report",
+    Anpr = "anpr",
+    Detection = "detection",
+    SmartSearch = "smart-search"
+}
+export declare enum ImageQuality {
+    ThreeSixty = "360",
+    FourEighty = "480",
+    SevenTwenty = "720",
+    OneZeroEightZero = "1080",
+    Auto = "auto"
+}
+export type SrcSet = {
+    [q in ImageQuality]: string;
+};

package/dist/shared/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from "@evercam/api/types";
+export * from "./components";
+export * from "./customDataTableFilters";
+export * from "./imagePlayer";
+export * from "./timeline";
+export * from "./rbac";
+export * from "./observations";

package/dist/shared/types/observations.d.ts

@@ -0,0 +1,25 @@
+export type ObservationsTableHeader = {
+    isThumbnail?: boolean;
+    visible: boolean;
+    divider: boolean;
+    sortable: boolean;
+    text: string;
+    value: string;
+    class: string;
+    align: string;
+};
+export type ObservationsCountDay = {
+    day: string;
+};
+export type ObservationsTableOptionsUpdate = {
+    page: number;
+    sortBy: string[];
+    sortDesc: boolean[];
+};
+export type ObservationsEventsTableState = {
+    height: number | string;
+};
+export type ObservationTypeOption = {
+    value: string;
+    label: string;
+};