Move main Scorer and Validator to PerseusScore

.changeset/wise-owls-wait.md

@@ -0,0 +1,9 @@
+---
+"@khanacademy/perseus": major
+"@khanacademy/perseus-core": minor
+"@khanacademy/perseus-score": minor
+"@khanacademy/perseus-dev-ui": patch
+"@khanacademy/perseus-editor": patch
+---
+
+Move scorePerseusItem logic to PerseusScore

dev/flipbook.tsx

@@ -18,10 +18,10 @@ import {useEffect, useMemo, useReducer, useRef, useState} from "react";
 
 import {Renderer} from "../packages/perseus/src";
 import {SvgImage} from "../packages/perseus/src/components";
-import {scorePerseusItem} from "../packages/perseus/src/renderer-util";
 import {mockStrings} from "../packages/perseus/src/strings";
 import {isCorrect} from "../packages/perseus/src/util/scoring";
 import {trueForAllMafsSupportedGraphTypes} from "../packages/perseus/src/widgets/interactive-graphs/mafs-supported-graph-types";
+import {scorePerseusItem} from "../packages/perseus-score/src";
 
 import {EditableControlledInput} from "./editable-controlled-input";
 import {
@@ -324,7 +324,6 @@ function GradableRenderer(props: QuestionRendererProps) {
                                 const score = scorePerseusItem(
                                     question,
                                     rendererRef.current.getUserInputMap(),
-                                    mockStrings,
                                     "en",
                                 );
                                 setScore(score);

packages/perseus-core/src/index.ts

@@ -6,6 +6,7 @@ export type {
     MarkerType,
     InteractiveMarkerType,
     Relationship,
+    Alignment,
 } from "./types";
 export type {ErrorKind} from "./error/errors";
 export type {FunctionTypeMappingKeys} from "./utils/grapher-util";
@@ -112,8 +113,15 @@ export type {TableDefaultWidgetOptions} from "./widgets/table";
 export {default as videoLogic} from "./widgets/video";
 export type {VideoDefaultWidgetOptions} from "./widgets/video";
 
+export {
+    getUpgradedWidgetOptions,
+    upgradeWidgetInfoToLatestVersion,
+} from "./widgets/upgrade";
+
 export type * from "./widgets/logic-export.types";
 
+export * as CoreWidgetRegistry from "./widgets/core-widget-registry";
+
 export {default as getOrdererPublicWidgetOptions} from "./widgets/orderer/orderer-util";
 export {default as getCategorizerPublicWidgetOptions} from "./widgets/categorizer/categorizer-util";
 export {default as getCSProgramPublicWidgetOptions} from "./widgets/cs-program/cs-program-util";

packages/perseus-core/src/types.ts

@@ -51,3 +51,12 @@ export type InteractiveMarkerType = MarkerType & {
 // Used for NumberLine
 // TODO: can this be merged with PerseusNumberLineWidgetOptions.correctRel?
 export type Relationship = "lt" | "gt" | "le" | "ge";
+
+export type Alignment =
+    | "default"
+    | "block"
+    | "inline-block"
+    | "inline"
+    | "float-left"
+    | "float-right"
+    | "full-width";

packages/perseus-core/src/widgets/core-widget-registry.ts

@@ -0,0 +1,135 @@
+import categorizerWidgetLogic from "./categorizer";
+import csProgramWidgetLogic from "./cs-program";
+import definitionWidgetLogic from "./definition";
+import dropdownWidgetLogic from "./dropdown";
+import explanationWidgetLogic from "./explanation";
+import expressionWidgetLogic from "./expression";
+import gradedGroupWidgetLogic from "./graded-group";
+import gradedGroupSetWidgetLogic from "./graded-group-set";
+import grapherWidgetLogic from "./grapher";
+import groupWidgetLogic from "./group";
+import iframeWidgetLogic from "./iframe";
+import imageWidgetLogic from "./image";
+import inputNumberWidgetLogic from "./input-number";
+import interactionWidgetLogic from "./interaction";
+import interactiveGraphWidgetLogic from "./interactive-graph";
+import labelImageWidgetLogic from "./label-image";
+import matcherWidgetLogic from "./matcher";
+import matrixWidgetLogic from "./matrix";
+import measurerWidgetLogic from "./measurer";
+import numberLineWidgetLogic from "./number-line";
+import numericInputWidgetLogic from "./numeric-input";
+import ordererWidgetLogic from "./orderer";
+import passageWidgetLogic from "./passage";
+import passageRefWidgetLogic from "./passage-ref";
+import passageRefTargetWidgetLogic from "./passage-ref-target";
+import phetSimulationWidgetLogic from "./phet-simulation";
+import plotterWidgetLogic from "./plotter";
+import pythonProgramWidgetLogic from "./python-program";
+import radioWidgetLogic from "./radio";
+import sorterWidgetLogic from "./sorter";
+import tableWidgetLogic from "./table";
+import videoWidgetLogic from "./video";
+
+import type {WidgetLogic} from "./logic-export.types";
+import type {Alignment} from "../types";
+
+const widgets = {};
+
+function registerWidget(type: string, logic: WidgetLogic) {
+    widgets[type] = logic;
+}
+
+export function isWidgetRegistered(type: string) {
+    const widgetLogic = widgets[type];
+    return !!widgetLogic;
+}
+
+export function getCurrentVersion(type: string) {
+    const widgetLogic = widgets[type];
+    return widgetLogic?.version || {major: 0, minor: 0};
+}
+
+export function getWidgetOptionsUpgrades(type: string) {
+    const widgetLogic = widgets[type];
+    return widgetLogic?.widgetOptionsUpgrades || {};
+}
+
+export function getDefaultWidgetOptions(type: string) {
+    const widgetLogic = widgets[type];
+    return widgetLogic?.defaultWidgetOptions || {};
+}
+
+/**
+ * Handling for the optional alignments for widgets
+ * See widget-container.jsx for details on how alignments are implemented.
+ */
+
+/**
+ * Returns the list of supported alignments for the given (string) widget
+ * type. This is used primarily at editing time to display the choices
+ * for the user.
+ *
+ * Supported alignments are given as an array of strings in the exports of
+ * a widget's module.
+ */
+export const getSupportedAlignments = (
+    type: string,
+): ReadonlyArray<Alignment> => {
+    const widgetLogic = widgets[type];
+    if (!widgetLogic?.supportedAlignments?.[0]) {
+        // default alignments
+        return ["default"];
+    }
+    return widgetLogic?.supportedAlignments;
+};
+
+/**
+ * For the given (string) widget type, determine the default alignment for
+ * the widget. This is used at rendering time to go from "default" alignment
+ * to the actual alignment displayed on the screen.
+ *
+ * The default alignment is given either as a string (called
+ * `defaultAlignment`) or a function (called `getDefaultAlignment`) on
+ * the exports of a widget's module.
+ */
+export const getDefaultAlignment = (type: string): Alignment => {
+    const widgetLogic = widgets[type];
+    if (!widgetLogic?.defaultAlignment) {
+        return "block";
+    }
+    return widgetLogic.defaultAlignment;
+};
+
+registerWidget("categorizer", categorizerWidgetLogic);
+registerWidget("cs-program", csProgramWidgetLogic);
+registerWidget("definition", definitionWidgetLogic);
+registerWidget("dropdown", dropdownWidgetLogic);
+registerWidget("explanation", explanationWidgetLogic);
+registerWidget("expression", expressionWidgetLogic);
+registerWidget("graded-group", gradedGroupWidgetLogic);
+registerWidget("graded-group-set", gradedGroupSetWidgetLogic);
+registerWidget("grapher", grapherWidgetLogic);
+registerWidget("group", groupWidgetLogic);
+registerWidget("iframe", iframeWidgetLogic);
+registerWidget("image", imageWidgetLogic);
+registerWidget("input-number", inputNumberWidgetLogic);
+registerWidget("interaction", interactionWidgetLogic);
+registerWidget("interactive-graph", interactiveGraphWidgetLogic);
+registerWidget("label-image", labelImageWidgetLogic);
+registerWidget("matcher", matcherWidgetLogic);
+registerWidget("matrix", matrixWidgetLogic);
+registerWidget("measurer", measurerWidgetLogic);
+registerWidget("number-line", numberLineWidgetLogic);
+registerWidget("numeric-input", numericInputWidgetLogic);
+registerWidget("orderer", ordererWidgetLogic);
+registerWidget("passage", passageWidgetLogic);
+registerWidget("passage-ref", passageRefWidgetLogic);
+registerWidget("passage-ref-target", passageRefTargetWidgetLogic);
+registerWidget("phet-simulation", phetSimulationWidgetLogic);
+registerWidget("plotter", plotterWidgetLogic);
+registerWidget("python-program", pythonProgramWidgetLogic);
+registerWidget("radio", radioWidgetLogic);
+registerWidget("sorter", sorterWidgetLogic);
+registerWidget("table", tableWidgetLogic);
+registerWidget("video", videoWidgetLogic);

packages/perseus-core/src/widgets/cs-program/index.ts

@@ -25,6 +25,7 @@ const defaultWidgetOptions: CSProgramDefaultWidgetOptions = {
 const csProgramWidgetLogic: WidgetLogic = {
     name: "cs-program",
     defaultWidgetOptions,
+    supportedAlignments: ["block", "full-width"],
 };
 
 export default csProgramWidgetLogic;

packages/perseus-core/src/widgets/definition/index.ts

@@ -14,6 +14,7 @@ const defaultWidgetOptions: DefinitionDefaultWidgetOptions = {
 const definitionWidgetLogic: WidgetLogic = {
     name: "definition",
     defaultWidgetOptions,
+    defaultAlignment: "inline",
 };
 
 export default definitionWidgetLogic;

packages/perseus-core/src/widgets/dropdown/index.ts

@@ -19,6 +19,7 @@ const defaultWidgetOptions: DropdownDefaultWidgetOptions = {
 const dropdownWidgetLogic: WidgetLogic = {
     name: "definition",
     defaultWidgetOptions,
+    defaultAlignment: "inline-block",
 };
 
 export default dropdownWidgetLogic;

packages/perseus-core/src/widgets/explanation/index.ts

@@ -16,6 +16,7 @@ const defaultWidgetOptions: ExplanationDefaultWidgetOptions = {
 const explanationWidgetLogic: WidgetLogic = {
     name: "explanation",
     defaultWidgetOptions,
+    defaultAlignment: "inline",
 };
 
 export default explanationWidgetLogic;

packages/perseus-core/src/widgets/expression/index.ts

@@ -13,6 +13,7 @@ const expressionWidgetLogic: WidgetLogic = {
     version: currentVersion,
     widgetOptionsUpgrades: widgetOptionsUpgrades,
     defaultWidgetOptions: defaultWidgetOptions,
+    defaultAlignment: "inline-block",
 };
 
 export default expressionWidgetLogic;

packages/perseus-core/src/widgets/graded-group-set/index.ts

@@ -10,9 +10,9 @@ const defaultWidgetOptions: GradedGroupSetDefaultWidgetOptions = {
     gradedGroups: [],
 };
 
-const GradedGroupSetWidgetLogic: WidgetLogic = {
+const gradedGroupSetWidgetLogic: WidgetLogic = {
     name: "graded-group-set",
     defaultWidgetOptions,
 };
 
-export default GradedGroupSetWidgetLogic;
+export default gradedGroupSetWidgetLogic;

packages/perseus-core/src/widgets/graded-group/index.ts

@@ -14,9 +14,9 @@ const defaultWidgetOptions: GradedGroupDefaultWidgetOptions = {
     hint: null,
 };
 
-const GradedGroupWidgetLogic: WidgetLogic = {
+const gradedGroupWidgetLogic: WidgetLogic = {
     name: "graded-group",
     defaultWidgetOptions,
 };
 
-export default GradedGroupWidgetLogic;
+export default gradedGroupWidgetLogic;

packages/perseus-core/src/widgets/group/index.ts

@@ -15,9 +15,9 @@ const defaultWidgetOptions: GroupDefaultWidgetOptions = {
     metadata: undefined,
 };
 
-const GroupWidgetLogic: WidgetLogic = {
+const groupWidgetLogic: WidgetLogic = {
     name: "group",
     defaultWidgetOptions,
 };
 
-export default GroupWidgetLogic;
+export default groupWidgetLogic;

packages/perseus-core/src/widgets/image/index.ts

@@ -26,6 +26,8 @@ const defaultWidgetOptions: ImageDefaultWidgetOptions = {
 const imageWidgetLogic: WidgetLogic = {
     name: "image",
     defaultWidgetOptions,
+    supportedAlignments: ["block", "full-width"],
+    defaultAlignment: "block",
 };
 
 export default imageWidgetLogic;

packages/perseus-core/src/widgets/input-number/index.ts

@@ -25,6 +25,7 @@ const defaultWidgetOptions: InputNumberDefaultWidgetOptions = {
 const inputNumberWidgetLogic: WidgetLogic = {
     name: "input-number",
     defaultWidgetOptions,
+    defaultAlignment: "inline-block",
 };
 
 export default inputNumberWidgetLogic;

packages/perseus-core/src/widgets/logic-export.types.ts

@@ -1,4 +1,5 @@
 import type {Version} from "../data-schema";
+import type {Alignment} from "../types";
 
 export type WidgetOptionsUpgradeMap = {
     // OldProps => NewProps,
@@ -10,4 +11,6 @@ export type WidgetLogic = {
     version?: Version;
     widgetOptionsUpgrades?: WidgetOptionsUpgradeMap;
     defaultWidgetOptions?: any;
+    supportedAlignments?: ReadonlyArray<Alignment>;
+    defaultAlignment?: Alignment;
 };

packages/perseus-core/src/widgets/numeric-input/index.ts

@@ -27,6 +27,7 @@ const defaultWidgetOptions: NumericInputDefaultWidgetOptions = {
 const numericInputWidgetLogic: WidgetLogic = {
     name: "numeric-input",
     defaultWidgetOptions,
+    defaultAlignment: "inline-block",
 };
 
 export default numericInputWidgetLogic;

packages/perseus-core/src/widgets/passage-ref-target/index.ts

@@ -13,6 +13,7 @@ const defaultWidgetOptions: PassageRefTargetDefaultWidgetOptions = {
 const passageRefTargetWidgetLogic: WidgetLogic = {
     name: "passageRefTarget",
     defaultWidgetOptions,
+    defaultAlignment: "inline",
 };
 
 export default passageRefTargetWidgetLogic;

packages/perseus-core/src/widgets/passage-ref/index.ts

@@ -8,6 +8,7 @@ const passageRefWidgetLogic: WidgetLogic = {
     name: "passageRef",
     version: currentVersion,
     defaultWidgetOptions: defaultWidgetOptions,
+    defaultAlignment: "inline",
 };
 
 export default passageRefWidgetLogic;

packages/perseus-core/src/widgets/phet-simulation/index.ts

@@ -11,9 +11,9 @@ const defaultWidgetOptions: PhetSimulationDefaultWidgetOptions = {
     description: "",
 };
 
-const PhetSimulationWidgetLogic: WidgetLogic = {
+const phetSimulationWidgetLogic: WidgetLogic = {
     name: "phet-simulation",
     defaultWidgetOptions,
 };
 
-export default PhetSimulationWidgetLogic;
+export default phetSimulationWidgetLogic;