Create helper to build public widget options for Matcher

.changeset/tricky-hairs-grin.md

@@ -0,0 +1,6 @@
+---
+"@khanacademy/perseus": minor
+"@khanacademy/perseus-core": minor
+---
+
+Implement a widget export function to filter out rubric data from widget options for the Matcher widget

packages/perseus-core/src/index.ts

@@ -94,3 +94,4 @@ export type * from "./widgets/logic-export.types";
 export {default as getOrdererPublicWidgetOptions} from "./widgets/orderer/orderer-util";
 export {default as getCategorizerPublicWidgetOptions} from "./widgets/categorizer/categorizer-util";
 export {default as getExpressionPublicWidgetOptions} from "./widgets/expression/expression-util";
+export {default as getMatcherPublicWidgetOptions} from "./widgets/matcher/matcher-util";

packages/perseus-core/src/widgets/matcher/matcher-util.test.ts

@@ -0,0 +1,52 @@
+import getMatcherPublicWidgetOptions from "./matcher-util";
+
+import type {PerseusMatcherWidgetOptions} from "../../data-schema";
+
+describe("getMatcherPublicWidgetOptions", () => {
+    it("should return left and right arrays with sorted items to remove correct order information", () => {
+        // Arrange
+        const options: PerseusMatcherWidgetOptions = {
+            labels: ["**Claims**", "**Evidence**"],
+            padding: true,
+            orderMatters: false,
+            right: [
+                "Medium-sized stars typically exist for roughly 10 billion years",
+                "The current trajectory of the Earth\u2019s tectonic plate movement",
+                "The life cycle of medium-sized stars includes a red giant stage and ends in a whimper as a white dwarf",
+                "Rapid escalation of greenhouse gas emissions",
+                "The current trajectory of the Milky Way galaxy and those in its immediate proximity",
+            ],
+            left: [
+                "Our Sun will run out of fuel and die in around 5 billion years ",
+                "Plate tectonics will rearrange the continents: the Pacific will narrow, bringing Australia closer to the Americas, and the Atlantic will expand to form the largest of the oceans ",
+                "Our Sun will run out of hydrogen, swell into a red giant, gobble up the inner rocky planets, and then collapse and die ",
+                "Average global temperatures will rise ",
+                "In 3 to 4 billion years, our galaxy will begin a slow collision with its closest large neighbor, Andromeda ",
+            ],
+        };
+
+        // Act
+        const publicWidgetOptions = getMatcherPublicWidgetOptions(options);
+
+        // Assert
+        expect(publicWidgetOptions).toEqual({
+            labels: ["**Claims**", "**Evidence**"],
+            padding: true,
+            orderMatters: false,
+            right: [
+                "Medium-sized stars typically exist for roughly 10 billion years",
+                "Rapid escalation of greenhouse gas emissions",
+                "The current trajectory of the Earth\u2019s tectonic plate movement",
+                "The current trajectory of the Milky Way galaxy and those in its immediate proximity",
+                "The life cycle of medium-sized stars includes a red giant stage and ends in a whimper as a white dwarf",
+            ],
+            left: [
+                "Average global temperatures will rise ",
+                "In 3 to 4 billion years, our galaxy will begin a slow collision with its closest large neighbor, Andromeda ",
+                "Our Sun will run out of fuel and die in around 5 billion years ",
+                "Our Sun will run out of hydrogen, swell into a red giant, gobble up the inner rocky planets, and then collapse and die ",
+                "Plate tectonics will rearrange the continents: the Pacific will narrow, bringing Australia closer to the Americas, and the Atlantic will expand to form the largest of the oceans ",
+            ],
+        });
+    });
+});

packages/perseus-core/src/widgets/matcher/matcher-util.ts

@@ -0,0 +1,31 @@
+import type {PerseusMatcherWidgetOptions} from "@khanacademy/perseus-core";
+
+/**
+ * For details on the individual options, see the
+ * PerseusMatcherWidgetOptions type
+ */
+type MatcherPublicWidgetOptions = {
+    labels: PerseusMatcherWidgetOptions["labels"];
+    left: Array<string>; // First column that is usually static, but could be movable
+    right: Array<string>; // Second column that appears to be always movable
+    orderMatters: PerseusMatcherWidgetOptions["orderMatters"]; // when this is on, both columns are dynamic and the order of the pairs in the list matters
+    padding: PerseusMatcherWidgetOptions["padding"];
+};
+
+/**
+ * Given a PerseusMatcherWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+function getMatcherPublicWidgetOptions(
+    options: PerseusMatcherWidgetOptions,
+): MatcherPublicWidgetOptions {
+    return {
+        labels: options.labels,
+        left: options.left.slice().sort(),
+        right: options.right.slice().sort(),
+        orderMatters: options.orderMatters,
+        padding: options.padding,
+    };
+}
+
+export default getMatcherPublicWidgetOptions;

packages/perseus/src/types.ts

@@ -15,6 +15,7 @@ import type {
     getOrdererPublicWidgetOptions,
     getCategorizerPublicWidgetOptions,
     getExpressionPublicWidgetOptions,
+    getMatcherPublicWidgetOptions,
 } from "@khanacademy/perseus-core";
 import type {LinterContextProps} from "@khanacademy/perseus-linter";
 import type {
@@ -541,6 +542,7 @@ export type WidgetScorerFunction = (
  * A union type of all the functions that provide public widget options.
  */
 export type PublicWidgetOptionsFunction =
+    | typeof getMatcherPublicWidgetOptions
     | typeof getCategorizerPublicWidgetOptions
     | typeof getOrdererPublicWidgetOptions
     | typeof getExpressionPublicWidgetOptions;

packages/perseus/src/widgets/matcher/matcher.tsx

@@ -1,3 +1,4 @@
+import {getMatcherPublicWidgetOptions} from "@khanacademy/perseus-core";
 import {linterContextDefault} from "@khanacademy/perseus-linter";
 import {scoreMatcher} from "@khanacademy/perseus-score";
 import {CircularSpinner} from "@khanacademy/wonder-blocks-progress-spinner";
@@ -290,4 +291,5 @@ export default {
     // TODO(LEMS-2656): remove TS suppression
     // @ts-expect-error: Type 'UserInput' is not assignable to type 'PerseusMatcherUserInput'.
     scorer: scoreMatcher,
+    getPublicWidgetOptions: getMatcherPublicWidgetOptions,
 } satisfies WidgetExports<typeof Matcher>;