Merge pull request #1658 from concord-consortium/188618233-adornments…

…-import-types

improve adornment v2 importer typing

v3/src/components/data-display/models/data-configuration-model.ts

@@ -25,7 +25,7 @@ import {getQuantileScale, missingColor, parseColor} from "../../../utilities/col
 import { numericSortComparator } from "../../../utilities/data-utils"
 import {GraphPlace} from "../../axis-graph-shared"
 import {CaseData} from "../d3-types"
-import {AttrRole, TipAttrRoles, graphPlaceToAttrRole} from "../data-display-types"
+import {AttrRole, GraphAttrRole, TipAttrRoles, graphPlaceToAttrRole} from "../data-display-types"
 
 export const AttributeDescription = types
   .model('AttributeDescription', {
@@ -43,6 +43,8 @@ export type RoleAttrIDPair = { role: AttrRole, attributeID: string }
 
 export interface IAttributeDescriptionSnapshot extends SnapshotIn<typeof AttributeDescription> {
 }
+
+export type GraphAttributeDescriptionsMapSnapshot = Partial<Record<GraphAttrRole, IAttributeDescriptionSnapshot>>
 export type AttributeDescriptionsMapSnapshot = Partial<Record<AttrRole, IAttributeDescriptionSnapshot>>
 
 export const kUnknownDataConfigurationType = "unknownDataConfigurationType"

v3/src/components/graph/adornments/adornment-models.ts

@@ -2,7 +2,7 @@
   Adornment models are strictly MST. They keep track of the user modifications of the defaults.
  */
 
-import {Instance, types} from "mobx-state-tree"
+import {Instance, SnapshotIn, types} from "mobx-state-tree"
 import { IAxisModel } from "../../axis/models/axis-model"
 import {safeDomIdentifier, typedId} from "../../../utilities/js-utils"
 import {Point} from "../../data-display/data-display-types"
@@ -27,6 +27,8 @@ export const PointModel = types.model("Point", {
       }
     }
   }))
+export interface IPointModelSnapshot extends SnapshotIn<typeof PointModel> {}
+
 export const kInfinitePoint = {x:NaN, y:NaN}
 
 export interface IUpdateCategoriesOptions {

v3/src/components/graph/adornments/adornment-types.ts

@@ -12,7 +12,8 @@ import { IStandardDeviationAdornmentModel, StandardDeviationAdornmentModel }
   from "./univariate-measures/standard-deviation/standard-deviation-adornment-model"
 import { IStandardErrorAdornmentModel, StandardErrorAdornmentModel }
   from "./univariate-measures/standard-error/standard-error-adornment-model"
-import { NormalCurveAdornmentModel } from "./univariate-measures/normal-curve/normal-curve-adornment-model"
+import { INormalCurveAdornmentModel, NormalCurveAdornmentModel }
+  from "./univariate-measures/normal-curve/normal-curve-adornment-model"
 import { IMeanAbsoluteDeviationAdornmentModel, MeanAbsoluteDeviationAdornmentModel }
   from "./univariate-measures/mean-absolute-deviation/mean-absolute-deviation-adornment-model"
 import { BoxPlotAdornmentModel, IBoxPlotAdornmentModel } from "./univariate-measures/box-plot/box-plot-adornment-model"
@@ -52,8 +53,9 @@ export const AdornmentModelUnion = types.union({ dispatcher: adornmentTypeDispat
   StandardDeviationAdornmentModel, StandardErrorAdornmentModel, UnknownAdornmentModel)
 export type IAdornmentModelUnion = IBoxPlotAdornmentModel | ICountAdornmentModel | ILSRLAdornmentModel |
   IMeanAdornmentModel | IMeanAbsoluteDeviationAdornmentModel | IMedianAdornmentModel | IMovableValueAdornmentModel |
-  IMovableLineAdornmentModel | IMovablePointAdornmentModel | IPlottedFunctionAdornmentModel |
-  IPlottedValueAdornmentModel | IStandardDeviationAdornmentModel | IStandardErrorAdornmentModel | IUnknownAdornmentModel
+  IMovableLineAdornmentModel | IMovablePointAdornmentModel | INormalCurveAdornmentModel |
+  IPlottedFunctionAdornmentModel | IPlottedValueAdornmentModel |
+  IStandardDeviationAdornmentModel | IStandardErrorAdornmentModel | IUnknownAdornmentModel
 
 export const ParentAdornmentTypes = ["Univariate Measure"] as const
 export type ParentAdornmentType = typeof ParentAdornmentTypes[number]

v3/src/components/graph/adornments/adornment-utils.ts

@@ -7,9 +7,9 @@ export function getAxisDomains(xAxis?: IBaseNumericAxisModel, yAxis?: IBaseNumer
   return { xDomain, yDomain }
 }
 
-export const updateCellKey = (cellKey: Record<string, string>, attrId: string, cat: string) => {
+export const updateCellKey = (cellKey: Record<string, string>, attrId: string | undefined, cat: string) => {
   const newCellKey = { ...cellKey }
-  if (cat) {
+  if (attrId && cat) {
     const propertyAlreadyPresent = Object.prototype.hasOwnProperty.call(newCellKey, attrId)
     if (propertyAlreadyPresent && newCellKey[attrId] !== cat) {
       // When the same attribute appears on multiple axes or splits, we avoid overwriting the existing key's

v3/src/components/graph/adornments/count/count-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { AdornmentModel, IAdornmentModel } from "../adornment-models"
 import { kCountType } from "./count-adornment-types"
 import {IGraphDataConfigurationModel} from "../../models/graph-data-configuration-model"
@@ -63,7 +63,7 @@ export const CountAdornmentModel = AdornmentModel
       } else {
         scaleCopy.range([plotHeight, 0])
       }
-  
+
       for (let i = 0; i < subPlotRegionBoundaries.length - 1; i++) {
         const lowerBoundary = subPlotRegionBoundaries[i]
         const upperBoundary = subPlotRegionBoundaries[i + 1]
@@ -79,7 +79,7 @@ export const CountAdornmentModel = AdornmentModel
         prevHeight += height
         counts.push({ bottomOffset, height, leftOffset, count, width })
       }
-  
+
       return counts
     }
   }))
@@ -97,6 +97,7 @@ export const CountAdornmentModel = AdornmentModel
     }
   }))
 
+export interface ICountAdornmentModelSnapshot extends SnapshotIn<typeof CountAdornmentModel> {}
 export interface ICountAdornmentModel extends Instance<typeof CountAdornmentModel> {}
 export function isCountAdornment(adornment: IAdornmentModel): adornment is ICountAdornmentModel {
   return adornment.type === kCountType

v3/src/components/graph/adornments/lsrl/lsrl-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { Point } from "../../../data-display/data-display-types"
 import { dataDisplayGetNumericValue } from "../../../data-display/data-display-value-utils"
 import { AdornmentModel, IAdornmentModel, IUpdateCategoriesOptions, PointModel } from "../adornment-models"
@@ -62,6 +62,7 @@ export const LSRLInstance = types.model("LSRLInstance", {
   }
 }))
 
+
 export const LSRLAdornmentModel = AdornmentModel
 .named("LSRLAdornmentModel")
 .props({
@@ -224,7 +225,9 @@ export const LSRLAdornmentModel = AdornmentModel
   }
 }))
 
+export interface ILSRLInstanceSnapshot extends SnapshotIn<typeof LSRLInstance> {}
 export interface ILSRLInstance extends Instance<typeof LSRLInstance> {}
+export interface ILSRLAdornmentModelSnapshot extends SnapshotIn<typeof LSRLAdornmentModel> {}
 export interface ILSRLAdornmentModel extends Instance<typeof LSRLAdornmentModel> {}
 export function isLSRLAdornment(adornment: IAdornmentModel): adornment is ILSRLAdornmentModel {
   return adornment.type === kLSRLType

v3/src/components/graph/adornments/movable-line/movable-line-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { Point } from "../../../data-display/data-display-types"
 import { AdornmentModel, IAdornmentModel, IUpdateCategoriesOptions, PointModel,
          kInfinitePoint } from "../adornment-models"
@@ -94,7 +94,9 @@ export const MovableLineAdornmentModel = AdornmentModel
   }
 }))
 
+export interface IMovableLineInstanceSnapshot extends SnapshotIn<typeof MovableLineInstance> {}
 export interface IMovableLineInstance extends Instance<typeof MovableLineInstance> {}
+export interface IMovableLineAdornmentModelSnapshot extends SnapshotIn<typeof MovableLineAdornmentModel> {}
 export interface IMovableLineAdornmentModel extends Instance<typeof MovableLineAdornmentModel> {}
 export function isMovableLineAdornment(adornment: IAdornmentModel): adornment is IMovableLineAdornmentModel {
   return adornment.type === kMovableLineType

v3/src/components/graph/adornments/movable-point/movable-point-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { Point } from "../../../data-display/data-display-types"
 import { AdornmentModel, IAdornmentModel, IUpdateCategoriesOptions, PointModel } from "../adornment-models"
 import { IAxisModel, isNumericAxisModel } from "../../../axis/models/axis-model"
@@ -39,6 +39,7 @@ export const MovablePointAdornmentModel = AdornmentModel
       })
     }
   }))
+export interface IMovablePointAdornmentModelSnapshot extends SnapshotIn<typeof MovablePointAdornmentModel> {}
 export interface IMovablePointAdornmentModel extends Instance<typeof MovablePointAdornmentModel> {}
 export function isMovablePointAdornment(adornment: IAdornmentModel): adornment is IMovablePointAdornmentModel {
   return adornment.type === kMovablePointType

v3/src/components/graph/adornments/movable-value/movable-value-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { AdornmentModel, IAdornmentModel, IUpdateCategoriesOptions } from "../adornment-models"
 import { kMovableValueType } from "./movable-value-adornment-types"
 import { IBaseNumericAxisModel } from "../../../axis/models/axis-model"
@@ -140,6 +140,7 @@ export const MovableValueAdornmentModel = AdornmentModel
     }
   }))
 
+export interface IMovableValueAdornmentModelSnapshot extends SnapshotIn<typeof MovableValueAdornmentModel> {}
 export interface IMovableValueAdornmentModel extends Instance<typeof MovableValueAdornmentModel> {}
 export function isMovableValueAdornment(adornment: IAdornmentModel): adornment is IMovableValueAdornmentModel {
   return adornment.type === kMovableValueType

v3/src/components/graph/adornments/plotted-function/plotted-function-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { AdornmentModel, IAdornmentModel } from "../adornment-models"
 import { kPlottedFunctionType, kPlottedFunctionValueTitleKey, FormulaFn } from "./plotted-function-adornment-types"
 import { Formula } from "../../../../models/formula/formula"
@@ -50,6 +50,7 @@ export const PlottedFunctionAdornmentModel = AdornmentModel
     }
   }))
 
+export interface IPlottedFunctionAdornmentModelSnapshot extends SnapshotIn<typeof PlottedFunctionAdornmentModel> {}
 export interface IPlottedFunctionAdornmentModel extends Instance<typeof PlottedFunctionAdornmentModel> {}
 export function isPlottedFunctionAdornment(adornment: IAdornmentModel): adornment is IPlottedFunctionAdornmentModel {
   return adornment.type === kPlottedFunctionType

v3/src/components/graph/adornments/univariate-measures/box-plot/box-plot-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { median } from "mathjs"
 import { quantileOfSortedArray } from "../../../../../utilities/math-utils"
 import { UnivariateMeasureAdornmentModel } from "../univariate-measure-adornment-model"
@@ -114,6 +114,7 @@ export const BoxPlotAdornmentModel = UnivariateMeasureAdornmentModel
     }
   }))
 
+export interface IBoxPlotAdornmentModelSnapshot extends SnapshotIn<typeof BoxPlotAdornmentModel> {}
 export interface IBoxPlotAdornmentModel extends Instance<typeof BoxPlotAdornmentModel> {}
 export function isBoxPlotAdornment(adornment: IAdornmentModel): adornment is IBoxPlotAdornmentModel {
   return adornment.type === kBoxPlotType

v3/src/components/graph/adornments/univariate-measures/mean-absolute-deviation/mean-absolute-deviation-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { mean } from "mathjs"
 import {IGraphDataConfigurationModel} from "../../../models/graph-data-configuration-model"
 import {
@@ -34,6 +34,8 @@ export const MeanAbsoluteDeviationAdornmentModel = UnivariateMeasureAdornmentMod
     }
   }))
 
+export interface IMeanAbsoluteDeviationAdornmentModelSnapshot
+  extends SnapshotIn<typeof MeanAbsoluteDeviationAdornmentModel> {}
 export interface IMeanAbsoluteDeviationAdornmentModel extends Instance<typeof MeanAbsoluteDeviationAdornmentModel> {}
 export function isMeanAbsoluteDeviationAdornment(adornment: IUnivariateMeasureAdornmentModel):
   adornment is IMeanAbsoluteDeviationAdornmentModel {

v3/src/components/graph/adornments/univariate-measures/mean/mean-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { mean } from "mathjs"
 import { UnivariateMeasureAdornmentModel } from "../univariate-measure-adornment-model"
 import { kMeanType, kMeanValueTitleKey } from "./mean-adornment-types"
@@ -19,6 +19,7 @@ export const MeanAdornmentModel = UnivariateMeasureAdornmentModel
     }
   }))
 
+export interface IMeanAdornmentModelSnapshot extends SnapshotIn<typeof MeanAdornmentModel> {}
 export interface IMeanAdornmentModel extends Instance<typeof MeanAdornmentModel> {}
 export function isMeanAdornment(adornment: IAdornmentModel): adornment is IMeanAdornmentModel {
   return adornment.type === kMeanType

v3/src/components/graph/adornments/univariate-measures/median/median-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { median } from "mathjs"
 import {IGraphDataConfigurationModel} from "../../../models/graph-data-configuration-model"
 import { UnivariateMeasureAdornmentModel } from "../univariate-measure-adornment-model"
@@ -19,6 +19,7 @@ export const MedianAdornmentModel = UnivariateMeasureAdornmentModel
     }
   }))
 
+export interface IMedianAdornmentModelSnapshot extends SnapshotIn<typeof MedianAdornmentModel> {}
 export interface IMedianAdornmentModel extends Instance<typeof MedianAdornmentModel> {}
 export function isMedianAdornment(adornment: IAdornmentModel): adornment is IMedianAdornmentModel {
   return adornment.type === kMedianType

v3/src/components/graph/adornments/univariate-measures/normal-curve/normal-curve-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { mean, std } from "mathjs"
 import {IGraphDataConfigurationModel} from "../../../models/graph-data-configuration-model"
 import { UnivariateMeasureAdornmentModel, IUnivariateMeasureAdornmentModel }
@@ -70,6 +70,7 @@ export const NormalCurveAdornmentModel = UnivariateMeasureAdornmentModel
     },
   }))
 
+export interface INormalCurveAdornmentModelSnapshot extends SnapshotIn<typeof NormalCurveAdornmentModel> {}
 export interface INormalCurveAdornmentModel extends Instance<typeof NormalCurveAdornmentModel> {}
 export function isNormalCurveAdornment(adornment: IUnivariateMeasureAdornmentModel):
   adornment is INormalCurveAdornmentModel {

v3/src/components/graph/adornments/univariate-measures/plotted-value/plotted-value-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { IAdornmentModel } from "../../adornment-models"
 import { kPlottedValueType, kPlottedValueValueTitleKey } from "./plotted-value-adornment-types"
 import { UnivariateMeasureAdornmentModel } from "../univariate-measure-adornment-model"
@@ -32,6 +32,7 @@ export const PlottedValueAdornmentModel = UnivariateMeasureAdornmentModel
     }
   }))
 
+export interface IPlottedValueAdornmentModelSnapshot extends SnapshotIn<typeof PlottedValueAdornmentModel> {}
 export interface IPlottedValueAdornmentModel extends Instance<typeof PlottedValueAdornmentModel> {}
 export function isPlottedValueAdornment(adornment: IAdornmentModel): adornment is IPlottedValueAdornmentModel {
   return adornment.type === kPlottedValueType

v3/src/components/graph/adornments/univariate-measures/standard-deviation/standard-deviation-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { mean, std } from "mathjs"
 import {IGraphDataConfigurationModel} from "../../../models/graph-data-configuration-model"
 import {
@@ -36,6 +36,7 @@ export const StandardDeviationAdornmentModel = UnivariateMeasureAdornmentModel
     }
   }))
 
+export interface IStandardDeviationAdornmentModelSnapshot extends SnapshotIn<typeof StandardDeviationAdornmentModel> {}
 export interface IStandardDeviationAdornmentModel extends Instance<typeof StandardDeviationAdornmentModel> {}
 export function isStandardDeviationAdornment(adornment: IUnivariateMeasureAdornmentModel):
   adornment is IStandardDeviationAdornmentModel {

v3/src/components/graph/adornments/univariate-measures/standard-error/standard-error-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { mean, std } from "mathjs"
 import {IGraphDataConfigurationModel} from "../../../models/graph-data-configuration-model"
 import { IAdornmentModel } from "../../adornment-models"
@@ -56,6 +56,7 @@ export const StandardErrorAdornmentModel = UnivariateMeasureAdornmentModel
     }
   }))
 
+export interface IStandardErrorAdornmentModelSnapshot extends SnapshotIn<typeof StandardErrorAdornmentModel> {}
 export interface IStandardErrorAdornmentModel extends Instance<typeof StandardErrorAdornmentModel> {}
 export function isStandardErrorAdornment(adornment: IAdornmentModel | undefined):
   adornment is IStandardErrorAdornmentModel {

v3/src/components/graph/adornments/univariate-measures/univariate-measure-adornment-model.ts

@@ -1,4 +1,4 @@
-import { Instance, types } from "mobx-state-tree"
+import { Instance, SnapshotIn, types } from "mobx-state-tree"
 import { Point } from "../../../data-display/data-display-types"
 import { AdornmentModel, IAdornmentModel, IUpdateCategoriesOptions, PointModel } from "../adornment-models"
 import { IDataConfigurationModel } from "../../../data-display/models/data-configuration-model"
@@ -126,6 +126,7 @@ export const UnivariateMeasureAdornmentModel = AdornmentModel
     }
   }))
 
+export interface IMeasureInstanceSnapshot extends SnapshotIn<typeof MeasureInstance> {}
 export interface IMeasureInstance extends Instance<typeof MeasureInstance> {}
 export interface IUnivariateMeasureAdornmentModel extends Instance<typeof UnivariateMeasureAdornmentModel> {}
 export function isUnivariateMeasureAdornment(adornment: IAdornmentModel):