@khanacademy/perseus-core 5.4.0 → 5.4.2

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

@@ -2,7 +2,7 @@ import _ from 'underscore';
 import _extends from '@babel/runtime/helpers/extends';
 import * as KAS from '@khanacademy/kas';
 import _objectWithoutPropertiesLoose from '@babel/runtime/helpers/objectWithoutPropertiesLoose';
-import { seededRNG as seededRNG$1, shuffle as shuffle$1 } from '@khanacademy/perseus-core';
+import { addLibraryVersionToPerseusDebug } from '@khanacademy/perseus-utils';
 
 function getMatrixSize(matrix) {
   const matrixSize = [1, 1];
@@ -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
   })))
 }));
 
@@ -2720,10 +2738,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
 });
@@ -2800,51 +2818,9 @@ 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") {
-    var _globalThis$__perseus;
-    globalThis.__perseus_debug__ = (_globalThis$__perseus = globalThis.__perseus_debug__) != null ? _globalThis$__perseus : {};
-    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";
+const libVersion = "5.4.2";
 addLibraryVersionToPerseusDebug(libName, libVersion);
 
 /**
@@ -3321,20 +3297,73 @@ 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 seededRNG(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, ensurePermuted = false) {
+  // Always return a copy of the input array
+  const shuffled = _.clone(array);
+
+  // Handle edge cases (input array is empty or uniform)
+  if (!shuffled.length || _.all(shuffled, function (value) {
+    return _.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 && _.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 = seededRNG$1(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 = shuffle$1(props.left, rng, /* ensurePermuted */true);
+    left = shuffle(props.left, rng, /* ensurePermuted */true);
   }
-  const right = shuffle$1(props.right, rng, /* ensurePermuted */true);
+  const right = shuffle(props.right, rng, /* ensurePermuted */true);
   return {
     left,
     right
@@ -3349,9 +3378,9 @@ function shuffleMatcherWithRandom(data) {
     // If the order doesn't matter, don't shuffle the left column
     left = data.left;
   } else {
-    left = shuffle$1(data.left, Math.random, /* ensurePermuted */true);
+    left = shuffle(data.left, Math.random, /* ensurePermuted */true);
   }
-  const right = shuffle$1(data.right, Math.random, /* ensurePermuted */true);
+  const right = shuffle(data.right, Math.random, /* ensurePermuted */true);
   return {
     left,
     right
@@ -3732,7 +3761,7 @@ const radioWidgetLogic = {
  * the public options that should be exposed to the client.
  */
 function getSorterPublicWidgetOptions(options) {
-  const shuffledCorrect = shuffle$1(options.correct, Math.random, /* ensurePermuted */true);
+  const shuffledCorrect = shuffle(options.correct, Math.random, /* ensurePermuted */true);
   return _extends({}, options, {
     // Note(Tamara): This does not provide correct answer information any longer.
     // To maintain compatibility with the original widget options, we are
@@ -4025,8 +4054,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;
@@ -4045,58 +4075,5 @@ 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 seededRNG(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, ensurePermuted = false) {
-  // Always return a copy of the input array
-  const shuffled = _.clone(array);
-
-  // Handle edge cases (input array is empty or uniform)
-  if (!shuffled.length || _.all(shuffled, function (value) {
-    return _.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 && _.isEqual(array, shuffled));
-  return shuffled;
-}
-const random = seededRNG(new Date().getTime() & 0xffffffff);
-
 export { coreWidgetRegistry as CoreWidgetRegistry, Errors, grapherUtil as GrapherUtil, ItemExtras, PerseusError, PerseusExpressionAnswerFormConsidered, addWidget, approximateDeepEqual, approximateEqual, categorizerWidgetLogic as categorizerLogic, csProgramWidgetLogic as csProgramLogic, deepClone, definitionWidgetLogic as definitionLogic, deriveExtraKeys, deriveNumCorrect, dropdownWidgetLogic as dropdownLogic, explanationWidgetLogic as explanationLogic, expressionWidgetLogic as expressionLogic, getCSProgramPublicWidgetOptions, getCategorizerPublicWidgetOptions, getDecimalSeparator, getDropdownPublicWidgetOptions, getExpressionPublicWidgetOptions, getGrapherPublicWidgetOptions, getIFramePublicWidgetOptions, getInteractiveGraphPublicWidgetOptions, getLabelImagePublicWidgetOptions, getMatcherPublicWidgetOptions, getMatrixPublicWidgetOptions, getMatrixSize, getNumberLinePublicWidgetOptions, getNumericInputPublicWidgetOptions, getOrdererPublicWidgetOptions, getPlotterPublicWidgetOptions, getRadioPublicWidgetOptions, getSorterPublicWidgetOptions, getTablePublicWidgetOptions, getUpgradedWidgetOptions, getWidgetIdsFromContent, getWidgetIdsFromContentByType, gradedGroupWidgetLogic as gradedGroupLogic, gradedGroupSetWidgetLogic as gradedGroupSetLogic, grapherWidgetLogic as grapherLogic, groupWidgetLogic as groupLogic, iframeWidgetLogic as iframeLogic, imageWidgetLogic as imageLogic, inputNumberWidgetLogic as inputNumberLogic, interactionWidgetLogic as interactionLogic, interactiveGraphWidgetLogic as interactiveGraphLogic, isFailure, isSuccess, labelImageWidgetLogic as labelImageLogic, libVersion, lockedFigureColorNames, lockedFigureColors, lockedFigureFillStyles, mapObject, matcherWidgetLogic as matcherLogic, matrixWidgetLogic as matrixLogic, measurerWidgetLogic as measurerLogic, numberLineWidgetLogic as numberLineLogic, numericInputWidgetLogic as numericInputLogic, ordererWidgetLogic as ordererLogic, parseAndMigratePerseusArticle, parseAndMigratePerseusItem, parsePerseusItem, passageWidgetLogic as passageLogic, passageRefWidgetLogic as passageRefLogic, passageRefTargetWidgetLogic as passageRefTargetLogic, phetSimulationWidgetLogic as phetSimulationLogic, plotterWidgetLogic as plotterLogic, plotterPlotTypes, pluck, pythonProgramWidgetLogic as pythonProgramLogic, radioWidgetLogic as radioLogic, random, seededRNG, shuffle, shuffleMatcher, sorterWidgetLogic as sorterLogic, splitPerseusItem, tableWidgetLogic as tableLogic, upgradeWidgetInfoToLatestVersion, usesNumCorrect, videoWidgetLogic as videoLogic };
 //# sourceMappingURL=index.js.map