Create a function to get the public options for the NumberLine widget (…

…#2179) Issue: https://khanacademy.atlassian.net/browse/LEMS-2768 ## Test plan: `yarn test` Author: benchristel Reviewers: Myranae, handeyeco, jeremywiebe Required Reviewers: Approved By: Myranae Checks: ✅ Publish npm snapshot (ubuntu-latest, 20.x), ✅ Check builds for changes in size (ubuntu-latest, 20.x), ✅ Check for .changeset entries for all changed files (ubuntu-latest, 20.x), ✅ Lint, Typecheck, Format, and Test (ubuntu-latest, 20.x), ✅ Cypress (ubuntu-latest, 20.x), ✅ Publish Storybook to Chromatic (ubuntu-latest, 20.x) Pull Request URL: #2179
Khan · Feb 3, 2025 · 564447a · 564447a
1 parent 7f88f17
commit 564447a
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 1 deletion.
diff --git a/.changeset/wise-plants-lick.md b/.changeset/wise-plants-lick.md
@@ -0,0 +1,6 @@
+---
+"@khanacademy/perseus": minor
+"@khanacademy/perseus-core": minor
+---
+
+Create a function to get the public options for the NumberLine widget
diff --git a/packages/perseus-core/src/index.ts b/packages/perseus-core/src/index.ts
@@ -122,3 +122,4 @@ export {default as getLabelImagePublicWidgetOptions} from "./widgets/label-image
 export {default as getSorterPublicWidgetOptions} from "./widgets/sorter/sorter-util";
 export {default as getDropdownPublicWidgetOptions} from "./widgets/dropdown/dropdown-util";
 export {default as getNumericInputPublicWidgetOptions} from "./widgets/numeric-input/numeric-input-util";
+export {default as getNumberLinePublicWidgetOptions} from "./widgets/number-line/number-line-util";
diff --git a/packages/perseus-core/src/widgets/number-line/number-line-util.test.ts b/packages/perseus-core/src/widgets/number-line/number-line-util.test.ts
@@ -0,0 +1,41 @@
+import getNumberLinePublicWidgetOptions from "./number-line-util";
+
+import type {PerseusNumberLineWidgetOptions} from "../../data-schema";
+
+describe("getNumberLinePublicWidgetOptions", () => {
+    it("removes correctX and correctRel", () => {
+        const options: PerseusNumberLineWidgetOptions = {
+            correctRel: "lt",
+            correctX: 42,
+            range: [0, 100],
+            numDivisions: 5,
+            tickStep: 6,
+            divisionRange: [],
+            initialX: 3,
+            labelRange: [],
+            labelStyle: "",
+            labelTicks: false,
+            snapDivisions: 0,
+            isTickCtrl: false,
+            showTooltips: false,
+            static: false,
+        };
+
+        const publicOptions = getNumberLinePublicWidgetOptions(options);
+
+        expect(publicOptions).toEqual({
+            range: [0, 100],
+            numDivisions: 5,
+            tickStep: 6,
+            divisionRange: [],
+            initialX: 3,
+            labelRange: [],
+            labelStyle: "",
+            labelTicks: false,
+            snapDivisions: 0,
+            isTickCtrl: false,
+            showTooltips: false,
+            static: false,
+        });
+    });
+});
diff --git a/packages/perseus-core/src/widgets/number-line/number-line-util.ts b/packages/perseus-core/src/widgets/number-line/number-line-util.ts
@@ -0,0 +1,24 @@
+import type {PerseusNumberLineWidgetOptions} from "../../data-schema";
+
+type NumberLinePublicWidgetOptions = Pick<
+    PerseusNumberLineWidgetOptions,
+    | "range"
+    | "labelRange"
+    | "labelStyle"
+    | "labelTicks"
+    | "isTickCtrl"
+    | "divisionRange"
+    | "numDivisions"
+    | "snapDivisions"
+    | "tickStep"
+    | "initialX"
+    | "showTooltips"
+    | "static"
+>;
+
+export default function getNumberLinePublicWidgetOptions(
+    options: PerseusNumberLineWidgetOptions,
+): NumberLinePublicWidgetOptions {
+    const {correctX: _, correctRel: __, ...publicOptions} = options;
+    return publicOptions;
+}
diff --git a/packages/perseus/src/types.ts b/packages/perseus/src/types.ts
@@ -20,6 +20,7 @@ import type {
     getSorterPublicWidgetOptions,
     getDropdownPublicWidgetOptions,
     getNumericInputPublicWidgetOptions,
+    getNumberLinePublicWidgetOptions,
 } from "@khanacademy/perseus-core";
 import type {LinterContextProps} from "@khanacademy/perseus-linter";
 import type {
@@ -553,7 +554,8 @@ export type PublicWidgetOptionsFunction =
     | typeof getExpressionPublicWidgetOptions
     | typeof getLabelImagePublicWidgetOptions
     | typeof getSorterPublicWidgetOptions
-    | typeof getCSProgramPublicWidgetOptions;
+    | typeof getCSProgramPublicWidgetOptions
+    | typeof getNumberLinePublicWidgetOptions;
 
 export type WidgetExports<
     T extends React.ComponentType<any> & Widget = React.ComponentType<any>,

diff --git a/packages/perseus/src/widgets/number-line/number-line.tsx b/packages/perseus/src/widgets/number-line/number-line.tsx
@@ -1,4 +1,5 @@
 import {number as knumber, KhanMath} from "@khanacademy/kmath";
+import {getNumberLinePublicWidgetOptions} from "@khanacademy/perseus-core";
 import {scoreNumberLine, validateNumberLine} from "@khanacademy/perseus-score";
 import * as React from "react";
 import ReactDOM from "react-dom";
@@ -808,4 +809,5 @@ export default {
     // TODO(LEMS-2656): remove TS suppression
     // @ts-expect-error: Type 'UserInput' is not assignable to type 'PerseusNumberLineUserInput'.
     validator: validateNumberLine,
+    getPublicWidgetOptions: getNumberLinePublicWidgetOptions,
 } satisfies WidgetExports<typeof NumberLine>;