@khanacademy/perseus-score 2.0.0 → 2.1.0

package/dist/score.d.ts

@@ -0,0 +1,21 @@
+import type { PerseusScore, UserInputMap } from "./validation.types";
+import type { PerseusRenderer, PerseusWidgetsMap } from "@khanacademy/perseus-core";
+/**
+ * If a widget says that it is empty once it is graded.
+ * Trying to encapsulate references to the score format.
+ */
+export declare function scoreIsEmpty(score: PerseusScore): boolean;
+/**
+ * Combine two score objects.
+ *
+ * Given two score objects for two different widgets, combine them so that
+ * if one is wrong, the total score is wrong, etc.
+ */
+export declare function combineScores(scoreA: PerseusScore, scoreB: PerseusScore): PerseusScore;
+export declare function flattenScores(widgetScoreMap: {
+    [widgetId: string]: PerseusScore;
+}): PerseusScore;
+export declare function scorePerseusItem(perseusRenderData: PerseusRenderer, userInputMap: UserInputMap, locale: string): PerseusScore;
+export declare function scoreWidgetsFunctional(widgets: PerseusWidgetsMap, widgetIds: ReadonlyArray<string>, userInputMap: UserInputMap, locale: string): {
+    [widgetId: string]: PerseusScore;
+};

package/dist/util/score-noop.d.ts

@@ -0,0 +1,11 @@
+import type { PerseusScore } from "../validation.types";
+/**
+ * Several widgets don't have "right"/"wrong" scoring logic,
+ * so this just says to move on past those widgets
+ *
+ * TODO(LEMS-2543) widgets that use this probably shouldn't have any
+ * scoring logic and the thing scoring an exercise
+ * should just know to skip these
+ */
+declare function scoreNoop(points?: number): PerseusScore;
+export default scoreNoop;

package/dist/util/test-helpers.d.ts

@@ -0,0 +1,14 @@
+import type { DropdownWidget, ExpressionWidget } from "@khanacademy/perseus-core";
+export declare function getTestDropdownWidget(): DropdownWidget;
+export declare function getExpressionWidget(): ExpressionWidget;
+export declare function getLegacyExpressionWidget(): {
+    type: string;
+    options: {
+        times: boolean;
+        buttonSets: string[];
+        functions: never[];
+        form: boolean;
+        simplify: boolean;
+        value: string;
+    };
+};

package/dist/validate.d.ts

@@ -0,0 +1,7 @@
+import type { UserInputMap, ValidationDataMap } from "./validation.types";
+/**
+ * Checks the given user input to see if any answerable widgets have not been
+ * "filled in" (ie. if they're empty). Another way to think about this
+ * function is that its a check to see if we can score the provided input.
+ */
+export declare function emptyWidgetsFunctional(widgets: ValidationDataMap, widgetIds: ReadonlyArray<string>, userInputMap: UserInputMap, locale: string): ReadonlyArray<string>;

package/dist/validation.types.d.ts

@@ -29,6 +29,8 @@
  * ```
  */
 import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType, MakeWidgetMap, Relationship } from "@khanacademy/perseus-core";
+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;

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

@@ -0,0 +1,3 @@
+import type { PerseusGroupRubric, PerseusGroupUserInput, PerseusScore } from "../../validation.types";
+declare function scoreGroup(userInput: PerseusGroupUserInput, rubric: PerseusGroupRubric, locale: string): PerseusScore;
+export default scoreGroup;

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

@@ -0,0 +1,3 @@
+import type { PerseusGroupUserInput, PerseusGroupValidationData, ValidationResult } from "../../validation.types";
+declare function validateGroup(userInput: PerseusGroupUserInput, validationData: PerseusGroupValidationData, locale: string): ValidationResult;
+export default validateGroup;

package/dist/widgets/mock-widget/mock-widget-validation.types.d.ts

@@ -0,0 +1,6 @@
+export type PerseusMockWidgetRubric = {
+    value: string;
+};
+export type PerseusMockWidgetUserInput = {
+    currentValue: string;
+};

package/dist/widgets/mock-widget/score-mock-widget.d.ts

@@ -0,0 +1,4 @@
+import type { PerseusMockWidgetRubric, PerseusMockWidgetUserInput } from "./mock-widget-validation.types";
+import type { PerseusScore } from "../../validation.types";
+declare function scoreMockWidget(userInput: PerseusMockWidgetUserInput, rubric: PerseusMockWidgetRubric): PerseusScore;
+export default scoreMockWidget;

package/dist/widgets/mock-widget/validate-mock-widget.d.ts

@@ -0,0 +1,4 @@
+import type { PerseusMockWidgetUserInput } from "./mock-widget-validation.types";
+import type { ValidationResult } from "../../validation.types";
+declare function validateMockWidget(userInput: PerseusMockWidgetUserInput): ValidationResult;
+export default validateMockWidget;

package/dist/widgets/widget-registry.d.ts

@@ -0,0 +1,4 @@
+import type { WidgetScorerFunction, WidgetValidatorFunction } from "../validation.types";
+export declare function registerWidget(type: string, scorer: WidgetScorerFunction, validator?: WidgetValidatorFunction): void;
+export declare const getWidgetValidator: (name: string) => WidgetValidatorFunction | null;
+export declare const getWidgetScorer: (name: string) => WidgetScorerFunction | null;

package/package.json

@@ -3,7 +3,7 @@
     "description": "Perseus score",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "2.0.0",
+    "version": "2.1.0",
     "publishConfig": {
         "access": "public"
     },
@@ -26,9 +26,9 @@
         "test": "bash -c 'yarn --silent --cwd \"../..\" test ${@:0} $($([[ ${@: -1} = -* ]] || [[ ${@: -1} = bash ]]) && echo $PWD)'"
     },
     "dependencies": {
-        "@khanacademy/kas": "^0.4.12",
-        "@khanacademy/kmath": "^0.3.1",
-        "@khanacademy/perseus-core": "3.3.0"
+        "@khanacademy/kas": "^0.4.13",
+        "@khanacademy/kmath": "^0.3.2",
+        "@khanacademy/perseus-core": "3.4.0"
     },
     "devDependencies": {},
     "peerDependencies": {},