@khanacademy/perseus-core 10.1.0 → 11.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/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/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/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": "11.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",