@khanacademy/perseus 17.8.0 → 18.0.1

package/dist/perseus-types.d.ts

@@ -37,7 +37,7 @@ type Widget<Type extends string, Options> = {
     static?: boolean;
     graded?: boolean;
     alignment?: string;
-    options: Options | null | undefined;
+    options: Options;
     key?: number;
     version?: Version;
 };
@@ -332,10 +332,11 @@ export type PerseusMatcherWidgetOptions = {
     orderMatters: boolean;
     padding: boolean;
 };
+export type PerseusMatrixWidgetAnswers = ReadonlyArray<ReadonlyArray<number>>;
 export type PerseusMatrixWidgetOptions = {
     prefix: string;
     suffix: string;
-    answers: ReadonlyArray<ReadonlyArray<number>>;
+    answers: PerseusMatrixWidgetAnswers;
     cursorPosition: ReadonlyArray<number>;
     matrixBoardSize: ReadonlyArray<number>;
     static: boolean;
@@ -385,7 +386,7 @@ export type PerseusNumberLineWidgetOptions = {
     snapDivisions: number;
     tickStep: number | null | undefined;
     correctRel: string | null | undefined;
-    correctX: number | null | undefined;
+    correctX: number;
     initialX: number | null | undefined;
     showTooltip?: boolean;
     static: boolean;

package/dist/renderer.d.ts

@@ -3,8 +3,8 @@ import InteractionTracker from "./interaction-tracker";
 import TranslationLinter from "./translation-linter";
 import WidgetContainer from "./widget-container";
 import type { DependenciesContext } from "./dependencies";
-import type { PerseusRenderer, PerseusWidgetOptions } from "./perseus-types";
-import type { APIOptions, APIOptionsWithDefaults, FilterCriterion, FocusPath, PerseusScore, WidgetInfo, WidgetProps } from "./types";
+import type { PerseusRenderer, PerseusWidget, PerseusWidgetOptions } from "./perseus-types";
+import type { APIOptions, APIOptionsWithDefaults, FilterCriterion, FocusPath, PerseusScore, WidgetProps } from "./types";
 import type { LinterContextProps } from "@khanacademy/perseus-linter";
 import "./styles/perseus-renderer.less";
 type WidgetState = {
@@ -64,7 +64,7 @@ type Props = Partial<React.ContextType<typeof DependenciesContext>> & {
 type State = {
     translationLintErrors: ReadonlyArray<string>;
     widgetInfo: Readonly<{
-        [id: string]: WidgetInfo | null | undefined;
+        [id: string]: PerseusWidget | null | undefined;
     }>;
     widgetProps: Readonly<{
         [id: string]: any | null | undefined;
@@ -115,13 +115,13 @@ declare class Renderer extends React.Component<Props, State> {
         widgetProps: State["widgetProps"];
     };
     _getAllWidgetsInfo: (props: Props) => {
-        [key: string]: WidgetInfo;
+        [key: string]: PerseusWidget;
     };
     _getAllWidgetsStartProps: (allWidgetInfo: {
-        [key: string]: WidgetInfo;
+        [key: string]: PerseusWidget;
     }, props: Props) => any;
     _getDefaultWidgetInfo: (widgetId: string) => any;
-    _getWidgetInfo: (widgetId: string) => WidgetInfo;
+    _getWidgetInfo: (widgetId: string) => PerseusWidget;
     renderWidget: (impliedType: string, id: string, state: WidgetState) => null | React.ReactNode;
     getWidgetProps: (id: string) => WidgetProps<any, PerseusWidgetOptions>;
     /**

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

@@ -9,6 +9,7 @@ import * as PerseusLinter from "@khanacademy/perseus-linter";
  */
 import * as React from "react";
 import Renderer from "./renderer";
+import type { PerseusItem } from "./perseus-types";
 import type { APIOptions, FocusPath, PerseusDependenciesV2 } from "./types";
 import type { KeypadAPI } from "@khanacademy/math-input";
 import type { KeypadContextRendererInterface, RendererInterface, KEScore } from "@khanacademy/perseus-core";
@@ -16,10 +17,7 @@ import type { LinterContextProps } from "@khanacademy/perseus-linter";
 type OwnProps = {
     apiOptions: APIOptions;
     hintsVisible?: number;
-    item: {
-        hints: ReadonlyArray<any>;
-        question: any;
-    };
+    item: PerseusItem;
     linterContext: LinterContextProps;
     problemNum?: number;
     reviewMode?: boolean;

package/dist/strings.js

@@ -121,6 +121,7 @@ module.exports = [
     i18n._("Skip to %(title)s", {}),
     i18n._("Something went wrong.", {}),
     i18n._("Sorry, I don't understand that!", {}),
+    i18n._("Sorry, this part of the question is no longer available. 😅 Don't worry, you won't be graded on this part. Keep going!", {}),
     i18n._("Switch direction", {}),
     i18n._("Tap each dot on the image to select all answers that apply.", {}),
     i18n._("Tap each dot on the image to select an answer.", {}),
@@ -130,7 +131,6 @@ module.exports = [
     i18n._("This controls the proportion or percentage that will be used in your simulation.", {}),
     i18n._("This controls the sample size that will be used in your simulation. For example, if you set this to 100, then for each trial, responses from 100 participants will be simulated.", {}),
     i18n._("This is the number of trials used in the simulation. For example, if set to 50, then the survey will be conducted 50 times.", {}),
-    i18n._("This part of the question is no-longer available. You will not be graded on this part.", {}),
     // I18N: As in the command, "Translate the polygon"
     i18n._("Translate", {}),
     i18n._("translation", {}),

package/dist/types.d.ts

@@ -213,7 +213,15 @@ export type WidgetExports<T extends React.ComponentType<any> = React.ComponentTy
     displayName: string;
     getWidget?: () => T;
     accessible?: boolean | ((props: any) => boolean);
+    /** Supresses widget from showing up in the dropdown in the content editor */
     hidden?: boolean;
+    /**
+    The widget version. Any time the _major_ version changes, the widget
+    should provide a new entry in the propUpgrades map to migrate from the
+    older version to the current (new) version. Minor version changes must
+    be backwards compatible with previous minor versions widget options.
+    This key defaults to `{major: 0, minor: 0}` if not provided.
+     */
     version?: Version;
     supportedAlignments?: ReadonlyArray<Alignment>;
     defaultAlignment?: Alignment;
@@ -221,15 +229,24 @@ export type WidgetExports<T extends React.ComponentType<any> = React.ComponentTy
     isLintable?: boolean;
     tracking?: Tracking;
     traverseChildWidgets?: any;
+    /** transforms the widget options to the props used to render the widget */
     transform?: WidgetTransform;
+    /** transforms the widget options to the props used to render the widget for
+    static renders  */
     staticTransform?: WidgetTransform;
+    /**
+    A map of major version numbers (as a string, eg "1") to a function that
+    migrates from the _previous_ major version.
+    Example:
+      propUpgrades: {'1': (options) => ({...options})}
+    would migrate from major version 0 to 1.
+    */
     propUpgrades?: {
         [key: string]: (arg1: any) => any;
     };
     widget: T;
 }>;
-export type WidgetInfo = PerseusWidget;
-export type FilterCriterion = string | ((id: string, widgetInfo: WidgetInfo, widget?: Widget | null | undefined) => boolean);
+export type FilterCriterion = string | ((id: string, widgetInfo: PerseusWidget, widget?: Widget | null | undefined) => boolean);
 export type WidgetProps<RenderProps, Rubric, TrackingExtraArgs = Empty> = RenderProps & {
     widgetId: string;
     alignment: string | null | undefined;

package/dist/util/drawing-transform.d.ts

@@ -0,0 +1,21 @@
+import type { GraphBounds } from "./graph-bounds";
+import type { Coord } from "../interactive2/types";
+interface Raphael {
+    setSize(width: number, height: number): any;
+}
+export declare class DrawingTransform {
+    raphael: Raphael;
+    xScale: number;
+    yScale: number;
+    bounds: GraphBounds;
+    constructor(raphael: Raphael, initialScale: [number, number], bounds: GraphBounds);
+    scaleVector: (point: number | Coord) => any;
+    scalePoint: (point: number | Coord) => Coord;
+    unscalePoint: (point: number | Coord) => any;
+    unscaleVector: (point: number | Coord) => any;
+    setScale: (scale: number | Coord) => void;
+    canvasDimensions: () => Coord;
+    pixelsPerUnitX: () => number;
+    pixelsPerUnitY: () => number;
+}
+export {};

package/dist/util/extract-perseus-data.d.ts

@@ -0,0 +1,26 @@
+import type { PerseusRenderer } from "../perseus-types";
+/**
+ * This function extracts the answers from the widgets.
+ *
+ * For each widget type, we first check to make sure the path to the answer exists,
+ * then we extract the answer and add it to the list of answers.
+ *
+ * A list is returned because some widgets, like multi-select radio widgets and groups
+ * can have multiple answers.
+ *
+ * @param {PerseusRenderer["widgets"]} widgets
+ * @returns a list of strings that are the answers to the widgets
+ */
+declare function getAnswersFromWidgets(widgets: PerseusRenderer["widgets"]): ReadonlyArray<string>;
+/**
+ * Inject a string equivalent of the widgets into the content.
+ *
+ * Content may contain Perseus widgets, that looks like this: '[[☃ Radio 1]]'.
+ * This function replaces those widgets with its equivalent string.
+ *
+ * @param {string} content
+ * @param {PerseusRenderer["widgets"]} widgets
+ * @returns
+ */
+declare function injectWidgets(content: string, widgets: PerseusRenderer["widgets"]): string;
+export { getAnswersFromWidgets, injectWidgets };

package/dist/util/graph-bounds.d.ts

@@ -0,0 +1,9 @@
+export declare class GraphBounds {
+    readonly xMin: number;
+    readonly xMax: number;
+    readonly yMin: number;
+    readonly yMax: number;
+    constructor(xRange: [number, number], yRange: [number, number]);
+    width(): number;
+    height(): number;
+}

package/dist/util/graphie.d.ts

@@ -1,2 +1,4 @@
+import type { Coord } from "../interactive2/types";
+export declare function polar(r: number | Coord, th: number): number[];
 declare const GraphUtils: any;
 export default GraphUtils;

package/dist/util/interval.d.ts

@@ -0,0 +1 @@
+export type Interval = [number, number];

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

@@ -0,0 +1,10 @@
+import type { PerseusItem } from "../perseus-types";
+/**
+ * Helper to parse Perseus JSON
+ * Why not just use JSON.parse? We want:
+ * - To make sure types are correct
+ * - To give us a central place to validate/transform output if needed
+ * @param {string} input - the stringified Perseus JSON
+ * @returns {PerseusItem} the parsed PerseusItem object
+ */
+export default function parsePerseusJSON(input: string): PerseusItem;

package/dist/util/tex.d.ts

@@ -1,6 +1,4 @@
 declare const _default: {
-    processMath: (elem: HTMLElement, text: string, force?: boolean, callback?: () => unknown) => Promise<void>;
-    cleanupMath: (elem: HTMLElement) => HTMLElement;
-    retrieveMathFormula: (elem: HTMLElement) => any;
+    processMath: (elem: HTMLElement, text: string | number, force?: boolean, callback?: () => unknown) => Promise<void>;
 };
 export default _default;

package/dist/widgets/deprecated-standin/index.d.ts

@@ -1,9 +1,9 @@
 import React from "react";
 import type { PerseusScore } from "../../types";
-type AutoCorrectProps = any;
+type Props = any;
 type Rubric = any;
 type UserInput = Empty;
-declare class AutoCorrect extends React.Component<AutoCorrectProps> {
+declare class DeprecatedStandin extends React.Component<Props> {
     static validate(userInput: UserInput, rubric: Rubric): PerseusScore;
     getUserInput: () => UserInput;
     simpleValidate: (arg1: Rubric) => PerseusScore;
@@ -12,7 +12,7 @@ declare class AutoCorrect extends React.Component<AutoCorrectProps> {
 declare const _default: Readonly<{
     name: string;
     displayName: string;
-    getWidget?: (() => typeof AutoCorrect) | undefined;
+    getWidget?: (() => typeof DeprecatedStandin) | undefined;
     accessible?: boolean | ((props: any) => boolean) | undefined;
     hidden?: boolean | undefined;
     version?: import("../../types").Version | undefined;
@@ -27,6 +27,6 @@ declare const _default: Readonly<{
     propUpgrades?: {
         [key: string]: (arg1: any) => any;
     } | undefined;
-    widget: typeof AutoCorrect;
+    widget: typeof DeprecatedStandin;
 }>;
 export default _default;

package/dist/widgets/passage.d.ts

@@ -2,8 +2,8 @@ import * as React from "react";
 import type { ParseState } from "./passage/passage-markdown";
 import type { SerializedHighlightSet } from "../components/highlighting/types";
 import type { ChangeableProps } from "../mixins/changeable";
-import type { PerseusPassageWidgetOptions } from "../perseus-types";
-import type { PerseusScore, WidgetInfo, WidgetProps } from "../types";
+import type { PerseusPassageWidgetOptions, PerseusWidget } from "../perseus-types";
+import type { PerseusScore, WidgetProps } from "../types";
 import type { SingleASTNode } from "@khanacademy/simple-markdown";
 export declare class LineHeightMeasurer extends React.Component<Record<any, any>> {
     _line: HTMLDivElement | null | undefined;
@@ -18,7 +18,7 @@ type RenderProps = {
     footnotes: PerseusPassageWidgetOptions["footnotes"];
     showLineNumbers: PerseusPassageWidgetOptions["showLineNumbers"];
 };
-type FindWidgetsCallback = (id: string, widgetInfo: WidgetInfo) => boolean;
+type FindWidgetsCallback = (id: string, widgetInfo: PerseusWidget) => boolean;
 type PassageProps = ChangeableProps & WidgetProps<RenderProps, Rubric> & {
     findWidgets: (arg1: FindWidgetsCallback) => ReadonlyArray<Passage>;
     highlights: SerializedHighlightSet;

package/dist/widgets.d.ts

@@ -1,4 +1,5 @@
-import type { Alignment, Tracking, Version, WidgetExports, WidgetInfo, WidgetTransform } from "./types";
+import type { PerseusWidget } from "./perseus-types";
+import type { Alignment, Tracking, Version, WidgetExports, WidgetTransform } from "./types";
 import type * as React from "react";
 type Editor = any;
 export declare const registerWidget: (name: string, widget: WidgetExports) => void;
@@ -13,19 +14,28 @@ export declare const registerWidgets: (widgets: ReadonlyArray<WidgetExports>) =>
  */
 export declare const replaceWidget: (name: string, replacementName: string) => void;
 export declare const registerEditors: (editorsToRegister: ReadonlyArray<Editor>) => void;
+/**
+ *
+ * @param name - the widget that you are trying to replace
+ * @param replacementName - the name of the widget that takes its place
+ *
+ * e.g. replaceEditor("transformer", "always-correct") will make it so the
+ * transformer widget is replaced by the always correct widget
+ */
+export declare const replaceEditor: (name: string, replacementName: string) => void;
 export declare const getWidget: (name: string) => React.ComponentType<any> | null | undefined;
 export declare const getEditor: (name: string) => Editor | null | undefined;
 export declare const getTransform: (name: string) => WidgetTransform | null | undefined;
-export declare const getVersion: (name: string) => Version | null | undefined;
+export declare const getVersion: (name: string) => Version | undefined;
 export declare const getVersionVector: () => {
     [key: string]: Version;
 };
 export declare const getPublicWidgets: () => ReadonlyArray<WidgetExports>;
-export declare const isAccessible: (widgetInfo: WidgetInfo) => boolean;
+export declare const isAccessible: (widgetInfo: PerseusWidget) => boolean;
 export declare const getAllWidgetTypes: () => ReadonlyArray<string>;
-export declare const upgradeWidgetInfoToLatestVersion: (oldWidgetInfo: WidgetInfo) => WidgetInfo;
-export declare const getRendererPropsForWidgetInfo: (widgetInfo: WidgetInfo, problemNum?: number) => any;
-export declare const traverseChildWidgets: (widgetInfo: WidgetInfo, traverseRenderer: any) => WidgetInfo;
+export declare const upgradeWidgetInfoToLatestVersion: (oldWidgetInfo: PerseusWidget) => PerseusWidget;
+export declare const getRendererPropsForWidgetInfo: (widgetInfo: PerseusWidget, problemNum?: number) => PerseusWidget;
+export declare const traverseChildWidgets: (widgetInfo: PerseusWidget, traverseRenderer: any) => PerseusWidget;
 /**
  * Handling for the optional alignments for widgets
  * See widget-container.jsx for details on how alignments are implemented.

package/package.json

@@ -3,7 +3,7 @@
     "description": "Core Perseus API (includes renderers and widgets)",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "17.8.0",
+    "version": "18.0.1",
     "publishConfig": {
         "access": "public"
     },
@@ -24,8 +24,7 @@
     "dependencies": {
         "@khanacademy/kas": "^0.3.7",
         "@khanacademy/kmath": "^0.1.8",
-        "@khanacademy/math-input": "^16.5.0",
-        "@khanacademy/mathjax-renderer": "git+ssh://git@github.com:Khan/mathjax-renderer.git#v1.5.0",
+        "@khanacademy/math-input": "^16.5.1",
         "@khanacademy/perseus-core": "1.4.1",
         "@khanacademy/perseus-linter": "^0.3.10",
         "@khanacademy/pure-markdown": "^0.2.13",
@@ -33,23 +32,24 @@
         "@khanacademy/wonder-blocks-banner": "^3.0.33"
     },
     "devDependencies": {
+        "@khanacademy/mathjax-renderer": "git+ssh://git@github.com:Khan/mathjax-renderer.git#v1.5.1",
         "@khanacademy/wonder-blocks-button": "^6.2.5",
         "@khanacademy/wonder-blocks-clickable": "^4.0.12",
         "@khanacademy/wonder-blocks-color": "^3.0.0",
         "@khanacademy/wonder-blocks-core": "^6.3.1",
         "@khanacademy/wonder-blocks-data": "^13.0.6",
-        "@khanacademy/wonder-blocks-dropdown": "^5.1.0",
+        "@khanacademy/wonder-blocks-dropdown": "^5.1.2",
         "@khanacademy/wonder-blocks-form": "^4.3.19",
         "@khanacademy/wonder-blocks-i18n": "^2.0.2",
         "@khanacademy/wonder-blocks-layout": "^2.0.25",
         "@khanacademy/wonder-blocks-link": "^6.0.5",
-        "@khanacademy/wonder-blocks-modal": "^4.2.0",
-        "@khanacademy/wonder-blocks-pill": "^1.0.15",
-        "@khanacademy/wonder-blocks-popover": "^3.0.22",
+        "@khanacademy/wonder-blocks-modal": "^4.2.1",
+        "@khanacademy/wonder-blocks-pill": "^2.0.0",
+        "@khanacademy/wonder-blocks-popover": "^3.1.0",
         "@khanacademy/wonder-blocks-progress-spinner": "^2.0.25",
         "@khanacademy/wonder-blocks-spacing": "^4.0.1",
-        "@khanacademy/wonder-blocks-switch": "^1.1.9",
-        "@khanacademy/wonder-blocks-tooltip": "^2.1.24",
+        "@khanacademy/wonder-blocks-switch": "^1.1.10",
+        "@khanacademy/wonder-blocks-tooltip": "^2.1.25",
         "@khanacademy/wonder-blocks-typography": "^2.1.10",
         "@khanacademy/wonder-stuff-core": "^1.5.1",
         "@phosphor-icons/core": "^2.0.2",