@khanacademy/perseus 21.1.0 → 21.2.0

package/dist/perseus-api.d.ts

@@ -96,7 +96,7 @@ export declare const ApiOptions: {
         crossOutEnabled?: boolean | undefined;
         editorChangeDelay?: number | undefined;
         flags?: Record<string, boolean | Record<string, boolean>> | undefined;
-        onWidgetStartProps?: ((widgets: import("./perseus-types").PerseusWidgetsMap) => import("./perseus-types").PerseusWidgetsMap) | undefined;
+        onWidgetStartProps?: ((widgets: import("./perseus-types").PerseusWidgetsMap) => void) | undefined;
     }> & {
         GroupMetadataEditor: NonNullable<React.ComponentType<any> | undefined>;
         baseElements: {

package/dist/perseus-types.d.ts

@@ -250,6 +250,10 @@ export type PerseusGradedGroupWidgetOptions = {
 export type PerseusGradedGroupSetWidgetOptions = {
     gradedGroups: ReadonlyArray<PerseusGradedGroupWidgetOptions>;
 };
+export type GraphRange = [
+    x: [min: number, max: number],
+    y: [min: number, max: number]
+];
 export type PerseusGrapherWidgetOptions = {
     availableTypes: ReadonlyArray<"absolute_value" | "exponential" | "linear" | "logarithm" | "quadratic" | "sinusoid" | "tangent">;
     correct: {
@@ -296,7 +300,7 @@ export type PerseusGrapherWidgetOptions = {
         gridStep?: [number, number];
         labels: [string, string];
         markings: "graph" | "none" | "grid";
-        range: [[number, number], [number, number]];
+        range: GraphRange;
         rulerLabel: "";
         rulerTicks: number;
         showProtractor?: boolean;
@@ -341,7 +345,7 @@ export type PerseusInteractiveGraphWidgetOptions = {
     showTooltips?: boolean;
     rulerLabel: string;
     rulerTicks: number;
-    range: [[number, number], [number, number]];
+    range: GraphRange;
     graph: PerseusGraphType;
     correct: PerseusGraphType;
     lockedFigures?: ReadonlyArray<LockedFigure>;

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

@@ -138,7 +138,7 @@ declare const ref: React.ForwardRefExoticComponent<Omit<Pick<OwnProps & HOCProps
         crossOutEnabled?: boolean | undefined;
         editorChangeDelay?: number | undefined;
         flags?: Record<string, boolean | Record<string, boolean>> | undefined;
-        onWidgetStartProps?: ((widgets: import("./perseus-types").PerseusWidgetsMap) => import("./perseus-types").PerseusWidgetsMap) | undefined;
+        onWidgetStartProps?: ((widgets: import("./perseus-types").PerseusWidgetsMap) => void) | undefined;
     }> | undefined;
     linterContext?: PerseusLinter.LinterContextProps | undefined;
     onRendered?: ((isRendered: boolean) => void) | undefined;

package/dist/types.d.ts

@@ -205,7 +205,7 @@ export type APIOptions = Readonly<{
      * This is useful for when we need to know how a widget has shuffled its
      * the available choices.
      */
-    onWidgetStartProps?: (widgets: PerseusWidgetsMap) => PerseusWidgetsMap;
+    onWidgetStartProps?: (widgets: PerseusWidgetsMap) => void;
 }>;
 type TeXProps = {
     children: string;

package/dist/util.d.ts

@@ -188,6 +188,8 @@ declare function getWordBeforeCursor(textarea: HTMLTextAreaElement): WordAndPosi
  * @param {int} pos - The position where the cursor will be moved
  */
 declare function moveCursor(textarea: HTMLTextAreaElement, pos: number): void;
+type Cloneable = null | undefined | boolean | string | number | Cloneable[] | readonly Cloneable[];
+declare function deepClone<T extends Cloneable>(obj: T): T;
 declare const Util: {
     readonly inputPathsEqual: typeof inputPathsEqual;
     readonly nestedMap: <T, M>(children: T | ReadonlyArray<T>, func: (arg1: T) => M, context: unknown) => M | ReadonlyArray<M>;
@@ -242,5 +244,6 @@ declare const Util: {
     };
     readonly unescapeMathMode: (label: string) => string;
     readonly random: RNG;
+    readonly deepClone: typeof deepClone;
 };
 export default Util;

package/dist/widgets/expression.d.ts

@@ -124,7 +124,7 @@ declare const _default: Readonly<{
             crossOutEnabled?: boolean | undefined;
             editorChangeDelay?: number | undefined;
             flags?: Record<string, boolean | Record<string, boolean>> | undefined;
-            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => import("../perseus-types").PerseusWidgetsMap) | undefined;
+            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => void) | undefined;
         }> & {
             GroupMetadataEditor: NonNullable<React.ComponentType<any> | undefined>;
             baseElements: {
@@ -191,7 +191,7 @@ declare const _default: Readonly<{
             crossOutEnabled?: boolean | undefined;
             editorChangeDelay?: number | undefined;
             flags?: Record<string, boolean | Record<string, boolean>> | undefined;
-            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => import("../perseus-types").PerseusWidgetsMap) | undefined;
+            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => void) | undefined;
         }> & {
             GroupMetadataEditor: NonNullable<React.ComponentType<any> | undefined>;
             baseElements: {
@@ -258,7 +258,7 @@ declare const _default: Readonly<{
             crossOutEnabled?: boolean | undefined;
             editorChangeDelay?: number | undefined;
             flags?: Record<string, boolean | Record<string, boolean>> | undefined;
-            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => import("../perseus-types").PerseusWidgetsMap) | undefined;
+            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => void) | undefined;
         }> & {
             GroupMetadataEditor: NonNullable<React.ComponentType<any> | undefined>;
             baseElements: {
@@ -322,7 +322,7 @@ declare const _default: Readonly<{
             crossOutEnabled?: boolean | undefined;
             editorChangeDelay?: number | undefined;
             flags?: Record<string, boolean | Record<string, boolean>> | undefined;
-            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => import("../perseus-types").PerseusWidgetsMap) | undefined;
+            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => void) | undefined;
         }> & {
             GroupMetadataEditor: NonNullable<React.ComponentType<any> | undefined>;
             baseElements: {
@@ -389,7 +389,7 @@ declare const _default: Readonly<{
             crossOutEnabled?: boolean | undefined;
             editorChangeDelay?: number | undefined;
             flags?: Record<string, boolean | Record<string, boolean>> | undefined;
-            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => import("../perseus-types").PerseusWidgetsMap) | undefined;
+            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => void) | undefined;
         }> & {
             GroupMetadataEditor: NonNullable<React.ComponentType<any> | undefined>;
             baseElements: {
@@ -456,7 +456,7 @@ declare const _default: Readonly<{
             crossOutEnabled?: boolean | undefined;
             editorChangeDelay?: number | undefined;
             flags?: Record<string, boolean | Record<string, boolean>> | undefined;
-            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => import("../perseus-types").PerseusWidgetsMap) | undefined;
+            onWidgetStartProps?: ((widgets: import("../perseus-types").PerseusWidgetsMap) => void) | undefined;
         }> & {
             GroupMetadataEditor: NonNullable<React.ComponentType<any> | undefined>;
             baseElements: {

package/dist/widgets/interactive-graph.d.ts

@@ -5,7 +5,10 @@ import type { Widget } from "../renderer";
 import type { ChangeHandler, PerseusScore, WidgetProps } from "../types";
 import type { QuadraticCoefficient, SineCoefficient, Range } from "../util/geometry";
 type RenderProps = PerseusInteractiveGraphWidgetOptions;
-type Rubric = PerseusInteractiveGraphWidgetOptions;
+export type Rubric = {
+    correct: PerseusGraphType;
+    graph: PerseusGraphType;
+};
 type Props = WidgetProps<RenderProps, Rubric>;
 type State = any;
 type DefaultProps = {

package/dist/widgets/interactive-graphs/axis-ticks.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+export declare function generateTickLocations(tickStep: number, min: number, max: number): number[];
+type Props = {
+    tickStep: [number, number];
+    range: [[number, number], [number, number]];
+};
+export declare const AxisTicks: (props: Props) => JSX.Element;
+export {};

package/dist/widgets/interactive-graphs/graphs/components/movable-line.d.ts

@@ -1,14 +1,16 @@
 /// <reference types="react" />
 import { vec } from "mafs";
 import type { Interval } from "mafs";
-export declare const MovableLine: (props: {
+type Props = {
     start: vec.Vector2;
     end: vec.Vector2;
     onMove: (delta: vec.Vector2) => unknown;
-    stroke?: string | undefined;
+    stroke?: string;
     extend?: {
         start: boolean;
         end: boolean;
         range: [Interval, Interval];
-    } | undefined;
-}) => JSX.Element;
+    };
+};
+export declare const MovableLine: (props: Props) => JSX.Element;
+export {};

package/dist/widgets/interactive-graphs/grid.d.ts

@@ -1,11 +1,22 @@
 /// <reference types="react" />
+import type { GraphRange } from "../../perseus-types";
 import type { SizeClass } from "../../util/sizing-utils";
+import type { vec } from "mafs";
 interface GridProps {
-    step: [number, number];
-    gridStep: [number, number];
-    range: [[number, number], [number, number]];
+    tickStep: vec.Vector2;
+    gridStep: vec.Vector2;
+    range: GraphRange;
     containerSizeClass: SizeClass;
     markings: "graph" | "grid" | "none";
 }
+/**
+ * lineLabelText get the text that should
+ * be displayed for a specific tick place
+ *
+ * @param {number} n the tick number
+ * @param {number} tickStep how frequently a label should appear
+ * @param {vec.Vector2} range the min/max range on the axis
+ */
+export declare const lineLabelText: (n: number, tickStep: number, range: vec.Vector2) => string;
 export declare const Grid: (props: GridProps) => JSX.Element | null;
 export {};

package/dist/widgets/interactive-graphs/mafs-graph.d.ts

@@ -3,7 +3,7 @@ import type { InteractiveGraphProps } from "./types";
 import type { Widget } from "../../renderer";
 import "mafs/core.css";
 import "./mafs-styles.css";
-export type MafsWrapperProps = {
+export type Props = {
     box: [number, number];
     backgroundImage?: InteractiveGraphProps["backgroundImage"];
     graph: InteractiveGraphProps["graph"];
@@ -16,6 +16,6 @@ export type MafsWrapperProps = {
     markings: InteractiveGraphProps["markings"];
     onChange: InteractiveGraphProps["onChange"];
 };
-export declare const MafsGraph: React.ForwardRefExoticComponent<MafsWrapperProps & {
+export declare const MafsGraph: React.ForwardRefExoticComponent<Props & {
     children?: React.ReactNode;
 } & React.RefAttributes<Partial<Widget>>>;

package/dist/widgets/interactive-graphs/reducer/interactive-graph-action.d.ts

@@ -1,5 +1,6 @@
+import type { Props as MafsGraphProps } from "../mafs-graph";
 import type { vec } from "mafs";
-export type InteractiveGraphAction = MoveControlPoint | MoveLine | MoveAll | MovePoint;
+export type InteractiveGraphAction = MoveControlPoint | MoveLine | MoveAll | MovePoint | ChangeSnapStep | ChangeRange;
 export declare const MOVE_CONTROL_POINT = "move-control-point";
 export interface MoveControlPoint {
     type: typeof MOVE_CONTROL_POINT;
@@ -31,4 +32,16 @@ export interface MovePoint {
     destination: vec.Vector2;
 }
 export declare function movePoint(index: number, destination: vec.Vector2): MovePoint;
+export declare const CHANGE_SNAP_STEP = "change-snap-step";
+export interface ChangeSnapStep {
+    type: typeof CHANGE_SNAP_STEP;
+    snapStep: MafsGraphProps["snapStep"];
+}
+export declare function changeSnapStep(snapStep: MafsGraphProps["snapStep"]): ChangeSnapStep;
+export declare const CHANGE_RANGE = "change-range";
+export interface ChangeRange {
+    type: typeof CHANGE_RANGE;
+    range: MafsGraphProps["range"];
+}
+export declare function changeRange(range: MafsGraphProps["range"]): ChangeRange;
 export {};

package/dist/widgets/interactive-graphs/utils.d.ts

@@ -1,5 +1,6 @@
 import type { Coord } from "../../interactive2/types";
 import type { PerseusInteractiveGraphWidgetOptions } from "../../perseus-types";
+import type { vec } from "mafs";
 /**
  * 44 is touch best practice and AAA compliant for WCAG
  * https://www.w3.org/WAI/WCAG21/Understanding/target-size.html
@@ -7,3 +8,4 @@ import type { PerseusInteractiveGraphWidgetOptions } from "../../perseus-types";
 export declare const TARGET_SIZE = 44;
 export declare const normalizePoints: <A extends Coord[]>(range: PerseusInteractiveGraphWidgetOptions["range"], step: PerseusInteractiveGraphWidgetOptions["step"], coordsList: A, noSnap?: boolean) => A;
 export declare const normalizeCoords: <A extends Coord[]>(coordsList: A, ranges: PerseusInteractiveGraphWidgetOptions["range"]) => A;
+export declare function snap(snapStep: vec.Vector2, point: vec.Vector2): vec.Vector2;

package/dist/widgets/label-image.d.ts

@@ -123,7 +123,7 @@ declare const _default: Readonly<{
             crossOutEnabled?: boolean | undefined;
             editorChangeDelay?: number | undefined;
             flags?: Record<string, boolean | Record<string, boolean>> | undefined;
-            onWidgetStartProps?: ((widgets: import("..").PerseusWidgetsMap) => import("..").PerseusWidgetsMap) | undefined;
+            onWidgetStartProps?: ((widgets: import("..").PerseusWidgetsMap) => void) | undefined;
         }>;
         choices: readonly string[];
         imageAlt: string;
@@ -172,7 +172,7 @@ declare const _default: Readonly<{
             crossOutEnabled?: boolean | undefined;
             editorChangeDelay?: number | undefined;
             flags?: Record<string, boolean | Record<string, boolean>> | undefined;
-            onWidgetStartProps?: ((widgets: import("..").PerseusWidgetsMap) => import("..").PerseusWidgetsMap) | undefined;
+            onWidgetStartProps?: ((widgets: import("..").PerseusWidgetsMap) => void) | undefined;
         }>;
         choices: readonly string[];
         imageAlt: string;

package/package.json

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