@khanacademy/perseus-score 1.1.0 → 2.0.0

package/dist/validation.types.d.ts

@@ -5,29 +5,30 @@
  *
  * These types are:
  *
- * `Perseus<Widget>UserInput`: the data returned by the widget that the user
- * entered. This is referred to as the 'guess' in some older parts of Perseus.
+ *   * `Perseus<Widget>UserInput`: the data from the widget that represents the
+ *     data the user entered. This is referred to as the 'guess' in some older
+ *     parts of Perseus.
  *
- * `Perseus<Widget>ValidationData`: the data needed to do validation of the
- * user input. Validation refers to the different checks that we can do both on
- * the client-side (before submitting user input for scoring) and on the
- * server-side (when we score it). As such, it cannot contain any of the
- * sensitive scoring data that would reveal the answer.
+ *   * `Perseus<Widget>ValidationData`: the data needed to do validation of the
+ *     user input. Validation refers to the different checks that we can do
+ *     both on the client-side (before submitting user input for scoring) and
+ *     on the server-side (when we score it). As such, it cannot contain any of
+ *     the sensitive scoring data that would reveal the answer.
  *
- * `Perseus<Widget>ScoringData` (nee `Perseus<Widget>Rubric`): the data needed
- * to score the user input. By convention, this type is defined as the set of
- * sensitive answer data and then intersected with
- * `Perseus<Widget>ValidationData`.
+ *   * `Perseus<Widget>Rubric` (nee `Perseus<Widget>Rubric`): the data
+ *     needed to score the user input. By convention, this type is defined as
+ *     the set of sensitive answer data and then intersected with
+ *     `Perseus<Widget>ValidationData`.
  *
  * For example:
  * ```
- * type Perseus<Widget>ScoringData = {
+ * type Perseus<Widget>Rubric = {
  *     correct: string;  // Used _only_ for scoring
  *     size: number;     // Used _only_ for scoring
  * } & Perseus<Widget>ValidationData;
  * ```
  */
-import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatcherWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType, InteractiveMarkerType, Relationship } from "@khanacademy/perseus-core";
+import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType, MakeWidgetMap, Relationship } from "@khanacademy/perseus-core";
 export type PerseusScore = {
     type: "invalid";
     message?: string | null | undefined;
@@ -42,16 +43,15 @@ export type ValidationResult = Extract<PerseusScore, {
     type: "invalid";
 }> | null;
 export type UserInputStatus = "correct" | "incorrect" | "incomplete";
-export type PerseusCategorizerScoringData = {
+export type PerseusCategorizerRubric = {
     values: ReadonlyArray<number>;
 } & PerseusCategorizerValidationData;
 export type PerseusCategorizerUserInput = {
-    values: PerseusCategorizerScoringData["values"];
+    values: PerseusCategorizerRubric["values"];
 };
 export type PerseusCategorizerValidationData = {
     items: ReadonlyArray<string>;
 };
-export type PerseusCSProgramRubric = Empty;
 export type PerseusCSProgramUserInput = {
     status: UserInputStatus;
     message: string | null;
@@ -68,6 +68,9 @@ export type PerseusExpressionRubric = {
 };
 export type PerseusExpressionUserInput = string;
 export type PerseusGroupRubric = PerseusGroupWidgetOptions;
+export type PerseusGroupValidationData = {
+    widgets: ValidationDataMap;
+};
 export type PerseusGroupUserInput = UserInputMap;
 export type PerseusGradedGroupRubric = PerseusGradedGroupWidgetOptions;
 export type PerseusGradedGroupSetRubric = PerseusGradedGroupSetWidgetOptions;
@@ -75,7 +78,6 @@ export type PerseusGrapherRubric = {
     correct: GrapherAnswerTypes;
 };
 export type PerseusGrapherUserInput = PerseusGrapherRubric["correct"];
-export type PerseusIFrameRubric = Empty;
 export type PerseusIFrameUserInput = {
     status: UserInputStatus;
     message: string | null;
@@ -95,11 +97,22 @@ export type PerseusInteractiveGraphRubric = {
     graph: PerseusGraphType;
 };
 export type PerseusInteractiveGraphUserInput = PerseusGraphType;
-export type PerseusLabelImageRubric = Empty;
+export type PerseusLabelImageRubric = {
+    markers: ReadonlyArray<{
+        answers: ReadonlyArray<string>;
+        label: string;
+    }>;
+};
 export type PerseusLabelImageUserInput = {
-    markers: ReadonlyArray<InteractiveMarkerType>;
+    markers: ReadonlyArray<{
+        selected?: ReadonlyArray<string>;
+        label: string;
+    }>;
+};
+export type PerseusMatcherRubric = {
+    left: ReadonlyArray<string>;
+    right: ReadonlyArray<string>;
 };
-export type PerseusMatcherRubric = PerseusMatcherWidgetOptions;
 export type PerseusMatcherUserInput = {
     left: ReadonlyArray<string>;
     right: ReadonlyArray<string>;
@@ -111,13 +124,7 @@ export type PerseusMatrixValidationData = Empty;
 export type PerseusMatrixUserInput = {
     answers: PerseusMatrixRubric["answers"];
 };
-export type PerseusMockWidgetRubric = {
-    value: string;
-};
-export type PerseusMockWidgetUserInput = {
-    currentValue: string;
-};
-export type PerseusNumberLineScoringData = {
+export type PerseusNumberLineRubric = {
     correctRel: string | null | undefined;
     correctX: number;
     range: ReadonlyArray<number>;
@@ -142,7 +149,7 @@ export type PerseusOrdererRubric = PerseusOrdererWidgetOptions;
 export type PerseusOrdererUserInput = {
     current: ReadonlyArray<string>;
 };
-export type PerseusPlotterScoringData = {
+export type PerseusPlotterRubric = {
     correct: ReadonlyArray<number>;
 } & PerseusPlotterValidationData;
 export type PerseusPlotterValidationData = {
@@ -166,12 +173,107 @@ export type PerseusTableRubric = {
     answers: ReadonlyArray<ReadonlyArray<string>>;
 };
 export type PerseusTableUserInput = ReadonlyArray<ReadonlyArray<string>>;
-export type Rubric = PerseusCategorizerScoringData | PerseusCSProgramRubric | PerseusDropdownRubric | PerseusExpressionRubric | PerseusGroupRubric | PerseusGradedGroupRubric | PerseusGradedGroupSetRubric | PerseusGrapherRubric | PerseusIFrameRubric | PerseusInputNumberRubric | PerseusInteractiveGraphRubric | PerseusLabelImageRubric | PerseusMatcherRubric | PerseusMatrixRubric | PerseusMockWidgetRubric | PerseusNumberLineScoringData | PerseusNumericInputRubric | PerseusOrdererRubric | PerseusPlotterScoringData | PerseusRadioRubric | PerseusSorterRubric | PerseusTableRubric;
-export type UserInput = PerseusCategorizerUserInput | PerseusCSProgramUserInput | PerseusDropdownUserInput | PerseusExpressionUserInput | PerseusGrapherUserInput | PerseusIFrameUserInput | PerseusInputNumberUserInput | PerseusInteractiveGraphUserInput | PerseusLabelImageUserInput | PerseusMatcherUserInput | PerseusMatrixUserInput | PerseusMockWidgetUserInput | PerseusNumberLineUserInput | PerseusNumericInputUserInput | PerseusOrdererUserInput | PerseusPlotterUserInput | PerseusRadioUserInput | PerseusSorterUserInput | PerseusTableUserInput;
-export type UserInputMap = {
-    [widgetId: string]: UserInput | UserInputMap;
+export interface RubricRegistry {
+    categorizer: PerseusCategorizerRubric;
+    dropdown: PerseusDropdownRubric;
+    expression: PerseusExpressionRubric;
+    "graded-group-set": PerseusGradedGroupSetRubric;
+    "graded-group": PerseusGradedGroupRubric;
+    grapher: PerseusGrapherRubric;
+    group: PerseusGroupRubric;
+    image: PerseusLabelImageRubric;
+    "input-number": PerseusInputNumberRubric;
+    "interactive-graph": PerseusInteractiveGraphRubric;
+    "label-image": PerseusLabelImageRubric;
+    matcher: PerseusMatcherRubric;
+    matrix: PerseusMatrixRubric;
+    "number-line": PerseusNumberLineRubric;
+    "numeric-input": PerseusNumericInputRubric;
+    orderer: PerseusOrdererRubric;
+    plotter: PerseusPlotterRubric;
+    radio: PerseusRadioRubric;
+    sorter: PerseusSorterRubric;
+    table: PerseusTableRubric;
+}
+/**
+ * A map of scoring data (previously referred to as "rubric"), keyed by
+ * `widgetId`. This data is used to score a learner's guess for a PerseusItem.
+ *
+ * NOTE:  The value in this map is intentionally a subset of WidgetOptions<T>.
+ * By using the same shape (minus any unneeded render data), we are able to
+ * share functionality that understands how to traverse maps of `widget id` to
+ * `options`.
+ */
+export type RubricMap = {
+    [Property in keyof RubricRegistry as `${Property} ${number}`]: {
+        type: Property;
+        static?: boolean;
+        options: RubricRegistry[Property];
+    };
 };
+export type Rubric = RubricRegistry[keyof RubricRegistry];
+/**
+ * This is an interface so that it can be extended if a widget is created
+ * outside of this Perseus package. See `PerseusWidgetTypes` for a full
+ * explanation.
+ */
+interface UserInputRegistry {
+    categorizer: PerseusCategorizerUserInput;
+    "cs-program": PerseusCSProgramUserInput;
+    dropdown: PerseusDropdownUserInput;
+    expression: PerseusExpressionUserInput;
+    grapher: PerseusGrapherUserInput;
+    group: PerseusGroupUserInput;
+    iframe: PerseusIFrameUserInput;
+    "input-number": PerseusInputNumberUserInput;
+    "interactive-graph": PerseusInteractiveGraphUserInput;
+    "label-image": PerseusLabelImageUserInput;
+    matcher: PerseusMatcherUserInput;
+    matrix: PerseusMatrixUserInput;
+    "number-line": PerseusNumberLineUserInput;
+    "numeric-input": PerseusNumericInputUserInput;
+    orderer: PerseusOrdererUserInput;
+    plotter: PerseusPlotterUserInput;
+    radio: PerseusRadioUserInput;
+    sorter: PerseusSorterUserInput;
+    table: PerseusTableUserInput;
+}
+/** A union type of all the widget user input types */
+export type UserInput = UserInputRegistry[keyof UserInputRegistry];
+/**
+ * A map of widget IDs to user input types (strongly typed based on the format
+ * of the widget ID).
+ */
+export type UserInputMap = MakeWidgetMap<UserInputRegistry>;
 /**
  * deprecated prefer using UserInputMap
  */
 export type UserInputArray = ReadonlyArray<UserInputArray | UserInput | null | undefined>;
+export interface ValidationDataTypes {
+    categorizer: PerseusCategorizerValidationData;
+    group: PerseusGroupValidationData;
+    plotter: PerseusPlotterValidationData;
+}
+/**
+ * A map of validation data, keyed by `widgetId`. This data is used to check if
+ * a question is answerable. This data represents the minimal intersection of
+ * data that's available in the client (widget options) and server (scoring
+ * data) and is represented by a group of types known as "validation data".
+ *
+ * NOTE: The value in this map is intentionally a subset of WidgetOptions<T>.
+ * By using the same shape (minus any unneeded data), we are able to pass a
+ * `PerseusWidgetsMap` or ` into any function that accepts a
+ * `ValidationDataMap` without any mutation of data.
+ */
+export type ValidationDataMap = {
+    [Property in keyof ValidationDataTypes as `${Property} ${number}`]: {
+        type: Property;
+        static?: boolean;
+        options: ValidationDataTypes[Property];
+    };
+};
+/**
+ * A union type of all the different widget validation data types that exist.
+ */
+export type ValidationData = ValidationDataTypes[keyof ValidationDataTypes];
+export {};

package/dist/validation.typetest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/widgets/categorizer/score-categorizer.d.ts

@@ -1,3 +1,3 @@
-import type { PerseusCategorizerScoringData, PerseusCategorizerUserInput, PerseusScore } from "../../validation.types";
-declare function scoreCategorizer(userInput: PerseusCategorizerUserInput, scoringData: PerseusCategorizerScoringData): PerseusScore;
+import type { PerseusCategorizerRubric, PerseusCategorizerUserInput, PerseusScore } from "../../validation.types";
+declare function scoreCategorizer(userInput: PerseusCategorizerUserInput, rubric: PerseusCategorizerRubric): PerseusScore;
 export default scoreCategorizer;

package/dist/widgets/cs-program/score-cs-program.d.ts

@@ -1,3 +1,3 @@
 import type { PerseusCSProgramUserInput, PerseusScore } from "../../validation.types";
-declare function scoreCSProgram(state: PerseusCSProgramUserInput): PerseusScore;
+declare function scoreCSProgram(userInput: PerseusCSProgramUserInput): PerseusScore;
 export default scoreCSProgram;

package/dist/widgets/expression/score-expression.d.ts

@@ -1,3 +1,3 @@
 import type { PerseusExpressionRubric, PerseusExpressionUserInput, PerseusScore } from "../../validation.types";
-declare function scoreExpression(userInput: PerseusExpressionUserInput, rubric: PerseusExpressionRubric, strings: any, locale: string): PerseusScore;
+declare function scoreExpression(userInput: PerseusExpressionUserInput, rubric: PerseusExpressionRubric, locale: string): PerseusScore;
 export default scoreExpression;

package/dist/widgets/grapher/score-grapher.d.ts

@@ -1,3 +1,3 @@
-import type { PerseusGrapherUserInput, PerseusGrapherRubric, PerseusScore } from "../../validation.types";
+import type { PerseusGrapherRubric, PerseusGrapherUserInput, PerseusScore } from "../../validation.types";
 declare function scoreGrapher(userInput: PerseusGrapherUserInput, rubric: PerseusGrapherRubric): PerseusScore;
 export default scoreGrapher;

package/dist/widgets/interactive-graph/score-interactive-graph.d.ts

@@ -1,3 +1,3 @@
-import type { PerseusScore, PerseusInteractiveGraphRubric, PerseusInteractiveGraphUserInput } from "@khanacademy/perseus-score";
+import type { PerseusInteractiveGraphRubric, PerseusScore, PerseusInteractiveGraphUserInput } from "@khanacademy/perseus-score";
 declare function scoreInteractiveGraph(userInput: PerseusInteractiveGraphUserInput, rubric: PerseusInteractiveGraphRubric): PerseusScore;
 export default scoreInteractiveGraph;

package/dist/widgets/label-image/score-label-image.d.ts

@@ -1,9 +1,8 @@
 import type { PerseusLabelImageUserInput, PerseusLabelImageRubric, PerseusScore } from "../../validation.types";
-import type { InteractiveMarkerType } from "@khanacademy/perseus-core";
 type InteractiveMarkerScore = {
     hasAnswers: boolean;
     isCorrect: boolean;
 };
-export declare function scoreLabelImageMarker(marker: InteractiveMarkerType): InteractiveMarkerScore;
-declare function scoreLabelImage(userInput: PerseusLabelImageUserInput, rubric?: PerseusLabelImageRubric): PerseusScore;
+export declare function scoreLabelImageMarker(userInput: PerseusLabelImageUserInput["markers"][number]["selected"], rubric: PerseusLabelImageRubric["markers"][number]["answers"]): InteractiveMarkerScore;
+declare function scoreLabelImage(userInput: PerseusLabelImageUserInput, rubric: PerseusLabelImageRubric): PerseusScore;
 export default scoreLabelImage;

package/dist/widgets/label-image/validate-label-image.d.ts

@@ -0,0 +1,3 @@
+import type { PerseusLabelImageUserInput, ValidationResult } from "../../validation.types";
+declare function validateLabelImage(userInput: PerseusLabelImageUserInput): ValidationResult;
+export default validateLabelImage;

package/dist/widgets/matcher/score-matcher.d.ts

@@ -1,3 +1,3 @@
 import type { PerseusMatcherRubric, PerseusMatcherUserInput, PerseusScore } from "../../validation.types";
-declare function scoreMatcher(state: PerseusMatcherUserInput, rubric: PerseusMatcherRubric): PerseusScore;
+declare function scoreMatcher(userInput: PerseusMatcherUserInput, rubric: PerseusMatcherRubric): PerseusScore;
 export default scoreMatcher;

package/dist/widgets/matrix/score-matrix.d.ts

@@ -1,3 +1,3 @@
-import type { PerseusMatrixUserInput, PerseusMatrixRubric, PerseusScore } from "../../validation.types";
+import type { PerseusMatrixRubric, PerseusMatrixUserInput, PerseusScore } from "../../validation.types";
 declare function scoreMatrix(userInput: PerseusMatrixUserInput, rubric: PerseusMatrixRubric): PerseusScore;
 export default scoreMatrix;

package/dist/widgets/matrix/validate-matrix.d.ts

@@ -1,4 +1,4 @@
-import type { PerseusMatrixUserInput, PerseusMatrixValidationData, ValidationResult } from "../../validation.types";
+import type { PerseusMatrixUserInput, ValidationResult } from "../../validation.types";
 /**
  * Checks user input from the matrix widget to see if it is scorable.
  *
@@ -7,5 +7,5 @@ import type { PerseusMatrixUserInput, PerseusMatrixValidationData, ValidationRes
  *
  * @see `scoreMatrix()` for more details.
  */
-declare function validateMatrix(userInput: PerseusMatrixUserInput, validationData: PerseusMatrixValidationData): ValidationResult;
+declare function validateMatrix(userInput: PerseusMatrixUserInput): ValidationResult;
 export default validateMatrix;

package/dist/widgets/number-line/score-number-line.d.ts

@@ -1,3 +1,3 @@
-import type { PerseusNumberLineScoringData, PerseusNumberLineUserInput, PerseusScore } from "../../validation.types";
-declare function scoreNumberLine(userInput: PerseusNumberLineUserInput, scoringData: PerseusNumberLineScoringData): PerseusScore;
+import type { PerseusNumberLineRubric, PerseusNumberLineUserInput, PerseusScore } from "../../validation.types";
+declare function scoreNumberLine(userInput: PerseusNumberLineUserInput, rubric: PerseusNumberLineRubric): PerseusScore;
 export default scoreNumberLine;

package/dist/widgets/plotter/score-plotter.d.ts

@@ -1,3 +1,3 @@
-import type { PerseusPlotterUserInput, PerseusPlotterScoringData, PerseusScore } from "../../validation.types";
-declare function scorePlotter(userInput: PerseusPlotterUserInput, scoringData: PerseusPlotterScoringData): PerseusScore;
+import type { PerseusPlotterUserInput, PerseusPlotterRubric, PerseusScore } from "../../validation.types";
+declare function scorePlotter(userInput: PerseusPlotterUserInput, rubric: PerseusPlotterRubric): PerseusScore;
 export default scorePlotter;

package/dist/widgets/sorter/score-sorter.d.ts

@@ -1,3 +1,3 @@
-import type { PerseusSorterUserInput, PerseusSorterRubric, PerseusScore } from "../../validation.types";
+import type { PerseusSorterRubric, PerseusSorterUserInput, PerseusScore } from "../../validation.types";
 declare function scoreSorter(userInput: PerseusSorterUserInput, rubric: PerseusSorterRubric): PerseusScore;
 export default scoreSorter;

package/dist/widgets/table/score-table.d.ts

@@ -1,3 +1,3 @@
-import type { PerseusScore, PerseusTableRubric, PerseusTableUserInput } from "../../validation.types";
+import type { PerseusTableRubric, PerseusScore, PerseusTableUserInput } from "../../validation.types";
 declare function scoreTable(userInput: PerseusTableUserInput, rubric: PerseusTableRubric): PerseusScore;
 export default scoreTable;

package/package.json

@@ -3,7 +3,7 @@
     "description": "Perseus score",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "1.1.0",
+    "version": "2.0.0",
     "publishConfig": {
         "access": "public"
     },
@@ -26,9 +26,9 @@
         "test": "bash -c 'yarn --silent --cwd \"../..\" test ${@:0} $($([[ ${@: -1} = -* ]] || [[ ${@: -1} = bash ]]) && echo $PWD)'"
     },
     "dependencies": {
-        "@khanacademy/kas": "^0.4.11",
-        "@khanacademy/kmath": "^0.3.0",
-        "@khanacademy/perseus-core": "3.2.0"
+        "@khanacademy/kas": "^0.4.12",
+        "@khanacademy/kmath": "^0.3.1",
+        "@khanacademy/perseus-core": "3.3.0"
     },
     "devDependencies": {},
     "peerDependencies": {},