@khanacademy/perseus 41.3.0 → 41.5.0

package/dist/server-item-renderer.d.ts

@@ -62,7 +62,7 @@ export declare class ServerItemRenderer extends React.Component<Props, State> im
     _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"
+     * the form "answer-numeric-input 1", or the string "answer-area"
      * for the whole answer area (if the answer area is a single widget).
      */
     _setWidgetProps(widgetId: string, newProps: Props, callback: any): void;

package/dist/util/answer-types.d.ts

@@ -1,6 +1,6 @@
 import type { PerseusStrings } from "../strings";
 type Guess = any;
-type Predicate = any;
+type Predicate = (guess: number, maxError: number) => boolean;
 export type Score = {
     empty: boolean;
     correct: boolean;
@@ -9,13 +9,56 @@ export type Score = {
     guess: Guess;
     ungraded?: boolean;
 };
+/**
+ * Answer types
+ *
+ * Utility for creating answerable questions displayed in exercises
+ *
+ * Different answer types produce different kinds of input displays, and do
+ * different kinds of checking on the solutions.
+ *
+ * Each of the objects contain two functions, setup and createValidator.
+ *
+ * The setup function takes a solutionarea and solution, and performs setup
+ * within the solutionarea, and then returns an object which contains:
+ *
+ * answer: a function which, when called, will retrieve the current answer from
+ *         the solutionarea, which can then be validated using the validator
+ *         function
+ * validator: a function returned from the createValidator function (defined
+ *            below)
+ * solution: the correct answer to the problem
+ * showGuess: a function which, when given a guess, shows the guess within the
+ *            provided solutionarea
+ * showGuessCustom: a function which displays parts of a guess that are not
+ *                  within the solutionarea; currently only used for custom
+ *                  answers
+ *
+ * The createValidator function only takes a solution, and it returns a
+ * function which can be used to validate an answer.
+ *
+ * The resulting validator function returns:
+ * - true: if the answer is fully correct
+ * - false: if the answer is incorrect
+ * - "" (the empty string): if no answer has been provided (e.g. the answer box
+ *   is left unfilled)
+ * - a string: if there is some slight error
+ *
+ * In most cases, setup and createValidator don't really need the solution DOM
+ * element so we have setupFunctional and createValidatorFunctional for them
+ * which take only $solution.text() and $solution.data(). This makes it easier
+ * to reuse specific answer types.
+ *
+ * TODO(alpert): Think of a less-absurd name for createValidatorFunctional.
+ *
+ */
 declare const KhanAnswerTypes: {
     readonly predicate: {
         readonly defaultForms: "integer, proper, improper, mixed, decimal";
         readonly createValidatorFunctional: (predicate: Predicate, options: any, strings: PerseusStrings) => (arg1: Guess) => Score;
     };
     readonly number: {
-        readonly convertToPredicate: (correctAnswer: string, options: any) => Predicate;
+        readonly convertToPredicate: (correctAnswer: string, options: any) => [predicate: Predicate, options: any];
         readonly createValidatorFunctional: (correctAnswer: string, options: any, strings: PerseusStrings) => (arg1: Guess) => Score;
     };
     readonly expression: {

package/dist/util/parse-perseus-json/perseus-parsers/graded-group-set-widget.d.ts

@@ -0,0 +1,3 @@
+import type { GradedGroupSetWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseGradedGroupSetWidget: Parser<GradedGroupSetWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/graded-group-widget.d.ts

@@ -0,0 +1,16 @@
+import type { GradedGroupWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseGradedGroupWidgetOptions: Parser<{
+    title: string;
+    hasHint: boolean | null | undefined;
+    hint: import("../../../perseus-types").PerseusRenderer | null | undefined;
+    content: string;
+    widgets: import("../../../perseus-types").PerseusWidgetsMap;
+    widgetEnabled: boolean | null | undefined;
+    immutableWidgets: boolean | null | undefined;
+    images: Record<string, {
+        width: number;
+        height: number;
+    }>;
+}>;
+export declare const parseGradedGroupWidget: Parser<GradedGroupWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/grapher-widget.d.ts

@@ -0,0 +1,3 @@
+import type { GrapherWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseGrapherWidget: Parser<GrapherWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/group-widget.d.ts

@@ -0,0 +1,3 @@
+import type { GroupWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseGroupWidget: Parser<GroupWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/iframe-widget.d.ts

@@ -0,0 +1,3 @@
+import type { IFrameWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseIframeWidget: Parser<IFrameWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/image-widget.d.ts

@@ -0,0 +1,3 @@
+import type { ImageWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseImageWidget: Parser<ImageWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/input-number-widget.d.ts

@@ -0,0 +1,3 @@
+import type { InputNumberWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseInputNumberWidget: Parser<InputNumberWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/interaction-widget.d.ts

@@ -0,0 +1,3 @@
+import type { InteractionWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseInteractionWidget: Parser<InteractionWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/label-image-widget.d.ts

@@ -0,0 +1,3 @@
+import type { LabelImageWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseLabelImageWidget: Parser<LabelImageWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/matcher-widget.d.ts

@@ -0,0 +1,3 @@
+import type { MatcherWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseMatcherWidget: Parser<MatcherWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/matrix-widget.d.ts

@@ -0,0 +1,3 @@
+import type { MatrixWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseMatrixWidget: Parser<MatrixWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/measurer-widget.d.ts

@@ -0,0 +1,3 @@
+import type { MeasurerWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseMeasurerWidget: Parser<MeasurerWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/molecule-renderer-widget.d.ts

@@ -0,0 +1,3 @@
+import type { MoleculeRendererWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseMoleculeRendererWidget: Parser<MoleculeRendererWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/number-line-widget.d.ts

@@ -0,0 +1,3 @@
+import type { NumberLineWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseNumberLineWidget: Parser<NumberLineWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/numeric-input-widget.d.ts

@@ -0,0 +1,3 @@
+import type { NumericInputWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseNumericInputWidget: Parser<NumericInputWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/orderer-widget.d.ts

@@ -0,0 +1,3 @@
+import type { OrdererWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseOrdererWidget: Parser<OrdererWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/passage-ref-widget.d.ts

@@ -0,0 +1,3 @@
+import type { PassageRefWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parsePassageRefWidget: Parser<PassageRefWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/passage-widget.d.ts

@@ -0,0 +1,3 @@
+import type { PassageWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parsePassageWidget: Parser<PassageWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/phet-simulation-widget.d.ts

@@ -0,0 +1,3 @@
+import type { PhetSimulationWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parsePhetSimulationWidget: Parser<PhetSimulationWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/plotter-widget.d.ts

@@ -0,0 +1,3 @@
+import type { PlotterWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parsePlotterWidget: Parser<PlotterWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/python-program-widget.d.ts

@@ -0,0 +1,3 @@
+import type { PythonProgramWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parsePythonProgramWidget: Parser<PythonProgramWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/radio-widget.d.ts

@@ -0,0 +1,3 @@
+import type { RadioWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseRadioWidget: Parser<RadioWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/sorter-widget.d.ts

@@ -0,0 +1,3 @@
+import type { SorterWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseSorterWidget: Parser<SorterWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/table-widget.d.ts

@@ -0,0 +1,3 @@
+import type { TableWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseTableWidget: Parser<TableWidget>;

package/dist/util/parse-perseus-json/perseus-parsers/video-widget.d.ts

@@ -0,0 +1,3 @@
+import type { VideoWidget } from "../../../perseus-types";
+import type { Parser } from "../parser-types";
+export declare const parseVideoWidget: Parser<VideoWidget>;

package/dist/validation.types.d.ts

@@ -1,4 +1,4 @@
-import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatcherWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumberLineWidgetOptions, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusPlotterWidgetOptions, PerseusRadioChoice, PerseusTableWidgetOptions, PerseusGraphCorrectType } from "./perseus-types";
+import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatcherWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumberLineWidgetOptions, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusPlotterWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType } from "./perseus-types";
 import type { InteractiveMarkerType } from "./widgets/label-image/types";
 import type { Relationship } from "./widgets/number-line/number-line";
 export type UserInputStatus = "correct" | "incorrect" | "incomplete";
@@ -102,7 +102,9 @@ export type PerseusSorterUserInput = {
     options: ReadonlyArray<string>;
     changed: boolean;
 };
-export type PerseusTableRubric = PerseusTableWidgetOptions;
+export type PerseusTableRubric = {
+    answers: ReadonlyArray<ReadonlyArray<string>>;
+};
 export type PerseusTableUserInput = ReadonlyArray<ReadonlyArray<string>>;
 export type Rubric = PerseusCategorizerRubric | PerseusCSProgramRubric | PerseusDropdownRubric | PerseusExpressionRubric | PerseusGroupRubric | PerseusGradedGroupRubric | PerseusGradedGroupSetRubric | PerseusGrapherRubric | PerseusIFrameRubric | PerseusInputNumberRubric | PerseusInteractiveGraphRubric | PerseusLabelImageRubric | PerseusMatcherRubric | PerseusMatrixRubric | PerseusNumberLineRubric | PerseusNumericInputRubric | PerseusOrdererRubric | PerseusPlotterRubric | PerseusRadioRubric | PerseusSorterRubric | PerseusTableRubric;
 export type UserInput = PerseusCategorizerUserInput | PerseusCSProgramUserInput | PerseusDropdownUserInput | PerseusExpressionUserInput | PerseusGrapherUserInput | PerseusIFrameUserInput | PerseusInputNumberUserInput | PerseusInteractiveGraphUserInput | PerseusLabelImageUserInput | PerseusMatcherUserInput | PerseusMatrixUserInput | PerseusNumberLineUserInput | PerseusNumericInputUserInput | PerseusOrdererUserInput | PerseusPlotterUserInput | PerseusRadioUserInput | PerseusSorterUserInput | PerseusTableUserInput;

package/dist/widgets/numeric-input/numeric-input.d.ts

@@ -74,7 +74,14 @@ declare const _default: {
     defaultAlignment: "inline-block";
     accessible: true;
     widget: typeof NumericInput;
+    version: {
+        major: number;
+        minor: number;
+    };
     transform: (widgetOptions: PerseusNumericInputWidgetOptions) => RenderProps;
+    propUpgrades: {
+        readonly "1": (initialProps: any) => PerseusNumericInputWidgetOptions;
+    };
     isLintable: true;
     scorer: typeof scoreNumericInput;
     getOneCorrectAnswerFromRubric(rubric: PerseusNumericInputRubric): string | null | undefined;

package/dist/widgets/table/score-table.d.ts

@@ -1,5 +1,5 @@
 import type { PerseusStrings } from "../../strings";
 import type { PerseusScore } from "../../types";
 import type { PerseusTableRubric, PerseusTableUserInput } from "../../validation.types";
-declare function scoreTable(state: PerseusTableUserInput, rubric: PerseusTableRubric, strings: PerseusStrings): PerseusScore;
+declare function scoreTable(userInput: PerseusTableUserInput, rubric: PerseusTableRubric, strings: PerseusStrings): PerseusScore;
 export default scoreTable;

package/dist/widgets/table/utils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Filters the given table (modelled as a 2D array) to remove any rows that are
+ * completely empty.
+ *
+ * @returns A new table with only non-empty rows.
+ */
+export declare const filterNonEmpty: (table: ReadonlyArray<ReadonlyArray<string>>) => (readonly string[])[];

package/dist/widgets/table/validate-table.d.ts

@@ -0,0 +1,6 @@
+import type { PerseusScore } from "../../types";
+import type { PerseusTableUserInput } from "../../validation.types";
+declare function validateTable(userInput: PerseusTableUserInput): Extract<PerseusScore, {
+    type: "invalid";
+}> | null;
+export default validateTable;

package/package.json

@@ -3,7 +3,7 @@
     "description": "Core Perseus API (includes renderers and widgets)",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "41.3.0",
+    "version": "41.5.0",
     "publishConfig": {
         "access": "public"
     },
@@ -40,7 +40,7 @@
         "test": "bash -c 'yarn --silent --cwd \"../..\" test ${@:0} $($([[ ${@: -1} = -* ]] || [[ ${@: -1} = bash ]]) && echo $PWD)'"
     },
     "dependencies": {
-        "@khanacademy/kas": "^0.3.16",
+        "@khanacademy/kas": "^0.4.0",
         "@khanacademy/keypad-context": "^1.0.4",
         "@khanacademy/kmath": "^0.1.16",
         "@khanacademy/math-input": "^21.1.4",