@khanacademy/perseus 45.1.0 → 46.0.0

package/dist/index.d.ts

@@ -31,6 +31,7 @@ export { default as MatrixWidget } from "./widgets/matrix";
 export { default as TableWidget } from "./widgets/table";
 export { default as PlotterWidget } from "./widgets/plotter";
 export { default as GrapherWidget } from "./widgets/grapher";
+import { keScoreFromPerseusScore } from "./util/scoring";
 export declare const GrapherUtil: {
     allTypes: any;
     DEFAULT_GRAPHER_PROPS: any;
@@ -39,6 +40,9 @@ export declare const GrapherUtil: {
     getEquationString: (props: any) => string;
     typeToButton: (type: "linear" | "absolute_value" | "exponential" | "logarithm" | "quadratic" | "sinusoid" | "tangent") => any;
 };
+export declare const ScoringUtil: {
+    keScoreFromPerseusScore: typeof keScoreFromPerseusScore;
+};
 /**
  * Misc
  */

package/dist/index.js

@@ -2915,12 +2915,6 @@ const rWidgetRule = /^\[\[\u2603 (([a-z-]+) ([0-9]+))\]\]/;
 const rTypeFromWidgetId = /^([a-z-]+) ([0-9]+)$/;
 const rWidgetParts = new RegExp(rWidgetRule.source + "$");
 const snowman = "\u2603";
-const noScore = {
-  type: "points",
-  earned: 0,
-  total: 0,
-  message: null
-};
 const seededRNG$1 = function (seed) {
   let randomSeed = seed;
   return function () {
@@ -2998,97 +2992,6 @@ const split = "x".split(/(.)/g).length ? function (str, r) {
   return output;
 };
 
-/**
- * Combine two score objects.
- *
- * Given two score objects for two different widgets, combine them so that
- * if one is wrong, the total score is wrong, etc.
- */
-function combineScores(scoreA, scoreB) {
-  let message;
-  if (scoreA.type === "points" && scoreB.type === "points") {
-    if (scoreA.message && scoreB.message && scoreA.message !== scoreB.message) {
-      // TODO(alpert): Figure out how to combine messages usefully
-      message = null;
-    } else {
-      message = scoreA.message || scoreB.message;
-    }
-    return {
-      type: "points",
-      earned: scoreA.earned + scoreB.earned,
-      total: scoreA.total + scoreB.total,
-      message: message
-    };
-  }
-  if (scoreA.type === "points" && scoreB.type === "invalid") {
-    return scoreB;
-  }
-  if (scoreA.type === "invalid" && scoreB.type === "points") {
-    return scoreA;
-  }
-  if (scoreA.type === "invalid" && scoreB.type === "invalid") {
-    if (scoreA.message && scoreB.message && scoreA.message !== scoreB.message) {
-      // TODO(alpert): Figure out how to combine messages usefully
-      message = null;
-    } else {
-      message = scoreA.message || scoreB.message;
-    }
-    return {
-      type: "invalid",
-      message: message
-    };
-  }
-
-  /**
-   * The above checks cover all combinations of score type, so if we get here
-   * then something is amiss with our inputs.
-   */
-  throw new perseusCore.PerseusError("PerseusScore with unknown type encountered", perseusCore.Errors.InvalidInput, {
-    metadata: {
-      scoreA: JSON.stringify(scoreA),
-      scoreB: JSON.stringify(scoreB)
-    }
-  });
-}
-function flattenScores(widgetScoreMap) {
-  return Object.values(widgetScoreMap).reduce(combineScores, noScore);
-}
-function isCorrect(score) {
-  return score.type === "points" && score.earned >= score.total;
-}
-function keScoreFromPerseusScore(score,
-// It's weird, but this is what we're passing it
-guess, state) {
-  if (score.type === "points") {
-    return {
-      empty: false,
-      correct: isCorrect(score),
-      message: score.message,
-      guess: guess,
-      state: state
-    };
-  }
-  if (score.type === "invalid") {
-    return {
-      empty: true,
-      correct: false,
-      message: score.message,
-      suppressAlmostThere: score.suppressAlmostThere,
-      guess: guess,
-      state: state
-    };
-  }
-  throw new perseusCore.PerseusError(
-  // @ts-expect-error - TS2339 - Property 'type' does not exist on type 'never'.
-  "Invalid score type: " + score.type, perseusCore.Errors.InvalidInput, {
-    metadata: {
-      score: JSON.stringify(score),
-      guess: JSON.stringify(guess),
-      state: JSON.stringify(state)
-    }
-  });
-}
-
 /**
  * Return the first valid interpretation of 'text' as a number, in the form
  * {value: 2.3, exact: true}.
@@ -3386,28 +3289,6 @@ function strongEncodeURIComponent(str) {
   .replace(/\*/g, "%2A");
 }
 
-/**
- * If a widget says that it is empty once it is graded.
- * Trying to encapsulate references to the score format.
- */
-function scoreIsEmpty(score) {
-  // HACK(benkomalo): ugh. this isn't great; the Perseus score objects
-  // overload the type "invalid" for what should probably be three
-  // distinct cases:
-  //  - truly empty or not fully filled out
-  //  - invalid or malformed inputs
-  //  - "almost correct" like inputs where the widget wants to give
-  //  feedback (e.g. a fraction needs to be reduced, or `pi` should
-  //  be used instead of 3.14)
-  //
-  //  Unfortunately the coercion happens all over the place, as these
-  //  Perseus style score objects are created *everywhere* (basically
-  //  in every widget), so it's hard to change now. We assume that
-  //  anything with a "message" is not truly empty, and one of the
-  //  latter two cases for now.
-  return score.type === "invalid" && (!score.message || score.message.length === 0);
-}
-
 /*
  * The touchHandlers are used to track the current state of the touch
  * event, such as whether or not the user is currently pressed down (either
@@ -3580,13 +3461,9 @@ const Util = {
   rTypeFromWidgetId,
   rWidgetParts,
   snowman,
-  noScore,
   seededRNG: seededRNG$1,
   shuffle: shuffle$3,
   split,
-  combineScores,
-  flattenScores,
-  keScoreFromPerseusScore,
   firstNumericalParse: firstNumericalParse$1,
   stringArrayOfSize: stringArrayOfSize$1,
   gridDimensionConfig,
@@ -3602,7 +3479,6 @@ const Util = {
   parseQueryString,
   updateQueryString: updateQueryString$2,
   strongEncodeURIComponent,
-  scoreIsEmpty,
   touchHandlers,
   resetTouchHandlers,
   extractPointerLocation,
@@ -18902,6 +18778,126 @@ class QuestionParagraph extends React__namespace.Component {
   }
 }
 
+const noScore = {
+  type: "points",
+  earned: 0,
+  total: 0,
+  message: null
+};
+
+/**
+ * If a widget says that it is empty once it is graded.
+ * Trying to encapsulate references to the score format.
+ */
+function scoreIsEmpty(score) {
+  // HACK(benkomalo): ugh. this isn't great; the Perseus score objects
+  // overload the type "invalid" for what should probably be three
+  // distinct cases:
+  //  - truly empty or not fully filled out
+  //  - invalid or malformed inputs
+  //  - "almost correct" like inputs where the widget wants to give
+  //  feedback (e.g. a fraction needs to be reduced, or `pi` should
+  //  be used instead of 3.14)
+  //
+  //  Unfortunately the coercion happens all over the place, as these
+  //  Perseus style score objects are created *everywhere* (basically
+  //  in every widget), so it's hard to change now. We assume that
+  //  anything with a "message" is not truly empty, and one of the
+  //  latter two cases for now.
+  return score.type === "invalid" && (!score.message || score.message.length === 0);
+}
+
+/**
+ * Combine two score objects.
+ *
+ * Given two score objects for two different widgets, combine them so that
+ * if one is wrong, the total score is wrong, etc.
+ */
+function combineScores(scoreA, scoreB) {
+  let message;
+  if (scoreA.type === "points" && scoreB.type === "points") {
+    if (scoreA.message && scoreB.message && scoreA.message !== scoreB.message) {
+      // TODO(alpert): Figure out how to combine messages usefully
+      message = null;
+    } else {
+      message = scoreA.message || scoreB.message;
+    }
+    return {
+      type: "points",
+      earned: scoreA.earned + scoreB.earned,
+      total: scoreA.total + scoreB.total,
+      message: message
+    };
+  }
+  if (scoreA.type === "points" && scoreB.type === "invalid") {
+    return scoreB;
+  }
+  if (scoreA.type === "invalid" && scoreB.type === "points") {
+    return scoreA;
+  }
+  if (scoreA.type === "invalid" && scoreB.type === "invalid") {
+    if (scoreA.message && scoreB.message && scoreA.message !== scoreB.message) {
+      // TODO(alpert): Figure out how to combine messages usefully
+      message = null;
+    } else {
+      message = scoreA.message || scoreB.message;
+    }
+    return {
+      type: "invalid",
+      message: message
+    };
+  }
+
+  /**
+   * The above checks cover all combinations of score type, so if we get here
+   * then something is amiss with our inputs.
+   */
+  throw new perseusCore.PerseusError("PerseusScore with unknown type encountered", perseusCore.Errors.InvalidInput, {
+    metadata: {
+      scoreA: JSON.stringify(scoreA),
+      scoreB: JSON.stringify(scoreB)
+    }
+  });
+}
+function flattenScores(widgetScoreMap) {
+  return Object.values(widgetScoreMap).reduce(combineScores, noScore);
+}
+function isCorrect(score) {
+  return score.type === "points" && score.earned >= score.total;
+}
+function keScoreFromPerseusScore(score,
+// It's weird, but this is what we're passing it
+guess, state) {
+  if (score.type === "points") {
+    return {
+      empty: false,
+      correct: isCorrect(score),
+      message: score.message,
+      guess: guess,
+      state: state
+    };
+  }
+  if (score.type === "invalid") {
+    return {
+      empty: true,
+      correct: false,
+      message: score.message,
+      suppressAlmostThere: score.suppressAlmostThere,
+      guess: guess,
+      state: state
+    };
+  }
+  throw new perseusCore.PerseusError(
+  // @ts-expect-error - TS2339 - Property 'type' does not exist on type 'never'.
+  "Invalid score type: " + score.type, perseusCore.Errors.InvalidInput, {
+    metadata: {
+      score: JSON.stringify(score),
+      guess: JSON.stringify(guess),
+      state: JSON.stringify(state)
+    }
+  });
+}
+
 // These are all the current widgets that require user-input and are supported for automatic scoring
 const QUESTION_WIDGETS = ["numeric-input", "input-number", "radio", "interactive-graph", "interactive-number-line", "categorizer", "plotter", "orderer", "protractor", "matcher", "sorter"];
 
@@ -19500,7 +19496,7 @@ widgetIds, userInputMap, strings, locale) {
     const scorer = getWidgetScorer(widget.type);
     const score = scorer?.(userInputMap[id], widget.options, strings, locale);
     if (score) {
-      return Util.scoreIsEmpty(score);
+      return scoreIsEmpty(score);
     }
   });
 }
@@ -19516,7 +19512,7 @@ strings, locale) {
   // so this checks that the widgets are being used before scoring them
   const usedWidgetIds = getWidgetIdsFromContent(perseusRenderData.content);
   const scores = scoreWidgetsFunctional(perseusRenderData.widgets, usedWidgetIds, userInputMap, strings, locale);
-  return Util.flattenScores(scores);
+  return flattenScores(scores);
 }
 function scoreWidgetsFunctional(widgets,
 // This is a port of old code, I'm not sure why
@@ -21102,7 +21098,7 @@ class Renderer extends React__namespace.Component {
    */
   score() {
     const scores = scoreWidgetsFunctional(this.state.widgetInfo, this.widgetIds, this.getUserInputMap(), this.props.strings, this.context.locale);
-    const combinedScore = Util.flattenScores(scores);
+    const combinedScore = flattenScores(scores);
     return combinedScore;
   }
 
@@ -21114,28 +21110,6 @@ class Renderer extends React__namespace.Component {
     const totalScore = this.score();
     return [totalGuess, totalScore];
   };
-  examples = () => {
-    const widgetIds = this.widgetIds;
-    const examples = widgetIds.map(widgetId => {
-      const widget = this.getWidgetInstance(widgetId);
-      return widget != null && widget.examples ? widget.examples() : null;
-    }).filter(Boolean);
-
-    // no widgets with examples
-    if (!examples.length) {
-      return null;
-    }
-    const allEqual = ___default["default"].all(examples, function (example) {
-      return ___default["default"].isEqual(examples[0], example);
-    });
-
-    // some widgets have different examples
-    // TODO(alex): handle this better
-    if (!allEqual) {
-      return null;
-    }
-    return examples[0];
-  };
 
   // TranslationLinter callback
   handletranslationLintErrors = lintErrors => {
@@ -22180,7 +22154,7 @@ class InputNumber extends React__namespace.Component {
   getPromptJSON() {
     return getPromptJSON$s(this.props, this.getUserInput());
   }
-  examples = () => {
+  examples() {
     const {
       strings
     } = this.context;
@@ -22188,7 +22162,7 @@ class InputNumber extends React__namespace.Component {
     const forms = answerTypes[type].forms.split(/\s*,\s*/);
     const examples = ___default["default"].map(forms, form => formExamples$1[form](this.props, strings));
     return [strings.yourAnswer].concat(examples);
-  };
+  }
   render() {
     if (this.props.apiOptions.customKeypad) {
       // TODO(charlie): Support "Review Mode".
@@ -22474,8 +22448,11 @@ class NumericInput extends React__namespace.Component {
     isFocused: false
   };
 
-  // TODO(Nicole, Jeremy): This is maybe never used and should be removed
-  examples = () => {
+  /**
+   * Generates a string that demonstrates how to input the various supported
+   * answer forms.
+   */
+  examples() {
     // if the set of specified forms are empty, allow all forms
     const forms = this.props.answerForms?.length !== 0 ? this.props.answerForms : Object.keys(formExamples).map(name => {
       return {
@@ -22490,7 +22467,7 @@ class NumericInput extends React__namespace.Component {
     // versions of the same format
     examples = ___default["default"].uniq(examples);
     return [this.context.strings.yourAnswer].concat(examples);
-  };
+  }
   shouldShowExamples = () => {
     const noFormsAccepted = this.props.answerForms?.length === 0;
     // To check if all answer forms are accepted, we must first
@@ -29662,7 +29639,7 @@ const getPromptJSON$f = rendererJSON => {
 // it. As such, scoring a group means scoring all widgets it contains.
 function scoreGroup(userInput, options, strings, locale) {
   const scores = scoreWidgetsFunctional(options.widgets, Object.keys(options.widgets), userInput, strings, locale);
-  return Util.flattenScores(scores);
+  return flattenScores(scores);
 }
 
 // exports has no 'transform'
@@ -45479,7 +45456,7 @@ const init = function () {
 
 // This file is processed by a Rollup plugin (replace) to inject the production
 const libName = "@khanacademy/perseus";
-const libVersion = "45.1.0";
+const libVersion = "46.0.0";
 perseusCore.addLibraryVersionToPerseusDebug(libName, libVersion);
 
 const apiVersion = {
@@ -46252,7 +46229,7 @@ class ServerItemRenderer extends React__namespace.Component {
     // TODO(alex): Check whether we rely on the format here for
     //             analyzing ProblemLogs. If not, remove this layer.
     const maxCompatGuess = [this.questionRenderer.getUserInput(), []];
-    const keScore = Util.keScoreFromPerseusScore(score, maxCompatGuess, this.questionRenderer.getSerializedState());
+    const keScore = keScoreFromPerseusScore(score, maxCompatGuess, this.questionRenderer.getSerializedState());
     const emptyQuestionAreaWidgets = this.questionRenderer.emptyWidgets();
     this.setState({
       questionCompleted: keScore.correct,
@@ -47348,7 +47325,7 @@ class MultiRenderer extends React__namespace.Component {
     if (ref.getSerializedState) {
       state = ref.getSerializedState();
     }
-    return Util.keScoreFromPerseusScore(score, guess, state);
+    return keScoreFromPerseusScore(score, guess, state);
   }
 
   /**
@@ -47377,8 +47354,8 @@ class MultiRenderer extends React__namespace.Component {
       scores.push(data.ref.score());
       return data.ref?.getUserInput();
     });
-    const combinedScore = scores.reduce(Util.combineScores);
-    return Util.keScoreFromPerseusScore(combinedScore, guess, state);
+    const combinedScore = scores.reduce(combineScores);
+    return keScoreFromPerseusScore(combinedScore, guess, state);
   }
 
   /**
@@ -50235,6 +50212,9 @@ const GrapherUtil = {
   getEquationString,
   typeToButton
 };
+const ScoringUtil = {
+  keScoreFromPerseusScore
+};
 
 exports.ApiOptions = ApiOptions;
 exports.ArticleRenderer = ArticleRenderer;
@@ -50268,6 +50248,7 @@ exports.PlotterWidget = Plotter$1;
 exports.QUESTION_WIDGETS = QUESTION_WIDGETS;
 exports.Radio = Radio;
 exports.Renderer = Renderer;
+exports.ScoringUtil = ScoringUtil;
 exports.ServerItemRenderer = ref;
 exports.TableWidget = Table$1;
 exports.Util = Util;