@khanacademy/perseus 45.1.0 → 46.0.0

package/dist/es/index.js

@@ -2793,12 +2793,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 seededRNG(seed) {
   let randomSeed = seed;
   return function () {
@@ -2875,97 +2869,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 PerseusError("PerseusScore with unknown type encountered", 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 PerseusError(
-  // @ts-expect-error - TS2339 - Property 'type' does not exist on type 'never'.
-  "Invalid score type: " + score.type, 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}.
@@ -3263,28 +3166,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
@@ -3459,13 +3340,9 @@ const Util = {
   rTypeFromWidgetId,
   rWidgetParts,
   snowman,
-  noScore,
   seededRNG: seededRNG$1,
   shuffle: shuffle$3,
   split,
-  combineScores,
-  flattenScores,
-  keScoreFromPerseusScore,
   firstNumericalParse: firstNumericalParse$1,
   stringArrayOfSize: stringArrayOfSize$1,
   gridDimensionConfig,
@@ -3481,7 +3358,6 @@ const Util = {
   parseQueryString,
   updateQueryString: updateQueryString$2,
   strongEncodeURIComponent,
-  scoreIsEmpty,
   touchHandlers,
   resetTouchHandlers,
   extractPointerLocation,
@@ -18702,6 +18578,126 @@ class QuestionParagraph extends React.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 PerseusError("PerseusScore with unknown type encountered", 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 PerseusError(
+  // @ts-expect-error - TS2339 - Property 'type' does not exist on type 'never'.
+  "Invalid score type: " + score.type, 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"];
 
@@ -19300,7 +19296,7 @@ widgetIds, userInputMap, strings, locale) {
     const scorer = getWidgetScorer(widget.type);
     const score = scorer == null ? void 0 : scorer(userInputMap[id], widget.options, strings, locale);
     if (score) {
-      return Util.scoreIsEmpty(score);
+      return scoreIsEmpty(score);
     }
   });
 }
@@ -19316,7 +19312,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
@@ -20596,28 +20592,6 @@ class Renderer extends React.Component {
       const totalScore = this.score();
       return [totalGuess, totalScore];
     };
-    this.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 = _.all(examples, function (example) {
-        return _.isEqual(examples[0], example);
-      });
-
-      // some widgets have different examples
-      // TODO(alex): handle this better
-      if (!allEqual) {
-        return null;
-      }
-      return examples[0];
-    };
     // TranslationLinter callback
     this.handletranslationLintErrors = lintErrors => {
       if (!this._isMounted) {
@@ -20868,7 +20842,7 @@ class Renderer extends React.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;
   }
   render() {
@@ -21929,15 +21903,6 @@ class InputNumber extends React.Component {
         currentValue: newValue
       }, cb);
     };
-    this.examples = () => {
-      const {
-        strings
-      } = this.context;
-      const type = this.props.answerType;
-      const forms = answerTypes[type].forms.split(/\s*,\s*/);
-      const examples = _.map(forms, form => formExamples$1[form](this.props, strings));
-      return [strings.yourAnswer].concat(examples);
-    };
   }
   static getUserInputFromProps(props) {
     return {
@@ -21950,6 +21915,15 @@ class InputNumber extends React.Component {
   getPromptJSON() {
     return getPromptJSON$s(this.props, this.getUserInput());
   }
+  examples() {
+    const {
+      strings
+    } = this.context;
+    const type = this.props.answerType;
+    const forms = answerTypes[type].forms.split(/\s*,\s*/);
+    const examples = _.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".
@@ -22232,31 +22206,13 @@ class NumericInput extends React.Component {
       previousValues: [""],
       isFocused: false
     };
-    // TODO(Nicole, Jeremy): This is maybe never used and should be removed
-    this.examples = () => {
-      var _this$props$answerFor;
-      // if the set of specified forms are empty, allow all forms
-      const forms = ((_this$props$answerFor = this.props.answerForms) == null ? void 0 : _this$props$answerFor.length) !== 0 ? this.props.answerForms : Object.keys(formExamples).map(name => {
-        return {
-          name: name,
-          simplify: "required"
-        };
-      });
-      let examples = _.map(forms, form => {
-        return formExamples[form.name](form, this.context.strings);
-      });
-      // Ensure no duplicate tooltip text from simplified and unsimplified
-      // versions of the same format
-      examples = _.uniq(examples);
-      return [this.context.strings.yourAnswer].concat(examples);
-    };
     this.shouldShowExamples = () => {
-      var _this$props$answerFor2, _this$props$answerFor3;
-      const noFormsAccepted = ((_this$props$answerFor2 = this.props.answerForms) == null ? void 0 : _this$props$answerFor2.length) === 0;
+      var _this$props$answerFor, _this$props$answerFor2;
+      const noFormsAccepted = ((_this$props$answerFor = this.props.answerForms) == null ? void 0 : _this$props$answerFor.length) === 0;
       // To check if all answer forms are accepted, we must first
       // find the *names* of all accepted forms, and see if they are
       // all present, ignoring duplicates
-      const answerFormNames = _.uniq((_this$props$answerFor3 = this.props.answerForms) == null ? void 0 : _this$props$answerFor3.map(form => form.name));
+      const answerFormNames = _.uniq((_this$props$answerFor2 = this.props.answerForms) == null ? void 0 : _this$props$answerFor2.map(form => form.name));
       const allFormsAccepted = answerFormNames.length >= Object.keys(formExamples).length;
       return !noFormsAccepted && !allFormsAccepted;
     };
@@ -22313,6 +22269,27 @@ class NumericInput extends React.Component {
       currentValue: props.currentValue
     };
   }
+  /**
+   * Generates a string that demonstrates how to input the various supported
+   * answer forms.
+   */
+  examples() {
+    var _this$props$answerFor3;
+    // if the set of specified forms are empty, allow all forms
+    const forms = ((_this$props$answerFor3 = this.props.answerForms) == null ? void 0 : _this$props$answerFor3.length) !== 0 ? this.props.answerForms : Object.keys(formExamples).map(name => {
+      return {
+        name: name,
+        simplify: "required"
+      };
+    });
+    let examples = _.map(forms, form => {
+      return formExamples[form.name](form, this.context.strings);
+    });
+    // Ensure no duplicate tooltip text from simplified and unsimplified
+    // versions of the same format
+    examples = _.uniq(examples);
+    return [this.context.strings.yourAnswer].concat(examples);
+  }
   getUserInput() {
     return NumericInput.getUserInputFromProps(this.props);
   }
@@ -29384,7 +29361,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'
@@ -45109,7 +45086,7 @@ const init = function init() {
 
 // 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";
 addLibraryVersionToPerseusDebug(libName, libVersion);
 
 const apiVersion = {
@@ -45884,7 +45861,7 @@ class ServerItemRenderer extends React.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,
@@ -46963,7 +46940,7 @@ class MultiRenderer extends React.Component {
     if (ref.getSerializedState) {
       state = ref.getSerializedState();
     }
-    return Util.keScoreFromPerseusScore(score, guess, state);
+    return keScoreFromPerseusScore(score, guess, state);
   }
 
   /**
@@ -46993,8 +46970,8 @@ class MultiRenderer extends React.Component {
       scores.push(data.ref.score());
       return (_data$ref = data.ref) == null ? void 0 : _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);
   }
 
   /**
@@ -49837,6 +49814,9 @@ const GrapherUtil = {
   getEquationString,
   typeToButton
 };
+const ScoringUtil = {
+  keScoreFromPerseusScore
+};
 
-export { ApiOptions, ArticleRenderer, BaseRadio, Categorizer$1 as Categorizer, changeable as Changeable, ClassNames, dependencies as Dependencies, EditorJsonify, Expression, GrapherUtil, Grapher$1 as GrapherWidget, HintRenderer, HintsRenderer, InputNumber$1 as InputNumber, InteractiveGraph$1 as InteractiveGraphWidget, ItemExtras, JiptParagraphs, KhanColors, KhanMath, context as LoadingContext, Log, Matrix$1 as MatrixWidget, MultiItems, NumericInput$1 as NumericInput, PerseusExpressionAnswerFormConsidered, PerseusI18nContext, PerseusI18nContextProvider, PerseusMarkdown, Plotter$1 as PlotterWidget, QUESTION_WIDGETS, Radio, Renderer, ref as ServerItemRenderer, Table$1 as TableWidget, Util, denylist as WIDGET_PROP_DENYLIST, widgets$1 as Widgets, addWidget, apiVersion, bodyXsmallBold, buildEmptyItemTreeForShape, buildMapper, components, containerSizeClass, contentHasWidgetType, convertWidgetNameToEnum, displaySigFigs, generateTestCategorizerWidget, generateTestExpressionWidget, generateTestInteractiveGraphWidget, generateTestNumericInputWidget, generateTestPerseusItem, generateTestRadioWidget, genericPerseusItemData, getAngleCoords, getAnswerFromUserInput, getAnswersFromWidgets, getCircleCoords, getClockwiseAngle, getCorrectAnswerForWidgetId, getImagesWithoutAltData, getInteractiveBoxFromSizeClass, getLineCoords, getLinearSystemCoords, getPointCoords, getPolygonCoords, getQuadraticCoords, getSegmentCoords, getSinusoidCoords, getValidWidgetIds, getWidgetFromWidgetMap, getWidgetIdsFromContent, getWidgetIdsFromContentByType, getWidgetTypeByWidgetId, getWidgetsFromWidgetMap, getWidgetsMapFromItemData, iconChevronDown, iconTrash, init, injectWidgets, interactiveSizes$1 as interactiveSizes, isItemRenderableByVersion, isWidgetIdInContent, isWrongAnswerSupported, itemDataVersion, itemToTree, ItemVersion as itemVersion, libVersion, lockedFigureColors, lockedFigureFillStyles, makeSafeUrl, mathOnlyParser, mediaQueries, parsePerseusItem, plotterPlotTypes, preprocessTex, registerAllWidgetsForTesting, scorePerseusItem, shapes, shouldHaveIndividualAnswer, traverse, usePerseusI18n, violatingWidgets, allWidgets as widgets };
+export { ApiOptions, ArticleRenderer, BaseRadio, Categorizer$1 as Categorizer, changeable as Changeable, ClassNames, dependencies as Dependencies, EditorJsonify, Expression, GrapherUtil, Grapher$1 as GrapherWidget, HintRenderer, HintsRenderer, InputNumber$1 as InputNumber, InteractiveGraph$1 as InteractiveGraphWidget, ItemExtras, JiptParagraphs, KhanColors, KhanMath, context as LoadingContext, Log, Matrix$1 as MatrixWidget, MultiItems, NumericInput$1 as NumericInput, PerseusExpressionAnswerFormConsidered, PerseusI18nContext, PerseusI18nContextProvider, PerseusMarkdown, Plotter$1 as PlotterWidget, QUESTION_WIDGETS, Radio, Renderer, ScoringUtil, ref as ServerItemRenderer, Table$1 as TableWidget, Util, denylist as WIDGET_PROP_DENYLIST, widgets$1 as Widgets, addWidget, apiVersion, bodyXsmallBold, buildEmptyItemTreeForShape, buildMapper, components, containerSizeClass, contentHasWidgetType, convertWidgetNameToEnum, displaySigFigs, generateTestCategorizerWidget, generateTestExpressionWidget, generateTestInteractiveGraphWidget, generateTestNumericInputWidget, generateTestPerseusItem, generateTestRadioWidget, genericPerseusItemData, getAngleCoords, getAnswerFromUserInput, getAnswersFromWidgets, getCircleCoords, getClockwiseAngle, getCorrectAnswerForWidgetId, getImagesWithoutAltData, getInteractiveBoxFromSizeClass, getLineCoords, getLinearSystemCoords, getPointCoords, getPolygonCoords, getQuadraticCoords, getSegmentCoords, getSinusoidCoords, getValidWidgetIds, getWidgetFromWidgetMap, getWidgetIdsFromContent, getWidgetIdsFromContentByType, getWidgetTypeByWidgetId, getWidgetsFromWidgetMap, getWidgetsMapFromItemData, iconChevronDown, iconTrash, init, injectWidgets, interactiveSizes$1 as interactiveSizes, isItemRenderableByVersion, isWidgetIdInContent, isWrongAnswerSupported, itemDataVersion, itemToTree, ItemVersion as itemVersion, libVersion, lockedFigureColors, lockedFigureFillStyles, makeSafeUrl, mathOnlyParser, mediaQueries, parsePerseusItem, plotterPlotTypes, preprocessTex, registerAllWidgetsForTesting, scorePerseusItem, shapes, shouldHaveIndividualAnswer, traverse, usePerseusI18n, violatingWidgets, allWidgets as widgets };
 //# sourceMappingURL=index.js.map