Move enum logic from Webapp to Perseus

[handeyeco]

Summary:

In this PR I added some logic in Webapp knowing I would need to move it to Perseus; now that I'm trying to add the CEDAR event to Mobile, the time has come.

---

I didn't get any ideas on how to implement the below and I need to move on, so I'm going to move forward with the original plan.

I'm wondering if this could be done in a cleaner way. In each widget we have an export; for example this is Radio's:

export default {
    name: "radio", // <- type: string
    displayName: "Radio / Multiple choice",
    accessible: true,
    widget: Radio,
    transform: transform,
    staticTransform: transform,
    version: {major: 1, minor: 0},
    propUpgrades: propUpgrades,
    isLintable: true,
} as WidgetExports<typeof Radio>;

We also do something like this in perseus-types.ts:

export type RadioWidget = Widget<'radio', PerseusRadioWidgetOptions>;

type Widget<Type extends string, Options> = {
    // The "type" of widget which will define what the Options field looks like
    type: Type;

    // ...etc...
};

Then:

export type PerseusWidgetsMap = {
    // ...etc...
} & {
    [key in `radio ${number}`]: RadioWidget;
} & {
    // ...etc...

It feels like we're having to maintain a lot of places where there are lists of widgets; now this would add even more. Is there a way to derive this type information from the widgets themselves? For instance:

// in each widget file
export default {
    name: "radio",
    enum: "RADIO",
    // ...etc...
} as WidgetExports<typeof Radio>;

// in a shared file
const perseusWidgets = [
    RadioWidget,
    LightPuzzleWidget,
    // ...etc...
]

// Could theses be derived types?
const PerseusWidgetNames = perseusWidgets.map(w => w.name) as const;
const PerseusWidgetEnums = perseusWidgets.map(w => w.enum) as const;

That way the widgets themselves are responsible for providing their own name and enum values? And we have one master list of widgets that is used to derive other lists?

Issue: MOB-5441

[github-actions]

Size Change: +863 B (0%)

Total Size: 811 kB

Filename	Size	Change
packages/math-input/dist/es/index.js	80.4 kB	+155 B (0%)
packages/perseus-editor/dist/es/index.js	262 kB	-175 B (0%)
packages/perseus/dist/es/index.js	386 kB	+883 B (0%)

ℹ️ View Unchanged

Filename	Size
packages/kas/dist/es/index.js	38.1 kB
packages/kmath/dist/es/index.js	4.27 kB
packages/perseus-core/dist/es/index.js	908 B
packages/perseus-error/dist/es/index.js	878 B
packages/perseus-linter/dist/es/index.js	21.8 kB
packages/pure-markdown/dist/es/index.js	3.68 kB
packages/simple-markdown/dist/es/index.js	12.4 kB

_{compressed-size-action}

[codecov]

Codecov Report

Attention: Patch coverage is 85.98726% with 22 lines in your changes are missing coverage. Please review.

Project coverage is 67.25%. Comparing base (547eb28) to head (0a98447).
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1058      +/-   ##
==========================================
+ Coverage   65.12%   67.25%   +2.12%     
==========================================
  Files         432      436       +4     
  Lines       96215    96445     +230     
  Branches     6544    10110    +3566     
==========================================
+ Hits        62664    64867    +2203     
+ Misses      33551    31578    -1973     

Files	Coverage Δ
packages/perseus/src/index.ts	100.00% <100.00%> (ø)
packages/perseus/src/util/widget-enum-utils.ts	85.62% <85.62%> (ø)

... and 108 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 547eb28...0a98447. Read the comment docs.

[nedredmond]

Are these reversed?

[handeyeco]

Oh that's weird. That's copy/pasted from prod webapp which means it's live on the site. 🤔 Not that I think we care all that much about graded-group statistics (compared to more interactive widgets).

[khan-actions-bot]

Gerald

Required Reviewers

• @Khan/perseus for changes to .changeset/silver-humans-sell.md, packages/perseus/src/index.ts, packages/perseus/src/util/widget-enum-utils.ts

---

Don't want to be involved in this pull request? Comment #removeme and we won't notify you of further changes.

[github-actions]

npm Snapshot: Published

Good news!! We've packaged up the latest commit from this PR (0a98447) and published it to npm. You
can install it using the tag PR1058.

Example:

yarn add @khanacademy/perseus@PR1058

If you are working in Khan Academy's webapp, you can run:

./dev/tools/bump_perseus_version.sh -t PR1058

[SonicScrewdriver]

Oh lovely this can replace that function in the coach report utils! :)

[SonicScrewdriver]

Wonderful, thank you!