Chore/kill yalc with fire (#629)

* init * more shifting * Move @babel dependencies up to workspace root * Begin updating dependent libraries to use sync'd webpack builds w/ watches * Commit changes before a long weekend * Split packages into platform and extensions * Consolidate how/where we specify file/module type entrypoints * Make it possible to pass in extensions as App props * Resolve viewer's modules * Target for UMD bundle * Add Webpack Stylus loader * Provide WebPack build options for microscopy, vtk, and ui * Better entrypoint for extensions * Push changes up to switch PCs * Fix ESM symlink build for Viewers * Shift docs to root * Specify additional lerna config props * Begin providing basic readme info * Rename example extension folder * Shift links to bottom of doc * First attempt at a netlify deploy preview * Attempt to fix deploy preview build * push workspace enabled to initial command; remove second yarn install; use npx to call gitbook cli commands * Try to use global gitbook-cli * Export node_modules path * More agressive with modifying PATH * Follow deploy log output advice * try again to set bin path * Try swapping bash with a new shell * Try bash -l instead of exec bash * Annd let's try again * and again * We may have figured it out johnny, boy * We need to pull cornerstone-wado-image-loader files from hoisted node_modules * Attempt to fix ticks/escapes * Change copy syntax; try running tests on viewers from root for circleci * Lower version to match circleci image * Try alternative jest-canvas-mock location and version file syntax * Run version command instead of calling node directly * Try alternative jest transform * Set path and enable workspaces * Add codecov flags * Use cpx so our copying finishes? * Get all platform unit tests to run * Run and report individually and in parallel * Try once relying on codecov yaml to split w/ flags * Add projects to split by flags * Generate separate reports * Trigger codecov after everything has finished running; these may not support flags * Use recommended flags from issue comments for codecov * Fix typo * Remove clear flag * Shift back to calling codecov from root * Generate example for codecov issue * Try fixing paths * Simplify * Try using codecov orb * Bump circleci version * Upload core and viewer * Use full string paths * Remove individual codecov calls * Fix dir * Combine files before upload * Escape anchors * tryfix syntax * Escape string literal * Combine lines to reduce path * long paths * Use home alias * Fix filename * Try to see the contents of our cat'd file * Also upload `core` * Try running with aliased folder * Fix path; split PR and Merge unit tests into separate jobs * Set default threshold * Fix typo * Changing to scoped package names * Adding note * Catch more updates * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.0 - @ohif/extension-dicom-html@0.0.4-alpha.0 - @ohif/extension-dicom-microscopy@0.0.9-alpha.0 - @ohif/extension-dicom-pdf@0.0.8-alpha.0 - @ohif/extension-vtk@0.1.4-alpha.0 - @ohif/core@0.11.1-alpha.0 - @ohif/i18n@0.2.3-alpha.0 - @ohif/ui@0.2.18-alpha.0 - @ohif/viewer@0.0.22-alpha.0 * Clean up primary readme * Support for dev and dev:* commands * Shift build command; satisfy default PWA build * Remove old scripts * Clean up UI to set webpack scripts * Tidy up project links * Clean duplicate code in UI project * Update UI project's docs * Clean up ui and i18n config * Reduce duplicate code in `@ohif/core` * Fix @ohif/ui versions * bump @ohif/core versions * Redux testkit dep * Remove unused/duplicate config files for projects/packages * ohif-core --> @ohif/core * Safer publish command * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.1 - @ohif/extension-dicom-html@0.0.4-alpha.1 - @ohif/extension-dicom-microscopy@0.0.9-alpha.1 - @ohif/extension-dicom-pdf@0.0.8-alpha.1 - @ohif/extension-vtk@0.1.4-alpha.1 - @ohif/core@0.11.1-alpha.1 - @ohif/i18n@0.2.3-alpha.1 - @ohif/ui@0.2.18-alpha.1 - @ohif/viewer@0.0.22-alpha.1 * test version bump * Add global prettier config * chore(release): publish %s [skip ci] - @ohif/viewer@0.0.22-alpha.2 * test lerna publish * Update package.jsons * Fix build scripts * catch changes * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.2 - @ohif/extension-dicom-html@0.0.4-alpha.2 - @ohif/extension-dicom-microscopy@0.0.9-alpha.2 - @ohif/extension-dicom-pdf@0.0.8-alpha.2 - @ohif/extension-vtk@0.1.4-alpha.2 - @ohif/core@0.11.1-alpha.2 - @ohif/i18n@0.2.3-alpha.2 - @ohif/ui@0.2.18-alpha.2 - @ohif/viewer@0.0.22-alpha.3 * fix eslint issues caused by eslint 6 and our react-app config * Publish with canary tag * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.3 - @ohif/extension-dicom-html@0.0.4-alpha.3 - @ohif/extension-dicom-microscopy@0.0.9-alpha.3 - @ohif/extension-dicom-pdf@0.0.8-alpha.3 - @ohif/extension-vtk@0.1.4-alpha.3 - @ohif/core@0.11.1-alpha.3 - @ohif/i18n@0.2.3-alpha.3 - @ohif/ui@0.2.18-alpha.3 - @ohif/viewer@0.0.22-alpha.4 * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.4 - @ohif/extension-dicom-html@0.0.4-alpha.4 - @ohif/extension-dicom-microscopy@0.0.9-alpha.4 - @ohif/extension-dicom-pdf@0.0.8-alpha.4 - @ohif/extension-vtk@0.1.4-alpha.4 - @ohif/core@0.11.1-alpha.4 - @ohif/i18n@0.2.3-alpha.4 - @ohif/ui@0.2.18-alpha.4 - @ohif/viewer@0.0.22-alpha.5 * Simplify build * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.5 - @ohif/extension-dicom-html@0.0.4-alpha.5 - @ohif/extension-dicom-microscopy@0.0.9-alpha.5 - @ohif/extension-dicom-pdf@0.0.8-alpha.5 - @ohif/extension-vtk@0.1.4-alpha.5 - @ohif/core@0.11.1-alpha.5 - @ohif/i18n@0.2.3-alpha.5 - @ohif/ui@0.2.18-alpha.5 - @ohif/viewer@0.0.22-alpha.6 * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.6 - @ohif/extension-dicom-html@0.0.4-alpha.6 - @ohif/extension-dicom-microscopy@0.0.9-alpha.6 - @ohif/extension-dicom-pdf@0.0.8-alpha.6 - @ohif/extension-vtk@0.1.4-alpha.6 - @ohif/core@0.11.1-alpha.6 - @ohif/i18n@0.2.3-alpha.6 - @ohif/ui@0.2.18-alpha.6 - @ohif/viewer@0.0.22-alpha.7 * Split version and publish * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.7 - @ohif/extension-dicom-html@0.0.4-alpha.7 - @ohif/extension-dicom-microscopy@0.0.9-alpha.7 - @ohif/extension-dicom-pdf@0.0.8-alpha.7 - @ohif/extension-vtk@0.1.4-alpha.7 - @ohif/core@0.11.1-alpha.7 - @ohif/i18n@0.2.3-alpha.7 - @ohif/ui@0.2.18-alpha.7 - @ohif/viewer@0.0.22-alpha.8 * Try simplify netlify build * react-viewerbase --> @ohif/ui * add test for stylus loader * Try new way to specify publish path * Use an output folder that won't be ignored * Try move command * fiddle with paths * Dig for some information * Make sure we're in root for our commands * Remove discovery * Setup script-tag example * Fix typo * Move config folder * Update cornerstone extension to use shared/root webpack configs * capture changes * Update extension webpack configs * Don't check in docz output * Fix babel runtime resolution issue * Simplify ui build steps * Push in progress * Shift directories * Get viewer dev path to work * Fix viewer commonjs build * Fix build pwa config for viewers * Make sure our package specific command can be called from root * Update notes * Fix imports and misc. merge notes * Bump wado-image-loader version * Switch up commands to remove webworkers copy * Fix CI config * Fix more broken package references * Add react-dropzone * Persist so e2e test can use * Fix lockfile * Use cypress orb to simplify CI * Fix config * Try again * Install yarn latest for orb * Install yarn a different way * Wait on correct port * Run tests in viewer project * Fix cypress config * Make Cypress happier - use default location * Simplify e2e testing * Capture UI changes since fork * Catch core up * Grab latest deps after merge * Fix broken import * Make sure cornerstone-wado-image-loader resolves to 3+ * Note regarding orbs * Fix refresh on 404 routes * Fix odd error for cornerstone-wado-image-loader * Different target for UMD * Simplify dev script * Try to get fancy with netlify output * Let's do it again * Try to fix measurementTools issue * See if we can get our lerna magic to work on merge to monorepo branch
2019-08-13 15:36:46 -04:00
1 parent cac911f08e
commit 08ff214ea6
@@ -0,0 +1,244 @@
+import { ProtocolMatchingRule } from './rules';
+import { removeFromArray } from '../lib/removeFromArray';
+import Stage from './Stage';
+import guid from '../../utils/guid';
+import user from '../../user';
+
+/**
+ * This class represents a Hanging Protocol at the highest level
+ *
+ * @type {Protocol}
+ */
+export default class Protocol {
+  /**
+   * The Constructor for the Class to create a Protocol with the bare
+   * minimum information
+   *
+   * @param name The desired name for the Protocol
+   */
+  constructor(name) {
+    // Create a new UUID for this Protocol
+    this.id = guid();
+
+    // Store a value which determines whether or not a Protocol is locked
+    // This is probably temporary, since we will eventually have role / user
+    // checks for editing. For now we just need it to prevent changes to the
+    // default protocols.
+    this.locked = false;
+
+    // Boolean value to indicate if the protocol has updated priors information
+    // it's set in "updateNumberOfPriorsReferenced" function
+    this.hasUpdatedPriorsInformation = false;
+
+    // Apply the desired name
+    this.name = name;
+
+    // Set the created and modified dates to Now
+    this.createdDate = new Date();
+    this.modifiedDate = new Date();
+
+    // If we are logged in while creating this Protocol,
+    // store this information as well
+    if (user.userLoggedIn && user.userLoggedIn()) {
+      this.createdBy = user.getUserId();
+      this.modifiedBy = user.getUserId();
+    }
+
+    // Create two empty Sets specifying which roles
+    // have read and write access to this Protocol
+    this.availableTo = new Set();
+    this.editableBy = new Set();
+
+    // Define empty arrays for the Protocol matching rules
+    // and Stages
+    this.protocolMatchingRules = [];
+    this.stages = [];
+
+    // Define auxiliary values for priors
+    this.numberOfPriorsReferenced = -1;
+  }
+
+  getNumberOfPriorsReferenced(skipCache = false) {
+    let numberOfPriorsReferenced =
+      skipCache !== true ? this.numberOfPriorsReferenced : -1;
+
+    // Check if information is cached already
+    if (numberOfPriorsReferenced > -1) {
+      return numberOfPriorsReferenced;
+    }
+
+    numberOfPriorsReferenced = 0;
+
+    // Search each study matching rule for prior rules
+    // Each stage can have many viewports that can have
+    // multiple study matching rules.
+    this.stages.forEach(stage => {
+      if (!stage.viewports) {
+        return;
+      }
+
+      stage.viewports.forEach(viewport => {
+        if (!viewport.studyMatchingRules) {
+          return;
+        }
+
+        viewport.studyMatchingRules.forEach(rule => {
+          // If the current rule is not a priors rule, it will return -1 then numberOfPriorsReferenced will continue to be 0
+          const priorsReferenced = rule.getNumberOfPriorsReferenced();
+          if (priorsReferenced > numberOfPriorsReferenced) {
+            numberOfPriorsReferenced = priorsReferenced;
+          }
+        });
+      });
+    });
+
+    this.numberOfPriorsReferenced = numberOfPriorsReferenced;
+
+    return numberOfPriorsReferenced;
+  }
+
+  updateNumberOfPriorsReferenced() {
+    this.getNumberOfPriorsReferenced(true);
+  }
+
+  /**
+   * Method to update the modifiedDate when the Protocol
+   * has been changed
+   */
+  protocolWasModified() {
+    // If we are logged in while modifying this Protocol,
+    // store this information as well
+    if (user.userLoggedIn && user.userLoggedIn()) {
+      this.modifiedBy = user.getUserId();
+    }
+
+    // Protocol has been modified, so mark priors information
+    // as "outdated"
+    this.hasUpdatedPriorsInformation = false;
+
+    // Update number of priors referenced info
+    this.updateNumberOfPriorsReferenced();
+
+    // Update the modifiedDate with the current Date/Time
+    this.modifiedDate = new Date();
+  }
+
+  /**
+   * Occasionally the Protocol class needs to be instantiated from a JavaScript Object
+   * containing the Protocol data. This function fills in a Protocol with the Object
+   * data.
+   *
+   * @param input A Protocol as a JavaScript Object, e.g. retrieved from JSON
+   */
+  fromObject(input) {
+    // Check if the input already has an ID
+    // If so, keep it. It not, create a new UUID
+    this.id = input.id || guid();
+
+    // Assign the input name to the Protocol
+    this.name = input.name;
+
+    // Retrieve locked status, use !! to make it truthy
+    // so that undefined values will be set to false
+    this.locked = !!input.locked;
+
+    // TODO: Check how to regenerate Set from Object
+    //this.availableTo = new Set(input.availableTo);
+    //this.editableBy = new Set(input.editableBy);
+
+    // If the input contains Protocol matching rules
+    if (input.protocolMatchingRules) {
+      input.protocolMatchingRules.forEach(ruleObject => {
+        // Create new Rules from the stored data
+        var rule = new ProtocolMatchingRule();
+        rule.fromObject(ruleObject);
+
+        // Add them to the Protocol
+        this.protocolMatchingRules.push(rule);
+      });
+    }
+
+    // If the input contains data for various Stages in the
+    // display set sequence
+    if (input.stages) {
+      input.stages.forEach(stageObject => {
+        // Create Stages from the stored data
+        var stage = new Stage();
+        stage.fromObject(stageObject);
+
+        // Add them to the Protocol
+        this.stages.push(stage);
+      });
+    }
+  }
+
+  /**
+   * Creates a clone of the current Protocol with a new name
+   *
+   * @param name
+   * @returns {Protocol|*}
+   */
+  createClone(name) {
+    // Create a new JavaScript independent of the current Protocol
+    var currentProtocol = Object.assign({}, this);
+
+    // Create a new Protocol to return
+    var clonedProtocol = new Protocol();
+
+    // Apply the desired properties
+    currentProtocol.id = clonedProtocol.id;
+    clonedProtocol.fromObject(currentProtocol);
+
+    // If we have specified a name, assign it
+    if (name) {
+      clonedProtocol.name = name;
+    }
+
+    // Unlock the clone
+    clonedProtocol.locked = false;
+
+    // Return the cloned Protocol
+    return clonedProtocol;
+  }
+
+  /**
+   * Adds a Stage to this Protocol's display set sequence
+   *
+   * @param stage
+   */
+  addStage(stage) {
+    this.stages.push(stage);
+
+    // Update the modifiedDate and User that last
+    // modified this Protocol
+    this.protocolWasModified();
+  }
+
+  /**
+   * Adds a Rule to this Protocol's array of matching rules
+   *
+   * @param rule
+   */
+  addProtocolMatchingRule(rule) {
+    this.protocolMatchingRules.push(rule);
+
+    // Update the modifiedDate and User that last
+    // modified this Protocol
+    this.protocolWasModified();
+  }
+
+  /**
+   * Removes a Rule from this Protocol's array of matching rules
+   *
+   * @param rule
+   */
+  removeProtocolMatchingRule(rule) {
+    var wasRemoved = removeFromArray(this.protocolMatchingRules, rule);
+
+    // Update the modifiedDate and User that last
+    // modified this Protocol
+    if (wasRemoved) {
+      this.protocolWasModified();
+    }
+  }
+}
@@ -0,0 +1,174 @@
+import { comparators } from '../lib/comparators';
+import guid from '../../utils/guid';
+
+const EQUALS_REGEXP = /^equals$/;
+
+/**
+ * This Class represents a Rule to be evaluated given a set of attributes
+ * Rules have:
+ * - An attribute (e.g. 'seriesDescription')
+ * - A constraint Object, in the form required by Validate.js:
+ *
+ * rule.constraint = {
+ *   contains: {
+ *      value: 'T-1'
+ *      }
+ *   };
+ *
+ *  Note: In this example we use the 'contains' Validator, which is a custom Validator defined in Viewerbase
+ *
+ * - A value for whether or not they are Required to be matched (default: False)
+ * - A value for their relative weighting during Protocol or Image matching (default: 1)
+ */
+export default class Rule {
+  /**
+   * The Constructor for the Class to create a Rule with the bare
+   * minimum information
+   *
+   * @param name The desired name for the Rule
+   */
+  constructor(attribute, constraint, required, weight) {
+    // Create a new UUID for this Rule
+    this.id = guid();
+
+    // Set the Rule's weight (defaults to 1)
+    this.weight = weight || 1;
+
+    // If an attribute is specified, assign it
+    if (attribute) {
+      this.attribute = attribute;
+    }
+
+    // If a constraint is specified, assign it
+    if (constraint) {
+      this.constraint = constraint;
+    }
+
+    // If a value for 'required' is specified, assign it
+    if (required === undefined) {
+      // If no value was specified, default to False
+      this.required = false;
+    } else {
+      this.required = required;
+    }
+
+    // Cache for constraint info object
+    this._constraintInfo = void 0;
+
+    // Cache for validator and value object
+    this._validatorAndValue = void 0;
+  }
+
+  /**
+   * Occasionally the Rule class needs to be instantiated from a JavaScript Object.
+   * This function fills in a Protocol with the Object data.
+   *
+   * @param input A Rule as a JavaScript Object, e.g. retrieved from JSON
+   */
+  fromObject(input) {
+    // Check if the input already has an ID
+    // If so, keep it. It not, create a new UUID
+    this.id = input.id || guid();
+
+    // Assign the specified input data to the Rule
+    this.required = input.required;
+    this.weight = input.weight;
+    this.attribute = input.attribute;
+    this.constraint = input.constraint;
+  }
+
+  /**
+   * Get the constraint info object for the current constraint
+   * @return {Object\undefined} Constraint object or undefined if current constraint
+   *                            is not valid or not found in comparators list
+   */
+  getConstraintInfo() {
+    let constraintInfo = this._constraintInfo;
+    // Check if info is cached already
+    if (constraintInfo !== void 0) {
+      return constraintInfo;
+    }
+
+    const ruleConstraint = Object.keys(this.constraint)[0];
+
+    if (ruleConstraint !== void 0) {
+      constraintInfo = comparators.find(
+        comparator => ruleConstraint === comparator.id
+      );
+    }
+
+    // Cache this information for later use
+    this._constraintInfo = constraintInfo;
+
+    return constraintInfo;
+  }
+
+  /**
+   * Check if current rule is related to priors
+   * @return {Boolean} True if a rule is related to priors or false otherwise
+   */
+  isRuleForPrior() {
+    // @TODO: Should we check this too? this.attribute === 'relativeTime'
+    return this.attribute === 'abstractPriorValue';
+  }
+
+  /**
+   * If the current rule is a rule for priors, returns the number of referenced priors. Otherwise, returns -1.
+   * @return {Number} The number of referenced priors or -1 if not applicable. Returns zero if the actual value could not be determined.
+   */
+  getNumberOfPriorsReferenced() {
+    if (!this.isRuleForPrior()) {
+      return -1;
+    }
+
+    // Get rule's validator and value
+    const ruleValidatorAndValue = this.getConstraintValidatorAndValue();
+    const { value, validator } = ruleValidatorAndValue;
+    const intValue = parseInt(value, 10) || 0; // avoid possible NaN
+
+    // "Equal to" validators
+    if (EQUALS_REGEXP.test(validator)) {
+      // In this case, -1 (the oldest prior) indicates that at least one study is used
+      return intValue < 0 ? 1 : intValue;
+    }
+
+    // Default cases return value
+    return 0;
+  }
+
+  /**
+   * Get the constraint validator and value
+   * @return {Object|undefined} Returns an object containing the validator and it's value or undefined
+   */
+  getConstraintValidatorAndValue() {
+    let validatorAndValue = this._validatorAndValue;
+
+    // Check if validator and value are cached already
+    if (validatorAndValue !== void 0) {
+      return validatorAndValue;
+    }
+
+    // Get the constraint info object
+    const constraintInfo = this.getConstraintInfo();
+
+    // Constraint info object exists and is valid
+    if (constraintInfo !== void 0) {
+      const validator = constraintInfo.validator;
+      const currentValidator = this.constraint[validator];
+
+      if (currentValidator) {
+        const constraintValidator = constraintInfo.validatorOption;
+        const constraintValue = currentValidator[constraintValidator];
+
+        validatorAndValue = {
+          value: constraintValue,
+          validator: constraintInfo.id,
+        };
+
+        this._validatorAndValue = validatorAndValue;
+      }
+    }
+
+    return validatorAndValue;
+  }
+}
@@ -0,0 +1,85 @@
+import ViewportStructure from './ViewportStructure';
+import Viewport from './Viewport';
+import guid from '../../utils/guid';
+
+/**
+ * A Stage is one step in the Display Set Sequence for a Hanging Protocol
+ *
+ * Stages are defined as a ViewportStructure and an array of Viewports
+ *
+ * @type {Stage}
+ */
+export default class Stage {
+  constructor(ViewportStructure, name) {
+    // Create a new UUID for this Stage
+    this.id = guid();
+
+    // Assign the name and ViewportStructure provided
+    this.name = name;
+    this.viewportStructure = ViewportStructure;
+
+    // Create an empty array for the Viewports
+    this.viewports = [];
+
+    // Set the created date to Now
+    this.createdDate = new Date();
+  }
+
+  /**
+   * Creates a clone of the current Stage with a new name
+   *
+   * @param name
+   * @returns {Stage|*}
+   */
+  createClone(name) {
+    // Create a new JavaScript independent of the current Protocol
+    var currentStage = Object.assign({}, this);
+
+    // Create a new Stage to return
+    var clonedStage = new Stage();
+
+    // Assign the desired properties
+    currentStage.id = clonedStage.id;
+    clonedStage.fromObject(currentStage);
+
+    // If we have specified a name, assign it
+    if (name) {
+      clonedStage.name = name;
+    }
+
+    // Return the cloned Stage
+    return clonedStage;
+  }
+
+  /**
+   * Occasionally the Stage class needs to be instantiated from a JavaScript Object.
+   * This function fills in a Protocol with the Object data.
+   *
+   * @param input A Stage as a JavaScript Object, e.g. retrieved from JSON
+   */
+  fromObject(input) {
+    // Check if the input already has an ID
+    // If so, keep it. It not, create a new UUID
+    this.id = input.id || guid();
+
+    // Assign the input name to the Stage
+    this.name = input.name;
+
+    // If a ViewportStructure is present in the input, add it from the
+    // input data
+    this.viewportStructure = new ViewportStructure();
+    this.viewportStructure.fromObject(input.viewportStructure);
+
+    // If any viewports are present in the input object
+    if (input.viewports) {
+      input.viewports.forEach(viewportObject => {
+        // Create a new Viewport with their data
+        var viewport = new Viewport();
+        viewport.fromObject(viewportObject);
+
+        // Add it to the viewports array
+        this.viewports.push(viewport);
+      });
+    }
+  }
+}
@@ -0,0 +1,85 @@
+import {
+  StudyMatchingRule,
+  SeriesMatchingRule,
+  ImageMatchingRule,
+} from './rules';
+import { removeFromArray } from '../lib/removeFromArray';
+
+/**
+ * This Class defines a Viewport in the Hanging Protocol Stage. A Viewport contains
+ * arrays of Rules that are matched in the ProtocolEngine in order to determine which
+ * images should be hung.
+ *
+ * @type {Viewport}
+ */
+export default class Viewport {
+  constructor() {
+    this.viewportSettings = {};
+    this.imageMatchingRules = [];
+    this.seriesMatchingRules = [];
+    this.studyMatchingRules = [];
+  }
+
+  /**
+   * Occasionally the Viewport class needs to be instantiated from a JavaScript Object.
+   * This function fills in a Viewport with the Object data.
+   *
+   * @param input The Viewport as a JavaScript Object, e.g. retrieved from JSON
+   */
+  fromObject(input) {
+    // If ImageMatchingRules exist, create them from the Object data
+    // and add them to the Viewport's imageMatchingRules array
+    if (input.imageMatchingRules) {
+      input.imageMatchingRules.forEach(ruleObject => {
+        var rule = new ImageMatchingRule();
+        rule.fromObject(ruleObject);
+        this.imageMatchingRules.push(rule);
+      });
+    }
+
+    // If SeriesMatchingRules exist, create them from the Object data
+    // and add them to the Viewport's seriesMatchingRules array
+    if (input.seriesMatchingRules) {
+      input.seriesMatchingRules.forEach(ruleObject => {
+        var rule = new SeriesMatchingRule();
+        rule.fromObject(ruleObject);
+        this.seriesMatchingRules.push(rule);
+      });
+    }
+
+    // If StudyMatchingRules exist, create them from the Object data
+    // and add them to the Viewport's studyMatchingRules array
+    if (input.studyMatchingRules) {
+      input.studyMatchingRules.forEach(ruleObject => {
+        var rule = new StudyMatchingRule();
+        rule.fromObject(ruleObject);
+        this.studyMatchingRules.push(rule);
+      });
+    }
+
+    // If ViewportSettings exist, add them to the current protocol
+    if (input.viewportSettings) {
+      this.viewportSettings = input.viewportSettings;
+    }
+  }
+
+  /**
+   * Finds and removes a rule from whichever array it exists in.
+   * It is not required to specify if it exists in studyMatchingRules,
+   * seriesMatchingRules, or imageMatchingRules
+   *
+   * @param rule
+   */
+  removeRule(rule) {
+    var array;
+    if (rule instanceof StudyMatchingRule) {
+      array = this.studyMatchingRules;
+    } else if (rule instanceof SeriesMatchingRule) {
+      array = this.seriesMatchingRules;
+    } else if (rule instanceof ImageMatchingRule) {
+      array = this.imageMatchingRules;
+    }
+
+    removeFromArray(array, rule);
+  }
+}
@@ -0,0 +1,53 @@
+/**
+ * The ViewportStructure class represents the layout and layout properties that
+ * Viewports are displayed in. ViewportStructure has a type, which corresponds to
+ * a layout template, and a set of properties, which depend on the type.
+ *
+ * @type {ViewportStructure}
+ */
+export default class ViewportStructure {
+  constructor(type, properties) {
+    this.type = type;
+    this.properties = properties;
+  }
+
+  /**
+   * Occasionally the ViewportStructure class needs to be instantiated from a JavaScript Object.
+   * This function fills in a ViewportStructure with the Object data.
+   *
+   * @param input The ViewportStructure as a JavaScript Object, e.g. retrieved from JSON
+   */
+  fromObject(input) {
+    this.type = input.type;
+    this.properties = input.properties;
+  }
+
+  /**
+   * Retrieve the layout template name based on the layout type
+   *
+   * @returns {string}
+   */
+  getLayoutTemplateName() {
+    // Viewport structure can be updated later when we build more complex display layouts
+    switch (this.type) {
+      case 'grid':
+        return 'gridLayout';
+    }
+  }
+
+  /**
+   * Retrieve the number of Viewports required for this layout
+   * given the layout type and properties
+   *
+   * @returns {string}
+   */
+  getNumViewports() {
+    // Viewport structure can be updated later when we build more complex display layouts
+    switch (this.type) {
+      case 'grid':
+        // For the typical grid layout, we only need to multiply rows by columns to
+        // obtain the number of viewports
+        return this.properties.rows * this.properties.columns;
+    }
+  }
+}
@@ -0,0 +1,23 @@
+import Protocol from './Protocol.js';
+import Rule from './Rule.js';
+import Stage from './Stage.js';
+import Viewport from './Viewport.js';
+import ViewportStructure from './ViewportStructure.js';
+import {
+  ProtocolMatchingRule,
+  StudyMatchingRule,
+  SeriesMatchingRule,
+  ImageMatchingRule,
+} from './rules.js';
+
+export {
+  Protocol,
+  Rule,
+  Stage,
+  Viewport,
+  ViewportStructure,
+  ProtocolMatchingRule,
+  StudyMatchingRule,
+  SeriesMatchingRule,
+  ImageMatchingRule,
+};
@@ -0,0 +1,40 @@
+import Rule from './Rule';
+
+/**
+ * The ProtocolMatchingRule Class extends the Rule Class.
+ *
+ * At present it does not add any new methods or attributes
+ * @type {ProtocolMatchingRule}
+ */
+class ProtocolMatchingRule extends Rule {}
+
+/**
+ * The StudyMatchingRule Class extends the Rule Class.
+ *
+ * At present it does not add any new methods or attributes
+ * @type {StudyMatchingRule}
+ */
+class StudyMatchingRule extends Rule {}
+
+/**
+ * The SeriesMatchingRule Class extends the Rule Class.
+ *
+ * At present it does not add any new methods or attributes
+ * @type {SeriesMatchingRule}
+ */
+class SeriesMatchingRule extends Rule {}
+
+/**
+ * The ImageMatchingRule class extends the Rule Class.
+ *
+ * At present it does not add any new methods or attributes
+ * @type {ImageMatchingRule}
+ */
+class ImageMatchingRule extends Rule {}
+
+export {
+  ProtocolMatchingRule,
+  StudyMatchingRule,
+  SeriesMatchingRule,
+  ImageMatchingRule,
+};