@khanacademy/perseus 44.0.0 → 45.0.0

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;
     /**

package/dist/types.d.ts

@@ -403,6 +403,11 @@ export type WidgetProps<RenderProps, Rubric = Empty, TrackingExtraArgs = Empty>
     problemNum: number | null | undefined;
     apiOptions: APIOptionsWithDefaults;
     keypadElement?: any;
+    /**
+     * 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;
     onFocus: (blurPath: FocusPath) => void;
     onBlur: (blurPath: FocusPath) => void;

package/dist/widgets/expression/expression.d.ts

@@ -172,7 +172,7 @@ declare const _default: {
         visibleLabel: PerseusExpressionWidgetOptions["visibleLabel"];
         ariaLabel: PerseusExpressionWidgetOptions["ariaLabel"];
         value: string;
-    }, "ariaLabel" | "static" | "onChange" | "keypadElement" | "containerSizeClass" | "widgetId" | "problemNum" | "questionCompleted" | "findWidgets" | "trackInteraction" | "reviewMode" | keyof import("../..").PerseusDependenciesV2 | "alignment" | "reviewModeRubric" | "isLastUsedWidget" | "visibleLabel" | "buttonsVisible" | "keypadConfiguration"> & {
+    }, "ariaLabel" | "static" | "onChange" | "keypadElement" | "containerSizeClass" | "widgetId" | "problemNum" | "questionCompleted" | "findWidgets" | "trackInteraction" | "alignment" | "reviewMode" | keyof import("../..").PerseusDependenciesV2 | "reviewModeRubric" | "isLastUsedWidget" | "visibleLabel" | "buttonsVisible" | "keypadConfiguration"> & {
         value?: string | undefined;
         onFocus?: ((blurPath: FocusPath) => void) | undefined;
         onBlur?: ((blurPath: FocusPath) => void) | undefined;

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

@@ -23,7 +23,7 @@ declare class Group extends React.Component<Props> implements Widget {
     static defaultProps: DefaultProps;
     componentDidMount(): void;
     change: ChangeFn;
-    getUserInputMap(): import("../../validation.types").UserInputMap | undefined;
+    getUserInputMap(): import("../..").UserInputMap | undefined;
     /**
      * @deprecated getUserInputMap should be used for Groups
      */

package/package.json

@@ -3,7 +3,7 @@
     "description": "Core Perseus API (includes renderers and widgets)",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "44.0.0",
+    "version": "45.0.0",
     "publishConfig": {
         "access": "public"
     },