@khanacademy/perseus 35.1.1 → 36.0.0

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

@@ -1,6 +1,6 @@
 import * as React from "react";
 import type { PerseusOrdererWidgetOptions } from "../../perseus-types";
-import type { WidgetProps } from "../../types";
+import type { PerseusScore, WidgetProps, Widget } from "../../types";
 import type { PerseusOrdererRubric, PerseusOrdererUserInput } from "../../validation.types";
 type Position = {
     left: number;
@@ -33,9 +33,10 @@ type OrdererState = {
     animateTo: Position | null | undefined;
     onAnimationEnd?: (arg1: any) => void;
 };
-declare class Orderer extends React.Component<OrdererProps, OrdererState> {
+declare class Orderer extends React.Component<OrdererProps, OrdererState> implements Widget {
     static defaultProps: OrdererDefaultProps;
     state: OrdererState;
+    static validate(userInput: PerseusOrdererUserInput, rubric: PerseusOrdererRubric): PerseusScore;
     UNSAFE_componentWillReceiveProps(nextProps: OrdererProps): void;
     onClick: (arg1: string, arg2: number, arg3: any, arg4: Element) => void;
     onRelease: (arg1: any) => void;
@@ -44,7 +45,7 @@ declare class Orderer extends React.Component<OrdererProps, OrdererState> {
     isCardInBank: (arg1: any) => boolean;
     setListValues: (arg1: ReadonlyArray<string>) => void;
     getUserInput(): PerseusOrdererUserInput;
-    simpleValidate(rubric: PerseusOrdererRubric): any;
+    simpleValidate(rubric: PerseusOrdererRubric): PerseusScore;
     render(): React.ReactNode;
 }
 declare const _default: Readonly<{

package/dist/widgets/passage/passage.d.ts

@@ -4,8 +4,8 @@ import type { ParseState } from "./passage-markdown";
 import type { SerializedHighlightSet } from "../../components/highlighting/types";
 import type { ChangeableProps } from "../../mixins/changeable";
 import type { PerseusPassageWidgetOptions, PerseusWidget } from "../../perseus-types";
-import type { WidgetProps } from "../../types";
-import type { PerseusPassageRubric, PerseusPassageUserInput } from "../../validation.types";
+import type { WidgetProps, Widget } from "../../types";
+import type { NullUserInput, PerseusPassageRubric } from "../../validation.types";
 import type { SingleASTNode } from "@khanacademy/simple-markdown";
 export declare class LineHeightMeasurer extends React.Component<Record<any, any>> {
     _line: HTMLDivElement | null | undefined;
@@ -41,7 +41,7 @@ export type Reference = {
     endLine: number;
     content: string | null | undefined;
 };
-export declare class Passage extends React.Component<PassageProps, PassageState> {
+export declare class Passage extends React.Component<PassageProps, PassageState> implements Widget {
     static contextType: React.Context<{
         strings: import("../../strings").PerseusStrings;
         locale: string;
@@ -93,7 +93,7 @@ export declare class Passage extends React.Component<PassageProps, PassageState>
      *
      * These are misc widget functions used for the widget API
      */
-    getUserInput(): PerseusPassageUserInput;
+    getUserInput(): NullUserInput;
     simpleValidate(): import("../../types").PerseusScore;
     /**
      * Rendering

package/dist/widgets/passage/utils.d.ts

@@ -0,0 +1,12 @@
+import { Passage } from "./passage";
+/**
+ * A function that detects if the given widget is a `Passage` widget. This is
+ * also a type guard so that after this function is called, the widget that was
+ * passed in is refined to be a `Passage` widget on success.
+ *
+ * This makes it a handy function to use with `.filter()` calls on arrays of
+ * widgets.
+ *
+ * Type guards: https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-guards-and-differentiating-types
+ */
+export declare function isPassageWidget(widget: any): widget is Passage;

package/dist/widgets/passage-ref/passage-ref.d.ts

@@ -1,8 +1,8 @@
 import * as React from "react";
 import { PerseusI18nContext } from "../../components/i18n-context";
 import type { PerseusPassageRefWidgetOptions } from "../../perseus-types";
-import type { ChangeFn, WidgetProps } from "../../types";
-import type { PerseusPassageRefRubric, PerseusPassageRefUserInput } from "../../validation.types";
+import type { ChangeFn, Widget, WidgetProps } from "../../types";
+import type { NullUserInput, PerseusPassageRefRubric } from "../../validation.types";
 type RenderProps = {
     passageNumber: PerseusPassageRefWidgetOptions["passageNumber"];
     referenceNumber: PerseusPassageRefWidgetOptions["referenceNumber"];
@@ -18,7 +18,7 @@ type State = {
     lineRange: [number, number] | null | undefined;
     content: string | null | undefined;
 };
-declare class PassageRef extends React.Component<Props, State> {
+declare class PassageRef extends React.Component<Props, State> implements Widget {
     static contextType: React.Context<{
         strings: import("../../strings").PerseusStrings;
         locale: string;
@@ -34,7 +34,7 @@ declare class PassageRef extends React.Component<Props, State> {
     shouldComponentUpdate(nextProps: Props, nextState: State): boolean;
     componentDidUpdate(): void;
     componentWillUnmount(): void;
-    getUserInput(): PerseusPassageRefUserInput;
+    getUserInput(): NullUserInput;
     change: ChangeFn;
     _deferredUpdateRange: () => void;
     _updateRange: () => void;

package/dist/widgets/passage-ref-target/passage-ref-target.d.ts

@@ -2,8 +2,8 @@ import * as React from "react";
 import { PerseusI18nContext } from "../../components/i18n-context";
 import * as Changeable from "../../mixins/changeable";
 import type { PerseusPassageRefTargetWidgetOptions } from "../../perseus-types";
-import type { APIOptions } from "../../types";
-import type { PerseusPassageRefTargetUserInput } from "../../validation.types";
+import type { APIOptions, Widget } from "../../types";
+import type { NullUserInput } from "../../validation.types";
 import type { LinterContextProps } from "@khanacademy/perseus-linter";
 type Props = Changeable.ChangeableProps & {
     apiOptions: APIOptions;
@@ -14,7 +14,7 @@ type DefaultProps = {
     content: Props["content"];
     linterContext: Props["linterContext"];
 };
-declare class PassageRefTarget extends React.Component<Props> {
+declare class PassageRefTarget extends React.Component<Props> implements Widget {
     static contextType: React.Context<{
         strings: import("../../strings").PerseusStrings;
         locale: string;
@@ -22,7 +22,7 @@ declare class PassageRefTarget extends React.Component<Props> {
     context: React.ContextType<typeof PerseusI18nContext>;
     static defaultProps: DefaultProps;
     static validate(): import("../../types").PerseusScore;
-    getUserInput(): PerseusPassageRefTargetUserInput;
+    getUserInput(): NullUserInput;
     change: (arg1: any, arg2: any, arg3: any) => any;
     simpleValidate(): import("../../types").PerseusScore;
     render(): React.ReactNode;

package/dist/widgets/phet-simulation/phet-simulation.d.ts

@@ -5,8 +5,8 @@
 import * as React from "react";
 import { PerseusI18nContext } from "../../components/i18n-context";
 import type { PerseusPhetSimulationWidgetOptions } from "../../perseus-types";
-import type { WidgetProps } from "../../types";
-import type { PerseusPhetSimulationUserInput } from "../../validation.types";
+import type { WidgetProps, Widget } from "../../types";
+import type { NullUserInput } from "../../validation.types";
 type RenderProps = PerseusPhetSimulationWidgetOptions;
 type Props = WidgetProps<RenderProps, PerseusPhetSimulationWidgetOptions>;
 type State = {
@@ -16,7 +16,7 @@ type State = {
     } | null;
     url: URL | null;
 };
-export declare class PhetSimulation extends React.Component<Props, State> {
+export declare class PhetSimulation extends React.Component<Props, State> implements Widget {
     static contextType: React.Context<{
         strings: import("../../strings").PerseusStrings;
         locale: string;
@@ -28,7 +28,7 @@ export declare class PhetSimulation extends React.Component<Props, State> {
     constructor(props: any);
     componentDidMount(): Promise<void>;
     componentDidUpdate(prevProps: any): Promise<void>;
-    getUserInput(): PerseusPhetSimulationUserInput;
+    getUserInput(): NullUserInput;
     getPhetCompatibleLocale: (arg1: string) => string;
     displayLoadFailure: () => void;
     updateSimState(urlString: string): Promise<void>;

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

@@ -1,7 +1,7 @@
 import * as React from "react";
 import { PerseusI18nContext } from "../../components/i18n-context";
 import type { PerseusPlotterWidgetOptions } from "../../perseus-types";
-import type { PerseusScore, WidgetProps } from "../../types";
+import type { PerseusScore, Widget, WidgetProps } from "../../types";
 import type { PerseusPlotterRubric, PerseusPlotterUserInput } from "../../validation.types";
 type RenderProps = PerseusPlotterWidgetOptions;
 type Props = WidgetProps<RenderProps, PerseusPlotterRubric> & {
@@ -25,7 +25,7 @@ type State = {
     values: ReadonlyArray<number>;
     categoryHeights: Record<string, number>;
 };
-export declare class Plotter extends React.Component<Props, State> {
+export declare class Plotter extends React.Component<Props, State> implements Widget {
     static contextType: React.Context<{
         strings: import("../../strings").PerseusStrings;
         locale: string;

package/dist/widgets/python-program/python-program.d.ts

@@ -1,4 +1,5 @@
 import * as React from "react";
+import type { FocusPath, Widget } from "../../types";
 type Props = {
     programID: string;
     height: number;
@@ -6,8 +7,12 @@ type Props = {
 type DefaultProps = {
     height: Props["height"];
 };
-declare class PythonProgram extends React.Component<Props> {
+/**
+ * This renders the program in an iframe.
+ */
+declare class PythonProgram extends React.Component<Props> implements Widget {
     static defaultProps: DefaultProps;
+    getDOMNodeForPath(path: FocusPath): null;
     render(): React.ReactNode;
 }
 declare const _default: Readonly<{

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

@@ -3,7 +3,7 @@ import { PerseusI18nContext } from "../../components/i18n-context";
 import type { FocusFunction } from "./base-radio";
 import type { PerseusRadioChoice, PerseusRadioWidgetOptions, ShowSolutions } from "../../perseus-types";
 import type { PerseusStrings } from "../../strings";
-import type { PerseusScore, WidgetProps, ChoiceState } from "../../types";
+import type { PerseusScore, WidgetProps, ChoiceState, Widget } from "../../types";
 import type { PerseusRadioRubric, PerseusRadioUserInput } from "../../validation.types";
 export type RenderProps = {
     numCorrect: number;
@@ -23,7 +23,7 @@ export type RadioChoiceWithMetadata = PerseusRadioChoice & {
     originalIndex: number;
     correct: boolean;
 };
-declare class Radio extends React.Component<Props> {
+declare class Radio extends React.Component<Props> implements Widget {
     static contextType: React.Context<{
         strings: PerseusStrings;
         locale: string;

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

@@ -1,7 +1,7 @@
 import * as React from "react";
 import type { SortableOption } from "../../components/sortable";
 import type { PerseusSorterWidgetOptions } from "../../perseus-types";
-import type { PerseusScore, WidgetProps } from "../../types";
+import type { PerseusScore, Widget, WidgetProps } from "../../types";
 import type { PerseusSorterRubric, PerseusSorterUserInput } from "../../validation.types";
 type RenderProps = PerseusSorterWidgetOptions;
 type Props = WidgetProps<RenderProps, PerseusSorterRubric>;
@@ -16,7 +16,7 @@ type DefaultProps = {
 type State = {
     changed: boolean;
 };
-declare class Sorter extends React.Component<Props, State> {
+declare class Sorter extends React.Component<Props, State> implements Widget {
     _isMounted: boolean;
     static defaultProps: DefaultProps;
     static validate(userInput: PerseusSorterUserInput, rubric: PerseusSorterRubric): PerseusScore;

package/dist/widgets/table/table.d.ts

@@ -3,7 +3,7 @@ import { PerseusI18nContext } from "../../components/i18n-context";
 import type { ChangeableProps } from "../../mixins/changeable";
 import type { PerseusTableWidgetOptions } from "../../perseus-types";
 import type { PerseusStrings } from "../../strings";
-import type { PerseusScore, WidgetProps } from "../../types";
+import type { PerseusScore, Widget, WidgetProps } from "../../types";
 import type { PerseusTableRubric, PerseusTableUserInput } from "../../validation.types";
 type RenderProps = PerseusTableWidgetOptions & {
     editableHeaders: boolean;
@@ -19,7 +19,7 @@ type DefaultProps = {
     answers: Props["answers"];
     linterContext: Props["linterContext"];
 };
-declare class Table extends React.Component<Props> {
+declare class Table extends React.Component<Props> implements Widget {
     static contextType: React.Context<{
         strings: PerseusStrings;
         locale: string;
@@ -38,7 +38,7 @@ declare class Table extends React.Component<Props> {
     focus: () => boolean;
     focusInputPath: (arg1: any) => void;
     blurInputPath: (arg1: any) => void;
-    getDOMNodeForPath: (arg1: any) => Text | Element | null | undefined;
+    getDOMNodeForPath(path: any): Element | Text | null;
     getInputPaths: () => ReadonlyArray<ReadonlyArray<string>>;
     getGrammarTypeForPath: (arg1: any) => string;
     setInputValue: (arg1: any, arg2: any, arg3: any) => void;

package/dist/widgets/video/video.d.ts

@@ -4,7 +4,7 @@
 import * as React from "react";
 import { PerseusI18nContext } from "../../components/i18n-context";
 import type { PerseusVideoWidgetOptions } from "../../perseus-types";
-import type { WidgetProps } from "../../types";
+import type { Widget, WidgetProps } from "../../types";
 import type { PerseusVideoRubric } from "../../validation.types";
 type RenderProps = PerseusVideoWidgetOptions;
 type Props = WidgetProps<RenderProps, PerseusVideoRubric> & {
@@ -13,7 +13,7 @@ type Props = WidgetProps<RenderProps, PerseusVideoRubric> & {
 /**
  * Video renderer.
  */
-declare class Video extends React.Component<Props> {
+declare class Video extends React.Component<Props> implements Widget {
     static contextType: React.Context<{
         strings: import("../../strings").PerseusStrings;
         locale: string;

package/package.json

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