Create helper to build public widget options for Sorter

.changeset/beige-glasses-reflect.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 Sorter widget

packages/perseus-core/src/index.ts

@@ -116,3 +116,4 @@ export {default as getOrdererPublicWidgetOptions} from "./widgets/orderer/ordere
 export {default as getCategorizerPublicWidgetOptions} from "./widgets/categorizer/categorizer-util";
 export {default as getExpressionPublicWidgetOptions} from "./widgets/expression/expression-util";
 export {default as getLabelImagePublicWidgetOptions} from "./widgets/label-image/label-image-util";
+export {default as getSorterPublicWidgetOptions} from "./widgets/sorter/sorter-util";

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

@@ -0,0 +1,24 @@
+import getSorterPublicWidgetOptions from "./sorter-util";
+
+import type {PerseusSorterWidgetOptions} from "../../data-schema";
+
+describe("getSorterPublicWidgetOptions", () => {
+    it("should return the correct public options without any answer data", () => {
+        // Arrange
+        const options: PerseusSorterWidgetOptions = {
+            correct: ["$15$ grams", "$55$ grams", "$0.005$ kilograms"],
+            layout: "horizontal",
+            padding: true,
+        };
+
+        // Act
+        const publicWidgetOptions = getSorterPublicWidgetOptions(options);
+
+        // Assert
+        expect(publicWidgetOptions).toEqual({
+            correct: ["$0.005$ kilograms", "$15$ grams", "$55$ grams"],
+            layout: "horizontal",
+            padding: true,
+        });
+    });
+});

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

@@ -0,0 +1,30 @@
+import type {PerseusSorterWidgetOptions} from "@khanacademy/perseus-core";
+
+/**
+ * For details on the individual options, see the
+ * PerseusSorterWidgetOptions type
+ */
+type SorterPublicWidgetOptions = {
+    correct: PerseusSorterWidgetOptions["correct"];
+    padding: PerseusSorterWidgetOptions["padding"];
+    layout: PerseusSorterWidgetOptions["layout"];
+};
+
+/**
+ * Given a PerseusSorterWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+function getSorterPublicWidgetOptions(
+    options: PerseusSorterWidgetOptions,
+): SorterPublicWidgetOptions {
+    return {
+        // Note(Tamara): This does not provide correct answer information any longer.
+        // To maintain compatibility with the original widget options, we are
+        // keeping the key the same. Represents initial state of the cards here.
+        correct: options.correct.slice().sort(),
+        padding: options.padding,
+        layout: options.layout,
+    };
+}
+
+export default getSorterPublicWidgetOptions;

packages/perseus/src/types.ts

@@ -16,6 +16,7 @@ import type {
     getOrdererPublicWidgetOptions,
     getCategorizerPublicWidgetOptions,
     getExpressionPublicWidgetOptions,
+    getSorterPublicWidgetOptions,
 } from "@khanacademy/perseus-core";
 import type {LinterContextProps} from "@khanacademy/perseus-linter";
 import type {
@@ -545,7 +546,8 @@ export type PublicWidgetOptionsFunction =
     | typeof getCategorizerPublicWidgetOptions
     | typeof getOrdererPublicWidgetOptions
     | typeof getExpressionPublicWidgetOptions
-    | typeof getLabelImagePublicWidgetOptions;
+    | typeof getLabelImagePublicWidgetOptions
+    | typeof getSorterPublicWidgetOptions;
 
 export type WidgetExports<
     T extends React.ComponentType<any> & Widget = React.ComponentType<any>,

packages/perseus/src/widgets/sorter/sorter.tsx

@@ -1,3 +1,7 @@
+import {
+    type PerseusSorterWidgetOptions,
+    getSorterPublicWidgetOptions,
+} from "@khanacademy/perseus-core";
 import {linterContextDefault} from "@khanacademy/perseus-linter";
 import {scoreSorter, validateSorter} from "@khanacademy/perseus-score";
 import * as React from "react";
@@ -9,7 +13,6 @@ import {getPromptJSON as _getPromptJSON} from "../../widget-ai-utils/sorter/sort
 import type {SortableOption} from "../../components/sortable";
 import type {Widget, WidgetExports, WidgetProps} from "../../types";
 import type {SorterPromptJSON} from "../../widget-ai-utils/sorter/sorter-ai-utils";
-import type {PerseusSorterWidgetOptions} from "@khanacademy/perseus-core";
 import type {
     PerseusSorterRubric,
     PerseusSorterUserInput,
@@ -138,4 +141,5 @@ export default {
     // TODO(LEMS-2656): remove TS suppression
     // @ts-expect-error: Type UserInput is not assignable to type PerseusSorterUserInput
     validator: validateSorter,
+    getPublicWidgetOptions: getSorterPublicWidgetOptions,
 } satisfies WidgetExports<typeof Sorter>;