@khanacademy/perseus-core 3.6.0 → 3.7.0

package/dist/data-schema.d.ts

@@ -226,7 +226,14 @@ export type PerseusRenderer = {
      * field.
      */
     widgets: PerseusWidgetsMap;
-    metadata?: ReadonlyArray<string>;
+    /**
+     * Formerly used in the PerseusGradedGroup widget.  A list of "tags" that
+     * are keys that represent other content in the system.  Not rendered to
+     * the user. NOTE: perseus_data.go says this is required even though it
+     * isn't necessary.
+     * @deprecated
+     */
+    metadata?: any;
     /**
      * A dictionary of {[imageUrl]: PerseusImageDetail}.
      */
@@ -258,7 +265,7 @@ export type WidgetOptions<Type extends string, Options> = {
     graded?: boolean;
     alignment?: string;
     options: Options;
-    key?: number;
+    key?: number | null;
     version?: Version;
 };
 export type CategorizerWidget = WidgetOptions<'categorizer', PerseusCategorizerWidgetOptions>;
@@ -304,7 +311,7 @@ export type PerseusImageBackground = {
     height?: number;
     top?: number;
     left?: number;
-    scale?: number | string;
+    scale?: number;
     bottom?: number;
 };
 /**

package/dist/es/index.js

@@ -1,3 +1,5 @@
+import { seededRNG as seededRNG$1, shuffle as shuffle$2 } from '@khanacademy/perseus-core';
+
 /**
  * Adds the given perseus library version information to the __perseus_debug__
  * object and ensures that the object is attached to `globalThis` (`window` in
@@ -818,7 +820,7 @@ function times(n, iteratee, context) {
 }
 
 // Return a random integer between `min` and `max` (inclusive).
-function random(min, max) {
+function random$1(min, max) {
   if (max == null) {
     max = min;
     min = 0;
@@ -1561,14 +1563,14 @@ function toArray(obj) {
 function sample(obj, n, guard) {
   if (n == null || guard) {
     if (!isArrayLike(obj)) obj = values(obj);
-    return obj[random(obj.length - 1)];
+    return obj[random$1(obj.length - 1)];
   }
   var sample = toArray(obj);
   var length = getLength(sample);
   n = Math.max(Math.min(n, length), 0);
   var last = length - 1;
   for (var index = 0; index < n; index++) {
-    var rand = random(index, last);
+    var rand = random$1(index, last);
     var temp = sample[index];
     sample[index] = sample[rand];
     sample[rand] = temp;
@@ -1577,7 +1579,7 @@ function sample(obj, n, guard) {
 }
 
 // Shuffle a collection.
-function shuffle(obj) {
+function shuffle$1(obj) {
   return sample(obj, Infinity);
 }
 
@@ -1963,7 +1965,7 @@ var allExports = /*#__PURE__*/Object.freeze({
     matcher: matcher,
     matches: matcher,
     times: times,
-    random: random,
+    random: random$1,
     now: now,
     escape: escape,
     unescape: unescape,
@@ -2020,7 +2022,7 @@ var allExports = /*#__PURE__*/Object.freeze({
     where: where,
     max: max,
     min: min,
-    shuffle: shuffle,
+    shuffle: shuffle$1,
     sample: sample,
     sortBy: sortBy,
     groupBy: groupBy,
@@ -3076,7 +3078,7 @@ function parseWidget(parseType, parseOptions) {
     graded: optional(boolean),
     alignment: optional(string),
     options: parseOptions,
-    key: optional(number),
+    key: optional(nullable(number)),
     version: optional(object({
       major: number,
       minor: number
@@ -3462,14 +3464,15 @@ const imageDimensionToNumber = pipeParsers(union(number).or(string).parser)
 // string parses to either NaN (using parseInt) or 0 (using unary +) and
 // CSS will treat NaN as invalid and default to 0 instead.
 .then(convert(emptyToZero)).then(stringToNumber).parser;
+const dimensionOrUndefined = defaulted(imageDimensionToNumber, () => undefined);
 const parsePerseusImageBackground = object({
   url: optional(nullable(string)),
-  width: optional(imageDimensionToNumber),
-  height: optional(imageDimensionToNumber),
-  top: optional(imageDimensionToNumber),
-  left: optional(imageDimensionToNumber),
-  bottom: optional(imageDimensionToNumber),
-  scale: optional(imageDimensionToNumber)
+  width: dimensionOrUndefined,
+  height: dimensionOrUndefined,
+  top: dimensionOrUndefined,
+  left: dimensionOrUndefined,
+  bottom: dimensionOrUndefined,
+  scale: dimensionOrUndefined
 });
 
 const pairOfNumbers$2 = pair(number, number);
@@ -4210,7 +4213,7 @@ const parseNumericInputWidget = parseWidget(constant("numeric-input"), object({
     // the data, simplify this.
     value: optional(nullable(number)),
     status: string,
-    answerForms: optional(array(parseMathFormat)),
+    answerForms: defaulted(array(parseMathFormat), () => undefined),
     strict: boolean,
     maxError: optional(nullable(number)),
     // TODO(benchristel): simplify should never be a boolean, but we
@@ -4308,7 +4311,7 @@ const parseRadioWidget = parseWidget(constant("radio"), object({
     // There is an import cycle between radio-widget.ts and
     // widgets-map.ts. The anonymous function below ensures that we
     // don't refer to parseWidgetsMap before it's defined.
-    widgets: optional((rawVal, ctx) => parseWidgetsMap(rawVal, ctx))
+    widgets: defaulted((rawVal, ctx) => parseWidgetsMap(rawVal, ctx), () => undefined)
   })),
   hasNoneOfTheAbove: optional(boolean),
   countChoices: optional(boolean),
@@ -4461,13 +4464,17 @@ const parseDeprecatedWidget = parseWidget(
 (_, ctx) => ctx.success("deprecated-standin"),
 // Allow any widget options
 object({}));
-const parseStringToPositiveInt = (rawValue, ctx) => {
-  if (typeof rawValue !== "string" || !/^[1-9][0-9]*$/.test(rawValue)) {
-    return ctx.failure("a string representing a positive integer", rawValue);
+const parseStringToNonNegativeInt = (rawValue, ctx) => {
+  // The article renderer seems to allow the numeric part of a widget ID to
+  // be 0, at least for image widgets. However, if widget IDs in an exercise
+  // contain 0, the exercise renderer will blow up. We allow 0 here for
+  // compatibility with articles.
+  if (typeof rawValue !== "string" || !/^(0|[1-9][0-9]*)$/.test(rawValue)) {
+    return ctx.failure("a string representing a non-negative integer", rawValue);
   }
   return ctx.success(+rawValue);
 };
-const parseWidgetIdComponents = pair(string, parseStringToPositiveInt);
+const parseWidgetIdComponents = pair(string, parseStringToNonNegativeInt);
 
 const parsePerseusRenderer = defaulted(object({
   // TODO(benchristel): content is also defaulted to empty string in
@@ -4478,8 +4485,9 @@ const parsePerseusRenderer = defaulted(object({
   // The anonymous function below ensures that we don't try to access
   // parseWidgetsMap before it's defined.
   widgets: defaulted((rawVal, ctx) => parseWidgetsMap(rawVal, ctx), () => ({})),
-  metadata: optional(array(string)),
-  images: parseImages
+  images: parseImages,
+  // deprecated
+  metadata: any
 }),
 // Default value
 () => ({
@@ -4490,29 +4498,48 @@ const parsePerseusRenderer = defaulted(object({
 
 const parsePerseusArticle = union(parsePerseusRenderer).or(array(parsePerseusRenderer)).parser;
 
-function _objectWithoutPropertiesLoose(r, e) {
-  if (null == r) return {};
-  var t = {};
-  for (var n in r) if ({}.hasOwnProperty.call(r, n)) {
-    if (-1 !== e.indexOf(n)) continue;
-    t[n] = r[n];
-  }
-  return t;
-}
-
 const parseHint = object({
   replace: optional(boolean),
   content: string,
   widgets: defaulted(parseWidgetsMap, () => ({})),
-  metadata: optional(array(string)),
-  images: parseImages
+  images: parseImages,
+  // deprecated
+  metadata: any
 });
 
-const _excluded$a = ["type", "options"];
+const parsePerseusAnswerArea = pipeParsers(defaulted(object({}), () => ({}))).then(convert(toAnswerArea)).parser;
+
+// Some answerAreas have extra, bogus fields, like:
+//
+//   "answerArea": {
+//     "type": "multiple",
+//     "options": {},
+//     "version": null,
+//     "static": false,
+//     "graded": false,
+//     "alignment": "",
+//   }
+//
+// This function filters the fields of an answerArea object, keeping only the
+// known ones, and converts `undefined` and `null` values to `false`.
+function toAnswerArea(raw) {
+  return {
+    zTable: !!raw.zTable,
+    calculator: !!raw.calculator,
+    chi2Table: !!raw.chi2Table,
+    financialCalculatorMonthlyPayment: !!raw.financialCalculatorMonthlyPayment,
+    financialCalculatorTotalAmount: !!raw.financialCalculatorTotalAmount,
+    financialCalculatorTimeToPayOff: !!raw.financialCalculatorTimeToPayOff,
+    periodicTable: !!raw.periodicTable,
+    periodicTableWithKey: !!raw.periodicTableWithKey,
+    tTable: !!raw.tTable
+  };
+}
+
 const parsePerseusItem$1 = object({
   question: parsePerseusRenderer,
   hints: defaulted(array(parseHint), () => []),
-  answerArea: pipeParsers(defaulted(object({}), () => ({}))).then(migrateAnswerArea).then(record(enumeration(...ItemExtras), boolean)).parser,
+  answerArea: parsePerseusAnswerArea,
   itemDataVersion: optional(object({
     major: number,
     minor: number
@@ -4521,24 +4548,6 @@ const parsePerseusItem$1 = object({
   answer: any
 });
 
-// Some answerAreas have extra fields, like:
-//
-//   "answerArea": {
-//     "type": "multiple",
-//     "options": {
-//       "content": "",
-//       "images": {},
-//       "widgets": {}
-//     }
-//   }
-//
-// The "type" and "options" fields don't seem to be used anywhere. This
-// migration function removes them.
-function migrateAnswerArea(rawValue, ctx) {
-  const rest = _objectWithoutPropertiesLoose(rawValue, _excluded$a);
-  return ctx.success(rest);
-}
-
 /**
  * Helper to parse PerseusItem JSON
  * Why not just use JSON.parse? We want:
@@ -4613,7 +4622,7 @@ function throwErrorIfCheatingDetected() {
 
 // This file is processed by a Rollup plugin (replace) to inject the production
 const libName = "@khanacademy/perseus-core";
-const libVersion = "3.6.0";
+const libVersion = "3.7.0";
 addLibraryVersionToPerseusDebug(libName, libVersion);
 
 /**
@@ -4898,6 +4907,16 @@ const gradedGroupSetWidgetLogic = {
   defaultWidgetOptions: defaultWidgetOptions$o
 };
 
+function _objectWithoutPropertiesLoose(r, e) {
+  if (null == r) return {};
+  var t = {};
+  for (var n in r) if ({}.hasOwnProperty.call(r, n)) {
+    if (-1 !== e.indexOf(n)) continue;
+    t[n] = r[n];
+  }
+  return t;
+}
+
 const _excluded$9 = ["correct"];
 function getGrapherPublicWidgetOptions(options) {
   const publicOptions = _objectWithoutPropertiesLoose(options, _excluded$9);
@@ -4933,10 +4952,7 @@ const grapherWidgetLogic = {
 const defaultWidgetOptions$m = {
   content: "",
   widgets: {},
-  images: {},
-  // `undefined` instead of `null` so that getDefaultProps works for
-  // `the GroupMetadataEditor`
-  metadata: undefined
+  images: {}
 };
 const groupWidgetLogic = {
   name: "group",
@@ -5077,6 +5093,63 @@ const labelImageWidgetLogic = {
   getPublicWidgetOptions: getLabelImagePublicWidgetOptions
 };
 
+// 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);
+  let left;
+  if (!props.orderMatters) {
+    // If the order doesn't matter, don't shuffle the left column
+    left = props.left;
+  } else {
+    left = shuffle$2(props.left, rng, /* ensurePermuted */true);
+  }
+  const right = shuffle$2(props.right, rng, /* ensurePermuted */true);
+  return {
+    left,
+    right
+  };
+};
+
+// TODO(LEMS-2841): Can shorten to shuffleMatcher after above function removed
+function shuffleMatcherWithRandom(data) {
+  // Use the same random() function to shuffle both columns sequentially
+  let left;
+  if (!data.orderMatters) {
+    // If the order doesn't matter, don't shuffle the left column
+    left = data.left;
+  } else {
+    left = shuffle$2(data.left, Math.random, /* ensurePermuted */true);
+  }
+  const right = shuffle$2(data.right, Math.random, /* ensurePermuted */true);
+  return {
+    left,
+    right
+  };
+}
+
+/**
+ * For details on the individual options, see the
+ * PerseusMatcherWidgetOptions type
+ */
+
+/**
+ * Given a PerseusMatcherWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+function getMatcherPublicWidgetOptions(options) {
+  const {
+    left,
+    right
+  } = shuffleMatcherWithRandom(options);
+  return _extends({}, options, {
+    left: left,
+    right: right
+  });
+}
+
 const defaultWidgetOptions$f = {
   left: ["$x$", "$y$", "$z$"],
   right: ["$1$", "$2$", "$3$"],
@@ -5086,7 +5159,8 @@ const defaultWidgetOptions$f = {
 };
 const matcherWidgetLogic = {
   name: "matcher",
-  defaultWidgetOptions: defaultWidgetOptions$f
+  defaultWidgetOptions: defaultWidgetOptions$f,
+  getPublicWidgetOptions: getMatcherPublicWidgetOptions
 };
 
 const _excluded$6 = ["answers"];
@@ -5418,14 +5492,17 @@ const radioWidgetLogic = {
  * the public options that should be exposed to the client.
  */
 function getSorterPublicWidgetOptions(options) {
-  return {
+  const shuffledCorrect = shuffle$2(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
     // keeping the key the same. Represents initial state of the cards here.
-    correct: options.correct.slice().sort(),
-    padding: options.padding,
-    layout: options.layout
-  };
+    correct: shuffledCorrect,
+    // Note(Tamara): This new key is only added here with "true". There isn't
+    // a place where it is set to false. It indicates that the correct field
+    // has been shuffled and no longer contains correct answer info.
+    isCorrectShuffled: true
+  });
 }
 
 const defaultWidgetOptions$2 = {
@@ -5724,5 +5801,58 @@ function splitPerseusItem(originalItem) {
   });
 }
 
-export { coreWidgetRegistry as CoreWidgetRegistry, Errors, grapherUtil as GrapherUtil, ItemExtras, PerseusError, PerseusExpressionAnswerFormConsidered, addLibraryVersionToPerseusDebug, addWidget, approximateDeepEqual, approximateEqual, categorizerWidgetLogic as categorizerLogic, csProgramWidgetLogic as csProgramLogic, deepClone, definitionWidgetLogic as definitionLogic, dropdownWidgetLogic as dropdownLogic, explanationWidgetLogic as explanationLogic, expressionWidgetLogic as expressionLogic, getCSProgramPublicWidgetOptions, getCategorizerPublicWidgetOptions, getDecimalSeparator, getDropdownPublicWidgetOptions, getExpressionPublicWidgetOptions, getGrapherPublicWidgetOptions, getIFramePublicWidgetOptions, getInteractiveGraphPublicWidgetOptions, getLabelImagePublicWidgetOptions, 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, sorterWidgetLogic as sorterLogic, splitPerseusItem, tableWidgetLogic as tableLogic, upgradeWidgetInfoToLatestVersion, videoWidgetLogic as videoLogic };
+/* 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, addLibraryVersionToPerseusDebug, addWidget, approximateDeepEqual, approximateEqual, categorizerWidgetLogic as categorizerLogic, csProgramWidgetLogic as csProgramLogic, deepClone, definitionWidgetLogic as definitionLogic, 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, videoWidgetLogic as videoLogic };
 //# sourceMappingURL=index.js.map