@khanacademy/perseus 43.0.1 → 43.1.0

package/dist/perseus-types.d.ts

@@ -82,7 +82,14 @@ export type PerseusItem = {
     question: PerseusRenderer;
     hints: ReadonlyArray<Hint>;
     answerArea: PerseusAnswerArea | null | undefined;
-    itemDataVersion: Version;
+    /**
+     * The version of the item.
+     * @deprecated Not used.
+     */
+    itemDataVersion: any;
+    /**
+     * @deprecated Superseded by per-widget answers.
+     */
     answer: any;
 };
 /**
@@ -590,12 +597,12 @@ export type PerseusMatcherWidgetOptions = {
 };
 export type PerseusMatrixWidgetAnswers = ReadonlyArray<ReadonlyArray<number>>;
 export type PerseusMatrixWidgetOptions = {
-    prefix: string;
-    suffix: string;
+    prefix?: string | undefined;
+    suffix?: string | undefined;
     answers: PerseusMatrixWidgetAnswers;
-    cursorPosition: ReadonlyArray<number>;
+    cursorPosition?: ReadonlyArray<number> | undefined;
     matrixBoardSize: ReadonlyArray<number>;
-    static: boolean;
+    static?: boolean | undefined;
 };
 export type PerseusMeasurerWidgetOptions = {
     image: PerseusImageBackground;
@@ -651,8 +658,8 @@ export type PerseusOrdererWidgetOptions = {
     options: ReadonlyArray<PerseusRenderer>;
     correctOptions: ReadonlyArray<PerseusRenderer>;
     otherOptions: ReadonlyArray<PerseusRenderer>;
-    height: string;
-    layout: string;
+    height: "normal" | "auto";
+    layout: "horizontal" | "vertical";
 };
 export type PerseusPassageWidgetOptions = {
     footnotes: string;

package/dist/util/parse-perseus-json/general-purpose-parsers/defaulted.d.ts

@@ -1,2 +1,2 @@
 import type { Parser } from "../parser-types";
-export declare function defaulted<T, Default extends T | null | undefined>(parser: Parser<T>, fallback: (missingValue: null | undefined) => Default): Parser<T | Default>;
+export declare function defaulted<T, Default>(parser: Parser<T>, fallback: (missingValue: null | undefined) => Default): Parser<T | Default>;

package/dist/util/parse-perseus-json/general-purpose-parsers/index.d.ts

@@ -9,7 +9,9 @@ export * from "./number";
 export * from "./object";
 export * from "./optional";
 export * from "./pair";
+export * from "./pipe-parsers";
 export * from "./record";
 export * from "./string";
 export * from "./trio";
 export * from "./union";
+export * from "./unknown";

package/dist/util/parse-perseus-json/general-purpose-parsers/pipe-parsers.d.ts

@@ -0,0 +1,7 @@
+import type { Parser, PartialParser } from "../parser-types";
+export declare function pipeParsers<T>(p: Parser<T>): ParserPipeline<T>;
+export declare class ParserPipeline<T> {
+    readonly parser: Parser<T>;
+    constructor(parser: Parser<T>);
+    then<U>(nextParser: PartialParser<T, U>): ParserPipeline<U>;
+}

package/dist/util/parse-perseus-json/general-purpose-parsers/pipe-parsers.typetest.d.ts

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

package/dist/util/parse-perseus-json/general-purpose-parsers/unknown.d.ts

@@ -0,0 +1,2 @@
+import type { Parser } from "../parser-types";
+export declare const unknown: Parser<unknown>;

package/dist/util/parse-perseus-json/perseus-parsers/images-map.d.ts

@@ -0,0 +1,5 @@
+import type { PerseusImageDetail } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseImages: Parser<{
+    [key: string]: PerseusImageDetail;
+}>;

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

@@ -1,3 +1,7 @@
 import type { WidgetOptions } from "../../../perseus-types";
 import type { Parser } from "../parser-types";
 export declare function parseWidget<Type extends string, Options>(parseType: Parser<Type>, parseOptions: Parser<Options>): Parser<WidgetOptions<Type, Options>>;
+export declare function parseWidgetWithVersion<Version extends {
+    major: number;
+    minor: number;
+} | undefined, Type extends string, Options>(parseVersion: Parser<Version>, parseType: Parser<Type>, parseOptions: Parser<Options>): Parser<WidgetOptions<Type, Options>>;

package/dist/validation.types.d.ts

@@ -27,15 +27,18 @@
  * } & Perseus<Widget>ValidationData;
  * ```
  */
-import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatcherWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumberLineWidgetOptions, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusPlotterWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType } from "./perseus-types";
+import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatcherWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumberLineWidgetOptions, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType } from "./perseus-types";
 import type { InteractiveMarkerType } from "./widgets/label-image/types";
 import type { Relationship } from "./widgets/number-line/number-line";
 export type UserInputStatus = "correct" | "incorrect" | "incomplete";
-export type PerseusCategorizerRubric = {
+export type PerseusCategorizerScoringData = {
     values: ReadonlyArray<number>;
-};
+} & PerseusCategorizerValidationData;
 export type PerseusCategorizerUserInput = {
-    values: PerseusCategorizerRubric["values"];
+    values: PerseusCategorizerScoringData["values"];
+};
+export type PerseusCategorizerValidationData = {
+    items: ReadonlyArray<string>;
 };
 export type PerseusCSProgramRubric = Empty;
 export type PerseusCSProgramUserInput = {
@@ -117,7 +120,12 @@ export type PerseusOrdererRubric = PerseusOrdererWidgetOptions;
 export type PerseusOrdererUserInput = {
     current: ReadonlyArray<string>;
 };
-export type PerseusPlotterRubric = PerseusPlotterWidgetOptions;
+export type PerseusPlotterScoringData = {
+    correct: ReadonlyArray<number>;
+} & PerseusPlotterValidationData;
+export type PerseusPlotterValidationData = {
+    starting: ReadonlyArray<number>;
+};
 export type PerseusPlotterUserInput = ReadonlyArray<number>;
 export type PerseusRadioRubric = {
     choices: ReadonlyArray<PerseusRadioChoice>;
@@ -136,7 +144,7 @@ export type PerseusTableRubric = {
     answers: ReadonlyArray<ReadonlyArray<string>>;
 };
 export type PerseusTableUserInput = ReadonlyArray<ReadonlyArray<string>>;
-export type Rubric = PerseusCategorizerRubric | PerseusCSProgramRubric | PerseusDropdownRubric | PerseusExpressionRubric | PerseusGroupRubric | PerseusGradedGroupRubric | PerseusGradedGroupSetRubric | PerseusGrapherRubric | PerseusIFrameRubric | PerseusInputNumberRubric | PerseusInteractiveGraphRubric | PerseusLabelImageRubric | PerseusMatcherRubric | PerseusMatrixRubric | PerseusNumberLineRubric | PerseusNumericInputRubric | PerseusOrdererRubric | PerseusPlotterRubric | PerseusRadioRubric | PerseusSorterRubric | PerseusTableRubric;
+export type Rubric = PerseusCategorizerScoringData | PerseusCSProgramRubric | PerseusDropdownRubric | PerseusExpressionRubric | PerseusGroupRubric | PerseusGradedGroupRubric | PerseusGradedGroupSetRubric | PerseusGrapherRubric | PerseusIFrameRubric | PerseusInputNumberRubric | PerseusInteractiveGraphRubric | PerseusLabelImageRubric | PerseusMatcherRubric | PerseusMatrixRubric | PerseusNumberLineRubric | PerseusNumericInputRubric | PerseusOrdererRubric | PerseusPlotterScoringData | PerseusRadioRubric | PerseusSorterRubric | PerseusTableRubric;
 export type UserInput = PerseusCategorizerUserInput | PerseusCSProgramUserInput | PerseusDropdownUserInput | PerseusExpressionUserInput | PerseusGrapherUserInput | PerseusIFrameUserInput | PerseusInputNumberUserInput | PerseusInteractiveGraphUserInput | PerseusLabelImageUserInput | PerseusMatcherUserInput | PerseusMatrixUserInput | PerseusNumberLineUserInput | PerseusNumericInputUserInput | PerseusOrdererUserInput | PerseusPlotterUserInput | PerseusRadioUserInput | PerseusSorterUserInput | PerseusTableUserInput;
 export type UserInputMap = {
     [widgetId: string]: UserInput | UserInputMap;

package/dist/widgets/categorizer/categorizer.d.ts

@@ -3,9 +3,9 @@ import { PerseusI18nContext } from "../../components/i18n-context";
 import scoreCategorizer from "./score-categorizer";
 import type { PerseusCategorizerWidgetOptions } from "../../perseus-types";
 import type { Widget, WidgetProps } from "../../types";
-import type { PerseusCategorizerRubric, PerseusCategorizerUserInput } from "../../validation.types";
+import type { PerseusCategorizerScoringData, PerseusCategorizerUserInput } from "../../validation.types";
 import type { CategorizerPromptJSON } from "../../widget-ai-utils/categorizer/categorizer-ai-utils";
-type Props = WidgetProps<RenderProps, PerseusCategorizerRubric> & {
+type Props = WidgetProps<RenderProps, PerseusCategorizerScoringData> & {
     values: ReadonlyArray<string>;
 };
 type DefaultProps = {

package/dist/widgets/categorizer/score-categorizer.d.ts

@@ -1,5 +1,5 @@
 import type { PerseusStrings } from "../../strings";
 import type { PerseusScore } from "../../types";
-import type { PerseusCategorizerRubric, PerseusCategorizerUserInput } from "../../validation.types";
-declare function scoreCategorizer(userInput: PerseusCategorizerUserInput, rubric: PerseusCategorizerRubric, strings: PerseusStrings): PerseusScore;
+import type { PerseusCategorizerScoringData, PerseusCategorizerUserInput } from "../../validation.types";
+declare function scoreCategorizer(userInput: PerseusCategorizerUserInput, scoringData: PerseusCategorizerScoringData, strings: PerseusStrings): PerseusScore;
 export default scoreCategorizer;

package/dist/widgets/categorizer/validate-categorizer.d.ts

@@ -0,0 +1,15 @@
+import type { PerseusStrings } from "../../strings";
+import type { PerseusScore } from "../../types";
+import type { PerseusCategorizerUserInput, PerseusCategorizerValidationData } from "../../validation.types";
+/**
+ * Checks userInput from the categorizer widget to see if the user has selected
+ * a category for each item.
+ * @param userInput - The user's input corresponding to an array of indices that
+ * represent the selected category for each row/item.
+ * @param validationData - An array of strings corresponding to each row/item
+ * @param strings - Used to provide a validation message
+ */
+declare function validateCategorizer(userInput: PerseusCategorizerUserInput, validationData: PerseusCategorizerValidationData, strings: PerseusStrings): Extract<PerseusScore, {
+    type: "invalid";
+}> | null;
+export default validateCategorizer;

package/dist/widgets/dropdown/validate-dropdown.d.ts

@@ -0,0 +1,10 @@
+import type { PerseusScore } from "../../types";
+import type { PerseusDropdownUserInput } from "../../validation.types";
+/**
+ * Checks if the user has selected an item from the dropdown before scoring.
+ * This is shown with a userInput value / index other than 0.
+ */
+declare function validateDropdown(userInput: PerseusDropdownUserInput): Extract<PerseusScore, {
+    type: "invalid";
+}> | null;
+export default validateDropdown;

package/dist/widgets/interactive-graphs/graphs/components/movable-point.d.ts

@@ -1,9 +1,16 @@
 import * as React from "react";
 import type { CSSCursor } from "./css-cursor";
+import type { AriaLive } from "../../types";
 import type { KeyboardMovementConstraint } from "../use-draggable";
 import type { vec } from "mafs";
 type Props = {
     point: vec.Vector2;
+    ariaDescribedBy?: string;
+    ariaLabel?: string;
+    ariaLive?: AriaLive;
+    color?: string;
+    constrain?: KeyboardMovementConstraint;
+    cursor?: CSSCursor | undefined;
     /**
      * Represents where this point stands in the overall point sequence.
      * This is used to provide screen readers with context about the point.
@@ -12,14 +19,11 @@ type Props = {
      * Note: This number is 1-indexed, and should restart from 1 for each
      * interactive figure on the graph.
      */
-    sequenceNumber: number;
-    onMove?: (newPoint: vec.Vector2) => unknown;
+    sequenceNumber?: number;
+    onBlur?: (event: React.FocusEvent) => unknown;
     onClick?: () => unknown;
-    color?: string;
-    cursor?: CSSCursor | undefined;
-    constrain?: KeyboardMovementConstraint;
-    onFocus?: ((event: React.FocusEvent) => unknown) | undefined;
-    onBlur?: ((event: React.FocusEvent) => unknown) | undefined;
+    onFocus?: (event: React.FocusEvent) => unknown;
+    onMove?: (newPoint: vec.Vector2) => unknown;
 };
 export declare const MovablePoint: React.ForwardRefExoticComponent<Props & React.RefAttributes<SVGGElement | null>>;
 export {};

package/dist/widgets/interactive-graphs/graphs/components/use-control-point.d.ts

@@ -1,11 +1,17 @@
 import * as React from "react";
 import type { CSSCursor } from "./css-cursor";
+import type { AriaLive } from "../../types";
 import type { KeyboardMovementConstraint } from "../use-draggable";
 import type { vec } from "mafs";
 type Params = {
     point: vec.Vector2;
+    ariaDescribedBy?: string;
+    ariaLabel?: string;
+    ariaLive?: AriaLive;
     color?: string | undefined;
+    constrain?: KeyboardMovementConstraint;
     cursor?: CSSCursor | undefined;
+    forwardedRef?: React.ForwardedRef<SVGGElement | null> | undefined;
     /**
      * Represents where this point stands in the overall point sequence.
      * This is used to provide screen readers with context about the point.
@@ -14,13 +20,11 @@ type Params = {
      * Note: This number is 1-indexed, and should restart from 1 for each
      * interactive figure on the graph.
      */
-    sequenceNumber: number;
-    constrain?: KeyboardMovementConstraint;
+    sequenceNumber?: number;
     onMove?: ((newPoint: vec.Vector2) => unknown) | undefined;
     onClick?: (() => unknown) | undefined;
     onFocus?: ((event: React.FocusEvent) => unknown) | undefined;
     onBlur?: ((event: React.FocusEvent) => unknown) | undefined;
-    forwardedRef?: React.ForwardedRef<SVGGElement | null> | undefined;
 };
 type Return = {
     focusableHandle: React.ReactNode;

package/dist/widgets/interactive-graphs/types.d.ts

@@ -90,3 +90,4 @@ export type GraphDimensions = {
     width: number;
     height: number;
 };
+export type AriaLive = "off" | "assertive" | "polite" | undefined;

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

@@ -1,12 +1,19 @@
 import * as React from "react";
 import { PerseusI18nContext } from "../../components/i18n-context";
 import scoreMatrix from "./score-matrix";
-import type { PerseusMatrixWidgetOptions } from "../../perseus-types";
+import type { PerseusMatrixWidgetAnswers } from "../../perseus-types";
 import type { WidgetProps, Widget, FocusPath } from "../../types";
 import type { PerseusMatrixRubric, PerseusMatrixUserInput } from "../../validation.types";
 import type { MatrixPromptJSON } from "../../widget-ai-utils/matrix/matrix-ai-utils";
 export declare function getMatrixSize(matrix: ReadonlyArray<ReadonlyArray<number>>): number[];
-type ExternalProps = WidgetProps<PerseusMatrixWidgetOptions, PerseusMatrixRubric>;
+type ExternalProps = WidgetProps<{
+    prefix: string;
+    suffix: string;
+    answers: PerseusMatrixWidgetAnswers;
+    cursorPosition: ReadonlyArray<number>;
+    matrixBoardSize: ReadonlyArray<number>;
+    static?: boolean | undefined;
+}, PerseusMatrixRubric>;
 type Props = ExternalProps & {
     onChange: (arg1: {
         cursorPosition?: ReadonlyArray<number>;
@@ -17,9 +24,9 @@ type Props = ExternalProps & {
 type DefaultProps = {
     matrixBoardSize: Props["matrixBoardSize"];
     answers: Props["answers"];
-    prefix: Props["prefix"];
-    suffix: Props["suffix"];
-    cursorPosition: Props["cursorPosition"];
+    prefix: string;
+    suffix: string;
+    cursorPosition: ReadonlyArray<number>;
     apiOptions: Props["apiOptions"];
     linterContext: Props["linterContext"];
 };

package/dist/widgets/measurer/measurer.d.ts

@@ -40,7 +40,7 @@ declare const _default: {
         minor: number;
     };
     propUpgrades: {
-        readonly "1": (v0props: any) => any;
+        readonly "1": (v0props: any) => PerseusMeasurerWidgetOptions;
     };
     scorer: () => import("../../types").PerseusScore;
 };

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

@@ -0,0 +1,12 @@
+import type { PerseusScore } from "../../types";
+import type { PerseusOrdererUserInput } from "../../validation.types";
+/**
+ * Checks user input from the orderer widget to see if the user has started
+ * ordering the options, making the widget scorable.
+ * @param userInput
+ * @see `scoreOrderer` for more details.
+ */
+declare function validateOrderer(userInput: PerseusOrdererUserInput): Extract<PerseusScore, {
+    type: "invalid";
+}> | null;
+export default validateOrderer;

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

@@ -3,10 +3,10 @@ import { PerseusI18nContext } from "../../components/i18n-context";
 import scorePlotter from "./score-plotter";
 import type { PerseusPlotterWidgetOptions } from "../../perseus-types";
 import type { Widget, WidgetProps } from "../../types";
-import type { PerseusPlotterRubric, PerseusPlotterUserInput } from "../../validation.types";
+import type { PerseusPlotterScoringData, PerseusPlotterUserInput } from "../../validation.types";
 import type { UnsupportedWidgetPromptJSON } from "../../widget-ai-utils/unsupported-widget";
 type RenderProps = PerseusPlotterWidgetOptions;
-type Props = WidgetProps<RenderProps, PerseusPlotterRubric> & {
+type Props = WidgetProps<RenderProps, PerseusPlotterScoringData> & {
     labelInterval: NonNullable<PerseusPlotterWidgetOptions["labelInterval"]>;
     picSize: NonNullable<PerseusPlotterWidgetOptions["picSize"]>;
 };

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

@@ -1,4 +1,4 @@
 import type { PerseusScore } from "../../types";
-import type { PerseusPlotterRubric, PerseusPlotterUserInput } from "../../validation.types";
-declare function scorePlotter(userInput: PerseusPlotterUserInput, rubric: PerseusPlotterRubric): PerseusScore;
+import type { PerseusPlotterScoringData, PerseusPlotterUserInput } from "../../validation.types";
+declare function scorePlotter(userInput: PerseusPlotterUserInput, scoringData: PerseusPlotterScoringData): PerseusScore;
 export default scorePlotter;

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

@@ -0,0 +1,12 @@
+import type { PerseusScore } from "../../types";
+import type { PerseusPlotterUserInput, PerseusPlotterValidationData } from "../../validation.types";
+/**
+ * Checks user input to confirm it is not the same as the starting values for the graph.
+ * This means the user has modified the graph, and the question can be scored.
+ *
+ * @see 'scorePlotter' for more details on scoring.
+ */
+declare function validatePlotter(userInput: PerseusPlotterUserInput, validationData: PerseusPlotterValidationData): Extract<PerseusScore, {
+    type: "invalid";
+}> | null;
+export default validatePlotter;

package/dist/widgets/radio/radio.d.ts

@@ -15,7 +15,7 @@ declare const _default: {
         minor: number;
     };
     propUpgrades: {
-        readonly "1": (v0props: any) => any;
+        readonly "1": (v0props: any) => PerseusRadioWidgetOptions;
     };
     isLintable: true;
     scorer: typeof scoreRadio;

package/dist/widgets/radio/validate-radio.d.ts

@@ -0,0 +1,14 @@
+import type { PerseusScore } from "../../types";
+import type { PerseusRadioUserInput } from "../../validation.types";
+/**
+ * Checks if the user has selected at least one option. Additional validation
+ * is done in scoreRadio to check if the number of selected options is correct
+ * and if the user has selected both a correct option and the "none of the above"
+ * option.
+ * @param userInput
+ * @see `scoreRadio` for the additional validation logic and the scoring logic.
+ */
+declare function validateRadio(userInput: PerseusRadioUserInput): Extract<PerseusScore, {
+    type: "invalid";
+}> | null;
+export default validateRadio;

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

@@ -0,0 +1,13 @@
+import type { PerseusScore } from "../../types";
+import type { PerseusSorterUserInput } from "../../validation.types";
+/**
+ * Checks user input for the sorter widget to ensure that the user has made
+ * changes before attempting to score the widget.
+ * @param userInput
+ * @see 'scoreSorter' in 'packages/perseus/src/widgets/sorter/score-sorter.ts'
+ * for more details on how the sorter widget is scored.
+ */
+declare function validateSorter(userInput: PerseusSorterUserInput): Extract<PerseusScore, {
+    type: "invalid";
+}> | null;
+export default validateSorter;

package/package.json

@@ -3,7 +3,7 @@
     "description": "Core Perseus API (includes renderers and widgets)",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "43.0.1",
+    "version": "43.1.0",
     "publishConfig": {
         "access": "public"
     },
@@ -40,14 +40,14 @@
         "test": "bash -c 'yarn --silent --cwd \"../..\" test ${@:0} $($([[ ${@: -1} = -* ]] || [[ ${@: -1} = bash ]]) && echo $PWD)'"
     },
     "dependencies": {
-        "@khanacademy/kas": "^0.4.1",
+        "@khanacademy/kas": "^0.4.2",
         "@khanacademy/keypad-context": "^1.0.4",
         "@khanacademy/kmath": "^0.1.16",
         "@khanacademy/math-input": "^21.1.5",
         "@khanacademy/perseus-core": "1.5.3",
         "@khanacademy/perseus-linter": "^1.2.4",
-        "@khanacademy/pure-markdown": "^0.3.12",
-        "@khanacademy/simple-markdown": "^0.13.5",
+        "@khanacademy/pure-markdown": "^0.3.13",
+        "@khanacademy/simple-markdown": "^0.13.6",
         "@types/classnames": "2.2.0",
         "@use-gesture/react": "^10.2.27",
         "mafs": "0.19.0",

package/dist/util/parse-perseus-json/general-purpose-parsers/compose-parsers.d.ts

@@ -1,2 +0,0 @@
-import type { ParsedValue, PartialParser, Parser } from "../parser-types";
-export declare function composeParsers<A extends Parser<any>, B extends PartialParser<ParsedValue<A>, any>>(parserA: A, parserB: B): Parser<ParsedValue<B>>;