@cornerstonejs/tools 2.0.0-beta.3 → 2.0.0-beta.5

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0-beta.5",
   "description": "Cornerstone3D Tools",
   "main": "dist/umd/index.js",
-  "types": "dist/esm/index.d.ts",
+  "types": "dist/types/index.d.ts",
   "module": "dist/esm/index.js",
   "repository": "https://github.com/cornerstonejs/cornerstone3D",
   "files": [
@@ -29,7 +29,7 @@
     "webpack:watch": "webpack --mode development --progress --watch  --config ./.webpack/webpack.dev.js"
   },
   "dependencies": {
-    "@cornerstonejs/core": "^2.0.0-beta.3",
+    "@cornerstonejs/core": "^2.0.0-beta.5",
     "lodash.clonedeep": "4.5.0",
     "lodash.get": "^4.4.2"
   },
@@ -52,5 +52,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "d78cf780d4383a61ea0a9762bafa4104666757a4"
+  "gitHead": "0767e6b927df9f41cf6e59ad13837de383c15c05"
 }

package/src/eventListeners/keyboard/keyDownListener.ts

@@ -1,4 +1,3 @@
-import _cloneDeep from 'lodash.clonedeep';
 import { getEnabledElement, triggerEvent } from '@cornerstonejs/core';
 import Events from '../../enums/Events';
 import { KeyDownEventDetail, KeyUpEventDetail } from '../../types/EventTypes';
@@ -97,7 +96,7 @@ function _onKeyUp(evt: KeyboardEvent): void {
   state.element.addEventListener('keydown', keyListener);
 
   // Restore `state` to `defaultState`
-  state = _cloneDeep(defaultState);
+  state = structuredClone(defaultState);
   triggerEvent(eventDetail.element, Events.KEY_UP, eventDetail);
 }
 

package/src/stateManagement/annotation/FrameOfReferenceSpecificAnnotationManager.ts

@@ -1,4 +1,3 @@
-import cloneDeep from 'lodash.clonedeep';
 import {
   Annotation,
   Annotations,
@@ -314,14 +313,14 @@ class FrameOfReferenceSpecificAnnotationManager implements IAnnotationManager {
       const toolSpecificAnnotations =
         frameOfReferenceSpecificAnnotations[toolName];
 
-      return cloneDeep(toolSpecificAnnotations);
+      return structuredClone(toolSpecificAnnotations);
     } else if (groupKey) {
       const frameOfReferenceSpecificAnnotations = annotations[groupKey];
 
-      return cloneDeep(frameOfReferenceSpecificAnnotations);
+      return structuredClone(frameOfReferenceSpecificAnnotations);
     }
 
-    return cloneDeep(annotations);
+    return structuredClone(annotations);
   };
 
   /**
@@ -361,7 +360,7 @@ class FrameOfReferenceSpecificAnnotationManager implements IAnnotationManager {
       annotations[groupKey] = <GroupSpecificAnnotations>state;
     } else {
       // Set entire annotations
-      this.annotations = <AnnotationState>cloneDeep(state);
+      this.annotations = <AnnotationState>structuredClone(state);
     }
   };
 

package/src/stateManagement/segmentation/SegmentationStateManager.ts

@@ -1,5 +1,4 @@
 import { utilities as csUtils } from '@cornerstonejs/core';
-import cloneDeep from 'lodash.clonedeep';
 
 import CORNERSTONE_COLOR_LUT from '../../constants/COLOR_LUT';
 
@@ -52,7 +51,7 @@ export default class SegmentationStateManager {
     if (!uid) {
       uid = csUtils.uuidv4();
     }
-    this.state = cloneDeep(initialDefaultState);
+    this.state = structuredClone(initialDefaultState);
     this.uid = uid;
   }
 
@@ -85,7 +84,7 @@ export default class SegmentationStateManager {
    * Reset the state to the default state
    */
   resetState(): void {
-    this.state = cloneDeep(initialDefaultState);
+    this.state = structuredClone(initialDefaultState);
   }
 
   /**

package/src/stateManagement/segmentation/addSegmentationRepresentations.ts

@@ -1,4 +1,3 @@
-import _cloneDeep from 'lodash.clonedeep';
 import {
   SegmentationRepresentationConfig,
   RepresentationPublicInput,

package/src/stateManagement/segmentation/addSegmentations.ts

@@ -1,4 +1,3 @@
-import _cloneDeep from 'lodash.clonedeep';
 import { SegmentationPublicInput } from '../../types/SegmentationStateTypes';
 import { validateSegmentationInput } from './helpers';
 import { addSegmentation as addSegmentationToState } from './segmentationState';
@@ -18,7 +17,7 @@ function addSegmentations(
   validateSegmentationInput(segmentationInputArray);
 
   segmentationInputArray.map((segInput) => {
-    const segmentationInput = _cloneDeep(segInput);
+    const segmentationInput = structuredClone(segInput);
 
     addSegmentationToState(segmentationInput);
   });

package/src/store/ToolGroupManager/ToolGroup.ts

@@ -1,5 +1,4 @@
 import { MouseBindings, ToolModes } from '../../enums';
-import cloneDeep from 'lodash.clonedeep';
 import get from 'lodash.get';
 import {
   triggerEvent,
@@ -679,7 +678,7 @@ export default class ToolGroup implements IToolGroup {
       configurationPath
     );
 
-    return cloneDeep(_configuration);
+    return structuredClone(_configuration);
   }
 
   /**

package/src/store/state.ts

@@ -1,5 +1,3 @@
-import _cloneDeep from 'lodash.clonedeep';
-
 import { IToolGroup, IToolClassReference } from '../types';
 import Synchronizer from './SynchronizerManager/Synchronizer';
 import svgNodeCache, { resetSvgNodeCache } from './svgNodeCache';
@@ -46,7 +44,15 @@ let state: ICornerstoneTools3dState = {
 
 function resetCornerstoneToolsState(): void {
   resetSvgNodeCache();
-  state = _cloneDeep(defaultState);
+  state = {
+    ...structuredClone({
+      ...defaultState,
+      svgNodeCache: {},
+    }),
+    svgNodeCache: {
+      ...defaultState.svgNodeCache,
+    },
+  };
 }
 
 export {

package/src/tools/WindowLevelTool.ts

@@ -58,6 +58,9 @@ class WindowLevelTool extends BaseTool {
       const properties = viewport.getProperties();
       ({ lower, upper } = properties.voiRange);
       const volume = cache.getVolume(volumeId);
+      if (!volume) {
+        throw new Error('Volume not found ' + volumeId);
+      }
       modality = volume.metadata.Modality;
       isPreScaled = volume.scaling && Object.keys(volume.scaling).length > 0;
     } else if (viewport instanceof StackViewport) {

package/src/tools/displayTools/Contour/contourDisplay.ts

@@ -129,7 +129,6 @@ async function render(
   const contourData = segmentation.representationData[Representations.Contour];
   const { geometryIds } = contourData;
 
-
   // We don't have a good way to handle stack viewports for contours at the moment.
   // Plus, if we add a segmentation to one viewport, it gets added to all the viewports in the toolGroup too.
   if (viewport instanceof StackViewport) {

package/src/types/index.ts

@@ -47,17 +47,17 @@ import type {
   SegmentationState,
   RepresentationPublicInput,
 } from './SegmentationStateTypes';
-import ISynchronizerEventHandler from './ISynchronizerEventHandler';
-import {
+import type ISynchronizerEventHandler from './ISynchronizerEventHandler';
+import type {
   FloodFillGetter,
   FloodFillOptions,
   FloodFillResult,
 } from './FloodFillTypes';
-import IToolClassReference from './IToolClassReference';
-import { ContourSegmentationData } from './ContourTypes';
-import IAnnotationManager from './IAnnotationManager';
-import AnnotationGroupSelector from './AnnotationGroupSelector';
-import { Statistics } from './CalculatorTypes';
+import type IToolClassReference from './IToolClassReference';
+import type { ContourSegmentationData } from './ContourTypes';
+import type IAnnotationManager from './IAnnotationManager';
+import type AnnotationGroupSelector from './AnnotationGroupSelector';
+import type { Statistics } from './CalculatorTypes';
 
 export type {
   // AnnotationState

package/src/utilities/segmentation/createLabelmapVolumeForViewport.ts

@@ -1,4 +1,3 @@
-import { _cloneDeep } from 'lodash.clonedeep';
 import {
   getEnabledElementByIds,
   volumeLoader,
@@ -23,16 +22,16 @@ export default async function createLabelmapVolumeForViewport(input: {
   renderingEngineId: string;
   segmentationId?: string;
   options?: {
-    volumeId?: string;
-    scalarData?: Float32Array | Uint8Array | Uint16Array | Int16Array;
-    targetBuffer?: {
+    volumeId: string;
+    scalarData: Float32Array | Uint8Array | Uint16Array | Int16Array;
+    targetBuffer: {
       type: 'Float32Array' | 'Uint8Array' | 'Uint16Array' | 'Int8Array';
     };
-    metadata?: any;
-    dimensions?: Types.Point3;
-    spacing?: Types.Point3;
-    origin?: Types.Point3;
-    direction?: Float32Array;
+    metadata: Types.Metadata;
+    dimensions: Types.Point3;
+    spacing: Types.Point3;
+    origin: Types.Point3;
+    direction: Types.Mat3;
   };
 }): Promise<string> {
   const { viewportId, renderingEngineId, options } = input;
@@ -60,7 +59,7 @@ export default async function createLabelmapVolumeForViewport(input: {
   if (options) {
     // create a new labelmap with its own properties
     // This allows creation of a higher resolution labelmap vs reference volume
-    const properties = _cloneDeep(options);
+    const properties = structuredClone(options);
     await volumeLoader.createLocalVolume(properties, segmentationId);
   } else {
     // create a labelmap from a reference volume

package/src/utilities/stackPrefetch/stackPrefetch.ts

@@ -1,6 +1,4 @@
 import {
-  getEnabledElement,
-  StackViewport,
   imageLoader,
   Enums,
   eventTarget,

package/dist/esm/types/AnnotationGroupSelector.d.ts

@@ -1,2 +0,0 @@
-declare type AnnotationGroupSelector = HTMLDivElement | string;
-export default AnnotationGroupSelector;

package/dist/esm/types/EventTypes.d.ts

@@ -1,215 +0,0 @@
-import { Types } from '@cornerstonejs/core';
-import { Annotation } from './AnnotationTypes';
-import IPoints from './IPoints';
-import ITouchPoints from './ITouchPoints';
-import IDistance from './IDistance';
-import { SetToolBindingsType } from './ISetToolModeOptions';
-import { Swipe } from '../enums/Touch';
-import { ToolModes } from '../enums';
-declare type NormalizedInteractionEventDetail = {
-    eventName: string;
-    renderingEngineId: string;
-    viewportId: string;
-    camera: Record<string, unknown>;
-    element: HTMLDivElement;
-};
-declare type MouseCustomEventDetail = NormalizedInteractionEventDetail & {
-    event: Record<string, unknown> | MouseEvent;
-};
-declare type TouchCustomEventDetail = NormalizedInteractionEventDetail & {
-    event: Record<string, unknown> | TouchEvent;
-};
-declare type MousePointsDetail = {
-    startPoints: IPoints;
-    lastPoints: IPoints;
-    currentPoints: IPoints;
-    deltaPoints: IPoints;
-};
-declare type TouchPointsDetail = {
-    startPoints: ITouchPoints;
-    lastPoints: ITouchPoints;
-    currentPoints: ITouchPoints;
-    startPointsList: ITouchPoints[];
-    lastPointsList: ITouchPoints[];
-    currentPointsList: ITouchPoints[];
-    deltaPoints: IPoints;
-    deltaDistance: IDistance;
-};
-declare type InteractionEventDetail = NormalizedInteractionEventDetail & (MouseCustomEventDetail | TouchCustomEventDetail) & (MousePointsDetail | TouchPointsDetail);
-declare type InteractionStartEventDetail = InteractionEventDetail;
-declare type InteractionEndEventDetail = InteractionEventDetail;
-declare type ToolModeChangedEventDetail = {
-    toolGroupId: string;
-    toolName: string;
-    mode: ToolModes;
-    toolBindingsOptions?: SetToolBindingsType;
-};
-declare type ToolActivatedEventDetail = {
-    toolGroupId: string;
-    toolName: string;
-    toolBindingsOptions: SetToolBindingsType;
-};
-declare type AnnotationAddedEventDetail = {
-    viewportId: string;
-    renderingEngineId: string;
-    annotation: Annotation;
-};
-declare type AnnotationCompletedEventDetail = {
-    annotation: Annotation;
-};
-declare type AnnotationModifiedEventDetail = {
-    viewportId: string;
-    renderingEngineId: string;
-    annotation: Annotation;
-};
-declare type AnnotationRemovedEventDetail = {
-    annotation: Annotation;
-    annotationManagerUID: string;
-};
-declare type AnnotationSelectionChangeEventDetail = {
-    added: Array<string>;
-    removed: Array<string>;
-    selection: Array<string>;
-};
-declare type AnnotationLockChangeEventDetail = {
-    added: Array<Annotation>;
-    removed: Array<Annotation>;
-    locked: Array<Annotation>;
-};
-declare type AnnotationVisibilityChangeEventDetail = {
-    lastHidden: Array<string>;
-    lastVisible: Array<string>;
-    hidden: Array<string>;
-};
-declare type AnnotationRenderedEventDetail = {
-    element: HTMLDivElement;
-    viewportId: string;
-    renderingEngineId: string;
-};
-declare type SegmentationDataModifiedEventDetail = {
-    segmentationId: string;
-    modifiedSlicesToUse?: number[];
-};
-declare type SegmentationRenderedEventDetail = {
-    viewportId: string;
-    toolGroupId: string;
-};
-declare type SegmentationRepresentationModifiedEventDetail = {
-    toolGroupId: string;
-    segmentationRepresentationUID: string;
-};
-declare type SegmentationRemovedEventDetail = {
-    segmentationId: string;
-};
-declare type SegmentationRepresentationRemovedEventDetail = {
-    toolGroupId: string;
-    segmentationRepresentationUID: string;
-};
-declare type SegmentationModifiedEventDetail = {
-    segmentationId: string;
-};
-declare type KeyDownEventDetail = {
-    element: HTMLDivElement;
-    viewportId: string;
-    renderingEngineId: string;
-    key: string;
-    keyCode: number;
-};
-declare type KeyUpEventDetail = KeyDownEventDetail;
-declare type MouseDownEventDetail = NormalizedInteractionEventDetail & MouseCustomEventDetail & MousePointsDetail & {
-    mouseButton: number;
-};
-declare type TouchStartEventDetail = NormalizedInteractionEventDetail & TouchCustomEventDetail & TouchPointsDetail;
-declare type MouseDragEventDetail = NormalizedInteractionEventDetail & MouseCustomEventDetail & MousePointsDetail & {
-    mouseButton: number;
-};
-declare type TouchDragEventDetail = NormalizedInteractionEventDetail & TouchCustomEventDetail & TouchPointsDetail;
-declare type MouseMoveEventDetail = NormalizedInteractionEventDetail & MouseCustomEventDetail & {
-    currentPoints: IPoints;
-};
-declare type MouseUpEventDetail = NormalizedInteractionEventDetail & MouseCustomEventDetail & MousePointsDetail & {
-    mouseButton: number;
-};
-declare type TouchEndEventDetail = NormalizedInteractionEventDetail & TouchPointsDetail & TouchCustomEventDetail;
-declare type MouseDownActivateEventDetail = NormalizedInteractionEventDetail & MousePointsDetail & MouseCustomEventDetail & {
-    mouseButton: number;
-};
-declare type TouchStartActivateEventDetail = NormalizedInteractionEventDetail & TouchCustomEventDetail & TouchPointsDetail;
-declare type MouseClickEventDetail = NormalizedInteractionEventDetail & MouseCustomEventDetail & MousePointsDetail & {
-    mouseButton: number;
-};
-declare type MouseDoubleClickEventDetail = NormalizedInteractionEventDetail & MouseCustomEventDetail & MousePointsDetail;
-declare type TouchTapEventDetail = NormalizedInteractionEventDetail & TouchCustomEventDetail & {
-    currentPointsList: ITouchPoints[];
-    currentPoints: ITouchPoints;
-    taps: number;
-};
-declare type TouchSwipeEventDetail = NormalizedInteractionEventDetail & TouchCustomEventDetail & {
-    swipe: Swipe;
-};
-declare type TouchPressEventDetail = NormalizedInteractionEventDetail & TouchCustomEventDetail & {
-    startPointsList: ITouchPoints[];
-    lastPointsList: ITouchPoints[];
-    startPoints: ITouchPoints;
-    lastPoints: ITouchPoints;
-};
-declare type MouseWheelEventDetail = NormalizedInteractionEventDetail & MouseCustomEventDetail & {
-    detail: Record<string, any>;
-    wheel: {
-        spinX: number;
-        spinY: number;
-        pixelX: number;
-        pixelY: number;
-        direction: number;
-    };
-    points: IPoints;
-};
-declare type VolumeScrollOutOfBoundsEventDetail = {
-    volumeId: string;
-    viewport: Types.IVolumeViewport;
-    desiredStepIndex: number;
-    currentStepIndex: number;
-    delta: number;
-    numScrollSteps: number;
-    currentImageId: string;
-};
-declare type NormalizedMouseEventType = Types.CustomEventType<MouseCustomEventDetail>;
-declare type NormalizedTouchEventType = Types.CustomEventType<TouchCustomEventDetail>;
-declare type ToolModeChangedEventType = Types.CustomEventType<ToolModeChangedEventDetail>;
-declare type ToolActivatedEventType = Types.CustomEventType<ToolActivatedEventDetail>;
-declare type AnnotationAddedEventType = Types.CustomEventType<AnnotationAddedEventDetail>;
-declare type AnnotationCompletedEventType = Types.CustomEventType<AnnotationCompletedEventDetail>;
-declare type AnnotationModifiedEventType = Types.CustomEventType<AnnotationModifiedEventDetail>;
-declare type AnnotationRemovedEventType = Types.CustomEventType<AnnotationRemovedEventDetail>;
-declare type AnnotationSelectionChangeEventType = Types.CustomEventType<AnnotationSelectionChangeEventDetail>;
-declare type AnnotationRenderedEventType = Types.CustomEventType<AnnotationRenderedEventDetail>;
-declare type AnnotationLockChangeEventType = Types.CustomEventType<AnnotationLockChangeEventDetail>;
-declare type AnnotationVisibilityChangeEventType = Types.CustomEventType<AnnotationVisibilityChangeEventDetail>;
-declare type SegmentationDataModifiedEventType = Types.CustomEventType<SegmentationDataModifiedEventDetail>;
-declare type SegmentationRepresentationModifiedEventType = Types.CustomEventType<SegmentationRepresentationModifiedEventDetail>;
-declare type SegmentationRemovedEventType = Types.CustomEventType<SegmentationRemovedEventDetail>;
-declare type SegmentationRepresentationRemovedEventType = Types.CustomEventType<SegmentationRepresentationRemovedEventDetail>;
-declare type SegmentationRenderedEventType = Types.CustomEventType<SegmentationRenderedEventDetail>;
-declare type SegmentationModifiedEventType = Types.CustomEventType<SegmentationModifiedEventDetail>;
-declare type KeyDownEventType = Types.CustomEventType<KeyDownEventDetail>;
-declare type KeyUpEventType = Types.CustomEventType<KeyUpEventDetail>;
-declare type MouseDownEventType = Types.CustomEventType<MouseDownEventDetail>;
-declare type TouchTapEventType = Types.CustomEventType<TouchTapEventDetail>;
-declare type TouchSwipeEventType = Types.CustomEventType<TouchSwipeEventDetail>;
-declare type TouchPressEventType = Types.CustomEventType<TouchPressEventDetail>;
-declare type TouchStartEventType = Types.CustomEventType<TouchStartEventDetail>;
-declare type InteractionEventType = Types.CustomEventType<InteractionEventDetail>;
-declare type InteractionStartType = Types.CustomEventType<InteractionStartEventDetail>;
-declare type InteractionEndType = Types.CustomEventType<InteractionEndEventDetail>;
-declare type MouseDownActivateEventType = Types.CustomEventType<MouseDownActivateEventDetail>;
-declare type TouchStartActivateEventType = Types.CustomEventType<TouchStartActivateEventDetail>;
-declare type MouseDragEventType = Types.CustomEventType<MouseDragEventDetail>;
-declare type TouchDragEventType = Types.CustomEventType<TouchDragEventDetail>;
-declare type MouseUpEventType = Types.CustomEventType<MouseUpEventDetail>;
-declare type TouchEndEventType = Types.CustomEventType<TouchEndEventDetail>;
-declare type MouseClickEventType = Types.CustomEventType<MouseClickEventDetail>;
-declare type MouseMoveEventType = Types.CustomEventType<MouseMoveEventDetail>;
-declare type MouseDoubleClickEventType = Types.CustomEventType<MouseDoubleClickEventDetail>;
-declare type MouseWheelEventType = Types.CustomEventType<MouseWheelEventDetail>;
-declare type VolumeScrollOutOfBoundsEventType = Types.CustomEventType<VolumeScrollOutOfBoundsEventDetail>;
-export { InteractionStartType, InteractionEndType, InteractionEventType, NormalizedInteractionEventDetail, NormalizedMouseEventType, NormalizedTouchEventType, ToolModeChangedEventDetail, ToolModeChangedEventType, ToolActivatedEventDetail, ToolActivatedEventType, AnnotationAddedEventDetail, AnnotationAddedEventType, AnnotationCompletedEventDetail, AnnotationCompletedEventType, AnnotationModifiedEventDetail, AnnotationModifiedEventType, AnnotationRemovedEventDetail, AnnotationRemovedEventType, AnnotationSelectionChangeEventDetail, AnnotationSelectionChangeEventType, AnnotationRenderedEventDetail, AnnotationRenderedEventType, AnnotationLockChangeEventDetail, AnnotationVisibilityChangeEventDetail, AnnotationLockChangeEventType, AnnotationVisibilityChangeEventType, SegmentationDataModifiedEventType, SegmentationRepresentationModifiedEventDetail, SegmentationRepresentationModifiedEventType, SegmentationRepresentationRemovedEventDetail, SegmentationRepresentationRemovedEventType, SegmentationRemovedEventType, SegmentationRemovedEventDetail, SegmentationDataModifiedEventDetail, SegmentationRenderedEventType, SegmentationRenderedEventDetail, SegmentationModifiedEventType, SegmentationModifiedEventDetail, KeyDownEventDetail, KeyDownEventType, KeyUpEventDetail, KeyUpEventType, MouseDownEventDetail, TouchStartEventDetail, MouseDownEventType, TouchStartEventType, MouseDownActivateEventDetail, TouchStartActivateEventDetail, MouseDownActivateEventType, TouchStartActivateEventType, MouseDragEventDetail, TouchDragEventDetail, MouseDragEventType, TouchDragEventType, MouseUpEventDetail, TouchEndEventDetail, MouseUpEventType, TouchEndEventType, MouseClickEventDetail, MouseClickEventType, TouchTapEventDetail, TouchTapEventType, TouchSwipeEventDetail, TouchSwipeEventType, TouchPressEventDetail, TouchPressEventType, MouseMoveEventDetail, MouseMoveEventType, MouseDoubleClickEventDetail, MouseDoubleClickEventType, MouseWheelEventDetail, MouseWheelEventType, VolumeScrollOutOfBoundsEventDetail, VolumeScrollOutOfBoundsEventType, };

package/dist/esm/types/IToolClassReference.d.ts

@@ -1,3 +0,0 @@
-import { BaseTool } from '../tools';
-declare type IToolClassReference = new <T extends BaseTool>(config: any) => T;
-export default IToolClassReference;

package/dist/esm/types/InteractionTypes.d.ts

@@ -1,2 +0,0 @@
-declare type InteractionTypes = 'Mouse' | 'Touch';
-export default InteractionTypes;

package/dist/esm/utilities/math/angle/angleBetweenLines.d.ts

@@ -1,6 +0,0 @@
-import type { Types } from '@cornerstonejs/core';
-declare type Line2D = [Types.Point2, Types.Point2];
-declare type Line3D = [Types.Point3, Types.Point3];
-declare type Line = Line2D | Line3D;
-export default function angleBetweenLines(line1: Line, line2: Line): number;
-export {};