@khanacademy/perseus-core 8.0.0 → 10.0.0

package/dist/parse-perseus-json/perseus-parsers/python-program-widget.d.ts

@@ -1,3 +1,4 @@
-import type { PythonProgramWidget } from "../../data-schema";
-import type { Parser } from "../parser-types";
-export declare const parsePythonProgramWidget: Parser<PythonProgramWidget>;
+export declare const parsePythonProgramWidget: import("../parser-types").Parser<import("../..").WidgetOptions<"python-program", import("../general-purpose-parsers/object-types").OptionalizeProperties<{
+    programID: string;
+    height: number;
+}>>>;

package/dist/parse-perseus-json/perseus-parsers/python-program-widget.typetest.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,3 +1,5 @@
-import type { SorterWidget } from "../../data-schema";
-import type { Parser } from "../parser-types";
-export declare const parseSorterWidget: Parser<SorterWidget>;
+export declare const parseSorterWidget: import("../parser-types").Parser<import("../..").WidgetOptions<"sorter", import("../general-purpose-parsers/object-types").OptionalizeProperties<{
+    correct: string[];
+    padding: boolean;
+    layout: "horizontal" | "vertical";
+}>>>;

package/dist/parse-perseus-json/perseus-parsers/sorter-widget.typetest.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,3 +1,6 @@
-import type { TableWidget } from "../../data-schema";
-import type { Parser } from "../parser-types";
-export declare const parseTableWidget: Parser<TableWidget>;
+export declare const parseTableWidget: import("../parser-types").Parser<import("../..").WidgetOptions<"table", import("../general-purpose-parsers/object-types").OptionalizeProperties<{
+    headers: string[];
+    rows: number;
+    columns: number;
+    answers: string[][];
+}>>>;

package/dist/parse-perseus-json/perseus-parsers/table-widget.typetest.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,3 +1,4 @@
-import type { VideoWidget } from "../../data-schema";
-import type { Parser } from "../parser-types";
-export declare const parseVideoWidget: Parser<VideoWidget>;
+export declare const parseVideoWidget: import("../parser-types").Parser<import("../..").WidgetOptions<"video", import("../general-purpose-parsers/object-types").OptionalizeProperties<{
+    location: string;
+    static: boolean | undefined;
+}>>>;

package/dist/parse-perseus-json/perseus-parsers/video-widget.typetest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types.d.ts

@@ -15,16 +15,19 @@ export type KEScore = {
     state: any;
 };
 export type MarkerType = {
-    answers: ReadonlyArray<string>;
+    answers: string[];
     label: string;
     x: number;
     y: number;
 };
 export type InteractiveMarkerType = MarkerType & {
-    selected?: ReadonlyArray<string>;
+    selected?: string[];
     showCorrectness?: "correct" | "incorrect";
     focused?: boolean;
 };
-export type Relationship = "lt" | "gt" | "le" | "ge";
+export type Relationship = "eq" | "lt" | "gt" | "le" | "ge";
 export type Alignment = "default" | "block" | "inline-block" | "inline" | "float-left" | "float-right" | "full-width";
+export type RecursiveReadonly<T> = {
+    readonly [K in keyof T]: RecursiveReadonly<T[K]>;
+};
 export {};

package/dist/utils/deep-clone.d.ts

@@ -1,3 +1,2 @@
-type Cloneable = null | undefined | boolean | string | number | Cloneable[] | readonly Cloneable[];
-declare function deepClone<T extends Cloneable>(obj: T): T;
+declare function deepClone<T>(obj: T): T;
 export default deepClone;

package/dist/utils/item-has-hints.d.ts

@@ -0,0 +1,5 @@
+import type { PerseusItem } from "../data-schema";
+/**
+ * Returns true if the item has hints
+ */
+export declare const itemHasHints: (item: PerseusItem) => boolean;

package/dist/utils/item-has-rationales.d.ts

@@ -0,0 +1,5 @@
+import type { PerseusItem } from "../data-schema";
+/**
+ * Returns true if a Perseus item contains any widget with rationales.
+ */
+export declare const itemHasRationales: (item: PerseusItem) => boolean;

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

@@ -1,5 +1,5 @@
 type RNG = () => number;
 export declare const seededRNG: (seed: number) => RNG;
-export declare function shuffle<T>(array: ReadonlyArray<T>, randomSeed: number | RNG, ensurePermuted?: boolean): ReadonlyArray<T>;
+export declare function shuffle<T>(array: ReadonlyArray<T>, randomSeed: number | RNG, ensurePermuted?: boolean): T[];
 export declare const random: RNG;
 export {};

package/dist/utils/split-perseus-item.d.ts

@@ -1,7 +1,7 @@
 import type { PerseusItem } from "../data-schema";
 /**
- * Return a copy of a Perseus item with rubric data removed (ie answers)
+ * Return a copy of a PerseusItem with rubric data removed (ie answers)
  *
- * @param originalItem - the original, full Perseus item (which includes the rubric - aka answer data)
+ * @param original - the original, full PerseusItem (which includes the rubric - aka answer data)
  */
-export default function splitPerseusItem(originalItem: PerseusItem): PerseusItem;
+export default function splitPerseusItem(original: PerseusItem): PerseusItem;

package/dist/utils/split-perseus-renderer.d.ts

@@ -0,0 +1,7 @@
+import type { PerseusRenderer } from "../data-schema";
+/**
+ * Return a copy of a PerseusRenderer with rubric data removed (ie answers)
+ *
+ * @param original - the original, full PerseusRenderer (which includes the rubric - aka answer data)
+ */
+export default function splitPerseusRenderer(original: PerseusRenderer): PerseusRenderer;

package/dist/utils/test-utils.d.ts

@@ -1,4 +1,5 @@
-import type { PerseusItem } from "../data-schema";
+import type { PerseusItem, PerseusRenderer } from "../data-schema";
+export declare function generateTestPerseusRenderer(customFields?: Partial<PerseusRenderer>): PerseusRenderer;
 /**
  * Generate a Perseus item object for testing purposes.
  *

package/dist/validation.types.d.ts

@@ -47,27 +47,27 @@ export type ValidationResult = Extract<PerseusScore, {
 }> | null;
 export type UserInputStatus = "correct" | "incorrect" | "incomplete";
 export type PerseusCategorizerRubric = {
-    values: ReadonlyArray<number>;
+    values: number[];
 } & PerseusCategorizerValidationData;
 export type PerseusCategorizerUserInput = {
     values: PerseusCategorizerRubric["values"];
 };
 export type PerseusCategorizerValidationData = {
-    items: ReadonlyArray<string>;
+    items: string[];
 };
 export type PerseusCSProgramUserInput = {
     status: UserInputStatus;
     message: string | null;
 };
 export type PerseusDropdownRubric = {
-    choices: ReadonlyArray<PerseusDropdownChoice>;
+    choices: Array<PerseusDropdownChoice>;
 };
 export type PerseusDropdownUserInput = {
     value: number;
 };
 export type PerseusExpressionRubric = {
-    answerForms: ReadonlyArray<PerseusExpressionAnswerForm>;
-    functions: ReadonlyArray<string>;
+    answerForms: Array<PerseusExpressionAnswerForm>;
+    functions: string[];
 };
 export type PerseusExpressionUserInput = string;
 export type PerseusGroupRubric = PerseusGroupWidgetOptions;
@@ -101,24 +101,24 @@ export type PerseusInteractiveGraphRubric = {
 };
 export type PerseusInteractiveGraphUserInput = PerseusGraphType;
 export type PerseusLabelImageRubric = {
-    markers: ReadonlyArray<{
-        answers: ReadonlyArray<string>;
+    markers: Array<{
+        answers: string[];
         label: string;
     }>;
 };
 export type PerseusLabelImageUserInput = {
-    markers: ReadonlyArray<{
-        selected?: ReadonlyArray<string>;
+    markers: Array<{
+        selected?: string[];
         label: string;
     }>;
 };
 export type PerseusMatcherRubric = {
-    left: ReadonlyArray<string>;
-    right: ReadonlyArray<string>;
+    left: string[];
+    right: string[];
 };
 export type PerseusMatcherUserInput = {
-    left: ReadonlyArray<string>;
-    right: ReadonlyArray<string>;
+    left: string[];
+    right: string[];
 };
 export type PerseusMatrixRubric = {
     answers: PerseusMatrixWidgetAnswers;
@@ -130,7 +130,7 @@ export type PerseusMatrixUserInput = {
 export type PerseusNumberLineRubric = {
     correctRel: string | null | undefined;
     correctX: number;
-    range: ReadonlyArray<number>;
+    range: number[];
     initialX: number | null | undefined;
     isInequality: boolean;
 };
@@ -139,10 +139,10 @@ export type PerseusNumberLineUserInput = {
     numLinePosition: number;
     rel: Relationship | "eq";
     numDivisions: number;
-    divisionRange: ReadonlyArray<number>;
+    divisionRange: number[];
 };
 export type PerseusNumericInputRubric = {
-    answers: ReadonlyArray<PerseusNumericInputAnswer>;
+    answers: PerseusNumericInputAnswer[];
     coefficient: boolean;
 };
 export type PerseusNumericInputUserInput = {
@@ -150,32 +150,32 @@ export type PerseusNumericInputUserInput = {
 };
 export type PerseusOrdererRubric = PerseusOrdererWidgetOptions;
 export type PerseusOrdererUserInput = {
-    current: ReadonlyArray<string>;
+    current: string[];
 };
 export type PerseusPlotterRubric = {
-    correct: ReadonlyArray<number>;
+    correct: number[];
 } & PerseusPlotterValidationData;
 export type PerseusPlotterValidationData = {
-    starting: ReadonlyArray<number>;
+    starting: number[];
 };
-export type PerseusPlotterUserInput = ReadonlyArray<number>;
+export type PerseusPlotterUserInput = number[];
 export type PerseusRadioRubric = {
-    choices: ReadonlyArray<PerseusRadioChoice>;
+    choices: PerseusRadioChoice[];
 };
 export type PerseusRadioUserInput = {
-    choicesSelected: ReadonlyArray<boolean>;
+    choicesSelected: boolean[];
 };
 export type PerseusSorterRubric = {
-    correct: ReadonlyArray<string>;
+    correct: string[];
 };
 export type PerseusSorterUserInput = {
-    options: ReadonlyArray<string>;
+    options: string[];
     changed: boolean;
 };
 export type PerseusTableRubric = {
-    answers: ReadonlyArray<ReadonlyArray<string>>;
+    answers: string[][];
 };
-export type PerseusTableUserInput = ReadonlyArray<ReadonlyArray<string>>;
+export type PerseusTableUserInput = string[][];
 export interface RubricRegistry {
     categorizer: PerseusCategorizerRubric;
     dropdown: PerseusDropdownRubric;
@@ -251,7 +251,7 @@ export type UserInputMap = MakeWidgetMap<UserInputRegistry>;
 /**
  * deprecated prefer using UserInputMap
  */
-export type UserInputArray = ReadonlyArray<UserInputArray | UserInput | null | undefined>;
+export type UserInputArray = Array<UserInputArray | UserInput | null | undefined>;
 export interface ValidationDataTypes {
     categorizer: PerseusCategorizerValidationData;
     group: PerseusGroupValidationData;

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

@@ -28,3 +28,11 @@ export declare const getSupportedAlignments: (type: string) => ReadonlyArray<Ali
  * the exports of a widget's module.
  */
 export declare const getDefaultAlignment: (type: string) => Alignment;
+/**
+ * We use a function here rather than registering widgets
+ * at the top-level of the file to avoid circular dependencies.
+ * Logic that needs core widget functionality
+ * (like a prod or in tests)
+ * need to call this function before trying to use that logic.
+ */
+export declare function registerCoreWidgets(): void;

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

@@ -0,0 +1,12 @@
+import type { PerseusGroupWidgetOptions, PerseusRenderer } from "../../data-schema";
+/**
+ * For details on the individual options, see the
+ * PerseusGroupWidgetOptions type
+ */
+export type GroupPublicWidgetOptions = PerseusRenderer;
+/**
+ * Given a PerseusGroupWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+declare function getGroupPublicWidgetOptions(options: PerseusGroupWidgetOptions): GroupPublicWidgetOptions;
+export default getGroupPublicWidgetOptions;

package/dist/widgets/input-number/input-number-util.d.ts

@@ -0,0 +1,12 @@
+import type { PerseusInputNumberWidgetOptions } from "../../data-schema";
+/**
+ * For details on the individual options, see the
+ * PerseusInputNumberWidgetOptions type
+ */
+type InputNumberPublicWidgetOptions = Pick<PerseusInputNumberWidgetOptions, "answerType" | "inexact" | "maxError" | "rightAlign" | "simplify" | "size" | "customKeypad">;
+/**
+ * Given a PerseusInputNumberWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+declare function getInputNumberPublicWidgetOptions(options: PerseusInputNumberWidgetOptions): InputNumberPublicWidgetOptions;
+export default getInputNumberPublicWidgetOptions;

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

@@ -3,7 +3,9 @@ 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 getGrapherPublicWidgetOptions from "./grapher/grapher-util";
+import type getGroupPublicWidgetOptions from "./group/group-util";
 import type getIFramePublicWidgetOptions from "./iframe/iframe-util";
+import type getInputNumberPublicWidgetOptions from "./input-number/input-number-util";
 import type getInteractiveGraphPublicWidgetOptions from "./interactive-graph/interactive-graph-util";
 import type getLabelImagePublicWidgetOptions from "./label-image/label-image-util";
 import type getMatcherPublicWidgetOptions from "./matcher/matcher-util";
@@ -26,7 +28,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 getMatcherPublicWidgetOptions | typeof getPlotterPublicWidgetOptions | typeof getIFramePublicWidgetOptions | typeof getRadioPublicWidgetOptions | typeof getNumericInputPublicWidgetOptions | typeof getDropdownPublicWidgetOptions | typeof getCategorizerPublicWidgetOptions | typeof getOrdererPublicWidgetOptions | typeof getExpressionPublicWidgetOptions | typeof getInteractiveGraphPublicWidgetOptions | typeof getLabelImagePublicWidgetOptions | typeof getSorterPublicWidgetOptions | typeof getCSProgramPublicWidgetOptions | typeof getNumberLinePublicWidgetOptions | typeof getTablePublicWidgetOptions | typeof getGrapherPublicWidgetOptions | typeof getMatrixPublicWidgetOptions;
+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 WidgetLogic = {
     name: string;
     version?: Version;

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

@@ -1,4 +1,3 @@
 import type { PerseusMatrixWidgetOptions } from "../../data-schema";
-type MatrixPublicWidgetOptions = Pick<PerseusMatrixWidgetOptions, "prefix" | "suffix" | "cursorPosition" | "matrixBoardSize" | "static">;
+export type MatrixPublicWidgetOptions = Pick<PerseusMatrixWidgetOptions, "prefix" | "suffix" | "cursorPosition" | "matrixBoardSize" | "static">;
 export default function getMatrixPublicWidgetOptions(options: PerseusMatrixWidgetOptions): MatrixPublicWidgetOptions;
-export {};

package/dist/widgets/number-line/number-line-util.d.ts

@@ -1,4 +1,3 @@
 import type { PerseusNumberLineWidgetOptions } from "../../data-schema";
-type NumberLinePublicWidgetOptions = Pick<PerseusNumberLineWidgetOptions, "range" | "labelRange" | "labelStyle" | "labelTicks" | "isTickCtrl" | "divisionRange" | "numDivisions" | "snapDivisions" | "tickStep" | "initialX" | "showTooltips" | "static">;
+export type NumberLinePublicWidgetOptions = Pick<PerseusNumberLineWidgetOptions, "range" | "labelRange" | "labelStyle" | "labelTicks" | "isTickCtrl" | "isInequality" | "divisionRange" | "numDivisions" | "snapDivisions" | "tickStep" | "initialX" | "showTooltips" | "static">;
 export default function getNumberLinePublicWidgetOptions(options: PerseusNumberLineWidgetOptions): NumberLinePublicWidgetOptions;
-export {};

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

@@ -3,14 +3,10 @@ import type { PerseusOrdererWidgetOptions } from "../../data-schema";
  * For details on the individual options, see the
  * PerseusOrdererWidgetOptions type
  */
-type OrdererPublicWidgetOptions = {
-    options: PerseusOrdererWidgetOptions["options"];
-    height: PerseusOrdererWidgetOptions["height"];
-    layout: PerseusOrdererWidgetOptions["layout"];
-};
+export type OrdererPublicWidgetOptions = Pick<PerseusOrdererWidgetOptions, "options" | "height" | "layout">;
 /**
  * Given a PerseusOrdererWidgetOptions object, return a new object with only
  * the public options that should be exposed to the client.
  */
-declare function getOrdererPublicWidgetOptions(options: PerseusOrdererWidgetOptions): OrdererPublicWidgetOptions;
+declare function getOrdererPublicWidgetOptions(fullOptions: PerseusOrdererWidgetOptions): OrdererPublicWidgetOptions;
 export default getOrdererPublicWidgetOptions;

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

@@ -3,7 +3,7 @@ import type { PerseusPlotterWidgetOptions } from "../../data-schema";
  * For details on the individual options, see the
  * PerseusPlotterWidgetOptions type
  */
-type PlotterPublicWidgetOptions = Omit<PerseusPlotterWidgetOptions, "correct">;
+export type PlotterPublicWidgetOptions = Omit<PerseusPlotterWidgetOptions, "correct">;
 /**
  * Given a PerseusPlotterWidgetOptions object, return a new object with only
  * the public options that should be exposed to the client.

package/package.json

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

package/dist/parse-perseus-json/general-purpose-parsers/is-object.d.ts

@@ -1 +0,0 @@
-export declare function isObject(x: unknown): x is Record<keyof any, unknown>;