@khanacademy/perseus 19.1.5 → 19.1.7

package/dist/interactive2/movable-point.d.ts

@@ -1,2 +1,196 @@
-declare const MovablePoint: (graphie: any, movable: any, options: any) => void;
+import type { Movable } from "./movable";
+import type { Constraint, ConstraintCallbacks } from "./types";
+import type { Graphie } from "../util/graphie";
+import type { Coord } from "@khanacademy/perseus";
+type State = {
+    add: unknown[];
+    added: boolean;
+    constraints: Constraint[];
+    coord: Coord;
+    cursor: "move";
+    draw: ((state: State, prevState: State) => void)[];
+    hasMoved: boolean;
+    id: string;
+    modify: unknown[];
+    onClick: unknown[];
+    onMove: ((coord: Coord, prevCoord: Coord) => void)[];
+    onMoveEnd: unknown[];
+    onMoveStart: unknown[];
+    onRemove?: () => void;
+    outOfBounds: boolean;
+    pointSize: number;
+    remove: (() => void)[];
+    shadow: boolean;
+    static: boolean;
+    tooltip: boolean;
+    touchOffset: null | Coord;
+    mouseTarget: unknown;
+    visibleShape: {
+        wrapper: HTMLElement;
+        toBack(): void;
+        toFront(): void;
+    };
+    normalStyle: Record<string, any>;
+    highlightStyle: Record<string, any>;
+};
+export declare class MovablePoint {
+    graphie: Graphie;
+    movable: Movable<Record<string, never>>;
+    state: State;
+    prevState: State;
+    _tooltip?: HTMLElement;
+    _listenerMap: Record<string, number>;
+    constructor(graphie: Graphie, movable: Movable<Record<string, never>>, options: Partial<State>);
+    modify(options: any): void;
+    _createDefaultState(): {
+        coord: readonly [0, 0];
+        pointSize: 4;
+        static: false;
+        cursor: "move";
+        normalStyle: null;
+        highlightStyle: null;
+        shadow: false;
+        tooltip: false;
+        id: string;
+    };
+    cloneState(): {
+        add: unknown[];
+        added: boolean;
+        constraints: Constraint[];
+        coord: Coord;
+        cursor: "move";
+        draw: ((state: State, prevState: State) => void)[];
+        hasMoved: boolean;
+        id: string;
+        modify: unknown[];
+        onClick: unknown[];
+        onMove: ((coord: Coord, prevCoord: Coord) => void)[];
+        onMoveEnd: unknown[];
+        onMoveStart: unknown[];
+        onRemove?: (() => void) | undefined;
+        outOfBounds: boolean;
+        pointSize: number;
+        remove: (() => void)[];
+        shadow: boolean;
+        static: boolean;
+        tooltip: boolean;
+        touchOffset: Coord | null;
+        mouseTarget: unknown;
+        visibleShape: {
+            wrapper: HTMLElement;
+            toBack(): void;
+            toFront(): void;
+        };
+        normalStyle: Record<string, any>;
+        highlightStyle: Record<string, any>;
+        isHovering?: boolean | undefined;
+        isMouseOver?: boolean | undefined;
+        isDragging?: boolean | undefined;
+    };
+    update(options: Partial<State>): void;
+    draw(): void;
+    constrain(): boolean;
+    /**
+     * Fire an onSomething type event to all functions in listeners
+     */
+    _fireEvent<F extends (...args: any[]) => any>(listeners: F[], ...args: Parameters<F>): void;
+    /**
+     * Combine the array of constraints functions
+     * Returns either an [x, y] coordinate or false
+     */
+    _applyConstraints(current: Coord, previous: Coord, extraOptions?: ConstraintCallbacks): Coord | false;
+    /**
+     * Displays a tooltip above the point, replacing any previous contents. If
+     * there is no tooltip initialized, adds the tooltip.
+     *
+     * If the type of contents is string, the contents will be rendered with
+     * KaTeX. Otherwise, the content will be assumed to be a DOM node and will
+     * be appended inside the tooltip.
+     */
+    _showTooltip(contents: any): void;
+    _hideTooltip(): void;
+    coord(): Coord;
+    setCoord(coord: Coord): void;
+    setCoordConstrained(coord: any): void;
+    /**
+     * Add a listener to any event: startMove, constraints, onMove, onMoveEnd,
+     * etc. If a listener is already bound to the given eventName and id, then
+     * it is overwritten by func.
+     *
+     * eventName: the string name of the event to listen to. one of:
+     *   "onMoveStart", "onMove", "onMoveEnd", "draw", "remove"
+     *
+     * id: a string id that can be used to remove this event at a later time
+     *   note: adding multiple listeners with the same id is undefined behavior
+     *
+     * func: the function to call when the event happens, which is called
+     *   with the event's standard parameters [usually (coord, prevCoord) or
+     *   (state, prevState)]
+     */
+    listen(eventName: string, id: string, func: () => unknown): void;
+    /**
+     * Remove a previously added listener, by the id specified in the
+     * corresponding listen() call
+     *
+     * If the given id has not been registered already, this is a no-op
+     */
+    unlisten(eventName: any, id: any): void;
+    grab(coord: Coord): void;
+    moveTo(coord: Coord): void;
+    remove(): void;
+    pointSize(): number;
+    static(): boolean;
+    cursor(): "move";
+    normalStyle(): Record<string, any>;
+    highlightStyle(): Record<string, any>;
+    shadow(): boolean;
+    tooltip(): boolean;
+    added(): boolean;
+    hasMoved(): boolean;
+    visibleShape(): {
+        wrapper: HTMLElement;
+        toBack(): void;
+        toFront(): void;
+    };
+    outOfBounds(): boolean;
+    mouseTarget(): unknown;
+    touchOffset(): Coord | null;
+    /**
+     * Forwarding methods to this.movable:
+     */
+    isHovering(): boolean | undefined;
+    isDragging(): boolean | undefined;
+    toBack(): void;
+    toFront(): void;
+    static add: {
+        readonly constrain: () => void;
+    };
+    static modify: {
+        readonly draw: () => void;
+    };
+    static draw: {
+        readonly basic: (state: any, prevState: any) => void;
+        readonly highlight: (state: any, prevState: any) => void;
+    };
+    static remove: {
+        readonly basic: () => void;
+    };
+    static onMoveStart: {
+        standard: null;
+    };
+    static constraints: {
+        readonly fixed: () => Constraint;
+        readonly snap: (snap?: number | null | undefined) => Constraint;
+        readonly bound: (range?: [import("../util/interval").Interval, import("../util/interval").Interval] | undefined, snap?: number | Coord | undefined, optionalPaddingPx?: number | undefined) => Constraint;
+    };
+    static onMove: {
+        standard: null;
+    };
+    static onMoveEnd: {
+        standard: null;
+    };
+    static onClick: {
+        standard: null;
+    };
+}
 export default MovablePoint;

package/dist/interactive2/movable.d.ts

@@ -57,7 +57,7 @@ export declare class Movable<Options extends Record<string, any>> {
      * Simulates a mouse grab event on the movable object.
      */
     grab(coord: Coord): void;
-    _applyConstraints(current: Coord, previous: Coord, extraOptions?: ConstraintCallbacks): any;
+    _applyConstraints(current: Coord, previous: Coord, extraOptions?: ConstraintCallbacks): false | [number, number];
     toBack(): void;
     toFront(): void;
     /**

package/dist/interactive2/types.d.ts

@@ -1,7 +1,9 @@
-import type { Movable } from "./movable";
+import type { Graphie } from "../util/graphie";
 export type Coord = [number, number];
 export type Line = [Coord, Coord];
-export type Constraint = (this: Movable<any>, current: Coord | boolean, previous: Coord, options: ConstraintCallbacks) => Coord | boolean | undefined;
+export type Constraint = (this: {
+    graphie: Graphie;
+}, current: Coord | boolean, previous: Coord, options: ConstraintCallbacks) => Coord | boolean | undefined;
 export type ConstraintCallbacks = {
     onSkipRemaining(): void;
     onOutOfBounds?: () => void;

package/dist/interactive2.d.ts

@@ -1,5 +1,6 @@
+import { MovablePoint } from "./interactive2/movable-point";
 declare const Interactive2: {
-    readonly MovablePoint: (graphie: any, movable: any, options: any) => void;
+    readonly MovablePoint: typeof MovablePoint;
     readonly addMovablePoint: (graphie: any, options: any) => any;
     readonly MovableLine: (graphie: any, movable: any, options: any) => void;
     readonly addMovableLine: (graphie: any, options: any) => any;

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

@@ -102,8 +102,7 @@ export declare class ServerItemRenderer extends React.Component<Props, State> im
     setAssetStatus: (assetKey: string, status: boolean) => void;
     render(): React.ReactNode;
 }
-declare const ref: React.ForwardRefExoticComponent<Omit<Pick<OwnProps & HOCProps, "item" | "problemNum" | "reviewMode" | "keypadElement" | "hintsVisible" | "dependencies"> & {
-    linterContext?: PerseusLinter.LinterContextProps | undefined;
+declare const ref: React.ForwardRefExoticComponent<Omit<Pick<OwnProps & HOCProps, "item" | "problemNum" | "keypadElement" | "reviewMode" | "dependencies" | "hintsVisible"> & {
     apiOptions?: Readonly<{
         isArticle?: boolean | undefined;
         onInputError?: ((widgetId: any, value: string, message?: string | null | undefined) => unknown) | undefined;
@@ -138,6 +137,7 @@ declare const ref: React.ForwardRefExoticComponent<Omit<Pick<OwnProps & HOCProps
         editorChangeDelay?: number | undefined;
         onWidgetStartProps?: ((widgets: import("./types").PerseusWidgetMap) => import("./types").PerseusWidgetMap) | undefined;
     }> | undefined;
+    linterContext?: PerseusLinter.LinterContextProps | undefined;
     onRendered?: ((isRendered: boolean) => void) | undefined;
 } & {}, "onRendered"> & React.RefAttributes<ServerItemRenderer>>;
 export default ref;

package/dist/util/graphie.d.ts

@@ -1,3 +1,4 @@
+import type { MouseHandler } from "./interactive";
 import type { Interval } from "./interval";
 import type { Coord } from "../interactive2/types";
 export declare function polar(r: number | Coord, th: number): Coord;
@@ -100,13 +101,22 @@ export declare class Graphie {
     private addArrowheads;
     scalePoint: (point: number | Coord) => Coord;
     scaleVector: (point: number | Coord) => any;
-    unscalePoint: (point: Coord) => any;
-    unscaleVector: (point: Coord) => any;
+    unscalePoint: (point: number | Coord) => any;
+    unscaleVector: (point: number | Coord) => any;
     private processAttributes;
     getMouseCoord(event: Readonly<{
         pageX?: number;
         pageY?: number;
     }>): Coord;
+    addMouseLayer(options: {
+        onClick?: MouseHandler;
+        onMouseMove?: MouseHandler;
+        onMouseDown?: MouseHandler;
+        onMouseOver?: MouseHandler;
+        onMouseOut?: MouseHandler;
+        allowScratchpad?: boolean;
+        setDrawingAreaAvailable?: (available: boolean) => void;
+    }): void;
 }
 type RangeSpecifier = [Interval, Interval] | Coord | number;
 export declare function normalizeRange(range: RangeSpecifier): [Interval, Interval];

package/dist/widgets/expression.d.ts

@@ -212,11 +212,11 @@ declare const _default: Readonly<{
         onFocus: (blurPath: import("../types").FocusPath) => void;
         times: boolean;
         value: string;
-    }, "onChange" | "trackInteraction" | "static" | "analytics" | "problemNum" | "questionCompleted" | "keypadElement" | "alignment" | "buttonsVisible" | "containerSizeClass" | "widgetId" | "findWidgets" | "keypadConfiguration" | "reviewModeRubric" | "isLastUsedWidget"> & {
+    }, "onChange" | "trackInteraction" | "static" | "analytics" | "buttonsVisible" | "containerSizeClass" | "widgetId" | "problemNum" | "questionCompleted" | "findWidgets" | "keypadElement" | "keypadConfiguration" | "alignment" | "reviewModeRubric" | "isLastUsedWidget"> & {
         onFocus?: ((blurPath: import("../types").FocusPath) => void) | undefined;
         onBlur?: ((blurPath: import("../types").FocusPath) => void) | undefined;
         value?: string | undefined;
-        linterContext?: import("@khanacademy/perseus-linter").LinterContextProps | undefined;
+        buttonSets?: import("../perseus-types").LegacyButtonSets | undefined;
         apiOptions?: Readonly<Readonly<{
             isArticle?: boolean | undefined;
             onInputError?: ((widgetId: any, value: string, message?: string | null | undefined) => unknown) | undefined;
@@ -269,9 +269,9 @@ declare const _default: Readonly<{
             showAlignmentOptions: NonNullable<boolean | undefined>;
             useDraftEditor: NonNullable<boolean | undefined>;
         }> | undefined;
-        buttonSets?: import("../perseus-types").LegacyButtonSets | undefined;
         functions?: readonly string[] | undefined;
         times?: boolean | undefined;
+        linterContext?: import("@khanacademy/perseus-linter").LinterContextProps | undefined;
     } & {}, "analytics"> & React.RefAttributes<Expression>>) | undefined;
     widget: React.ForwardRefExoticComponent<Omit<Pick<RenderProps & {
         widgetId: string;
@@ -401,11 +401,11 @@ declare const _default: Readonly<{
         onFocus: (blurPath: import("../types").FocusPath) => void;
         times: boolean;
         value: string;
-    }, "onChange" | "trackInteraction" | "static" | "analytics" | "problemNum" | "questionCompleted" | "keypadElement" | "alignment" | "buttonsVisible" | "containerSizeClass" | "widgetId" | "findWidgets" | "keypadConfiguration" | "reviewModeRubric" | "isLastUsedWidget"> & {
+    }, "onChange" | "trackInteraction" | "static" | "analytics" | "buttonsVisible" | "containerSizeClass" | "widgetId" | "problemNum" | "questionCompleted" | "findWidgets" | "keypadElement" | "keypadConfiguration" | "alignment" | "reviewModeRubric" | "isLastUsedWidget"> & {
         onFocus?: ((blurPath: import("../types").FocusPath) => void) | undefined;
         onBlur?: ((blurPath: import("../types").FocusPath) => void) | undefined;
         value?: string | undefined;
-        linterContext?: import("@khanacademy/perseus-linter").LinterContextProps | undefined;
+        buttonSets?: import("../perseus-types").LegacyButtonSets | undefined;
         apiOptions?: Readonly<Readonly<{
             isArticle?: boolean | undefined;
             onInputError?: ((widgetId: any, value: string, message?: string | null | undefined) => unknown) | undefined;
@@ -458,9 +458,9 @@ declare const _default: Readonly<{
             showAlignmentOptions: NonNullable<boolean | undefined>;
             useDraftEditor: NonNullable<boolean | undefined>;
         }> | undefined;
-        buttonSets?: import("../perseus-types").LegacyButtonSets | undefined;
         functions?: readonly string[] | undefined;
         times?: boolean | undefined;
+        linterContext?: import("@khanacademy/perseus-linter").LinterContextProps | undefined;
     } & {}, "analytics"> & React.RefAttributes<Expression>>;
     accessible?: boolean | ((props: any) => boolean) | undefined;
     hidden?: boolean | undefined;

package/package.json

@@ -3,7 +3,7 @@
     "description": "Core Perseus API (includes renderers and widgets)",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "19.1.5",
+    "version": "19.1.7",
     "publishConfig": {
         "access": "public"
     },
@@ -18,17 +18,20 @@
     "module": "dist/es/index.js",
     "main": "dist/index.js",
     "source": "src/index.ts",
+    "files": [
+        "dist"
+    ],
     "scripts": {
         "test": "bash -c 'yarn --silent --cwd \"../..\" test ${@:0} $($([[ ${@: -1} = -* ]] || [[ ${@: -1} = bash ]]) && echo $PWD)'"
     },
     "dependencies": {
-        "@khanacademy/kas": "^0.3.7",
-        "@khanacademy/kmath": "^0.1.11",
-        "@khanacademy/math-input": "^17.0.4",
-        "@khanacademy/perseus-core": "1.4.1",
-        "@khanacademy/perseus-linter": "^0.3.10",
-        "@khanacademy/pure-markdown": "^0.2.13",
-        "@khanacademy/simple-markdown": "^0.11.2",
+        "@khanacademy/kas": "^0.3.8",
+        "@khanacademy/kmath": "^0.1.12",
+        "@khanacademy/math-input": "^17.0.6",
+        "@khanacademy/perseus-core": "1.4.2",
+        "@khanacademy/perseus-linter": "^0.3.11",
+        "@khanacademy/pure-markdown": "^0.2.14",
+        "@khanacademy/simple-markdown": "^0.11.3",
         "@khanacademy/wonder-blocks-banner": "^3.0.33"
     },
     "devDependencies": {

package/.babelrc.js

@@ -1,8 +0,0 @@
-/**
- * HACK(kevinb): Due to https://github.com/facebook/jest/issues/11741,
- * we need to have this file, or updating inline snapshots can fail rather
- * cryptically.
- *
- * We should remove this when jest is fixed.
- */
-module.exports = require("../../config/build/babel.config");

package/.eslintrc.js

@@ -1,12 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable import/no-commonjs */
-const path = require("path");
-
-module.exports = {
-    rules: {
-        "import/no-extraneous-dependencies": [
-            "error",
-            {packageDir: [__dirname, path.join(__dirname, "../../")]},
-        ],
-    },
-};