@khanacademy/perseus 3.0.0 → 4.0.0

package/dist/interactive2.d.ts

@@ -0,0 +1,10 @@
+declare const Interactive2: {
+    readonly MovablePoint: (graphie: any, movable: any, options: any) => void;
+    readonly addMovablePoint: (graphie: any, options: any) => any;
+    readonly MovableLine: (graphie: any, movable: any, options: any) => void;
+    readonly addMovableLine: (graphie: any, options: any) => any;
+    readonly MovablePolygon: (graphie: any, movable: any, options: any) => void;
+    readonly addMovablePolygon: (graphie: any, options: any) => any;
+    readonly addMaybeMobileMovablePoint: (widget: any, extraProps: any) => any;
+};
+export default Interactive2;

package/dist/interactive2.js.flow

@@ -0,0 +1,16 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+declare var Interactive2: {|
+  +MovablePoint: (graphie: any, movable: any, options: any) => void,
+  +addMovablePoint: (graphie: any, options: any) => any,
+  +MovableLine: (graphie: any, movable: any, options: any) => void,
+  +addMovableLine: (graphie: any, options: any) => any,
+  +MovablePolygon: (graphie: any, movable: any, options: any) => void,
+  +addMovablePolygon: (graphie: any, options: any) => any,
+  +addMaybeMobileMovablePoint: (widget: any, extraProps: any) => any,
+|};
+declare export default typeof Interactive2;

package/dist/item-renderer.d.ts

@@ -0,0 +1,117 @@
+import * as React from "react";
+import HintsRenderer from "./hints-renderer";
+import Renderer from "./renderer";
+import type { KeypadProps } from "./mixins/provide-keypad";
+import type { PerseusItem } from "./perseus-types";
+import type { APIOptions, FocusPath, KEScore, LinterContextProps } from "./types";
+type Props = // These props are used by the ProvideKeypad mixin.
+KeypadProps & {
+    apiOptions: APIOptions;
+    controlPeripherals?: boolean;
+    workAreaSelector: string;
+    hintsAreaSelector: string;
+    initialHintsVisible?: number;
+    item: PerseusItem | any;
+    onShowCalculator?: () => unknown;
+    onShowChi2Table?: () => unknown;
+    onShowPeriodicTable?: () => unknown;
+    onShowTTable?: () => unknown;
+    onShowZTable?: () => unknown;
+    problemNum: number;
+    reviewMode: boolean;
+    savedState: any;
+    linterContext: LinterContextProps;
+    legacyPerseusLint?: ReadonlyArray<string>;
+};
+type DefaultProps = {
+    apiOptions: Props["apiOptions"];
+    controlPeripherals: Props["controlPeripherals"];
+    hintsAreaSelector: Props["hintsAreaSelector"];
+    initialHintsVisible: Props["initialHintsVisible"];
+    linterContext: Props["linterContext"];
+    reviewMode: Props["reviewMode"];
+    workAreaSelector: Props["workAreaSelector"];
+};
+type State = {
+    keypadElement: HTMLElement | null | undefined;
+    hintsVisible: number;
+    questionCompleted: boolean;
+    questionHighlightedWidgets: ReadonlyArray<string>;
+};
+type SerializedState = {
+    hints: any;
+    question: {
+        [id: string]: any;
+    };
+};
+declare class ItemRenderer extends React.Component<Props, State> {
+    questionRenderer: Renderer;
+    hintsRenderer: React.ElementRef<typeof HintsRenderer> | null | undefined;
+    _currentFocus: FocusPath;
+    static defaultProps: DefaultProps;
+    constructor(props: Props);
+    componentDidMount(): void;
+    UNSAFE_componentWillReceiveProps(nextProps: Props): void;
+    componentDidUpdate(): void;
+    componentWillUnmount(): void;
+    keypadElement(): any;
+    update(): void;
+    _handleFocusChange: (newFocus: FocusPath, oldFocus: FocusPath) => void;
+    _setCurrentFocus(newFocus: FocusPath): void;
+    _onRendererBlur(blurPath: FocusPath): void;
+    /**
+     * Accepts a question area widgetId, or an answer area widgetId of
+     * the form "answer-input-number 1", or the string "answer-area"
+     * for the whole answer area (if the answer area is a single widget).
+     */
+    _setWidgetProps(widgetId: string, newProps: any, callback: any): void;
+    /**
+     * Sets the input value into the widget found at `path`. The `focus`
+     * function provided is called when all affected widgets have been
+     * re-rendered with the new value.
+     */
+    setInputValue(path: FocusPath, newValue: string, focus: () => void): void;
+    focusPath(path: FocusPath): void;
+    blurPath(path: FocusPath): void;
+    getDOMNodeForPath(path: FocusPath): Element | Text | null | undefined;
+    getGrammarTypeForPath(path: FocusPath): string | null | undefined;
+    getInputPaths(): ReadonlyArray<FocusPath>;
+    handleInteractWithWidget: (widgetId: string) => void;
+    focus(): boolean | null | undefined;
+    blur(): void;
+    showHint(): void;
+    getNumHints(): number;
+    /**
+     * Grades the item.
+     *
+     * Returns a KE-style score of {
+     *     empty: bool,
+     *     correct: bool,
+     *     message: string|null,
+     *     guess: Array
+     * }
+     */
+    scoreInput(): KEScore;
+    /**
+     * Returns an array of all widget IDs in the order they occur in
+     * the question content.
+     */
+    getWidgetIds(): ReadonlyArray<string>;
+    /**
+     * Returns an object mapping from widget ID to KE-style score.
+     * The keys of this object are the values of the array returned
+     * from `getWidgetIds`.
+     */
+    scoreWidgets(): {
+        [id: string]: KEScore;
+    };
+    /**
+     * Get a representation of the current state of the item.
+     */
+    getSerializedState(): SerializedState;
+    restoreSerializedState(state: SerializedState, callback?: () => void): void;
+    showRationalesForCurrentlySelectedChoices(): void;
+    deselectIncorrectSelectedChoices(): void;
+    render(): React.ReactNode;
+}
+export default ItemRenderer;

package/dist/item-renderer.js.flow

@@ -0,0 +1,136 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import * as React from "react";
+import HintsRenderer from "./hints-renderer";
+import Renderer from "./renderer";
+import type { KeypadProps } from "./mixins/provide-keypad";
+import type { PerseusItem } from "./perseus-types";
+import type {
+  APIOptions,
+  FocusPath,
+  KEScore,
+  LinterContextProps,
+} from "./types";
+declare type Props = {|
+  ...KeypadProps,
+  ...{|
+    apiOptions: APIOptions,
+    controlPeripherals?: boolean,
+    workAreaSelector: string,
+    hintsAreaSelector: string,
+    initialHintsVisible?: number,
+    item: PerseusItem | any,
+    onShowCalculator?: () => mixed,
+    onShowChi2Table?: () => mixed,
+    onShowPeriodicTable?: () => mixed,
+    onShowTTable?: () => mixed,
+    onShowZTable?: () => mixed,
+    problemNum: number,
+    reviewMode: boolean,
+    savedState: any,
+    linterContext: LinterContextProps,
+    legacyPerseusLint?: $ReadOnlyArray<string>,
+  |},
+|};
+declare type DefaultProps = {|
+  apiOptions: $PropertyType<Props, "apiOptions">,
+  controlPeripherals: $PropertyType<Props, "controlPeripherals">,
+  hintsAreaSelector: $PropertyType<Props, "hintsAreaSelector">,
+  initialHintsVisible: $PropertyType<Props, "initialHintsVisible">,
+  linterContext: $PropertyType<Props, "linterContext">,
+  reviewMode: $PropertyType<Props, "reviewMode">,
+  workAreaSelector: $PropertyType<Props, "workAreaSelector">,
+|};
+declare type State = {|
+  keypadElement: HTMLElement | null | void,
+  hintsVisible: number,
+  questionCompleted: boolean,
+  questionHighlightedWidgets: $ReadOnlyArray<string>,
+|};
+declare type SerializedState = {|
+  hints: any,
+  question: {
+    [id: string]: any,
+  },
+|};
+declare class ItemRenderer extends React.Component<Props, State> {
+  questionRenderer: Renderer;
+  hintsRenderer: React.ElementRef<typeof HintsRenderer> | null | void;
+  _currentFocus: FocusPath;
+  static defaultProps: DefaultProps;
+  constructor(props: Props): this;
+  componentDidMount(): void;
+  UNSAFE_componentWillReceiveProps(nextProps: Props): void;
+  componentDidUpdate(): void;
+  componentWillUnmount(): void;
+  keypadElement(): any;
+  update(): void;
+  _handleFocusChange: (newFocus: FocusPath, oldFocus: FocusPath) => void;
+  _setCurrentFocus(newFocus: FocusPath): void;
+  _onRendererBlur(blurPath: FocusPath): void;
+
+  /**
+   * Accepts a question area widgetId, or an answer area widgetId of
+   * the form "answer-input-number 1", or the string "answer-area"
+   * for the whole answer area (if the answer area is a single widget).
+   */
+  _setWidgetProps(widgetId: string, newProps: any, callback: any): void;
+
+  /**
+   * Sets the input value into the widget found at `path`. The `focus`
+   * function provided is called when all affected widgets have been
+   * re-rendered with the new value.
+   */
+  setInputValue(path: FocusPath, newValue: string, focus: () => void): void;
+  focusPath(path: FocusPath): void;
+  blurPath(path: FocusPath): void;
+  getDOMNodeForPath(path: FocusPath): Element | Text | null | void;
+  getGrammarTypeForPath(path: FocusPath): string | null | void;
+  getInputPaths(): $ReadOnlyArray<FocusPath>;
+  handleInteractWithWidget: (widgetId: string) => void;
+  focus(): boolean | null | void;
+  blur(): void;
+  showHint(): void;
+  getNumHints(): number;
+
+  /**
+   * Grades the item.
+   *
+   * Returns a KE-style score of {
+   *     empty: bool,
+   *     correct: bool,
+   *     message: string|null,
+   *     guess: Array
+   * }
+   */
+  scoreInput(): KEScore;
+
+  /**
+   * Returns an array of all widget IDs in the order they occur in
+   * the question content.
+   */
+  getWidgetIds(): $ReadOnlyArray<string>;
+
+  /**
+   * Returns an object mapping from widget ID to KE-style score.
+   * The keys of this object are the values of the array returned
+   * from `getWidgetIds`.
+   */
+  scoreWidgets(): {
+    [id: string]: KEScore,
+  };
+
+  /**
+   * Get a representation of the current state of the item.
+   */
+  getSerializedState(): SerializedState;
+  restoreSerializedState(state: SerializedState, callback?: () => void): void;
+  showRationalesForCurrentlySelectedChoices(): void;
+  deselectIncorrectSelectedChoices(): void;
+  render(): React.Node;
+}
+declare export default typeof ItemRenderer;

package/dist/item-version.d.ts

@@ -0,0 +1,4 @@
+declare const ItemVersion: {
+    [key: string]: import("./types").Version;
+};
+export default ItemVersion;

package/dist/item-version.js.flow

@@ -0,0 +1,11 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import * as $Flowgen$Import$_2e__2f_types from "./types";
+declare var ItemVersion: {
+  [key: string]: $Flowgen$Import$_2e__2f_types.Version,
+};
+declare export default typeof ItemVersion;

package/dist/jipt-paragraphs.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Paragraph parsing/splitting for article jipt i18n
+ */
+declare const _default: {
+    parseToArray: (source: string) => string[];
+    joinFromArray: (paragraphs: readonly string[]) => string;
+};
+export default _default;

package/dist/jipt-paragraphs.js.flow

@@ -0,0 +1,14 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+/**
+ * Paragraph parsing/splitting for article jipt i18n
+ */
+declare var _default: {|
+  parseToArray: (source: string) => string[],
+  joinFromArray: (paragraphs: $ReadOnlyArray<string>) => string,
+|};
+declare export default typeof _default;

package/dist/keypad-context.d.ts

@@ -0,0 +1,20 @@
+/**
+ * KeypadContext provides a way to the Keypad and (Server)ItemRenderer to
+ * communicate.
+ *
+ * The KeypadContext.Provider wraps the ExerciseFooter while KeypadContext.Consumer
+ * wraps each (Server)ItemRenderer render site and the Keypad rendered in the
+ * ExerciseFooter.
+ */
+import * as React from "react";
+import type { RendererInterface } from "./types";
+type KeypadContext = {
+    setKeypadElement: (keypadElement?: HTMLElement | null | undefined) => void;
+    keypadElement: HTMLElement | null | undefined;
+    setRenderer: (renderer?: RendererInterface | null | undefined) => void;
+    renderer: RendererInterface | null | undefined;
+    setScrollableElement: (scrollableElement?: HTMLElement | null | undefined) => void;
+    scrollableElement: HTMLElement | null | undefined;
+};
+declare const context: React.Context<KeypadContext>;
+export default context;

package/dist/keypad-context.js.flow

@@ -0,0 +1,18 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import * as React from "react";
+import type { RendererInterface } from "./types";
+declare type KeypadContext = {|
+  setKeypadElement: (keypadElement?: HTMLElement | null | void) => void,
+  keypadElement: HTMLElement | null | void,
+  setRenderer: (renderer?: RendererInterface | null | void) => void,
+  renderer: RendererInterface | null | void,
+  setScrollableElement: (scrollableElement?: HTMLElement | null | void) => void,
+  scrollableElement: HTMLElement | null | void,
+|};
+declare var context: React.Context<KeypadContext>;
+declare export default typeof context;

package/dist/loading-context.d.ts

@@ -0,0 +1,14 @@
+/**
+ * A React context for signaling when all of the components in a Perseus
+ * renderer is fully rendered.  This means that all images and math have
+ * finished loading/rendering.
+ *
+ * Currently only used by ServerItemRender to indicate when the question
+ * renderer is fully rendered.
+ */
+import * as React from "react";
+type Context = {
+    onRendered: (isRendered: boolean) => void;
+};
+declare const context: React.Context<Context>;
+export default context;

package/dist/loading-context.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 type Context = {|
+  onRendered: (isRendered: boolean) => void,
+|};
+declare var context: React.Context<Context>;
+declare export default typeof context;

package/dist/logging/log.d.ts

@@ -0,0 +1,55 @@
+import type { Metadata } from "@khanacademy/wonder-stuff-core";
+/**
+ * @typedef {Object} Errors utility for referencing the Perseus error taxonomy.
+ */
+export declare const Errors: Readonly<{
+    /**
+     * @property {ErrorKind} Unknown The kind of error is not known.
+     */
+    Unknown: "Unknown";
+    /**
+     * @property {ErrorKind} Internal The error is internal to the executing code.
+     */
+    Internal: "Internal";
+    /**
+     * @property {ErrorKind} InvalidInput There was a problem with the provided
+     * input, such as the wrong format or a null value.
+     */
+    InvalidInput: "InvalidInput";
+    /**
+     * @property {ErrorKind} NotAllowed There was a problem due to the state of
+     * the system not matching the requested operation or input. For example,
+     * trying to create a username that is valid, but is already taken by
+     * another user. Use {@link InvalidInput} instead when the input isn't
+     * valid regardless of the state of the system. Use {@link NotFound} when
+     * the failure is due to not being able to find a resource.
+     */
+    NotAllowed: "NotAllowed";
+    /**
+     * @property {ErrorKind} TransientService There was a problem when making a
+     * request to a service.
+     */
+    TransientService: "TransientService";
+    /**
+     * @property {ErrorKind} Service There was a non-transient problem when
+     * making a request to service.
+     */
+    Service: "Service";
+}>;
+/**
+ * @type {ErrorKind} The kind of error being reported
+ */
+export type ErrorKind = typeof Errors[keyof typeof Errors];
+export type LogErrorOptions = {
+    cause?: Error | null | undefined;
+    loggedMetadata?: Metadata | null | undefined;
+    metadata?: Metadata | null | undefined;
+};
+/**
+ * Provides logging infrastructure for Perseus
+ */
+export interface ILogger {
+    log(message: string, extra?: Metadata | null | undefined): void;
+    error(message: string, kind: ErrorKind, extra?: LogErrorOptions): void;
+}
+export declare const Log: ILogger;

package/dist/logging/log.js.flow

@@ -0,0 +1,62 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import type { Metadata } from "@khanacademy/wonder-stuff-core";
+
+/**
+ * @typedef {Object} Errors utility for referencing the Perseus error taxonomy.
+ */
+declare export var Errors: $ReadOnly<{|
+  /**
+   * @property {ErrorKind} Unknown The kind of error is not known.
+   */
+  Unknown: "Unknown",
+
+  /**
+   * @property {ErrorKind} Internal The error is internal to the executing code.
+   */
+  Internal: "Internal",
+
+  /**
+   * @property {ErrorKind} InvalidInput There was a problem with the provided
+   * input, such as the wrong format or a null value.
+   */
+  InvalidInput: "InvalidInput",
+
+  /**
+   * @property [object Object],[object Object],[object Object],[object Object],[object Object]
+   */
+  NotAllowed: "NotAllowed",
+
+  /**
+   * @property {ErrorKind} TransientService There was a problem when making a
+   * request to a service.
+   */
+  TransientService: "TransientService",
+
+  /**
+   * @property {ErrorKind} Service There was a non-transient problem when
+   * making a request to service.
+   */
+  Service: "Service",
+|}>;
+/**
+ * @type {ErrorKind} The kind of error being reported
+ */
+export type ErrorKind = $ElementType<typeof Errors, $Keys<typeof Errors>>;
+export type LogErrorOptions = {|
+  cause?: Error | null | void,
+  loggedMetadata?: Metadata | null | void,
+  metadata?: Metadata | null | void,
+|};
+/**
+ * Provides logging infrastructure for Perseus
+ */
+export interface ILogger {
+  log(message: string, extra?: Metadata | null | void): void;
+  error(message: string, kind: ErrorKind, extra?: LogErrorOptions): void;
+}
+declare export var Log: ILogger;

package/dist/mixins/changeable.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Changeable
+ *
+ * Adds a this.change() function to a component
+ *
+ * This.change takes prop changes as parameters, and calls
+ * this.props.onChange with the modified props.
+ */
+import PropTypes from "prop-types";
+import type { ChangeFn } from "../types";
+/**
+ * this.change()
+ *
+ * Can be called as follows:
+ * this.change(newProps, callback);
+ *
+ * this.change(propName, propValue, callback);
+ *
+ * this.change(propName) -> returns a lambda that takes a prop value to
+ * set and a callback to call after having set that value.
+ */
+export declare const change: ChangeFn;
+export declare const propTypes: {
+    readonly onChange: PropTypes.Validator<(...args: any[]) => any>;
+};
+export type ChangeableProps = {
+    onChange: (values: {
+        [key: string]: any;
+    }, callback?: () => unknown | null | undefined, silent?: boolean) => unknown;
+};

package/dist/mixins/changeable.js.flow

@@ -0,0 +1,33 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import PropTypes from "prop-types";
+import type { ChangeFn } from "../types";
+
+/**
+ * this.change()
+ *
+ * Can be called as follows:
+ * this.change(newProps, callback);
+ *
+ * this.change(propName, propValue, callback);
+ *
+ * this.change(propName) -> returns a lambda that takes a prop value to
+ * set and a callback to call after having set that value.
+ */
+declare export var change: ChangeFn;
+declare export var propTypes: {|
+  +onChange: PropTypes.Validator<(...args: any[]) => any>,
+|};
+export type ChangeableProps = {|
+  onChange: (
+    values: {
+      [key: string]: any,
+    },
+    callback?: () => mixed | null | void,
+    silent?: boolean
+  ) => mixed,
+|};

package/dist/mixins/editor-jsonify.d.ts

@@ -0,0 +1,4 @@
+declare const EditorJsonify: {
+    readonly serialize: () => any;
+};
+export default EditorJsonify;

package/dist/mixins/editor-jsonify.js.flow

@@ -0,0 +1,10 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+declare var EditorJsonify: {|
+  +serialize: () => any,
+|};
+declare export default typeof EditorJsonify;

package/dist/mixins/provide-keypad.d.ts

@@ -0,0 +1,36 @@
+/**
+ * A mixin that renders a custom software keypad in additional to the base
+ * component. The base component will receive blur events when the keypad is
+ * dismissed and can access the keypad element itself so as to manage its
+ * activation and dismissal.
+ *
+ * TODO(charlie): This would make a nicer higher-order component, except that
+ * we need to expose methods on the base component (i.e., `ItemRenderer`). When
+ * `ItemRenderer` and friends are written as ES6 Classes, we can have them
+ * extend a `ProvideKeypad` component instead of using this mixin.
+ */
+import PropTypes from "prop-types";
+import type { CSSProperties } from "aphrodite";
+export type KeypadProps = {
+    keypadStyle?: CSSProperties;
+};
+export type KeypadApiOptions = {
+    customKeypad: boolean;
+    nativeKeypadProxy: any;
+};
+declare const ProvideKeypad: {
+    readonly propTypes: {
+        readonly apiOptions: PropTypes.Requireable<PropTypes.InferProps<{
+            customKeypad: PropTypes.Requireable<boolean>;
+            nativeKeypadProxy: PropTypes.Requireable<(...args: any[]) => any>;
+        }>>;
+        readonly keypadStyle: PropTypes.Requireable<any>;
+    };
+    readonly getInitialState: () => {
+        keypadElement: any | null;
+    };
+    readonly componentDidMount: () => void;
+    readonly componentWillUnmount: () => void;
+    readonly keypadElement: () => any;
+};
+export default ProvideKeypad;

package/dist/mixins/provide-keypad.js.flow

@@ -0,0 +1,33 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import PropTypes from "prop-types";
+import type { CSSProperties } from "aphrodite";
+export type KeypadProps = {|
+  keypadStyle?: CSSProperties,
+|};
+export type KeypadApiOptions = {|
+  customKeypad: boolean,
+  nativeKeypadProxy: any,
+|};
+declare var ProvideKeypad: {|
+  +propTypes: {|
+    +apiOptions: PropTypes.Requireable<
+      PropTypes.InferProps<{|
+        customKeypad: PropTypes.Requireable<boolean>,
+        nativeKeypadProxy: PropTypes.Requireable<(...args: any[]) => any>,
+      |}>
+    >,
+    +keypadStyle: PropTypes.Requireable<any>,
+  |},
+  +getInitialState: () => {|
+    keypadElement: any | null,
+  |},
+  +componentDidMount: () => void,
+  +componentWillUnmount: () => void,
+  +keypadElement: () => any,
+|};
+declare export default typeof ProvideKeypad;

package/dist/mixins/widget-jsonify-deprecated.d.ts

@@ -0,0 +1,5 @@
+declare const WidgetJsonifyDeprecated: {
+    readonly getUserInput: () => any;
+    readonly getUserInputFromProps: (props: any) => any;
+};
+export default WidgetJsonifyDeprecated;