@3cr/viewer-browser 0.0.200 → 0.0.220

package/src/{dataLayer/viewer3cr.ts → services/viewer-3cr.service.ts}

@@ -1,27 +1,49 @@
-import { FrontEndPayload } from "@3cr/sdk-browser/types/payload";
-import { createInstance, executePayload, registerOnPayloadHandler } from "@3cr/sdk-browser";
-import { unref } from "vue";
+import { createInstance, executePayload, registerOnPayloadHandler } from '@3cr/sdk-browser';
+import { unref } from 'vue';
 import {
   AnchorPoint,
-  DataOverlayActions,
+  DataOverlaysActions,
   FileManagementActions,
-  FrontEndInterfaces, InteractivityActions, LayoutActions, NavigationCubeActions, PresetsActions, ScanMovementActions,
+  FrontEndInterfaces,
+  InteractivityActions,
+  LayoutActions,
+  NavigationCubeActions,
+  PresetsActions,
+  ScanMovementActions,
   ScanOrientationActions,
-  ScanView, SlidersActions, ViewSelectionActions
-} from "@3cr/types-ts";
-import { LoadViewerPayload } from "@/models/LoadViewerPayload";
-import { currentColourPreset, previousLayout, transactionStarted } from "@/dataLayer/scanState";
-import { toNumber } from "@/helpers/utils";
-import { EventHandlers } from "@/dataLayer/eventHandlers";
-import { clamp } from "@/dataLayer/clamp";
-
-type InterfaceCallback = (message: string, action: string) => void | Promise<void>;
-
-type ActionCallback = (message: string) => void | Promise<void>;
-
-export const emptyPayload = { Version: "1.1.0" };
-
-export class Viewer3cr {
+  ScanView,
+  SlidersActions,
+  ViewSelectionActions,
+  FrontEndPayload,
+  InteractivityState,
+  MarkupsActions,
+  McadActions,
+  ObjectBoolean,
+  ObjectColour,
+  ObjectInvert,
+  ObjectVisibility,
+  ViewToggleData
+} from '@3cr/types-ts';
+import { LoadViewerPayload } from '@/models/loadViewerPayload';
+import { currentColourPreset, previousLayout, transactionStarted } from '@/models/scanState';
+import { EventHandlers } from '@/models/eventHandlers';
+import { clamp } from '@/functions/clamp';
+import { LoadSessionState } from '@3cr/types-ts/types/LoadSessionState';
+
+type InterfaceCallback = (
+  message: string,
+  action: string,
+  returnChannel: string,
+  returnTo: string
+) => void | Promise<void>;
+
+type ActionCallback = (message: string, returnChannel: string, returnTo: string) => void | Promise<void>;
+
+export const emptyPayload = { Version: '1.1.0' };
+
+type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
+
+export class Viewer3crService {
   private interfaceCallbacks = new EventHandlers<string, InterfaceCallback>();
 
   private actionCallbacks = new EventHandlers<string, ActionCallback>();
@@ -48,29 +70,21 @@ export class Viewer3cr {
   }
 
   /**
-   * DO-02: Toggle 2D annotation visibility.
-   * @param id The annotation id.
-   * @param visibility The annotation visibility.
+   * DO-03: Toggle 2D annotation visibility.
+   * @param value The object visibility
    */
-  async toggle2dAnnotation(id: string, visibility: boolean): Promise<void> {
-    await this.sendPayload(FrontEndInterfaces.data_overlay, DataOverlayActions.do03, {
-      Version: '1.1.0',
-      Id: id,
-      Visibility: visibility
-    });
+  async toggle2dAnnotation(value: Optional<ObjectVisibility, 'Version'>): Promise<void> {
+    value.Version ??= '1.1.0';
+    await this.sendPayload(FrontEndInterfaces.data_overlay, DataOverlaysActions.do03, value);
   }
 
   /**
    * DO-11: Toggle 3D annotation visibility.
-   * @param id The annotation id.
-   * @param visibility The annotation visibility.
-   */
-  async toggle3dAnnotation(id: string, visibility: boolean): Promise<void> {
-    await this.sendPayload(FrontEndInterfaces.data_overlay, DataOverlayActions.do11, {
-      Version: '1.1.0',
-      Id: id,
-      Visibility: visibility
-    });
+   * @param value The object visibility
+   */
+  async toggle3dAnnotation(value: Optional<ObjectVisibility, 'Version'>): Promise<void> {
+    value.Version ??= '1.1.0';
+    await this.sendPayload(FrontEndInterfaces.data_overlay, DataOverlaysActions.do11, value);
   }
 
   /**
@@ -83,96 +97,60 @@ export class Viewer3cr {
 
   /**
    * FM-03: Load previous CurrentScanState values.
-   * @param url The URL to the file.
-   */
-  async loadScanSession(url: string): Promise<void> {
-    await this.sendPayload(FrontEndInterfaces.file_management, FileManagementActions.fm03, {
-      Version: '1.1.0',
-      Url: url
-    });
-  }
-
-  /**
-   * FM-05: Load separate data overlay file from external UI.
-   * @param url The URL to the file.
-   */
-  async loadDataOverlay(url: string): Promise<void> {
-    await this.sendPayload(FrontEndInterfaces.file_management, FileManagementActions.fm05, {
-      Version: '1.1.0',
-      Url: url
-    });
-  }
-
-  /**
-   * FM-09: Load separate MCAD file from external UI.
-   * @param url The URL to the file.
+   * @param value The URL to the file.
    */
-  async loadMcad(url: string): Promise<void> {
-    await this.sendPayload(FrontEndInterfaces.file_management, 'fm_09', {
-      Version: '1.1.0',
-      Url: url
-    });
+  async loadScanSession(value: Optional<LoadSessionState, 'Version'>): Promise<void> {
+    value.Version ??= '1.1.0';
+    await this.sendPayload(FrontEndInterfaces.file_management, FileManagementActions.fm03, value);
   }
 
   /**
-   * SO-01: Rotate 2D view by up to +-XXX degrees.
-   * @param view The 2D view.
-   * @param deg The degrees.
+   * FM-05: Sets the data overlay session with the given session file.
+   * This will clear all previously loaded data overlay sessions.
+   * @param value The URL to the file.
    */
-  async rotateByDeg(view: ScanView, deg: number) {
-    await this.sendPayload(FrontEndInterfaces.scan_orientation, ScanOrientationActions.so01, {
-      Version: "0.0.1",
-      View: view,
-      Angle: deg,
-    });
+  async setDataOverlaySession(value: Optional<LoadSessionState, 'Version'>): Promise<void> {
+    value.Version ??= '1.1.0';
+    await this.sendPayload(FrontEndInterfaces.file_management, FileManagementActions.fm05, value);
   }
 
   /**
-   * SO-02: Flip 2D View Horizontally.
-   * @param view The scan view.
-   * @param flipped Whether to enable horizontal flip.
+   * FM-06: Adds a data overlay session to existing sessions.
+   * @param value The URL to the file.
    */
-  async flipHorizontally(view: ScanView, flipped: boolean): Promise<void> {
-    await this.sendPayload(FrontEndInterfaces.scan_orientation, ScanOrientationActions.so02, {
-      Version: "0.0.1",
-      View: view,
-      Flipped: flipped
-    })
+  async addDataOverlaySession(value: Optional<LoadSessionState, 'Version'>): Promise<void> {
+    value.Version ??= '1.1.0';
+    await this.sendPayload(FrontEndInterfaces.file_management, FileManagementActions.fm06, value);
   }
 
   /**
-   * SO-03: Flip 2D View Vertically.
-   * @param view The scan view.
-   * @param flipped Whether to enable vertical flip.
-   */
-  async flipVertically(view: ScanView, flipped: boolean): Promise<void> {
-    await this.sendPayload(FrontEndInterfaces.scan_orientation, ScanOrientationActions.so03, {
-      Version: "0.0.1",
-      View: view,
-      Flipped: flipped
-    });
-  }
-
-  /**
-   * SO-04: Invert Volume Rendering
-   * @param sagittal If the Sagittal axis is inverted.
-   * @param coronal If the Coronal axis is inverted.
-   * @param transverse If the Transverse axis is inverted.
+   * FM-09: Load separate MCAD file from external UI.
+   * @param value The URL to the file.
+   * @param returnChannel The return channel.
+   * @param returnTo The return to id.
    */
-  async invertTransform(sagittal: boolean, coronal: boolean, transverse: boolean): Promise<void> {
-    // TODO: Replace so_04 with action type constant
-    await this.sendPayload(FrontEndInterfaces.scan_orientation, 'so_04', {
-      Version: "0.0.1",
-      InvertedSagittal: sagittal,
-      InvertedCoronal: coronal,
-      InvertedTransverse: transverse
-    });
+  async loadMcadObjects(
+    value?: Optional<LoadSessionState, 'Version'>,
+    returnChannel?: string[],
+    returnTo?: string
+  ): Promise<void> {
+    await this.sendPayload(
+      FrontEndInterfaces.file_management,
+      FileManagementActions.fm09,
+      value,
+      returnChannel,
+      returnTo
+    );
   }
 
   async viewSelection(action: ViewSelectionActions) {
     await this.sendPayload(FrontEndInterfaces.view_selection, action, emptyPayload);
   }
 
+  async viewSelectionToggleView(payload: Optional<ViewToggleData, 'Version'>) {
+    await this.sendPayload(FrontEndInterfaces.view_selection, ViewSelectionActions.vs07, payload);
+  }
+
   async sliderHandler(action: SlidersActions, value: number) {
     if (unref(transactionStarted)) return;
     await this.slider(action, value);
@@ -195,6 +173,79 @@ export class Viewer3cr {
     }
   }
 
+  /**
+   * MC-03: Set visibility of MCAD objects.
+   * @param value The object visibility value.
+   */
+  async setMcadObjectVisibility(value: Optional<ObjectVisibility, 'Version'>): Promise<void> {
+    value.Version ??= '1.2.0';
+    await this.sendPayload(FrontEndInterfaces.mcad, McadActions.mc03, value);
+  }
+
+  /**
+   * MC-04: Set colour & opacity of MCAD objects.
+   * @param value The colour & opacity value.
+   */
+  async setMcadObjectColour(value: Optional<ObjectColour, 'Version'>): Promise<void> {
+    value.Version ??= '1.2.0';
+    await this.sendPayload(FrontEndInterfaces.mcad, McadActions.mc04, value);
+  }
+
+  /**
+   * MC-05: Enables movement of MCAD objects.
+   * @param value The movement toggle.
+   */
+  async moveMcadObject(value: Optional<ObjectBoolean, 'Version'>): Promise<void> {
+    value.Version ??= '1.2.0';
+    await this.sendPayload(FrontEndInterfaces.mcad, McadActions.mc05, value);
+  }
+
+  /**
+   * MC-16: Invert MCAD objects.
+   * @param value The inversion state.
+   */
+  async invertMcadObject(value: Optional<ObjectInvert, 'Version'>): Promise<void> {
+    value.Version ??= '1.2.0';
+    await this.sendPayload(FrontEndInterfaces.mcad, McadActions.mc16, value);
+  }
+
+  /**
+   * MU-16: Set 2D/3D visibility of markups.
+   * @param id The markup id.
+   * @param visibility The visibility state.
+   */
+  async setMarkupVisibility(id: string, visibility: boolean): Promise<void> {
+    const payload = { Version: '1.2.1', Id: id, Visibility2d: visibility, Visibility3d: visibility };
+    await this.sendPayload(FrontEndInterfaces.markups, MarkupsActions.mu16, [payload]);
+  }
+
+  /**
+   * MU-20: 2D length tool.
+   * @param value If the length tool should be enabled.
+   */
+  async lengthTool(value: Optional<InteractivityState, 'Version'>): Promise<void> {
+    value.Version ??= '1.2.0';
+    await this.sendPayload(FrontEndInterfaces.markups, MarkupsActions.mu20, value);
+  }
+
+  /**
+   * MU-21: 2D polygon tool.
+   * @param value If the polygon tool should be enabled.
+   */
+  async polygonTool(value: Optional<InteractivityState, 'Version'>): Promise<void> {
+    value.Version ??= '1.2.0';
+    await this.sendPayload(FrontEndInterfaces.markups, MarkupsActions.mu21, value);
+  }
+
+  /**
+   * MU-22: 2D angle tool.
+   * @param value If the angle tool should be enabled.
+   */
+  async angleTool(value: Optional<InteractivityState, 'Version'>): Promise<void> {
+    value.Version ??= '1.2.0';
+    await this.sendPayload(FrontEndInterfaces.markups, MarkupsActions.mu22, value);
+  }
+
   /**
    * NC-01: Set Navigation Cube Co-ordinates and Size.
    * @param anchorPoint The anchor point on the screen.
@@ -203,7 +254,13 @@ export class Viewer3cr {
    * @param width The navigation cube width.
    * @param height The navigation cube height.
    */
-  async setNavCubePositionSize(anchorPoint: AnchorPoint, x: number, y: number, width: number, height: number): Promise<void> {
+  async setNavCubePositionSize(
+    anchorPoint: AnchorPoint,
+    x: number,
+    y: number,
+    width: number,
+    height: number
+  ): Promise<void> {
     await this.sendPayload(FrontEndInterfaces.navigation_cube, NavigationCubeActions.nc01, {
       Version: '0.0.1',
       AnchorPoint: anchorPoint,
@@ -218,8 +275,8 @@ export class Viewer3cr {
    */
   async setNavCubeVisibility(visibility: boolean): Promise<void> {
     await this.sendPayload(FrontEndInterfaces.navigation_cube, NavigationCubeActions.nc02, {
-      Version: "0.0.1",
-      Value: visibility,
+      Version: '0.0.1',
+      Value: visibility
     });
   }
 
@@ -254,8 +311,7 @@ export class Viewer3cr {
    * @param a Alpha channel.
    */
   async setNavCubeColourOpacity(r: number, g: number, b: number, a: number): Promise<void> {
-    // TODO: Replace nc_05 with action type constant
-    await this.sendPayload(FrontEndInterfaces.navigation_cube, 'nc_05', {
+    await this.sendPayload(FrontEndInterfaces.navigation_cube, NavigationCubeActions.nc05, {
       Version: '0.0.1',
       R: clamp(r / 255, 0, 1),
       G: clamp(g / 255, 0, 1),
@@ -273,8 +329,7 @@ export class Viewer3cr {
    * @param a Alpha channel.
    */
   async setNavCubeHighlightColourOpacity(r: number, g: number, b: number, a: number): Promise<void> {
-    // TODO: Replace nc_07 with action type constant
-    await this.sendPayload(FrontEndInterfaces.navigation_cube, 'nc_07', {
+    await this.sendPayload(FrontEndInterfaces.navigation_cube, NavigationCubeActions.nc07, {
       Version: '0.0.1',
       R: clamp(r / 255, 0, 1),
       G: clamp(g / 255, 0, 1),
@@ -289,11 +344,10 @@ export class Viewer3cr {
    * @param value The movement in mm.
    */
   async panLeft(view: ScanView, value: number): Promise<void> {
-    // TODO: Replace sm_13 with action type constant
-    await this.sendPayload(FrontEndInterfaces.scan_movement, "sm_13", {
-      Version: "0.0.1",
+    await this.sendPayload(FrontEndInterfaces.scan_movement, ScanMovementActions.sm13, {
+      Version: '0.0.1',
       View: view,
-      Movement: value,
+      Movement: value
     });
   }
 
@@ -303,11 +357,10 @@ export class Viewer3cr {
    * @param value The movement in mm.
    */
   async panRight(view: ScanView, value: number): Promise<void> {
-    // TODO: Replace sm_14 with action type constant
-    await this.sendPayload(FrontEndInterfaces.scan_movement, "sm_14", {
-      Version: "0.0.1",
+    await this.sendPayload(FrontEndInterfaces.scan_movement, ScanMovementActions.sm14, {
+      Version: '0.0.1',
       View: view,
-      Movement: value,
+      Movement: value
     });
   }
 
@@ -317,11 +370,10 @@ export class Viewer3cr {
    * @param value The movement in mm.
    */
   async panUp(view: ScanView, value: number): Promise<void> {
-    // TODO: Replace sm_15 with action type constant
-    await this.sendPayload(FrontEndInterfaces.scan_movement, "sm_15", {
-      Version: "0.0.1",
+    await this.sendPayload(FrontEndInterfaces.scan_movement, ScanMovementActions.sm15, {
+      Version: '0.0.1',
       View: view,
-      Movement: value,
+      Movement: value
     });
   }
 
@@ -331,11 +383,10 @@ export class Viewer3cr {
    * @param value The movement in mm.
    */
   async panDown(view: ScanView, value: number): Promise<void> {
-    // TODO: Replace sm_16 with action type constant
-    await this.sendPayload(FrontEndInterfaces.scan_movement, "sm_16", {
-      Version: "0.0.1",
+    await this.sendPayload(FrontEndInterfaces.scan_movement, ScanMovementActions.sm16, {
+      Version: '0.0.1',
       View: view,
-      Movement: value,
+      Movement: value
     });
   }
 
@@ -345,8 +396,8 @@ export class Viewer3cr {
    * @param value The amount to zoom in.
    */
   async zoomIn(view: ScanView, value: number): Promise<void> {
-    await this.sendPayload(FrontEndInterfaces.scan_movement, "sm_17", {
-      Version: "0.0.1",
+    await this.sendPayload(FrontEndInterfaces.scan_movement, ScanMovementActions.sm17, {
+      Version: '0.0.1',
       View: view,
       Movement: value
     });
@@ -358,53 +409,121 @@ export class Viewer3cr {
    * @param value The amount to zoom out.
    */
   async zoomOut(view: ScanView, value: number): Promise<void> {
-    await this.sendPayload(FrontEndInterfaces.scan_movement, "sm_18", {
-      Version: "0.0.1",
+    await this.sendPayload(FrontEndInterfaces.scan_movement, ScanMovementActions.sm18, {
+      Version: '0.0.1',
       View: view,
       Movement: value
     });
   }
 
+  /**
+   * SO-01: Rotate 2D view by up to +-XXX degrees.
+   * @param view The 2D view.
+   * @param deg The degrees.
+   */
+  async rotateByDeg(view: ScanView, deg: number) {
+    await this.sendPayload(FrontEndInterfaces.scan_orientation, ScanOrientationActions.so01, {
+      Version: '0.0.1',
+      View: view,
+      Angle: deg
+    });
+  }
+
+  /**
+   * SO-02: Flip 2D View Horizontally.
+   * @param view The scan view.
+   * @param flipped Whether to enable horizontal flip.
+   */
+  async flipHorizontally(view: ScanView, flipped: boolean): Promise<void> {
+    await this.sendPayload(FrontEndInterfaces.scan_orientation, ScanOrientationActions.so02, {
+      Version: '0.0.1',
+      View: view,
+      Flipped: flipped
+    });
+  }
+
+  /**
+   * SO-03: Flip 2D View Vertically.
+   * @param view The scan view.
+   * @param flipped Whether to enable vertical flip.
+   */
+  async flipVertically(view: ScanView, flipped: boolean): Promise<void> {
+    await this.sendPayload(FrontEndInterfaces.scan_orientation, ScanOrientationActions.so03, {
+      Version: '0.0.1',
+      View: view,
+      Flipped: flipped
+    });
+  }
+
+  /**
+   * SO-04: Invert Volume Rendering
+   * @param sagittal If the Sagittal axis is inverted.
+   * @param coronal If the Coronal axis is inverted.
+   * @param transverse If the Transverse axis is inverted.
+   */
+  async invertTransform(sagittal: boolean, coronal: boolean, transverse: boolean): Promise<void> {
+    await this.sendPayload(FrontEndInterfaces.scan_orientation, ScanOrientationActions.so04, {
+      Version: '0.0.1',
+      InvertedSagittal: sagittal,
+      InvertedCoronal: coronal,
+      InvertedTransverse: transverse
+    });
+  }
+
   /**
    * IN-01, IN-02: Enable/Disable Unity input interactions.
    * @param isHovering If the inputs should be enabled.
    */
   async hoverOverCanvas(isHovering: boolean) {
     await this.sendPayload(FrontEndInterfaces.interactivity, InteractivityActions.in01, {
-      Version: "0.0.1",
-      Value: isHovering,
+      Version: '0.0.1',
+      Value: isHovering
     });
     await this.sendPayload(FrontEndInterfaces.interactivity, InteractivityActions.in02, {
-      Version: "0.0.1",
-      Value: isHovering,
+      Version: '0.0.1',
+      Value: isHovering
     });
   }
 
   private async scanMovement(action: ScanMovementActions, value: number) {
     await this.sendPayload(FrontEndInterfaces.scan_movement, action, {
-      Version: "0.0.1",
-      Value: toNumber(value),
+      Version: '0.0.1',
+      Value: value
     });
   }
 
   private async slider(action: SlidersActions, value: number) {
     await this.sendPayload(FrontEndInterfaces.sliders, action, {
-      Version: "0.0.1",
-      Value: toNumber(value),
+      Version: '0.0.1',
+      Value: value
     });
   }
 
-  async sendPayload(iface: string, action: string, message: any): Promise<void> {
+  async sendPayload(
+    iface: string,
+    action: string,
+    message: any,
+    returnChannel?: string[],
+    returnTo?: string
+  ): Promise<void> {
     await executePayload({
-      Version: "0.0.1",
+      Version: '0.0.1',
       Interface: iface as any,
       Action: action as any,
-      Message: JSON.stringify(message),
+      ReturnChannel: returnChannel ? JSON.stringify(returnChannel) : null,
+      ReturnTo: returnTo ?? null,
+      Message: JSON.stringify(message)
     });
   }
 
-  private async onPayload(payload: FrontEndPayload): Promise<void> {
-    await this.interfaceCallbacks.call(payload.Interface, payload.Message, payload.Action);
-    await this.actionCallbacks.call(payload.Action, payload.Message);
+  async onPayload(payload: FrontEndPayload): Promise<void> {
+    await this.interfaceCallbacks.call(
+      payload.Interface,
+      payload.Message,
+      payload.Action,
+      payload.ReturnChannel,
+      payload.ReturnTo
+    );
+    await this.actionCallbacks.call(payload.Action, payload.Message, payload.ReturnChannel, payload.ReturnTo);
   }
 }

package/src/types/action.ts

@@ -0,0 +1,13 @@
+import { ActionData } from '@/types/action-data';
+
+interface ActionBase {
+  ActionType: number;
+}
+
+export interface Action extends ActionBase {
+  ActionData: ActionData;
+}
+
+export interface ActionRaw extends ActionBase {
+  ActionData: string;
+}

package/src/types/call-to-action.ts

@@ -0,0 +1,9 @@
+import { Action, ActionRaw } from '@/types/action';
+
+export interface CallToAction {
+  Actions: Action[];
+}
+
+export interface CallToActionRaw {
+  Actions: ActionRaw[];
+}

package/src/types/colour.ts

@@ -0,0 +1,6 @@
+export interface Colour {
+  r: number;
+  g: number;
+  b: number;
+  a: number;
+}

package/src/types/data-overlay-angle.ts

@@ -0,0 +1,16 @@
+import { InvertTransformData, Vector3Data } from '@3cr/types-ts';
+import { DataOverlay, DataOverlayRaw } from '@/types/data-overlay';
+import { SegmentAngle } from '@/types/segment-angle';
+
+interface DataOverlayAngleBase {
+  Points: Vector3Data[];
+  Inverted: InvertTransformData;
+  Visibility2d: boolean | null;
+  Visibility3d: boolean | null;
+  SegmentAngles: SegmentAngle[];
+  Units: string;
+}
+
+export type DataOverlayAngle = DataOverlayAngleBase & DataOverlay;
+
+export type DataOverlayAngleRaw = DataOverlayAngleBase & DataOverlayRaw;

package/src/types/data-overlay-annotation.ts

@@ -0,0 +1,18 @@
+import { Vector3Data, InvertTransformData, ColourData, Vector2Data } from '@3cr/types-ts';
+import { DataOverlay, DataOverlayRaw } from '@/types/data-overlay';
+
+interface DataOverlayAnnotationBase {
+  Position: Vector3Data;
+  Inverted: InvertTransformData;
+  Colour2d: ColourData;
+  Colour3d: ColourData;
+  Size2d: Vector2Data;
+  Size3d: Vector3Data;
+  Icon2d: string;
+  Visibility2d: boolean | null;
+  Visibility3d: boolean | null;
+}
+
+export type DataOverlayAnnotation = DataOverlayAnnotationBase & DataOverlay;
+
+export type DataOverlayAnnotationRaw = DataOverlayAnnotationBase & DataOverlayRaw;

package/src/types/data-overlay-data.ts

@@ -0,0 +1,15 @@
+import { DataOverlayType } from '@3cr/types-ts/types/DataOverlayType';
+
+interface DataOverlayDataBase {
+  Version: string;
+  Id: string;
+  DataType: DataOverlayType;
+}
+
+export interface DataOverlayData<T> extends DataOverlayDataBase {
+  Data: T;
+}
+
+export interface DataOverlayDataRaw extends DataOverlayDataBase {
+  Data: string;
+}

package/src/types/data-overlay-info.ts

@@ -0,0 +1,14 @@
+export interface DataOverlayInfo {
+  id: string;
+  title: string;
+  target: [number, number];
+  data: {
+    icon: string;
+    title: string;
+    subtitle?: string;
+    actions?: {
+      url: string;
+      description: string;
+    }[];
+  }[];
+}