@khanacademy/perseus 19.3.0 → 19.4.0

package/dist/perseus-types.d.ts

@@ -1,6 +1,10 @@
 import type { Coord } from "./interactive2/types";
 export type Range = [number, number];
 export type Size = [number, number];
+type StyleParams = {
+    fill?: string;
+    stroke?: string;
+};
 type Empty = Record<never, never>;
 export type PerseusItem = {
     question: PerseusRenderer;
@@ -240,7 +244,7 @@ export type PerseusInteractiveGraphWidgetOptions = {
     gridStep: [number, number];
     snapStep: [number, number];
     backgroundImage?: PerseusImageBackground;
-    markings: string;
+    markings: "graph" | "grid" | "none";
     labels: ReadonlyArray<string>;
     showProtractor: boolean;
     showRuler: boolean;
@@ -250,6 +254,13 @@ export type PerseusInteractiveGraphWidgetOptions = {
     range: [[number, number], [number, number]];
     graph: PerseusGraphType;
     correct: PerseusGraphType;
+    lockedFigures?: ReadonlyArray<LockedFigure>;
+};
+export type LockedFigure = LockedPoint;
+export type LockedPoint = {
+    type: "point";
+    coord: Coord;
+    style?: StyleParams;
 };
 export type PerseusGraphType = PerseusGraphTypeAngle | PerseusGraphTypeCircle | PerseusGraphTypeLinear | PerseusGraphTypeLinearSystem | PerseusGraphTypePoint | PerseusGraphTypePolygon | PerseusGraphTypeQuadratic | PerseusGraphTypeRay | PerseusGraphTypeSegment | PerseusGraphTypeSinusoid;
 export type PerseusGraphTypeCommon = {
@@ -507,7 +518,7 @@ export type PerseusInteractionGraph = {
     labels: ReadonlyArray<string>;
     range: [Range, Range];
     gridStep: [number, number];
-    markings: string;
+    markings: "graph" | "grid" | "none";
     snapStep?: [number, number];
     valid?: boolean | string;
     backgroundImage?: PerseusImageBackground;

package/dist/util/test-utils.d.ts

@@ -0,0 +1,12 @@
+import type { PerseusItem } from "../perseus-types";
+export declare const genericPerseusItemData: PerseusItem;
+/**
+ * Generate a Perseus item object for testing purposes.
+ *
+ * In order to better type Perseus objects used in testing, this function
+ * uses a basic Perseus object and updates it with custom values as needed.
+ *
+ * @param {Partial<PerseusItem>} customFields
+ * @returns PerseusItem
+ */
+export declare function generateTestPerseusItem(customFields?: Partial<PerseusItem>): PerseusItem;

package/package.json

@@ -3,7 +3,7 @@
     "description": "Core Perseus API (includes renderers and widgets)",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "19.3.0",
+    "version": "19.4.0",
     "publishConfig": {
         "access": "public"
     },