@sdeverywhere/check-core 0.1.9 → 0.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -4,6 +4,39 @@ type DatasetKey = string;
4
4
  type Dataset = Map<number, number>;
5
5
  type DatasetMap = Map<DatasetKey, Dataset>;
6
6
 
7
+ /**
8
+ * Specifies a constant override that will be applied when running the model.
9
+ *
10
+ * Unlike `InputSetting` (which works with pre-declared input variables that have
11
+ * defined min/max ranges), constant overrides can modify ANY constant in the model
12
+ * when the `customConstants` feature is enabled.
13
+ */
14
+ interface ConstantOverride {
15
+ /** The variable ID of the constant to be overridden. */
16
+ varId: VarId;
17
+ /** The new value for the constant. */
18
+ value: number;
19
+ }
20
+ /**
21
+ * Specifies a lookup override that will be applied when running the model.
22
+ *
23
+ * The data provided here will override the default data in the generated model
24
+ * for the lookup or data variable identified by `varId`. When `points` is
25
+ * undefined, any previously-applied override for that variable will be reset
26
+ * back to its original data.
27
+ *
28
+ * Lookup overrides are only effective when the `customLookups` feature is
29
+ * enabled in the bundle.
30
+ */
31
+ interface LookupOverride {
32
+ /** The variable ID of the lookup or data variable to be overridden. */
33
+ varId: VarId;
34
+ /**
35
+ * The lookup data as a flat array of (x,y) pairs. If undefined, the lookup
36
+ * data will be reset to the original data.
37
+ */
38
+ points?: Float64Array;
39
+ }
7
40
  /** A unique identifier for the scenario, derived from its input settings. */
8
41
  type ScenarioSpecUid = string;
9
42
  type InputPosition = 'at-default' | 'at-minimum' | 'at-maximum';
@@ -41,9 +74,45 @@ interface DatasetsResult {
41
74
  */
42
75
  modelRunTime?: number;
43
76
  }
77
+ /**
78
+ * Options for the `getDatasetsForScenario` method.
79
+ */
80
+ interface GetDatasetsOptions {
81
+ /**
82
+ * If defined, override the values for the specified constant variables.
83
+ *
84
+ * Unlike input settings (which work with pre-declared input variables), constant
85
+ * overrides can modify ANY constant in the model when the `customConstants` feature
86
+ * is enabled.
87
+ *
88
+ * Note that constant overrides do NOT persist across `getDatasetsForScenario` calls.
89
+ * They must be provided each time you want to override constants.
90
+ */
91
+ constants?: ConstantOverride[];
92
+ /**
93
+ * If defined, override the data for the specified lookup or data variables.
94
+ *
95
+ * The data provided here will override the default data in the generated model
96
+ * for each variable identified by `varId`. Lookup overrides are only effective
97
+ * when the `customLookups` feature is enabled in the bundle.
98
+ *
99
+ * Note that lookup overrides MAY OR MAY NOT persist across `getDatasetsForScenario`
100
+ * calls, depending on the underlying model/runtime implementation. If you want to
101
+ * ensure that previously-applied lookup overrides do not take effect on subsequent
102
+ * runs, pass an undefined `points` array for the relevant variable to cause the
103
+ * lookup data to be reset to its original data.
104
+ */
105
+ lookups?: LookupOverride[];
106
+ }
44
107
  interface DataSource {
45
- /** Return the datasets that result from running the given scenario. */
46
- getDatasetsForScenario(scenarioSpec: ScenarioSpec, datasetKeys: DatasetKey[]): Promise<DatasetsResult>;
108
+ /**
109
+ * Return the datasets that result from running the given scenario.
110
+ *
111
+ * @param scenarioSpec The scenario spec that defines the inputs for the model run.
112
+ * @param datasetKeys The keys of the datasets to be fetched.
113
+ * @param options Optional configuration including constant and lookup overrides.
114
+ */
115
+ getDatasetsForScenario(scenarioSpec: ScenarioSpec, datasetKeys: DatasetKey[], options?: GetDatasetsOptions): Promise<DatasetsResult>;
47
116
  }
48
117
 
49
118
  /**
@@ -58,14 +127,11 @@ interface RelatedItem {
58
127
  /** A unique, stable input identifier. */
59
128
  type InputId = string;
60
129
  /**
61
- * Holds information about an input variable used in the model.
130
+ * Holds information about an input variable that is controlled by a continuous range/slider.
62
131
  */
63
- interface InputVar {
64
- /**
65
- * Whether this input is controlled by a continuous range/slider or a discrete on/off switch.
66
- * If undefined, 'slider' will be assumed.
67
- */
68
- kind?: 'slider' | 'switch';
132
+ interface SliderInputVar {
133
+ /** Indicates that this input is controlled by a continuous range/slider. */
134
+ kind: 'slider';
69
135
  /**
70
136
  * A unique, stable identifier string for this input.
71
137
  *
@@ -91,6 +157,37 @@ interface InputVar {
91
157
  /** The metadata for the related input control. */
92
158
  relatedItem?: RelatedItem;
93
159
  }
160
+ /**
161
+ * Holds information about an input variable that is controlled by a discrete on/off switch.
162
+ */
163
+ interface SwitchInputVar {
164
+ /** Indicates that this input is controlled by a discrete on/off switch. */
165
+ kind: 'switch';
166
+ /**
167
+ * A unique, stable identifier string for this input.
168
+ *
169
+ * This can be used to identify an input variable in a way that is resilient
170
+ * to the variable's name being changed between two versions of the model.
171
+ */
172
+ inputId: InputId;
173
+ /** The variable identifier (typically a simplified/canonical ID, like the form used in SDE). */
174
+ varId: VarId;
175
+ /** The full variable name as used in the modeling tool. */
176
+ varName: string;
177
+ /** The default value of the input. */
178
+ defaultValue: number;
179
+ /** The value of the variable when this switch is in an "off" state. */
180
+ offValue: number;
181
+ /** The value of the variable when this switch is in an "on" state. */
182
+ onValue: number;
183
+ /** The metadata for the related input control. */
184
+ relatedItem?: RelatedItem;
185
+ }
186
+ /**
187
+ * Holds information about an input variable used in the model. This is a discriminated
188
+ * union; use the `kind` field to determine the underlying variant.
189
+ */
190
+ type InputVar = SliderInputVar | SwitchInputVar;
94
191
  /**
95
192
  * Holds information about an output variable used in the model.
96
193
  */
@@ -553,6 +650,15 @@ declare class TaskQueue {
553
650
  }
554
651
 
555
652
  type CheckDataRequestKey = string;
653
+ /**
654
+ * Options for `requestDataset`.
655
+ */
656
+ interface RequestDatasetOptions {
657
+ /** Optional constant overrides for the model. */
658
+ constants?: ConstantOverride[];
659
+ /** Optional lookup overrides for the model. */
660
+ lookups?: LookupOverride[];
661
+ }
556
662
  /**
557
663
  * Coordinates on-demand loading of data used to display a graph representation
558
664
  * of a check/predicate.
@@ -560,7 +666,16 @@ type CheckDataRequestKey = string;
560
666
  declare class CheckDataCoordinator {
561
667
  private readonly taskQueue;
562
668
  constructor(taskQueue: TaskQueue);
563
- requestDataset(requestKey: CheckDataRequestKey, scenarioSpec: ScenarioSpec, datasetKey: DatasetKey, onResponse: (dataset: Dataset) => void): void;
669
+ /**
670
+ * Request a dataset from the model.
671
+ *
672
+ * @param requestKey The unique key for the request.
673
+ * @param scenarioSpec The scenario spec that defines the inputs for the model run.
674
+ * @param datasetKey The key of the dataset to be fetched.
675
+ * @param options Optional configuration including constant and lookup overrides.
676
+ * @param onResponse The callback that will be called with the dataset.
677
+ */
678
+ requestDataset(requestKey: CheckDataRequestKey, scenarioSpec: ScenarioSpec, datasetKey: DatasetKey, options: RequestDatasetOptions | undefined, onResponse: (dataset: Dataset) => void): void;
564
679
  cancelRequest(key: CheckDataRequestKey): void;
565
680
  }
566
681
  /**
@@ -1262,15 +1377,50 @@ interface ComparisonViewGroup {
1262
1377
  views: (ComparisonView | ComparisonUnresolvedView)[];
1263
1378
  }
1264
1379
 
1380
+ /**
1381
+ * A summary of timing samples collected during a performance run.
1382
+ */
1265
1383
  interface PerfReport {
1384
+ /** Minimum sample time, in milliseconds. */
1266
1385
  readonly minTime: number;
1386
+ /** Maximum sample time, in milliseconds. */
1267
1387
  readonly maxTime: number;
1388
+ /**
1389
+ * Trimmed mean (interquartile mean) computed from the middle 50% of samples,
1390
+ * in milliseconds. This is more robust against outliers than a simple mean.
1391
+ */
1268
1392
  readonly avgTime: number;
1393
+ /** Median (50th percentile) sample time, in milliseconds. */
1394
+ readonly medianTime: number;
1395
+ /** 95th percentile sample time, in milliseconds. */
1396
+ readonly p95Time: number;
1397
+ /** Population standard deviation across all samples, in milliseconds. */
1398
+ readonly stdDev: number;
1399
+ /** All recorded sample times, sorted ascending, in milliseconds. */
1269
1400
  readonly allTimes: number[];
1270
1401
  }
1402
+ /**
1403
+ * Collect performance timing samples and produce a robust statistical summary.
1404
+ */
1271
1405
  declare class PerfStats {
1272
1406
  private readonly times;
1407
+ /**
1408
+ * Record a single run time sample.
1409
+ *
1410
+ * @param timeInMillis The run time in milliseconds.
1411
+ */
1273
1412
  addRun(timeInMillis: number): void;
1413
+ /**
1414
+ * Get the raw run time samples that have been recorded.
1415
+ *
1416
+ * @returns A copy of the recorded run times, in insertion order.
1417
+ */
1418
+ getTimes(): number[];
1419
+ /**
1420
+ * Produce a `PerfReport` summarizing the recorded samples.
1421
+ *
1422
+ * @returns The summary report.
1423
+ */
1274
1424
  toReport(): PerfReport;
1275
1425
  }
1276
1426
 
@@ -1679,6 +1829,19 @@ interface ComparisonConfig {
1679
1829
  }
1680
1830
 
1681
1831
  type ComparisonDataRequestKey = string;
1832
+ /**
1833
+ * Options for `requestDatasetMaps`.
1834
+ */
1835
+ interface RequestDatasetMapsOptions {
1836
+ /** Optional constant overrides for the "left" model. */
1837
+ constantsL?: ConstantOverride[];
1838
+ /** Optional constant overrides for the "right" model. */
1839
+ constantsR?: ConstantOverride[];
1840
+ /** Optional lookup overrides for the "left" model. */
1841
+ lookupsL?: LookupOverride[];
1842
+ /** Optional lookup overrides for the "right" model. */
1843
+ lookupsR?: LookupOverride[];
1844
+ }
1682
1845
  /**
1683
1846
  * Coordinates loading of data in parallel from two models.
1684
1847
  */
@@ -1697,10 +1860,11 @@ declare class ComparisonDataCoordinator {
1697
1860
  * will be fetched from the "left" bundle's model, otherwise they will be fetched from
1698
1861
  * the "right" bundle's model.
1699
1862
  * @param scenarioSpecR The scenario used for the second ("right") model of the comparison.
1700
- * @param graphId The keys of the datasets to be fetched.
1863
+ * @param datasetKeys The keys of the datasets to be fetched.
1864
+ * @param options Optional configuration including constant and lookup overrides.
1701
1865
  * @param onResponse The callback that will be called with the dataset maps.
1702
1866
  */
1703
- requestDatasetMaps(requestKey: ComparisonDataRequestKey, sourceL: 'left' | 'right', scenarioSpecL: ScenarioSpec, sourceR: 'left' | 'right', scenarioSpecR: ScenarioSpec, datasetKeys: DatasetKey[], onResponse: (datasetMapL?: DatasetMap, datasetMapR?: DatasetMap) => void): void;
1867
+ requestDatasetMaps(requestKey: ComparisonDataRequestKey, sourceL: 'left' | 'right', scenarioSpecL: ScenarioSpec, sourceR: 'left' | 'right', scenarioSpecR: ScenarioSpec, datasetKeys: DatasetKey[], options: RequestDatasetMapsOptions | undefined, onResponse: (datasetMapL?: DatasetMap, datasetMapR?: DatasetMap) => void): void;
1704
1868
  /**
1705
1869
  * Request graph data from the two models.
1706
1870
  *
@@ -1993,4 +2157,4 @@ declare function runSuite(config: Config, callbacks: RunSuiteCallbacks, options?
1993
2157
  */
1994
2158
  declare function suiteSummaryFromReport(suiteReport: SuiteReport, elapsedMillis: number): SuiteSummary;
1995
2159
 
1996
- export { type AllInputsSpec, type Bundle, type BundleGraphData, type BundleGraphDatasetSpec, type BundleGraphId, type BundleGraphSpec, type BundleGraphView, type BundleGraphViewOptions, type BundleModel, type CancelRunPerf, type CancelRunSuite, type CancelRunTrace as CancelTrace, type CheckConfig, CheckDataCoordinator, type CheckDataRef, type CheckDataRefKey, type CheckDataRequestKey, type CheckDataset, type CheckDatasetError, type CheckDatasetReport, type CheckGroupReport, type CheckKey, type CheckNameSpec, type CheckOptions, type CheckPredicateOp, type CheckPredicateOpConstantRef, type CheckPredicateOpDataRef, type CheckPredicateOpRef, type CheckPredicateReport, type CheckPredicateSummary, type CheckPredicateTimeOptions, type CheckPredicateTimeRange, type CheckPredicateTimeSingle, type CheckPredicateTimeSpec, type CheckReport, type CheckResult, type CheckResultErrorInfo, type CheckScenario, type CheckScenarioError, type CheckScenarioInputDesc, type CheckScenarioReport, type CheckStatus, type CheckSummary, type CheckTestReport, type ComparisonCategorizedResults, type ComparisonConfig, ComparisonDataCoordinator, type ComparisonDataRequestKey, type ComparisonDataset, type ComparisonDatasetName, type ComparisonDatasetOptions, type ComparisonDatasetSource, type ComparisonDatasetSpec, type ComparisonDatasets, type ComparisonGraphGroup, type ComparisonGraphGroupId, type ComparisonGraphGroupRefSpec, type ComparisonGraphGroupSpec, type ComparisonGraphId, type ComparisonGraphsArraySpec, type ComparisonGraphsPresetSpec, type ComparisonGroup, type ComparisonGroupKey, type ComparisonGroupKind, type ComparisonGroupRoot, type ComparisonGroupScores, type ComparisonGroupSummariesByCategory, type ComparisonGroupSummary, type ComparisonOptions, type ComparisonPlot, type ComparisonReport, type ComparisonReportDetailItem, type ComparisonReportDetailRow, type ComparisonReportOptions, type ComparisonReportSummaryRow, type ComparisonReportSummarySection, type ComparisonResolverError, type ComparisonResolverInvalidValueError, type ComparisonResolverUnknownInputError, type ComparisonResolverUnknownInputSettingGroupError, type ComparisonScenario, type ComparisonScenarioAllInputsSettings, type ComparisonScenarioGroup, type ComparisonScenarioGroupId, type ComparisonScenarioGroupRefSpec, type ComparisonScenarioGroupSpec, type ComparisonScenarioGroupTitle, type ComparisonScenarioId, type ComparisonScenarioInput, type ComparisonScenarioInputAtPositionSpec, type ComparisonScenarioInputAtValueSpec, type ComparisonScenarioInputName, type ComparisonScenarioInputPosition, type ComparisonScenarioInputSettings, type ComparisonScenarioInputSpec, type ComparisonScenarioInputState, type ComparisonScenarioKey, type ComparisonScenarioPresetMatrixSpec, type ComparisonScenarioRefSpec, type ComparisonScenarioSettings, type ComparisonScenarioSpec, type ComparisonScenarioSubtitle, type ComparisonScenarioTitle, type ComparisonScenarioTitleSpec, type ComparisonScenarioWithAllInputsSpec, type ComparisonScenarioWithDistinctInputsSpec, type ComparisonScenarioWithInputsSpec, type ComparisonScenarioWithSettingGroupSpec, type ComparisonScenarios, type ComparisonSortMode, type ComparisonSpecs, type ComparisonSpecsSource, type ComparisonSummary, type ComparisonTestReport, type ComparisonTestSummary, type ComparisonUnresolvedScenarioGroupRef, type ComparisonUnresolvedScenarioRef, type ComparisonUnresolvedView, type ComparisonView, type ComparisonViewBox, type ComparisonViewBoxSpec, type ComparisonViewGraphOrder, type ComparisonViewGraphsSpec, type ComparisonViewGroup, type ComparisonViewGroupSpec, type ComparisonViewGroupTitle, type ComparisonViewGroupWithScenariosSpec, type ComparisonViewGroupWithViewsSpec, type ComparisonViewItemSubtitle, type ComparisonViewItemTitle, type ComparisonViewRow, type ComparisonViewRowSpec, type ComparisonViewRowSubtitle, type ComparisonViewRowTitle, type ComparisonViewSpec, type ComparisonViewSubtitle, type ComparisonViewTitle, type Config, type ConfigInitOptions, type ConfigOptions, type DataSource, type Dataset, type DatasetGroupName, type DatasetKey, type DatasetMap, type DatasetsResult, type DiffPoint, type DiffReport, type DiffValidity, type EncodedImplVars, type EncodedSubscript, type EncodedVarInstance, type EncodedVarType, type EncodedVariable, type GraphComparisonDatasetReport, type GraphComparisonMetadataReport, type GraphComparisonReport, type GraphInclusion, type ImplVar, type ImplVarGroup, type InputAliasName, type InputGroupName, type InputId, type InputPosition, type InputSetting, type InputSettingGroupId, type InputSettingsSpec, type InputVar, type LegendItem, type LinkItem, type LoadedBundle, type ModelSpec, type NamedBundle, type OutputVar, type PerfReport, PerfStats, type PositionSetting, type RelatedItem, type RunPerfCallbacks, type RunPerfOptions, type RunSuiteCallbacks, type RunSuiteOptions, type ScenarioSpec, type ScenarioSpecUid, type SourceName, type SuiteReport, type SuiteSummary, type RunTraceCallbacks as TraceCallbacks, type TraceCompareToBundleOptions, type TraceCompareToExtDataOptions, type TraceDatasetReport, type TraceOptions, type TraceReport, type ValueSetting, type VarId, categorizeComparisonTestSummaries, checkReportFromSummary, checkSummaryFromReport, comparisonSummaryFromReport, createCheckDataCoordinator, createCheckDataCoordinatorForTests, createComparisonDataCoordinator, createConfig, datasetMessage, decodeImplVars, diffDatasets, diffGraphs, encodeImplVars, getScoresForTestSummaries, predicateMessage, runPerf, runSuite, runTrace, scenarioMessage, suiteSummaryFromReport, testSummaryFromReport };
2160
+ export { type AllInputsSpec, type Bundle, type BundleGraphData, type BundleGraphDatasetSpec, type BundleGraphId, type BundleGraphSpec, type BundleGraphView, type BundleGraphViewOptions, type BundleModel, type CancelRunPerf, type CancelRunSuite, type CancelRunTrace as CancelTrace, type CheckConfig, CheckDataCoordinator, type CheckDataRef, type CheckDataRefKey, type CheckDataRequestKey, type CheckDataset, type CheckDatasetError, type CheckDatasetReport, type CheckGroupReport, type CheckKey, type CheckNameSpec, type CheckOptions, type CheckPredicateOp, type CheckPredicateOpConstantRef, type CheckPredicateOpDataRef, type CheckPredicateOpRef, type CheckPredicateReport, type CheckPredicateSummary, type CheckPredicateTimeOptions, type CheckPredicateTimeRange, type CheckPredicateTimeSingle, type CheckPredicateTimeSpec, type CheckReport, type CheckResult, type CheckResultErrorInfo, type CheckScenario, type CheckScenarioError, type CheckScenarioInputDesc, type CheckScenarioReport, type CheckStatus, type CheckSummary, type CheckTestReport, type ComparisonCategorizedResults, type ComparisonConfig, ComparisonDataCoordinator, type ComparisonDataRequestKey, type ComparisonDataset, type ComparisonDatasetName, type ComparisonDatasetOptions, type ComparisonDatasetSource, type ComparisonDatasetSpec, type ComparisonDatasets, type ComparisonGraphGroup, type ComparisonGraphGroupId, type ComparisonGraphGroupRefSpec, type ComparisonGraphGroupSpec, type ComparisonGraphId, type ComparisonGraphsArraySpec, type ComparisonGraphsPresetSpec, type ComparisonGroup, type ComparisonGroupKey, type ComparisonGroupKind, type ComparisonGroupRoot, type ComparisonGroupScores, type ComparisonGroupSummariesByCategory, type ComparisonGroupSummary, type ComparisonOptions, type ComparisonPlot, type ComparisonReport, type ComparisonReportDetailItem, type ComparisonReportDetailRow, type ComparisonReportOptions, type ComparisonReportSummaryRow, type ComparisonReportSummarySection, type ComparisonResolverError, type ComparisonResolverInvalidValueError, type ComparisonResolverUnknownInputError, type ComparisonResolverUnknownInputSettingGroupError, type ComparisonScenario, type ComparisonScenarioAllInputsSettings, type ComparisonScenarioGroup, type ComparisonScenarioGroupId, type ComparisonScenarioGroupRefSpec, type ComparisonScenarioGroupSpec, type ComparisonScenarioGroupTitle, type ComparisonScenarioId, type ComparisonScenarioInput, type ComparisonScenarioInputAtPositionSpec, type ComparisonScenarioInputAtValueSpec, type ComparisonScenarioInputName, type ComparisonScenarioInputPosition, type ComparisonScenarioInputSettings, type ComparisonScenarioInputSpec, type ComparisonScenarioInputState, type ComparisonScenarioKey, type ComparisonScenarioPresetMatrixSpec, type ComparisonScenarioRefSpec, type ComparisonScenarioSettings, type ComparisonScenarioSpec, type ComparisonScenarioSubtitle, type ComparisonScenarioTitle, type ComparisonScenarioTitleSpec, type ComparisonScenarioWithAllInputsSpec, type ComparisonScenarioWithDistinctInputsSpec, type ComparisonScenarioWithInputsSpec, type ComparisonScenarioWithSettingGroupSpec, type ComparisonScenarios, type ComparisonSortMode, type ComparisonSpecs, type ComparisonSpecsSource, type ComparisonSummary, type ComparisonTestReport, type ComparisonTestSummary, type ComparisonUnresolvedScenarioGroupRef, type ComparisonUnresolvedScenarioRef, type ComparisonUnresolvedView, type ComparisonView, type ComparisonViewBox, type ComparisonViewBoxSpec, type ComparisonViewGraphOrder, type ComparisonViewGraphsSpec, type ComparisonViewGroup, type ComparisonViewGroupSpec, type ComparisonViewGroupTitle, type ComparisonViewGroupWithScenariosSpec, type ComparisonViewGroupWithViewsSpec, type ComparisonViewItemSubtitle, type ComparisonViewItemTitle, type ComparisonViewRow, type ComparisonViewRowSpec, type ComparisonViewRowSubtitle, type ComparisonViewRowTitle, type ComparisonViewSpec, type ComparisonViewSubtitle, type ComparisonViewTitle, type Config, type ConfigInitOptions, type ConfigOptions, type ConstantOverride, type DataSource, type Dataset, type DatasetGroupName, type DatasetKey, type DatasetMap, type DatasetsResult, type DiffPoint, type DiffReport, type DiffValidity, type EncodedImplVars, type EncodedSubscript, type EncodedVarInstance, type EncodedVarType, type EncodedVariable, type GetDatasetsOptions, type GraphComparisonDatasetReport, type GraphComparisonMetadataReport, type GraphComparisonReport, type GraphInclusion, type ImplVar, type ImplVarGroup, type InputAliasName, type InputGroupName, type InputId, type InputPosition, type InputSetting, type InputSettingGroupId, type InputSettingsSpec, type InputVar, type LegendItem, type LinkItem, type LoadedBundle, type LookupOverride, type ModelSpec, type NamedBundle, type OutputVar, type PerfReport, PerfStats, type PositionSetting, type RelatedItem, type RunPerfCallbacks, type RunPerfOptions, type RunSuiteCallbacks, type RunSuiteOptions, type ScenarioSpec, type ScenarioSpecUid, type SliderInputVar, type SourceName, type SuiteReport, type SuiteSummary, type SwitchInputVar, type RunTraceCallbacks as TraceCallbacks, type TraceCompareToBundleOptions, type TraceCompareToExtDataOptions, type TraceDatasetReport, type TraceOptions, type TraceReport, type ValueSetting, type VarId, categorizeComparisonTestSummaries, checkReportFromSummary, checkSummaryFromReport, comparisonSummaryFromReport, createCheckDataCoordinator, createCheckDataCoordinatorForTests, createComparisonDataCoordinator, createConfig, datasetMessage, decodeImplVars, diffDatasets, diffGraphs, encodeImplVars, getScoresForTestSummaries, predicateMessage, runPerf, runSuite, runTrace, scenarioMessage, suiteSummaryFromReport, testSummaryFromReport };
package/dist/index.d.ts CHANGED
@@ -4,6 +4,39 @@ type DatasetKey = string;
4
4
  type Dataset = Map<number, number>;
5
5
  type DatasetMap = Map<DatasetKey, Dataset>;
6
6
 
7
+ /**
8
+ * Specifies a constant override that will be applied when running the model.
9
+ *
10
+ * Unlike `InputSetting` (which works with pre-declared input variables that have
11
+ * defined min/max ranges), constant overrides can modify ANY constant in the model
12
+ * when the `customConstants` feature is enabled.
13
+ */
14
+ interface ConstantOverride {
15
+ /** The variable ID of the constant to be overridden. */
16
+ varId: VarId;
17
+ /** The new value for the constant. */
18
+ value: number;
19
+ }
20
+ /**
21
+ * Specifies a lookup override that will be applied when running the model.
22
+ *
23
+ * The data provided here will override the default data in the generated model
24
+ * for the lookup or data variable identified by `varId`. When `points` is
25
+ * undefined, any previously-applied override for that variable will be reset
26
+ * back to its original data.
27
+ *
28
+ * Lookup overrides are only effective when the `customLookups` feature is
29
+ * enabled in the bundle.
30
+ */
31
+ interface LookupOverride {
32
+ /** The variable ID of the lookup or data variable to be overridden. */
33
+ varId: VarId;
34
+ /**
35
+ * The lookup data as a flat array of (x,y) pairs. If undefined, the lookup
36
+ * data will be reset to the original data.
37
+ */
38
+ points?: Float64Array;
39
+ }
7
40
  /** A unique identifier for the scenario, derived from its input settings. */
8
41
  type ScenarioSpecUid = string;
9
42
  type InputPosition = 'at-default' | 'at-minimum' | 'at-maximum';
@@ -41,9 +74,45 @@ interface DatasetsResult {
41
74
  */
42
75
  modelRunTime?: number;
43
76
  }
77
+ /**
78
+ * Options for the `getDatasetsForScenario` method.
79
+ */
80
+ interface GetDatasetsOptions {
81
+ /**
82
+ * If defined, override the values for the specified constant variables.
83
+ *
84
+ * Unlike input settings (which work with pre-declared input variables), constant
85
+ * overrides can modify ANY constant in the model when the `customConstants` feature
86
+ * is enabled.
87
+ *
88
+ * Note that constant overrides do NOT persist across `getDatasetsForScenario` calls.
89
+ * They must be provided each time you want to override constants.
90
+ */
91
+ constants?: ConstantOverride[];
92
+ /**
93
+ * If defined, override the data for the specified lookup or data variables.
94
+ *
95
+ * The data provided here will override the default data in the generated model
96
+ * for each variable identified by `varId`. Lookup overrides are only effective
97
+ * when the `customLookups` feature is enabled in the bundle.
98
+ *
99
+ * Note that lookup overrides MAY OR MAY NOT persist across `getDatasetsForScenario`
100
+ * calls, depending on the underlying model/runtime implementation. If you want to
101
+ * ensure that previously-applied lookup overrides do not take effect on subsequent
102
+ * runs, pass an undefined `points` array for the relevant variable to cause the
103
+ * lookup data to be reset to its original data.
104
+ */
105
+ lookups?: LookupOverride[];
106
+ }
44
107
  interface DataSource {
45
- /** Return the datasets that result from running the given scenario. */
46
- getDatasetsForScenario(scenarioSpec: ScenarioSpec, datasetKeys: DatasetKey[]): Promise<DatasetsResult>;
108
+ /**
109
+ * Return the datasets that result from running the given scenario.
110
+ *
111
+ * @param scenarioSpec The scenario spec that defines the inputs for the model run.
112
+ * @param datasetKeys The keys of the datasets to be fetched.
113
+ * @param options Optional configuration including constant and lookup overrides.
114
+ */
115
+ getDatasetsForScenario(scenarioSpec: ScenarioSpec, datasetKeys: DatasetKey[], options?: GetDatasetsOptions): Promise<DatasetsResult>;
47
116
  }
48
117
 
49
118
  /**
@@ -58,14 +127,11 @@ interface RelatedItem {
58
127
  /** A unique, stable input identifier. */
59
128
  type InputId = string;
60
129
  /**
61
- * Holds information about an input variable used in the model.
130
+ * Holds information about an input variable that is controlled by a continuous range/slider.
62
131
  */
63
- interface InputVar {
64
- /**
65
- * Whether this input is controlled by a continuous range/slider or a discrete on/off switch.
66
- * If undefined, 'slider' will be assumed.
67
- */
68
- kind?: 'slider' | 'switch';
132
+ interface SliderInputVar {
133
+ /** Indicates that this input is controlled by a continuous range/slider. */
134
+ kind: 'slider';
69
135
  /**
70
136
  * A unique, stable identifier string for this input.
71
137
  *
@@ -91,6 +157,37 @@ interface InputVar {
91
157
  /** The metadata for the related input control. */
92
158
  relatedItem?: RelatedItem;
93
159
  }
160
+ /**
161
+ * Holds information about an input variable that is controlled by a discrete on/off switch.
162
+ */
163
+ interface SwitchInputVar {
164
+ /** Indicates that this input is controlled by a discrete on/off switch. */
165
+ kind: 'switch';
166
+ /**
167
+ * A unique, stable identifier string for this input.
168
+ *
169
+ * This can be used to identify an input variable in a way that is resilient
170
+ * to the variable's name being changed between two versions of the model.
171
+ */
172
+ inputId: InputId;
173
+ /** The variable identifier (typically a simplified/canonical ID, like the form used in SDE). */
174
+ varId: VarId;
175
+ /** The full variable name as used in the modeling tool. */
176
+ varName: string;
177
+ /** The default value of the input. */
178
+ defaultValue: number;
179
+ /** The value of the variable when this switch is in an "off" state. */
180
+ offValue: number;
181
+ /** The value of the variable when this switch is in an "on" state. */
182
+ onValue: number;
183
+ /** The metadata for the related input control. */
184
+ relatedItem?: RelatedItem;
185
+ }
186
+ /**
187
+ * Holds information about an input variable used in the model. This is a discriminated
188
+ * union; use the `kind` field to determine the underlying variant.
189
+ */
190
+ type InputVar = SliderInputVar | SwitchInputVar;
94
191
  /**
95
192
  * Holds information about an output variable used in the model.
96
193
  */
@@ -553,6 +650,15 @@ declare class TaskQueue {
553
650
  }
554
651
 
555
652
  type CheckDataRequestKey = string;
653
+ /**
654
+ * Options for `requestDataset`.
655
+ */
656
+ interface RequestDatasetOptions {
657
+ /** Optional constant overrides for the model. */
658
+ constants?: ConstantOverride[];
659
+ /** Optional lookup overrides for the model. */
660
+ lookups?: LookupOverride[];
661
+ }
556
662
  /**
557
663
  * Coordinates on-demand loading of data used to display a graph representation
558
664
  * of a check/predicate.
@@ -560,7 +666,16 @@ type CheckDataRequestKey = string;
560
666
  declare class CheckDataCoordinator {
561
667
  private readonly taskQueue;
562
668
  constructor(taskQueue: TaskQueue);
563
- requestDataset(requestKey: CheckDataRequestKey, scenarioSpec: ScenarioSpec, datasetKey: DatasetKey, onResponse: (dataset: Dataset) => void): void;
669
+ /**
670
+ * Request a dataset from the model.
671
+ *
672
+ * @param requestKey The unique key for the request.
673
+ * @param scenarioSpec The scenario spec that defines the inputs for the model run.
674
+ * @param datasetKey The key of the dataset to be fetched.
675
+ * @param options Optional configuration including constant and lookup overrides.
676
+ * @param onResponse The callback that will be called with the dataset.
677
+ */
678
+ requestDataset(requestKey: CheckDataRequestKey, scenarioSpec: ScenarioSpec, datasetKey: DatasetKey, options: RequestDatasetOptions | undefined, onResponse: (dataset: Dataset) => void): void;
564
679
  cancelRequest(key: CheckDataRequestKey): void;
565
680
  }
566
681
  /**
@@ -1262,15 +1377,50 @@ interface ComparisonViewGroup {
1262
1377
  views: (ComparisonView | ComparisonUnresolvedView)[];
1263
1378
  }
1264
1379
 
1380
+ /**
1381
+ * A summary of timing samples collected during a performance run.
1382
+ */
1265
1383
  interface PerfReport {
1384
+ /** Minimum sample time, in milliseconds. */
1266
1385
  readonly minTime: number;
1386
+ /** Maximum sample time, in milliseconds. */
1267
1387
  readonly maxTime: number;
1388
+ /**
1389
+ * Trimmed mean (interquartile mean) computed from the middle 50% of samples,
1390
+ * in milliseconds. This is more robust against outliers than a simple mean.
1391
+ */
1268
1392
  readonly avgTime: number;
1393
+ /** Median (50th percentile) sample time, in milliseconds. */
1394
+ readonly medianTime: number;
1395
+ /** 95th percentile sample time, in milliseconds. */
1396
+ readonly p95Time: number;
1397
+ /** Population standard deviation across all samples, in milliseconds. */
1398
+ readonly stdDev: number;
1399
+ /** All recorded sample times, sorted ascending, in milliseconds. */
1269
1400
  readonly allTimes: number[];
1270
1401
  }
1402
+ /**
1403
+ * Collect performance timing samples and produce a robust statistical summary.
1404
+ */
1271
1405
  declare class PerfStats {
1272
1406
  private readonly times;
1407
+ /**
1408
+ * Record a single run time sample.
1409
+ *
1410
+ * @param timeInMillis The run time in milliseconds.
1411
+ */
1273
1412
  addRun(timeInMillis: number): void;
1413
+ /**
1414
+ * Get the raw run time samples that have been recorded.
1415
+ *
1416
+ * @returns A copy of the recorded run times, in insertion order.
1417
+ */
1418
+ getTimes(): number[];
1419
+ /**
1420
+ * Produce a `PerfReport` summarizing the recorded samples.
1421
+ *
1422
+ * @returns The summary report.
1423
+ */
1274
1424
  toReport(): PerfReport;
1275
1425
  }
1276
1426
 
@@ -1679,6 +1829,19 @@ interface ComparisonConfig {
1679
1829
  }
1680
1830
 
1681
1831
  type ComparisonDataRequestKey = string;
1832
+ /**
1833
+ * Options for `requestDatasetMaps`.
1834
+ */
1835
+ interface RequestDatasetMapsOptions {
1836
+ /** Optional constant overrides for the "left" model. */
1837
+ constantsL?: ConstantOverride[];
1838
+ /** Optional constant overrides for the "right" model. */
1839
+ constantsR?: ConstantOverride[];
1840
+ /** Optional lookup overrides for the "left" model. */
1841
+ lookupsL?: LookupOverride[];
1842
+ /** Optional lookup overrides for the "right" model. */
1843
+ lookupsR?: LookupOverride[];
1844
+ }
1682
1845
  /**
1683
1846
  * Coordinates loading of data in parallel from two models.
1684
1847
  */
@@ -1697,10 +1860,11 @@ declare class ComparisonDataCoordinator {
1697
1860
  * will be fetched from the "left" bundle's model, otherwise they will be fetched from
1698
1861
  * the "right" bundle's model.
1699
1862
  * @param scenarioSpecR The scenario used for the second ("right") model of the comparison.
1700
- * @param graphId The keys of the datasets to be fetched.
1863
+ * @param datasetKeys The keys of the datasets to be fetched.
1864
+ * @param options Optional configuration including constant and lookup overrides.
1701
1865
  * @param onResponse The callback that will be called with the dataset maps.
1702
1866
  */
1703
- requestDatasetMaps(requestKey: ComparisonDataRequestKey, sourceL: 'left' | 'right', scenarioSpecL: ScenarioSpec, sourceR: 'left' | 'right', scenarioSpecR: ScenarioSpec, datasetKeys: DatasetKey[], onResponse: (datasetMapL?: DatasetMap, datasetMapR?: DatasetMap) => void): void;
1867
+ requestDatasetMaps(requestKey: ComparisonDataRequestKey, sourceL: 'left' | 'right', scenarioSpecL: ScenarioSpec, sourceR: 'left' | 'right', scenarioSpecR: ScenarioSpec, datasetKeys: DatasetKey[], options: RequestDatasetMapsOptions | undefined, onResponse: (datasetMapL?: DatasetMap, datasetMapR?: DatasetMap) => void): void;
1704
1868
  /**
1705
1869
  * Request graph data from the two models.
1706
1870
  *
@@ -1993,4 +2157,4 @@ declare function runSuite(config: Config, callbacks: RunSuiteCallbacks, options?
1993
2157
  */
1994
2158
  declare function suiteSummaryFromReport(suiteReport: SuiteReport, elapsedMillis: number): SuiteSummary;
1995
2159
 
1996
- export { type AllInputsSpec, type Bundle, type BundleGraphData, type BundleGraphDatasetSpec, type BundleGraphId, type BundleGraphSpec, type BundleGraphView, type BundleGraphViewOptions, type BundleModel, type CancelRunPerf, type CancelRunSuite, type CancelRunTrace as CancelTrace, type CheckConfig, CheckDataCoordinator, type CheckDataRef, type CheckDataRefKey, type CheckDataRequestKey, type CheckDataset, type CheckDatasetError, type CheckDatasetReport, type CheckGroupReport, type CheckKey, type CheckNameSpec, type CheckOptions, type CheckPredicateOp, type CheckPredicateOpConstantRef, type CheckPredicateOpDataRef, type CheckPredicateOpRef, type CheckPredicateReport, type CheckPredicateSummary, type CheckPredicateTimeOptions, type CheckPredicateTimeRange, type CheckPredicateTimeSingle, type CheckPredicateTimeSpec, type CheckReport, type CheckResult, type CheckResultErrorInfo, type CheckScenario, type CheckScenarioError, type CheckScenarioInputDesc, type CheckScenarioReport, type CheckStatus, type CheckSummary, type CheckTestReport, type ComparisonCategorizedResults, type ComparisonConfig, ComparisonDataCoordinator, type ComparisonDataRequestKey, type ComparisonDataset, type ComparisonDatasetName, type ComparisonDatasetOptions, type ComparisonDatasetSource, type ComparisonDatasetSpec, type ComparisonDatasets, type ComparisonGraphGroup, type ComparisonGraphGroupId, type ComparisonGraphGroupRefSpec, type ComparisonGraphGroupSpec, type ComparisonGraphId, type ComparisonGraphsArraySpec, type ComparisonGraphsPresetSpec, type ComparisonGroup, type ComparisonGroupKey, type ComparisonGroupKind, type ComparisonGroupRoot, type ComparisonGroupScores, type ComparisonGroupSummariesByCategory, type ComparisonGroupSummary, type ComparisonOptions, type ComparisonPlot, type ComparisonReport, type ComparisonReportDetailItem, type ComparisonReportDetailRow, type ComparisonReportOptions, type ComparisonReportSummaryRow, type ComparisonReportSummarySection, type ComparisonResolverError, type ComparisonResolverInvalidValueError, type ComparisonResolverUnknownInputError, type ComparisonResolverUnknownInputSettingGroupError, type ComparisonScenario, type ComparisonScenarioAllInputsSettings, type ComparisonScenarioGroup, type ComparisonScenarioGroupId, type ComparisonScenarioGroupRefSpec, type ComparisonScenarioGroupSpec, type ComparisonScenarioGroupTitle, type ComparisonScenarioId, type ComparisonScenarioInput, type ComparisonScenarioInputAtPositionSpec, type ComparisonScenarioInputAtValueSpec, type ComparisonScenarioInputName, type ComparisonScenarioInputPosition, type ComparisonScenarioInputSettings, type ComparisonScenarioInputSpec, type ComparisonScenarioInputState, type ComparisonScenarioKey, type ComparisonScenarioPresetMatrixSpec, type ComparisonScenarioRefSpec, type ComparisonScenarioSettings, type ComparisonScenarioSpec, type ComparisonScenarioSubtitle, type ComparisonScenarioTitle, type ComparisonScenarioTitleSpec, type ComparisonScenarioWithAllInputsSpec, type ComparisonScenarioWithDistinctInputsSpec, type ComparisonScenarioWithInputsSpec, type ComparisonScenarioWithSettingGroupSpec, type ComparisonScenarios, type ComparisonSortMode, type ComparisonSpecs, type ComparisonSpecsSource, type ComparisonSummary, type ComparisonTestReport, type ComparisonTestSummary, type ComparisonUnresolvedScenarioGroupRef, type ComparisonUnresolvedScenarioRef, type ComparisonUnresolvedView, type ComparisonView, type ComparisonViewBox, type ComparisonViewBoxSpec, type ComparisonViewGraphOrder, type ComparisonViewGraphsSpec, type ComparisonViewGroup, type ComparisonViewGroupSpec, type ComparisonViewGroupTitle, type ComparisonViewGroupWithScenariosSpec, type ComparisonViewGroupWithViewsSpec, type ComparisonViewItemSubtitle, type ComparisonViewItemTitle, type ComparisonViewRow, type ComparisonViewRowSpec, type ComparisonViewRowSubtitle, type ComparisonViewRowTitle, type ComparisonViewSpec, type ComparisonViewSubtitle, type ComparisonViewTitle, type Config, type ConfigInitOptions, type ConfigOptions, type DataSource, type Dataset, type DatasetGroupName, type DatasetKey, type DatasetMap, type DatasetsResult, type DiffPoint, type DiffReport, type DiffValidity, type EncodedImplVars, type EncodedSubscript, type EncodedVarInstance, type EncodedVarType, type EncodedVariable, type GraphComparisonDatasetReport, type GraphComparisonMetadataReport, type GraphComparisonReport, type GraphInclusion, type ImplVar, type ImplVarGroup, type InputAliasName, type InputGroupName, type InputId, type InputPosition, type InputSetting, type InputSettingGroupId, type InputSettingsSpec, type InputVar, type LegendItem, type LinkItem, type LoadedBundle, type ModelSpec, type NamedBundle, type OutputVar, type PerfReport, PerfStats, type PositionSetting, type RelatedItem, type RunPerfCallbacks, type RunPerfOptions, type RunSuiteCallbacks, type RunSuiteOptions, type ScenarioSpec, type ScenarioSpecUid, type SourceName, type SuiteReport, type SuiteSummary, type RunTraceCallbacks as TraceCallbacks, type TraceCompareToBundleOptions, type TraceCompareToExtDataOptions, type TraceDatasetReport, type TraceOptions, type TraceReport, type ValueSetting, type VarId, categorizeComparisonTestSummaries, checkReportFromSummary, checkSummaryFromReport, comparisonSummaryFromReport, createCheckDataCoordinator, createCheckDataCoordinatorForTests, createComparisonDataCoordinator, createConfig, datasetMessage, decodeImplVars, diffDatasets, diffGraphs, encodeImplVars, getScoresForTestSummaries, predicateMessage, runPerf, runSuite, runTrace, scenarioMessage, suiteSummaryFromReport, testSummaryFromReport };
2160
+ export { type AllInputsSpec, type Bundle, type BundleGraphData, type BundleGraphDatasetSpec, type BundleGraphId, type BundleGraphSpec, type BundleGraphView, type BundleGraphViewOptions, type BundleModel, type CancelRunPerf, type CancelRunSuite, type CancelRunTrace as CancelTrace, type CheckConfig, CheckDataCoordinator, type CheckDataRef, type CheckDataRefKey, type CheckDataRequestKey, type CheckDataset, type CheckDatasetError, type CheckDatasetReport, type CheckGroupReport, type CheckKey, type CheckNameSpec, type CheckOptions, type CheckPredicateOp, type CheckPredicateOpConstantRef, type CheckPredicateOpDataRef, type CheckPredicateOpRef, type CheckPredicateReport, type CheckPredicateSummary, type CheckPredicateTimeOptions, type CheckPredicateTimeRange, type CheckPredicateTimeSingle, type CheckPredicateTimeSpec, type CheckReport, type CheckResult, type CheckResultErrorInfo, type CheckScenario, type CheckScenarioError, type CheckScenarioInputDesc, type CheckScenarioReport, type CheckStatus, type CheckSummary, type CheckTestReport, type ComparisonCategorizedResults, type ComparisonConfig, ComparisonDataCoordinator, type ComparisonDataRequestKey, type ComparisonDataset, type ComparisonDatasetName, type ComparisonDatasetOptions, type ComparisonDatasetSource, type ComparisonDatasetSpec, type ComparisonDatasets, type ComparisonGraphGroup, type ComparisonGraphGroupId, type ComparisonGraphGroupRefSpec, type ComparisonGraphGroupSpec, type ComparisonGraphId, type ComparisonGraphsArraySpec, type ComparisonGraphsPresetSpec, type ComparisonGroup, type ComparisonGroupKey, type ComparisonGroupKind, type ComparisonGroupRoot, type ComparisonGroupScores, type ComparisonGroupSummariesByCategory, type ComparisonGroupSummary, type ComparisonOptions, type ComparisonPlot, type ComparisonReport, type ComparisonReportDetailItem, type ComparisonReportDetailRow, type ComparisonReportOptions, type ComparisonReportSummaryRow, type ComparisonReportSummarySection, type ComparisonResolverError, type ComparisonResolverInvalidValueError, type ComparisonResolverUnknownInputError, type ComparisonResolverUnknownInputSettingGroupError, type ComparisonScenario, type ComparisonScenarioAllInputsSettings, type ComparisonScenarioGroup, type ComparisonScenarioGroupId, type ComparisonScenarioGroupRefSpec, type ComparisonScenarioGroupSpec, type ComparisonScenarioGroupTitle, type ComparisonScenarioId, type ComparisonScenarioInput, type ComparisonScenarioInputAtPositionSpec, type ComparisonScenarioInputAtValueSpec, type ComparisonScenarioInputName, type ComparisonScenarioInputPosition, type ComparisonScenarioInputSettings, type ComparisonScenarioInputSpec, type ComparisonScenarioInputState, type ComparisonScenarioKey, type ComparisonScenarioPresetMatrixSpec, type ComparisonScenarioRefSpec, type ComparisonScenarioSettings, type ComparisonScenarioSpec, type ComparisonScenarioSubtitle, type ComparisonScenarioTitle, type ComparisonScenarioTitleSpec, type ComparisonScenarioWithAllInputsSpec, type ComparisonScenarioWithDistinctInputsSpec, type ComparisonScenarioWithInputsSpec, type ComparisonScenarioWithSettingGroupSpec, type ComparisonScenarios, type ComparisonSortMode, type ComparisonSpecs, type ComparisonSpecsSource, type ComparisonSummary, type ComparisonTestReport, type ComparisonTestSummary, type ComparisonUnresolvedScenarioGroupRef, type ComparisonUnresolvedScenarioRef, type ComparisonUnresolvedView, type ComparisonView, type ComparisonViewBox, type ComparisonViewBoxSpec, type ComparisonViewGraphOrder, type ComparisonViewGraphsSpec, type ComparisonViewGroup, type ComparisonViewGroupSpec, type ComparisonViewGroupTitle, type ComparisonViewGroupWithScenariosSpec, type ComparisonViewGroupWithViewsSpec, type ComparisonViewItemSubtitle, type ComparisonViewItemTitle, type ComparisonViewRow, type ComparisonViewRowSpec, type ComparisonViewRowSubtitle, type ComparisonViewRowTitle, type ComparisonViewSpec, type ComparisonViewSubtitle, type ComparisonViewTitle, type Config, type ConfigInitOptions, type ConfigOptions, type ConstantOverride, type DataSource, type Dataset, type DatasetGroupName, type DatasetKey, type DatasetMap, type DatasetsResult, type DiffPoint, type DiffReport, type DiffValidity, type EncodedImplVars, type EncodedSubscript, type EncodedVarInstance, type EncodedVarType, type EncodedVariable, type GetDatasetsOptions, type GraphComparisonDatasetReport, type GraphComparisonMetadataReport, type GraphComparisonReport, type GraphInclusion, type ImplVar, type ImplVarGroup, type InputAliasName, type InputGroupName, type InputId, type InputPosition, type InputSetting, type InputSettingGroupId, type InputSettingsSpec, type InputVar, type LegendItem, type LinkItem, type LoadedBundle, type LookupOverride, type ModelSpec, type NamedBundle, type OutputVar, type PerfReport, PerfStats, type PositionSetting, type RelatedItem, type RunPerfCallbacks, type RunPerfOptions, type RunSuiteCallbacks, type RunSuiteOptions, type ScenarioSpec, type ScenarioSpecUid, type SliderInputVar, type SourceName, type SuiteReport, type SuiteSummary, type SwitchInputVar, type RunTraceCallbacks as TraceCallbacks, type TraceCompareToBundleOptions, type TraceCompareToExtDataOptions, type TraceDatasetReport, type TraceOptions, type TraceReport, type ValueSetting, type VarId, categorizeComparisonTestSummaries, checkReportFromSummary, checkSummaryFromReport, comparisonSummaryFromReport, createCheckDataCoordinator, createCheckDataCoordinatorForTests, createComparisonDataCoordinator, createConfig, datasetMessage, decodeImplVars, diffDatasets, diffGraphs, encodeImplVars, getScoresForTestSummaries, predicateMessage, runPerf, runSuite, runTrace, scenarioMessage, suiteSummaryFromReport, testSummaryFromReport };