@evercam/api 1.0.0-913c1fc0c → 1.0.0-9272abbb4

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

@@ -1,12 +1,26 @@
-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, TaskStatus, Tag, TuplePoint2D } from "@evercam/shared/types";
-import type { IngestUploadInitResponse } from "@evercam/api/types";
+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",
@@ -37,8 +51,130 @@ export declare enum IframeMessageType {
     ForgeTokenResponse = "ForgeTokenResponse",
     ShowBimUploadChoice = "showBimUploadChoice",
     ViewerLaunchFlags = "viewerLaunchFlags",
-    CloseCameraMarkerPreview = "CloseCameraMarkerPreview"
+    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"
@@ -54,24 +190,6 @@ export declare enum PlayerMode {
     Video = "video",
     Jpegs = "jpegs"
 }
-export type TasksStatusMap = {
-    [key: string]: TaskStatus;
-};
-export type TaskProgressItem = {
-    status: TaskStatus;
-    description: string;
-    percentDone?: number;
-    duration?: number;
-};
-export type GlobalSearchMatch = {
-    path: Array<string>;
-    value: string | number | boolean;
-};
-export type GlobalSearchResult = {
-    index: number;
-    matches: Array<GlobalSearchMatch>;
-};
-export type GlobalSearchResultInput = Array<Record<any, any> | Array<any>>;
 export type TimelineProviderRequestParams = TimelineDateInterval & {
     precision?: TimelinePrecision;
     labels?: string[];
@@ -182,12 +300,14 @@ export type TagSelectorItem = Tag & {
 };
 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",
@@ -202,6 +322,7 @@ export declare enum FormSchemaDataType {
 export type FormSchemaOptions = {
     title: string;
     value: string;
+    parentId?: string | null;
 };
 export type FormSchemaField = {
     id: string;
@@ -229,6 +350,7 @@ export type DrawingStats = {
 };
 export interface ScrollListener {
     element: Element | Window;
+    event: "scroll" | "resize";
     handler: () => void;
 }
 export interface LeaderLineInstance {
@@ -242,24 +364,25 @@ export type SnapshotCardItem = {
     placeholderThumbnailUrl?: string;
     fallbackThumbnailUrl?: string;
 };
-export type DocumentExtended = Document & {
-    webkitIsFullScreen?: boolean;
-    mozFullScreen?: boolean;
-    msFullscreenElement?: Element | null;
-    fullscreenElement?: Element;
-    webkitFullscreenElement?: Element;
-    mozFullScreenElement?: Element;
-};
 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;
-    drone?: boolean;
-    is360?: boolean;
+    icon: string;
+    excerpt?: string;
+    commentTarget?: {
+        commentId: number;
+        dateId: string | number;
+        floorId: string;
+    };
 };
 export type FormattedNotification = FormattedNotificationData & {
     date: string;
@@ -288,6 +411,20 @@ export type AutodeskUploadFormData = {
     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;
@@ -301,18 +438,6 @@ export interface MediaHubSortParameter {
     label: string;
     value: string;
 }
-export type TableHeaderParams<TItem = unknown> = {
-    value: string;
-    text: string;
-    cellClass?: 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;
 };
@@ -321,3 +446,56 @@ export type BimUploadFileResult = {
     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/droneUpload.d.ts

@@ -0,0 +1,67 @@
+import type { AerialAllocation, DroneFlightMetadata, DroneFileState, DroneFileError } from "@evercam/api/types";
+export declare enum DroneUploadErrorCode {
+    Offline = "offline",
+    UploadStalled = "upload_stalled",
+    AuthorizationExpired = "upload_authorization_expired",
+    UploadRejected = "upload_rejected",
+    ConnectionLost = "connection_lost",
+    UploadStopped = "upload_stopped",
+    UploadCancelled = "upload_cancelled",
+    DuplicateFilenames = "duplicate_filenames",
+    DifferentFlight = "different_flight",
+    ProcessingClosed = "processing_closed",
+    PartialUploadFailed = "partial_upload_failed",
+    NotSubmitted = "not_submitted"
+}
+export type AerialUploadFile = {
+    file: File;
+    allocation: AerialAllocation;
+};
+export declare enum DroneUploadStatus {
+    Queued = "queued",
+    Uploading = "uploading",
+    Failed = "failed",
+    Completed = "completed"
+}
+export type DroneUploadProgress = {
+    status: DroneUploadStatus;
+    uploadedFiles: number;
+    totalFiles: number;
+    uploadedBytes: number;
+    totalBytes: number;
+    percentage: number;
+    startedAt: number;
+    initialBytes: number;
+    error?: Error;
+};
+export type DroneUploadOptions = {
+    label?: string;
+    projectId: string;
+    processingId?: number;
+    flightMetadata: DroneFlightMetadata;
+    files: File[];
+    aerialShots: AerialUploadFile[];
+    onProgress?: (progress: DroneUploadProgress) => void;
+};
+export type AerialUploadOptions = Pick<DroneUploadOptions, "label" | "aerialShots" | "onProgress"> & {
+    processingId: number;
+};
+export type DroneUploadJob = {
+    readonly projectId?: string;
+    readonly initialProcessingId?: number;
+    readonly label: string;
+    readonly aerialFilenames: string[];
+    processingId?: number;
+    ingestUrl?: string;
+    progress: DroneUploadProgress;
+    run: () => Promise<void>;
+    cancel: () => Promise<void>;
+};
+export type UploadCollection = {
+    files: File[];
+    initialStates?: DroneFileState[];
+    allocate: (files: File[]) => Promise<DroneFileState[]>;
+    acknowledge: (filenames: string[]) => Promise<{
+        errors: DroneFileError[];
+    }>;
+};

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

@@ -1,5 +1,9 @@
 export * from "@evercam/api/types";
 export * from "./components";
+export * from "./report";
+export * from "./customDataTableFilters";
 export * from "./imagePlayer";
 export * from "./timeline";
 export * from "./rbac";
+export * from "./observations";
+export * from "./droneUpload";

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;
+};

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

@@ -0,0 +1,101 @@
+import type Vue from "vue";
+import type { CancelToken } from "axios";
+import type { Operator } from "@evercam/api/types";
+import type { DateRangeOption } from "@evercam/shared/utils/datePresets";
+export type ReportTableHeaderParams<TItem = unknown> = {
+    value: string;
+    text: string;
+    align?: string;
+    sortable?: boolean;
+    visible?: boolean;
+    width?: number | string;
+    copyable?: boolean;
+    toStringFn?: (item: TItem, key: string) => string;
+    sort?(a: unknown, b: unknown): number;
+    togglable?: boolean;
+    filterable?: boolean;
+};
+export declare enum ReportSortDirection {
+    Asc = "asc",
+    Desc = "desc"
+}
+export declare enum ReportFilterComponent {
+    Text = "TextFieldSearchFilter",
+    Select = "SelectSearchFilter",
+    DatePicker = "DatePickerSearchFilter",
+    CountField = "CountFieldSearchFilter",
+    Tag = "TagSearchFilter"
+}
+export type ReportFilterCell = {
+    header: ReportTableHeaderParams;
+    field?: ReportFilterField;
+};
+export type OfflineCamerasReportContext = Vue & {
+    report: string;
+};
+export type ReportFilterItem = {
+    name?: string;
+    value: string | number | boolean | null;
+};
+export type ReportSearchParamValue = string | number | boolean | null | undefined | (string | number | boolean | null)[];
+export type ReportSearchParams = Record<string, ReportSearchParamValue>;
+export type ReportItem = Record<string, unknown>;
+export type ReportProviderResponse<TItem = ReportItem> = {
+    total?: number;
+    [dataField: string]: TItem[] | number | undefined;
+};
+export type ReportTableProvider<TItem = ReportItem> = (request: {
+    cancelToken: CancelToken;
+    params: ReportSearchParams;
+}) => Promise<ReportProviderResponse<TItem>>;
+export type ReportTableOptions = {
+    page?: number;
+    itemsPerPage?: number | string;
+    sortBy?: string[];
+    sortDesc?: boolean[];
+};
+export type ReportFilterFieldNamesMap = {
+    fromField: string;
+    toField: string;
+};
+export type ReportFilterOperatorItem = {
+    value: Operator;
+    label: string;
+};
+export type ReportFilterAttributes = {
+    items?: ReportFilterItem[];
+    multiple?: boolean;
+    isAutocomplete?: boolean;
+    value?: string | number | string[];
+    label?: string;
+    textFieldAttrs?: {
+        placeholder?: string;
+    };
+    isRange?: boolean;
+    convertToIso?: boolean;
+    minDate?: string;
+    maxDate?: string;
+    options?: DateRangeOption[];
+    withOperator?: boolean;
+    operatorFieldName?: string;
+    operatorLabel?: string;
+    operatorItems?: ReportFilterOperatorItem[];
+    showToolTip?: boolean;
+    toolTipText?: string;
+    "menu-props"?: {
+        offsetY?: boolean;
+    };
+};
+export type ReportFilterField<TItem = ReportItem> = {
+    component: ReportFilterComponent;
+    name?: string;
+    width?: number;
+    attributes?: ReportFilterAttributes;
+    listeners?: {
+        keypress?: (event: KeyboardEvent) => boolean | void;
+    };
+    fieldNamesMap?: ReportFilterFieldNamesMap;
+    isGlobalFilter?: boolean;
+    offline?: boolean;
+    customFilter?: (item: TItem, fieldName: string, search: ReportSearchParamValue) => boolean;
+};

package/dist/shared/utils/datePickerValue.d.ts

@@ -0,0 +1,36 @@
+import type { DateRange, DayMeta } from "@evercam/ui";
+/**
+ * EDatePicker works in plain local `Date`s; this app stores dates as
+ * "YYYY-MM-DD" strings. Both helpers carry the wall-clock reading across that
+ * boundary — never the instant — so a date never shifts by a day.
+ */
+export declare function toCalendarDate(value?: string | number | Date | null, { timezone, withHour }?: {
+    timezone?: string;
+    withHour?: boolean;
+}): Date | undefined;
+export declare function toIsoDay(date?: Date | null): string;
+export declare function toCalendarDayEnd(value?: string | number | Date | null, timezone?: string): Date | undefined;
+export declare function toCalendarRange(value?: string[] | null): DateRange;
+export declare function fromCalendarRange(range?: DateRange | null): string[];
+export declare function toCssColor(color?: string): string | undefined;
+export declare function toDayMeta({ date, events, eventColor, }: {
+    date: Date;
+    events?: string[] | ((day: string) => boolean);
+    eventColor?: string | ((day: string) => string | undefined);
+}): DayMeta | undefined;
+/**
+ * Days inside the current selection carry no marker; everything else keeps the
+ * "available footage" dot. An empty or half-made selection marks every day.
+ */
+export declare function getOutsideRangeColor(day: string, range?: string[] | null, color?: string): string | undefined;
+export declare function orderDayRange(range?: string[] | null): {
+    fromDate: string;
+    toDate: string;
+} | null;
+export declare function toDayBounds({ fromDate, toDate, }: {
+    fromDate: string;
+    toDate: string;
+}): {
+    fromDate: string;
+    toDate: string;
+};

package/dist/shared/utils/datePresets.d.ts

@@ -0,0 +1,31 @@
+import type { DatePreset as EDatePickerPreset, WeekStart } from "@evercam/ui";
+export declare enum DateRangeOption {
+    Today = 0,
+    Yesterday = -1,
+    Last7Days = -7,
+    Last30Days = -30,
+    Last90Days = -90,
+    Last365Days = -365,
+    Next7Days = 7,
+    Next30Days = 30,
+    Next60Days = 60,
+    ThisMonth = "__thisMonth__",
+    LastCalendarMonth = "__lastCalendarMonth__",
+    DataRange = "__dataRange__",
+    CalendarRange = "__calendarRange__"
+}
+export declare const DefaultDateRangeOptions: DateRangeOption[];
+export type DateRangePresetOptions = {
+    min?: Date;
+    max?: Date;
+    dataRangeLabel?: string;
+    weekStartsOn?: WeekStart;
+};
+export declare function toDateRangePresets(options: DateRangeOption[], $t: (key: string) => string, { min, max, dataRangeLabel, weekStartsOn }?: DateRangePresetOptions): EDatePickerPreset[];
+export declare function matchDateRangePreset({ range, presets, min, max, weekStartsOn, }: {
+    range?: string[] | null;
+    presets: EDatePickerPreset[];
+    min?: Date;
+    max?: Date;
+    weekStartsOn?: WeekStart;
+}): EDatePickerPreset | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evercam/api",
-  "version": "1.0.0-913c1fc0c",
+  "version": "1.0.0-9272abbb4",
   "description": "Evercam API client",
   "repository": {
     "type": "git",
@@ -28,6 +28,8 @@
   },
   "readme": "README.md",
   "scripts": {
+    "preinstall": "node ../shared/ci-scripts/check-bootstrap.js",
+    "bootstrap": "node ../shared/ci-scripts/bootstrap.js",
     "clean": "rimraf dist",
     "typecheck": "tsc --noEmit",
     "build:types": "tsc --declaration --emitDeclarationOnly",