@sdeverywhere/check-core 0.1.1 → 0.1.2

package/dist/index.d.ts

@@ -1,12 +1,12 @@
-declare type SourceName = string;
-declare type VarId = string;
-declare type DatasetKey = string;
-declare type Dataset = Map<number, number>;
-declare type DatasetMap = Map<DatasetKey, Dataset>;
+type SourceName = string;
+type VarId = string;
+type DatasetKey = string;
+type Dataset = Map<number, number>;
+type DatasetMap = Map<DatasetKey, Dataset>;
 
 /** A unique identifier for the scenario, derived from its input settings. */
-declare type ScenarioSpecUid = string;
-declare type InputPosition = 'at-default' | 'at-minimum' | 'at-maximum';
+type ScenarioSpecUid = string;
+type InputPosition = 'at-default' | 'at-minimum' | 'at-maximum';
 interface PositionSetting {
     kind: 'position';
     inputVarId: VarId;
@@ -17,7 +17,7 @@ interface ValueSetting {
     inputVarId: VarId;
     value: number;
 }
-declare type InputSetting = PositionSetting | ValueSetting;
+type InputSetting = PositionSetting | ValueSetting;
 interface InputSettingsSpec {
     kind: 'input-settings';
     uid: ScenarioSpecUid;
@@ -28,7 +28,7 @@ interface AllInputsSpec {
     uid: ScenarioSpecUid;
     position: InputPosition;
 }
-declare type ScenarioSpec = InputSettingsSpec | AllInputsSpec;
+type ScenarioSpec = InputSettingsSpec | AllInputsSpec;
 
 interface DatasetsResult {
     /**
@@ -56,7 +56,7 @@ interface RelatedItem {
     locationPath: string[];
 }
 /** A unique, stable input identifier. */
-declare type InputId = string;
+type InputId = string;
 /**
  * Holds information about an input variable used in the model.
  */
@@ -145,6 +145,12 @@ interface ImplVar {
     varType: string;
 }
 
+/** The human-readable name for a group of inputs. */
+type InputGroupName = string;
+/** The alias name for an input. */
+type InputAliasName = string;
+/** The human-readable name for a group of dataset. */
+type DatasetGroupName = string;
 /**
  * Includes the properties needed to display a legend item in the UI.
  */
@@ -165,7 +171,8 @@ interface LinkItem {
     /** The link content (a URL or text). */
     content: string;
 }
-declare type BundleGraphId = string;
+/** The identifier for a bundle-specific graph. */
+type BundleGraphId = string;
 /**
  * Describes a dataset in a bundle-specific graph.
  */
@@ -225,11 +232,11 @@ interface ModelSpec {
     /** The map of all variables (both internal and exported) in this version of the model. */
     implVars: Map<DatasetKey, ImplVar>;
     /** The custom input variable aliases defined for this model. */
-    inputAliases?: Map<string, VarId>;
+    inputAliases?: Map<InputAliasName, VarId>;
     /** The custom input variable groups defined for this model. */
-    inputGroups?: Map<string, InputVar[]>;
+    inputGroups?: Map<InputGroupName, InputVar[]>;
     /** The custom dataset (output variable) groups defined for this model. */
-    datasetGroups?: Map<string, DatasetKey[]>;
+    datasetGroups?: Map<DatasetGroupName, DatasetKey[]>;
     /** The start time (year) for the model. */
     startTime?: number;
     /** The end time (year) for the model. */
@@ -289,7 +296,7 @@ interface LoadedBundle {
     model: BundleModel;
 }
 
-declare type CheckDataRequestKey = string;
+type CheckDataRequestKey = string;
 /**
  * Coordinates on-demand loading of data used to display a graph representation
  * of a check/predicate.
@@ -302,17 +309,17 @@ declare class CheckDataCoordinator {
     cancelRequest(key: CheckDataRequestKey): void;
 }
 
-declare type CheckPredicateOp = 'gt' | 'gte' | 'lt' | 'lte' | 'eq' | 'approx';
+type CheckPredicateOp = 'gt' | 'gte' | 'lt' | 'lte' | 'eq' | 'approx';
 
-declare type CheckPredicateTimeSingle = number;
-declare type CheckPredicateTimeRange = [number, number];
+type CheckPredicateTimeSingle = number;
+type CheckPredicateTimeRange = [number, number];
 interface CheckPredicateTimeOptions {
     after_excl?: number;
     after_incl?: number;
     before_excl?: number;
     before_incl?: number;
 }
-declare type CheckPredicateTimeSpec = CheckPredicateTimeSingle | CheckPredicateTimeRange | CheckPredicateTimeOptions;
+type CheckPredicateTimeSpec = CheckPredicateTimeSingle | CheckPredicateTimeRange | CheckPredicateTimeOptions;
 
 interface CheckResultErrorInfo {
     kind: 'unknown-dataset' | 'unknown-input' | 'unknown-input-group' | 'empty-input-group';
@@ -328,7 +335,7 @@ interface CheckResult {
     errorInfo?: CheckResultErrorInfo;
 }
 
-declare type CheckDatasetError = 'no-matches-for-dataset' | 'no-matches-for-group' | 'no-matches-for-type';
+type CheckDatasetError = 'no-matches-for-dataset' | 'no-matches-for-group' | 'no-matches-for-type';
 interface CheckDataset {
     /** The key for the matched dataset; can be undefined if no dataset matched. */
     datasetKey?: DatasetKey;
@@ -367,7 +374,7 @@ interface CheckScenario {
 /**
  * The key type for data references (in the form `<ScenarioUid::DatasetKey>`).
  */
-declare type CheckDataRefKey = string;
+type CheckDataRefKey = string;
 /**
  * The scenario and dataset referenced by a particular predicate (for cases
  * where the check is against another dataset rather than a constant value).
@@ -381,9 +388,9 @@ interface CheckDataRef {
     dataset: CheckDataset;
 }
 
-declare type CheckKey = number;
+type CheckKey = number;
 
-declare type CheckStatus = 'passed' | 'failed' | 'error';
+type CheckStatus = 'passed' | 'failed' | 'error';
 interface CheckPredicateOpConstantRef {
     kind: 'constant';
     value: number;
@@ -392,7 +399,7 @@ interface CheckPredicateOpDataRef {
     kind: 'data';
     dataRef: CheckDataRef;
 }
-declare type CheckPredicateOpRef = CheckPredicateOpConstantRef | CheckPredicateOpDataRef;
+type CheckPredicateOpRef = CheckPredicateOpConstantRef | CheckPredicateOpDataRef;
 interface CheckPredicateReport {
     checkKey: CheckKey;
     result: CheckResult;
@@ -423,7 +430,7 @@ interface CheckGroupReport {
 interface CheckReport {
     groups: CheckGroupReport[];
 }
-declare type StyleFunc = (s: string) => string;
+type StyleFunc = (s: string) => string;
 /**
  * Return a string representation of the given scenario.
  *
@@ -492,11 +499,11 @@ declare function checkSummaryFromReport(checkReport: CheckReport): CheckSummary;
  */
 declare function checkReportFromSummary(checkConfig: CheckConfig, checkSummary: CheckSummary): CheckReport | undefined;
 
-declare type ComparisonScenarioId = string;
-declare type ComparisonScenarioTitle = string;
-declare type ComparisonScenarioSubtitle = string;
-declare type ComparisonScenarioInputName = string;
-declare type ComparisonScenarioInputPosition = 'default' | 'min' | 'max';
+type ComparisonScenarioId = string;
+type ComparisonScenarioTitle = string;
+type ComparisonScenarioSubtitle = string;
+type ComparisonScenarioInputName = string;
+type ComparisonScenarioInputPosition = 'default' | 'min' | 'max';
 /**
  * Specifies an input that is set to a specific position (default / min / max).
  */
@@ -521,7 +528,7 @@ interface ComparisonScenarioInputAtValueSpec {
  * A single input setting for a scenario.  An input can be set to a specific number value,
  * or it can be set to a "position" (default / min / max).
  */
-declare type ComparisonScenarioInputSpec = ComparisonScenarioInputAtPositionSpec | ComparisonScenarioInputAtValueSpec;
+type ComparisonScenarioInputSpec = ComparisonScenarioInputAtPositionSpec | ComparisonScenarioInputAtValueSpec;
 /**
  * Specifies a single scenario that sets one or more inputs to a value/position.
  */
@@ -536,6 +543,23 @@ interface ComparisonScenarioWithInputsSpec {
     /** The input settings for this scenario. */
     inputs: ComparisonScenarioInputSpec[];
 }
+/**
+ * Specifies a single scenario that configures inputs differently for the two
+ * model instances.
+ */
+interface ComparisonScenarioWithDistinctInputsSpec {
+    kind: 'scenario-with-distinct-inputs';
+    /** The unique identifier for the scenario. */
+    id?: ComparisonScenarioId;
+    /** The title of the scenario. */
+    title?: ComparisonScenarioTitle;
+    /** The subtitle of the scenario. */
+    subtitle?: ComparisonScenarioSubtitle;
+    /** The input settings for this scenario when run with the "left" model. */
+    inputsL: ComparisonScenarioInputSpec[];
+    /** The input settings for this scenario when run with the "right" model. */
+    inputsR: ComparisonScenarioInputSpec[];
+}
 /**
  * Specifies a single scenario that sets all available inputs to position.
  */
@@ -564,7 +588,7 @@ interface ComparisonScenarioPresetMatrixSpec {
  * A definition of input scenario(s).  A scenario can set one input to a value/position, or it
  * can set multiple inputs to particular values/positions.
  */
-declare type ComparisonScenarioSpec = ComparisonScenarioWithInputsSpec | ComparisonScenarioWithAllInputsSpec | ComparisonScenarioPresetMatrixSpec;
+type ComparisonScenarioSpec = ComparisonScenarioWithInputsSpec | ComparisonScenarioWithDistinctInputsSpec | ComparisonScenarioWithAllInputsSpec | ComparisonScenarioPresetMatrixSpec;
 /** A reference to a scenario definition. */
 interface ComparisonScenarioRefSpec {
     kind: 'scenario-ref';
@@ -575,8 +599,8 @@ interface ComparisonScenarioRefSpec {
     /** The optional subtitle that is used instead of the referenced scenario's subtitle. */
     subtitle?: ComparisonScenarioSubtitle;
 }
-declare type ComparisonScenarioGroupId = string;
-declare type ComparisonScenarioGroupTitle = string;
+type ComparisonScenarioGroupId = string;
+type ComparisonScenarioGroupTitle = string;
 /**
  * A definition of a group of input scenarios.  Multiple scenarios can be grouped together under a single name, and
  * can later be referenced by group ID in a view definition.
@@ -596,9 +620,9 @@ interface ComparisonScenarioGroupRefSpec {
     /** The ID of the scenario group that is referenced. */
     groupId: ComparisonScenarioGroupId;
 }
-declare type ComparisonViewTitle = string;
-declare type ComparisonViewSubtitle = string;
-declare type ComparisonViewGraphId = string;
+type ComparisonViewTitle = string;
+type ComparisonViewSubtitle = string;
+type ComparisonViewGraphId = string;
 /**
  * Specifies a list of graphs to be shown in a view.
  */
@@ -618,7 +642,7 @@ interface ComparisonViewGraphsPresetSpec {
 /**
  * Specifies a set of graphs to be shown in a view.
  */
-declare type ComparisonViewGraphsSpec = ComparisonViewGraphsArraySpec | ComparisonViewGraphsPresetSpec;
+type ComparisonViewGraphsSpec = ComparisonViewGraphsArraySpec | ComparisonViewGraphsPresetSpec;
 /**
  * A definition of a view.  A view presents a set of graphs for a single input scenario.
  */
@@ -633,7 +657,7 @@ interface ComparisonViewSpec {
     /** The graphs to be shown for each scenario view. */
     graphs: ComparisonViewGraphsSpec;
 }
-declare type ComparisonViewGroupTitle = string;
+type ComparisonViewGroupTitle = string;
 /**
  * Specifies a view group with an explicit array of view definitions.
  */
@@ -661,7 +685,7 @@ interface ComparisonViewGroupWithScenariosSpec {
  * A definition of a group of views.  Multiple related views can be grouped together under a single title
  * to make them easy to distinguish in a report.
  */
-declare type ComparisonViewGroupSpec = ComparisonViewGroupWithViewsSpec | ComparisonViewGroupWithScenariosSpec;
+type ComparisonViewGroupSpec = ComparisonViewGroupWithViewsSpec | ComparisonViewGroupWithScenariosSpec;
 /**
  * Contains the scenario and view definitions from one or more sources (JSON/YAML files or manually
  * defined specs).
@@ -700,7 +724,7 @@ interface ComparisonDataset {
     outputVarR?: OutputVar;
 }
 /** A unique key for a `ComparisonScenario`, generated internally for use by the library. */
-declare type ComparisonScenarioKey = string & {
+type ComparisonScenarioKey = string & {
     _brand?: 'ComparisonScenarioKey';
 };
 interface ComparisonResolverUnknownInputError {
@@ -709,7 +733,7 @@ interface ComparisonResolverUnknownInputError {
 interface ComparisonResolverInvalidValueError {
     kind: 'invalid-value';
 }
-declare type ComparisonResolverError = ComparisonResolverUnknownInputError | ComparisonResolverInvalidValueError;
+type ComparisonResolverError = ComparisonResolverUnknownInputError | ComparisonResolverInvalidValueError;
 /** Describes the resolution state for a scenario input relative to a specific model. */
 interface ComparisonScenarioInputState {
     /** The matched input variable; can be undefined if no input matched. */
@@ -746,7 +770,7 @@ interface ComparisonScenarioAllInputsSettings {
  * The configuration for an input scenario, either a set of individual input settings, or one
  * that sets all inputs in the model to a certain position.
  */
-declare type ComparisonScenarioSettings = ComparisonScenarioInputSettings | ComparisonScenarioAllInputsSettings;
+type ComparisonScenarioSettings = ComparisonScenarioInputSettings | ComparisonScenarioAllInputsSettings;
 /** A single resolved input scenario. */
 interface ComparisonScenario {
     kind: 'scenario';
@@ -907,7 +931,7 @@ interface ComparisonConfig {
     viewGroups: ComparisonViewGroup[];
 }
 
-declare type ComparisonDataRequestKey = string;
+type ComparisonDataRequestKey = string;
 /**
  * Coordinates loading of data in parallel from two models.
  */
@@ -928,7 +952,7 @@ interface DiffPoint {
     valueL: number;
     valueR: number;
 }
-declare type DiffValidity = 'neither' | 'left-only' | 'right-only' | 'both';
+type DiffValidity = 'neither' | 'left-only' | 'right-only' | 'both';
 interface DiffReport {
     validity: DiffValidity;
     minValue: number;
@@ -1002,7 +1026,7 @@ interface ComparisonSummary {
     perfReportR: PerfReport;
 }
 
-declare type GraphInclusion = 'neither' | 'left-only' | 'right-only' | 'both';
+type GraphInclusion = 'neither' | 'left-only' | 'right-only' | 'both';
 interface GraphComparisonMetadataReport {
     /** The key for the metadata field. */
     key: string;
@@ -1046,8 +1070,8 @@ declare function diffGraphs(graphL: BundleGraphSpec | undefined, graphR: BundleG
  */
 declare function comparisonSummaryFromReport(comparisonReport: ComparisonReport): ComparisonSummary;
 
-declare type ComparisonGroupKind = 'by-dataset' | 'by-scenario';
-declare type ComparisonGroupKey = string;
+type ComparisonGroupKind = 'by-dataset' | 'by-scenario';
+type ComparisonGroupKey = string;
 /**
  * A group of comparison test summaries associated with a particular scenario or dataset.
  */
@@ -1063,7 +1087,7 @@ interface ComparisonGroup {
     testSummaries: ComparisonTestSummary[];
 }
 /** Describes the "root" or primary item for a group of comparisons. */
-declare type ComparisonGroupRoot = ComparisonDataset | ComparisonScenario;
+type ComparisonGroupRoot = ComparisonDataset | ComparisonScenario;
 /** A summary of scores for a group of comparisons. */
 interface ComparisonGroupScores {
     /** The total number of comparisons (sample size) for this group. */
@@ -1216,7 +1240,7 @@ interface SuiteSummary {
     comparisonSummary?: ComparisonSummary;
 }
 
-declare type CancelRunSuite = () => void;
+type CancelRunSuite = () => void;
 interface RunSuiteCallbacks {
     onProgress?: (pct: number) => void;
     onComplete?: (suiteReport: SuiteReport) => void;
@@ -1245,4 +1269,4 @@ declare function runSuite(config: Config, callbacks: RunSuiteCallbacks, options?
  */
 declare function suiteSummaryFromReport(suiteReport: SuiteReport): SuiteSummary;
 
-export { AllInputsSpec, Bundle, BundleGraphData, BundleGraphDatasetSpec, BundleGraphId, BundleGraphSpec, BundleGraphView, BundleModel, CheckDataCoordinator, CheckDataRequestKey, CheckDatasetReport, CheckGroupReport, CheckKey, CheckPredicateOp, CheckPredicateOpConstantRef, CheckPredicateOpDataRef, CheckPredicateOpRef, CheckPredicateReport, CheckPredicateSummary, CheckPredicateTimeOptions, CheckPredicateTimeRange, CheckPredicateTimeSingle, CheckPredicateTimeSpec, CheckReport, CheckResult, CheckResultErrorInfo, CheckScenario, CheckScenarioError, CheckScenarioInputDesc, CheckScenarioReport, CheckStatus, CheckSummary, CheckTestReport, ComparisonCategorizedResults, ComparisonConfig, ComparisonDataCoordinator, ComparisonDataRequestKey, ComparisonDataset, ComparisonDatasetOptions, ComparisonDatasets, ComparisonGroup, ComparisonGroupKey, ComparisonGroupKind, ComparisonGroupRoot, ComparisonGroupScores, ComparisonGroupSummariesByCategory, ComparisonGroupSummary, ComparisonOptions, ComparisonReport, ComparisonResolverError, ComparisonResolverInvalidValueError, ComparisonResolverUnknownInputError, ComparisonScenario, ComparisonScenarioAllInputsSettings, ComparisonScenarioGroup, ComparisonScenarioGroupId, ComparisonScenarioGroupRefSpec, ComparisonScenarioGroupSpec, ComparisonScenarioGroupTitle, ComparisonScenarioId, ComparisonScenarioInput, ComparisonScenarioInputAtPositionSpec, ComparisonScenarioInputAtValueSpec, ComparisonScenarioInputName, ComparisonScenarioInputPosition, ComparisonScenarioInputSettings, ComparisonScenarioInputSpec, ComparisonScenarioInputState, ComparisonScenarioKey, ComparisonScenarioPresetMatrixSpec, ComparisonScenarioRefSpec, ComparisonScenarioSettings, ComparisonScenarioSpec, ComparisonScenarioSubtitle, ComparisonScenarioTitle, ComparisonScenarioWithAllInputsSpec, ComparisonScenarioWithInputsSpec, ComparisonScenarios, ComparisonSpecs, ComparisonSpecsSource, ComparisonSummary, ComparisonTestReport, ComparisonTestSummary, ComparisonUnresolvedScenarioGroupRef, ComparisonUnresolvedScenarioRef, ComparisonUnresolvedView, ComparisonView, ComparisonViewGraphId, ComparisonViewGraphsArraySpec, ComparisonViewGraphsPresetSpec, ComparisonViewGraphsSpec, ComparisonViewGroup, ComparisonViewGroupSpec, ComparisonViewGroupTitle, ComparisonViewGroupWithScenariosSpec, ComparisonViewGroupWithViewsSpec, ComparisonViewSpec, ComparisonViewSubtitle, ComparisonViewTitle, Config, ConfigInitOptions, ConfigOptions, DataSource, Dataset, DatasetKey, DatasetMap, DatasetsResult, DiffPoint, DiffReport, DiffValidity, Dimension, GraphComparisonDatasetReport, GraphComparisonMetadataReport, GraphComparisonReport, GraphInclusion, ImplVar, InputId, InputPosition, InputSetting, InputSettingsSpec, InputVar, LegendItem, LinkItem, LoadedBundle, ModelSpec, NamedBundle, OutputVar, PerfReport, PerfRunner, PerfStats, PositionSetting, RelatedItem, RunSuiteCallbacks, RunSuiteOptions, ScenarioSpec, ScenarioSpecUid, SourceName, Subscript, SuiteReport, SuiteSummary, ValueSetting, VarId, categorizeComparisonTestSummaries, checkReportFromSummary, checkSummaryFromReport, comparisonSummaryFromReport, createConfig, datasetMessage, diffDatasets, diffGraphs, predicateMessage, runSuite, scenarioMessage, suiteSummaryFromReport };
+export { AllInputsSpec, Bundle, BundleGraphData, BundleGraphDatasetSpec, BundleGraphId, BundleGraphSpec, BundleGraphView, BundleModel, CheckDataCoordinator, CheckDataRequestKey, CheckDatasetReport, CheckGroupReport, CheckKey, CheckPredicateOp, CheckPredicateOpConstantRef, CheckPredicateOpDataRef, CheckPredicateOpRef, CheckPredicateReport, CheckPredicateSummary, CheckPredicateTimeOptions, CheckPredicateTimeRange, CheckPredicateTimeSingle, CheckPredicateTimeSpec, CheckReport, CheckResult, CheckResultErrorInfo, CheckScenario, CheckScenarioError, CheckScenarioInputDesc, CheckScenarioReport, CheckStatus, CheckSummary, CheckTestReport, ComparisonCategorizedResults, ComparisonConfig, ComparisonDataCoordinator, ComparisonDataRequestKey, ComparisonDataset, ComparisonDatasetOptions, ComparisonDatasets, ComparisonGroup, ComparisonGroupKey, ComparisonGroupKind, ComparisonGroupRoot, ComparisonGroupScores, ComparisonGroupSummariesByCategory, ComparisonGroupSummary, ComparisonOptions, ComparisonReport, ComparisonResolverError, ComparisonResolverInvalidValueError, ComparisonResolverUnknownInputError, ComparisonScenario, ComparisonScenarioAllInputsSettings, ComparisonScenarioGroup, ComparisonScenarioGroupId, ComparisonScenarioGroupRefSpec, ComparisonScenarioGroupSpec, ComparisonScenarioGroupTitle, ComparisonScenarioId, ComparisonScenarioInput, ComparisonScenarioInputAtPositionSpec, ComparisonScenarioInputAtValueSpec, ComparisonScenarioInputName, ComparisonScenarioInputPosition, ComparisonScenarioInputSettings, ComparisonScenarioInputSpec, ComparisonScenarioInputState, ComparisonScenarioKey, ComparisonScenarioPresetMatrixSpec, ComparisonScenarioRefSpec, ComparisonScenarioSettings, ComparisonScenarioSpec, ComparisonScenarioSubtitle, ComparisonScenarioTitle, ComparisonScenarioWithAllInputsSpec, ComparisonScenarioWithDistinctInputsSpec, ComparisonScenarioWithInputsSpec, ComparisonScenarios, ComparisonSpecs, ComparisonSpecsSource, ComparisonSummary, ComparisonTestReport, ComparisonTestSummary, ComparisonUnresolvedScenarioGroupRef, ComparisonUnresolvedScenarioRef, ComparisonUnresolvedView, ComparisonView, ComparisonViewGraphId, ComparisonViewGraphsArraySpec, ComparisonViewGraphsPresetSpec, ComparisonViewGraphsSpec, ComparisonViewGroup, ComparisonViewGroupSpec, ComparisonViewGroupTitle, ComparisonViewGroupWithScenariosSpec, ComparisonViewGroupWithViewsSpec, ComparisonViewSpec, ComparisonViewSubtitle, ComparisonViewTitle, Config, ConfigInitOptions, ConfigOptions, DataSource, Dataset, DatasetGroupName, DatasetKey, DatasetMap, DatasetsResult, DiffPoint, DiffReport, DiffValidity, Dimension, GraphComparisonDatasetReport, GraphComparisonMetadataReport, GraphComparisonReport, GraphInclusion, ImplVar, InputAliasName, InputGroupName, InputId, InputPosition, InputSetting, InputSettingsSpec, InputVar, LegendItem, LinkItem, LoadedBundle, ModelSpec, NamedBundle, OutputVar, PerfReport, PerfRunner, PerfStats, PositionSetting, RelatedItem, RunSuiteCallbacks, RunSuiteOptions, ScenarioSpec, ScenarioSpecUid, SourceName, Subscript, SuiteReport, SuiteSummary, ValueSetting, VarId, categorizeComparisonTestSummaries, checkReportFromSummary, checkSummaryFromReport, comparisonSummaryFromReport, createConfig, datasetMessage, diffDatasets, diffGraphs, predicateMessage, runSuite, scenarioMessage, suiteSummaryFromReport };