@khanacademy/perseus-core 10.1.0 → 12.0.0

package/dist/parse-perseus-json/index.d.ts

@@ -23,23 +23,24 @@ export type ParseFailureDetail = {
     invalidObject: unknown;
 };
 /**
- * Parses a PerseusItem from a JSON string, migrates old formats to the latest
- * schema, and runtime-typechecks the result. Use this to parse assessmentItem
- * data.
+ * Parses a PerseusItem from a plain object or JSON string, migrates old
+ * formats to the latest schema, and runtime-typechecks the result. Use this to
+ * parse assessmentItem data.
  *
  * @returns a {@link Result} of the parsed PerseusItem. If the result is a
  * failure, it will contain an error message describing where in the tree
  * parsing failed.
  * @throws SyntaxError if the argument is not well-formed JSON.
  */
-export declare function parseAndMigratePerseusItem(json: string): Result<PerseusItem, ParseFailureDetail>;
+export declare function parseAndMigratePerseusItem(data: unknown): Result<PerseusItem, ParseFailureDetail>;
 /**
- * Parses a PerseusArticle from a JSON string, migrates old formats to the
- * latest schema, and runtime-typechecks the result.
+ * Parses a PerseusArticle from a plain object (or array) or JSON string,
+ * migrates old formats to the latest schema, and runtime-typechecks the
+ * result.
  *
  * @returns a {@link Result} of the parsed PerseusArticle. If the result is a
  * failure, it will contain an error message describing where in the tree
  * parsing failed.
  * @throws SyntaxError if the argument is not well-formed JSON.
  */
-export declare function parseAndMigratePerseusArticle(json: string): Result<PerseusArticle, ParseFailureDetail>;
+export declare function parseAndMigratePerseusArticle(data: unknown): Result<PerseusArticle, ParseFailureDetail>;

package/dist/parse-perseus-json/perseus-parsers/free-response-widget.d.ts

@@ -0,0 +1,3 @@
+import type { FreeResponseWidget } from "../../data-schema";
+import type { Parser } from "../parser-types";
+export declare const parseFreeResponseWidget: Parser<FreeResponseWidget>;

package/dist/utils/random-util.d.ts

@@ -1,5 +1,15 @@
-type RNG = () => number;
+/**
+ * A random number generator. Should return floats in the interval [0, 1), like
+ * Math.random().
+ */
+export type RNG = () => number;
 export declare const seededRNG: (seed: number) => RNG;
+/**
+ * Shuffle an array using a given random seed or function.
+ * If `ensurePermuted` is true, the input and output are guaranteed to be
+ * distinct permutations.
+ */
 export declare function shuffle<T>(array: ReadonlyArray<T>, randomSeed: number | RNG, ensurePermuted?: boolean): T[];
+export declare function constrainedShuffle<T>(array: readonly T[], random: RNG, isValidShuffle: (shuffled: readonly T[]) => boolean): T[];
+export declare function randomIntInRange(min: number, max: number, random: RNG): number;
 export declare const random: RNG;
-export {};

package/dist/utils/range.d.ts

@@ -0,0 +1 @@
+export declare function range(min: number, max: number): number[];

package/dist/utils/registry.d.ts

@@ -0,0 +1,13 @@
+declare class Registry<T> {
+    private name;
+    private contents;
+    private anythingRegistered;
+    constructor(name?: string);
+    private throwIfUnregistered;
+    has(key: string): boolean;
+    get(key: string): T | undefined;
+    keys(): Array<string>;
+    entries(): Array<[string, T]>;
+    set(key: string, value: T): void;
+}
+export default Registry;

package/dist/validation.types.d.ts

@@ -28,7 +28,7 @@
  * } & Perseus<Widget>ValidationData;
  * ```
  */
-import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType, MakeWidgetMap } from "./data-schema";
+import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType, MakeWidgetMap, PerseusFreeResponseWidgetScoringCriterion } from "./data-schema";
 import type { Relationship } from "./types";
 export type WidgetValidatorFunction = (userInput: UserInput, validationData: ValidationData, locale: string) => ValidationResult;
 export type WidgetScorerFunction = (userInput: UserInput, rubric: Rubric, locale?: string) => PerseusScore;
@@ -148,6 +148,13 @@ export type PerseusNumericInputRubric = {
 export type PerseusNumericInputUserInput = {
     currentValue: string;
 };
+export type PerseusFreeResponseUserInput = {
+    currentValue: string;
+};
+export type PerseusFreeResponseRubric = {
+    question: string;
+    scoringCriteria: ReadonlyArray<PerseusFreeResponseWidgetScoringCriterion>;
+};
 export type PerseusOrdererRubric = PerseusOrdererWidgetOptions;
 export type PerseusOrdererUserInput = {
     current: string[];
@@ -225,6 +232,7 @@ interface UserInputRegistry {
     "cs-program": PerseusCSProgramUserInput;
     dropdown: PerseusDropdownUserInput;
     expression: PerseusExpressionUserInput;
+    "free-response": PerseusFreeResponseUserInput;
     grapher: PerseusGrapherUserInput;
     group: PerseusGroupUserInput;
     iframe: PerseusIFrameUserInput;

package/dist/widgets/core-widget-registry.d.ts

@@ -1,9 +1,9 @@
 import type { PublicWidgetOptionsFunction } from "./logic-export.types";
 import type { Alignment } from "../types";
 export declare function isWidgetRegistered(type: string): boolean;
-export declare function getCurrentVersion(type: string): any;
-export declare const getPublicWidgetOptionsFunction: (name: string) => PublicWidgetOptionsFunction;
-export declare function getWidgetOptionsUpgrades(type: string): any;
+export declare function getCurrentVersion(type: string): import("..").Version;
+export declare const getPublicWidgetOptionsFunction: (type: string) => PublicWidgetOptionsFunction;
+export declare function getWidgetOptionsUpgrades(type: string): import("./logic-export.types").WidgetOptionsUpgradeMap;
 export declare function getDefaultWidgetOptions(type: string): any;
 /**
  * Handling for the optional alignments for widgets

package/dist/widgets/free-response/free-response-util.d.ts

@@ -0,0 +1,17 @@
+import type { PerseusFreeResponseWidgetOptions } from "../../data-schema";
+/**
+ * For details on the individual options, see the
+ * {@link PerseusFreeResponseWidgetOptions} type
+ */
+export type FreeResponsePublicWidgetOptions = {
+    allowUnlimitedCharacters: PerseusFreeResponseWidgetOptions["allowUnlimitedCharacters"];
+    characterLimit: PerseusFreeResponseWidgetOptions["characterLimit"];
+    placeholder: PerseusFreeResponseWidgetOptions["placeholder"];
+    question: PerseusFreeResponseWidgetOptions["question"];
+};
+/**
+ * Given a FreeResponsePublicWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+declare function getFreeResponsePublicWidgetOptions(options: PerseusFreeResponseWidgetOptions): FreeResponsePublicWidgetOptions;
+export default getFreeResponsePublicWidgetOptions;

package/dist/widgets/free-response/index.d.ts

@@ -0,0 +1,5 @@
+import type { PerseusFreeResponseWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type FreeResponseDefaultWidgetOptions = Pick<PerseusFreeResponseWidgetOptions, "allowUnlimitedCharacters" | "characterLimit" | "placeholder" | "question" | "scoringCriteria">;
+declare const freeResponseWidgetLogic: WidgetLogic;
+export default freeResponseWidgetLogic;

package/dist/widgets/logic-export.types.d.ts

@@ -2,6 +2,7 @@ import type getCategorizerPublicWidgetOptions from "./categorizer/categorizer-ut
 import type getCSProgramPublicWidgetOptions from "./cs-program/cs-program-util";
 import type getDropdownPublicWidgetOptions from "./dropdown/dropdown-util";
 import type getExpressionPublicWidgetOptions from "./expression/expression-util";
+import type getFreeResponsePublicWidgetOptions from "./free-response/free-response-util";
 import type getGrapherPublicWidgetOptions from "./grapher/grapher-util";
 import type getGroupPublicWidgetOptions from "./group/group-util";
 import type getIFramePublicWidgetOptions from "./iframe/iframe-util";
@@ -28,7 +29,7 @@ export type WidgetOptionsUpgradeMap = {
  * TODO(LEMS-2870): figure out how to make this generic so we don't need to be
  * so reliant on a set group of widgets
  */
-export type PublicWidgetOptionsFunction = typeof getCategorizerPublicWidgetOptions | typeof getCSProgramPublicWidgetOptions | typeof getDropdownPublicWidgetOptions | typeof getExpressionPublicWidgetOptions | typeof getGrapherPublicWidgetOptions | typeof getGroupPublicWidgetOptions | typeof getIFramePublicWidgetOptions | typeof getInputNumberPublicWidgetOptions | typeof getInteractiveGraphPublicWidgetOptions | typeof getLabelImagePublicWidgetOptions | typeof getMatcherPublicWidgetOptions | typeof getMatrixPublicWidgetOptions | typeof getNumberLinePublicWidgetOptions | typeof getNumericInputPublicWidgetOptions | typeof getOrdererPublicWidgetOptions | typeof getPlotterPublicWidgetOptions | typeof getRadioPublicWidgetOptions | typeof getSorterPublicWidgetOptions | typeof getTablePublicWidgetOptions;
+export type PublicWidgetOptionsFunction = typeof getCategorizerPublicWidgetOptions | typeof getCSProgramPublicWidgetOptions | typeof getDropdownPublicWidgetOptions | typeof getExpressionPublicWidgetOptions | typeof getFreeResponsePublicWidgetOptions | typeof getGrapherPublicWidgetOptions | typeof getGroupPublicWidgetOptions | typeof getIFramePublicWidgetOptions | typeof getInputNumberPublicWidgetOptions | typeof getInteractiveGraphPublicWidgetOptions | typeof getLabelImagePublicWidgetOptions | typeof getMatcherPublicWidgetOptions | typeof getMatrixPublicWidgetOptions | typeof getNumberLinePublicWidgetOptions | typeof getNumericInputPublicWidgetOptions | typeof getOrdererPublicWidgetOptions | typeof getPlotterPublicWidgetOptions | typeof getRadioPublicWidgetOptions | typeof getSorterPublicWidgetOptions | typeof getTablePublicWidgetOptions;
 export type WidgetLogic = {
     name: string;
     version?: Version;

package/dist/widgets/matcher/matcher-util.d.ts

@@ -13,7 +13,7 @@ export declare const shuffleMatcher: (props: MatcherInfo) => {
  * For details on the individual options, see the
  * PerseusMatcherWidgetOptions type
  */
-type MatcherPublicWidgetOptions = {
+export type MatcherPublicWidgetOptions = {
     labels: PerseusMatcherWidgetOptions["labels"];
     left: PerseusMatcherWidgetOptions["left"];
     right: PerseusMatcherWidgetOptions["right"];

package/dist/widgets/sorter/sorter-util.d.ts

@@ -7,11 +7,14 @@ type SorterPublicWidgetOptions = {
     correct: PerseusSorterWidgetOptions["correct"];
     padding: PerseusSorterWidgetOptions["padding"];
     layout: PerseusSorterWidgetOptions["layout"];
-    isCorrectShuffled: boolean;
 };
 /**
  * Given a PerseusSorterWidgetOptions object, return a new object with only
  * the public options that should be exposed to the client.
  */
 declare function getSorterPublicWidgetOptions(options: PerseusSorterWidgetOptions): SorterPublicWidgetOptions;
+export declare function shuffleSorter(props: {
+    correct: string[];
+    problemNum: number | null | undefined;
+}): string[];
 export default getSorterPublicWidgetOptions;

package/package.json

@@ -3,7 +3,7 @@
   "description": "Shared Perseus infrastructure",
   "author": "Khan Academy",
   "license": "MIT",
-  "version": "10.1.0",
+  "version": "12.0.0",
   "publishConfig": {
     "access": "public"
   },
@@ -23,8 +23,8 @@
   ],
   "dependencies": {
     "tiny-invariant": "^1.3.1",
-    "@khanacademy/kas": "2.0.3",
-    "@khanacademy/perseus-utils": "2.0.2"
+    "@khanacademy/kas": "2.0.4",
+    "@khanacademy/perseus-utils": "2.0.3"
   },
   "devDependencies": {
     "@khanacademy/wonder-stuff-core": "1.5.4",