init

extensions/test-extension/.webpack/webpack.dev.js

@@ -0,0 +1,12 @@
+const path = require('path');
+const webpackCommon = require('./../../../.webpack/webpack.base.js');
+const SRC_DIR = path.join(__dirname, '../src');
+const DIST_DIR = path.join(__dirname, '../dist');
+
+const ENTRY = {
+  app: `${SRC_DIR}/index.tsx`,
+};
+
+module.exports = (env, argv) => {
+  return webpackCommon(env, argv, { SRC_DIR, DIST_DIR, ENTRY });
+};

extensions/test-extension/.webpack/webpack.prod.js

@@ -0,0 +1,48 @@
+const webpack = require('webpack');
+const { merge } = require('webpack-merge');
+const path = require('path');
+const webpackCommon = require('./../../../.webpack/webpack.base.js');
+const pkg = require('./../package.json');
+
+const ROOT_DIR = path.join(__dirname, './..');
+const SRC_DIR = path.join(__dirname, '../src');
+const DIST_DIR = path.join(__dirname, '../dist');
+
+const ENTRY = {
+  app: `${SRC_DIR}/index.tsx`,
+};
+
+module.exports = (env, argv) => {
+  const commonConfig = webpackCommon(env, argv, { SRC_DIR, DIST_DIR, ENTRY });
+
+  return merge(commonConfig, {
+    stats: {
+      colors: true,
+      hash: true,
+      timings: true,
+      assets: true,
+      chunks: false,
+      chunkModules: false,
+      modules: false,
+      children: false,
+      warnings: true,
+    },
+    optimization: {
+      minimize: true,
+      sideEffects: false,
+    },
+    output: {
+      path: ROOT_DIR,
+      library: 'ohif-extension-test',
+      libraryTarget: 'umd',
+      libraryExport: 'default',
+      filename: pkg.main,
+    },
+    externals: [/\b(vtk.js)/, /\b(dcmjs)/, /\b(gl-matrix)/, /^@ohif/, /^@cornerstonejs/],
+    plugins: [
+      new webpack.optimize.LimitChunkCountPlugin({
+        maxChunks: 1,
+      }),
+    ],
+  });
+};

extensions/test-extension/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Open Health Imaging Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

extensions/test-extension/README.md

@@ -0,0 +1,4 @@
+# Test Extension
+This extension will provide uitlities and module to help with testing. It is not intended to be used in production.
+For instance, we can use the hanging protocol module to inject a hanging protocol into the core and later
+use it to test the hanging protocol detection mechanism.

extensions/test-extension/babel.config.js

@@ -0,0 +1 @@
+module.exports = require('../../babel.config.js');

extensions/test-extension/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@ohif/extension-test",
+  "version": "3.9.1",
+  "description": "OHIF extension used inside e2e testing",
+  "author": "OHIF",
+  "license": "MIT",
+  "repository": "OHIF/Viewers",
+  "main": "dist/ohif-extension-test.umd.js",
+  "module": "src/index.tsx",
+  "engines": {
+    "node": ">=14",
+    "npm": ">=6",
+    "yarn": ">=1.16.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "shx rm -rf dist",
+    "clean:deep": "yarn run clean && shx rm -rf node_modules",
+    "dev": "cross-env NODE_ENV=development webpack --config .webpack/webpack.dev.js --watch --output-pathinfo",
+    "build": "cross-env NODE_ENV=production webpack --config .webpack/webpack.prod.js",
+    "build:package-1": "yarn run build",
+    "start": "yarn run dev",
+    "test:unit": "jest --watchAll",
+    "test:unit:ci": "jest --ci --runInBand --collectCoverage --passWithNoTests"
+  },
+  "peerDependencies": {
+    "@ohif/core": "3.9.1",
+    "@ohif/ui": "3.9.1",
+    "dcmjs": "0.29.11",
+    "dicom-parser": "^1.8.9",
+    "hammerjs": "^2.0.8",
+    "prop-types": "^15.6.2",
+    "react": "^18.3.1"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.20.13",
+    "classnames": "^2.3.2"
+  }
+}

extensions/test-extension/src/custom-attribute/maxNumImageFrames.ts

@@ -0,0 +1,2 @@
+export default (study, extraData) =>
+  Math.max(...(extraData?.displaySets?.map?.(ds => ds.numImageFrames ?? 0) || [0]));

extensions/test-extension/src/custom-attribute/numberOfDisplaySets.ts

@@ -0,0 +1 @@
+export default (study, extraData) => extraData?.displaySets?.length;

extensions/test-extension/src/custom-attribute/sameAs.ts

@@ -0,0 +1,33 @@
+/**
+ * This function extracts an attribute from the already matched display sets, and
+ * compares it to the attribute in the current display set, and indicates if they match.
+ * From 'this', it uses:
+ *    `sameAttribute` as the attribute name to look for
+ *    `sameDisplaySetId` as the display set id to look for
+ * From `options`, it looks for
+ */
+export default function (displaySet, options) {
+  const { sameAttribute, sameDisplaySetId } = this;
+  if (!sameAttribute) {
+    console.log('sameAttribute not defined in', this);
+    return `sameAttribute not defined in ${this.id}`;
+  }
+  if (!sameDisplaySetId) {
+    console.log('sameDisplaySetId not defined in', this);
+    return `sameDisplaySetId not defined in ${this.id}`;
+  }
+  const { displaySetMatchDetails, displaySets } = options;
+  const match = displaySetMatchDetails.get(sameDisplaySetId);
+  if (!match) {
+    console.log('No match for display set', sameDisplaySetId);
+    return false;
+  }
+  const { displaySetInstanceUID } = match;
+  const altDisplaySet = displaySets.find(it => it.displaySetInstanceUID == displaySetInstanceUID);
+  if (!altDisplaySet) {
+    console.log('No display set found with', displaySetInstanceUID, 'in', displaySets);
+    return false;
+  }
+  const testValue = altDisplaySet[sameAttribute];
+  return testValue === displaySet[sameAttribute];
+}

extensions/test-extension/src/custom-context-menu/codingValues.ts

@@ -0,0 +1,80 @@
+/**
+ * Coding values is a map of simple string coding values to a set of
+ * attributes associated with the coding value.
+ *
+ * The simple string is in the format `<codingSchemeDesignator>:<codingValue>`
+ * That allows extracting the DICOM attributes from the designator/value, and
+ * allows for passing around the simple string.
+ * The additional attributes contained in the object include:
+ *       * text - this is the coding scheme text display value, and may be language specific
+ *       * type - this defines a named type, typically 'site'.  Different names can be used
+ *                to allow setting different findingSites values in order to define a hierarchy.
+ *       * color - used to apply annotation color
+ * It is also possible to define additional attributes here, used by custom
+ * extensions.
+ *
+ * See https://dicom.nema.org/medical/dicom/current/output/html/part16.html
+ * for definitions of SCT and other code values.
+ */
+const codingValues = {
+  id: 'codingValues',
+
+  // Sites
+  'SCT:69536005': {
+    text: 'Head',
+    type: 'site',
+  },
+  'SCT:45048000': {
+    text: 'Neck',
+    type: 'site',
+  },
+  'SCT:818981001': {
+    text: 'Abdomen',
+    type: 'site',
+  },
+  'SCT:816092008': {
+    text: 'Pelvis',
+    type: 'site',
+  },
+
+  // Findings
+  'SCT:371861004': {
+    text: 'Mild intimal coronary irregularities',
+    color: 'green',
+  },
+  'SCT:194983005': {
+    text: 'Aortic insufficiency',
+    color: 'darkred',
+  },
+  'SCT:399232001': {
+    text: '2-chamber',
+  },
+  'SCT:103340004': {
+    text: 'SAX',
+  },
+  'SCT:91134007': {
+    text: 'MV',
+  },
+  'SCT:122972007': {
+    text: 'PV',
+  },
+
+  // Orientations
+  'SCT:24422004': {
+    text: 'Axial',
+    color: '#000000',
+    type: 'orientation',
+  },
+  'SCT:81654009': {
+    text: 'Coronal',
+    color: '#000000',
+    type: 'orientation',
+  },
+  'SCT:30730003': {
+    text: 'Sagittal',
+    color: '#000000',
+    type: 'orientation',
+  },
+};
+
+export default codingValues;

extensions/test-extension/src/custom-context-menu/contextMenuCodeItem.ts

@@ -0,0 +1,26 @@
+const codeMenuItem = {
+  id: '@ohif/contextMenuAnnotationCode',
+
+  /** Applies the code value setup for this item */
+  transform: function (customizationService) {
+    const { code: codeRef } = this;
+    if (!codeRef) {
+      throw new Error(`item ${this} has no code ref`);
+    }
+    const codingValues = customizationService.get('codingValues');
+    const code = codingValues[codeRef];
+    return {
+      ...this,
+      codeRef,
+      code: { ref: codeRef, ...code },
+      label: code.text,
+      commands: [
+        {
+          commandName: 'updateMeasurement',
+        },
+      ],
+    };
+  },
+};
+
+export default codeMenuItem;

extensions/test-extension/src/custom-context-menu/findingsContextMenu.ts

@@ -0,0 +1,100 @@
+const findingsContextMenu = {
+  id: 'measurementsContextMenu',
+  customizationType: 'ohif.contextMenu',
+  menus: [
+    {
+      id: 'forExistingMeasurement',
+      // selector restricts context menu to when there is nearbyToolData
+      selector: ({ nearbyToolData }) => !!nearbyToolData,
+      items: [
+        {
+          customizationType: 'ohif.contextSubMenu',
+          label: 'Site',
+          actionType: 'ShowSubMenu',
+          subMenu: 'siteSelectionSubMenu',
+        },
+        {
+          customizationType: 'ohif.contextSubMenu',
+          label: 'Finding',
+          actionType: 'ShowSubMenu',
+          subMenu: 'findingSelectionSubMenu',
+        },
+        {
+          // customizationType is implicit here in the configuration setup
+          label: 'Delete Measurement',
+          commands: [
+            {
+              commandName: 'deleteMeasurement',
+            },
+          ],
+        },
+        {
+          label: 'Add Label',
+          commands: [
+            {
+              commandName: 'setMeasurementLabel',
+            },
+          ],
+        },
+
+        // The example below shows how to include a delegating sub-menu,
+        // Only available on the @ohif/mnGrid hanging protocol
+        // To demonstrate, select the 3x1 layout from the protocol menu
+        // and right click on a measurement.
+        {
+          label: 'IncludeSubMenu',
+          selector: ({ protocol }) => protocol?.id === '@ohif/mnGrid',
+          delegating: true,
+          subMenu: 'orientationSelectionSubMenu',
+        },
+      ],
+    },
+
+    {
+      id: 'orientationSelectionSubMenu',
+      selector: ({ nearbyToolData }) => false,
+      items: [
+        {
+          customizationType: '@ohif/contextMenuAnnotationCode',
+          code: 'SCT:24422004',
+        },
+        {
+          customizationType: '@ohif/contextMenuAnnotationCode',
+          code: 'SCT:81654009',
+        },
+      ],
+    },
+
+    {
+      id: 'findingSelectionSubMenu',
+      selector: ({ nearbyToolData }) => false,
+      items: [
+        {
+          customizationType: '@ohif/contextMenuAnnotationCode',
+          code: 'SCT:371861004',
+        },
+        {
+          customizationType: '@ohif/contextMenuAnnotationCode',
+          code: 'SCT:194983005',
+        },
+      ],
+    },
+
+    {
+      id: 'siteSelectionSubMenu',
+      selector: ({ nearbyToolData }) => !!nearbyToolData,
+      items: [
+        {
+          customizationType: '@ohif/contextMenuAnnotationCode',
+          code: 'SCT:69536005',
+        },
+        {
+          customizationType: '@ohif/contextMenuAnnotationCode',
+          code: 'SCT:45048000',
+        },
+      ],
+    },
+  ],
+};
+
+export default findingsContextMenu;

extensions/test-extension/src/custom-context-menu/index.ts

@@ -0,0 +1,5 @@
+import codingValues from './codingValues';
+import contextMenuCodeItem from './contextMenuCodeItem';
+import findingsContextMenu from './findingsContextMenu';
+
+export { codingValues, contextMenuCodeItem, findingsContextMenu };

extensions/test-extension/src/getCustomizationModule.ts

@@ -0,0 +1,14 @@
+import { codingValues, contextMenuCodeItem, findingsContextMenu } from './custom-context-menu';
+
+export default function getCustomizationModule() {
+  return [
+    {
+      name: 'custom-context-menu',
+      value: [codingValues, contextMenuCodeItem, findingsContextMenu],
+    },
+    {
+      name: 'contextMenuCodeItem',
+      value: [contextMenuCodeItem],
+    },
+  ];
+}

extensions/test-extension/src/hp/index.ts

@@ -0,0 +1,17 @@
+import hpMN from './hpMN';
+
+const hangingProtocols = [
+  {
+    name: '@ohif/hp-extension.mn',
+    protocol: hpMN,
+  },
+];
+
+/**
+ * Registers a single study hanging protocol which can be referenced as
+ * `@ohif/hp-exgtension.mn`, that has initial layouts which show images
+ * only display sets, up to a 2x2 view.
+ */
+export default function getHangingProtocolModule() {
+  return hangingProtocols;
+}

extensions/test-extension/src/hpTestSwitch.ts

@@ -0,0 +1,239 @@
+import { Types } from '@ohif/core';
+
+const viewport0a = {
+  viewportOptions: {
+    viewportId: 'viewportA',
+    toolGroupId: 'default',
+    allowUnmatchedView: true,
+  },
+  displaySets: [
+    {
+      id: 'defaultDisplaySetId',
+    },
+  ],
+};
+
+const viewport1b = {
+  viewportOptions: {
+    viewportId: 'viewportB',
+    toolGroupId: 'default',
+    allowUnmatchedView: true,
+  },
+  displaySets: [
+    {
+      matchedDisplaySetsIndex: 1,
+      id: 'defaultDisplaySetId',
+    },
+  ],
+};
+
+const viewport2c = {
+  viewportOptions: {
+    viewportId: 'viewportC',
+    toolGroupId: 'default',
+    allowUnmatchedView: true,
+  },
+  displaySets: [
+    {
+      matchedDisplaySetsIndex: 2,
+      id: 'defaultDisplaySetId',
+    },
+  ],
+};
+
+const viewport3d = {
+  viewportOptions: {
+    viewportId: 'viewportD',
+    toolGroupId: 'default',
+    allowUnmatchedView: true,
+  },
+  displaySets: [
+    {
+      matchedDisplaySetsIndex: 3,
+      id: 'defaultDisplaySetId',
+    },
+  ],
+};
+
+const viewport4e = {
+  viewportOptions: {
+    viewportId: 'viewportE',
+    toolGroupId: 'default',
+    allowUnmatchedView: true,
+  },
+  displaySets: [
+    {
+      matchedDisplaySetsIndex: 4,
+      id: 'defaultDisplaySetId',
+    },
+  ],
+};
+
+const viewport5f = {
+  viewportOptions: {
+    viewportId: 'viewportF',
+    toolGroupId: 'default',
+    allowUnmatchedView: true,
+  },
+  displaySets: [
+    {
+      matchedDisplaySetsIndex: 5,
+      id: 'defaultDisplaySetId',
+    },
+  ],
+};
+
+const viewport3a = {
+  viewportOptions: {
+    viewportId: 'viewportA',
+    toolGroupId: 'default',
+    allowUnmatchedView: true,
+  },
+  displaySets: [
+    {
+      matchedDisplaySetsIndex: 3,
+      id: 'defaultDisplaySetId',
+    },
+  ],
+};
+
+const viewport2b = {
+  viewportOptions: {
+    viewportId: 'viewportB',
+    toolGroupId: 'default',
+    allowUnmatchedView: true,
+  },
+  displaySets: [
+    {
+      matchedDisplaySetsIndex: 2,
+      id: 'defaultDisplaySetId',
+    },
+  ],
+};
+
+const viewport1c = {
+  viewportOptions: {
+    viewportId: 'viewportC',
+    toolGroupId: 'default',
+    allowUnmatchedView: true,
+  },
+  displaySets: [
+    {
+      matchedDisplaySetsIndex: 1,
+      id: 'defaultDisplaySetId',
+    },
+  ],
+};
+const viewport0d = {
+  viewportOptions: {
+    viewportId: 'viewportD',
+    toolGroupId: 'default',
+    allowUnmatchedView: true,
+  },
+  displaySets: [
+    {
+      matchedDisplaySetsIndex: 0,
+      id: 'defaultDisplaySetId',
+    },
+  ],
+};
+
+const viewportStructure = {
+  layoutType: 'grid',
+  properties: {
+    rows: 2,
+    columns: 2,
+  },
+};
+
+const viewportStructure32 = {
+  layoutType: 'grid',
+  properties: {
+    rows: 2,
+    columns: 3,
+  },
+};
+
+/**
+ * This hanging protocol is a test hanging protocol used to apply various
+ * layouts in different positions for display, re-using earlier names in
+ * various orders.
+ */
+const hpTestSwitch: Types.HangingProtocol.Protocol = {
+  hasUpdatedPriorsInformation: false,
+  id: '@ohif/mnTestSwitch',
+  description: 'Has various hanging protocol grid layouts',
+  name: 'Test Switch',
+  protocolMatchingRules: [
+    {
+      id: 'OneOrMoreSeries',
+      weight: 25,
+      attribute: 'numberOfDisplaySetsWithImages',
+      constraint: {
+        greaterThan: 0,
+      },
+    },
+  ],
+  toolGroupIds: ['default'],
+  displaySetSelectors: {
+    defaultDisplaySetId: {
+      seriesMatchingRules: [
+        {
+          attribute: 'numImageFrames',
+          constraint: {
+            greaterThan: { value: 0 },
+          },
+        },
+        // This display set will select the specified items by preference
+        // It has no affect if nothing is specified in the URL.
+        {
+          attribute: 'isDisplaySetFromUrl',
+          weight: 10,
+          constraint: {
+            equals: true,
+          },
+        },
+      ],
+    },
+  },
+  defaultViewport: {
+    viewportOptions: {
+      viewportType: 'stack',
+      toolGroupId: 'default',
+      allowUnmatchedView: true,
+    },
+    displaySets: [
+      {
+        id: 'defaultDisplaySetId',
+        matchedDisplaySetsIndex: -1,
+      },
+    ],
+  },
+  stages: [
+    {
+      name: '2x2 0a1b2c3d',
+      viewportStructure,
+      viewports: [viewport0a, viewport1b, viewport2c, viewport3d],
+    },
+    {
+      name: '3x2 0a1b4e2c3d5f',
+      viewportStructure: viewportStructure32,
+      // Note the following structure simply preserves the viewportId for
+      // a given screen position
+      viewports: [viewport0a, viewport1b, viewport4e, viewport2c, viewport3d, viewport5f],
+    },
+    {
+      name: '2x2 1c0d3a2b',
+      viewportStructure,
+      viewports: [viewport1c, viewport0d, viewport3a, viewport2b],
+    },
+    {
+      name: '2x2 3a2b1c0d',
+      viewportStructure,
+      viewports: [viewport3a, viewport2b, viewport1c, viewport0d],
+    },
+  ],
+  numberOfPriorsReferenced: -1,
+};
+
+export default hpTestSwitch;

extensions/test-extension/src/id.js

@@ -0,0 +1,5 @@
+import packageJson from '../package.json';
+
+const id = packageJson.name;
+
+export { id };

extensions/test-extension/src/index.tsx

@@ -0,0 +1,64 @@
+import { Types } from '@ohif/core';
+
+import { id } from './id';
+
+import hpTestSwitch from './hpTestSwitch';
+
+import getCustomizationModule from './getCustomizationModule';
+// import {setViewportZoomPan, storeViewportZoomPan } from './custom-viewport/setViewportZoomPan';
+import sameAs from './custom-attribute/sameAs';
+import numberOfDisplaySets from './custom-attribute/numberOfDisplaySets';
+import maxNumImageFrames from './custom-attribute/maxNumImageFrames';
+
+/**
+ * The test extension provides additional behaviour for testing various
+ * customizations and settings for OHIF.
+ */
+const testExtension: Types.Extensions.Extension = {
+  /**
+   * Only required property. Should be a unique value across all extensions.
+   */
+  id,
+
+  /** Register additional behaviour:
+   *   * HP custom attribute seriesDescriptions to retrieve an array of all series descriptions
+   *   * HP custom attribute numberOfDisplaySets to retrieve the number of display sets
+   *   * HP custom attribute numberOfDisplaySetsWithImages to retrieve the number of display sets containing images
+   *   * HP custom attribute to return a boolean true, when the attribute sameAttribute has the same
+   *     value as another series description in an already matched display set selector named with the value
+   *     in `sameDisplaySetId`
+   */
+  preRegistration: ({ servicesManager }: Types.Extensions.ExtensionParams) => {
+    const { hangingProtocolService } = servicesManager.services;
+    hangingProtocolService.addCustomAttribute(
+      'numberOfDisplaySets',
+      'Number of displays sets',
+      numberOfDisplaySets
+    );
+    hangingProtocolService.addCustomAttribute(
+      'maxNumImageFrames',
+      'Maximum of number of image frames',
+      maxNumImageFrames
+    );
+    hangingProtocolService.addCustomAttribute(
+      'sameAs',
+      'Match an attribute in an existing display set',
+      sameAs
+    );
+  },
+
+  /** Registers some customizations */
+  getCustomizationModule,
+
+  getHangingProtocolModule: () => {
+    return [
+      // Create a MxN hanging protocol available by default
+      {
+        name: hpTestSwitch.id,
+        protocol: hpTestSwitch,
+      },
+    ];
+  },
+};
+
+export default testExtension;