@khanacademy/perseus 19.1.5 → 19.1.7

package/src/widgets/radio/widget.tsx

@@ -1,520 +0,0 @@
-import {linterContextDefault} from "@khanacademy/perseus-linter";
-import * as i18n from "@khanacademy/wonder-blocks-i18n";
-import * as React from "react";
-
-import Renderer from "../../renderer";
-import Util from "../../util";
-import PassageRef from "../passage-ref";
-
-import BaseRadio from "./base-radio";
-
-import type {FocusFunction, ChoiceType} from "./base-radio";
-import type {
-    PerseusRadioChoice,
-    PerseusRadioWidgetOptions,
-} from "../../perseus-types";
-import type {PerseusScore, WidgetProps, ChoiceState} from "../../types";
-
-// RenderProps is the return type for radio.jsx#transform
-export type RenderProps = {
-    numCorrect: number;
-    hasNoneOfTheAbove?: boolean;
-    multipleSelect?: boolean;
-    countChoices?: boolean;
-    deselectEnabled?: boolean;
-    choices: ReadonlyArray<RadioChoiceWithMetadata>;
-    selectedChoices: ReadonlyArray<PerseusRadioChoice["correct"]>;
-    choiceStates?: ReadonlyArray<ChoiceState>;
-    // Depreciated; support for legacy way of handling changes
-    // Adds proptype for prop that is used but was lacking type
-    values?: ReadonlyArray<boolean>;
-};
-
-type UserInput = {
-    countChoices?: boolean;
-    choicesSelected: ReadonlyArray<boolean>;
-    numCorrect?: number;
-    noneOfTheAboveIndex?: number | null | undefined;
-    noneOfTheAboveSelected?: boolean;
-};
-type Rubric = PerseusRadioWidgetOptions;
-type Props = WidgetProps<RenderProps, Rubric>;
-
-type DefaultProps = {
-    choices: Props["choices"];
-    multipleSelect: Props["multipleSelect"];
-    countChoices: Props["countChoices"];
-    deselectEnabled: Props["deselectEnabled"];
-    linterContext: Props["linterContext"];
-};
-
-export type RadioChoiceWithMetadata = PerseusRadioChoice & {
-    originalIndex: number;
-    correct: boolean;
-};
-
-class Radio extends React.Component<Props> {
-    // @ts-expect-error - TS2564 - Property 'focusFunction' has no initializer and is not definitely assigned in the constructor.
-    focusFunction: FocusFunction;
-
-    static defaultProps: DefaultProps = {
-        choices: [],
-        multipleSelect: false,
-        countChoices: false,
-        deselectEnabled: false,
-        linterContext: linterContextDefault,
-    };
-
-    static validate(userInput: UserInput, rubric: Rubric): PerseusScore {
-        const numSelected = userInput.choicesSelected.reduce(
-            (sum, selected) => {
-                return sum + (selected ? 1 : 0);
-            },
-            0,
-        );
-
-        if (numSelected === 0) {
-            return {
-                type: "invalid",
-                message: null,
-            };
-        }
-
-        if (
-            userInput.numCorrect &&
-            userInput.numCorrect > 1 &&
-            numSelected !== userInput.numCorrect
-        ) {
-            return {
-                type: "invalid",
-                message: i18n._("Please choose the correct number of answers."),
-            };
-            // If NOTA and some other answer are checked, ...
-        }
-        if (userInput.noneOfTheAboveSelected && numSelected > 1) {
-            return {
-                type: "invalid",
-                message: i18n._(
-                    "'None of the above' may not be selected " +
-                        "when other answers are selected.",
-                ),
-            };
-        }
-
-        const correct = userInput.choicesSelected.every((selected, i) => {
-            let isCorrect;
-            if (userInput.noneOfTheAboveIndex === i) {
-                isCorrect = rubric.choices.every((choice, j) => {
-                    return i === j || !choice.correct;
-                });
-            } else {
-                isCorrect = !!rubric.choices[i].correct;
-            }
-            return isCorrect === selected;
-        });
-
-        return {
-            type: "points",
-            earned: correct ? 1 : 0,
-            total: 1,
-            message: null,
-        };
-    }
-
-    static getUserInputFromProps(props: Props): UserInput {
-        // Return checked inputs in the form {choicesSelected: [bool]}. (Dear
-        // future timeline implementers: this used to be {value: i} before
-        // multiple select was added)
-        if (props.choiceStates) {
-            let noneOfTheAboveIndex = null;
-            let noneOfTheAboveSelected = false;
-
-            const choiceStates = props.choiceStates;
-            const choicesSelected = choiceStates.map(() => false);
-            const countChoices = props.countChoices;
-            const numCorrect = props.numCorrect;
-
-            for (let i = 0; i < choicesSelected.length; i++) {
-                const index = props.choices[i].originalIndex;
-
-                choicesSelected[index] = choiceStates[i].selected;
-
-                if (props.choices[i].isNoneOfTheAbove) {
-                    // @ts-expect-error - TS2322 - Type 'number' is not assignable to type 'null'.
-                    noneOfTheAboveIndex = index;
-
-                    if (choicesSelected[i]) {
-                        noneOfTheAboveSelected = true;
-                    }
-                }
-            }
-
-            return {
-                countChoices,
-                choicesSelected,
-                numCorrect,
-                noneOfTheAboveIndex,
-                noneOfTheAboveSelected,
-            };
-            // Support legacy choiceState implementation
-        }
-        /* c8 ignore if - props.values is deprecated */
-        const {values} = props;
-        if (values) {
-            let noneOfTheAboveIndex = null;
-            let noneOfTheAboveSelected = false;
-
-            const choicesSelected = [...values];
-            const countChoices = props.countChoices;
-            const numCorrect = props.numCorrect;
-            const valuesLength = values.length;
-
-            for (let i = 0; i < valuesLength; i++) {
-                const index = props.choices[i].originalIndex;
-                choicesSelected[index] = values[i];
-
-                if (props.choices[i].isNoneOfTheAbove) {
-                    // @ts-expect-error - TS2322 - Type 'number' is not assignable to type 'null'.
-                    noneOfTheAboveIndex = index;
-                    if (choicesSelected[i]) {
-                        noneOfTheAboveSelected = true;
-                    }
-                }
-            }
-            return {
-                choicesSelected,
-                noneOfTheAboveIndex,
-                noneOfTheAboveSelected,
-                countChoices,
-                numCorrect,
-            };
-        }
-        // Nothing checked
-        return {
-            choicesSelected: props.choices.map(() => false),
-        };
-    }
-
-    _renderRenderer: (content?: string) => React.ReactElement = (
-        content = "",
-    ) => {
-        let nextPassageRefId = 1;
-        const widgets: Record<string, any> = {};
-
-        const modContent = content.replace(
-            /\{\{passage-ref (\d+) (\d+)(?: "([^"]*)")?\}\}/g,
-            (
-                match: string,
-                passageNum: string,
-                refNum: string,
-                summaryText: string,
-            ) => {
-                const widgetId = "passage-ref " + nextPassageRefId;
-                nextPassageRefId++;
-
-                widgets[widgetId] = {
-                    type: "passage-ref",
-                    graded: false,
-                    options: {
-                        passageNumber: parseInt(passageNum),
-                        referenceNumber: parseInt(refNum),
-                        summaryText: summaryText,
-                    },
-                    version: PassageRef.version,
-                };
-
-                return "[[" + Util.snowman + " " + widgetId + "]]";
-            },
-        );
-
-        // alwaysUpdate={true} so that passage-refs findWidgets
-        // get called when the outer passage updates the renderer
-        // TODO(aria): This is really hacky
-        // We pass in a key here so that we avoid a semi-spurious
-        // react warning when the ChoiceNoneAbove renders a
-        // different renderer in the same place. Note this destroys
-        // state, but since all we're doing is outputting
-        // "None of the above", that is okay.
-        // TODO(mdr): Widgets inside this Renderer are not discoverable through
-        //     the parent Renderer's `findWidgets` function.
-        return (
-            <Renderer
-                key="choiceContentRenderer"
-                content={modContent}
-                widgets={widgets}
-                findExternalWidgets={this.props.findWidgets}
-                alwaysUpdate={true}
-                linterContext={{
-                    ...this.props.linterContext,
-                    // @ts-expect-error - TS2322 - Type '{ blockHighlight: true; contentType: string; highlightLint: boolean; paths: readonly string[]; stack: readonly string[]; }' is not assignable to type 'LinterContextProps'.
-                    blockHighlight: true,
-                }}
-            />
-        );
-    };
-
-    // TODO(LP-10672): I think this might be unused right now. I can't find anywhere
-    // that we pass a value to `.focus()` and it seems to have been used for
-    // adding hints when editing.
-    // See: https://github.com/Khan/perseus/blame/e18582b4b69959270b90e237ef1813899711ddfa/src/widgets/radio.js#L169
-    focus(choiceIndex?: number | null): boolean {
-        if (this.focusFunction) {
-            return this.focusFunction(choiceIndex);
-        }
-
-        return false;
-    }
-
-    // lets BaseRadio regiser a focus callback so widget
-    // can focus an individual choice
-    registerFocusFunction(fun: FocusFunction): void {
-        this.focusFunction = fun;
-    }
-
-    // When `BaseRadio`'s `onChange` handler is called, indicating a change in
-    // our choices' state, we need to call our `onChange` handler in order to
-    // persist those changes in the item's Perseus state.
-    //
-    // So, given the new values for each choice, construct the new
-    // `choiceStates` objects, and pass them to `this.props.onChange`.
-    //
-    // `newValueLists` is an object with two keys: `checked` and `crossedOut`.
-    // Each contains an array of boolean values, specifying the new checked and
-    // crossed-out value of each choice.
-    //
-    // NOTE(mdr): This method expects to be auto-bound. If this component is
-    //     converted to an ES6 class, take care to auto-bind this method!
-    updateChoices: (
-        newValueLists: Readonly<{
-            checked: ReadonlyArray<boolean>;
-            crossedOut: ReadonlyArray<boolean>;
-        }>,
-    ) => void = (newValueLists) => {
-        const {choiceStates, choices} = this.props;
-
-        // Construct the baseline `choiceStates` objects. If this is the user's
-        // first interaction with the widget, we'll need to initialize them to
-        // new objects with all fields set to the default values. Otherwise, we
-        // should clone the old `choiceStates` objects, in preparation to
-        // mutate them.
-        const newChoiceStates = choiceStates
-            ? choiceStates.map((state: ChoiceState) => ({...state}))
-            : choices.map(() => ({
-                  selected: false,
-                  crossedOut: false,
-                  highlighted: false,
-                  rationaleShown: false,
-                  correctnessShown: false,
-                  previouslyAnswered: false,
-                  readOnly: false,
-              }));
-
-        // Mutate the new `choiceState` objects, according to the new `checked`
-        // and `crossedOut` values provided in `newValueLists`.
-        newChoiceStates.forEach((choiceState: ChoiceState, i) => {
-            choiceState.selected = newValueLists.checked[i];
-            choiceState.crossedOut = newValueLists.crossedOut[i];
-        });
-
-        this.props.onChange({choiceStates: newChoiceStates});
-        this.props.trackInteraction();
-    };
-
-    getUserInput: () => UserInput = () => {
-        return Radio.getUserInputFromProps(this.props);
-    };
-
-    simpleValidate: (arg1: PerseusRadioWidgetOptions) => PerseusScore = (
-        rubric,
-    ) => {
-        return Radio.validate(this.getUserInput(), rubric);
-    };
-
-    /**
-     * Turn on rationale display for the currently selected choices. Note that
-     * this leaves rationales on for choices that are already showing
-     * rationales.
-     */
-    showRationalesForCurrentlySelectedChoices: (
-        arg1: PerseusRadioWidgetOptions,
-    ) => void = (rubric) => {
-        const {choiceStates} = this.props;
-        if (choiceStates) {
-            const score = this.simpleValidate(rubric);
-            const widgetCorrect =
-                score.type === "points" && score.total === score.earned;
-
-            const newStates: ReadonlyArray<ChoiceState> = choiceStates.map(
-                (state: ChoiceState): ChoiceState => ({
-                    ...state,
-                    highlighted: state.selected,
-                    // If the choice is selected, show the rationale now
-                    rationaleShown:
-                        state.selected ||
-                        // If the choice already had a rationale, keep it shown
-                        state.rationaleShown ||
-                        // If the widget is correctly answered, show the rationale
-                        // for all the choices
-                        widgetCorrect,
-                    // We use the same behavior for the readOnly flag as for
-                    // rationaleShown, but we keep it separate in case other
-                    // behaviors want to disable choices without showing rationales.
-                    readOnly: state.selected || state.readOnly || widgetCorrect,
-                    correctnessShown: state.selected || state.correctnessShown,
-                    previouslyAnswered:
-                        state.previouslyAnswered || state.selected,
-                }),
-            );
-
-            this.props.onChange(
-                {
-                    choiceStates: newStates,
-                },
-                // @ts-expect-error - TS2345 - Argument of type 'null' is not assignable to parameter of type '(() => unknown) | undefined'.
-                null, // cb
-                true, // silent
-            );
-        }
-    };
-
-    /**
-     * Deselects any currently-selected choices that are not correct choices.
-     */
-    deselectIncorrectSelectedChoices: () => void = () => {
-        if (this.props.choiceStates) {
-            const newStates: ReadonlyArray<ChoiceState> =
-                this.props.choiceStates.map(
-                    (state: ChoiceState, i): ChoiceState => ({
-                        ...state,
-                        selected:
-                            state.selected && !!this.props.choices[i].correct,
-                        highlighted: false,
-                    }),
-                );
-
-            this.props.onChange(
-                {
-                    choiceStates: newStates,
-                },
-                // @ts-expect-error - TS2345 - Argument of type 'null' is not assignable to parameter of type '(() => unknown) | undefined'.
-                null, // cb
-                false, // silent
-            );
-        }
-    };
-
-    render(): React.ReactNode {
-        const {choices} = this.props;
-        let choiceStates: ReadonlyArray<ChoiceState>;
-        if (this.props.static) {
-            choiceStates = choices.map((choice) => ({
-                selected: !!choice.correct,
-                crossedOut: false,
-                readOnly: true,
-                highlighted: false,
-                rationaleShown: true,
-                correctnessShown: true,
-                previouslyAnswered: false,
-            }));
-        } else if (this.props.choiceStates) {
-            choiceStates = this.props.choiceStates;
-        } else if (this.props.values) {
-            // Support legacy choiceStates implementation
-            /* c8 ignore next - props.values is deprecated */
-            choiceStates = this.props.values.map((val) => ({
-                selected: val,
-                crossedOut: false,
-                readOnly: false,
-                highlighted: false,
-                rationaleShown: false,
-                correctnessShown: false,
-                previouslyAnswered: false,
-            }));
-        } else {
-            choiceStates = choices.map(() => ({
-                selected: false,
-                crossedOut: false,
-                readOnly: false,
-                highlighted: false,
-                rationaleShown: false,
-                correctnessShown: false,
-                previouslyAnswered: false,
-            }));
-        }
-
-        const choicesProp: ReadonlyArray<ChoiceType> = choices.map(
-            (choice, i) => {
-                const content =
-                    choice.isNoneOfTheAbove && !choice.content
-                        ? // we use i18n._ instead of $_ here because the content
-                          // sent to a renderer needs to be a string, not a react
-                          // node (/renderable/fragment).
-                          i18n._("None of the above")
-                        : choice.content;
-
-                const {
-                    selected,
-                    crossedOut,
-                    rationaleShown,
-                    correctnessShown,
-                    readOnly,
-                    highlighted,
-                    previouslyAnswered,
-                } = choiceStates[i];
-
-                const reviewChoice =
-                    this.props.reviewModeRubric &&
-                    this.props.reviewModeRubric.choices[i];
-
-                return {
-                    content: this._renderRenderer(content),
-                    checked: selected,
-                    // Current versions of the radio widget always pass in the
-                    // "correct" value through the choices. Old serialized state
-                    // for radio widgets doesn't have this though, so we have to
-                    // pull the correctness out of the review mode rubric. This
-                    // only works because all of the places we use
-                    // `restoreSerializedState()` also turn on reviewMode, but is
-                    // fine for now.
-                    // TODO(emily): Come up with a more comprehensive way to solve
-                    // this sort of "serialized state breaks when internal
-                    // structure changes" problem.
-                    correct:
-                        choice.correct === undefined
-                            ? !!reviewChoice && !!reviewChoice.correct
-                            : choice.correct,
-                    disabled: readOnly,
-                    hasRationale: !!choice.clue,
-                    rationale: this._renderRenderer(choice.clue),
-                    showRationale: rationaleShown,
-                    showCorrectness: correctnessShown,
-                    isNoneOfTheAbove: !!choice.isNoneOfTheAbove,
-                    revealNoneOfTheAbove: !!(
-                        this.props.questionCompleted && selected
-                    ),
-                    crossedOut,
-                    highlighted,
-                    previouslyAnswered: previouslyAnswered,
-                };
-            },
-        );
-
-        return (
-            <BaseRadio
-                labelWrap={true}
-                multipleSelect={this.props.multipleSelect}
-                countChoices={this.props.countChoices}
-                numCorrect={this.props.numCorrect}
-                choices={choicesProp}
-                onChange={this.updateChoices}
-                reviewModeRubric={this.props.reviewModeRubric}
-                deselectEnabled={this.props.deselectEnabled}
-                apiOptions={this.props.apiOptions}
-                isLastUsedWidget={this.props.isLastUsedWidget}
-                registerFocusFunction={(i) => this.registerFocusFunction(i)}
-            />
-        );
-    }
-}
-
-export default Radio;

package/src/widgets/radio.ts

@@ -1,157 +0,0 @@
-import * as i18n from "@khanacademy/wonder-blocks-i18n";
-import _ from "underscore";
-
-import Util from "../util";
-
-import Radio from "./radio/widget";
-
-import type {RenderProps, RadioChoiceWithMetadata} from "./radio/widget";
-import type {PerseusRadioWidgetOptions} from "../perseus-types";
-import type {WidgetExports} from "../types";
-
-const {shuffle, random} = Util;
-
-// Represents choices that we automatically re-order if encountered.
-// Note: these are in the reversed (incorrect) order that we will swap, if
-// found.
-// Note 2: these are internationalized when compared later on.
-const ReversedChoices: ReadonlyArray<[string, string]> = [
-    [i18n._("False"), i18n._("True")],
-    [i18n._("No"), i18n._("Yes")],
-];
-
-// Transforms the choices for display.
-const _choiceTransform = (
-    widgetOptions: PerseusRadioWidgetOptions,
-    problemNum?: number | null,
-) => {
-    const _maybeRandomize = function (
-        array: ReadonlyArray<RadioChoiceWithMetadata>,
-    ) {
-        const randomSeed = problemNum === undefined ? random : problemNum;
-        // NOTE: `problemNum` will only be set when the radio widget is
-        // rendered at the root of an exercise question. It will be `undefined`
-        // if it's rendered embedded in another widget, such as `graded-group`,
-        // or if rendered within an article. This results in a predictable
-        // shuffle order. To avoid this we use a random seed when `problemNum`
-        // is `undefined`.
-        return widgetOptions.randomize
-            ? shuffle(array, randomSeed ?? 0)
-            : array;
-    };
-
-    const _addNoneOfAbove = function (
-        choices: ReadonlyArray<RadioChoiceWithMetadata>,
-    ) {
-        let noneOfTheAbove = null;
-
-        const newChoices = choices.filter((choice, index) => {
-            if (choice.isNoneOfTheAbove) {
-                // @ts-expect-error - TS2322 - Type 'RadioChoiceWithMetadata' is not assignable to type 'null'.
-                noneOfTheAbove = choice;
-                return false;
-            }
-            return true;
-        });
-
-        // Place the "None of the above" options last
-        if (noneOfTheAbove) {
-            newChoices.push(noneOfTheAbove);
-        }
-
-        return newChoices;
-    };
-
-    const enforceOrdering = (
-        choices: ReadonlyArray<RadioChoiceWithMetadata>,
-    ) => {
-        const content = choices.map((c) => c.content);
-        if (ReversedChoices.some((reversed) => _.isEqual(content, reversed))) {
-            return [choices[1], choices[0]];
-        }
-        return choices;
-    };
-
-    // Add meta-information to choices
-    const choices: ReadonlyArray<RadioChoiceWithMetadata> =
-        widgetOptions.choices.map((choice, i): RadioChoiceWithMetadata => {
-            return {
-                ...choice,
-                originalIndex: i,
-                correct: Boolean(choice.correct),
-            };
-        });
-
-    // Apply all the transforms. Note that the order we call these is
-    // important!
-    // 3) finally add "None of the above" to the bottom
-    return _addNoneOfAbove(
-        // 2) then (potentially) enforce ordering (eg. False, True becomes
-        //    True, False)
-        enforceOrdering(
-            // 1) we randomize the order first
-            _maybeRandomize(choices),
-        ),
-    );
-};
-
-const transform = (
-    widgetOptions: PerseusRadioWidgetOptions,
-    problemNum?: number | null,
-): RenderProps => {
-    const choices = _choiceTransform(widgetOptions, problemNum);
-
-    const numCorrect: number = _.reduce(
-        widgetOptions.choices,
-        function (memo, choice) {
-            return choice.correct ? memo + 1 : memo;
-        },
-        0,
-    );
-
-    const {hasNoneOfTheAbove, multipleSelect, countChoices, deselectEnabled} =
-        widgetOptions;
-
-    return {
-        numCorrect,
-        hasNoneOfTheAbove,
-        multipleSelect,
-        countChoices,
-        deselectEnabled,
-        choices,
-        selectedChoices: _.pluck(choices, "correct"),
-    };
-};
-
-const propUpgrades = {
-    "1": (v0props: any): any => {
-        let choices;
-        let hasNoneOfTheAbove;
-
-        if (!v0props.noneOfTheAbove) {
-            choices = v0props.choices;
-            hasNoneOfTheAbove = false;
-        } else {
-            throw new Error(
-                "radio widget v0 no longer supports auto noneOfTheAbove",
-            );
-        }
-
-        return _.extend(_.omit(v0props, "noneOfTheAbove"), {
-            choices: choices,
-            hasNoneOfTheAbove: hasNoneOfTheAbove,
-        });
-    },
-} as const;
-
-export default {
-    name: "radio",
-    displayName: "Radio / Multiple choice",
-    accessible: true,
-    widget: Radio,
-    transform: transform,
-    staticTransform: transform,
-    version: {major: 1, minor: 0},
-    propUpgrades: propUpgrades,
-    isLintable: true,
-} as WidgetExports<typeof Radio>;