@khanacademy/math-input 20.1.2 → 21.0.1

package/dist/components/key-handlers/key-translator.d.ts

@@ -1,3 +1,9 @@
 import type Key from "../../data/keys";
 import type { MathFieldUpdaterCallback } from "../input/mathquill-types";
-export declare const getKeyTranslator: (locale: string) => Record<Key, MathFieldUpdaterCallback>;
+type KeyTranslatorStrings = {
+    sin: string;
+    cos: string;
+    tan: string;
+};
+export declare const getKeyTranslator: (locale: string, strings: KeyTranslatorStrings) => Record<Key, MathFieldUpdaterCallback>;
+export {};

package/dist/es/index.js

@@ -1,9 +1,10 @@
 import { addLibraryVersionToPerseusDebug } from '@khanacademy/perseus-core';
+import { KeypadContext } from '@khanacademy/keypad-context';
 import { color } from '@khanacademy/wonder-blocks-tokens';
 import { entries } from '@khanacademy/wonder-stuff-core';
 import { StyleSheet, css } from 'aphrodite';
 import * as React from 'react';
-import { useContext, useState, useMemo, useRef, useEffect } from 'react';
+import { useContext, useRef, useEffect, useState } from 'react';
 import ReactDOM from 'react-dom';
 import { SpeechRuleEngine } from '@khanacademy/mathjax-renderer';
 import MathQuill from 'mathquill';
@@ -15,7 +16,7 @@ import PropTypes from 'prop-types';
 
 // This file is processed by a Rollup plugin (replace) to inject the production
 const libName = "@khanacademy/math-input";
-const libVersion = "20.1.2";
+const libVersion = "21.0.1";
 addLibraryVersionToPerseusDebug(libName, libVersion);
 
 function _extends() {
@@ -212,49 +213,6 @@ function MathInputI18nContextProvider({
 }
 const useMathInputI18n = () => useContext(MathInputI18nContext);
 
-/**
- * KeypadContext provides a way to the Keypad and Perseus Renderers to
- * communicate.
- *
- * The StatefulKeypadContextProvider wraps the application
- * while KeypadContext.Consumer wraps things that need this state:
- * - mobile keypad usages
- * - Perseus Renderers (Server/Item/Article)
- */
-// @ts-expect-error - TS2322 - Type 'Context<{ setKeypadElement: (keypadElement: HTMLElement | null | undefined) => void; keypadElement: null; setRenderer: (renderer: RendererInterface | null | undefined) => void; renderer: null; setScrollableElement: (scrollableElement: HTMLElement | ... 1 more ... | undefined) => void; scrollableElement: null; }>' is not assignable to type 'Context<KeypadContext>'.
-const KeypadContext = /*#__PURE__*/React.createContext({
-  setKeypadActive: keypadActive => {},
-  keypadActive: false,
-  setKeypadElement: keypadElement => {},
-  keypadElement: null,
-  setRenderer: renderer => {},
-  renderer: null,
-  setScrollableElement: scrollableElement => {},
-  scrollableElement: null
-});
-function StatefulKeypadContextProvider(props) {
-  // whether or not to display the keypad
-  const [keypadActive, setKeypadActive] = useState(false);
-  // used to communicate between the keypad and the Renderer
-  const [keypadElement, setKeypadElement] = useState();
-  // this is a KeypadContextRendererInterface from Perseus
-  const [renderer, setRenderer] = useState();
-  const [scrollableElement, setScrollableElement] = useState();
-  const memoizedValue = useMemo(() => ({
-    keypadActive,
-    setKeypadActive,
-    keypadElement,
-    setKeypadElement,
-    renderer,
-    setRenderer,
-    scrollableElement,
-    setScrollableElement
-  }), [keypadActive, setKeypadActive, keypadElement, setKeypadElement, renderer, setRenderer, scrollableElement, setScrollableElement]);
-  return /*#__PURE__*/React.createElement(KeypadContext.Provider, {
-    value: memoizedValue
-  }, props.children);
-}
-
 /**
  * Common parameters used to style components.
  */
@@ -1234,13 +1192,31 @@ function buildGenericCallback(str, type = ActionType.WRITE) {
     }
   };
 }
+
+/**
+ * This lets us use translated functions
+ * (like tg->tan and sen->sin) when we know it's safe to.
+ * This lets us progressively support translations without needing
+ * to support every language all at once.
+ *
+ * @param {string} command - the translated command/function to check
+ * @param {string[]} supportedTranslations - list of translations we support
+ * @param {string} defaultCommand - what to fallback to if the command isn't supported
+ */
+function buildTranslatableFunctionCallback(command, supportedTranslations, defaultCommand) {
+  const cmd = supportedTranslations.includes(command) ? command : defaultCommand;
+  return function (mathField) {
+    mathField.write(`${cmd}\\left(\\right)`);
+    mathField.keystroke("Left");
+  };
+}
 function buildNormalFunctionCallback(command) {
   return function (mathField) {
     mathField.write(`\\${command}\\left(\\right)`);
     mathField.keystroke("Left");
   };
 }
-const getKeyTranslator = locale => ({
+const getKeyTranslator = (locale, strings) => ({
   EXP: handleExponent,
   EXP_2: handleExponent,
   EXP_3: handleExponent,
@@ -1254,9 +1230,9 @@ const getKeyTranslator = locale => ({
   RIGHT: handleArrow,
   LOG: buildNormalFunctionCallback("log"),
   LN: buildNormalFunctionCallback("ln"),
-  SIN: buildNormalFunctionCallback("sin"),
-  COS: buildNormalFunctionCallback("cos"),
-  TAN: buildNormalFunctionCallback("tan"),
+  COS: buildNormalFunctionCallback(strings.cos),
+  SIN: buildTranslatableFunctionCallback(strings.sin, ["sin", "sen"], "sin"),
+  TAN: buildTranslatableFunctionCallback(strings.tan, ["tan", "tg"], "tan"),
   CDOT: buildGenericCallback("\\cdot"),
   DECIMAL: buildGenericCallback(getDecimalSeparator(locale)),
   DIVIDE: buildGenericCallback("\\div"),
@@ -1397,7 +1373,7 @@ class MathWrapper {
     });
     (_this$mathField = this.mathField) == null || _this$mathField.setAriaLabel(ariaLabel);
     this.callbacks = callbacks;
-    this.mobileKeyTranslator = _extends({}, getKeyTranslator(locale), {
+    this.mobileKeyTranslator = _extends({}, getKeyTranslator(locale, strings), {
       // note(Matthew): our mobile backspace logic is really complicated
       // and for some reason doesn't really work in the desktop experience.
       // So we default to the basic backspace functionality in the
@@ -5797,5 +5773,5 @@ let KeypadType = /*#__PURE__*/function (KeypadType) {
   return KeypadType;
 }({});
 
-export { CursorContext, Keypad as DesktopKeypad, KeyArray, KeyConfigs, KeypadContext, MathInput as KeypadInput, KeypadType, MathInputI18nContext, MathInputI18nContextProvider, MobileKeypad, StatefulKeypadContextProvider, convertDotToTimesByLocale, createMathField, getCursorContext, getKeyTranslator, keypadElementPropType, libVersion, mathQuillInstance, useMathInputI18n };
+export { CursorContext, Keypad as DesktopKeypad, KeyArray, KeyConfigs, MathInput as KeypadInput, KeypadType, MathInputI18nContext, MathInputI18nContextProvider, MobileKeypad, convertDotToTimesByLocale, createMathField, getCursorContext, getKeyTranslator, keypadElementPropType, libVersion, mathQuillInstance, useMathInputI18n };
 //# sourceMappingURL=index.js.map