@khanacademy/perseus 43.1.0 → 45.0.0

package/dist/interactive2/interactive-util.d.ts

@@ -14,7 +14,7 @@ declare const InteractiveUtil: {
     /**
      * Turn a function or an array of functions into an array of functions
      */
-    readonly arrayify: (funcOrArray: ((...args: ReadonlyArray<unknown>) => unknown) | readonly unknown[]) => ReadonlyArray<unknown>;
+    readonly arrayify: (funcOrArray: ((...args: ReadonlyArray<unknown>) => unknown) | ReadonlyArray<unknown>) => ReadonlyArray<unknown>;
     /**
      * Convert all function-or-array arguments to arrays of functions
      */

package/dist/interactive2/movable-point-options.d.ts

@@ -19,8 +19,8 @@ declare const _default: {
     };
     constraints: {
         readonly fixed: () => Constraint;
-        readonly snap: (snap?: number | null | undefined) => Constraint;
-        readonly bound: (range?: [Interval, Interval] | undefined, snap?: number | Coord | undefined, optionalPaddingPx?: number | undefined) => Constraint;
+        readonly snap: (snap?: number | null) => Constraint;
+        readonly bound: (range?: [Interval, Interval], snap?: Coord | number, optionalPaddingPx?: number) => Constraint;
     };
     onMove: {
         standard: null;

package/dist/interactive2/movable-point.d.ts

@@ -66,14 +66,14 @@ export declare class MovablePoint {
         onMove: ((coord: Coord, prevCoord: Coord) => void)[];
         onMoveEnd: unknown[];
         onMoveStart: unknown[];
-        onRemove?: (() => void) | undefined;
+        onRemove?: () => void;
         outOfBounds: boolean;
         pointSize: number;
         remove: (() => void)[];
         shadow: boolean;
         static: boolean;
         tooltip: boolean;
-        touchOffset: Coord | null;
+        touchOffset: null | Coord;
         mouseTarget: unknown;
         visibleShape: {
             wrapper: HTMLElement;
@@ -82,9 +82,9 @@ export declare class MovablePoint {
         };
         normalStyle: Record<string, any>;
         highlightStyle: Record<string, any>;
-        isHovering?: boolean | undefined;
-        isMouseOver?: boolean | undefined;
-        isDragging?: boolean | undefined;
+        isHovering?: boolean;
+        isMouseOver?: boolean;
+        isDragging?: boolean;
     };
     update(options: Partial<State>): void;
     draw(): void;
@@ -179,8 +179,8 @@ export declare class MovablePoint {
     };
     static constraints: {
         readonly fixed: () => Constraint;
-        readonly snap: (snap?: number | null | undefined) => Constraint;
-        readonly bound: (range?: [import("../util/interval").Interval, import("../util/interval").Interval] | undefined, snap?: number | Coord | undefined, optionalPaddingPx?: number | undefined) => Constraint;
+        readonly snap: (snap?: number | null) => Constraint;
+        readonly bound: (range?: [import("../util/interval").Interval, import("../util/interval").Interval], snap?: Coord | number, optionalPaddingPx?: number) => Constraint;
     };
     static onMove: {
         standard: null;

package/dist/interactive2/objective_.d.ts

@@ -8,6 +8,6 @@
 declare const _default: {
     pluck: (table: any, subKey: string) => any;
     mapObject: <K extends string, V, U>(obj: Record<K, V>, lambda: (arg1: V, arg2: K) => U) => Record<K, U>;
-    mapObjectFromArray: <K_1 extends string, V_1>(arr: readonly K_1[], lambda: (arg1: K_1) => V_1) => Record<K_1, V_1>;
+    mapObjectFromArray: <K extends string, V>(arr: ReadonlyArray<K>, lambda: (arg1: K) => V) => Record<K, V>;
 };
 export default _default;

package/dist/jipt-paragraphs.d.ts

@@ -2,7 +2,7 @@
  * Paragraph parsing/splitting for article jipt i18n
  */
 declare const _default: {
-    parseToArray: (source: string) => string[];
-    joinFromArray: (paragraphs: readonly string[]) => string;
+    parseToArray: (source: string) => Array<string>;
+    joinFromArray: (paragraphs: ReadonlyArray<string>) => string;
 };
 export default _default;

package/dist/perseus-api.d.ts

@@ -28,7 +28,7 @@
  * semantic meaning across the same perseus api major version.
  */
 import PropTypes from "prop-types";
-import * as React from "react";
+import type { APIOptionsWithDefaults } from "./types";
 export declare const ApiOptions: {
     readonly propTypes: PropTypes.Validator<NonNullable<PropTypes.InferProps<{
         isArticle: PropTypes.Validator<boolean>;
@@ -56,82 +56,7 @@ export declare const ApiOptions: {
         crossOutEnabled: PropTypes.Requireable<boolean>;
         editorChangeDelay: PropTypes.Requireable<number>;
     }>>>;
-    readonly defaults: Readonly<Readonly<{
-        isArticle?: boolean | undefined;
-        onFocusChange?: ((newFocusPath: import("./types").FocusPath, oldFocusPath: import("./types").FocusPath, keypadHeight?: number | undefined, focusedElement?: HTMLElement | undefined) => unknown) | undefined;
-        GroupMetadataEditor?: React.ComponentType<any> | undefined;
-        showAlignmentOptions?: boolean | undefined;
-        readOnly?: boolean | undefined;
-        answerableCallback?: ((arg1: boolean) => unknown) | undefined;
-        getAnotherHint?: (() => unknown) | undefined;
-        interactionCallback?: ((widgetData: {
-            [widgetId: string]: any;
-        }) => void) | undefined;
-        groupAnnotator?: ((groupNumber: number, widgetId: string) => React.ReactNode) | undefined;
-        imagePlaceholder?: React.ReactNode;
-        widgetPlaceholder?: React.ReactNode;
-        baseElements?: {
-            Link: React.ComponentType<any>;
-        } | undefined;
-        imagePreloader?: ((dimensions: import("./types").Dimensions) => React.ReactNode) | undefined;
-        trackInteraction?: ((args: {
-            type: string;
-            id: string;
-            correct?: boolean | undefined;
-        } & Partial<import("./types").TrackingGradedGroupExtraArguments> & Partial<{
-            visible: number;
-        }>) => void) | undefined;
-        customKeypad?: boolean | undefined;
-        nativeKeypadProxy?: ((blur: () => void) => import("@khanacademy/math-input").KeypadAPI) | undefined;
-        isMobile?: boolean | undefined;
-        setDrawingAreaAvailable?: ((arg1: boolean) => unknown) | undefined;
-        hintProgressColor?: string | undefined;
-        canScrollPage?: boolean | undefined;
-        crossOutEnabled?: boolean | undefined;
-        editorChangeDelay?: number | undefined;
-        flags?: {
-            mafs?: false | ({
-                none?: boolean | undefined;
-                linear?: boolean | undefined;
-                circle?: boolean | undefined;
-                polygon?: boolean | undefined;
-                point?: boolean | undefined;
-                quadratic?: boolean | undefined;
-                sinusoid?: boolean | undefined;
-                angle?: boolean | undefined;
-                "linear-system"?: boolean | undefined;
-                ray?: boolean | undefined;
-                segment?: boolean | undefined;
-                "unlimited-polygon"?: boolean | undefined;
-                "unlimited-point"?: boolean | undefined;
-            } & {
-                "interactive-graph-locked-features-labels"?: boolean | undefined;
-                "locked-figures-aria"?: boolean | undefined;
-                "locked-point-labels"?: boolean | undefined;
-                "locked-line-labels"?: boolean | undefined;
-                "locked-vector-labels"?: boolean | undefined;
-                "locked-ellipse-labels"?: boolean | undefined;
-                "locked-polygon-labels"?: boolean | undefined;
-                "locked-function-labels"?: boolean | undefined;
-            }) | undefined;
-        } | undefined;
-        onWidgetStartProps?: ((widgets: import("./perseus-types").PerseusWidgetsMap) => void) | undefined;
-    }> & {
-        GroupMetadataEditor: NonNullable<React.ComponentType<any> | undefined>;
-        baseElements: {
-            Link: React.ComponentType<any>;
-        };
-        canScrollPage: NonNullable<boolean | undefined>;
-        crossOutEnabled: NonNullable<boolean | undefined>;
-        editorChangeDelay: number;
-        groupAnnotator: (groupNumber: number, widgetId: string) => React.ReactNode;
-        isArticle: NonNullable<boolean | undefined>;
-        isMobile: NonNullable<boolean | undefined>;
-        onFocusChange: (newFocusPath: import("./types").FocusPath, oldFocusPath: import("./types").FocusPath, keypadHeight?: number | undefined, focusedElement?: HTMLElement | undefined) => unknown;
-        readOnly: NonNullable<boolean | undefined>;
-        setDrawingAreaAvailable: (arg1: boolean) => unknown;
-        showAlignmentOptions: NonNullable<boolean | undefined>;
-    }>;
+    readonly defaults: APIOptionsWithDefaults;
 };
 export declare const ClassNames: {
     readonly RENDERER: "perseus-renderer";

package/dist/perseus-types.d.ts

@@ -207,14 +207,13 @@ export type PerseusDropdownWidgetOptions = {
     choices: ReadonlyArray<PerseusDropdownChoice>;
     placeholder: string;
     static: boolean;
+    visibleLabel?: string;
+    ariaLabel?: string;
 };
 export type PerseusDropdownChoice = {
     content: string;
     correct: boolean;
 };
-export type PerseusExampleWidgetOptions = {
-    value: string;
-};
 export type PerseusExplanationWidgetOptions = {
     showPrompt: string;
     hidePrompt: string;
@@ -905,11 +904,5 @@ export type PerseusMoleculeRendererWidgetOptions = {
 export type PerseusPassageRefTargetWidgetOptions = {
     content: string;
 };
-export type PerseusSimpleMarkdownTesterWidgetOptions = {
-    value: string;
-};
-type PerseusUnitInputWidgetOptions = {
-    value: string;
-};
-export type PerseusWidgetOptions = PerseusCategorizerWidgetOptions | PerseusCSProgramWidgetOptions | PerseusDefinitionWidgetOptions | PerseusDropdownWidgetOptions | PerseusExampleWidgetOptions | PerseusExplanationWidgetOptions | PerseusExpressionWidgetOptions | PerseusGradedGroupSetWidgetOptions | PerseusGradedGroupWidgetOptions | PerseusIFrameWidgetOptions | PerseusImageWidgetOptions | PerseusInputNumberWidgetOptions | PerseusInteractionWidgetOptions | PerseusInteractiveGraphWidgetOptions | PerseusLabelImageWidgetOptions | PerseusMatcherWidgetOptions | PerseusMatrixWidgetOptions | PerseusMeasurerWidgetOptions | PerseusMoleculeRendererWidgetOptions | PerseusNumberLineWidgetOptions | PerseusNumericInputWidgetOptions | PerseusOrdererWidgetOptions | PerseusPassageRefTargetWidgetOptions | PerseusPassageRefWidgetOptions | PerseusPassageWidgetOptions | PerseusPhetSimulationWidgetOptions | PerseusPlotterWidgetOptions | PerseusRadioWidgetOptions | PerseusSimpleMarkdownTesterWidgetOptions | PerseusSorterWidgetOptions | PerseusTableWidgetOptions | PerseusUnitInputWidgetOptions | PerseusVideoWidgetOptions;
+export type PerseusWidgetOptions = PerseusCategorizerWidgetOptions | PerseusCSProgramWidgetOptions | PerseusDefinitionWidgetOptions | PerseusDropdownWidgetOptions | PerseusExplanationWidgetOptions | PerseusExpressionWidgetOptions | PerseusGradedGroupSetWidgetOptions | PerseusGradedGroupWidgetOptions | PerseusIFrameWidgetOptions | PerseusImageWidgetOptions | PerseusInputNumberWidgetOptions | PerseusInteractionWidgetOptions | PerseusInteractiveGraphWidgetOptions | PerseusLabelImageWidgetOptions | PerseusMatcherWidgetOptions | PerseusMatrixWidgetOptions | PerseusMeasurerWidgetOptions | PerseusMoleculeRendererWidgetOptions | PerseusNumberLineWidgetOptions | PerseusNumericInputWidgetOptions | PerseusOrdererWidgetOptions | PerseusPassageRefTargetWidgetOptions | PerseusPassageRefWidgetOptions | PerseusPassageWidgetOptions | PerseusPhetSimulationWidgetOptions | PerseusPlotterWidgetOptions | PerseusRadioWidgetOptions | PerseusSorterWidgetOptions | PerseusTableWidgetOptions | PerseusVideoWidgetOptions;
 export {};

package/dist/renderer-util.d.ts

@@ -1,8 +1,10 @@
-import type { PerseusWidgetsMap } from "./perseus-types";
+import type { PerseusRenderer, PerseusWidgetsMap } from "./perseus-types";
 import type { PerseusStrings } from "./strings";
 import type { PerseusScore } from "./types";
 import type { UserInputMap } from "./validation.types";
+export declare function getUpgradedWidgetOptions(oldWidgetOptions: PerseusWidgetsMap): PerseusWidgetsMap;
 export declare function emptyWidgetsFunctional(widgets: PerseusWidgetsMap, widgetIds: Array<string>, userInputMap: UserInputMap, strings: PerseusStrings, locale: string): ReadonlyArray<string>;
-export declare function scoreWidgetsFunctional(widgets: PerseusWidgetsMap, widgetIds: Array<string>, userInputMap: UserInputMap, strings: PerseusStrings, locale: string): {
+export declare function scorePerseusItem(perseusRenderData: PerseusRenderer, userInputMap: UserInputMap, strings: PerseusStrings, locale: string): PerseusScore;
+export declare function scoreWidgetsFunctional(widgets: PerseusWidgetsMap, widgetIds: ReadonlyArray<string>, userInputMap: UserInputMap, strings: PerseusStrings, locale: string): {
     [widgetId: string]: PerseusScore;
 };

package/dist/renderer.d.ts

@@ -103,7 +103,6 @@ declare class Renderer extends React.Component<Props, State> implements GetPromp
         widgetInfo: State["widgetInfo"];
         widgetProps: State["widgetProps"];
     };
-    _getAllWidgetsInfo: (props: Props) => PerseusWidgetsMap;
     _getAllWidgetsStartProps: (allWidgetInfo: PerseusWidgetsMap, props: Props) => PerseusWidgetsMap;
     _getDefaultWidgetInfo: (widgetId: string) => any;
     _getWidgetInfo: (widgetId: string) => PerseusWidget;
@@ -218,18 +217,15 @@ declare class Renderer extends React.Component<Props, State> implements GetPromp
      */
     getPromptJSON(): RendererPromptJSON;
     /**
-     * Returns an object mapping from widget ID to perseus-style score.
-     * The keys of this object are the values of the array returned
-     * from `getWidgetIds`.
+     * Scores the content.
+     *
+     * @deprecated use scorePerseusItem
      */
-    scoreWidgets(): {
-        [widgetId: string]: PerseusScore;
-    };
+    score(): PerseusScore;
     /**
-     * Grades the content.
+     * @deprecated use scorePerseusItem
      */
-    score(): PerseusScore;
-    guessAndScore(): [UserInputArray, PerseusScore];
+    guessAndScore: () => [UserInputArray, PerseusScore];
     examples: () => ReadonlyArray<string> | null | undefined;
     handletranslationLintErrors: (lintErrors: ReadonlyArray<string>) => void;
     render(): React.ReactNode;

package/dist/server-item-renderer.d.ts

@@ -12,12 +12,14 @@ import { PerseusI18nContext } from "./components/i18n-context";
 import Renderer from "./renderer";
 import type { PerseusItem, ShowSolutions } from "./perseus-types";
 import type { FocusPath, PerseusDependenciesV2, SharedRendererProps } from "./types";
+import type { UserInputArray, UserInputMap } from "./validation.types";
 import type { GetPromptJSONInterface, RendererPromptJSON } from "./widget-ai-utils/prompt-types";
 import type { KeypadAPI } from "@khanacademy/math-input";
 import type { KeypadContextRendererInterface, RendererInterface, KEScore } from "@khanacademy/perseus-core";
 type OwnProps = {
     hintsVisible?: number;
     item: PerseusItem;
+    score?: KEScore | null;
     problemNum?: number;
     reviewMode?: boolean;
     keypadElement?: KeypadAPI | null | undefined;
@@ -30,8 +32,23 @@ type HOCProps = {
 type Props = SharedRendererProps & OwnProps & HOCProps;
 type DefaultProps = Required<Pick<Props, "apiOptions" | "onRendered" | "linterContext">>;
 type State = {
+    /**
+     * questionCompleted is used to signal that a learner has attempted
+     * the exercise. This is used when widgets want to show things like
+     * rationale or partial correctness.
+     */
     questionCompleted: boolean;
-    questionHighlightedWidgets: ReadonlyArray<any>;
+    /**
+     * As far as I can tell, this is used to highlight empty widgets
+     * after a learner has clicked the "check" button. I don't think this could
+     * still be used though, because the "check" button is disabled while there
+     * are empty widgets.
+     */
+    questionHighlightedWidgets: ReadonlyArray<string>;
+    /**
+     * Keeps track of whether each asset (SvgImage or TeX) rendered by
+     * the questionRenderer has finished loading or rendering.
+     */
     assetStatuses: {
         [assetKey: string]: boolean;
     };
@@ -76,8 +93,22 @@ export declare class ServerItemRenderer extends React.Component<Props, State> im
     blur(): void;
     getNumHints(): number;
     getPromptJSON(): RendererPromptJSON;
+    /**
+     * Returns an array of the widget `.getUserInput()` results
+     *
+     * TODO: can we remove this? Seems to be just for backwards
+     * compatibility with old Perseus Chrome logging
+     * @deprecated use getUserInput
+     */
+    getUserInputLegacy(): UserInputArray;
+    /**
+     * Returns an object of the widget `.getUserInput()` results
+     */
+    getUserInput(): UserInputMap;
     /**
      * Grades the item.
+     *
+     * @deprecated use scorePerseusItem
      */
     scoreInput(): KEScore;
     /**
@@ -97,65 +128,42 @@ export declare class ServerItemRenderer extends React.Component<Props, State> im
 }
 declare const ref: React.ForwardRefExoticComponent<Omit<Pick<SharedRendererProps & OwnProps & HOCProps, keyof OwnProps> & {
     apiOptions?: Readonly<{
-        isArticle?: boolean | undefined;
-        onFocusChange?: ((newFocusPath: FocusPath, oldFocusPath: FocusPath, keypadHeight?: number | undefined, focusedElement?: HTMLElement | undefined) => unknown) | undefined;
-        GroupMetadataEditor?: React.ComponentType<any> | undefined;
-        showAlignmentOptions?: boolean | undefined;
-        readOnly?: boolean | undefined;
-        answerableCallback?: ((arg1: boolean) => unknown) | undefined;
-        getAnotherHint?: (() => unknown) | undefined;
-        interactionCallback?: ((widgetData: {
+        isArticle?: boolean;
+        onFocusChange?: (newFocusPath: FocusPath, oldFocusPath: FocusPath, keypadHeight?: number, focusedElement?: HTMLElement) => unknown;
+        GroupMetadataEditor?: React.ComponentType<any>;
+        showAlignmentOptions?: boolean;
+        readOnly?: boolean;
+        answerableCallback?: (arg1: boolean) => unknown;
+        getAnotherHint?: () => unknown;
+        interactionCallback?: (widgetData: {
             [widgetId: string]: any;
-        }) => void) | undefined;
-        groupAnnotator?: ((groupNumber: number, widgetId: string) => React.ReactNode) | undefined;
+        }) => void;
+        groupAnnotator?: (groupNumber: number, widgetId: string) => React.ReactNode;
         imagePlaceholder?: React.ReactNode;
         widgetPlaceholder?: React.ReactNode;
         baseElements?: {
             Link: React.ComponentType<any>;
-        } | undefined;
-        imagePreloader?: ((dimensions: import("./types").Dimensions) => React.ReactNode) | undefined;
-        trackInteraction?: ((args: {
+        };
+        imagePreloader?: (dimensions: import("./types").Dimensions) => React.ReactNode;
+        trackInteraction?: (args: {
             type: string;
             id: string;
-            correct?: boolean | undefined;
+            correct?: boolean;
         } & Partial<import("./types").TrackingGradedGroupExtraArguments> & Partial<{
             visible: number;
-        }>) => void) | undefined;
-        customKeypad?: boolean | undefined;
-        nativeKeypadProxy?: ((blur: () => void) => KeypadAPI) | undefined;
-        isMobile?: boolean | undefined;
-        setDrawingAreaAvailable?: ((arg1: boolean) => unknown) | undefined;
-        hintProgressColor?: string | undefined;
-        canScrollPage?: boolean | undefined;
-        crossOutEnabled?: boolean | undefined;
-        editorChangeDelay?: number | undefined;
+        }>) => void;
+        customKeypad?: boolean;
+        nativeKeypadProxy?: (blur: () => void) => KeypadAPI;
+        isMobile?: boolean;
+        setDrawingAreaAvailable?: (arg1: boolean) => unknown;
+        hintProgressColor?: string;
+        canScrollPage?: boolean;
+        crossOutEnabled?: boolean;
+        editorChangeDelay?: number;
         flags?: {
-            mafs?: false | ({
-                none?: boolean | undefined;
-                linear?: boolean | undefined;
-                circle?: boolean | undefined;
-                polygon?: boolean | undefined;
-                point?: boolean | undefined;
-                quadratic?: boolean | undefined;
-                sinusoid?: boolean | undefined;
-                angle?: boolean | undefined;
-                "linear-system"?: boolean | undefined;
-                ray?: boolean | undefined;
-                segment?: boolean | undefined;
-                "unlimited-polygon"?: boolean | undefined;
-                "unlimited-point"?: boolean | undefined;
-            } & {
-                "interactive-graph-locked-features-labels"?: boolean | undefined;
-                "locked-figures-aria"?: boolean | undefined;
-                "locked-point-labels"?: boolean | undefined;
-                "locked-line-labels"?: boolean | undefined;
-                "locked-vector-labels"?: boolean | undefined;
-                "locked-ellipse-labels"?: boolean | undefined;
-                "locked-polygon-labels"?: boolean | undefined;
-                "locked-function-labels"?: boolean | undefined;
-            }) | undefined;
-        } | undefined;
-        onWidgetStartProps?: ((widgets: import("./perseus-types").PerseusWidgetsMap) => void) | undefined;
+            mafs?: false | ({ [Key in typeof import("./types").MafsGraphTypeFlags[number]]?: boolean; } & { [Key in typeof import("./types").InteractiveGraphLockedFeaturesFlags[number]]?: boolean; });
+        };
+        onWidgetStartProps?: (widgets: import("./perseus-types").PerseusWidgetsMap) => void;
     }> | undefined;
     linterContext?: PerseusLinter.LinterContextProps | undefined;
     onRendered?: ((isRendered: boolean) => void) | undefined;

package/dist/strings.d.ts

@@ -191,6 +191,7 @@ export type PerseusStrings = {
         elements: string;
     }) => string;
     srNoInteractiveElements: string;
+    selectAnAnswer: string;
 };
 /**
  * Untranslated strings used in Perseus. To be used by an external

package/dist/strings.js

@@ -159,7 +159,8 @@ const strings = {
   srPointAtCoordinates: {
     context: "Screenreader-accessible description of a point on a graph",
     message: "Point %(num)s at %(x)s comma %(y)s"
-  }
+  },
+  selectAnAnswer: "Select an answer"
 };
 
 /**
@@ -438,7 +439,8 @@ const mockStrings = {
     } = _ref28;
     return `Interactive elements: ${elements}`;
   },
-  srNoInteractiveElements: "No interactive elements"
+  srNoInteractiveElements: "No interactive elements",
+  selectAnAnswer: "Select an answer"
 };
 
 exports.mockStrings = mockStrings;