@khanacademy/perseus-score 8.9.2 → 8.10.1

package/dist/score.d.ts

@@ -1,4 +1,25 @@
 import type { PerseusRenderer, PerseusScore, PerseusWidgetsMap, UserInputMap } from "@khanacademy/perseus-core";
+type WidgetScores = {
+    [widgetId: string]: PerseusScore;
+};
+type PerseusScoreWithWidgetScores = PerseusScore & {
+    /**
+     * The per-widget scores, keyed by widget ID, that contributed to the
+     * item's overall score (see the `earned` and `total` fields).
+     */
+    widgetScores: WidgetScores;
+};
+/**
+ * Filters the given widget `scores` dictionary and returns only widget scores
+ * that are invalid.
+ */
+export declare function onlyInvalidScores(scores: WidgetScores): WidgetScores;
+/**
+ * Combines an overall score with constituent widget scores. Takes into account
+ * if the overall score is invalid and strips out any widget scores that are
+ * not `invalid` to protect against leaking correctness.
+ */
+export declare function combineScoreWithWidgetScores(score: PerseusScore, widgetScores: WidgetScores): PerseusScoreWithWidgetScores;
 /**
  * score a Perseus item
  *
@@ -8,13 +29,19 @@ import type { PerseusRenderer, PerseusScore, PerseusWidgetsMap, UserInputMap } f
  * @param perseusRenderData - the full answer data, includes the correct answer
  * @param userInputMap - the user's input for each widget, mapped by ID
  * @param locale - string locale for math parsing ("de" 1.000,00 vs "en" 1,000.00)
+ *
+ * @returns The full {@link PerseusScore} as well as widget-level scores which
+ * can be used to analyze which parts of the question the learner got correct
+ * vs. incorrect. When the score result is "invalid", only "invalid" widget
+ * scores are included in `widgetScores`.
  */
-export declare function scorePerseusItem(perseusRenderData: PerseusRenderer, userInputMap: UserInputMap, locale: string): PerseusScore;
+export declare function scorePerseusItem(perseusRenderData: PerseusRenderer, userInputMap: UserInputMap, locale: string): PerseusScoreWithWidgetScores;
 /**
  * @experimental - this is a temporary function for use by the Input Number to
  * Numeric Input project. It will be removed in a future minor version.
  */
-export declare function scorePerseusItemWithInputNumberAsNumericInput(perseusRenderData: PerseusRenderer, userInputMap: UserInputMap, locale: string): PerseusScore;
+export declare function scorePerseusItemWithInputNumberAsNumericInput(perseusRenderData: PerseusRenderer, userInputMap: UserInputMap, locale: string): PerseusScoreWithWidgetScores;
 export declare function scoreWidgetsFunctional(widgets: PerseusWidgetsMap, widgetIds: ReadonlyArray<string>, userInputMap: UserInputMap, locale: string): {
     [widgetId: string]: PerseusScore;
 };
+export {};

package/package.json

@@ -3,7 +3,7 @@
   "description": "Perseus score",
   "author": "Khan Academy",
   "license": "MIT",
-  "version": "8.9.2",
+  "version": "8.10.1",
   "publishConfig": {
     "access": "public"
   },
@@ -23,8 +23,8 @@
   ],
   "dependencies": {
     "@khanacademy/kas": "2.2.3",
-    "@khanacademy/kmath": "2.4.9",
-    "@khanacademy/perseus-core": "26.2.0",
+    "@khanacademy/kmath": "2.4.11",
+    "@khanacademy/perseus-core": "26.3.1",
     "@khanacademy/perseus-utils": "2.1.5"
   },
   "devDependencies": {