@khanacademy/perseus-editor 2.0.2 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # @khanacademy/perseus-editor
 
+## 2.1.0
+
+### Minor Changes
+
+-   4a368030: Remove getKaTeX from the PerseusDependencies type
+
+    perseus-editor now detects KaTeX rendering errors by calling KaTeX directly,
+    rather than using getKaTeX from PerseusDependencies.
+
+    The logKaTeXError method, which was unused by Perseus, has been removed from
+    the PerseusDependencies type as well.
+
+    Clients should update their code by removing the getKaTeX and logKaTeXError
+    properties from their PerseusDependencies object. If they want to log an error
+    when TeX fails to render, they should do so in their TeX component.
+
+### Patch Changes
+
+-   9c4a6c96: Remove obsolete properties from the PerseusDependencies type
+
+    We are in the process of migrating the webapp and mobile repos to use
+    MathJax 3 as their math renderer instead of KaTeX. This change removes some of
+    Perseus's dependencies on KaTeX.
+
+    Clients should update their code by removing the `getRenderA11yString`,
+    `loadMathjax`, `KatexProvider`, and `shouldUseFutureKaTeX` properties from
+    their PerseusDependencies object.
+
+-   Updated dependencies [4a368030]
+-   Updated dependencies [5cc23179]
+-   Updated dependencies [e0a087d0]
+-   Updated dependencies [b062ad47]
+-   Updated dependencies [8a47076d]
+-   Updated dependencies [09ab3260]
+-   Updated dependencies [5432857d]
+-   Updated dependencies [40c2736d]
+-   Updated dependencies [b585fe29]
+-   Updated dependencies [91617cfa]
+-   Updated dependencies [e284e7c1]
+-   Updated dependencies [9c4a6c96]
+    -   @khanacademy/perseus@6.0.0
+
+## 2.0.3
+
+### Patch Changes
+
+-   472e20e1: Remove all references to multipleNumberInput (ie. Ask for (one|all) correct solution)
+-   22c5d564: Remove the use of React.FC<> and use types named Props/State in more components
+-   Updated dependencies [472e20e1]
+-   Updated dependencies [22c5d564]
+    -   @khanacademy/perseus@5.0.0
+
 ## 2.0.2
 
 ### Patch Changes

package/dist/article-editor.d.ts

@@ -19,7 +19,7 @@ type DefaultProps = {
     sectionImageUploadGenerator: (i: number) => React.ReactElement<React.ComponentProps<"span">>;
     useNewStyles: boolean;
 };
-type PerseusArticleEditorProps = DefaultProps & {
+type Props = DefaultProps & {
     apiOptions?: APIOptions;
     imageUploader?: (arg1: string, arg2: (arg1: string) => unknown) => unknown;
     previewURL: string;
@@ -27,7 +27,7 @@ type PerseusArticleEditorProps = DefaultProps & {
 type State = {
     highlightLint: boolean;
 };
-export default class ArticleEditor extends React.Component<PerseusArticleEditorProps, State> {
+export default class ArticleEditor extends React.Component<Props, State> {
     static defaultProps: DefaultProps;
     state: State;
     componentDidMount(): void;

package/dist/article-editor.js.flow

@@ -23,7 +23,7 @@ declare type DefaultProps = {|
   ) => React.Element<"span">,
   useNewStyles: boolean,
 |};
-declare type PerseusArticleEditorProps = {|
+declare type Props = {|
   ...DefaultProps,
   ...{|
     apiOptions?: APIOptions,
@@ -36,7 +36,7 @@ declare type State = {|
   highlightLint: boolean,
 |};
 declare export default class ArticleEditor
-  extends React.Component<PerseusArticleEditorProps, State>
+  extends React.Component<Props, State>
 {
   static defaultProps: DefaultProps;
   state: State;

package/dist/components/dropdown-option.d.ts

@@ -1,6 +1,6 @@
 import * as React from "react";
 export type OptionRenderer = (children: React.ReactElement<any> | null | undefined, value: string, selected: boolean, disabled?: boolean) => React.ReactElement<any>;
-type OptionProps = {
+type Props = {
     value: string;
     children?: React.ReactNode;
     selected?: boolean;
@@ -13,7 +13,7 @@ type OptionProps = {
     ariaLabel?: string;
 };
 export declare const optionHeight = 30;
-declare class Option extends React.Component<OptionProps> {
+declare class Option extends React.Component<Props> {
     node: HTMLDivElement;
     handleKeyDown(event: any): void;
     render(): React.ReactNode;

package/dist/components/dropdown-option.js.flow

@@ -11,7 +11,7 @@ export type OptionRenderer = (
   selected: boolean,
   disabled?: boolean
 ) => React.Element<any>;
-declare type OptionProps = {|
+declare type Props = {|
   value: string,
   children?: React.Node,
   selected?: boolean,
@@ -24,7 +24,7 @@ declare type OptionProps = {|
   ariaLabel?: string,
 |};
 declare export var optionHeight: 30;
-declare class Option extends React.Component<OptionProps> {
+declare class Option extends React.Component<Props> {
   node: HTMLDivElement;
   handleKeyDown(event: any): void;
   render(): React.Node;

package/dist/components/link.d.ts

@@ -6,7 +6,7 @@ type DefaultProps = {
     href: string;
     style: CSSProperties | Array<CSSProperties>;
 };
-type LinkProps = DefaultProps & {
+type Props = DefaultProps & {
     children?: React.ReactNode;
     className?: string;
     inlineStyles?: {
@@ -34,7 +34,7 @@ type LinkProps = DefaultProps & {
 /**
  * A wrapper that creates an anchor tag with normalized styles
  */
-declare class Link extends React.Component<LinkProps> {
+declare class Link extends React.Component<Props> {
     static defaultProps: DefaultProps;
     render(): React.ReactNode;
 }

package/dist/components/link.js.flow

@@ -12,7 +12,7 @@ declare type DefaultProps = {|
   href: string,
   style: CSSProperties | Array<CSSProperties>,
 |};
-declare type LinkProps = {|
+declare type Props = {|
   ...DefaultProps,
   ...{|
     children?: React.Node,
@@ -43,7 +43,7 @@ declare type LinkProps = {|
 /**
  * A wrapper that creates an anchor tag with normalized styles
  */
-declare class Link extends React.Component<LinkProps> {
+declare class Link extends React.Component<Props> {
   static defaultProps: DefaultProps;
   render(): React.Node;
 }

package/dist/diffs/__stories__/perseus-diff-wrapper.d.ts

@@ -1,5 +1,6 @@
 import * as React from "react";
-declare const Wrapper: React.FC<{
+type Props = {
     children: React.ReactNode;
-}>;
+};
+declare const Wrapper: ({ children }: Props) => React.ReactElement;
 export default Wrapper;

package/dist/diffs/__stories__/perseus-diff-wrapper.js.flow

@@ -5,7 +5,8 @@
  * @flow
  */
 import * as React from "react";
-declare var Wrapper: React.StatelessFunctionalComponent<{|
+declare type Props = {|
   children: React.Node,
-|}>;
+|};
+declare var Wrapper: (x: Props) => React.Element<any>;
 declare export default typeof Wrapper;

package/dist/editor.d.ts

@@ -1,7 +1,6 @@
-import katex from "katex";
 import * as React from "react";
 import type { ChangeHandler, WidgetInfo } from "@khanacademy/perseus";
-type EditorProps = Readonly<{
+type Props = Readonly<{
     apiOptions: any;
     className?: string;
     content: string;
@@ -34,20 +33,18 @@ type DeafultProps = {
         [name: string]: WidgetInfo;
     };
 };
-type EditorState = {
-    showKatexErrors: boolean;
+type State = {
     textAreaValue: string;
-    katex?: katex;
 };
-declare class Editor extends React.Component<EditorProps, EditorState> {
+declare class Editor extends React.Component<Props, State> {
     lastUserValue: string | null | undefined;
     deferredChange: any | null | undefined;
     widgetIds: any | null | undefined;
     static defaultProps: DeafultProps;
-    state: EditorState;
+    state: State;
     componentDidMount(): void;
-    UNSAFE_componentWillReceiveProps(nextProps: EditorProps): void;
-    componentDidUpdate(prevProps: EditorProps): void;
+    UNSAFE_componentWillReceiveProps(nextProps: Props): void;
+    componentDidUpdate(prevProps: Props): void;
     componentWillUnmount(): void;
     getWidgetEditor: (id: string, type: string) => undefined | React.ReactNode;
     _handleWidgetEditorChange: (id: string, newWidgetInfo: WidgetInfo, cb?: () => unknown, silent?: boolean) => void;
@@ -56,7 +53,7 @@ declare class Editor extends React.Component<EditorProps, EditorState> {
      * Calculate the size of all the images in props.content, and send
      * those sizes to this.props.images using props.onChange.
      */
-    _sizeImages: (props: EditorProps) => void;
+    _sizeImages: (props: Props) => void;
     handleDrop: (e: DragEvent) => void;
     handleChange: (e: React.SyntheticEvent<HTMLTextAreaElement>) => void;
     _handleKeyDown: (e: React.KeyboardEvent<HTMLTextAreaElement>) => void;

package/dist/editor.js.flow

@@ -4,10 +4,9 @@
  * Flowgen v1.21.0
  * @flow
  */
-import katex from "katex";
 import * as React from "react";
 import type { ChangeHandler, WidgetInfo } from "@khanacademy/perseus";
-declare type EditorProps = $ReadOnly<{|
+declare type Props = $ReadOnly<{|
   apiOptions: any,
   className?: string,
   content: string,
@@ -40,20 +39,18 @@ declare type DeafultProps = {|
     [name: string]: WidgetInfo,
   },
 |};
-declare type EditorState = {|
-  showKatexErrors: boolean,
+declare type State = {|
   textAreaValue: string,
-  katex?: katex,
 |};
-declare class Editor extends React.Component<EditorProps, EditorState> {
+declare class Editor extends React.Component<Props, State> {
   lastUserValue: string | null | void;
   deferredChange: any | null | void;
   widgetIds: any | null | void;
   static defaultProps: DeafultProps;
-  state: EditorState;
+  state: State;
   componentDidMount(): void;
-  UNSAFE_componentWillReceiveProps(nextProps: EditorProps): void;
-  componentDidUpdate(prevProps: EditorProps): void;
+  UNSAFE_componentWillReceiveProps(nextProps: Props): void;
+  componentDidUpdate(prevProps: Props): void;
   componentWillUnmount(): void;
   getWidgetEditor: (id: string, type: string) => void | React.Node;
   _handleWidgetEditorChange: (
@@ -68,7 +65,7 @@ declare class Editor extends React.Component<EditorProps, EditorState> {
    * Calculate the size of all the images in props.content, and send
    * those sizes to this.props.images using props.onChange.
    */
-  _sizeImages: (props: EditorProps) => void;
+  _sizeImages: (props: Props) => void;
   handleDrop: (e: DragEvent) => void;
   handleChange: (e: SyntheticEvent<HTMLTextAreaElement>) => void;
   _handleKeyDown: (e: SyntheticKeyboardEvent<HTMLTextAreaElement>) => void;