@khanacademy/perseus 92.0.0 → 92.0.2

package/dist/perseus-markdown.new.d.ts

@@ -1,11 +0,0 @@
-declare const _default: {
-    characterCount: (source: string) => number;
-    traverseContent: (ast: any, cb: (node: any) => void) => void;
-    parse: (source: string, state: any) => any;
-    parseInline: (source: string, state: any) => any;
-    reactFor: (arg1: import("@khanacademy/simple-markdown").ReactNodeOutput) => import("@khanacademy/simple-markdown").ReactOutput;
-    ruleOutput: any;
-    basicOutput: any;
-    sanitizeUrl: (url?: string | null | undefined) => string | null | undefined;
-};
-export default _default;

package/dist/question-paragraph.new.d.ts

@@ -1,10 +0,0 @@
-import * as React from "react";
-type Props = {
-    className?: string | null | undefined;
-    translationIndex?: number;
-    paragraphIndex?: number;
-    children?: React.ReactNode;
-    inline?: boolean;
-};
-declare const QuestionParagraph: (props: Props) => React.ReactNode;
-export default QuestionParagraph;

package/dist/renderer.new.d.ts

@@ -1,199 +0,0 @@
-/***********************************************************************
- *                                                                     *
- * WARNING!!!! THERE ARE ACTIVE CHANGES HAPPENING IN THE RENDERER!     *
- *                                                                     *
- ***********************************************************************/
-import * as React from "react";
-import { PerseusI18nContext } from "./components/i18n-context";
-import InteractionTracker from "./interaction-tracker";
-import TranslationLinter from "./translation-linter";
-import WidgetContainer from "./widget-container.new";
-import type { DependenciesContext } from "./dependencies";
-import type { PerseusStrings } from "./strings";
-import type { APIOptions, APIOptionsWithDefaults, FilterCriterion, FindWidgetsFunction, FocusPath, Widget, WidgetProps } from "./types";
-import type { HandleUserInputCallback, InitializeUserInputCallback } from "./user-input-manager";
-import type { GetPromptJSONInterface, RendererPromptJSON } from "./widget-ai-utils/prompt-types";
-import type { KeypadAPI } from "@khanacademy/math-input";
-import type { PerseusRenderer, PerseusScore, PerseusWidget, PerseusWidgetOptions, PerseusWidgetsMap, ShowSolutions, UserInput, UserInputMap } from "@khanacademy/perseus-core";
-import type { LinterContextProps } from "@khanacademy/perseus-linter";
-import type { ASTNode, SingleASTNode } from "@khanacademy/simple-markdown";
-import "./styles/perseus-renderer.new.css";
-type WidgetState = {
-    isMobile?: boolean;
-    inTable?: boolean;
-    key?: number;
-    paragraphIndex?: number;
-    foundFullWidth?: boolean;
-    baseElements?: any;
-};
-type Props = Partial<React.ContextType<typeof DependenciesContext>> & {
-    content: PerseusRenderer["content"];
-    widgets: PerseusRenderer["widgets"];
-    images: PerseusRenderer["images"];
-    apiOptions?: APIOptions;
-    userInput?: UserInputMap;
-    handleUserInput?: HandleUserInputCallback;
-    initializeUserInput?: InitializeUserInputCallback;
-    alwaysUpdate?: boolean;
-    findExternalWidgets: FindWidgetsFunction;
-    keypadElement?: KeypadAPI | null;
-    onRender: (node?: any) => void;
-    problemNum?: number;
-    reviewMode?: boolean | null | undefined;
-    /**
-     * Meant to differentiate between "scorable" contexts (exercises, GradedGroup)
-     * and non-"scorable" contexts (articles, hints)
-     */
-    isScorable?: boolean;
-    /**
-     * If set to "all", all rationales or solutions will be shown. If set to
-     * "selected", soltions will only be shown for selected choices. If set to
-     * "none", solutions will not be shown-- equivalent to `undefined`.
-     */
-    showSolutions?: ShowSolutions;
-    /**
-     * If linterContext.highlightLint is true, then content will be passed to
-     * the linter and any warnings will be highlighted in the rendered output.
-     */
-    linterContext: LinterContextProps;
-    legacyPerseusLint?: ReadonlyArray<string>;
-    /**
-     *  Skip adding paragraph class
-     */
-    inline?: boolean;
-    strings: PerseusStrings;
-};
-type State = {
-    translationLintErrors: ReadonlyArray<string>;
-    widgetInfo: Readonly<PerseusWidgetsMap>;
-    jiptContent: string | null;
-};
-type DefaultProps = Required<Pick<Props, "alwaysUpdate" | "content" | "findExternalWidgets" | "images" | "linterContext" | "onRender" | "showSolutions" | "reviewMode" | "isScorable" | "widgets">>;
-declare class Renderer extends React.Component<Props, State> implements GetPromptJSONInterface {
-    static contextType: React.Context<import("./components/i18n-context").I18nContextType>;
-    context: React.ContextType<typeof PerseusI18nContext>;
-    _currentFocus: FocusPath | null | undefined;
-    _foundTextNodes: boolean;
-    _interactionTrackers: {
-        [id: string]: InteractionTracker<any>;
-    };
-    _isMounted: boolean;
-    _isTwoColumn: boolean;
-    _translationLinter: TranslationLinter;
-    _widgetContainers: Map<string, WidgetContainer>;
-    translationIndex: number;
-    widgetIds: Array<string>;
-    static defaultProps: DefaultProps;
-    constructor(props: Props);
-    componentDidMount(): void;
-    UNSAFE_componentWillReceiveProps(nextProps: Props): void;
-    shouldComponentUpdate(nextProps: Props, nextState: State): any | boolean;
-    componentDidUpdate(prevProps: Props, prevState: State): void;
-    componentWillUnmount(): void;
-    getApiOptions: () => APIOptionsWithDefaults;
-    _getInitialWidgetState: (props: Props) => {
-        widgetInfo: State["widgetInfo"];
-    };
-    _getDefaultWidgetInfo: (widgetId: string) => any;
-    _getWidgetInfo: (widgetId: string) => PerseusWidget;
-    _isAnswerable(): boolean;
-    renderWidget: (impliedType: string, id: string, state: WidgetState) => null | React.ReactNode;
-    _getWidgetIndexById(id: string): number;
-    getWidgetProps(widgetId: string): WidgetProps<PerseusWidgetOptions, UserInput>;
-    /**
-     * Serializes the questions state so it can be recovered.
-     *
-     * If an instance of widgetProps is passed in, it generates the serialized
-     * state from that instead of the current widget props.
-     */
-    /**
-     * @deprecated - do not use in new code.
-     */
-    getSerializedState(): Record<string, any>;
-    /**
-     * Allows inter-widget communication.
-     *
-     * This function yields this Renderer's own internal widgets, and it's used
-     * in two places.
-     *
-     * First, we expose our own internal widgets to each other by giving them
-     * a `findWidgets` function that, in turn, calls this function.
-     *
-     * Second, we expose our own internal widgets to this Renderer's parent,
-     * by allowing it to call this function directly. That way, it can hook us
-     * up to other Renderers on the page, by writing a `findExternalWidgets`
-     * prop that calls each other Renderer's `findInternalWidgets` function.
-     *
-     * Takes a `filterCriterion` on which widgets to return.
-     * `filterCriterion` can be one of:
-     *  * A string widget id
-     *  * A string widget type
-     *  * a function from (id, widgetInfo, widgetComponent) to true or false
-     *
-     * Returns an array of the matching widget components.
-     *
-     * If you need to do logic with more than the components, it is possible
-     * to do such logic inside the filter, rather than on the result array.
-     *
-     * "Remember: abilities are not inherently good or evil, it's how you use
-     * them." ~ Kyle Katarn
-     * Please use this one with caution.
-     */
-    findInternalWidgets: (filterCriterion: FilterCriterion) => ReadonlyArray<Widget | null | undefined>;
-    /**
-     * Allows inter-widget communication.
-     *
-     * Includes both widgets internal to this Renderer, and external widgets
-     * exposed by the `findExternalWidgets` prop.
-     *
-     * See `findInternalWidgets` for more information.
-     */
-    findWidgets: (filterCriterion: FilterCriterion) => any;
-    getWidgetInstance: (id: string) => Widget | null | undefined;
-    _onWidgetFocus: (id: string, focusPath?: ReadonlyArray<string>) => void;
-    _onWidgetBlur: (id: string, blurPath: FocusPath) => void;
-    getContent: (props: Props, state: State) => any;
-    shouldRenderJiptPlaceholder: (props: Props, state: State) => boolean;
-    replaceJiptContent(content: string, paragraphIndex?: number): void;
-    outputMarkdown: (ast: ASTNode, state: WidgetState) => React.ReactNode;
-    outputNested: (ast: ASTNode, state: WidgetState) => React.ReactNode;
-    outputNode: (node: SingleASTNode, nestedOutput: (ast: SingleASTNode, state: WidgetState) => React.ReactNode, state: WidgetState) => React.ReactNode;
-    handleRender: (prevProps: Props) => void;
-    _setCurrentFocus: (path: FocusPath) => void;
-    focus: () => boolean | null | undefined;
-    getDOMNodeForPath: (path: FocusPath) => Element | Text | null | undefined;
-    getInputPaths: () => ReadonlyArray<FocusPath>;
-    focusPath: (path: FocusPath) => void;
-    blurPath: (path: FocusPath) => void;
-    blur: () => void;
-    /**
-     * Returns an array of widget ids that are empty (meaning widgets where the
-     * learner has not interacted with the widget yet or has not filled in all
-     * fields).  For example, the `interactive-graph` widget is considered
-     * empty if the graph is in the starting state.
-     */
-    emptyWidgets(): ReadonlyArray<string>;
-    /**
-     * Returns an object of the widget `.getUserInput()` results
-     */
-    getUserInputMap(): UserInputMap;
-    /**
-     * Returns an array of all widget IDs in the order they occur in
-     * the content.
-     */
-    getWidgetIds: () => ReadonlyArray<string>;
-    /**
-     * Returns a JSON representation of the content and widgets
-     * that can be passed to an LLM for prompt context.
-     */
-    getPromptJSON(): RendererPromptJSON;
-    /**
-     * Scores the content.
-     *
-     * @deprecated use scorePerseusItem
-     */
-    score(): PerseusScore;
-    handletranslationLintErrors: (lintErrors: ReadonlyArray<string>) => void;
-    render(): React.ReactNode;
-}
-export default Renderer;

package/dist/renderer.old.d.ts

@@ -1,210 +0,0 @@
-/***********************************************************************
- *                                                                     *
- * WARNING!!!! THERE ARE ACTIVE CHANGES HAPPENING IN THE RENDERER!     *
- *                                                                     *
- ***********************************************************************/
-import * as React from "react";
-import { PerseusI18nContext } from "./components/i18n-context";
-import InteractionTracker from "./interaction-tracker";
-import TranslationLinter from "./translation-linter";
-import WidgetContainer from "./widget-container.old";
-import type { DependenciesContext } from "./dependencies";
-import type { PerseusStrings } from "./strings";
-import type { APIOptions, APIOptionsWithDefaults, FilterCriterion, FindWidgetsFunction, FocusPath, Widget, WidgetProps } from "./types";
-import type { HandleUserInputCallback, InitializeUserInputCallback } from "./user-input-manager";
-import type { GetPromptJSONInterface, RendererPromptJSON } from "./widget-ai-utils/prompt-types";
-import type { KeypadAPI } from "@khanacademy/math-input";
-import type { PerseusRenderer, PerseusScore, PerseusWidget, PerseusWidgetOptions, PerseusWidgetsMap, ShowSolutions, UserInput, UserInputMap } from "@khanacademy/perseus-core";
-import type { LinterContextProps } from "@khanacademy/perseus-linter";
-import type { ASTNode, SingleASTNode } from "@khanacademy/simple-markdown";
-import "./styles/perseus-renderer.css";
-type WidgetState = {
-    isMobile?: boolean;
-    inTable?: boolean;
-    key?: number;
-    paragraphIndex?: number;
-    foundFullWidth?: boolean;
-    baseElements?: any;
-};
-export type Props = Partial<React.ContextType<typeof DependenciesContext>> & {
-    content: PerseusRenderer["content"];
-    widgets: PerseusRenderer["widgets"];
-    images: PerseusRenderer["images"];
-    apiOptions?: APIOptions;
-    userInput?: UserInputMap;
-    handleUserInput?: HandleUserInputCallback;
-    initializeUserInput?: InitializeUserInputCallback;
-    alwaysUpdate?: boolean;
-    findExternalWidgets: FindWidgetsFunction;
-    keypadElement?: KeypadAPI | null;
-    onRender: (node?: any) => void;
-    problemNum?: number;
-    reviewMode?: boolean | null | undefined;
-    /**
-     * Meant to differentiate between "scorable" contexts (exercises, GradedGroup)
-     * and non-"scorable" contexts (articles, hints)
-     */
-    isScorable?: boolean;
-    /**
-     * If set to "all", all rationales or solutions will be shown. If set to
-     * "selected", soltions will only be shown for selected choices. If set to
-     * "none", solutions will not be shown-- equivalent to `undefined`.
-     */
-    showSolutions?: ShowSolutions;
-    /**
-     * If linterContext.highlightLint is true, then content will be passed to
-     * the linter and any warnings will be highlighted in the rendered output.
-     */
-    linterContext: LinterContextProps;
-    legacyPerseusLint?: ReadonlyArray<string>;
-    /**
-     *  Skip adding paragraph class
-     */
-    inline?: boolean;
-    strings: PerseusStrings;
-};
-type State = {
-    translationLintErrors: ReadonlyArray<string>;
-    widgetInfo: Readonly<PerseusWidgetsMap>;
-    jiptContent: string | null;
-};
-type DefaultProps = Required<Pick<Props, "alwaysUpdate" | "content" | "findExternalWidgets" | "images" | "linterContext" | "onRender" | "showSolutions" | "reviewMode" | "isScorable" | "widgets">>;
-/**
- * We want to be able to reset the question state when we go
- * from one question to another question. However it's kind of tricky:
- * 1. Content could be the same
- * 2. Problem number could be the same
- * 3. We don't want to reset when going from answerless to answerful data
- * So compare the prev props to the next props, but use
- * answerless for both for the comparison
- */
-export type DifferentQuestionPartialProps = Pick<Props, "content" | "widgets" | "problemNum">;
-export declare function isDifferentQuestion(propsA: DifferentQuestionPartialProps, propsB: DifferentQuestionPartialProps): boolean;
-declare class Renderer extends React.Component<Props, State> implements GetPromptJSONInterface {
-    static contextType: React.Context<import("./components/i18n-context").I18nContextType>;
-    context: React.ContextType<typeof PerseusI18nContext>;
-    _currentFocus: FocusPath | null | undefined;
-    _foundTextNodes: boolean;
-    _interactionTrackers: {
-        [id: string]: InteractionTracker<any>;
-    };
-    _isMounted: boolean;
-    _isTwoColumn: boolean;
-    _translationLinter: TranslationLinter;
-    _widgetContainers: Map<string, WidgetContainer>;
-    translationIndex: number;
-    widgetIds: Array<string>;
-    static defaultProps: DefaultProps;
-    constructor(props: Props);
-    componentDidMount(): void;
-    UNSAFE_componentWillReceiveProps(nextProps: Props): void;
-    shouldComponentUpdate(nextProps: Props, nextState: State): any | boolean;
-    componentDidUpdate(prevProps: Props, prevState: State): void;
-    componentWillUnmount(): void;
-    getApiOptions: () => APIOptionsWithDefaults;
-    _getInitialWidgetState: (props: Props) => {
-        widgetInfo: State["widgetInfo"];
-    };
-    _getDefaultWidgetInfo: (widgetId: string) => any;
-    _getWidgetInfo: (widgetId: string) => PerseusWidget;
-    _isAnswerable(): boolean;
-    renderWidget: (impliedType: string, id: string, state: WidgetState) => null | React.ReactNode;
-    _getWidgetIndexById(id: string): number;
-    getWidgetProps(widgetId: string): WidgetProps<PerseusWidgetOptions, UserInput>;
-    /**
-     * Serializes the questions state so it can be recovered.
-     *
-     * If an instance of widgetProps is passed in, it generates the serialized
-     * state from that instead of the current widget props.
-     */
-    /**
-     * @deprecated - do not use in new code.
-     */
-    getSerializedState(): Record<string, any>;
-    /**
-     * Allows inter-widget communication.
-     *
-     * This function yields this Renderer's own internal widgets, and it's used
-     * in two places.
-     *
-     * First, we expose our own internal widgets to each other by giving them
-     * a `findWidgets` function that, in turn, calls this function.
-     *
-     * Second, we expose our own internal widgets to this Renderer's parent,
-     * by allowing it to call this function directly. That way, it can hook us
-     * up to other Renderers on the page, by writing a `findExternalWidgets`
-     * prop that calls each other Renderer's `findInternalWidgets` function.
-     *
-     * Takes a `filterCriterion` on which widgets to return.
-     * `filterCriterion` can be one of:
-     *  * A string widget id
-     *  * A string widget type
-     *  * a function from (id, widgetInfo, widgetComponent) to true or false
-     *
-     * Returns an array of the matching widget components.
-     *
-     * If you need to do logic with more than the components, it is possible
-     * to do such logic inside the filter, rather than on the result array.
-     *
-     * "Remember: abilities are not inherently good or evil, it's how you use
-     * them." ~ Kyle Katarn
-     * Please use this one with caution.
-     */
-    findInternalWidgets: (filterCriterion: FilterCriterion) => ReadonlyArray<Widget | null | undefined>;
-    /**
-     * Allows inter-widget communication.
-     *
-     * Includes both widgets internal to this Renderer, and external widgets
-     * exposed by the `findExternalWidgets` prop.
-     *
-     * See `findInternalWidgets` for more information.
-     */
-    findWidgets: (filterCriterion: FilterCriterion) => any;
-    getWidgetInstance: (id: string) => Widget | null | undefined;
-    _onWidgetFocus: (id: string, focusPath?: ReadonlyArray<string>) => void;
-    _onWidgetBlur: (id: string, blurPath: FocusPath) => void;
-    getContent: (props: Props, state: State) => any;
-    shouldRenderJiptPlaceholder: (props: Props, state: State) => boolean;
-    replaceJiptContent(content: string, paragraphIndex?: number): void;
-    outputMarkdown: (ast: ASTNode, state: WidgetState) => React.ReactNode;
-    outputNested: (ast: ASTNode, state: WidgetState) => React.ReactNode;
-    outputNode: (node: SingleASTNode, nestedOutput: (ast: SingleASTNode, state: WidgetState) => React.ReactNode, state: WidgetState) => React.ReactNode;
-    handleRender: (prevProps: Props) => void;
-    _setCurrentFocus: (path: FocusPath) => void;
-    focus: () => boolean | null | undefined;
-    getDOMNodeForPath: (path: FocusPath) => Element | Text | null | undefined;
-    getInputPaths: () => ReadonlyArray<FocusPath>;
-    focusPath: (path: FocusPath) => void;
-    blurPath: (path: FocusPath) => void;
-    blur: () => void;
-    /**
-     * Returns an array of widget ids that are empty (meaning widgets where the
-     * learner has not interacted with the widget yet or has not filled in all
-     * fields).  For example, the `interactive-graph` widget is considered
-     * empty if the graph is in the starting state.
-     */
-    emptyWidgets(): ReadonlyArray<string>;
-    /**
-     * Returns an object of the widget `.getUserInput()` results
-     */
-    getUserInputMap(): UserInputMap;
-    /**
-     * Returns an array of all widget IDs in the order they occur in
-     * the content.
-     */
-    getWidgetIds: () => ReadonlyArray<string>;
-    /**
-     * Returns a JSON representation of the content and widgets
-     * that can be passed to an LLM for prompt context.
-     */
-    getPromptJSON(): RendererPromptJSON;
-    /**
-     * Scores the content.
-     *
-     * @deprecated use scorePerseusItem
-     */
-    score(): PerseusScore;
-    handletranslationLintErrors: (lintErrors: ReadonlyArray<string>) => void;
-    render(): React.ReactNode;
-}
-export default Renderer;

package/dist/widget-container.old.d.ts

@@ -1,24 +0,0 @@
-/***********************************************************************
- *                                                                     *
- * WARNING!!!! THERE ARE ACTIVE CHANGES HAPPENING IN THE RENDERER!     *
- *                                                                     *
- ***********************************************************************/
-import * as React from "react";
-import type { WidgetProps } from "./types";
-type Props = {
-    type: string;
-    id: string;
-    widgetProps: WidgetProps<any, any>;
-};
-type State = {
-    sizeClass: "small" | "medium" | "large" | "xlarge";
-};
-declare class WidgetContainerOld extends React.Component<Props, State> {
-    widgetRef: React.RefObject<React.ComponentType<any>>;
-    state: State;
-    componentDidMount(): void;
-    UNSAFE_componentWillReceiveProps(nextProps: Props): void;
-    getWidget: () => any;
-    render(): React.ReactNode;
-}
-export default WidgetContainerOld;