@khanacademy/math-input 0.6.2 → 0.6.4

package/package.json

@@ -3,7 +3,7 @@
     "description": "Khan Academy's new expression editor for the mobile web.",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "0.6.2",
+    "version": "0.6.4",
     "publishConfig": {
         "access": "public"
     },
@@ -30,7 +30,7 @@
         "jquery": "^2.1.1",
         "katex": "^0.11.1",
         "mathquill": "git+https://git@github.com/Khan/mathquill.git#a9ae54e057c5c1acc8244a5627acbff29901d992",
-        "perseus-build-settings": "^0.0.4",
+        "perseus-build-settings": "^0.0.5",
         "prop-types": "15.6.1",
         "react": "^16.8.0",
         "react-dom": "^16.8.0",

package/src/components/input/cursor-contexts.js

@@ -11,6 +11,27 @@
  * the radical.
  */
 
+export type CursorContext =
+    // The cursor is not in any of the other viable contexts.
+    | "NONE"
+    // The cursor is within a set of parentheses.
+    | "IN_PARENS"
+    // The cursor is within a superscript (e.g., an exponent).
+    | "IN_SUPER_SCRIPT"
+    // The cursor is within a subscript (e.g., the base of a custom logarithm).
+    | "IN_SUB_SCRIPT"
+    // The cursor is in the numerator of a fraction.
+    | "IN_NUMERATOR"
+    // The cursor is in the denominator of a fraction.
+    | "IN_DENOMINATOR"
+    // The cursor is sitting before a fraction; that is, the cursor is within
+    // what looks to be a mixed number preceding a fraction. This will only be
+    // the case when the only math between the cursor and the fraction to its
+    // write is non-leaf math (numbers and variables).
+    | "BEFORE_FRACTION";
+
+// TODO: Get rid of these constants in favour of CursorContext type.
+
 // The cursor is not in any of the other viable contexts.
 export const NONE = "NONE";
 // The cursor is within a set of parentheses.

package/src/consts.js

@@ -3,11 +3,33 @@
  * Constants that are shared between multiple files.
  */
 
+export type KeypadType = "FRACTION" | "EXPRESSION";
+
+// TODO: Retire this in favour of KeypadType (above)
 export const KeypadTypes = {
     FRACTION: "FRACTION",
     EXPRESSION: "EXPRESSION",
 };
 
+export type KeyType =
+    | "EMPTY"
+    // For numerals, variables, and any other characters that themselves
+    // compose 'values'.
+    | "VALUE"
+    // For buttons that insert or adjust math in an input.
+    | "OPERATOR"
+    // For buttons that move the cursor in an input (including via
+    // deletion).
+    | "INPUT_NAVIGATION"
+    // For buttons that modify the broader keypad state (e.g., by changing
+    // the visible pane).
+    | "KEYPAD_NAVIGATION"
+    // For buttons that house multiple buttons and have no action
+    // themselves.
+    | "MANY"
+    // For the echo animation that appears on press.
+    | "ECHO";
+
 export const KeyTypes = {
     EMPTY: "EMPTY",
     // For numerals, variables, and any other characters that themselves

package/src/data/key-configs.js

@@ -14,6 +14,7 @@ export type KeyConfig = {
     type: string,
     ariaLabel: string,
 };
+
 const KeyConfigs: Object = {
     // Basic math keys.
     [Keys.PLUS]: {

package/src/data/keys.js

@@ -4,6 +4,64 @@
  * alphanumeric characters.
  */
 
+export type Key =
+    | "PLUS"
+    | "MINUS"
+    | "NEGATIVE"
+    | "TIMES"
+    | "DIVIDE"
+    | "DECIMAL"
+    | "PERIOD"
+    | "PERCENT"
+    | "CDOT"
+    | "EQUAL"
+    | "NEQ"
+    | "GT"
+    | "LT"
+    | "GEQ"
+    | "LEQ"
+    | "FRAC_INCLUSIVE" // mobile native only
+    | "FRAC_EXCLUSIVE" // mobile native only
+    | "FRAC"
+    | "EXP"
+    | "EXP_2"
+    | "EXP_3"
+    | "SQRT"
+    | "CUBE_ROOT"
+    | "RADICAL"
+    | "LEFT_PAREN"
+    | "RIGHT_PAREN"
+    | "LN"
+    | "LOG"
+    | "LOG_N"
+    | "SIN"
+    | "COS"
+    | "TAN"
+
+    // TODO(charlie): Add in additional Greek letters.
+    | "PI"
+    | "THETA"
+    | "UP"
+    | "RIGHT"
+    | "DOWN"
+    | "LEFT"
+    | "BACKSPACE"
+    | "DISMISS"
+    | "JUMP_OUT_PARENTHESES"
+    | "JUMP_OUT_EXPONENT"
+    | "JUMP_OUT_BASE"
+    | "JUMP_INTO_NUMERATOR"
+    | "JUMP_OUT_NUMERATOR"
+    | "JUMP_OUT_DENOMINATOR"
+    | "NOOP"
+
+    // Multi-functional keys.
+    | "FRAC_MULTI" // mobile native only
+
+    // A custom key that captures an arbitrary number of symbols but has no
+    // 'default' symbol or action.
+    | "MANY";
+
 // TODO(charlie): There's duplication between this file and key-configs.js.
 // We should clean it up by removing this file and requiring clients to use the
 // `id` field on the key configurations.

package/src/index.js

@@ -17,3 +17,7 @@ export {default as KeyConfigs} from "./data/key-configs.js";
 import * as CursorContexts from "./components/input/cursor-contexts.js";
 
 export {CursorContexts};
+
+export type {KeypadType, KeyType} from "./consts.js";
+export type {Key} from "./data/keys.js";
+export type {CursorContext} from "./components/input/cursor-contexts.js";