@khanacademy/perseus-editor 1.1.1 → 2.0.1

package/dist/diffs/structured-item-diff.js.flow

@@ -0,0 +1,37 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import * as React from "react";
+import type { Item, Path, Shape } from "@khanacademy/perseus";
+declare type ItemList = [mixed, Path];
+declare type Tag = {|
+  idToName: (arg1: string) => string,
+  nameToId: (arg1: string) => string,
+  names: $ReadOnlyArray<string>,
+|};
+declare type Props = {|
+  after: Item,
+  before: Item,
+  shape: Shape,
+  tags: Tag,
+|};
+declare class StructuredItemDiff extends React.Component<Props> {
+  /**
+   * Traverses the given shape and adds paths that are present in
+   * beforeList and afterList to result. Note that this method assumes
+   * the order of elements in beforeList and afterList, which are
+   * from buildMapper(), is the same order they appear in in the shape.
+   */
+  static generateCompletePathsList(
+    beforeList: Array<ItemList>,
+    afterList: Array<ItemList>,
+    result: Array<Path>,
+    shape: Shape,
+    path: $ReadOnlyArray<any>
+  ): void;
+  render(): React.Node;
+}
+declare export default typeof StructuredItemDiff;

package/dist/diffs/tags-diff.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A side by side diff view for general passage layout tags.
+ */
+import * as React from "react";
+type Props = {
+    afterOnly: ReadonlyArray<string>;
+    beforeOnly: ReadonlyArray<string>;
+    intersection: ReadonlyArray<string>;
+    showSeparator: boolean;
+    title: string;
+};
+declare class TagsDiff extends React.Component<Props> {
+    static defaultProps: {
+        afterOnly: ReadonlyArray<any>;
+        beforeOnly: ReadonlyArray<any>;
+        showSeparator: boolean;
+        title: string;
+    };
+    render(): React.ReactNode;
+}
+export default TagsDiff;

package/dist/diffs/tags-diff.js.flow

@@ -0,0 +1,24 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import * as React from "react";
+declare type Props = {|
+  afterOnly: $ReadOnlyArray<string>,
+  beforeOnly: $ReadOnlyArray<string>,
+  intersection: $ReadOnlyArray<string>,
+  showSeparator: boolean,
+  title: string,
+|};
+declare class TagsDiff extends React.Component<Props> {
+  static defaultProps: {|
+    afterOnly: $ReadOnlyArray<any>,
+    beforeOnly: $ReadOnlyArray<any>,
+    showSeparator: boolean,
+    title: string,
+  |};
+  render(): React.Node;
+}
+declare export default typeof TagsDiff;

package/dist/diffs/text-diff.d.ts

@@ -0,0 +1,15 @@
+import PropTypes from "prop-types";
+import * as React from "react";
+declare class TextDiff extends React.Component<any, any> {
+    static propTypes: {
+        after: PropTypes.Requireable<string>;
+        before: PropTypes.Requireable<string>;
+        title: PropTypes.Validator<string>;
+    };
+    static defaultProps: any;
+    state: any;
+    UNSAFE_componentWillReceiveProps(nextProps: any): void;
+    handleExpand: () => void;
+    render(): React.ReactNode;
+}
+export default TextDiff;

package/dist/diffs/text-diff.js.flow

@@ -0,0 +1,21 @@
+/**
+ * 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 TextDiff extends React.Component<any, any> {
+  static propTypes: {|
+    after: PropTypes.Requireable<string>,
+    before: PropTypes.Requireable<string>,
+    title: PropTypes.Validator<string>,
+  |};
+  static defaultProps: any;
+  state: any;
+  UNSAFE_componentWillReceiveProps(nextProps: any): void;
+  handleExpand: () => void;
+  render(): React.Node;
+}
+declare export default typeof TextDiff;

package/dist/diffs/widget-diff-performer.d.ts

@@ -0,0 +1,2 @@
+declare const performDiff: (before: any, after: any, key?: any) => any;
+export default performDiff;

package/dist/diffs/widget-diff-performer.js.flow

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

package/dist/diffs/widget-diff.d.ts

@@ -0,0 +1,21 @@
+import PropTypes from "prop-types";
+import * as React from "react";
+declare class WidgetDiff extends React.Component<any> {
+    static propTypes: {
+        after: PropTypes.Requireable<PropTypes.InferProps<{
+            options: PropTypes.Requireable<{
+                [x: string]: any;
+            }>;
+        }>>;
+        before: PropTypes.Requireable<PropTypes.InferProps<{
+            options: PropTypes.Requireable<{
+                [x: string]: any;
+            }>;
+        }>>;
+        title: PropTypes.Validator<string>;
+        type: PropTypes.Requireable<string>;
+    };
+    static defaultProps: any;
+    render(): React.ReactNode;
+}
+export default WidgetDiff;

package/dist/diffs/widget-diff.js.flow

@@ -0,0 +1,31 @@
+/**
+ * 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 WidgetDiff extends React.Component<any> {
+  static propTypes: {|
+    after: PropTypes.Requireable<
+      PropTypes.InferProps<{|
+        options: PropTypes.Requireable<{
+          [x: string]: any,
+        }>,
+      |}>
+    >,
+    before: PropTypes.Requireable<
+      PropTypes.InferProps<{|
+        options: PropTypes.Requireable<{
+          [x: string]: any,
+        }>,
+      |}>
+    >,
+    title: PropTypes.Validator<string>,
+    type: PropTypes.Requireable<string>,
+  |};
+  static defaultProps: any;
+  render(): React.Node;
+}
+declare export default typeof WidgetDiff;

package/dist/editor-page.d.ts

@@ -0,0 +1,57 @@
+import * as React from "react";
+import type { APIOptions, APIOptionsWithDefaults, ChangeHandler, DeviceType, Hint, ImageUploader, RendererInterface, Version, KEScore } from "@khanacademy/perseus";
+type Props = {
+    apiOptions?: APIOptions;
+    answerArea?: any;
+    contentPaths?: ReadonlyArray<string>;
+    developerMode: boolean;
+    frameSource: string;
+    hints?: ReadonlyArray<Hint>;
+    imageUploader?: ImageUploader;
+    itemDataVersion?: Version;
+    itemId: string;
+    jsonMode: boolean;
+    onChange: ChangeHandler;
+    onPreviewDeviceChange: (arg1: DeviceType) => unknown;
+    previewDevice: DeviceType;
+    question?: any;
+    previewURL: string;
+};
+type PerseusJson = {
+    question: any;
+    answerArea: any;
+    hints: ReadonlyArray<Hint>;
+    itemDataVersion?: Version;
+};
+type State = {
+    json: PerseusJson;
+    gradeMessage: string;
+    wasAnswered: boolean;
+    highlightLint: boolean;
+};
+declare class EditorPage extends React.Component<Props, State> {
+    _isMounted: boolean;
+    rendererMountNode: HTMLDivElement;
+    renderer: RendererInterface | null | undefined;
+    static defaultProps: {
+        developerMode: boolean;
+        jsonMode: boolean;
+        onChange: () => void;
+    };
+    constructor(props: Props);
+    componentDidMount(): void;
+    componentDidUpdate(): void;
+    componentWillUnmount(): void;
+    toggleJsonMode: () => void;
+    updateRenderer(): void;
+    getApiOptions(): APIOptionsWithDefaults;
+    getSaveWarnings(): any;
+    serialize(options?: {
+        keepDeletedWidgets?: boolean;
+    }): any | PerseusJson;
+    handleChange: ChangeHandler;
+    changeJSON: (newJson: PerseusJson) => void;
+    scorePreview(): KEScore | null | undefined;
+    render(): React.ReactNode;
+}
+export default EditorPage;

package/dist/editor-page.js.flow

@@ -0,0 +1,73 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import * as React from "react";
+import type {
+  APIOptions,
+  APIOptionsWithDefaults,
+  ChangeHandler,
+  DeviceType,
+  Hint,
+  ImageUploader,
+  RendererInterface,
+  Version,
+  KEScore,
+} from "@khanacademy/perseus";
+declare type Props = {|
+  apiOptions?: APIOptions,
+  answerArea?: any,
+  contentPaths?: $ReadOnlyArray<string>,
+  developerMode: boolean,
+  frameSource: string,
+  hints?: $ReadOnlyArray<Hint>,
+  imageUploader?: ImageUploader,
+  itemDataVersion?: Version,
+  itemId: string,
+  jsonMode: boolean,
+  onChange: ChangeHandler,
+  onPreviewDeviceChange: (arg1: DeviceType) => mixed,
+  previewDevice: DeviceType,
+  question?: any,
+  previewURL: string,
+|};
+declare type PerseusJson = {|
+  question: any,
+  answerArea: any,
+  hints: $ReadOnlyArray<Hint>,
+  itemDataVersion?: Version,
+|};
+declare type State = {|
+  json: PerseusJson,
+  gradeMessage: string,
+  wasAnswered: boolean,
+  highlightLint: boolean,
+|};
+declare class EditorPage extends React.Component<Props, State> {
+  _isMounted: boolean;
+  rendererMountNode: HTMLDivElement;
+  renderer: RendererInterface | null | void;
+  static defaultProps: {|
+    developerMode: boolean,
+    jsonMode: boolean,
+    onChange: () => void,
+  |};
+  constructor(props: Props): this;
+  componentDidMount(): void;
+  componentDidUpdate(): void;
+  componentWillUnmount(): void;
+  toggleJsonMode: () => void;
+  updateRenderer(): void;
+  getApiOptions(): APIOptionsWithDefaults;
+  getSaveWarnings(): any;
+  serialize(options?: {|
+    keepDeletedWidgets?: boolean,
+  |}): any | PerseusJson;
+  handleChange: ChangeHandler;
+  changeJSON: (newJson: PerseusJson) => void;
+  scorePreview(): KEScore | null | void;
+  render(): React.Node;
+}
+declare export default typeof EditorPage;

package/dist/editor.d.ts

@@ -0,0 +1,82 @@
+import katex from "katex";
+import * as React from "react";
+import type { ChangeHandler, WidgetInfo } from "@khanacademy/perseus";
+type EditorProps = Readonly<{
+    apiOptions: any;
+    className?: string;
+    content: string;
+    replace?: any;
+    placeholder: string;
+    widgets: {
+        [name: string]: WidgetInfo;
+    };
+    images: any;
+    disabled: boolean;
+    widgetEnabled: boolean;
+    immutableWidgets: boolean;
+    showWordCount: boolean;
+    warnNoPrompt: boolean;
+    warnNoWidgets: boolean;
+    imageUploader?: (file: string, callback: (url: string) => unknown) => unknown;
+    onChange: ChangeHandler;
+}>;
+type DeafultProps = {
+    content: string;
+    disabled: boolean;
+    images: Record<any, any>;
+    immutableWidgets: boolean;
+    placeholder: string;
+    showWordCount: boolean;
+    warnNoPrompt: boolean;
+    warnNoWidgets: boolean;
+    widgetEnabled: boolean;
+    widgets: {
+        [name: string]: WidgetInfo;
+    };
+};
+type EditorState = {
+    showKatexErrors: boolean;
+    textAreaValue: string;
+    katex?: katex;
+};
+declare class Editor extends React.Component<EditorProps, EditorState> {
+    lastUserValue: string | null | undefined;
+    deferredChange: any | null | undefined;
+    widgetIds: any | null | undefined;
+    static defaultProps: DeafultProps;
+    state: EditorState;
+    componentDidMount(): void;
+    UNSAFE_componentWillReceiveProps(nextProps: EditorProps): void;
+    componentDidUpdate(prevProps: EditorProps): void;
+    componentWillUnmount(): void;
+    getWidgetEditor: (id: string, type: string) => undefined | React.ReactNode;
+    _handleWidgetEditorChange: (id: string, newWidgetInfo: WidgetInfo, cb?: () => unknown, silent?: boolean) => void;
+    _handleWidgetEditorRemove: (id: string) => void;
+    /**
+     * 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;
+    handleDrop: (e: DragEvent) => void;
+    handleChange: (e: React.SyntheticEvent<HTMLTextAreaElement>) => void;
+    _handleKeyDown: (e: React.KeyboardEvent<HTMLTextAreaElement>) => void;
+    _maybeCopyWidgets: (e: React.SyntheticEvent<HTMLTextAreaElement>) => void;
+    _maybePasteWidgets: (e: React.SyntheticEvent<HTMLTextAreaElement>) => void;
+    _safeWidgetNameMapping: (widgetData: {
+        [name: string]: any;
+    }) => Record<any, any>;
+    _addWidgetToContent: (oldContent: string, cursorRange: ReadonlyArray<number>, widgetType: string) => void;
+    _addWidget: (widgetType: string) => void;
+    addTemplate: (e: React.SyntheticEvent<HTMLTextAreaElement>) => void;
+    getSaveWarnings: () => any;
+    focus: () => void;
+    focusAndMoveToEnd: () => void;
+    serialize: (options?: any) => {
+        content: string;
+        images: any;
+        replace: any | undefined;
+        widgets: Record<any, any>;
+    };
+    render(): React.ReactNode;
+}
+export default Editor;

package/dist/editor.js.flow

@@ -0,0 +1,98 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * 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<{|
+  apiOptions: any,
+  className?: string,
+  content: string,
+  replace?: any,
+  placeholder: string,
+  widgets: {
+    [name: string]: WidgetInfo,
+  },
+  images: any,
+  disabled: boolean,
+  widgetEnabled: boolean,
+  immutableWidgets: boolean,
+  showWordCount: boolean,
+  warnNoPrompt: boolean,
+  warnNoWidgets: boolean,
+  imageUploader?: (file: string, callback: (url: string) => mixed) => mixed,
+  onChange: ChangeHandler,
+|}>;
+declare type DeafultProps = {|
+  content: string,
+  disabled: boolean,
+  images: { [key: any]: any },
+  immutableWidgets: boolean,
+  placeholder: string,
+  showWordCount: boolean,
+  warnNoPrompt: boolean,
+  warnNoWidgets: boolean,
+  widgetEnabled: boolean,
+  widgets: {
+    [name: string]: WidgetInfo,
+  },
+|};
+declare type EditorState = {|
+  showKatexErrors: boolean,
+  textAreaValue: string,
+  katex?: katex,
+|};
+declare class Editor extends React.Component<EditorProps, EditorState> {
+  lastUserValue: string | null | void;
+  deferredChange: any | null | void;
+  widgetIds: any | null | void;
+  static defaultProps: DeafultProps;
+  state: EditorState;
+  componentDidMount(): void;
+  UNSAFE_componentWillReceiveProps(nextProps: EditorProps): void;
+  componentDidUpdate(prevProps: EditorProps): void;
+  componentWillUnmount(): void;
+  getWidgetEditor: (id: string, type: string) => void | React.Node;
+  _handleWidgetEditorChange: (
+    id: string,
+    newWidgetInfo: WidgetInfo,
+    cb?: () => mixed,
+    silent?: boolean
+  ) => void;
+  _handleWidgetEditorRemove: (id: string) => void;
+
+  /**
+   * 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;
+  handleDrop: (e: DragEvent) => void;
+  handleChange: (e: SyntheticEvent<HTMLTextAreaElement>) => void;
+  _handleKeyDown: (e: SyntheticKeyboardEvent<HTMLTextAreaElement>) => void;
+  _maybeCopyWidgets: (e: SyntheticEvent<HTMLTextAreaElement>) => void;
+  _maybePasteWidgets: (e: SyntheticEvent<HTMLTextAreaElement>) => void;
+  _safeWidgetNameMapping: (widgetData: {
+    [name: string]: any,
+  }) => { [key: any]: any };
+  _addWidgetToContent: (
+    oldContent: string,
+    cursorRange: $ReadOnlyArray<number>,
+    widgetType: string
+  ) => void;
+  _addWidget: (widgetType: string) => void;
+  addTemplate: (e: SyntheticEvent<HTMLTextAreaElement>) => void;
+  getSaveWarnings: () => any;
+  focus: () => void;
+  focusAndMoveToEnd: () => void;
+  serialize: (options?: any) => {|
+    content: string,
+    images: any,
+    replace: any | void,
+    widgets: { [key: any]: any },
+  |};
+  render(): React.Node;
+}
+declare export default typeof Editor;