npm - larvitar - Versions diffs - 4.0.0-alpha.7 → 4.0.0-alpha.8 - Mend

larvitar 4.0.0-alpha.7 → 4.0.0-alpha.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/dist/imaging/tools/default.d.ts +13 -1
package/dist/imaging3d/tools/custom/exampleCustomTool.d.ts +10 -9
package/dist/imaging3d/tools/main.d.ts +13 -8
package/dist/larvitar.js +58 -21
package/package.json +1 -1

package/dist/imaging/tools/default.d.ts CHANGED Viewed

@@ -21,6 +21,18 @@ declare const DEFAULT_TOOLS: {
 declare const dvTools: {
     [key: string]: any;
 };
+/**
+ * D/Vision Lab 3D custom tools
+ */
+declare const dvTools3D: {
+    [key: string]: any;
+};
+/**
+ * D/Vision Lab MPR custom tools
+ */
+declare const dvToolsMPR: {
+    [key: string]: any;
+};
 /**
  * Tools default style
  * Available font families :
@@ -57,4 +69,4 @@ declare const setDefaultToolsProps: (newProps: Partial<ToolConfig>[]) => void;
  * NOTE: toolClass must be a valid cornerstone tool
  */
 declare const registerExternalTool: (toolName: string, toolClass: any, toolVersion?: "MPR" | "3D" | "") => void;
-export { DEFAULT_TOOLS, DEFAULT_TOOLS_3D, DEFAULT_TOOLS_MPR, DEFAULT_STYLE, DEFAULT_SETTINGS, DEFAULT_MOUSE_KEYS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool };
+export { DEFAULT_TOOLS, DEFAULT_TOOLS_3D, DEFAULT_TOOLS_MPR, DEFAULT_STYLE, DEFAULT_SETTINGS, DEFAULT_MOUSE_KEYS, dvTools, dvTools3D, dvToolsMPR, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool };

package/dist/imaging3d/tools/custom/exampleCustomTool.d.ts CHANGED Viewed

@@ -1,4 +1,5 @@
 import { BaseTool } from "@cornerstonejs/tools";
+import { Viewport } from "@cornerstonejs/core";
 import * as EventTypes from "@cornerstonejs/tools/dist/esm/types/EventTypes";
 /**
  * WindowLevel tool manipulates the windowLevel applied to a viewport. It
@@ -14,16 +15,16 @@ declare class CustomWWWLTool extends BaseTool {
     touchDragCallback(evt: EventTypes.InteractionEventType): void;
     mouseDragCallback(evt: EventTypes.InteractionEventType): void;
     getPTScaledNewRange({ deltaPointsCanvas, lower, upper, clientHeight, viewport, volumeId, isPreScaled }: {
-        deltaPointsCanvas: any;
-        lower: any;
-        upper: any;
-        clientHeight: any;
-        viewport: any;
-        volumeId: any;
-        isPreScaled: any;
+        deltaPointsCanvas: number[];
+        lower: number;
+        upper: number;
+        clientHeight: number;
+        viewport: Viewport;
+        volumeId?: string;
+        isPreScaled: boolean;
     }): {
-        lower: any;
-        upper: any;
+        lower: number;
+        upper: number;
     };
     getNewRange({ viewport, deltaPointsCanvas, volumeId, lower, upper }: {
         viewport: any;

package/dist/imaging3d/tools/main.d.ts CHANGED Viewed

@@ -15,19 +15,23 @@ import type { RenderingEngine } from "@cornerstonejs/core";
  */
 export declare const initializeCSTools: (settings?: ToolSettings, style?: ToolStyle) => Promise<void>;
 /**
- * Add a cornerstone tool (grab it from original library or dvision custom tools)
- * @param {*} toolName
- * @param {*} targetElementId
+ * Add a cornerstone 3D tool (grab it from original library or dvision custom 3D or MPR tools)
+ * @param {String} toolName
+ * @param {Partial<ToolConfig>} customConfig
+ * @param {String} type The type of tool to add (3D or MPR)
+ * @param {String} groupId The cornerstone3D Tool GroupID
  * @example larvitar.addTool("ScaleOverlay", {configuration:{minorTickLength: 10, majorTickLength: 25}}, "viewer")
  */
-export declare const addTool: (toolName: string, customConfig: Partial<ToolConfig>, groupId?: string) => void;
+export declare const addTool: (toolName: string, customConfig: Partial<ToolConfig>, type?: string, groupId?: string) => void;
 /**
  * @function addDefaultTools
  * @desc Adds default tools to the rendering engine (wwwl, pan, zoom, stackScroll)
- * @param elementId - the id of the element where the tools will be added
- * @param renderingEngine - the rendering engine where the tools will be added
+ * @param {String[]} elementIds - the ids of the elements where the tools will be added
+ * @param {RenderingEngine} renderingEngine - the rendering engine where the tools will be added
+ * @param {String} type The type of tool to add (3D or MPR)
+ * @param {String} groupId The cornerstone3D Tool GroupID
  */
-export declare const addDefaultTools: (elementIds: string[], renderingEngine: RenderingEngine, type?: string) => void;
+export declare const addDefaultTools: (elementIds: string[], renderingEngine: RenderingEngine, type?: string, toolGroupId?: string) => void;
 /**
  * Set Tool "active" on all elements (ie, rendered and manipulable)
  * @param toolName - The tool name.
@@ -53,9 +57,10 @@ export declare const syncViewportsCamera: (id: string | undefined, targetViewpor
  * @param groupId - The id of the tool group to create. @default "default"
  * @param viewports
  * @param tools
+ * @param type - MPR or 3D
  * @returns toolGroup - The created tool group.
  */
-export declare const createToolGroup: (groupId?: string, viewports?: string[], tools?: any[]) => cornerstoneTools.Types.IToolGroup | undefined;
+export declare const createToolGroup: (groupId?: string, viewports?: string[], tools?: any[], type?: string) => cornerstoneTools.Types.IToolGroup | undefined;
 /**
  * Set slab thickness and mode for a given viewport
  * @function setSlab

package/dist/larvitar.js CHANGED Viewed

@@ -85551,7 +85551,7 @@ __webpack_require__.d(index_dist_esm_constants_namespaceObject, {
 });
 ;// ./package.json
-const index_package_namespaceObject = /*#__PURE__*/JSON.parse('{"name":"larvitar","keywords":["DICOM","imaging","medical","cornerstone"],"version":"4.0.0-alpha.7","description":"typescript library for parsing, loading, rendering and interacting with DICOM images","repository":{"url":"https://github.com/dvisionlab/Larvitar.git","type":"git"},"main":"dist/larvitar.js","types":"dist/index.d.ts","files":["dist","imaging/**/*.d.ts","imaging3d/**/*.d.ts"],"scripts":{"coverage":"typescript-coverage-report","format":"prettier --write \\"imaging/**/*.{js,ts,json,css,md}\\" \\"imaging3d/**/*.{js,ts,json,css,md}\\" \\"docs/examples/**/*.html\\"","format:check":"prettier --check \\"imaging/**/*.{js,ts,json,css,md}\\" \\"imaging3d/**/*.{js,ts,json,css,md}\\" \\"docs/examples/**/*.html\\"","postinstall":"patch-package","build":"webpack --config ./bundler/webpack.prod.debug.js","dev":"webpack --progress --config ./bundler/webpack.dev.js","docs:dev":"vuepress dev docs","docs:build":"vuepress build docs","cypress":"cypress open","cypress:run":"cypress run","cypress:run:headless":"cypress run --headless"},"author":"Simone Manini <simone.manini@dvisionlab.com> (https://www.dvisionlab.com)","contributors":["Mattia Ronzoni <mattia.ronzoni@dvisionlab.com> (https://www.dvisionlab.com)","Laura Borghesi <laura.borghesi@dvisionlab.com> (https://www.dvisionlab.com)","Sara Zanchi <sara.zanchi@dvisionlab.com> (https://www.dvisionlab.com)"],"license":"MIT","dependencies":{"@cornerstonejs/core":"^3.12.1","@cornerstonejs/dicom-image-loader":"^3.12.1","@cornerstonejs/nifti-volume-loader":"^3.12.1","@cornerstonejs/tools":"^3.12.1","@hyzyla/pdfium":"^2.1.2","@icr/polyseg-wasm":"^0.4.0","consola":"^3.4.0","cornerstone-core":"^2.6.1","cornerstone-file-image-loader":"^0.3.0","cornerstone-tools":"^6.0.7","cornerstone-wado-image-loader":"^4.13.2","cornerstone-web-image-loader":"^2.1.1","crypto-js":"^4.1.1","dcmjs":"^0.34.0","dicom-character-set":"^1.0.3","dicom-parser":"^1.8.13","hammerjs":"^2.0.8","jpeg-lossless-decoder-js":"^2.0.7","keycode-js":"^3.1.0","lodash":"^4.17.15","pako":"^1.0.10","plotly.js-dist-min":"^2.27.1","uuid":"^8.3.2"},"devDependencies":{"@babel/core":"^7.21.8","@rollup/plugin-commonjs":"^28.0.3","@types/cornerstone-core":"^2.3.0","@types/crypto-js":"^4.1.1","@types/hammerjs":"^2.0.41","@types/lodash":"^4.14.192","@types/papaparse":"^5.3.7","@types/plotly.js":"^2.12.30","@types/plotly.js-dist-min":"^2.3.4","@types/uuid":"^9.0.1","@vuepress/bundler-vite":"^2.0.0-rc.18","@vuepress/plugin-slimsearch":"^2.0.0-rc.68","@vuepress/theme-default":"^2.0.0-rc.60","babel-loader":"^9.1.2","clean-webpack-plugin":"^4.0.0","cypress":"^14.2.0","cypress-image-snapshot":"^4.0.1","cypress-mochawesome-reporter":"^3.8.2","cypress-multi-reporters":"^2.0.5","eslint":"^9.17.0","html-loader":"^4.2.0","html-webpack-plugin":"^5.6.0","jsdom":"^26.0.0","lodash-webpack-plugin":"^0.11.6","mocha-json-reporter":"^1.0.0-1","patch-package":"^8.0.0","prettier":"^3.5.3","sass-embedded":"^1.80.7","ts-loader":"^9.4.2","typescript":"^5.0.2","typescript-coverage-report":"^0.7.0","vuepress":"^2.0.0-rc.18","webpack":"^5.76.3","webpack-cli":"^5.0.1","webpack-dev-server":"^4.13.1"}}');
+const index_package_namespaceObject = /*#__PURE__*/JSON.parse('{"name":"larvitar","keywords":["DICOM","imaging","medical","cornerstone"],"version":"4.0.0-alpha.8","description":"typescript library for parsing, loading, rendering and interacting with DICOM images","repository":{"url":"https://github.com/dvisionlab/Larvitar.git","type":"git"},"main":"dist/larvitar.js","types":"dist/index.d.ts","files":["dist","imaging/**/*.d.ts","imaging3d/**/*.d.ts"],"scripts":{"coverage":"typescript-coverage-report","format":"prettier --write \\"imaging/**/*.{js,ts,json,css,md}\\" \\"imaging3d/**/*.{js,ts,json,css,md}\\" \\"docs/examples/**/*.html\\"","format:check":"prettier --check \\"imaging/**/*.{js,ts,json,css,md}\\" \\"imaging3d/**/*.{js,ts,json,css,md}\\" \\"docs/examples/**/*.html\\"","postinstall":"patch-package","build":"webpack --config ./bundler/webpack.prod.debug.js","dev":"webpack --progress --config ./bundler/webpack.dev.js","docs:dev":"vuepress dev docs","docs:build":"vuepress build docs","cypress":"cypress open","cypress:run":"cypress run","cypress:run:headless":"cypress run --headless"},"author":"Simone Manini <simone.manini@dvisionlab.com> (https://www.dvisionlab.com)","contributors":["Mattia Ronzoni <mattia.ronzoni@dvisionlab.com> (https://www.dvisionlab.com)","Laura Borghesi <laura.borghesi@dvisionlab.com> (https://www.dvisionlab.com)","Sara Zanchi <sara.zanchi@dvisionlab.com> (https://www.dvisionlab.com)"],"license":"MIT","dependencies":{"@cornerstonejs/core":"^3.12.1","@cornerstonejs/dicom-image-loader":"^3.12.1","@cornerstonejs/nifti-volume-loader":"^3.12.1","@cornerstonejs/tools":"^3.12.1","@hyzyla/pdfium":"^2.1.2","@icr/polyseg-wasm":"^0.4.0","consola":"^3.4.0","cornerstone-core":"^2.6.1","cornerstone-file-image-loader":"^0.3.0","cornerstone-tools":"^6.0.7","cornerstone-wado-image-loader":"^4.13.2","cornerstone-web-image-loader":"^2.1.1","crypto-js":"^4.1.1","dcmjs":"^0.34.0","dicom-character-set":"^1.0.3","dicom-parser":"^1.8.13","hammerjs":"^2.0.8","jpeg-lossless-decoder-js":"^2.0.7","keycode-js":"^3.1.0","lodash":"^4.17.15","pako":"^1.0.10","plotly.js-dist-min":"^2.27.1","uuid":"^8.3.2"},"devDependencies":{"@babel/core":"^7.21.8","@rollup/plugin-commonjs":"^28.0.3","@types/cornerstone-core":"^2.3.0","@types/crypto-js":"^4.1.1","@types/hammerjs":"^2.0.41","@types/lodash":"^4.14.192","@types/papaparse":"^5.3.7","@types/plotly.js":"^2.12.30","@types/plotly.js-dist-min":"^2.3.4","@types/uuid":"^9.0.1","@vuepress/bundler-vite":"^2.0.0-rc.18","@vuepress/plugin-slimsearch":"^2.0.0-rc.68","@vuepress/theme-default":"^2.0.0-rc.60","babel-loader":"^9.1.2","clean-webpack-plugin":"^4.0.0","cypress":"^14.2.0","cypress-image-snapshot":"^4.0.1","cypress-mochawesome-reporter":"^3.8.2","cypress-multi-reporters":"^2.0.5","eslint":"^9.17.0","html-loader":"^4.2.0","html-webpack-plugin":"^5.6.0","jsdom":"^26.0.0","lodash-webpack-plugin":"^0.11.6","mocha-json-reporter":"^1.0.0-1","patch-package":"^8.0.0","prettier":"^3.5.3","sass-embedded":"^1.80.7","ts-loader":"^9.4.2","typescript":"^5.0.2","typescript-coverage-report":"^0.7.0","vuepress":"^2.0.0-rc.18","webpack":"^5.76.3","webpack-cli":"^5.0.1","webpack-dev-server":"^4.13.1"}}');
 // EXTERNAL MODULE: ./node_modules/cornerstone-core/dist/cornerstone.js
 var index_dist_cornerstone = __webpack_require__(1198);
 var index_cornerstone_default = /*#__PURE__*/__webpack_require__.n(index_dist_cornerstone);
@@ -97936,6 +97936,14 @@ const index_dvTools = {
     RotateTool: index_RotateTool,
     GspsTool: index_GspsTool
 };
+/**
+ * D/Vision Lab 3D custom tools
+ */
+const index_dvTools3D = {};
+/**
+ * D/Vision Lab MPR custom tools
+ */
+const index_dvToolsMPR = {};
 /**
  * Tools default style
  * Available font families :
@@ -98034,7 +98042,12 @@ const index_registerExternalTool = function (toolName, toolClass, toolVersion =
         : toolVersion === "3D"
             ? index_DEFAULT_TOOLS_3D
             : index_DEFAULT_TOOLS;
-    index_dvTools[toolClass.name] = toolClass;
+    const customTools = toolVersion === "MPR"
+        ? index_dvToolsMPR
+        : toolVersion === "3D"
+            ? index_dvTools3D
+            : index_dvTools;
+    customTools[toolClass.name] = toolClass;
     targetTools[toolName] = {
         name: toolName,
         class: toolClass.name,
@@ -284168,13 +284181,24 @@ const index_main_isToolMissing = function (toolName, targetElementId) {
     return false;
 };
 /**
- * Add a cornerstone tool (grab it from original library or dvision custom tools)
- * @param {*} toolName
- * @param {*} targetElementId
+ * Add a cornerstone 3D tool (grab it from original library or dvision custom 3D or MPR tools)
+ * @param {String} toolName
+ * @param {Partial<ToolConfig>} customConfig
+ * @param {String} type The type of tool to add (3D or MPR)
+ * @param {String} groupId The cornerstone3D Tool GroupID
  * @example larvitar.addTool("ScaleOverlay", {configuration:{minorTickLength: 10, majorTickLength: 25}}, "viewer")
  */
-const index_main_addTool = function (toolName, customConfig, groupId) {
-    const allToolsList = Object.assign(Object.assign({}, index_DEFAULT_TOOLS_3D), index_DEFAULT_TOOLS_MPR);
+const index_main_addTool = function (toolName, customConfig, type, groupId) {
+    let allToolsList;
+    if (type === "3D") {
+        allToolsList = index_DEFAULT_TOOLS_3D;
+    }
+    else if (type === "MPR") {
+        allToolsList = index_DEFAULT_TOOLS_MPR;
+    }
+    else {
+        allToolsList = Object.assign(Object.assign({}, index_DEFAULT_TOOLS_3D), index_DEFAULT_TOOLS_MPR);
+    }
     console.log("allToolsList", allToolsList);
     // extend defaults with user custom props
     let defaultConfig = allToolsList[toolName]
@@ -284185,7 +284209,17 @@ const index_main_addTool = function (toolName, customConfig, groupId) {
     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 = index_dvTools[toolClassName] ||
+    let customTool;
+    if (type === "3D") {
+        customTool = index_dvTools3D[toolClassName];
+    }
+    else if (type === "MPR") {
+        customTool = index_dvToolsMPR[toolClassName];
+    }
+    else {
+        customTool = index_dvTools3D[toolClassName] || index_dvToolsMPR[toolClassName];
+    }
+    const toolClass = customTool ||
         index_dist_esm_namespaceObject[toolClassName];
     index_addTool_addTool(toolClass);
     if (groupId) {
@@ -284202,11 +284236,13 @@ const index_main_addTool = function (toolName, customConfig, groupId) {
 /**
  * @function addDefaultTools
  * @desc Adds default tools to the rendering engine (wwwl, pan, zoom, stackScroll)
- * @param elementId - the id of the element where the tools will be added
- * @param renderingEngine - the rendering engine where the tools will be added
+ * @param {String[]} elementIds - the ids of the elements where the tools will be added
+ * @param {RenderingEngine} renderingEngine - the rendering engine where the tools will be added
+ * @param {String} type The type of tool to add (3D or MPR)
+ * @param {String} groupId The cornerstone3D Tool GroupID
  */
-const index_main_addDefaultTools = function (elementIds, renderingEngine, type = "2d" // "mpr" or "2d"
-) {
+const index_main_addDefaultTools = function (elementIds, renderingEngine, type = "3D", // "MPR" or "3D"
+toolGroupId = "default") {
     elementIds.forEach(elementId => {
         const element = renderingEngine.getViewport(elementId).element;
         try {
@@ -284220,7 +284256,6 @@ const index_main_addDefaultTools = function (elementIds, renderingEngine, type =
         const viewport = renderingEngine.getViewport(elementId);
         index_stackPrefetch_stackPrefetch.enable(viewport.element);
     });
-    const toolGroupId = "default"; // TODO as param with default value
     const toolGroup = index_ToolGroupManager_createToolGroup(toolGroupId);
     if (!toolGroup) {
         index_logger_logger.error("addDefaultTools: tool group not created");
@@ -284229,10 +284264,10 @@ const index_main_addDefaultTools = function (elementIds, renderingEngine, type =
     elementIds.forEach(viewportId => {
         toolGroup.addViewport(viewportId, renderingEngine.id);
     });
-    const toolsList = type === "2d" ? index_DEFAULT_TOOLS_3D : index_DEFAULT_TOOLS_MPR;
+    const toolsList = type === "3D" ? index_DEFAULT_TOOLS_3D : index_DEFAULT_TOOLS_MPR;
     // for each default tool
     (0,index_lodash.each)(toolsList, tool => {
-        index_main_addTool(tool.name, tool.configuration);
+        index_main_addTool(tool.name, tool.configuration, type);
         toolGroup.addTool(tool.name, tool.configuration);
         index_logger_logger.debug(`Tool ${tool.name} added to group:`, toolGroupId);
         // if sync tool, enable
@@ -284243,7 +284278,7 @@ const index_main_addDefaultTools = function (elementIds, renderingEngine, type =
         // TODO handle options (mouseButtonMask, etc) and other modes (eg passive)
         if (tool.defaultActive) {
             console.log("setToolActive", tool.name, tool.options);
-            index_main_setToolActive(tool.name, tool.options, undefined, true);
+            index_main_setToolActive(tool.name, tool.options, toolGroupId, true);
             index_logger_logger.debug(`Tool ${tool.name} set as default active`);
         }
     });
@@ -284381,10 +284416,11 @@ targetViewportId, sourceViewportId) {
  * @param groupId - The id of the tool group to create. @default "default"
  * @param viewports
  * @param tools
+ * @param type - MPR or 3D
  * @returns toolGroup - The created tool group.
  */
-const index_main_createToolGroup = function (groupId = "default", viewports = [], tools = [] // TODO type this properly
-) {
+const index_main_createToolGroup = function (groupId = "default", viewports = [], tools = [], // TODO type this properly
+type) {
     const toolGroup = index_ToolGroupManager_createToolGroup(groupId);
     if (!toolGroup) {
         index_logger_logger.error("createToolGroup: tool group not created");
@@ -284400,7 +284436,7 @@ const index_main_createToolGroup = function (groupId = "default", viewports = []
         toolGroup.addViewport(vp, renderingEngineId);
     });
     tools.forEach(tool => {
-        index_main_addTool(tool.name, tool.configuration, groupId);
+        index_main_addTool(tool.name, tool.configuration, type, groupId);
         index_logger_logger.debug(`Tool ${tool.name} added to group:`, groupId);
     });
     return toolGroup;
@@ -284434,7 +284470,9 @@ const index_setWWWL = function (ww, wl, viewportId) {
         index_logger_logger.error("setWWWL: viewport not found");
         return;
     }
-    viewport.setProperties({ voiRange: { lower: wl - ww / 2, upper: wl + ww / 2 } });
+    viewport.setProperties({
+        voiRange: { lower: wl - ww / 2, upper: wl + ww / 2 }
+    });
     viewport.render();
 };
@@ -284568,7 +284606,6 @@ class index_CustomWWWLTool extends index_base_BaseTool {
             return;
         }
     }
-    // @ts-ignore
     getPTScaledNewRange({ deltaPointsCanvas, lower, upper, clientHeight, viewport, volumeId, isPreScaled }) {
         let multiplier = index_exampleCustomTool_DEFAULT_MULTIPLIER;
         if (isPreScaled) {

package/package.json CHANGED Viewed

@@ -6,7 +6,7 @@
     "medical",
     "cornerstone"
   ],
-  "version": "4.0.0-alpha.7",
+  "version": "4.0.0-alpha.8",
   "description": "typescript library for parsing, loading, rendering and interacting with DICOM images",
   "repository": {
     "url": "https://github.com/dvisionlab/Larvitar.git",