@khanacademy/perseus-core 5.4.0 → 5.4.2

package/dist/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var _ = require('underscore');
 var KAS = require('@khanacademy/kas');
-var perseusCore = require('@khanacademy/perseus-core');
+var perseusUtils = require('@khanacademy/perseus-utils');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -1993,6 +1993,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
@@ -2277,7 +2286,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,
@@ -2292,12 +2315,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,
@@ -2306,7 +2324,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
   })))
 }));
 
@@ -2762,10 +2780,10 @@ const parsePerseusItem$1 = object({
   question: parsePerseusRenderer,
   hints: defaulted(array(parseHint), () => []),
   answerArea: parsePerseusAnswerArea,
-  itemDataVersion: optional(object({
+  itemDataVersion: optional(nullable(object({
     major: number,
     minor: number
-  })),
+  }))),
   // Deprecated field
   answer: any
 });
@@ -2842,51 +2860,10 @@ function throwErrorIfCheatingDetected() {
   }
 }
 
-/**
- * Adds the given perseus library version information to the __perseus_debug__
- * object and ensures that the object is attached to `globalThis` (`window` in
- * browser environments).
- *
- * This allows each library to provide runtime version information to assist in
- * debugging in production environments.
- */
-const addLibraryVersionToPerseusDebug = (libraryName, libraryVersion) => {
-  // If the library version is the default value, then we don't want to
-  // prefix it with a "v" to indicate that it is a version number.
-  let prefix = "v";
-  if (libraryVersion === "__lib_version__") {
-    prefix = "";
-  }
-  const formattedVersion = `${prefix}${libraryVersion}`;
-  if (typeof globalThis !== "undefined") {
-    globalThis.__perseus_debug__ = globalThis.__perseus_debug__ ?? {};
-    const existingVersionEntry = globalThis.__perseus_debug__[libraryName];
-    if (existingVersionEntry) {
-      // If we already have an entry and it doesn't match the registered
-      // version, we morph the entry into an array and log a warning.
-      if (existingVersionEntry !== formattedVersion) {
-        // Existing entry might be an array already (oops, at least 2
-        // versions of the library already loaded!).
-        const allVersions = Array.isArray(existingVersionEntry) ? existingVersionEntry : [existingVersionEntry];
-        allVersions.push(formattedVersion);
-        globalThis.__perseus_debug__[libraryName] = allVersions;
-
-        // eslint-disable-next-line no-console
-        console.warn(`Multiple versions of ${libraryName} loaded on this page: ${allVersions.sort().join(", ")}`);
-      }
-    } else {
-      globalThis.__perseus_debug__[libraryName] = formattedVersion;
-    }
-  } else {
-    // eslint-disable-next-line no-console
-    console.warn(`globalThis not found found (${formattedVersion})`);
-  }
-};
-
 // This file is processed by a Rollup plugin (replace) to inject the production
 const libName = "@khanacademy/perseus-core";
-const libVersion = "5.4.0";
-addLibraryVersionToPerseusDebug(libName, libVersion);
+const libVersion = "5.4.2";
+perseusUtils.addLibraryVersionToPerseusDebug(libName, libVersion);
 
 /**
  * @typedef {Object} Errors utility for referencing the Perseus error taxonomy.
@@ -3369,20 +3346,74 @@ const labelImageWidgetLogic = {
   getPublicWidgetOptions: getLabelImagePublicWidgetOptions
 };
 
+/* Note(tamara): Brought over from the perseus package packages/perseus/src/util.ts file.
+    May be useful to bring other perseus package utilities here. Contains utility functions
+    and types used across multiple widgets for randomization and shuffling. */
+const seededRNG = function (seed) {
+  let randomSeed = seed;
+  return function () {
+    // Robert Jenkins' 32 bit integer hash function.
+    let seed = randomSeed;
+    seed = seed + 0x7ed55d16 + (seed << 12) & 0xffffffff;
+    seed = (seed ^ 0xc761c23c ^ seed >>> 19) & 0xffffffff;
+    seed = seed + 0x165667b1 + (seed << 5) & 0xffffffff;
+    seed = (seed + 0xd3a2646c ^ seed << 9) & 0xffffffff;
+    seed = seed + 0xfd7046c5 + (seed << 3) & 0xffffffff;
+    seed = (seed ^ 0xb55a4f09 ^ seed >>> 16) & 0xffffffff;
+    return (randomSeed = seed & 0xfffffff) / 0x10000000;
+  };
+};
+
+// Shuffle an array using a given random seed or function.
+// If `ensurePermuted` is true, the input and output are guaranteed to be
+// distinct permutations.
+function shuffle(array, randomSeed) {
+  let ensurePermuted = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+  // Always return a copy of the input array
+  const shuffled = ___default["default"].clone(array);
+
+  // Handle edge cases (input array is empty or uniform)
+  if (!shuffled.length || ___default["default"].all(shuffled, function (value) {
+    return ___default["default"].isEqual(value, shuffled[0]);
+  })) {
+    return shuffled;
+  }
+  let random;
+  if (typeof randomSeed === "function") {
+    random = randomSeed;
+  } else {
+    random = seededRNG(randomSeed);
+  }
+  do {
+    // Fischer-Yates shuffle
+    for (let top = shuffled.length; top > 0; top--) {
+      const newEnd = Math.floor(random() * top);
+      const temp = shuffled[newEnd];
+
+      // @ts-expect-error - TS2542 - Index signature in type 'readonly T[]' only permits reading.
+      shuffled[newEnd] = shuffled[top - 1];
+      // @ts-expect-error - TS2542 - Index signature in type 'readonly T[]' only permits reading.
+      shuffled[top - 1] = temp;
+    }
+  } while (ensurePermuted && ___default["default"].isEqual(array, shuffled));
+  return shuffled;
+}
+const random = seededRNG(new Date().getTime() & 0xffffffff);
+
 // TODO(LEMS-2841): Should be able to remove once getPublicWidgetOptions is hooked up
 
 // TODO(LEMS-2841): Should be able to remove once getPublicWidgetOptions is hooked up
 const shuffleMatcher = props => {
   // Use the same random() function to shuffle both columns sequentially
-  const rng = perseusCore.seededRNG(props.problemNum);
+  const rng = seededRNG(props.problemNum);
   let left;
   if (!props.orderMatters) {
     // If the order doesn't matter, don't shuffle the left column
     left = props.left;
   } else {
-    left = perseusCore.shuffle(props.left, rng, /* ensurePermuted */true);
+    left = shuffle(props.left, rng, /* ensurePermuted */true);
   }
-  const right = perseusCore.shuffle(props.right, rng, /* ensurePermuted */true);
+  const right = shuffle(props.right, rng, /* ensurePermuted */true);
   return {
     left,
     right
@@ -3397,9 +3428,9 @@ function shuffleMatcherWithRandom(data) {
     // If the order doesn't matter, don't shuffle the left column
     left = data.left;
   } else {
-    left = perseusCore.shuffle(data.left, Math.random, /* ensurePermuted */true);
+    left = shuffle(data.left, Math.random, /* ensurePermuted */true);
   }
-  const right = perseusCore.shuffle(data.right, Math.random, /* ensurePermuted */true);
+  const right = shuffle(data.right, Math.random, /* ensurePermuted */true);
   return {
     left,
     right
@@ -3789,7 +3820,7 @@ const radioWidgetLogic = {
  * the public options that should be exposed to the client.
  */
 function getSorterPublicWidgetOptions(options) {
-  const shuffledCorrect = perseusCore.shuffle(options.correct, Math.random, /* ensurePermuted */true);
+  const shuffledCorrect = shuffle(options.correct, Math.random, /* ensurePermuted */true);
   return {
     ...options,
     // Note(Tamara): This does not provide correct answer information any longer.
@@ -4089,8 +4120,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) {
   const item = ___default["default"].clone(originalItem);
@@ -4110,60 +4142,6 @@ function splitPerseusItem(originalItem) {
   };
 }
 
-/* Note(tamara): Brought over from the perseus package packages/perseus/src/util.ts file.
-    May be useful to bring other perseus package utilities here. Contains utility functions
-    and types used across multiple widgets for randomization and shuffling. */
-const seededRNG = function (seed) {
-  let randomSeed = seed;
-  return function () {
-    // Robert Jenkins' 32 bit integer hash function.
-    let seed = randomSeed;
-    seed = seed + 0x7ed55d16 + (seed << 12) & 0xffffffff;
-    seed = (seed ^ 0xc761c23c ^ seed >>> 19) & 0xffffffff;
-    seed = seed + 0x165667b1 + (seed << 5) & 0xffffffff;
-    seed = (seed + 0xd3a2646c ^ seed << 9) & 0xffffffff;
-    seed = seed + 0xfd7046c5 + (seed << 3) & 0xffffffff;
-    seed = (seed ^ 0xb55a4f09 ^ seed >>> 16) & 0xffffffff;
-    return (randomSeed = seed & 0xfffffff) / 0x10000000;
-  };
-};
-
-// Shuffle an array using a given random seed or function.
-// If `ensurePermuted` is true, the input and output are guaranteed to be
-// distinct permutations.
-function shuffle(array, randomSeed) {
-  let ensurePermuted = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
-  // Always return a copy of the input array
-  const shuffled = ___default["default"].clone(array);
-
-  // Handle edge cases (input array is empty or uniform)
-  if (!shuffled.length || ___default["default"].all(shuffled, function (value) {
-    return ___default["default"].isEqual(value, shuffled[0]);
-  })) {
-    return shuffled;
-  }
-  let random;
-  if (typeof randomSeed === "function") {
-    random = randomSeed;
-  } else {
-    random = seededRNG(randomSeed);
-  }
-  do {
-    // Fischer-Yates shuffle
-    for (let top = shuffled.length; top > 0; top--) {
-      const newEnd = Math.floor(random() * top);
-      const temp = shuffled[newEnd];
-
-      // @ts-expect-error - TS2542 - Index signature in type 'readonly T[]' only permits reading.
-      shuffled[newEnd] = shuffled[top - 1];
-      // @ts-expect-error - TS2542 - Index signature in type 'readonly T[]' only permits reading.
-      shuffled[top - 1] = temp;
-    }
-  } while (ensurePermuted && ___default["default"].isEqual(array, shuffled));
-  return shuffled;
-}
-const random = seededRNG(new Date().getTime() & 0xffffffff);
-
 exports.CoreWidgetRegistry = coreWidgetRegistry;
 exports.Errors = Errors;
 exports.GrapherUtil = grapherUtil;