@khanacademy/perseus-editor 4.1.5 → 4.1.6

package/src/article-editor.tsx

@@ -1,438 +0,0 @@
-/* eslint-disable jsx-a11y/anchor-is-valid */
-/**
- * An article editor. Articles are long-form pieces of content, composed of
- * multiple (Renderer) sections concatenated together.
- */
-
-import {
-    components,
-    icons,
-    ApiOptions,
-    Errors,
-    PerseusError,
-} from "@khanacademy/perseus";
-import * as React from "react";
-import _ from "underscore";
-
-import DeviceFramer from "./components/device-framer";
-import JsonEditor from "./components/json-editor";
-import SectionControlButton from "./components/section-control-button";
-import Editor from "./editor";
-import IframeContentRenderer from "./iframe-content-renderer";
-
-import type {APIOptions, Changeable} from "@khanacademy/perseus";
-
-const {HUD, InlineIcon} = components;
-const {iconCircleArrowDown, iconCircleArrowUp, iconPlus, iconTrash} = icons;
-
-type RendererProps = {
-    content?: string;
-    widgets?: any;
-    images?: any;
-};
-
-type JsonType = RendererProps | ReadonlyArray<RendererProps>;
-type DefaultProps = {
-    contentPaths?: ReadonlyArray<string>;
-    json: JsonType;
-    mode: "diff" | "edit" | "json" | "preview";
-    screen: "phone" | "tablet" | "desktop";
-    sectionImageUploadGenerator: (
-        i: number,
-    ) => React.ReactElement<React.ComponentProps<"span">>;
-    useNewStyles: boolean;
-};
-type Props = DefaultProps & {
-    apiOptions?: APIOptions;
-    imageUploader?: (arg1: string, arg2: (arg1: string) => unknown) => unknown;
-    // URL of the route to show on initial load of the preview frames.
-    previewURL: string;
-} & Changeable.ChangeableProps;
-
-type State = {
-    highlightLint: boolean;
-};
-export default class ArticleEditor extends React.Component<Props, State> {
-    static defaultProps: DefaultProps = {
-        contentPaths: [],
-        json: [{}],
-        mode: "edit",
-        screen: "desktop",
-        sectionImageUploadGenerator: () => <span />,
-        useNewStyles: false,
-    };
-
-    state: State = {
-        highlightLint: true,
-    };
-
-    componentDidMount() {
-        this._updatePreviewFrames();
-    }
-
-    componentDidUpdate() {
-        this._updatePreviewFrames();
-    }
-
-    _updatePreviewFrames() {
-        if (this.props.mode === "preview") {
-            // eslint-disable-next-line react/no-string-refs
-            // @ts-expect-error - TS2339 - Property 'sendNewData' does not exist on type 'ReactInstance'.
-            this.refs["frame-all"].sendNewData({
-                type: "article-all",
-                data: this._sections().map((section, i) => {
-                    return this._apiOptionsForSection(section, i);
-                }),
-            });
-        } else if (this.props.mode === "edit") {
-            this._sections().forEach((section, i) => {
-                // eslint-disable-next-line react/no-string-refs
-                // @ts-expect-error - TS2339 - Property 'sendNewData' does not exist on type 'ReactInstance'.
-                this.refs["frame-" + i].sendNewData({
-                    type: "article",
-                    data: this._apiOptionsForSection(section, i),
-                });
-            });
-        }
-    }
-
-    _apiOptionsForSection(section: RendererProps, sectionIndex: number): any {
-        // eslint-disable-next-line react/no-string-refs
-        const editor = this.refs[`editor${sectionIndex}`];
-        return {
-            apiOptions: {
-                ...ApiOptions.defaults,
-                ...this.props.apiOptions,
-
-                // Alignment options are always available in article
-                // editors
-                showAlignmentOptions: true,
-                isArticle: true,
-            },
-            json: section,
-            useNewStyles: this.props.useNewStyles,
-            linterContext: {
-                contentType: "article",
-                highlightLint: this.state.highlightLint,
-                paths: this.props.contentPaths,
-            },
-            // @ts-expect-error - TS2339 - Property 'getSaveWarnings' does not exist on type 'ReactInstance'.
-            legacyPerseusLint: editor ? editor.getSaveWarnings() : [],
-        };
-    }
-
-    _sections(): ReadonlyArray<RendererProps> {
-        return Array.isArray(this.props.json)
-            ? this.props.json
-            : [this.props.json];
-    }
-
-    _renderEditor(): React.ReactElement<React.ComponentProps<"div">> {
-        const {imageUploader, sectionImageUploadGenerator} = this.props;
-
-        const apiOptions = {
-            ...ApiOptions.defaults,
-            ...this.props.apiOptions,
-
-            // Alignment options are always available in article editors
-            showAlignmentOptions: true,
-            isArticle: true,
-        } as const;
-
-        const sections = this._sections();
-
-        return (
-            <div className="perseus-editor-table">
-                {sections.map((section, i) => {
-                    return [
-                        <div className="perseus-editor-row" key={i}>
-                            <div className="perseus-editor-left-cell">
-                                <div className="pod-title">
-                                    Section {i + 1}
-                                    <div
-                                        style={{
-                                            display: "inline-block",
-                                            float: "right",
-                                        }}
-                                    >
-                                        {sectionImageUploadGenerator(i)}
-                                        <SectionControlButton
-                                            icon={iconPlus}
-                                            onClick={() => {
-                                                this._handleAddSectionAfter(i);
-                                            }}
-                                            title="Add a new section after this one"
-                                        />
-                                        {i + 1 < sections.length && (
-                                            <SectionControlButton
-                                                icon={iconCircleArrowDown}
-                                                onClick={() => {
-                                                    this._handleMoveSectionLater(
-                                                        i,
-                                                    );
-                                                }}
-                                                title="Move this section down"
-                                            />
-                                        )}
-                                        {i > 0 && (
-                                            <SectionControlButton
-                                                icon={iconCircleArrowUp}
-                                                onClick={() => {
-                                                    this._handleMoveSectionEarlier(
-                                                        i,
-                                                    );
-                                                }}
-                                                title="Move this section up"
-                                            />
-                                        )}
-                                        <SectionControlButton
-                                            icon={iconTrash}
-                                            onClick={() => {
-                                                const msg =
-                                                    "Are you sure you " +
-                                                    "want to delete section " +
-                                                    (i + 1) +
-                                                    "?";
-                                                /* eslint-disable no-alert */
-                                                if (confirm(msg)) {
-                                                    this._handleRemoveSection(
-                                                        i,
-                                                    );
-                                                }
-                                                /* eslint-enable no-alert */
-                                            }}
-                                            title="Delete this section"
-                                        />
-                                    </div>
-                                </div>
-                                <Editor
-                                    {...section}
-                                    apiOptions={apiOptions}
-                                    imageUploader={imageUploader}
-                                    onChange={_.partial(
-                                        this._handleEditorChange,
-                                        i,
-                                    )}
-                                    placeholder="Type your section text here..."
-                                    ref={"editor" + i}
-                                />
-                            </div>
-
-                            <div className="editor-preview">
-                                {this._renderIframePreview(i, true)}
-                            </div>
-                        </div>,
-                    ];
-                })}
-                {this._renderAddSection()}
-                {this._renderLinterHUD()}
-            </div>
-        );
-        /* eslint-enable max-len */
-    }
-
-    _renderAddSection(): React.ReactElement<React.ComponentProps<"div">> {
-        return (
-            <div className="perseus-editor-row">
-                <div className="perseus-editor-left-cell">
-                    <a
-                        href="#"
-                        className="simple-button orange"
-                        onClick={() => {
-                            this._handleAddSectionAfter(
-                                this._sections().length - 1,
-                            );
-                        }}
-                    >
-                        <InlineIcon {...iconPlus} /> Add a section
-                    </a>
-                </div>
-            </div>
-        );
-    }
-
-    _renderLinterHUD(): React.ReactElement<any> {
-        return (
-            <HUD
-                message="Style warnings"
-                enabled={this.state.highlightLint}
-                onClick={() => {
-                    this.setState({
-                        highlightLint: !this.state.highlightLint,
-                    });
-                }}
-            />
-        );
-    }
-
-    _renderIframePreview(
-        i: number | string,
-        nochrome: boolean,
-    ): React.ReactElement<any> {
-        const isMobile =
-            this.props.screen === "phone" || this.props.screen === "tablet";
-
-        return (
-            <DeviceFramer deviceType={this.props.screen} nochrome={nochrome}>
-                <IframeContentRenderer
-                    ref={"frame-" + i}
-                    key={this.props.screen}
-                    datasetKey="mobile"
-                    datasetValue={isMobile}
-                    seamless={nochrome}
-                    url={this.props.previewURL}
-                />
-            </DeviceFramer>
-        );
-    }
-
-    _renderPreviewMode(): React.ReactElement<React.ComponentProps<"div">> {
-        return (
-            <div className="standalone-preview">
-                {this._renderIframePreview("all", false)}
-            </div>
-        );
-    }
-
-    _handleJsonChange: (newJson: JsonType) => void = (newJson) => {
-        this.props.onChange({json: newJson});
-    };
-
-    _handleEditorChange: (i: number, newProps: RendererProps) => void = (
-        i,
-        newProps,
-    ) => {
-        const sections = _.clone(this._sections());
-        // @ts-expect-error - TS2542 - Index signature in type 'readonly RendererProps[]' only permits reading.
-        sections[i] = _.extend({}, sections[i], newProps);
-        this.props.onChange({json: sections});
-    };
-
-    _handleMoveSectionEarlier(i: number) {
-        if (i === 0) {
-            return;
-        }
-        const sections = _.clone(this._sections());
-        const section = sections[i];
-        // @ts-expect-error - TS2551 - Property 'splice' does not exist on type 'readonly RendererProps[]'. Did you mean 'slice'?
-        sections.splice(i, 1);
-        // @ts-expect-error - TS2551 - Property 'splice' does not exist on type 'readonly RendererProps[]'. Did you mean 'slice'?
-        sections.splice(i - 1, 0, section);
-        this.props.onChange({
-            json: sections,
-        });
-    }
-
-    _handleMoveSectionLater(i: number) {
-        const sections = _.clone(this._sections());
-        if (i + 1 === sections.length) {
-            return;
-        }
-        const section = sections[i];
-        // @ts-expect-error - TS2551 - Property 'splice' does not exist on type 'readonly RendererProps[]'. Did you mean 'slice'?
-        sections.splice(i, 1);
-        // @ts-expect-error - TS2551 - Property 'splice' does not exist on type 'readonly RendererProps[]'. Did you mean 'slice'?
-        sections.splice(i + 1, 0, section);
-        this.props.onChange({
-            json: sections,
-        });
-    }
-
-    _handleAddSectionAfter(i: number) {
-        // We do a full serialization here because we
-        // might be copying widgets:
-        const sections = _.clone(this.serialize());
-        // Here we do magic to allow you to copy-paste
-        // things from the previous section into the new
-        // section while preserving widgets.
-        // To enable this, we preserve the widgets
-        // object for the new section, but wipe out
-        // the content.
-        const newSection =
-            i >= 0
-                ? {
-                      widgets: sections[i].widgets,
-                  }
-                : {};
-        // @ts-expect-error - TS2339 - Property 'splice' does not exist on type 'JsonType'.
-        sections.splice(i + 1, 0, newSection);
-        this.props.onChange({
-            json: sections,
-        });
-    }
-
-    _handleRemoveSection(i: number) {
-        const sections = _.clone(this._sections());
-        // @ts-expect-error - TS2551 - Property 'splice' does not exist on type 'readonly RendererProps[]'. Did you mean 'slice'?
-        sections.splice(i, 1);
-        this.props.onChange({
-            json: sections,
-        });
-    }
-
-    serialize(): JsonType {
-        if (this.props.mode === "edit") {
-            return this._sections().map((section, i) => {
-                // eslint-disable-next-line react/no-string-refs
-                // @ts-expect-error - TS2339 - Property 'serialize' does not exist on type 'ReactInstance'.
-                return this.refs["editor" + i].serialize();
-            });
-        }
-        if (this.props.mode === "preview" || this.props.mode === "json") {
-            return this.props.json;
-        }
-        throw new PerseusError(
-            "Could not serialize; mode " + this.props.mode + " not found",
-            Errors.Internal,
-        );
-    }
-
-    /**
-     * Returns an array, with one element be section.
-     * Each element is an array of lint warnings present in that section.
-     *
-     * This function can currently only be called in edit mode.
-     */
-    getSaveWarnings(): ReadonlyArray<RendererProps> {
-        if (this.props.mode !== "edit") {
-            // TODO(joshuan): We should be able to get save warnings in
-            // preview mode.
-            throw new PerseusError(
-                "Can only get save warnings in edit mode.",
-                Errors.NotAllowed,
-            );
-        }
-
-        return this._sections().map((section, i) => {
-            // eslint-disable-next-line react/no-string-refs
-            // @ts-expect-error - TS2339 - Property 'getSaveWarnings' does not exist on type 'ReactInstance'.
-            return this.refs["editor" + i].getSaveWarnings();
-        });
-    }
-
-    render(): React.ReactNode {
-        return (
-            <div className="framework-perseus perseus-article-editor">
-                {this.props.mode === "edit" && this._renderEditor()}
-
-                {this.props.mode === "preview" && this._renderPreviewMode()}
-
-                {this.props.mode === "json" && (
-                    <div className="json-editor">
-                        <div className="json-editor-warning">
-                            <span>
-                                Warning: Editing in this mode can lead to broken
-                                articles!
-                            </span>
-                        </div>
-                        <JsonEditor
-                            multiLine={true}
-                            onChange={this._handleJsonChange}
-                            value={this.props.json}
-                        />
-                    </div>
-                )}
-            </div>
-        );
-    }
-}

package/src/components/__stories__/blur-input.stories.tsx

@@ -1,22 +0,0 @@
-import {action} from "@storybook/addon-actions";
-import * as React from "react";
-
-import BlurInput from "../blur-input";
-
-export default {
-    title: "Perseus/Editor/Components/Blur Input",
-};
-
-export const Default = (): React.ReactElement => {
-    const [value, setValue] = React.useState("");
-
-    return (
-        <BlurInput
-            value={value}
-            onChange={(newValue) => {
-                action("onChange")(newValue);
-                setValue(newValue);
-            }}
-        />
-    );
-};

package/src/components/__stories__/section-control-button.stories.tsx

@@ -1,26 +0,0 @@
-import {icons} from "@khanacademy/perseus";
-import * as React from "react";
-
-import SectionControlButton from "../section-control-button";
-
-type StoryArgs = Record<any, any>;
-
-type Story = {
-    title: string;
-};
-
-export default {
-    title: "Perseus/Editor/Components/Section Control Button",
-} as Story;
-
-export const ButtonForEditingSectionsOfContentWithInArticleEditor = (
-    args: StoryArgs,
-): React.ReactElement => {
-    return (
-        <SectionControlButton
-            icon={icons.iconTrash}
-            onClick={() => {}}
-            title="Remove image widget"
-        />
-    );
-};

package/src/components/__tests__/blur-input.test.tsx

@@ -1,67 +0,0 @@
-import {render, screen} from "@testing-library/react";
-import userEvent from "@testing-library/user-event";
-import * as React from "react";
-
-import BlurInput from "../blur-input";
-
-import "@testing-library/jest-dom"; // Imports custom matchers
-
-describe("BlurInput", () => {
-    it("should render", () => {
-        render(<BlurInput value="Hello world!" onChange={() => {}} />);
-    });
-
-    it("should call onChange prop on blur", () => {
-        // Arrange
-        const onChange = jest.fn();
-        render(<BlurInput value="Hello world!" onChange={onChange} />);
-
-        // Act
-        userEvent.type(screen.getByRole("textbox"), "Hello Khan Academy!");
-        userEvent.tab();
-
-        // Assert
-        expect(onChange).toHaveBeenCalledTimes(1);
-    });
-
-    it("should call onChange prop when typing into input", () => {
-        // Arrange
-        const onChange = jest.fn();
-        render(<BlurInput value="Hello world!" onChange={onChange} />);
-
-        // Act
-        userEvent.type(screen.getByRole("textbox"), "Hello Khan Academy!");
-        // NO TAB
-
-        // Assert
-        expect(onChange).not.toHaveBeenCalledTimes(1);
-    });
-
-    it("should call onChange prop when pasting into input", () => {
-        // Arrange
-        const onChange = jest.fn();
-        render(<BlurInput value="Hello world!" onChange={onChange} />);
-
-        // Act
-        userEvent.paste(screen.getByRole("textbox"), "Hello Khan Academy!");
-        // NO TAB
-
-        // Assert
-        expect(onChange).not.toHaveBeenCalledTimes(1);
-    });
-
-    it("should focus input through focus function", () => {
-        const ref = React.createRef<BlurInput>();
-
-        // Arrange
-        render(
-            <BlurInput ref={ref} value="Hello world!" onChange={() => {}} />,
-        );
-
-        // Act
-        ref.current?.focus();
-
-        // Assert
-        expect(screen.getByRole("textbox")).toHaveFocus();
-    });
-});

package/src/components/blur-input.tsx

@@ -1,69 +0,0 @@
-import * as React from "react";
-
-import type {CSSProperties} from "aphrodite";
-
-type Props = {
-    value: string;
-    onChange: (arg1: string) => void;
-    className?: string;
-    style?: CSSProperties;
-};
-
-type State = {
-    value: string;
-};
-
-/* You know when you want to propagate input to a parent...
- * but then that parent does something with the input...
- * then changing the props of the input...
- * on every keystroke...
- * so if some input is invalid or incomplete...
- * the input gets reset or otherwise effed...
- *
- * This is the solution.
- *
- * Enough melodrama. Its an input that only sends changes
- * to its parent on blur.
- */
-// eslint-disable-next-line react/no-unsafe
-class BlurInput extends React.Component<Props, State> {
-    input = React.createRef<HTMLInputElement>();
-
-    constructor(props: Props) {
-        super(props);
-        this.state = {value: this.props.value};
-    }
-
-    // eslint-disable-next-line react/no-unsafe
-    UNSAFE_componentWillReceiveProps(nextProps: Props) {
-        this.setState({value: nextProps.value});
-    }
-
-    handleChange: (e: any) => void = (e) => {
-        this.setState({value: e.target.value});
-    };
-
-    handleBlur: (e: any) => void = (e) => {
-        this.props.onChange(e.target.value);
-    };
-
-    focus() {
-        this.input.current?.focus();
-    }
-
-    render(): React.ReactNode {
-        return (
-            <input
-                ref={this.input}
-                className={this.props.className}
-                style={this.props.style}
-                type="text"
-                value={this.state.value}
-                onChange={this.handleChange}
-                onBlur={this.handleBlur}
-            />
-        );
-    }
-}
-
-export default BlurInput;