larvitar 1.5.13 → 2.0.0

package/imaging/tools/{main.js → main.ts}

@@ -5,7 +5,7 @@
 
 // external libraries
 import cornerstone from "cornerstone-core";
-import cornerstoneTools from "cornerstone-tools/dist/cornerstoneTools.js";
+import cornerstoneTools from "cornerstone-tools";
 import cornerstoneMath from "cornerstone-math";
 import Hammer from "hammerjs";
 import { each, extend } from "lodash";
@@ -18,7 +18,8 @@ import {
   DEFAULT_SETTINGS,
   dvTools
 } from "./default";
-import { larvitar_store } from "../imageStore";
+import { set as setStore } from "../imageStore";
+import type { ToolConfig, ToolSettings, ToolStyle } from "./types";
 
 /**
  * Initialize cornerstone tools with default configuration (extended with custom configuration)
@@ -27,7 +28,10 @@ import { larvitar_store } from "../imageStore";
  * @param {Object} settings - the style object (see tools/default.js)
  * @example larvitar.initializeCSTools({showSVGCursors:false}, {color: "0000FF"});
  */
-const initializeCSTools = function (settings, style) {
+const initializeCSTools = function (
+  settings?: ToolSettings,
+  style?: ToolStyle
+) {
   cornerstoneTools.external.cornerstone = cornerstone;
   cornerstoneTools.external.cornerstoneMath = cornerstoneMath;
   cornerstoneTools.external.Hammer = Hammer;
@@ -47,10 +51,14 @@ const initializeCSTools = function (settings, style) {
  * Create stack object to sync stack tools
  * @function csToolsCreateStack
  * @param {HTMLElement} element - The target hmtl element.
- * @param {Array} imageIds - Stack image ids.
+ * @param {Array?} imageIds - Stack image ids.
  * @param {String} currentImageId - The current image id.
  */
-const csToolsCreateStack = function (element, imageIds, currentImageIndex) {
+const csToolsCreateStack = function (
+  element: HTMLElement,
+  imageIds?: string[],
+  currentImageIndex?: number
+) {
   let stack;
   if (imageIds) {
     stack = {
@@ -70,7 +78,11 @@ const csToolsCreateStack = function (element, imageIds, currentImageIndex) {
   cornerstoneTools.addToolState(element, "stack", stack);
 };
 
-export function csToolsUpdateImageIds(elementId, imageIds, imageIdIndex) {
+export function csToolsUpdateImageIds(
+  elementId: string,
+  imageIds: string[],
+  imageIdIndex: number
+) {
   const element = document.getElementById(elementId);
   if (element) {
     const stackState = cornerstoneTools.getToolState(element, "stack");
@@ -88,7 +100,7 @@ export function csToolsUpdateImageIds(elementId, imageIds, imageIdIndex) {
  * @param {String} elementId - The target html element id
  * @param {String} imageId - The imageId in the form xxxxxx//:imageIndex
  */
-export function csToolsUpdateImageIndex(elementId, imageId) {
+export function csToolsUpdateImageIndex(elementId: string, imageId: string) {
   let currentImageIdIndex = parseInt(imageId.split(":")[1]);
   const element = document.getElementById(elementId);
   const stackState = cornerstoneTools.getToolState(element, "stack");
@@ -100,7 +112,7 @@ export function csToolsUpdateImageIndex(elementId, imageId) {
  *
  * @param {*} toolName
  */
-const isToolMissing = function (toolName) {
+const isToolMissing = function (toolName: string) {
   let elements = cornerstone.getEnabledElements();
   let isToolMissing = false;
   // TODO check only target viewports
@@ -120,14 +132,26 @@ const isToolMissing = function (toolName) {
  * @param {*} targetElementId
  * @example larvitar.addTool("ScaleOverlay", {configuration:{minorTickLength: 10, majorTickLength: 25}}, "viewer")
  */
-const addTool = function (toolName, customConfig, targetElementId) {
+const addTool = function (
+  toolName: string,
+  customConfig: Partial<ToolConfig>,
+  targetElementId?: string
+) {
   // extend defaults with user custom props
-  let defaultConfig = DEFAULT_TOOLS[toolName];
+  let defaultConfig = DEFAULT_TOOLS[toolName] || {};
   extend(defaultConfig, customConfig);
 
   if (isToolMissing(toolName)) {
-    const toolClassName = DEFAULT_TOOLS[toolName].class;
+    const toolClassName = defaultConfig.class;
+
+    if (!toolClassName) {
+      throw new Error(
+        `Tool ${toolName} class not found. Please check tools/default or pass a valid tool class name in the configuration object.`
+      );
+    }
+
     const toolClass = cornerstoneTools[toolClassName] || dvTools[toolClassName];
+
     if (targetElementId) {
       let element = document.getElementById(targetElementId);
       cornerstoneTools.addToolForElement(element, toolClass, defaultConfig);
@@ -141,11 +165,16 @@ const addTool = function (toolName, customConfig, targetElementId) {
  * Add all default tools, as listed in tools/default.js
  * @function addDefaultTools
  */
-export const addDefaultTools = function (elementId) {
+export const addDefaultTools = function (elementId: string) {
   let elements = cornerstone.getEnabledElements();
 
   if (elements.length == 0) {
     let element = document.getElementById(elementId);
+    if (!element) {
+      throw new Error(
+        `Element with id ${elementId} not found. Cannot add default tools.`
+      );
+    }
     cornerstone.enable(element);
   }
 
@@ -155,7 +184,6 @@ export const addDefaultTools = function (elementId) {
     if (!isToolMissing(tool.name)) {
       return;
     }
-
     // check target viewports and call add tool with options
     if (tool.viewports == "all") {
       addTool(tool.name, tool.configuration);
@@ -189,7 +217,7 @@ export const addDefaultTools = function (elementId) {
  * Try to update image, catching errors if image is not loaded yet
  * @param {HTMLObject} element
  */
-function tryUpdateImage(element) {
+function tryUpdateImage(element: HTMLElement) {
   try {
     cornerstone.updateImage(element);
   } catch (err) {
@@ -205,8 +233,13 @@ function tryUpdateImage(element) {
  * @param {Array} viewports - The hmtl element id to be used for tool initialization.
  * @param {Boolean} doNotSetInStore - Flag to avoid setting in store (useful on tools initialization eg in addDefaultTools). NOTE: This is just a hack, we must rework tools/ui sync.
  */
-const setToolActive = function (toolName, options, viewports, doNotSetInStore) {
-  let defaultOpt = { ...DEFAULT_TOOLS[toolName].options }; // deep copy obj because otherwise cornerstone tools will modify it
+const setToolActive = function (
+  toolName: string,
+  options?: Partial<ToolConfig["options"]>,
+  viewports?: string[],
+  doNotSetInStore?: boolean
+) {
+  let defaultOpt = { ...DEFAULT_TOOLS[toolName]?.options }; // deep copy obj because otherwise cornerstone tools will modify it
 
   extend(defaultOpt, options);
 
@@ -215,7 +248,9 @@ const setToolActive = function (toolName, options, viewports, doNotSetInStore) {
     each(viewports, function (elementId) {
       let el = document.getElementById(elementId);
       cornerstoneTools.setToolActiveForElement(el, toolName, defaultOpt);
-      tryUpdateImage(el);
+      if (el) {
+        tryUpdateImage(el);
+      }
     });
   } else {
     // activate and update all
@@ -235,10 +270,10 @@ const setToolActive = function (toolName, options, viewports, doNotSetInStore) {
       defaultOpt.mouseButtonMask = [defaultOpt.mouseButtonMask];
     }
     if (defaultOpt.mouseButtonMask.includes(1)) {
-      larvitar_store.set("leftActiveTool", toolName);
+      setStore(["leftActiveTool", toolName]);
     }
     if (defaultOpt.mouseButtonMask.includes(2)) {
-      larvitar_store.set("rightActiveTool", toolName);
+      setStore(["rightActiveTool", toolName]);
     }
   }
 };
@@ -248,25 +283,38 @@ const setToolActive = function (toolName, options, viewports, doNotSetInStore) {
  * @function setToolDisabled
  * @param {String} toolName - The tool name.
  * @param {Array} viewports - The hmtl element id to be used for tool initialization.
+ * @param {Boolean} resetCursor - Flag to restore native cursor. @default true
  */
-const setToolDisabled = function (toolName, viewports) {
+const setToolDisabled = function (
+  toolName: string,
+  viewports?: string[],
+  resetCursor = true
+) {
   if (viewports && viewports.length > 0) {
-    // activate and update only for "viewports"
+    // disable and update only for "viewports"
     each(viewports, function (elementId) {
       let el = document.getElementById(elementId);
+      if (!el) {
+        console.warn("setToolDisabled: element not found:", elementId);
+        return;
+      }
       cornerstoneTools.setToolDisabledForElement(el, toolName);
-      // restore native cursor
-      el.style.cursor = "initial";
-      tryUpdateImage(el);
+      if (resetCursor && el && el.style) {
+        // restore native cursor
+        el.style.cursor = "initial";
+        tryUpdateImage(el);
+      }
     });
   } else {
-    // activate and update all
+    // disable and update all
     cornerstoneTools.setToolDisabled(toolName);
     let enabledElements = cornerstone.getEnabledElements();
     each(enabledElements, enel => {
-      // restore native cursor
-      enel.element.style.cursor = "initial";
-      tryUpdateImage(enel.element);
+      if (resetCursor) {
+        // restore native cursor
+        enel.element.style.cursor = "initial";
+        tryUpdateImage(enel.element);
+      }
     });
   }
 };
@@ -276,25 +324,38 @@ const setToolDisabled = function (toolName, viewports) {
  * @function setToolEnabled
  * @param {String} toolName - The tool name.
  * @param {Array} viewports - The hmtl element id to be used for tool initialization.
+ * @param {Boolean} resetCursor - Flag to restore native cursor. @default true
  */
-const setToolEnabled = function (toolName, viewports) {
+const setToolEnabled = function (
+  toolName: string,
+  viewports?: string[],
+  resetCursor = true
+) {
   if (viewports && viewports.length > 0) {
-    // activate and update only for "viewports"
+    // enable and update only for "viewports"
     each(viewports, function (elementId) {
       let el = document.getElementById(elementId);
+      if (!el) {
+        console.warn("setToolDisabled: element not found:", elementId);
+        return;
+      }
       cornerstoneTools.setToolEnabledForElement(el, toolName);
-      // restore native cursor
-      el.style.cursor = "initial";
-      tryUpdateImage(el);
+      if (resetCursor && el && el.style) {
+        // restore native cursor
+        el.style.cursor = "initial";
+        tryUpdateImage(el);
+      }
     });
   } else {
-    // activate and update all
+    // enable and update all
     cornerstoneTools.setToolEnabled(toolName);
     let enabledElements = cornerstone.getEnabledElements();
     each(enabledElements, enel => {
-      // restore native cursor
-      enel.element.style.cursor = "initial";
-      tryUpdateImage(enel.element);
+      if (resetCursor) {
+        // restore native cursor
+        enel.element.style.cursor = "initial";
+        tryUpdateImage(enel.element);
+      }
     });
   }
 };
@@ -305,11 +366,15 @@ const setToolEnabled = function (toolName, viewports) {
  * @param {String} toolName - The tool name.
  * @param {Array} viewports - The hmtl element id to be used for tool initialization.
  */
-const setToolPassive = function (toolName, viewports) {
+const setToolPassive = function (toolName: string, viewports?: string[]) {
   if (viewports && viewports.length > 0) {
     // activate and update only for "viewports"
     each(viewports, function (elementId) {
       let el = document.getElementById(elementId);
+      if (!el) {
+        console.warn("setToolDisabled: element not found:", elementId);
+        return;
+      }
       cornerstoneTools.setToolPassiveForElement(el, toolName);
       tryUpdateImage(el);
     });
@@ -330,7 +395,7 @@ const setToolPassive = function (toolName, viewports) {
  * @function setToolsStyle
  * @param {Object} style - the style object (see tools/defaults.js)
  */
-const setToolsStyle = function (style) {
+const setToolsStyle = function (style?: ToolStyle) {
   extend(DEFAULT_STYLE, style);
 
   let fontFamily = DEFAULT_STYLE.fontFamily;
@@ -339,7 +404,7 @@ const setToolsStyle = function (style) {
   cornerstoneTools.toolStyle.setToolWidth(DEFAULT_STYLE.width);
   cornerstoneTools.toolColors.setToolColor(DEFAULT_STYLE.color);
   cornerstoneTools.toolColors.setActiveColor(DEFAULT_STYLE.activeColor);
-  cornerstoneTools.toolColors.setFillColor(DEFAULT_STYLE.fillColor); // used only by FreehandRoiTool indide handles
+  cornerstoneTools.toolColors.setFillColor(DEFAULT_STYLE.fillColor); // used only by FreehandRoiTool inside handles
   cornerstoneTools.textStyle.setFont(`${fontSize}px ${fontFamily}`);
   cornerstoneTools.textStyle.setBackgroundColor(DEFAULT_STYLE.backgroundColor);
 };