@khanacademy/perseus 20.7.0 → 20.8.0

package/dist/index.d.ts

@@ -65,7 +65,7 @@ export { default as KhanColors } from "./util/colors";
 export { default as preprocessTex } from "./util/katex-preprocess";
 export { registerAllWidgetsForTesting } from "./util/register-all-widgets-for-testing";
 export * as SizingUtils from "./util/sizing-utils";
-export { getAnswersFromWidgets, injectWidgets, } from "./util/extract-perseus-data";
+export { getAnswersFromWidgets, injectWidgets, getWidgetTypeFromWidgetKey, isWrongAnswerSupported, shouldHaveIndividualAnswer, isWidgetKeyInContent, getValidWidgetKeys, getCorrectAnswerForWidgetKey, getAnswerFromUserInput, } from "./util/extract-perseus-data";
 export { parsePerseusItem } from "./util/parse-perseus-json";
 export { generateTestPerseusItem, genericPerseusItemData, } from "./util/test-utils";
 export { convertWidgetNameToEnum, getWidgetTypeFromWidgetId, } from "./util/widget-enum-utils";

package/dist/index.js

@@ -41894,7 +41894,7 @@ const init = function (options) {
 
 // This file is processed by a Rollup plugin (replace) to inject the production
 const libName = "@khanacademy/perseus";
-const libVersion = "20.7.0";
+const libVersion = "20.8.0";
 perseusCore.addLibraryVersionToPerseusDebug(libName, libVersion);
 
 const apiVersion = {
@@ -44542,6 +44542,66 @@ function injectWidgets(content, widgets) {
   return context;
 }
 
+/* Widgets that have individual answers */
+const INDIVIDUAL_ANSWER_WIDGETS = ["interactive-graph", "categorizer", "grapher"];
+
+/* Widgets that are supported for automatic scoring */
+const SUPPORTED_WIDGETS = ["radio", "numeric-input", "input-number", "expression", ...INDIVIDUAL_ANSWER_WIDGETS];
+const getWidgetTypeFromWidgetKey = widgetKey => {
+  return widgetKey.split(" ")[0];
+};
+
+/* Verify if the perseus item has supported widgets for automatic scoring */
+const isWrongAnswerSupported = widgetKeys => {
+  return widgetKeys.length !== 0 && widgetKeys.every(widgetKey => SUPPORTED_WIDGETS.includes(getWidgetTypeFromWidgetKey(widgetKey)));
+};
+
+/* Verify if the widget key has an individual answer for the coach report view  */
+const shouldHaveIndividualAnswer = widgetKey => {
+  return INDIVIDUAL_ANSWER_WIDGETS.includes(getWidgetTypeFromWidgetKey(widgetKey));
+};
+
+/* Returns the answer userInput submission for currently supported widgets */
+// TODO (LEMS-1834): Fix userInput any types to be specific
+const getAnswerFromUserInput = (widgetType, userInput) => {
+  switch (widgetType) {
+    case "categorizer":
+      return userInput.values;
+    case "input-number":
+      return userInput.currentValue;
+    case "numeric-input":
+      return userInput.currentValue;
+    case "radio":
+      return userInput.choicesSelected;
+  }
+  return userInput;
+};
+
+/* Returns the correct answer for a given widget key and Perseus Item */
+// TODO (LEMS-1835): We should fix the resonse type from getWidget to be specific.
+// TODO (LEMS-1836): We should also consider adding the getOneCorrectAnswerFromRubric method to all widgets.
+const getCorrectAnswerForWidgetKey = (widgetKey, itemData) => {
+  const rubric = itemData.question.widgets[widgetKey].options;
+  const widgetType = getWidgetTypeFromWidgetKey(widgetKey);
+  const widget = getWidget(widgetType);
+
+  // @ts-expect-error - TS2339 - Property 'getOneCorrectAnswerFromRubric' does not exist on type 'ComponentType<any>'.
+  return widget?.getOneCorrectAnswerFromRubric?.(rubric);
+};
+
+/* Verify if the widget key exists in the content string of the Perseus Item */
+const isWidgetKeyInContent = (perseusItem, widgetKey) => {
+  return perseusItem.question.content.indexOf(widgetKey) !== -1;
+};
+
+/* Return an array of all the widget keys that exist in the content string of a Perseus Item */
+const getValidWidgetKeys = perseusItem => {
+  const {
+    widgets
+  } = perseusItem.question;
+  return wonderStuffCore.keys(widgets).filter(key => isWidgetKeyInContent(perseusItem, key));
+};
+
 /**
  * Helper to parse PerseusItem JSON
  * Why not just use JSON.parse? We want:
@@ -44873,9 +44933,13 @@ exports.generateTestPerseusItem = generateTestPerseusItem;
 exports.genericPerseusItemData = genericPerseusItemData;
 exports.getAllWidgetIds = getAllWidgetIds;
 exports.getAllWidgetTypes = getAllWidgetTypes;
+exports.getAnswerFromUserInput = getAnswerFromUserInput;
 exports.getAnswersFromWidgets = getAnswersFromWidgets;
+exports.getCorrectAnswerForWidgetKey = getCorrectAnswerForWidgetKey;
 exports.getQuestionWidgetIds = getQuestionWidgetIds;
+exports.getValidWidgetKeys = getValidWidgetKeys;
 exports.getWidgetTypeFromWidgetId = getWidgetTypeFromWidgetId;
+exports.getWidgetTypeFromWidgetKey = getWidgetTypeFromWidgetKey;
 exports.globalConstants = globalConstants;
 exports.globalStyles = globalStyles;
 exports.icons = iconPaths;
@@ -44883,6 +44947,8 @@ exports.init = init;
 exports.injectWidgets = injectWidgets;
 exports.interactiveSizes = interactiveSizes$1;
 exports.isItemRenderableByVersion = isItemRenderableByVersion;
+exports.isWidgetKeyInContent = isWidgetKeyInContent;
+exports.isWrongAnswerSupported = isWrongAnswerSupported;
 exports.itemDataVersion = itemDataVersion;
 exports.itemToTree = itemToTree;
 exports.itemVersion = ItemVersion;
@@ -44893,6 +44959,7 @@ exports.plotterPlotTypes = plotterPlotTypes;
 exports.preprocessTex = preprocessTex;
 exports.registerAllWidgetsForTesting = registerAllWidgetsForTesting;
 exports.shapes = shapes;
+exports.shouldHaveIndividualAnswer = shouldHaveIndividualAnswer;
 exports.traverse = traverse;
 exports.violatingWidgets = violatingWidgets;
 exports.widgets = allWidgets;