@khanacademy/perseus 19.1.4 → 19.1.6

package/dist/interactive2/interactive-util.d.ts

@@ -14,7 +14,7 @@ declare const InteractiveUtil: {
     /**
      * Turn a function or an array of functions into an array of functions
      */
-    readonly arrayify: (funcOrArray: readonly unknown[] | ((...args: ReadonlyArray<unknown>) => unknown)) => ReadonlyArray<unknown>;
+    readonly arrayify: (funcOrArray: ((...args: ReadonlyArray<unknown>) => unknown) | readonly unknown[]) => ReadonlyArray<unknown>;
     /**
      * Convert all function-or-array arguments to arrays of functions
      */

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

@@ -1,4 +1,5 @@
-import type { Coord } from "./types";
+import type { Constraint, Coord } from "./types";
+import type { Interval } from "../util/interval";
 declare const _default: {
     add: {
         readonly constrain: () => void;
@@ -17,9 +18,9 @@ declare const _default: {
         standard: null;
     };
     constraints: {
-        readonly fixed: () => () => boolean;
-        readonly snap: (snap: any) => (arg1: Coord) => unknown;
-        readonly bound: (range: any, snap: any, paddingPx: number) => (arg1: Coord, arg2: Coord, arg3: any) => Coord;
+        readonly fixed: () => Constraint;
+        readonly snap: (snap?: number | null | undefined) => Constraint;
+        readonly bound: (range?: [Interval, Interval] | undefined, snap?: number | Coord | undefined, optionalPaddingPx?: number | undefined) => Constraint;
     };
     onMove: {
         standard: null;

package/dist/interactive2/movable.d.ts

@@ -1,21 +1,98 @@
-import type { Coord } from "./types";
+import type { Constraint, ConstraintCallbacks, Coord } from "./types";
 import type { Graphie } from "../util/graphie";
 export interface State {
     added?: boolean;
     isHovering?: boolean;
     isMouseOver?: boolean;
     isDragging?: boolean;
-    mouseTarget?: unknown | null;
-    cursor: unknown | null;
+    mouseTarget?: {
+        toFront(): void;
+        toBack(): void;
+        remove(): void;
+        getMouseTarget(): Element;
+    } | null;
+    cursor?: null;
     id: string;
-    add: (() => void)[];
-    modify: (() => void)[];
-    draw: (() => void)[];
-    remove: (() => void)[];
-    onMoveStart: ((position: Coord) => void)[];
-    onMove: ((end: Coord, start: Coord) => void)[];
-    onMoveEnd: ((end: Coord, start: Coord) => void)[];
-    onClick: ((position: Coord, start: Coord) => void)[];
+    add?: (() => void)[];
+    modify?: ((state: State, prevState?: State) => void)[];
+    draw?: ((state: State, prevState?: State) => void)[];
+    remove?: (() => void)[];
+    onMoveStart?: ((position: Coord, positionAgain: Coord) => void)[];
+    onMove?: ((end: Coord, start: Coord) => void)[];
+    onMoveEnd?: ((end: Coord, start: Coord) => void)[];
+    onClick?: ((position: Coord, start: Coord) => void)[];
+    constraints?: Constraint[];
+}
+export declare class Movable<Options extends Record<string, any>> {
+    graphie: Graphie;
+    state: State;
+    prevState: State | undefined;
+    _listenerMap: Record<string, number>;
+    constructor(graphie: Graphie, options: Options);
+    modify(options: Options): void;
+    _createDefaultState(): {
+        cursor: null;
+        id: string;
+        add: never[];
+        modify: never[];
+        draw: never[];
+        remove: never[];
+        onMoveStart: never[];
+        onMove: never[];
+        onMoveEnd: never[];
+        onClick: never[];
+    };
+    update(options: Options): void;
+    cloneState(): State;
+    /**
+     * Fire an onSomething type event to all functions in listeners
+     */
+    _fireEvent<F extends (...args: any[]) => any>(listeners: F[] | undefined, ...args: Parameters<F>): void;
+    /**
+     * Call all draw functions, and update our prevState for the next
+     * draw function
+     */
+    draw(): void;
+    /**
+     * Simulates a mouse grab event on the movable object.
+     */
+    grab(coord: Coord): void;
+    _applyConstraints(current: Coord, previous: Coord, extraOptions?: ConstraintCallbacks): any;
+    toBack(): void;
+    toFront(): 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: string, id: string): void;
+    remove(): void;
+    cursor(): null | undefined;
+    added(): boolean | undefined;
+    isHovering(): boolean | undefined;
+    isMouseOver(): boolean | undefined;
+    isDragging(): boolean | undefined;
+    mouseTarget(): {
+        toFront(): void;
+        toBack(): void;
+        remove(): void;
+        getMouseTarget(): Element;
+    } | null | undefined;
 }
-declare const Movable: (graphie: Graphie, options: any) => void;
-export default Movable;

package/dist/interactive2/types.d.ts

@@ -1,2 +1,8 @@
+import type { Movable } from "./movable";
 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 ConstraintCallbacks = {
+    onSkipRemaining(): void;
+    onOutOfBounds?: () => void;
+};

package/dist/util/graphie.d.ts

@@ -40,6 +40,7 @@ export declare class Graphie {
     dimensions?: Coord;
     xpixels?: number;
     ypixels?: number;
+    isDragging?: boolean;
     constructor(el: Element);
     init(options: {
         range: [Interval, Interval];
@@ -102,6 +103,10 @@ export declare class Graphie {
     unscalePoint: (point: Coord) => any;
     unscaleVector: (point: Coord) => any;
     private processAttributes;
+    getMouseCoord(event: Readonly<{
+        pageX?: number;
+        pageY?: number;
+    }>): Coord;
 }
 type RangeSpecifier = [Interval, Interval] | Coord | number;
 export declare function normalizeRange(range: RangeSpecifier): [Interval, Interval];

package/dist/widgets/expression.d.ts

@@ -212,10 +212,10 @@ declare const _default: Readonly<{
         onFocus: (blurPath: import("../types").FocusPath) => void;
         times: boolean;
         value: string;
-    }, "trackInteraction" | "onChange" | "static" | "analytics" | "problemNum" | "questionCompleted" | "keypadElement" | "alignment" | "buttonsVisible" | "containerSizeClass" | "widgetId" | "findWidgets" | "keypadConfiguration" | "reviewModeRubric" | "isLastUsedWidget"> & {
-        value?: string | undefined;
+    }, "onChange" | "trackInteraction" | "static" | "analytics" | "problemNum" | "questionCompleted" | "keypadElement" | "alignment" | "buttonsVisible" | "containerSizeClass" | "widgetId" | "findWidgets" | "keypadConfiguration" | "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;
         apiOptions?: Readonly<Readonly<{
             isArticle?: boolean | undefined;
@@ -401,10 +401,10 @@ declare const _default: Readonly<{
         onFocus: (blurPath: import("../types").FocusPath) => void;
         times: boolean;
         value: string;
-    }, "trackInteraction" | "onChange" | "static" | "analytics" | "problemNum" | "questionCompleted" | "keypadElement" | "alignment" | "buttonsVisible" | "containerSizeClass" | "widgetId" | "findWidgets" | "keypadConfiguration" | "reviewModeRubric" | "isLastUsedWidget"> & {
-        value?: string | undefined;
+    }, "onChange" | "trackInteraction" | "static" | "analytics" | "problemNum" | "questionCompleted" | "keypadElement" | "alignment" | "buttonsVisible" | "containerSizeClass" | "widgetId" | "findWidgets" | "keypadConfiguration" | "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;
         apiOptions?: Readonly<Readonly<{
             isArticle?: 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.4",
+    "version": "19.1.6",
     "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.10",
-        "@khanacademy/math-input": "^17.0.3",
-        "@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.5",
+        "@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, "../../")]},
-        ],
-    },
-};