@khanacademy/perseus-core 7.0.2 → 7.1.0

package/dist/parse-perseus-json/perseus-parsers/dropdown-user-input.d.ts

@@ -0,0 +1,3 @@
+export declare const parseDropdownUserInput: import("../parser-types").Parser<{
+    value: number;
+}>;

package/dist/parse-perseus-json/perseus-parsers/dropdown-user-input.typetest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/parse-perseus-json/perseus-parsers/expression-user-input.d.ts

@@ -0,0 +1 @@
+export declare const parseExpressionUserInput: import("../parser-types").Parser<string>;

package/dist/parse-perseus-json/perseus-parsers/expression-user-input.typetest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/parse-perseus-json/perseus-parsers/interactive-graph-user-input.d.ts

@@ -0,0 +1 @@
+export declare const parseInteractiveGraphUserInput: import("../parser-types").Parser<import("../..").PerseusGraphTypeAngle | import("../..").PerseusGraphTypeCircle | import("../..").PerseusGraphTypeLinear | import("../..").PerseusGraphTypeLinearSystem | import("../..").PerseusGraphTypeNone | import("../..").PerseusGraphTypePoint | import("../..").PerseusGraphTypePolygon | import("../..").PerseusGraphTypeQuadratic | import("../..").PerseusGraphTypeRay | import("../..").PerseusGraphTypeSegment | import("../..").PerseusGraphTypeSinusoid>;

package/dist/parse-perseus-json/perseus-parsers/interactive-graph-user-input.typetest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/parse-perseus-json/perseus-parsers/interactive-graph-widget.d.ts

@@ -1,4 +1,5 @@
-import type { InteractiveGraphWidget } from "../../data-schema";
+import type { InteractiveGraphWidget, PerseusGraphTypeAngle, PerseusGraphTypeCircle, PerseusGraphTypeLinear, PerseusGraphTypeLinearSystem, PerseusGraphTypeNone, PerseusGraphTypePoint, PerseusGraphTypePolygon, PerseusGraphTypeQuadratic, PerseusGraphTypeRay, PerseusGraphTypeSegment, PerseusGraphTypeSinusoid } from "../../data-schema";
 import type { Parser } from "../parser-types";
+export declare const parsePerseusGraphType: Parser<PerseusGraphTypeAngle | PerseusGraphTypeCircle | PerseusGraphTypeLinear | PerseusGraphTypeLinearSystem | PerseusGraphTypeNone | PerseusGraphTypePoint | PerseusGraphTypePolygon | PerseusGraphTypeQuadratic | PerseusGraphTypeRay | PerseusGraphTypeSegment | PerseusGraphTypeSinusoid>;
 export declare const parseLockedFunctionDomain: Parser<[number, number]>;
 export declare const parseInteractiveGraphWidget: Parser<InteractiveGraphWidget>;

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

@@ -0,0 +1,3 @@
+export declare const parseNumericInputUserInput: import("../parser-types").Parser<{
+    currentValue: string;
+}>;

package/dist/parse-perseus-json/perseus-parsers/numeric-input-user-input.typetest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/parse-perseus-json/perseus-parsers/radio-user-input.d.ts

@@ -0,0 +1,3 @@
+export declare const parseRadioUserInput: import("../parser-types").Parser<{
+    choicesSelected: boolean[];
+}>;

package/dist/parse-perseus-json/perseus-parsers/radio-user-input.typetest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/validation.types.d.ts

@@ -0,0 +1,282 @@
+/**
+ * This file contains types used for validation and scoring. The types abide by
+ * a naming convention so that they're easy to follow and that we remain
+ * consistent across all of the widgets.
+ *
+ * These types are:
+ *
+ *   * `Perseus<Widget>UserInput`: the data from the widget that represents the
+ *     data the user entered. This is referred to as the 'guess' in some older
+ *     parts of Perseus.
+ *
+ *   * `Perseus<Widget>ValidationData`: the data needed to do validation of the
+ *     user input. Validation refers to the different checks that we can do
+ *     both on the client-side (before submitting user input for scoring) and
+ *     on the server-side (when we score it). As such, it cannot contain any of
+ *     the sensitive scoring data that would reveal the answer.
+ *
+ *   * `Perseus<Widget>Rubric` (nee `Perseus<Widget>Rubric`): the data
+ *     needed to score the user input. By convention, this type is defined as
+ *     the set of sensitive answer data and then intersected with
+ *     `Perseus<Widget>ValidationData`.
+ *
+ * For example:
+ * ```
+ * type Perseus<Widget>Rubric = {
+ *     correct: string;  // Used _only_ for scoring
+ *     size: number;     // Used _only_ for scoring
+ * } & Perseus<Widget>ValidationData;
+ * ```
+ */
+import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType, MakeWidgetMap } from "./data-schema";
+import type { Relationship } from "./types";
+export type WidgetValidatorFunction = (userInput: UserInput, validationData: ValidationData, locale: string) => ValidationResult;
+export type WidgetScorerFunction = (userInput: UserInput, rubric: Rubric, locale?: string) => PerseusScore;
+export type PerseusScore = {
+    type: "invalid";
+    message?: string | null | undefined;
+    suppressAlmostThere?: boolean | null | undefined;
+} | {
+    type: "points";
+    earned: number;
+    total: number;
+    message?: string | null | undefined;
+};
+export type ValidationResult = Extract<PerseusScore, {
+    type: "invalid";
+}> | null;
+export type UserInputStatus = "correct" | "incorrect" | "incomplete";
+export type PerseusCategorizerRubric = {
+    values: ReadonlyArray<number>;
+} & PerseusCategorizerValidationData;
+export type PerseusCategorizerUserInput = {
+    values: PerseusCategorizerRubric["values"];
+};
+export type PerseusCategorizerValidationData = {
+    items: ReadonlyArray<string>;
+};
+export type PerseusCSProgramUserInput = {
+    status: UserInputStatus;
+    message: string | null;
+};
+export type PerseusDropdownRubric = {
+    choices: ReadonlyArray<PerseusDropdownChoice>;
+};
+export type PerseusDropdownUserInput = {
+    value: number;
+};
+export type PerseusExpressionRubric = {
+    answerForms: ReadonlyArray<PerseusExpressionAnswerForm>;
+    functions: ReadonlyArray<string>;
+};
+export type PerseusExpressionUserInput = string;
+export type PerseusGroupRubric = PerseusGroupWidgetOptions;
+export type PerseusGroupValidationData = {
+    widgets: ValidationDataMap;
+};
+export type PerseusGroupUserInput = UserInputMap;
+export type PerseusGradedGroupRubric = PerseusGradedGroupWidgetOptions;
+export type PerseusGradedGroupSetRubric = PerseusGradedGroupSetWidgetOptions;
+export type PerseusGrapherRubric = {
+    correct: GrapherAnswerTypes;
+};
+export type PerseusGrapherUserInput = PerseusGrapherRubric["correct"];
+export type PerseusIFrameUserInput = {
+    status: UserInputStatus;
+    message: string | null;
+};
+export type PerseusInputNumberRubric = {
+    answerType?: "number" | "decimal" | "integer" | "rational" | "improper" | "mixed" | "percent" | "pi";
+    inexact?: boolean;
+    maxError?: number | string;
+    simplify: "required" | "optional" | "enforced";
+    value: string | number;
+};
+export type PerseusInputNumberUserInput = {
+    currentValue: string;
+};
+export type PerseusInteractiveGraphRubric = {
+    correct: PerseusGraphCorrectType;
+    graph: PerseusGraphType;
+};
+export type PerseusInteractiveGraphUserInput = PerseusGraphType;
+export type PerseusLabelImageRubric = {
+    markers: ReadonlyArray<{
+        answers: ReadonlyArray<string>;
+        label: string;
+    }>;
+};
+export type PerseusLabelImageUserInput = {
+    markers: ReadonlyArray<{
+        selected?: ReadonlyArray<string>;
+        label: string;
+    }>;
+};
+export type PerseusMatcherRubric = {
+    left: ReadonlyArray<string>;
+    right: ReadonlyArray<string>;
+};
+export type PerseusMatcherUserInput = {
+    left: ReadonlyArray<string>;
+    right: ReadonlyArray<string>;
+};
+export type PerseusMatrixRubric = {
+    answers: PerseusMatrixWidgetAnswers;
+} & PerseusMatrixValidationData;
+export type PerseusMatrixValidationData = Empty;
+export type PerseusMatrixUserInput = {
+    answers: PerseusMatrixRubric["answers"];
+};
+export type PerseusNumberLineRubric = {
+    correctRel: string | null | undefined;
+    correctX: number;
+    range: ReadonlyArray<number>;
+    initialX: number | null | undefined;
+    isInequality: boolean;
+};
+export type PerseusNumberLineUserInput = {
+    isTickCrtl?: boolean;
+    numLinePosition: number;
+    rel: Relationship | "eq";
+    numDivisions: number;
+    divisionRange: ReadonlyArray<number>;
+};
+export type PerseusNumericInputRubric = {
+    answers: ReadonlyArray<PerseusNumericInputAnswer>;
+    coefficient: boolean;
+};
+export type PerseusNumericInputUserInput = {
+    currentValue: string;
+};
+export type PerseusOrdererRubric = PerseusOrdererWidgetOptions;
+export type PerseusOrdererUserInput = {
+    current: ReadonlyArray<string>;
+};
+export type PerseusPlotterRubric = {
+    correct: ReadonlyArray<number>;
+} & PerseusPlotterValidationData;
+export type PerseusPlotterValidationData = {
+    starting: ReadonlyArray<number>;
+};
+export type PerseusPlotterUserInput = ReadonlyArray<number>;
+export type PerseusRadioRubric = {
+    choices: ReadonlyArray<PerseusRadioChoice>;
+};
+export type PerseusRadioUserInput = {
+    choicesSelected: ReadonlyArray<boolean>;
+};
+export type PerseusSorterRubric = {
+    correct: ReadonlyArray<string>;
+};
+export type PerseusSorterUserInput = {
+    options: ReadonlyArray<string>;
+    changed: boolean;
+};
+export type PerseusTableRubric = {
+    answers: ReadonlyArray<ReadonlyArray<string>>;
+};
+export type PerseusTableUserInput = ReadonlyArray<ReadonlyArray<string>>;
+export interface RubricRegistry {
+    categorizer: PerseusCategorizerRubric;
+    dropdown: PerseusDropdownRubric;
+    expression: PerseusExpressionRubric;
+    "graded-group-set": PerseusGradedGroupSetRubric;
+    "graded-group": PerseusGradedGroupRubric;
+    grapher: PerseusGrapherRubric;
+    group: PerseusGroupRubric;
+    image: PerseusLabelImageRubric;
+    "input-number": PerseusInputNumberRubric;
+    "interactive-graph": PerseusInteractiveGraphRubric;
+    "label-image": PerseusLabelImageRubric;
+    matcher: PerseusMatcherRubric;
+    matrix: PerseusMatrixRubric;
+    "number-line": PerseusNumberLineRubric;
+    "numeric-input": PerseusNumericInputRubric;
+    orderer: PerseusOrdererRubric;
+    plotter: PerseusPlotterRubric;
+    radio: PerseusRadioRubric;
+    sorter: PerseusSorterRubric;
+    table: PerseusTableRubric;
+}
+/**
+ * A map of scoring data (previously referred to as "rubric"), keyed by
+ * `widgetId`. This data is used to score a learner's guess for a PerseusItem.
+ *
+ * NOTE:  The value in this map is intentionally a subset of WidgetOptions<T>.
+ * By using the same shape (minus any unneeded render data), we are able to
+ * share functionality that understands how to traverse maps of `widget id` to
+ * `options`.
+ */
+export type RubricMap = {
+    [Property in keyof RubricRegistry as `${Property} ${number}`]: {
+        type: Property;
+        static?: boolean;
+        options: RubricRegistry[Property];
+    };
+};
+export type Rubric = RubricRegistry[keyof RubricRegistry];
+/**
+ * This is an interface so that it can be extended if a widget is created
+ * outside of this Perseus package. See `PerseusWidgetTypes` for a full
+ * explanation.
+ */
+interface UserInputRegistry {
+    categorizer: PerseusCategorizerUserInput;
+    "cs-program": PerseusCSProgramUserInput;
+    dropdown: PerseusDropdownUserInput;
+    expression: PerseusExpressionUserInput;
+    grapher: PerseusGrapherUserInput;
+    group: PerseusGroupUserInput;
+    iframe: PerseusIFrameUserInput;
+    "input-number": PerseusInputNumberUserInput;
+    "interactive-graph": PerseusInteractiveGraphUserInput;
+    "label-image": PerseusLabelImageUserInput;
+    matcher: PerseusMatcherUserInput;
+    matrix: PerseusMatrixUserInput;
+    "number-line": PerseusNumberLineUserInput;
+    "numeric-input": PerseusNumericInputUserInput;
+    orderer: PerseusOrdererUserInput;
+    plotter: PerseusPlotterUserInput;
+    radio: PerseusRadioUserInput;
+    sorter: PerseusSorterUserInput;
+    table: PerseusTableUserInput;
+}
+/** A union type of all the widget user input types */
+export type UserInput = UserInputRegistry[keyof UserInputRegistry];
+/**
+ * A map of widget IDs to user input types (strongly typed based on the format
+ * of the widget ID).
+ */
+export type UserInputMap = MakeWidgetMap<UserInputRegistry>;
+/**
+ * deprecated prefer using UserInputMap
+ */
+export type UserInputArray = ReadonlyArray<UserInputArray | UserInput | null | undefined>;
+export interface ValidationDataTypes {
+    categorizer: PerseusCategorizerValidationData;
+    group: PerseusGroupValidationData;
+    plotter: PerseusPlotterValidationData;
+}
+/**
+ * A map of validation data, keyed by `widgetId`. This data is used to check if
+ * a question is answerable. This data represents the minimal intersection of
+ * data that's available in the client (widget options) and server (scoring
+ * data) and is represented by a group of types known as "validation data".
+ *
+ * NOTE: The value in this map is intentionally a subset of WidgetOptions<T>.
+ * By using the same shape (minus any unneeded data), we are able to pass a
+ * `PerseusWidgetsMap` or ` into any function that accepts a
+ * `ValidationDataMap` without any mutation of data.
+ */
+export type ValidationDataMap = {
+    [Property in keyof ValidationDataTypes as `${Property} ${number}`]: {
+        type: Property;
+        static?: boolean;
+        options: ValidationDataTypes[Property];
+    };
+};
+/**
+ * A union type of all the different widget validation data types that exist.
+ */
+export type ValidationData = ValidationDataTypes[keyof ValidationDataTypes];
+export {};

package/dist/validation.typetest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/widgets/categorizer/categorizer-util.d.ts

@@ -3,7 +3,7 @@ import type { PerseusCategorizerWidgetOptions } from "../../data-schema";
  * For details on the individual options, see the
  * PerseusCategorizerWidgetOptions type
  */
-type CategorizerPublicWidgetOptions = {
+export type CategorizerPublicWidgetOptions = {
     items: PerseusCategorizerWidgetOptions["items"];
     categories: PerseusCategorizerWidgetOptions["categories"];
     randomizeItems: PerseusCategorizerWidgetOptions["randomizeItems"];

package/package.json

@@ -3,7 +3,7 @@
   "description": "Shared Perseus infrastructure",
   "author": "Khan Academy",
   "license": "MIT",
-  "version": "7.0.2",
+  "version": "7.1.0",
   "publishConfig": {
     "access": "public"
   },