Move Perseus JSON parsers to perseus-core (#2155)

## Summary:
These parsers will need to run in a NodeJS service for server-side
scoring. The server needs to be able to import them without also pulling
in JSX.

Moving them to perseus-core means we can't validate
dynamically-registered widgets as strictly, but that seems like a small
sacrifice given that a) dynamic widgets are not currently used in
production, and b) the validation we can do on them would not be
particularly strict in any case.

Issue: LEMS-2774

Test plan:

`yarn test`

Author: benchristel

Reviewers: handeyeco, jeremywiebe, benchristel

Required Reviewers:

Approved By: handeyeco, jeremywiebe

Checks: ✅ Publish npm snapshot (ubuntu-latest, 20.x), ✅ Check for .changeset entries for all changed files (ubuntu-latest, 20.x), ✅ Cypress (ubuntu-latest, 20.x), ✅ Lint, Typecheck, Format, and Test (ubuntu-latest, 20.x), ✅ Publish Storybook to Chromatic (ubuntu-latest, 20.x), ✅ Check builds for changes in size (ubuntu-latest, 20.x)

Pull Request URL: #2155

Author: benchristel

.changeset/forty-eels-play.md

@@ -24,6 +24,20 @@ export {
 export {default as deepClone} from "./utils/deep-clone";
 export * as GrapherUtil from "./utils/grapher-util";
 
+export {
+    parsePerseusItem,
+    parseAndMigratePerseusItem,
+    parseAndMigratePerseusArticle,
+} from "./parse-perseus-json";
+
+export {
+    isSuccess,
+    isFailure,
+    type Result,
+    type Success,
+    type Failure,
+} from "./parse-perseus-json/result";
+
 export {libVersion} from "./version";
 
 export {Errors} from "./error/errors";

packages/perseus-core/src/index.ts

@@ -1,12 +1,12 @@
-import {isRealJSONParse} from "../is-real-json-parse";
+import {isRealJSONParse} from "../utils/is-real-json-parse";
 
 import {parse} from "./parse";
 import {parsePerseusArticle as migrateAndTypecheckPerseusArticle} from "./perseus-parsers/perseus-article";
 import {parsePerseusItem as migrateAndTypecheckPerseusItem} from "./perseus-parsers/perseus-item";
 import {failure, isFailure} from "./result";
 
 import type {Result} from "./result";
-import type {PerseusItem, PerseusArticle} from "@khanacademy/perseus-core";
+import type {PerseusItem, PerseusArticle} from "../data-schema";
 
 /**
  * Helper to parse PerseusItem JSON

packages/perseus/src/util/parse-perseus-json/README.md renamed to packages/perseus-core/src/parse-perseus-json/README.md

@@ -2,7 +2,10 @@ import {jest} from "@jest/globals";
 
 import {assertFailure, assertSuccess, success} from "./result";
 
-import {parseAndMigratePerseusItem, parseAndMigratePerseusArticle} from ".";
+import {
+    parseAndMigratePerseusItem,
+    parseAndMigratePerseusArticle,
+} from "./index";
 
 describe("parseAndMigratePerseusItem", () => {
     it("should parse JSON", () => {

packages/perseus/src/util/parse-perseus-json/error-tracking-parse-context.test.ts renamed to packages/perseus-core/src/parse-perseus-json/error-tracking-parse-context.test.ts

@@ -11,8 +11,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 
 import {parseWidget} from "./widget";
 
+import type {CategorizerWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {CategorizerWidget} from "@khanacademy/perseus-core";
 
 export const parseCategorizerWidget: Parser<CategorizerWidget> = parseWidget(
     constant("categorizer"),

packages/perseus/src/util/parse-perseus-json/error-tracking-parse-context.ts renamed to packages/perseus-core/src/parse-perseus-json/error-tracking-parse-context.ts

@@ -11,8 +11,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 
 import {parseWidget} from "./widget";
 
+import type {CSProgramWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {CSProgramWidget} from "@khanacademy/perseus-core";
 
 export const parseCSProgramWidget: Parser<CSProgramWidget> = parseWidget(
     constant("cs-program"),

packages/perseus/src/util/parse-perseus-json/exhaustive-test-tool/index.ts renamed to packages/perseus-core/src/parse-perseus-json/exhaustive-test-tool/index.ts

@@ -3,8 +3,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 
 import {parseWidget} from "./widget";
 
+import type {DefinitionWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {DefinitionWidget} from "@khanacademy/perseus-core";
 
 export const parseDefinitionWidget: Parser<DefinitionWidget> = parseWidget(
     constant("definition"),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/any.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/any.ts

@@ -10,8 +10,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 
 import {parseWidget} from "./widget";
 
+import type {DropdownWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {DropdownWidget} from "@khanacademy/perseus-core";
 
 export const parseDropdownWidget: Parser<DropdownWidget> = parseWidget(
     constant("dropdown"),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/array.test.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/array.test.ts

@@ -4,8 +4,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 import {parseWidget} from "./widget";
 import {parseWidgetsMap} from "./widgets-map";
 
+import type {ExplanationWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {ExplanationWidget} from "@khanacademy/perseus-core";
 
 export const parseExplanationWidget: Parser<ExplanationWidget> = parseWidget(
     constant("explanation"),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/array.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/array.ts

@@ -16,11 +16,11 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 import {versionedWidgetOptions} from "./versioned-widget-options";
 import {parseWidgetWithVersion} from "./widget";
 
-import type {ParsedValue, Parser} from "../parser-types";
 import type {
     ExpressionWidget,
     PerseusExpressionAnswerForm,
-} from "@khanacademy/perseus-core";
+} from "../../data-schema";
+import type {ParsedValue, Parser} from "../parser-types";
 
 const stringOrNumberOrNullOrUndefined = union(string)
     .or(number)

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/array.typetest.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/array.typetest.ts

@@ -3,8 +3,8 @@ import {array, constant, object} from "../general-purpose-parsers";
 import {parseGradedGroupWidgetOptions} from "./graded-group-widget";
 import {parseWidget} from "./widget";
 
+import type {GradedGroupSetWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {GradedGroupSetWidget} from "@khanacademy/perseus-core";
 
 export const parseGradedGroupSetWidget: Parser<GradedGroupSetWidget> =
     parseWidget(

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/boolean.test.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/boolean.test.ts

@@ -17,8 +17,8 @@ import {parsePerseusRenderer} from "./perseus-renderer";
 import {parseWidget} from "./widget";
 import {parseWidgetsMap} from "./widgets-map";
 
+import type {GradedGroupWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {GradedGroupWidget} from "@khanacademy/perseus-core";
 
 const falseToNull = pipeParsers(constant(false)).then(
     convert(() => null),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/boolean.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/boolean.ts

@@ -15,8 +15,8 @@ import {discriminatedUnionOn} from "../general-purpose-parsers/discriminated-uni
 
 import {parseWidget} from "./widget";
 
+import type {GrapherWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {GrapherWidget} from "@khanacademy/perseus-core";
 
 const pairOfNumbers = pair(number, number);
 

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/constant.test.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/constant.test.ts

@@ -3,8 +3,8 @@ import {constant} from "../general-purpose-parsers";
 import {parsePerseusRenderer} from "./perseus-renderer";
 import {parseWidget} from "./widget";
 
+import type {GroupWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {GroupWidget} from "@khanacademy/perseus-core";
 
 export const parseGroupWidget: Parser<GroupWidget> = parseWidget(
     constant("group"),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/constant.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/constant.ts

@@ -10,8 +10,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 import {parseImages} from "./images-map";
 import {parseWidgetsMap} from "./widgets-map";
 
+import type {Hint} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {Hint} from "@khanacademy/perseus-core";
 
 export const parseHint: Parser<Hint> = object({
     replace: optional(boolean),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/convert.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/convert.ts

@@ -12,8 +12,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 
 import {parseWidget} from "./widget";
 
+import type {IFrameWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {IFrameWidget} from "@khanacademy/perseus-core";
 
 export const parseIframeWidget: Parser<IFrameWidget> = parseWidget(
     constant("iframe"),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/defaulted.test.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/defaulted.test.ts

@@ -12,8 +12,8 @@ import {
 import {parsePerseusImageBackground} from "./perseus-image-background";
 import {parseWidget} from "./widget";
 
+import type {ImageWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {ImageWidget} from "@khanacademy/perseus-core";
 
 const pairOfNumbers = pair(number, number);
 

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/defaulted.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/defaulted.ts

@@ -1,8 +1,8 @@
 import {number, object, record, string} from "../general-purpose-parsers";
 import {defaulted} from "../general-purpose-parsers/defaulted";
 
+import type {PerseusImageDetail} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {PerseusImageDetail} from "@khanacademy/perseus-core";
 
 export const parseImages: Parser<{[key: string]: PerseusImageDetail}> =
     defaulted(

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/discriminated-union.test.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/discriminated-union.test.ts

@@ -11,8 +11,8 @@ import {
 
 import {parseWidget} from "./widget";
 
+import type {InputNumberWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {InputNumberWidget} from "@khanacademy/perseus-core";
 
 const booleanToString: Parser<string> = (rawValue, ctx) => {
     if (typeof rawValue === "boolean") {

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/discriminated-union.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/discriminated-union.ts

@@ -18,11 +18,11 @@ import {discriminatedUnionOn} from "../general-purpose-parsers/discriminated-uni
 import {parsePerseusImageBackground} from "./perseus-image-background";
 import {parseWidget} from "./widget";
 
-import type {Parser} from "../parser-types";
 import type {
     InteractionWidget,
     PerseusInteractionElement,
-} from "@khanacademy/perseus-core";
+} from "../../data-schema";
+import type {Parser} from "../parser-types";
 
 const pairOfNumbers = pair(number, number);
 const stringOrEmpty = defaulted(string, () => "");

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/discriminated-union.typetest.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/discriminated-union.typetest.ts

@@ -1,5 +1,4 @@
-import {lockedFigureColorNames} from "@khanacademy/perseus-core";
-
+import {lockedFigureColorNames} from "../../data-schema";
 import {
     array,
     boolean,
@@ -20,7 +19,6 @@ import {discriminatedUnionOn} from "../general-purpose-parsers/discriminated-uni
 import {parsePerseusImageBackground} from "./perseus-image-background";
 import {parseWidget} from "./widget";
 
-import type {Parser} from "../parser-types";
 import type {
     InteractiveGraphWidget,
     LockedEllipseType,
@@ -46,7 +44,8 @@ import type {
     PerseusGraphTypeRay,
     PerseusGraphTypeSegment,
     PerseusGraphTypeSinusoid,
-} from "@khanacademy/perseus-core";
+} from "../../data-schema";
+import type {Parser} from "../parser-types";
 
 // Used to represent 2-D points and ranges
 const pairOfNumbers = pair(number, number);

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/enumeration.test.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/enumeration.test.ts

@@ -10,8 +10,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 
 import {parseWidget} from "./widget";
 
+import type {LabelImageWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {LabelImageWidget} from "@khanacademy/perseus-core";
 
 export const parseLabelImageWidget: Parser<LabelImageWidget> = parseWidget(
     constant("label-image"),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/enumeration.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/enumeration.ts

@@ -8,8 +8,8 @@ import {
 
 import {parseWidget} from "./widget";
 
+import type {MatcherWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {MatcherWidget} from "@khanacademy/perseus-core";
 
 export const parseMatcherWidget: Parser<MatcherWidget> = parseWidget(
     constant("matcher"),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/enumeration.typetest.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/enumeration.typetest.ts

@@ -14,8 +14,8 @@ import {stringToNumber} from "../general-purpose-parsers/string-to-number";
 
 import {parseWidget} from "./widget";
 
+import type {MatrixWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {MatrixWidget} from "@khanacademy/perseus-core";
 
 const numberOrString = union(number).or(string).parser;
 const numeric = pipeParsers(defaulted(numberOrString, () => NaN)).then(

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/index.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/index.ts

@@ -11,8 +11,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 import {parsePerseusImageBackground} from "./perseus-image-background";
 import {parseWidget} from "./widget";
 
+import type {MeasurerWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {MeasurerWidget} from "@khanacademy/perseus-core";
 
 export const parseMeasurerWidget: Parser<MeasurerWidget> = parseWidget(
     constant("measurer"),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/is-object.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/is-object.ts

@@ -8,8 +8,8 @@ import {
 
 import {parseWidget} from "./widget";
 
+import type {MoleculeRendererWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {MoleculeRendererWidget} from "@khanacademy/perseus-core";
 
 export const parseMoleculeRendererWidget: Parser<MoleculeRendererWidget> =
     parseWidget(

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/nullable.test.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/nullable.test.ts

@@ -15,8 +15,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 
 import {parseWidget} from "./widget";
 
+import type {NumberLineWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {NumberLineWidget} from "@khanacademy/perseus-core";
 
 const emptyStringToNull = pipeParsers(constant("")).then(
     convert(() => null),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/nullable.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/nullable.ts

@@ -16,8 +16,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 
 import {parseWidget} from "./widget";
 
+import type {NumericInputWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {NumericInputWidget} from "@khanacademy/perseus-core";
 
 const parseMathFormat = enumeration(
     "integer",

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/number.test.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/number.test.ts

@@ -10,8 +10,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 import {parsePerseusRenderer} from "./perseus-renderer";
 import {parseWidget} from "./widget";
 
+import type {OrdererWidget} from "../../data-schema";
 import type {Parser, PartialParser} from "../parser-types";
-import type {OrdererWidget} from "@khanacademy/perseus-core";
 
 // There is an import cycle between orderer-widget.ts and perseus-renderer.ts.
 // This wrapper ensures that we don't refer to parsePerseusRenderer before

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/number.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/number.ts

@@ -8,8 +8,8 @@ import {
 
 import {parseWidget} from "./widget";
 
+import type {PassageRefWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {PassageRefWidget} from "@khanacademy/perseus-core";
 
 export const parsePassageRefWidget: Parser<PassageRefWidget> = parseWidget(
     constant("passage-ref"),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/object.test.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/object.test.ts

@@ -3,8 +3,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 
 import {parseWidget} from "./widget";
 
+import type {PassageWidget} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {PassageWidget} from "@khanacademy/perseus-core";
 
 export const parsePassageWidget: Parser<PassageWidget> = parseWidget(
     constant("passage"),

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/object.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/object.ts

@@ -2,8 +2,8 @@ import {array, union} from "../general-purpose-parsers";
 
 import {parsePerseusRenderer} from "./perseus-renderer";
 
+import type {PerseusArticle} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {PerseusArticle} from "@khanacademy/perseus-core";
 
 export const parsePerseusArticle: Parser<PerseusArticle> = union(
     parsePerseusRenderer,

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/optional.test.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/optional.test.ts

@@ -10,8 +10,8 @@ import {
 import {convert} from "../general-purpose-parsers/convert";
 import {stringToNumber} from "../general-purpose-parsers/string-to-number";
 
+import type {PerseusImageBackground} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {PerseusImageBackground} from "@khanacademy/perseus-core";
 
 function emptyToZero(x: string | number): string | number {
     return x === "" ? 0 : x;

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/optional.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/optional.ts

@@ -1,5 +1,4 @@
-import {ItemExtras} from "@khanacademy/perseus-core";
-
+import {ItemExtras} from "../../data-schema";
 import {
     any,
     array,
@@ -16,8 +15,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 import {parseHint} from "./hint";
 import {parsePerseusRenderer} from "./perseus-renderer";
 
+import type {PerseusItem} from "../../data-schema";
 import type {ParseContext, Parser, ParseResult} from "../parser-types";
-import type {PerseusItem} from "@khanacademy/perseus-core";
 
 export const parsePerseusItem: Parser<PerseusItem> = object({
     question: parsePerseusRenderer,

packages/perseus/src/util/parse-perseus-json/general-purpose-parsers/pair.test.ts renamed to packages/perseus-core/src/parse-perseus-json/general-purpose-parsers/pair.test.ts

@@ -4,8 +4,8 @@ import {defaulted} from "../general-purpose-parsers/defaulted";
 import {parseImages} from "./images-map";
 import {parseWidgetsMap} from "./widgets-map";
 
+import type {PerseusRenderer} from "../../data-schema";
 import type {Parser} from "../parser-types";
-import type {PerseusRenderer} from "@khanacademy/perseus-core";
 
 export const parsePerseusRenderer: Parser<PerseusRenderer> = defaulted(
     object({