@khanacademy/perseus-score 8.0.10 → 8.1.0

package/dist/score.d.ts

@@ -1,15 +1,10 @@
 import type { PerseusRenderer, PerseusScore, PerseusWidgetsMap, UserInputMap } from "@khanacademy/perseus-core";
-/**
- * If a widget says that it is empty once it is graded.
- * Trying to encapsulate references to the score format.
- */
-export declare function scoreIsEmpty(score: PerseusScore): boolean;
-export declare function flattenScores(widgetScoreMap: {
-    [widgetId: string]: PerseusScore;
-}): PerseusScore;
 /**
  * score a Perseus item
  *
+ * TODO: this should be named differently -
+ * it's scoring UserInput, not a PerseusItem; also it doesn't take a PerseusItem
+ *
  * @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)

package/dist/util/flatten-scores.d.ts

@@ -0,0 +1,4 @@
+import type { PerseusScore } from "@khanacademy/perseus-core";
+export default function flattenScores(widgetScoreMap: {
+    [widgetId: string]: PerseusScore;
+}): PerseusScore;

package/dist/util/get-scoreable-widgets.d.ts

@@ -0,0 +1,9 @@
+import type { PerseusRenderer, PerseusWidgetsMap } from "@khanacademy/perseus-core";
+/**
+ * Returns the upgraded widgets and the IDs of widgets that should be scored.
+ * Filters out widgets not referenced in content and widgets that are static or ungraded.
+ */
+export default function getScoreableWidgets(perseusRenderData: PerseusRenderer): {
+    upgradedWidgets: PerseusWidgetsMap;
+    scoreableWidgetIds: ReadonlyArray<string>;
+};

package/dist/util/is-widget-scoreable.d.ts

@@ -0,0 +1,6 @@
+import type { PerseusWidget } from "@khanacademy/perseus-core";
+/**
+ * Determines if a widget should be scored/validated.
+ * Widgets that are ungraded or static should not be scored.
+ */
+export default function isWidgetScoreable(widget: PerseusWidget | undefined): boolean;

package/dist/util/score-is-empty.d.ts

@@ -0,0 +1,6 @@
+import type { PerseusScore } from "@khanacademy/perseus-core";
+/**
+ * If a widget says that it is empty once it is graded.
+ * Trying to encapsulate references to the score format.
+ */
+export default function scoreIsEmpty(score: PerseusScore): boolean;

package/dist/validate.d.ts

@@ -1,7 +1,17 @@
-import type { UserInputMap, ValidationDataMap } from "@khanacademy/perseus-core";
+import type { PerseusRenderer, PerseusScore, PerseusWidgetsMap, UserInputMap } from "@khanacademy/perseus-core";
+/**
+ * validate, meant for client-side validation using answerless Perseus data
+ *
+ * @param perseusRenderData - the answerless Perseus data
+ * @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 an invalid "score" if there's invalid input, otherwise null
+ */
+export declare function validateUserInput(perseusRenderData: PerseusRenderer, userInputMap: UserInputMap, locale: string): PerseusScore | null;
 /**
  * Checks the given user input to see if any answerable widgets have not been
  * "filled in" (ie. if they're empty). Another way to think about this
  * function is that its a check to see if we can score the provided input.
  */
-export declare function emptyWidgetsFunctional(widgets: ValidationDataMap, widgetIds: ReadonlyArray<string>, userInputMap: UserInputMap, locale: string): ReadonlyArray<string>;
+export declare function emptyWidgetsFunctional(widgets: PerseusWidgetsMap, widgetIds: ReadonlyArray<string>, userInputMap: UserInputMap, locale: string): ReadonlyArray<string>;

package/package.json

@@ -3,7 +3,7 @@
   "description": "Perseus score",
   "author": "Khan Academy",
   "license": "MIT",
-  "version": "8.0.10",
+  "version": "8.1.0",
   "publishConfig": {
     "access": "public"
   },
@@ -23,8 +23,8 @@
   ],
   "dependencies": {
     "@khanacademy/kas": "2.1.6",
-    "@khanacademy/kmath": "2.2.21",
-    "@khanacademy/perseus-core": "20.4.1",
+    "@khanacademy/kmath": "2.2.22",
+    "@khanacademy/perseus-core": "21.0.0",
     "@khanacademy/perseus-utils": "2.1.4"
   },
   "devDependencies": {