@khanacademy/perseus 3.0.0 → 4.0.0

package/dist/components/button-group.js.flow

@@ -0,0 +1,33 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import * as React from "react";
+declare type Props = {|
+  value: any,
+  buttons: $ReadOnlyArray<{|
+    value: any,
+    content: React.Node,
+    title?: string,
+  |}>,
+  onChange: (value?: any) => mixed,
+  allowEmpty: boolean,
+|};
+declare type DefaultProps = {|
+  allowEmpty: $PropertyType<Props, "allowEmpty">,
+  value: $PropertyType<Props, "value">,
+|};
+/**
+ * ButtonGroup is an aesthetically pleasing group of buttons.
+ */
+declare class ButtonGroup extends React.Component<Props> {
+  container: HTMLDivElement | null | void;
+  static defaultProps: DefaultProps;
+  componentWillUnmount(): void;
+  focus(): void | boolean;
+  toggleSelect(newValue: any): void;
+  render(): React.Node;
+}
+declare export default typeof ButtonGroup;

package/dist/components/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const devices: {
+    readonly PHONE: "phone";
+    readonly TABLET: "tablet";
+    readonly DESKTOP: "desktop";
+};
+export declare const lintGutterWidth = 36;
+export declare const perseusFrameBorderWidth = 1;

package/dist/components/constants.js.flow

@@ -0,0 +1,13 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+declare export var devices: {|
+  +PHONE: "phone",
+  +TABLET: "tablet",
+  +DESKTOP: "desktop",
+|};
+declare export var lintGutterWidth: 36;
+declare export var perseusFrameBorderWidth: 1;

package/dist/components/fixed-to-responsive.d.ts

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

package/dist/components/fixed-to-responsive.js.flow

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

package/dist/components/graph.d.ts

@@ -0,0 +1,44 @@
+import PropTypes from "prop-types";
+import * as React from "react";
+declare class Graph extends React.Component<any> {
+    protractor: any;
+    ruler: any;
+    _graphie: any;
+    _hasSetupGraphieThisUpdate: boolean;
+    _shouldSetupGraphie: boolean;
+    static propTypes: {
+        box: PropTypes.Validator<any[]>;
+        labels: PropTypes.Requireable<(string | null | undefined)[]>;
+        range: PropTypes.Requireable<((number | null | undefined)[] | null | undefined)[]>;
+        step: PropTypes.Requireable<(number | null | undefined)[]>;
+        gridStep: PropTypes.Requireable<(number | null | undefined)[]>;
+        snapStep: PropTypes.Requireable<(number | null | undefined)[]>;
+        markings: PropTypes.Requireable<string>;
+        backgroundImage: PropTypes.Requireable<PropTypes.InferProps<{
+            url: PropTypes.Requireable<string>;
+        }>>;
+        showProtractor: PropTypes.Requireable<boolean>;
+        showRuler: PropTypes.Requireable<boolean>;
+        rulerLabel: PropTypes.Requireable<string>;
+        rulerTicks: PropTypes.Requireable<number>;
+        onGraphieUpdated: PropTypes.Requireable<(...args: any[]) => any>;
+        instructions: PropTypes.Requireable<string>;
+        onClick: PropTypes.Requireable<(...args: any[]) => any>;
+        setDrawingAreaAvailable: PropTypes.Requireable<(...args: any[]) => any>;
+        isMobile: PropTypes.Requireable<boolean>;
+    };
+    static defaultProps: any;
+    render(): React.ReactNode;
+    componentDidMount(): void;
+    componentDidUpdate(): void;
+    UNSAFE_componentWillReceiveProps(nextProps: any): void;
+    reset: () => void;
+    graphie: () => any;
+    pointsFromNormalized: (arg1: any, arg2: any) => any;
+    _setupGraphie: (arg1: any) => void;
+    _getGridConfig: () => any;
+    _updateProtractor: () => void;
+    _updateRuler: () => void;
+    toJSON: () => any;
+}
+export default Graph;

package/dist/components/graph.js.flow

@@ -0,0 +1,52 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import PropTypes from "prop-types";
+import * as React from "react";
+declare class Graph extends React.Component<any> {
+  protractor: any;
+  ruler: any;
+  _graphie: any;
+  _hasSetupGraphieThisUpdate: boolean;
+  _shouldSetupGraphie: boolean;
+  static propTypes: {|
+    box: PropTypes.Validator<any[]>,
+    labels: PropTypes.Requireable<(string | null | void)[]>,
+    range: PropTypes.Requireable<((number | null | void)[] | null | void)[]>,
+    step: PropTypes.Requireable<(number | null | void)[]>,
+    gridStep: PropTypes.Requireable<(number | null | void)[]>,
+    snapStep: PropTypes.Requireable<(number | null | void)[]>,
+    markings: PropTypes.Requireable<string>,
+    backgroundImage: PropTypes.Requireable<
+      PropTypes.InferProps<{|
+        url: PropTypes.Requireable<string>,
+      |}>
+    >,
+    showProtractor: PropTypes.Requireable<boolean>,
+    showRuler: PropTypes.Requireable<boolean>,
+    rulerLabel: PropTypes.Requireable<string>,
+    rulerTicks: PropTypes.Requireable<number>,
+    onGraphieUpdated: PropTypes.Requireable<(...args: any[]) => any>,
+    instructions: PropTypes.Requireable<string>,
+    onClick: PropTypes.Requireable<(...args: any[]) => any>,
+    setDrawingAreaAvailable: PropTypes.Requireable<(...args: any[]) => any>,
+    isMobile: PropTypes.Requireable<boolean>,
+  |};
+  static defaultProps: any;
+  render(): React.Node;
+  componentDidMount(): void;
+  componentDidUpdate(): void;
+  UNSAFE_componentWillReceiveProps(nextProps: any): void;
+  reset: () => void;
+  graphie: () => any;
+  pointsFromNormalized: (arg1: any, arg2: any) => any;
+  _setupGraphie: (arg1: any) => void;
+  _getGridConfig: () => any;
+  _updateProtractor: () => void;
+  _updateRuler: () => void;
+  toJSON: () => any;
+}
+declare export default typeof Graph;

package/dist/components/graphie-classes.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A base class for all Graphie Movables
+ *
+ * Used for checking that all Graphie children are, in fact,
+ * GraphieMovables
+ */
+declare function GraphieMovable(descriptor: any): void;
+declare const _default: {
+    GraphieMovable: typeof GraphieMovable;
+    createClass: (spec: any) => any;
+    createSimpleClass: (addFunction: any) => any;
+};
+export default _default;

package/dist/components/graphie-classes.js.flow

@@ -0,0 +1,19 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+/**
+ * A base class for all Graphie Movables
+ *
+ * Used for checking that all Graphie children are, in fact,
+ * GraphieMovables
+ */
+declare function GraphieMovable(descriptor: any): void;
+declare var _default: {|
+  GraphieMovable: typeof GraphieMovable,
+  createClass: (spec: any) => any,
+  createSimpleClass: (addFunction: any) => any,
+|};
+declare export default typeof _default;

package/dist/components/graphie-movables.d.ts

@@ -0,0 +1,16 @@
+declare const _default: {
+    Arc: any;
+    Circle: any;
+    Label: any;
+    Line: any;
+    MovableLine: any;
+    MovablePoint: any;
+    Parabola: any;
+    Path: any;
+    Plot: any;
+    PlotParametric: any;
+    Point: any;
+    Sinusoid: any;
+    Rect: any;
+};
+export default _default;

package/dist/components/graphie-movables.js.flow

@@ -0,0 +1,22 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+declare var _default: {|
+  Arc: any,
+  Circle: any,
+  Label: any,
+  Line: any,
+  MovableLine: any,
+  MovablePoint: any,
+  Parabola: any,
+  Path: any,
+  Plot: any,
+  PlotParametric: any,
+  Point: any,
+  Sinusoid: any,
+  Rect: any,
+|};
+declare export default typeof _default;

package/dist/components/graphie.d.ts

@@ -0,0 +1,44 @@
+import PropTypes from "prop-types";
+import * as React from "react";
+type Props = any;
+declare class Graphie extends React.Component<Props> {
+    static propTypes: {
+        addMouseLayer: PropTypes.Requireable<boolean>;
+        box: PropTypes.Validator<(number | null | undefined)[]>;
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        isMobile: PropTypes.Requireable<boolean>;
+        onClick: PropTypes.Requireable<(...args: any[]) => any>;
+        onMouseDown: PropTypes.Requireable<(...args: any[]) => any>;
+        onMouseMove: PropTypes.Requireable<(...args: any[]) => any>;
+        onMouseUp: PropTypes.Requireable<(...args: any[]) => any>;
+        options: PropTypes.Requireable<PropTypes.InferProps<{
+            snapStep: PropTypes.Requireable<(number | null | undefined)[]>;
+        }>>;
+        range: PropTypes.Requireable<((number | null | undefined)[] | null | undefined)[]>;
+        responsive: PropTypes.Requireable<boolean>;
+        setDrawingAreaAvailable: PropTypes.Requireable<(...args: any[]) => any>;
+        setup: PropTypes.Validator<(...args: any[]) => any>;
+    };
+    static defaultProps: any;
+    componentDidMount(): void;
+    shouldComponentUpdate(nextProps: Props): boolean;
+    componentDidUpdate(prevProps: Props): void;
+    /**
+     * Allow parents of the <Graphie> component to grab a reference to the
+     * underlying graphie object using
+     * `this.refs.graphieComponent.getGraphie()`
+     *
+     * This shouldn't be necessary for 90% of cases, but the power is there.
+     * Use it for good and not evil.
+     */
+    getGraphie: () => any;
+    _range: () => ReadonlyArray<[number, number]>;
+    _box: () => ReadonlyArray<number>;
+    _scale: () => ReadonlyArray<number>;
+    _setupGraphie: () => void;
+    _removeMovables: () => void;
+    _renderMovables: (children: ReadonlyArray<any>, arg2: any) => React.ReactElement;
+    _updateMovables: () => void;
+    render(): React.ReactNode;
+}
+export default Graphie;

package/dist/components/graphie.js.flow

@@ -0,0 +1,56 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import PropTypes from "prop-types";
+import * as React from "react";
+declare type Props = any;
+declare class Graphie extends React.Component<Props> {
+  static propTypes: {|
+    addMouseLayer: PropTypes.Requireable<boolean>,
+    box: PropTypes.Validator<(number | null | void)[]>,
+    children: PropTypes.Requireable<PropTypes.ReactNodeLike>,
+    isMobile: PropTypes.Requireable<boolean>,
+    onClick: PropTypes.Requireable<(...args: any[]) => any>,
+    onMouseDown: PropTypes.Requireable<(...args: any[]) => any>,
+    onMouseMove: PropTypes.Requireable<(...args: any[]) => any>,
+    onMouseUp: PropTypes.Requireable<(...args: any[]) => any>,
+    options: PropTypes.Requireable<
+      PropTypes.InferProps<{|
+        snapStep: PropTypes.Requireable<(number | null | void)[]>,
+      |}>
+    >,
+    range: PropTypes.Requireable<((number | null | void)[] | null | void)[]>,
+    responsive: PropTypes.Requireable<boolean>,
+    setDrawingAreaAvailable: PropTypes.Requireable<(...args: any[]) => any>,
+    setup: PropTypes.Validator<(...args: any[]) => any>,
+  |};
+  static defaultProps: any;
+  componentDidMount(): void;
+  shouldComponentUpdate(nextProps: Props): boolean;
+  componentDidUpdate(prevProps: Props): void;
+
+  /**
+   * Allow parents of the <Graphie> component to grab a reference to the
+   * underlying graphie object using
+   * `this.refs.graphieComponent.getGraphie()`
+   *
+   * This shouldn't be necessary for 90% of cases, but the power is there.
+   * Use it for good and not evil.
+   */
+  getGraphie: () => any;
+  _range: () => $ReadOnlyArray<[number, number]>;
+  _box: () => $ReadOnlyArray<number>;
+  _scale: () => $ReadOnlyArray<number>;
+  _setupGraphie: () => void;
+  _removeMovables: () => void;
+  _renderMovables: (
+    children: $ReadOnlyArray<any>,
+    arg2: any
+  ) => React.Element<any>;
+  _updateMovables: () => void;
+  render(): React.Node;
+}
+declare export default typeof Graphie;

package/dist/components/highlighting/highlightable-content.d.ts

@@ -0,0 +1,39 @@
+import * as React from "react";
+import type { DOMHighlight, DOMHighlightSet, SerializedHighlightSet, DOMRange } from "./types";
+type HighlightableContentProps = {
+    children?: React.ReactElement<any>;
+    editable: boolean;
+    enabled: boolean;
+    onSerializedHighlightsUpdate: (serializedHighlights: SerializedHighlightSet) => unknown;
+    serializedHighlights: SerializedHighlightSet;
+};
+type HighlightableContentState = {
+    wordRanges: ReadonlyArray<DOMRange>;
+};
+declare class HighlightableContent extends React.PureComponent<HighlightableContentProps, HighlightableContentState> {
+    _container: HTMLElement | null | undefined;
+    _content: HTMLElement | null | undefined;
+    state: HighlightableContentState;
+    _buildHighlight(highlightRange: DOMRange): DOMHighlight | null | undefined;
+    /**
+     * Take the highlights from props, and deserialize them into DOMHighlights,
+     * according to the latest cache of word ranges.
+     */
+    _getDOMHighlights(): DOMHighlightSet;
+    /**
+     * Add the given DOMHighlight to the current set.
+     */
+    _handleAddHighlight: (highlight: DOMHighlight) => void;
+    /**
+     * Remove the given highlight from the list, and call our callback with the
+     * new set of highlights.
+     */
+    _handleRemoveHighlight: (keyToRemove: string) => void;
+    /**
+     * When our WordIndexer sends us a new cache of word ranges, store it in
+     * our component state.
+     */
+    _handleWordsUpdate: (wordRanges: ReadonlyArray<DOMRange>) => void;
+    render(): React.ReactNode;
+}
+export default HighlightableContent;

package/dist/components/highlighting/highlightable-content.js.flow

@@ -0,0 +1,59 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import * as React from "react";
+import type {
+  DOMHighlight,
+  DOMHighlightSet,
+  SerializedHighlightSet,
+  DOMRange,
+} from "./types";
+declare type HighlightableContentProps = {|
+  children?: React.Element<any>,
+  editable: boolean,
+  enabled: boolean,
+  onSerializedHighlightsUpdate: (
+    serializedHighlights: SerializedHighlightSet
+  ) => mixed,
+  serializedHighlights: SerializedHighlightSet,
+|};
+declare type HighlightableContentState = {|
+  wordRanges: $ReadOnlyArray<DOMRange>,
+|};
+declare class HighlightableContent
+  extends
+    React.PureComponent<HighlightableContentProps, HighlightableContentState>
+{
+  _container: HTMLElement | null | void;
+  _content: HTMLElement | null | void;
+  state: HighlightableContentState;
+  _buildHighlight(highlightRange: DOMRange): DOMHighlight | null | void;
+
+  /**
+   * Take the highlights from props, and deserialize them into DOMHighlights,
+   * according to the latest cache of word ranges.
+   */
+  _getDOMHighlights(): DOMHighlightSet;
+
+  /**
+   * Add the given DOMHighlight to the current set.
+   */
+  _handleAddHighlight: (highlight: DOMHighlight) => void;
+
+  /**
+   * Remove the given highlight from the list, and call our callback with the
+   * new set of highlights.
+   */
+  _handleRemoveHighlight: (keyToRemove: string) => void;
+
+  /**
+   * When our WordIndexer sends us a new cache of word ranges, store it in
+   * our component state.
+   */
+  _handleWordsUpdate: (wordRanges: $ReadOnlyArray<DOMRange>) => void;
+  render(): React.Node;
+}
+declare export default typeof HighlightableContent;

package/dist/components/highlighting/highlights.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Utility functions for manipulating highlights.
+ */
+import type { DOMHighlight, DOMHighlightSet, SerializedHighlight, DOMRange } from "./types";
+/**
+ * Given a list of DOMHighlights, return a new list that also includes the
+ * given DOMRange as a new DOMHighlight. If the DOMHighlight intersects
+ * existing DOMHighlights, the other Highlights are removed and their ranges
+ * are merged into the new DOMHighlight.
+ */
+export declare function addHighlight(existingHighlights: DOMHighlightSet, newHighlight: DOMHighlight): DOMHighlightSet;
+/**
+ * Given a DOMRange and a list of word ranges, build a corresponding
+ * DOMHighlight.
+ *
+ * If the DOMRange is not a valid highlight given the word ranges, return null.
+ */
+export declare function buildHighlight(existingHighlights: DOMHighlightSet, wordRanges: ReadonlyArray<DOMRange>, newHighlightRange: DOMRange): DOMHighlight | null | undefined;
+/**
+ * Given a SerializedHightlight and the current set of word ranges, return a
+ * DOMHighlight representing the SerializedHighlight.
+ *
+ * If the SerializedHighlight is not valid given the list of word ranges, throw
+ * an error.
+ */
+export declare function deserializeHighlight(serializedHighlight: SerializedHighlight, wordRanges: ReadonlyArray<DOMRange>): DOMHighlight;
+/**
+ * Return a SerializedHighlight representing the given DOMHighlight.
+ */
+export declare function serializeHighlight(highlight: DOMHighlight): SerializedHighlight;

package/dist/components/highlighting/highlights.js.flow

@@ -0,0 +1,54 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import type {
+  DOMHighlight,
+  DOMHighlightSet,
+  SerializedHighlight,
+  DOMRange,
+} from "./types";
+
+/**
+ * Given a list of DOMHighlights, return a new list that also includes the
+ * given DOMRange as a new DOMHighlight. If the DOMHighlight intersects
+ * existing DOMHighlights, the other Highlights are removed and their ranges
+ * are merged into the new DOMHighlight.
+ */
+declare export function addHighlight(
+  existingHighlights: DOMHighlightSet,
+  newHighlight: DOMHighlight
+): DOMHighlightSet;
+
+/**
+ * Given a DOMRange and a list of word ranges, build a corresponding
+ * DOMHighlight.
+ *
+ * If the DOMRange is not a valid highlight given the word ranges, return null.
+ */
+declare export function buildHighlight(
+  existingHighlights: DOMHighlightSet,
+  wordRanges: $ReadOnlyArray<DOMRange>,
+  newHighlightRange: DOMRange
+): DOMHighlight | null | void;
+
+/**
+ * Given a SerializedHightlight and the current set of word ranges, return a
+ * DOMHighlight representing the SerializedHighlight.
+ *
+ * If the SerializedHighlight is not valid given the list of word ranges, throw
+ * an error.
+ */
+declare export function deserializeHighlight(
+  serializedHighlight: SerializedHighlight,
+  wordRanges: $ReadOnlyArray<DOMRange>
+): DOMHighlight;
+
+/**
+ * Return a SerializedHighlight representing the given DOMHighlight.
+ */
+declare export function serializeHighlight(
+  highlight: DOMHighlight
+): SerializedHighlight;

package/dist/components/highlighting/ranges.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Utility functions for manipulating ranges of highlightable content.
+ */
+import type { DOMRange } from "./types";
+/**
+ * Given two DOMRanges, return a DOMRange whose start point comes from A, and
+ * whose end point comes from B.
+ */
+export declare function spanRanges(a: DOMRange, b: DOMRange): DOMRange;
+/**
+ * Given two DOMRanges, return whether they overlap.
+ *
+ * We here treat ranges like closed intervals: the boundary points are
+ * considered to be included in the range, and, if a ends exactly where b
+ * starts, they are considered to overlap.
+ */
+export declare function rangesOverlap(a: DOMRange, b: DOMRange): boolean;
+/**
+ * Given two DOMRanges, return whether the first includes the second: whether
+ * all points that B contains are also contained by A.
+ */
+export declare function rangeIncludes(a: DOMRange, b: DOMRange): boolean;
+/**
+ * Given two DOMRanges, intersect them: return a range that contains all points
+ * that both A contains and B contains, and contains no other points.
+ *
+ * If A and B do not overlap, no intersection exists; return null.
+ */
+export declare function intersectRanges(a: DOMRange, b: DOMRange): DOMRange | null | undefined;
+/**
+ * Given two DOMRanges, union them: return a range that contains all points
+ * that either A contains or B contains, and contains no other points.
+ *
+ * If A and B do not overlap, no union exists; return null.
+ */
+export declare function unionRanges(a: DOMRange, b: DOMRange): DOMRange | null | undefined;
+/**
+ * Given a list of word ranges, and a selection range, binary search the list
+ * and return the indexes of the first and last words that the selection
+ * intersects, or `null` if the range includes no words.
+ */
+export declare function findFirstAndLastWordIndexes(selectionRange: DOMRange, wordRanges: ReadonlyArray<DOMRange>): [number, number] | null | undefined;

package/dist/components/highlighting/ranges.js.flow

@@ -0,0 +1,60 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import type { DOMRange } from "./types";
+
+/**
+ * Given two DOMRanges, return a DOMRange whose start point comes from A, and
+ * whose end point comes from B.
+ */
+declare export function spanRanges(a: DOMRange, b: DOMRange): DOMRange;
+
+/**
+ * Given two DOMRanges, return whether they overlap.
+ *
+ * We here treat ranges like closed intervals: the boundary points are
+ * considered to be included in the range, and, if a ends exactly where b
+ * starts, they are considered to overlap.
+ */
+declare export function rangesOverlap(a: DOMRange, b: DOMRange): boolean;
+
+/**
+ * Given two DOMRanges, return whether the first includes the second: whether
+ * all points that B contains are also contained by A.
+ */
+declare export function rangeIncludes(a: DOMRange, b: DOMRange): boolean;
+
+/**
+ * Given two DOMRanges, intersect them: return a range that contains all points
+ * that both A contains and B contains, and contains no other points.
+ *
+ * If A and B do not overlap, no intersection exists; return null.
+ */
+declare export function intersectRanges(
+  a: DOMRange,
+  b: DOMRange
+): DOMRange | null | void;
+
+/**
+ * Given two DOMRanges, union them: return a range that contains all points
+ * that either A contains or B contains, and contains no other points.
+ *
+ * If A and B do not overlap, no union exists; return null.
+ */
+declare export function unionRanges(
+  a: DOMRange,
+  b: DOMRange
+): DOMRange | null | void;
+
+/**
+ * Given a list of word ranges, and a selection range, binary search the list
+ * and return the indexes of the first and last words that the selection
+ * intersects, or `null` if the range includes no words.
+ */
+declare export function findFirstAndLastWordIndexes(
+  selectionRange: DOMRange,
+  wordRanges: $ReadOnlyArray<DOMRange>
+): [number, number] | null | void;