@khanacademy/perseus 2.1.0 → 4.0.0

package/dist/util/colors.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Color constants we use throughout Perseus (originally on KhanUtil).
+ *
+ * Note that if the color palette changes substantially, it may also need to be
+ * updated in khan-exercises and cherry-picked into graphie-to-png's
+ * khan-exercises submodule, as graphie-to-png still relies on the palette
+ * provided on KhanUtil.
+ */
+declare const KhanColors: {
+    readonly BLUE: "#6495ED";
+    readonly ORANGE: "#FFA500";
+    readonly PINK: "#FF00AF";
+    readonly GREEN: "#28AE7B";
+    readonly PURPLE: "#9D38BD";
+    readonly RED: "#DF0030";
+    readonly GRAY: "gray";
+    readonly BLACK: "black";
+    readonly LIGHT_BLUE: "#9AB8ED";
+    readonly LIGHT_ORANGE: "#EDD19B";
+    readonly LIGHT_PINK: "#ED9BD3";
+    readonly LIGHT_GREEN: "#9BEDCE";
+    readonly LIGHT_PURPLE: "#DA9BED";
+    readonly LIGHT_RED: "#ED9AAC";
+    readonly LIGHT_GRAY: "#ED9B9B";
+    readonly LIGHT_BLACK: "#ED9B9B";
+    readonly GRAY10: "#D6D6D6";
+    readonly GRAY20: "#CDCDCD";
+    readonly GRAY30: "#B3B3B3";
+    readonly GRAY40: "#9A9A9A";
+    readonly GRAY50: "#808080";
+    readonly GRAY60: "#666666";
+    readonly GRAY70: "#4D4D4D";
+    readonly GRAY80: "#333333";
+    readonly GRAY90: "#1A1A1A";
+    readonly BLUE_A: "#CCFAFF";
+    readonly BLUE_B: "#80F6FF";
+    readonly BLUE_C: "#63D9EA";
+    readonly BLUE_D: "#11ACCD";
+    readonly BLUE_E: "#0C7F99";
+    readonly TEAL_A: "#94FFF5";
+    readonly TEAL_B: "#26EDD5";
+    readonly TEAL_C: "#01D1C1";
+    readonly TEAL_D: "#01A995";
+    readonly TEAL_E: "#208170";
+    readonly GREEN_A: "#B6FFB0";
+    readonly GREEN_B: "#8AF281";
+    readonly GREEN_C: "#74CF70";
+    readonly GREEN_D: "#1FAB54";
+    readonly GREEN_E: "#0D923F";
+    readonly GOLD_A: "#FFD0A9";
+    readonly GOLD_B: "#FFBB71";
+    readonly GOLD_C: "#FF9C39";
+    readonly GOLD_D: "#E07D10";
+    readonly GOLD_E: "#A75A05";
+    readonly RED_A: "#FCA9A9";
+    readonly RED_B: "#FF8482";
+    readonly RED_C: "#F9685D";
+    readonly RED_D: "#E84D39";
+    readonly RED_E: "#BC2612";
+    readonly MAROON_A: "#FFBDE0";
+    readonly MAROON_B: "#FF92C6";
+    readonly MAROON_C: "#ED5FA6";
+    readonly MAROON_D: "#CA337C";
+    readonly MAROON_E: "#9E034E";
+    readonly PURPLE_A: "#DDD7FF";
+    readonly PURPLE_B: "#C6B9FC";
+    readonly PURPLE_C: "#AA87FF";
+    readonly PURPLE_D: "#7854AB";
+    readonly PURPLE_E: "#543B78";
+    readonly MINT_A: "#F5F9E8";
+    readonly MINT_B: "#EDF2DF";
+    readonly MINT_C: "#E0E5CC";
+    readonly GRAY_A: "#F6F7F7";
+    readonly GRAY_B: "#F0F1F2";
+    readonly GRAY_C: "#E3E5E6";
+    readonly GRAY_D: "#D6D8DA";
+    readonly GRAY_E: "#BABEC2";
+    readonly GRAY_F: "#888D93";
+    readonly GRAY_G: "#626569";
+    readonly GRAY_H: "#3B3E40";
+    readonly GRAY_I: "#21242C";
+    readonly KA_BLUE: "#314453";
+    readonly KA_GREEN: "#71B307";
+    readonly _BACKGROUND: "#FDFDFD";
+    readonly INTERACTING: "#71B307";
+    readonly INTERACTIVE: "#71B307";
+    readonly DYNAMIC: "#6495ED";
+};
+export default KhanColors;

package/dist/util/colors.js.flow

@@ -0,0 +1,95 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+/**
+ * Color constants we use throughout Perseus (originally on KhanUtil).
+ *
+ * Note that if the color palette changes substantially, it may also need to be
+ * updated in khan-exercises and cherry-picked into graphie-to-png's
+ * khan-exercises submodule, as graphie-to-png still relies on the palette
+ * provided on KhanUtil.
+ */
+declare var KhanColors: {|
+  +BLUE: "#6495ED",
+  +ORANGE: "#FFA500",
+  +PINK: "#FF00AF",
+  +GREEN: "#28AE7B",
+  +PURPLE: "#9D38BD",
+  +RED: "#DF0030",
+  +GRAY: "gray",
+  +BLACK: "black",
+  +LIGHT_BLUE: "#9AB8ED",
+  +LIGHT_ORANGE: "#EDD19B",
+  +LIGHT_PINK: "#ED9BD3",
+  +LIGHT_GREEN: "#9BEDCE",
+  +LIGHT_PURPLE: "#DA9BED",
+  +LIGHT_RED: "#ED9AAC",
+  +LIGHT_GRAY: "#ED9B9B",
+  +LIGHT_BLACK: "#ED9B9B",
+  +GRAY10: "#D6D6D6",
+  +GRAY20: "#CDCDCD",
+  +GRAY30: "#B3B3B3",
+  +GRAY40: "#9A9A9A",
+  +GRAY50: "#808080",
+  +GRAY60: "#666666",
+  +GRAY70: "#4D4D4D",
+  +GRAY80: "#333333",
+  +GRAY90: "#1A1A1A",
+  +BLUE_A: "#CCFAFF",
+  +BLUE_B: "#80F6FF",
+  +BLUE_C: "#63D9EA",
+  +BLUE_D: "#11ACCD",
+  +BLUE_E: "#0C7F99",
+  +TEAL_A: "#94FFF5",
+  +TEAL_B: "#26EDD5",
+  +TEAL_C: "#01D1C1",
+  +TEAL_D: "#01A995",
+  +TEAL_E: "#208170",
+  +GREEN_A: "#B6FFB0",
+  +GREEN_B: "#8AF281",
+  +GREEN_C: "#74CF70",
+  +GREEN_D: "#1FAB54",
+  +GREEN_E: "#0D923F",
+  +GOLD_A: "#FFD0A9",
+  +GOLD_B: "#FFBB71",
+  +GOLD_C: "#FF9C39",
+  +GOLD_D: "#E07D10",
+  +GOLD_E: "#A75A05",
+  +RED_A: "#FCA9A9",
+  +RED_B: "#FF8482",
+  +RED_C: "#F9685D",
+  +RED_D: "#E84D39",
+  +RED_E: "#BC2612",
+  +MAROON_A: "#FFBDE0",
+  +MAROON_B: "#FF92C6",
+  +MAROON_C: "#ED5FA6",
+  +MAROON_D: "#CA337C",
+  +MAROON_E: "#9E034E",
+  +PURPLE_A: "#DDD7FF",
+  +PURPLE_B: "#C6B9FC",
+  +PURPLE_C: "#AA87FF",
+  +PURPLE_D: "#7854AB",
+  +PURPLE_E: "#543B78",
+  +MINT_A: "#F5F9E8",
+  +MINT_B: "#EDF2DF",
+  +MINT_C: "#E0E5CC",
+  +GRAY_A: "#F6F7F7",
+  +GRAY_B: "#F0F1F2",
+  +GRAY_C: "#E3E5E6",
+  +GRAY_D: "#D6D8DA",
+  +GRAY_E: "#BABEC2",
+  +GRAY_F: "#888D93",
+  +GRAY_G: "#626569",
+  +GRAY_H: "#3B3E40",
+  +GRAY_I: "#21242C",
+  +KA_BLUE: "#314453",
+  +KA_GREEN: "#71B307",
+  +_BACKGROUND: "#FDFDFD",
+  +INTERACTING: "#71B307",
+  +INTERACTIVE: "#71B307",
+  +DYNAMIC: "#6495ED",
+|};
+declare export default typeof KhanColors;

package/dist/util/fix-passage-refs.d.ts

@@ -0,0 +1,2 @@
+declare const FixPassageRefs: (itemData: any) => any;
+export default FixPassageRefs;

package/dist/util/fix-passage-refs.js.flow

@@ -0,0 +1,8 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+declare var FixPassageRefs: (itemData: any) => any;
+declare export default typeof FixPassageRefs;

package/dist/util/graph-utils.d.ts

@@ -0,0 +1,12 @@
+/**
+ * A wrapper around graphie.js and interactive.js to make sure interactive.js
+ * is always required at the same time as graphie.js. This is because
+ * interactive.js has side effects that are hard to see (it adds things to
+ * `Graphie.prototype`), so someone might forget to require interactive.js.
+ *
+ * To use the utilities exported from interactive.js, require that file
+ * itself.
+ */
+import GraphUtils from "./graphie";
+import "./interactive";
+export default GraphUtils;

package/dist/util/graph-utils.js.flow

@@ -0,0 +1,9 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import GraphUtils from "./graphie";
+import "./interactive";
+declare export default typeof GraphUtils;

package/dist/util/graphie.d.ts

@@ -0,0 +1,2 @@
+declare const GraphUtils: any;
+export default GraphUtils;

package/dist/util/graphie.js.flow

@@ -0,0 +1,8 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+declare var GraphUtils: any;
+declare export default typeof GraphUtils;

package/dist/util/interactive.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Interactive graphie utilities.
+ *
+ * This file exposes a couple functions, but mostly it adds functions to the
+ * `Graphie` prototype for dealing with interactive graphie elements.
+ */
+import "../jquery.mobile.vmouse";
+declare const InteractiveUtils: any;
+export default InteractiveUtils;

package/dist/util/interactive.js.flow

@@ -0,0 +1,9 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import "../jquery.mobile.vmouse";
+declare var InteractiveUtils: any;
+declare export default typeof InteractiveUtils;

package/dist/util/katex-preprocess.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Preprocess TeX code to convert things that KaTeX doesn't know how to handle
+ * to things is does.
+ */
+declare const _default: (texCode: string) => string;
+export default _default;

package/dist/util/katex-preprocess.js.flow

@@ -0,0 +1,12 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+/**
+ * Preprocess TeX code to convert things that KaTeX doesn't know how to handle
+ * to things is does.
+ */
+declare var _default: (texCode: string) => string;
+declare export default typeof _default;

package/dist/util/math.d.ts

@@ -0,0 +1,28 @@
+import type { MathFormat } from "../perseus-types";
+declare const KhanMath: {
+    readonly cleanMath: (expr: string) => string;
+    readonly bound: (num: number) => number;
+    readonly factorial: (x: number) => number;
+    readonly getGCD: (a: number, b: number) => number;
+    readonly getLCM: (a: number, b: number) => number;
+    readonly primes: readonly [2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97];
+    readonly isPrime: (n: number) => boolean;
+    readonly getPrimeFactorization: (number: number) => ReadonlyArray<number>;
+    readonly roundToNearest: (increment: number, num: number) => number;
+    readonly roundTo: (precision: number, num: number) => number;
+    /**
+     * Return a string of num rounded to a fixed precision decimal places,
+     * with an approx symbol if num had to be rounded, and trailing 0s
+     */
+    readonly toFixedApprox: (num: number, precision: number) => string;
+    /**
+     * Return a string of num rounded to precision decimal places, with an
+     * approx symbol if num had to be rounded, but no trailing 0s if it was
+     * not rounded.
+     */
+    readonly roundToApprox: (num: number, precision: number) => string;
+    readonly toFraction: (decimal: number, tolerance?: number) => [number, number];
+    readonly getNumericFormat: (text: string) => MathFormat | null | undefined;
+    readonly toNumericString: (number: number, format?: MathFormat) => string;
+};
+export default KhanMath;

package/dist/util/math.js.flow

@@ -0,0 +1,62 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import type { MathFormat } from "../perseus-types";
+declare var KhanMath: {|
+  +cleanMath: (expr: string) => string,
+  +bound: (num: number) => number,
+  +factorial: (x: number) => number,
+  +getGCD: (a: number, b: number) => number,
+  +getLCM: (a: number, b: number) => number,
+  +primes: [
+    2,
+    3,
+    5,
+    7,
+    11,
+    13,
+    17,
+    19,
+    23,
+    29,
+    31,
+    37,
+    41,
+    43,
+    47,
+    53,
+    59,
+    61,
+    67,
+    71,
+    73,
+    79,
+    83,
+    89,
+    97
+  ],
+  +isPrime: (n: number) => boolean,
+  +getPrimeFactorization: (number: number) => $ReadOnlyArray<number>,
+  +roundToNearest: (increment: number, num: number) => number,
+  +roundTo: (precision: number, num: number) => number,
+
+  /**
+   * Return a string of num rounded to a fixed precision decimal places,
+   * with an approx symbol if num had to be rounded, and trailing 0s
+   */
+  +toFixedApprox: (num: number, precision: number) => string,
+
+  /**
+   * Return a string of num rounded to precision decimal places, with an
+   * approx symbol if num had to be rounded, but no trailing 0s if it was
+   * not rounded.
+   */
+  +roundToApprox: (num: number, precision: number) => string,
+  +toFraction: (decimal: number, tolerance?: number) => [number, number],
+  +getNumericFormat: (text: string) => MathFormat | null | void,
+  +toNumericString: (number: number, format?: MathFormat) => string,
+|};
+declare export default typeof KhanMath;

package/dist/util/mobile-native-utils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Helps us detect that we are running in a mobile native environment for
+ * any js that is bundled in the mobile app (e.g. Perseus).
+ *
+ * @param {*} protocol protocol portion of a URL. Generally: window.location.protocol
+ */
+export declare const isFileProtocol: (protocol?: string | null) => boolean;

package/dist/util/mobile-native-utils.js.flow

@@ -0,0 +1,12 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+/**
+ * Helps us detect that we are running in a mobile native environment for
+ * any js that is bundled in the mobile app (e.g. Perseus).
+ * @param {*} protocol protocol portion of a URL. Generally: window.location.protocol
+ */
+declare export var isFileProtocol: (protocol?: string | null) => boolean;

package/dist/util/react-render.d.ts

@@ -0,0 +1,2 @@
+import * as React from "react";
+export default function render<ElementType extends React.ElementType>(element: React.ReactNode, container: HTMLElement, callback?: () => void): React.ElementRef<ElementType>;

package/dist/util/react-render.js.flow

@@ -0,0 +1,12 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import * as React from "react";
+declare export default function render<ElementType: React.ElementType<>>(
+  element: React.Node,
+  container: HTMLElement,
+  callback?: () => void
+): React.ElementRef<ElementType>;

package/dist/util/register-all-widgets-for-testing.d.ts

@@ -0,0 +1 @@
+export declare const registerAllWidgetsForTesting: () => void;

package/dist/util/register-all-widgets-for-testing.js.flow

@@ -0,0 +1,7 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+declare export var registerAllWidgetsForTesting: () => void;

package/dist/util/scroll-utils.d.ts

@@ -0,0 +1,10 @@
+/**
+ * A small collection of useful scrolling utility functions.
+ */
+/**
+ * Scroll the given element into view.
+ *
+ * This works with elements inside scroll containers, but may fail in scenarios
+ * involving multiple nested scroll containers.
+ */
+export declare const scrollElementIntoView: (element: Element, callback?: any) => void;

package/dist/util/scroll-utils.js.flow

@@ -0,0 +1,19 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+/**
+ * A small collection of useful scrolling utility functions.
+ */
+/**
+ * Scroll the given element into view.
+ *
+ * This works with elements inside scroll containers, but may fail in scenarios
+ * involving multiple nested scroll containers.
+ */
+declare export var scrollElementIntoView: (
+  element: Element,
+  callback?: any
+) => void;

package/dist/util/sizing-utils.d.ts

@@ -0,0 +1,9 @@
+export declare const containerSizeClass: {
+    readonly SMALL: "small";
+    readonly MEDIUM: "medium";
+    readonly LARGE: "large";
+    readonly XLARGE: "xlarge";
+};
+export type SizeClass = typeof containerSizeClass[keyof typeof containerSizeClass];
+export declare const getClassFromWidth: (width: number) => SizeClass;
+export declare const getInteractiveBoxFromSizeClass: (sizeClass: SizeClass) => [number, number];

package/dist/util/sizing-utils.js.flow

@@ -0,0 +1,20 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+declare export var containerSizeClass: {|
+  +SMALL: "small",
+  +MEDIUM: "medium",
+  +LARGE: "large",
+  +XLARGE: "xlarge",
+|};
+export type SizeClass = $ElementType<
+  typeof containerSizeClass,
+  $Keys<typeof containerSizeClass>
+>;
+declare export var getClassFromWidth: (width: number) => SizeClass;
+declare export var getInteractiveBoxFromSizeClass: (
+  sizeClass: SizeClass
+) => [number, number];

package/dist/util/tex.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    processMath: (elem: HTMLElement, text: string, force?: boolean, callback?: () => unknown) => Promise<void>;
+    cleanupMath: (elem: HTMLElement) => HTMLElement;
+    retrieveMathFormula: (elem: HTMLElement) => any;
+};
+export default _default;

package/dist/util/tex.js.flow

@@ -0,0 +1,17 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+declare var _default: {|
+  processMath: (
+    elem: HTMLElement,
+    text: string,
+    force?: boolean,
+    callback?: () => mixed
+  ) => Promise<void>,
+  cleanupMath: (elem: HTMLElement) => HTMLElement,
+  retrieveMathFormula: (elem: HTMLElement) => any,
+|};
+declare export default typeof _default;

package/dist/util/url-utils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Turns a URL into an absolute URL.
+ *
+ * @param {string} url The URL to turn into an absolute URL.
+ */
+export declare const toAbsoluteUrl: (url: string) => string;

package/dist/util/url-utils.js.flow

@@ -0,0 +1,11 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+/**
+ * Turns a URL into an absolute URL.
+ * @param {string} url The URL to turn into an absolute URL.
+ */
+declare export var toAbsoluteUrl: (url: string) => string;