@khanacademy/perseus-core 5.4.0 → 5.4.1

package/dist/data-schema.d.ts

@@ -766,10 +766,18 @@ export type PerseusMeasurerWidgetOptions = {
 };
 export type MathFormat = "integer" | "mixed" | "improper" | "proper" | "decimal" | "percent" | "pi";
 export type PerseusNumericInputAnswerForm = {
-    simplify: PerseusNumericInputSimplify | null | undefined;
+    simplify: PerseusNumericInputSimplify;
     name: MathFormat;
 };
-export type PerseusNumericInputSimplify = "required" | "correct" | "enforced" | "optional";
+/**
+ * Determines how unsimplified fractions are scored.
+ *
+ * - "required" means unsimplified fractions are considered invalid input, and
+ *   the learner can try again.
+ * - "enforced" means unsimplified fractions are marked incorrect.
+ * - "optional" means unsimplified fractions are accepted.
+ */
+export type PerseusNumericInputSimplify = "required" | "enforced" | "optional";
 export type PerseusNumericInputWidgetOptions = {
     answers: ReadonlyArray<PerseusNumericInputAnswer>;
     labelText?: string | undefined;
@@ -785,7 +793,7 @@ export type PerseusNumericInputAnswer = {
     answerForms?: ReadonlyArray<MathFormat>;
     strict: boolean;
     maxError: number | null | undefined;
-    simplify: PerseusNumericInputSimplify | null | undefined;
+    simplify: PerseusNumericInputSimplify;
 };
 export type PerseusNumberLineWidgetOptions = {
     range: ReadonlyArray<number>;

package/dist/es/index.js

@@ -1959,6 +1959,15 @@ const lockedFigureFillStyles = {
 
 // Not associated with a specific figure
 
+/**
+ * Determines how unsimplified fractions are scored.
+ *
+ * - "required" means unsimplified fractions are considered invalid input, and
+ *   the learner can try again.
+ * - "enforced" means unsimplified fractions are marked incorrect.
+ * - "optional" means unsimplified fractions are accepted.
+ */
+
 const plotterPlotTypes = ["bar", "line", "pic", "histogram", "dotplot"];
 
 // Used to represent 2-D points and ranges
@@ -2243,7 +2252,21 @@ const parseNumberLineWidget = parseWidget(constant("number-line"), object({
 }));
 
 const parseMathFormat = enumeration("integer", "mixed", "improper", "proper", "decimal", "percent", "pi");
-const parseSimplify = enumeration("required", "correct", "enforced", "optional");
+const parseSimplify = pipeParsers(union(constant(null)).or(constant(undefined)).or(boolean).or(constant("required")).or(constant("correct")).or(constant("enforced")).or(constant("optional")).or(constant("accepted")).parser).then(convert(deprecatedSimplifyValuesToRequired)).parser;
+function deprecatedSimplifyValuesToRequired(simplify) {
+  switch (simplify) {
+    case "enforced":
+    case "required":
+    case "optional":
+      return simplify;
+    // NOTE(benchristel): "accepted", "correct", true, false, undefined, and
+    // null are all treated the same as "required" during scoring, so we
+    // convert them to "required" here to preserve behavior. See the tests
+    // in score-numeric-input.test.ts
+    default:
+      return "required";
+  }
+}
 const parseNumericInputWidget = parseWidget(constant("numeric-input"), object({
   answers: array(object({
     message: string,
@@ -2258,12 +2281,7 @@ const parseNumericInputWidget = parseWidget(constant("numeric-input"), object({
     // TODO(benchristel): simplify should never be a boolean, but we
     // have some content where it is anyway. If we ever backfill
     // the data, we should simplify `simplify`.
-    simplify: optional(nullable(union(parseSimplify).or(pipeParsers(boolean).then(convert(value => {
-      if (typeof value === "boolean") {
-        return value ? "required" : "optional";
-      }
-      return value;
-    })).parser).parser))
+    simplify: parseSimplify
   })),
   labelText: optional(string),
   size: string,
@@ -2272,7 +2290,7 @@ const parseNumericInputWidget = parseWidget(constant("numeric-input"), object({
   static: defaulted(boolean, () => false),
   answerForms: optional(array(object({
     name: parseMathFormat,
-    simplify: optional(nullable(enumeration("required", "correct", "enforced", "optional")))
+    simplify: parseSimplify
   })))
 }));
 
@@ -2844,7 +2862,7 @@ const addLibraryVersionToPerseusDebug = (libraryName, libraryVersion) => {
 
 // This file is processed by a Rollup plugin (replace) to inject the production
 const libName = "@khanacademy/perseus-core";
-const libVersion = "5.4.0";
+const libVersion = "5.4.1";
 addLibraryVersionToPerseusDebug(libName, libVersion);
 
 /**
@@ -4025,8 +4043,9 @@ function getUpgradedWidgetOptions(oldWidgetOptions) {
 }
 
 /**
- * Upgrades widget options and removes answerful data for all the widgets in a
- * Perseus item.
+ * Return a copy of a Perseus item with rubric data removed (ie answers)
+ *
+ * @param originalItem - the original, full Perseus item (which includes the rubric - aka answer data)
  */
 function splitPerseusItem(originalItem) {
   var _item$widgets;