Moved the Cornerstone viewport code to an extension. Tons of changes to rollup and package.json files to make everything play nicely

2019-02-06 14:46:06 +01:00
1 parent 9a0f417eec
commit 22202141b8
@@ -0,0 +1,14 @@
+{
+  "presets": [
+    ["@babel/preset-env", {
+      "targets": {
+        "ie": "11"
+      }
+    }],
+    "@babel/preset-react"
+  ],
+  "plugins": [
+    "@babel/plugin-proposal-class-properties",
+    "@babel/plugin-transform-runtime"
+  ]
+}
@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
@@ -0,0 +1,16 @@
+{
+  "extends": [
+  	"react-app",
+  	"eslint:recommended",
+    "plugin:react/recommended"
+  ],
+  "parser": "babel-eslint",
+  "env": {
+    "jest": true
+  },
+  "settings": {
+    "react": {
+      "version": "detect",
+    },
+  },
+}
@@ -0,0 +1,23 @@
+
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+node_modules
+
+# builds
+build
+dist
+.rpt2_cache
+
+# misc
+.DS_Store
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.idea
@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}
@@ -0,0 +1,4 @@
+language: node_js
+node_js:
+  - 9
+  - 8
@@ -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.
@@ -0,0 +1,88 @@
+{
+  "name": "ohif-dicom-pdf-extension",
+  "version": "0.0.5",
+  "description": "OHIF extension for Dicom PDF",
+  "author": "OHIF",
+  "license": "MIT",
+  "repository": "OHIF/Viewers",
+  "main": "dist/index.umd.js",
+  "module": "dist/index.es.js",
+  "jsnext:main": "dist/index.es.js",
+  "engines": {
+    "node": ">=8",
+    "npm": ">=5"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "prepublishOnly": "npm build",
+    "start": "rollup -c -w",
+    "lint": "eslint -c .eslintrc --fix src && prettier --single-quote --write src/**/*.{js,jsx,json,css}"
+  },
+  "peerDependencies": {
+    "dicom-parser": "^1.8.3",
+    "ohif-core": "^0.2.6",
+    "prop-types": "^15.6.2",
+    "react": "^15.0.0 || ^16.0.0",
+    "react-dom": "^15.0.0 || ^16.0.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.2.2",
+    "@babel/plugin-external-helpers": "^7.2.0",
+    "@babel/plugin-proposal-class-properties": "^7.2.3",
+    "@babel/plugin-transform-runtime": "^7.2.0",
+    "@babel/preset-env": "^7.2.3",
+    "@babel/preset-react": "^7.0.0",
+    "@svgr/rollup": "^4.1.0",
+    "babel-eslint": "^9.0.0",
+    "cross-env": "^5.2.0",
+    "eslint": "5.6.0",
+    "eslint-plugin-import": "^2.14.0",
+    "eslint-plugin-node": "^8.0.0",
+    "eslint-plugin-promise": "^4.0.1",
+    "eslint-plugin-react": "^7.11.1",
+    "gh-pages": "^2.0.1",
+    "husky": "^1.3.1",
+    "lint-staged": "^8.1.0",
+    "lodash.clonedeep": "^4.5.0",
+    "prettier": "^1.15.3",
+    "react": "^16.6.3",
+    "react-dom": "^16.6.3",
+    "react-scripts": "^2.1.2",
+    "rollup": "^0.68.2",
+    "rollup-plugin-babel": "^4.2.0",
+    "rollup-plugin-commonjs": "^9.2.0",
+    "rollup-plugin-node-builtins": "^2.1.2",
+    "rollup-plugin-node-resolve": "^4.0.0",
+    "rollup-plugin-peer-deps-external": "^2.2.0",
+    "rollup-plugin-postcss": "^1.6.3",
+    "rollup-plugin-url": "^2.1.0",
+    "stylelint": "^9.9.0",
+    "stylelint-config-recommended": "^2.1.0",
+    "stylus": "^0.54.5"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "src/**/*.{js,jsx,json,css}": [
+      "prettier --single-quote --write",
+      "git add"
+    ]
+  },
+  "browserslist": [
+    ">0.2%",
+    "not dead",
+    "not ie <= 11",
+    "not op_mini all"
+  ],
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@babel/runtime": "^7.2.0",
+    "classnames": "^2.2.6",
+    "lodash.isequal": "^4.5.0"
+  }
+}
@@ -0,0 +1,55 @@
+import babel from 'rollup-plugin-babel'
+import commonjs from 'rollup-plugin-commonjs'
+import external from 'rollup-plugin-peer-deps-external'
+import postcss from 'rollup-plugin-postcss'
+import resolve from 'rollup-plugin-node-resolve'
+import url from 'rollup-plugin-url'
+import svgr from '@svgr/rollup'
+import pkg from './package.json'
+// Deal with https://github.com/rollup/rollup-plugin-commonjs/issues/297
+import builtins from 'rollup-plugin-node-builtins';
+
+const globals = {
+  'react': 'React',
+  'react-dom': 'ReactDOM',
+  'prop-types': 'PropTypes',
+  'ohif-core': 'OHIF',
+  'dicom-parser': 'dicomParser'
+};
+
+export default {
+  input: 'src/index.js',
+  output: [
+    {
+      file: pkg.main,
+      format: 'umd',
+      name: 'ohif-dicom-pdf-extension',
+      sourcemap: true,
+      globals
+    },
+    {
+      file: pkg.module,
+      format: 'es',
+      sourcemap: true,
+      globals
+    }
+  ],
+  plugins: [
+    builtins(),
+    external(),
+    postcss({
+      modules: false
+    }),
+    url(),
+    svgr(),
+    babel({
+      exclude: 'node_modules/**',
+      plugins: [ '@babel/external-helpers' ],
+      externalHelpers: true,
+      runtimeHelpers: true
+    }),
+    resolve(),
+    commonjs()
+  ],
+  external: Object.keys(pkg.peerDependencies || {}),
+}
@@ -0,0 +1,83 @@
+import React, { Component } from 'react';
+import dicomParser from 'dicom-parser';
+import TypedArrayProp from './TypedArrayProp';
+
+// TODO: Should probably use dcmjs for this
+const SOP_CLASS_UIDS = {
+  ENCAPSULATED_PDF: '1.2.840.10008.5.1.4.1.1.104.1'
+};
+
+class DicomPDFViewport extends Component {
+  state = {
+    fileURL: null,
+    error: null
+  };
+
+  static propTypes = {
+    byteArray: TypedArrayProp.uint8
+  };
+
+  renderPDF = dataSet => {
+    const sopClassUid = dataSet.string('x00080016');
+
+    if (sopClassUid !== SOP_CLASS_UIDS.ENCAPSULATED_PDF) {
+      throw new Error('This is not a DICOM-encapsulated PDF');
+    }
+
+    const fileTag = dataSet.elements.x00420011;
+    const offset = fileTag.dataOffset;
+    const remainder = offset + fileTag.length;
+    const pdfByteArray = dataSet.byteArray.slice(offset, remainder);
+    const PDF = new Blob([pdfByteArray], { type: 'application/pdf' });
+    const fileURL = URL.createObjectURL(PDF);
+
+    this.setState({
+      fileURL
+    });
+  };
+
+  parseByteArray = byteArray => {
+    const options = {
+      untilTag: ''
+    };
+
+    let dataSet;
+
+    try {
+      dataSet = dicomParser.parseDicom(byteArray, options);
+    } catch (error) {
+      this.setState({
+        error
+      });
+    }
+
+    return dataSet;
+  };
+
+  componentDidMount() {
+    const dataSet = this.parseByteArray(this.props.byteArray);
+
+    this.renderPDF(dataSet);
+  }
+
+  render() {
+    return (
+      <div
+        className={'DicomPDFViewport'}
+        style={{ width: '100%', height: '100%' }}
+      >
+        {this.state.fileURL && (
+          <object
+            data={this.state.fileURL}
+            type="application/pdf"
+            width="100%"
+            height="100%"
+          />
+        )}
+        {this.state.error && <h2>{JSON.stringify(this.state.error)}</h2>}
+      </div>
+    );
+  }
+}
+
+export default DicomPDFViewport;
@@ -0,0 +1,15 @@
+import React from 'react';
+import PropTypes from "prop-types";
+
+function OHIFComponentPlugin(props) {
+  return (<React.Fragment>{props.children}</React.Fragment>);
+}
+
+OHIFComponentPlugin.propTypes = {
+  id: PropTypes.string.isRequired,
+  init: PropTypes.func.isRequired,
+  destroy: PropTypes.func.isRequired,
+  children: PropTypes.node
+};
+
+export default OHIFComponentPlugin;
@@ -0,0 +1,27 @@
+import OHIFDicomPDFViewport from './OHIFDicomPDFViewport.js';
+import OHIFDicomPDFSopClassHandler from './OHIFDicomPDFSopClassHandler.js';
+
+export default class OHIFDicomPDFExtension {
+  /**
+   * Extension ID is a unique id, might be used for namespacing extension specific redux actions/reducers (?)
+   */
+  getExtensionId() {
+    return 'pdf';
+  }
+
+  getViewportModule() {
+    return OHIFDicomPDFViewport;
+  }
+
+  getSopClassHandler() {
+    return OHIFDicomPDFSopClassHandler;
+  }
+
+  getPanelModuleDefinition() {
+    return null;
+  }
+
+  getToolbarModuleDefinition() {
+    return null;
+  }
+}
@@ -0,0 +1,34 @@
+import OHIF from "ohif-core";
+
+const { plugins, utils } = OHIF;
+const { PLUGIN_TYPES } = plugins;
+
+// TODO: Should probably use dcmjs for this
+const SOP_CLASS_UIDS = {
+  ENCAPSULATED_PDF: '1.2.840.10008.5.1.4.1.1.104.1'
+};
+
+const OHIFDicomPDFSopClassHandler = {
+  id: 'OHIFDicomPDFSopClassHandlerPlugin',
+  type: PLUGIN_TYPES.SOP_CLASS_HANDLER,
+  sopClassUids: [
+    SOP_CLASS_UIDS.ENCAPSULATED_PDF
+  ],
+  getDisplaySetFromSeries(series, study, dicomWebClient, authorizationHeaders) {
+    debugger;
+    const instance = series.getFirstInstance();
+
+    return {
+      plugin: 'pdf',
+      displaySetInstanceUid: utils.guid(),
+      wadoRoot: study.getData().wadoRoot,
+      wadoUri: instance.getData().wadouri,
+      sopInstanceUid: instance.getSOPInstanceUID(),
+      seriesInstanceUid: series.getSeriesInstanceUID(),
+      studyInstanceUid: study.getStudyInstanceUID(),
+      authorizationHeaders: authorizationHeaders
+    };
+  }
+}
+
+export default OHIFDicomPDFSopClassHandler;
@@ -0,0 +1,76 @@
+import React, { Component } from 'react';
+import PropTypes from 'prop-types';
+import OHIF from 'ohif-core';
+import OHIFComponentPlugin from './OHIFComponentPlugin.js';
+import DicomPDFViewport from './DicomPDFViewport';
+
+const { DICOMWeb } = OHIF;
+
+class OHIFDicomPDFViewport extends Component {
+  static propTypes = {
+    studies: PropTypes.object,
+    displaySet: PropTypes.object,
+    viewportIndex: PropTypes.number
+  };
+
+  state = {
+    byteArray: null,
+    error: null
+  };
+
+  static id = 'DicomPDFViewportPDF';
+
+  static init() {
+    console.log('DicomPDFViewport init()');
+  }
+
+  static destroy() {
+    console.log('DicomPDFViewport destroy()');
+  }
+
+  componentDidMount() {
+    const { displaySet } = this.props.viewportData;
+    const { studyInstanceUid, seriesInstanceUid, sopInstanceUid, wadoRoot, wadoUri, authorizationHeaders} = displaySet;
+
+    this.retrieveDicomData(studyInstanceUid, seriesInstanceUid, sopInstanceUid, wadoRoot, wadoUri, authorizationHeaders).then(byteArray => {
+      this.setState({
+        byteArray
+      });
+    }, error => {
+      this.setState({
+        error
+      });
+
+        throw new Error(error);
+      }
+    );
+  }
+
+  retrieveDicomData(studyInstanceUid, seriesInstanceUid, sopInstanceUid, wadoRoot, wadoUri, authorizationHeaders) {
+    // TODO: Passing in a lot of data we aren't using
+
+    // TODO: Authorization header depends on the server. If we ever have multiple servers
+    // we will need to figure out how / when to pass this information in.
+    return fetch(wadoUri, {
+      headers: authorizationHeaders
+    }).then(response => response.arrayBuffer()).then(arraybuffer => {
+      return new Uint8Array(arraybuffer);
+    });
+  }
+
+  render() {
+    const { id, init, destroy } = OHIFDicomPDFViewport;
+    const pluginProps = { id, init, destroy };
+
+    return (
+      <OHIFComponentPlugin {...pluginProps}>
+        {this.state.byteArray && (
+          <DicomPDFViewport byteArray={this.state.byteArray} />
+        )}
+        {this.state.error && <h2>{JSON.stringify(this.state.error)}</h2>}
+      </OHIFComponentPlugin>
+    );
+  }
+}
+
+export default OHIFDicomPDFViewport;
@@ -0,0 +1,137 @@
+// https://github.com/facebook/prop-types/issues/69
+
+export const TypedArrayProp = {
+  any: (props, propName, componentName) => {
+    let obj = props[propName];
+    if (!(obj instanceof Float64Array ||
+      obj instanceof Float32Array ||
+      obj instanceof Int32Array ||
+      obj instanceof Int16Array ||
+      obj instanceof Int8Array ||
+      obj instanceof Uint32Array ||
+      obj instanceof Uint16Array ||
+      obj instanceof Uint8Array ||
+      obj instanceof Uint8ClampedArray)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected a typed array.'
+      );
+    }
+  },
+
+  float64: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Float64Array)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected a Float64Array.'
+      );
+    }
+  },
+
+  float32: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Float32Array)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected a Float32Array.'
+      );
+    }
+  },
+
+  float: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Float64Array ||
+      props[propName] instanceof Float32Array)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected a Float32Array or Float64Array.'
+      );
+    }
+  },
+
+  int32: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Int32Array)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected an Int32Array.'
+      );
+    }
+  },
+
+  int16: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Int16Array)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected an In16Array.'
+      );
+    }
+  },
+
+  int8: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Int8Array)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected an Int8Array.'
+      );
+    }
+  },
+
+  int: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Int32Array ||
+      props[propName] instanceof Int16Array ||
+      props[propName] instanceof Int8Array)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected an Int32Array, In16Array, or Int8Array.'
+      );
+    }
+  },
+
+  uint32: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Uint32Array)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected a Uint32Array.'
+      );
+    }
+  },
+
+  uint16: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Uint16Array)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected a Uint16Array.'
+      );
+    }
+  },
+
+  uint8: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Uint8Array)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected a Uint8Array.'
+      );
+    }
+  },
+
+  uint8clamped: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Uint8ClampedArray)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected a Uint8ClampedArray.'
+      );
+    }
+  },
+
+  uint: (props, propName, componentName) => {
+    if (!(props[propName] instanceof Uint32Array ||
+      props[propName] instanceof Uint16Array ||
+      props[propName] instanceof Uint8Array ||
+      props[propName] instanceof Uint8ClampedArray)) {
+      return new Error(
+        'Invalid prop `' + propName + '` supplied to' +
+        ' `' + componentName + '`. Expected a Uint32Array, Uint16Array, Uint8Array, or Uint8ClampedArray.'
+      );
+    }
+  },
+};
+
+export { TypedArrayProp as default };
@@ -0,0 +1,3 @@
+import OHIFDicomPDFExtension from './OHIFDicomPDFExtension.js';
+
+export default OHIFDicomPDFExtension;