@khanacademy/perseus-core 8.0.0 → 10.0.0

package/dist/data-schema.d.ts

@@ -50,8 +50,8 @@ export type ShowSolutions = "all" | "selected" | "none";
  *
  * ```
  * interface DummyRegistry {
- *     categorizer: { categories: ReadonlyArray<string> };
- *     dropdown: { choices: ReadonlyArray<string> }:
+ *     categorizer: { categories: string[] };
+ *     dropdown: { choices: string[] }:
  * }
  * ```
  *
@@ -65,8 +65,8 @@ export type ShowSolutions = "all" | "selected" | "none";
  *
  * ```
  * type DummyMap = {
- *     `categorizer ${number}`: { categories: ReadonlyArray<string> };
- *     `dropdown ${number}`: { choices: ReadonlyArray<string> };
+ *     `categorizer ${number}`: { categories: string[] };
+ *     `dropdown ${number}`: { choices: string[] };
  * }
  * ```
  *
@@ -192,14 +192,14 @@ export type PerseusWidget = PerseusWidgetTypes[keyof PerseusWidgetTypes];
  */
 export type PerseusItem = {
     question: PerseusRenderer;
-    hints: ReadonlyArray<Hint>;
+    hints: Hint[];
     answerArea: PerseusAnswerArea | null | undefined;
 };
 /**
  * A "PerseusArticle" is an item that is meant to be rendered as an article.
  * This item is never scored and is rendered by the `ArticleRenderer`.
  */
-export type PerseusArticle = PerseusRenderer | ReadonlyArray<PerseusRenderer>;
+export type PerseusArticle = PerseusRenderer | PerseusRenderer[];
 export type Version = {
     major: number;
     minor: number;
@@ -316,18 +316,18 @@ export type PerseusImageBackground = {
 export type MarkingsType = "axes" | "graph" | "grid" | "none";
 export type AxisLabelLocation = "onAxis" | "alongEdge";
 export type PerseusCategorizerWidgetOptions = {
-    items: ReadonlyArray<string>;
-    categories: ReadonlyArray<string>;
+    items: string[];
+    categories: string[];
     randomizeItems: boolean;
     static: boolean;
-    values: ReadonlyArray<number>;
+    values: number[];
     highlightLint?: boolean;
     linterContext?: PerseusLinterContext;
 };
 export type PerseusLinterContext = {
     contentType: string;
-    paths: ReadonlyArray<string>;
-    stack: ReadonlyArray<string>;
+    paths: string[];
+    stack: string[];
 };
 export type PerseusDefinitionWidgetOptions = {
     togglePrompt: string;
@@ -335,7 +335,7 @@ export type PerseusDefinitionWidgetOptions = {
     static: boolean;
 };
 export type PerseusDropdownWidgetOptions = {
-    choices: ReadonlyArray<PerseusDropdownChoice>;
+    choices: PerseusDropdownChoice[];
     placeholder: string;
     static: boolean;
     visibleLabel?: string;
@@ -352,13 +352,13 @@ export type PerseusExplanationWidgetOptions = {
     widgets: PerseusWidgetsMap;
     static: boolean;
 };
-export type LegacyButtonSets = ReadonlyArray<"basic" | "basic+div" | "trig" | "prealgebra" | "logarithms" | "basic relations" | "advanced relations" | "scientific">;
+export type LegacyButtonSets = Array<"basic" | "basic+div" | "trig" | "prealgebra" | "logarithms" | "basic relations" | "advanced relations" | "scientific">;
 export type PerseusExpressionWidgetOptions = {
-    answerForms: ReadonlyArray<PerseusExpressionAnswerForm>;
+    answerForms: PerseusExpressionAnswerForm[];
     buttonSets: LegacyButtonSets;
-    functions: ReadonlyArray<string>;
+    functions: string[];
     times: boolean;
-    extraKeys?: ReadonlyArray<KeypadKey>;
+    extraKeys?: KeypadKey[];
     visibleLabel?: string;
     ariaLabel?: string;
     buttonsVisible?: "always" | "never" | "focused";
@@ -384,7 +384,7 @@ export type PerseusGradedGroupWidgetOptions = {
     };
 };
 export type PerseusGradedGroupSetWidgetOptions = {
-    gradedGroups: ReadonlyArray<PerseusGradedGroupWidgetOptions>;
+    gradedGroups: PerseusGradedGroupWidgetOptions[];
 };
 export type GraphRange = [
     x: [min: number, max: number],
@@ -415,7 +415,7 @@ export type GrapherAnswerTypes = {
     coords: null | [Coord, Coord];
 };
 export type PerseusGrapherWidgetOptions = {
-    availableTypes: ReadonlyArray<"absolute_value" | "exponential" | "linear" | "logarithm" | "quadratic" | "sinusoid" | "tangent">;
+    availableTypes: Array<"absolute_value" | "exponential" | "linear" | "logarithm" | "quadratic" | "sinusoid" | "tangent">;
     correct: GrapherAnswerTypes;
     graph: {
         backgroundImage: {
@@ -427,7 +427,7 @@ export type PerseusGrapherWidgetOptions = {
             width?: number;
         };
         box?: [number, number];
-        editableSettings?: ReadonlyArray<"graph" | "snap" | "image" | "measure">;
+        editableSettings?: Array<"graph" | "snap" | "image" | "measure">;
         gridStep?: [number, number];
         labels: [string, string];
         markings: MarkingsType;
@@ -449,14 +449,14 @@ export type PerseusImageWidgetOptions = {
     alt?: string;
     backgroundImage: PerseusImageBackground;
     static?: boolean;
-    labels?: ReadonlyArray<PerseusImageLabel>;
+    labels?: Array<PerseusImageLabel>;
     range?: [Interval, Interval];
     box?: Size;
 };
 export type PerseusImageLabel = {
     content: string;
     alignment: string;
-    coordinates: ReadonlyArray<number>;
+    coordinates: number[];
 };
 export type PerseusInteractiveGraphWidgetOptions = {
     step: [number, number];
@@ -467,7 +467,7 @@ export type PerseusInteractiveGraphWidgetOptions = {
      * The type of markings to display on the graph.
      */
     markings: MarkingsType;
-    labels?: ReadonlyArray<string>;
+    labels?: string[];
     /**
      * Specifies the location of the labels on the graph.  default: "onAxis".
      * - "onAxis": Labels are positioned on the axis at the right (x) and top (y) of the graph.
@@ -503,7 +503,7 @@ export type PerseusInteractiveGraphWidgetOptions = {
     range: GraphRange;
     graph: PerseusGraphType;
     correct: PerseusGraphType;
-    lockedFigures?: ReadonlyArray<LockedFigure>;
+    lockedFigures: LockedFigure[];
     fullGraphAriaLabel?: string;
     fullGraphAriaDescription?: string;
 };
@@ -518,7 +518,7 @@ export type LockedPointType = {
     coord: Coord;
     color: LockedFigureColor;
     filled: boolean;
-    labels?: LockedLabelType[];
+    labels: LockedLabelType[];
     ariaLabel?: string;
 };
 export type LockedLineType = {
@@ -529,14 +529,14 @@ export type LockedLineType = {
     lineStyle: LockedLineStyle;
     showPoint1: boolean;
     showPoint2: boolean;
-    labels?: LockedLabelType[];
+    labels: LockedLabelType[];
     ariaLabel?: string;
 };
 export type LockedVectorType = {
     type: "vector";
     points: [tail: Coord, tip: Coord];
     color: LockedFigureColor;
-    labels?: LockedLabelType[];
+    labels: LockedLabelType[];
     ariaLabel?: string;
 };
 export type LockedFigureFillType = "none" | "white" | "translucent" | "solid";
@@ -549,17 +549,17 @@ export type LockedEllipseType = {
     color: LockedFigureColor;
     fillStyle: LockedFigureFillType;
     strokeStyle: LockedLineStyle;
-    labels?: LockedLabelType[];
+    labels: LockedLabelType[];
     ariaLabel?: string;
 };
 export type LockedPolygonType = {
     type: "polygon";
-    points: ReadonlyArray<Coord>;
+    points: Coord[];
     color: LockedFigureColor;
     showVertices: boolean;
     fillStyle: LockedFigureFillType;
     strokeStyle: LockedLineStyle;
-    labels?: LockedLabelType[];
+    labels: LockedLabelType[];
     ariaLabel?: string;
 };
 export type LockedFunctionType = {
@@ -580,7 +580,7 @@ export type LockedFunctionType = {
      * allowed. Note that infinite values are serialized as `null` in JSON.
      */
     domain: [min: number, max: number];
-    labels?: LockedLabelType[];
+    labels: LockedLabelType[];
     ariaLabel?: string;
 };
 export type LockedLabelType = {
@@ -591,9 +591,6 @@ export type LockedLabelType = {
     size: "small" | "medium" | "large";
 };
 export type PerseusGraphType = PerseusGraphTypeAngle | PerseusGraphTypeCircle | PerseusGraphTypeLinear | PerseusGraphTypeLinearSystem | PerseusGraphTypeNone | PerseusGraphTypePoint | PerseusGraphTypePolygon | PerseusGraphTypeQuadratic | PerseusGraphTypeRay | PerseusGraphTypeSegment | PerseusGraphTypeSinusoid;
-type PerseusGraphTypeCommon = {
-    coord?: Coord;
-};
 export type PerseusGraphTypeAngle = {
     type: "angle";
     showAngles?: boolean;
@@ -601,7 +598,7 @@ export type PerseusGraphTypeAngle = {
     angleOffsetDeg?: number;
     snapDegrees?: number;
     match?: "congruent";
-    coords?: [Coord, Coord, Coord] | null;
+    coords?: [Coord, Coord, Coord];
     startCoords?: [Coord, Coord, Coord];
 };
 export type PerseusGraphTypeCircle = {
@@ -612,26 +609,27 @@ export type PerseusGraphTypeCircle = {
         center: Coord;
         radius: number;
     };
-} & PerseusGraphTypeCommon;
+};
 export type PerseusGraphTypeLinear = {
     type: "linear";
     coords?: CollinearTuple | null;
     startCoords?: CollinearTuple;
-} & PerseusGraphTypeCommon;
+};
 export type PerseusGraphTypeLinearSystem = {
     type: "linear-system";
     coords?: CollinearTuple[] | null;
     startCoords?: CollinearTuple[];
-} & PerseusGraphTypeCommon;
+};
 export type PerseusGraphTypeNone = {
     type: "none";
 };
 export type PerseusGraphTypePoint = {
     type: "point";
     numPoints?: number | "unlimited";
-    coords?: ReadonlyArray<Coord> | null;
-    startCoords?: ReadonlyArray<Coord>;
-} & PerseusGraphTypeCommon;
+    coords?: Coord[] | null;
+    startCoords?: Coord[];
+    coord?: Coord;
+};
 export type PerseusGraphTypePolygon = {
     type: "polygon";
     numSides?: number | "unlimited";
@@ -639,30 +637,30 @@ export type PerseusGraphTypePolygon = {
     showSides?: boolean;
     snapTo?: "grid" | "angles" | "sides";
     match?: "similar" | "congruent" | "approx" | "exact";
-    coords?: ReadonlyArray<Coord> | null;
-    startCoords?: ReadonlyArray<Coord>;
-} & PerseusGraphTypeCommon;
+    coords?: Coord[] | null;
+    startCoords?: Coord[];
+};
 export type PerseusGraphTypeQuadratic = {
     type: "quadratic";
     coords?: [Coord, Coord, Coord] | null;
     startCoords?: [Coord, Coord, Coord];
-} & PerseusGraphTypeCommon;
+};
 export type PerseusGraphTypeSegment = {
     type: "segment";
     numSegments?: number;
     coords?: CollinearTuple[] | null;
     startCoords?: CollinearTuple[];
-} & PerseusGraphTypeCommon;
+};
 export type PerseusGraphTypeSinusoid = {
     type: "sinusoid";
-    coords?: ReadonlyArray<Coord> | null;
-    startCoords?: ReadonlyArray<Coord>;
-} & PerseusGraphTypeCommon;
+    coords?: Coord[] | null;
+    startCoords?: Coord[];
+};
 export type PerseusGraphTypeRay = {
     type: "ray";
     coords?: CollinearTuple | null;
     startCoords?: CollinearTuple;
-} & PerseusGraphTypeCommon;
+};
 type AngleGraphCorrect = {
     type: "angle";
     allowReflexAngles: boolean;
@@ -687,12 +685,12 @@ type NoneGraphCorrect = {
 };
 type PointGraphCorrect = {
     type: "point";
-    coords: ReadonlyArray<Coord>;
+    coords: Coord[];
 };
 type PolygonGraphCorrect = {
     type: "polygon";
     match: "similar" | "congruent" | "approx";
-    coords: ReadonlyArray<Coord>;
+    coords: Coord[];
 };
 type QuadraticGraphCorrect = {
     type: "quadratic";
@@ -712,36 +710,36 @@ type RayGraphCorrect = {
 };
 export type PerseusGraphCorrectType = AngleGraphCorrect | CircleGraphCorrect | LinearGraphCorrect | LinearSystemGraphCorrect | NoneGraphCorrect | PointGraphCorrect | PolygonGraphCorrect | QuadraticGraphCorrect | RayGraphCorrect | SegmentGraphCorrect | SinusoidGraphCorrect;
 export type PerseusLabelImageWidgetOptions = {
-    choices: ReadonlyArray<string>;
+    choices: string[];
     imageUrl: string;
     imageAlt: string;
     imageHeight: number;
     imageWidth: number;
-    markers: ReadonlyArray<PerseusLabelImageMarker>;
+    markers: PerseusLabelImageMarker[];
     hideChoicesFromInstructions: boolean;
     multipleAnswers: boolean;
     static: boolean;
 };
 export type PerseusLabelImageMarker = {
-    answers: ReadonlyArray<string>;
+    answers: string[];
     label: string;
     x: number;
     y: number;
 };
 export type PerseusMatcherWidgetOptions = {
-    labels: ReadonlyArray<string>;
-    left: ReadonlyArray<string>;
-    right: ReadonlyArray<string>;
+    labels: string[];
+    left: string[];
+    right: string[];
     orderMatters: boolean;
     padding: boolean;
 };
-export type PerseusMatrixWidgetAnswers = ReadonlyArray<ReadonlyArray<number>>;
+export type PerseusMatrixWidgetAnswers = number[][];
 export type PerseusMatrixWidgetOptions = {
     prefix?: string | undefined;
     suffix?: string | undefined;
     answers: PerseusMatrixWidgetAnswers;
-    cursorPosition?: ReadonlyArray<number> | undefined;
-    matrixBoardSize: ReadonlyArray<number>;
+    cursorPosition?: number[] | undefined;
+    matrixBoardSize: number[];
     static?: boolean | undefined;
 };
 export type PerseusMeasurerWidgetOptions = {
@@ -753,7 +751,6 @@ export type PerseusMeasurerWidgetOptions = {
     rulerPixels: number;
     rulerLength: number;
     box: [number, number];
-    static: boolean;
 };
 export type MathFormat = "integer" | "mixed" | "improper" | "proper" | "decimal" | "percent" | "pi";
 export type PerseusNumericInputAnswerForm = {
@@ -770,7 +767,7 @@ export type PerseusNumericInputAnswerForm = {
  */
 export type PerseusNumericInputSimplify = "required" | "enforced" | "optional";
 export type PerseusNumericInputWidgetOptions = {
-    answers: ReadonlyArray<PerseusNumericInputAnswer>;
+    answers: PerseusNumericInputAnswer[];
     labelText?: string | undefined;
     size: string;
     coefficient: boolean;
@@ -781,31 +778,32 @@ export type PerseusNumericInputAnswer = {
     message: string;
     value?: number | null;
     status: string;
-    answerForms?: ReadonlyArray<MathFormat>;
+    answerForms?: MathFormat[];
     strict: boolean;
     maxError?: number | null;
     simplify: PerseusNumericInputSimplify;
 };
 export type PerseusNumberLineWidgetOptions = {
-    range: ReadonlyArray<number>;
-    labelRange: ReadonlyArray<number | null>;
+    range: number[];
+    labelRange: Array<number | null>;
     labelStyle: string;
     labelTicks: boolean;
     isTickCtrl?: boolean | null;
-    divisionRange: ReadonlyArray<number>;
+    isInequality: boolean;
+    divisionRange: number[];
     numDivisions?: number | null;
     snapDivisions: number;
     tickStep?: number | null;
-    correctRel?: string | null;
+    correctRel?: "eq" | "lt" | "gt" | "le" | "ge";
     correctX: number | null;
     initialX?: number | null;
     showTooltips?: boolean;
     static: boolean;
 };
 export type PerseusOrdererWidgetOptions = {
-    options: ReadonlyArray<PerseusRenderer>;
-    correctOptions: ReadonlyArray<PerseusRenderer>;
-    otherOptions: ReadonlyArray<PerseusRenderer>;
+    options: PerseusRenderer[];
+    correctOptions: PerseusRenderer[];
+    otherOptions: PerseusRenderer[];
     height: "normal" | "auto";
     layout: "horizontal" | "vertical";
 };
@@ -824,22 +822,22 @@ export type PerseusPassageRefWidgetOptions = {
 export declare const plotterPlotTypes: readonly ["bar", "line", "pic", "histogram", "dotplot"];
 export type PlotType = (typeof plotterPlotTypes)[number];
 export type PerseusPlotterWidgetOptions = {
-    labels: ReadonlyArray<string>;
-    categories: ReadonlyArray<string>;
+    labels: string[];
+    categories: string[];
     type: PlotType;
     maxY: number;
     scaleY: number;
     labelInterval?: number | null;
     snapsPerLine: number;
-    starting: ReadonlyArray<number>;
-    correct: ReadonlyArray<number>;
+    starting: number[];
+    correct: number[];
     picUrl?: string | null;
     picSize?: number | null;
     picBoxHeight?: number | null;
-    plotDimensions: ReadonlyArray<number>;
+    plotDimensions: number[];
 };
 export type PerseusRadioWidgetOptions = {
-    choices: ReadonlyArray<PerseusRadioChoice>;
+    choices: PerseusRadioChoice[];
     hasNoneOfTheAbove?: boolean;
     countChoices?: boolean;
     numCorrect?: number;
@@ -858,25 +856,25 @@ export type PerseusRadioChoice = {
     widgets?: PerseusWidgetsMap;
 };
 export type PerseusSorterWidgetOptions = {
-    correct: ReadonlyArray<string>;
+    correct: string[];
     padding: boolean;
     layout: "horizontal" | "vertical";
 };
 export type PerseusTableWidgetOptions = {
-    headers: ReadonlyArray<string>;
+    headers: string[];
     rows: number;
     columns: number;
-    answers: ReadonlyArray<ReadonlyArray<string>>;
+    answers: string[][];
 };
 export type PerseusInteractionWidgetOptions = {
     graph: PerseusInteractionGraph;
-    elements: ReadonlyArray<PerseusInteractionElement>;
+    elements: PerseusInteractionElement[];
     static: boolean;
 };
 export type PerseusInteractionGraph = {
-    editableSettings?: ReadonlyArray<"canvas" | "graph">;
+    editableSettings?: Array<"canvas" | "graph">;
     box: Size;
-    labels: ReadonlyArray<string>;
+    labels: string[];
     range: [Interval, Interval];
     gridStep: [number, number];
     /**
@@ -1001,7 +999,7 @@ export type PerseusInteractionRectangleElementOptions = {
 export type PerseusCSProgramWidgetOptions = {
     programID: string;
     programType?: any;
-    settings: ReadonlyArray<PerseusCSProgramSetting>;
+    settings: PerseusCSProgramSetting[];
     showEditor: boolean;
     showButtons: boolean;
     height: number;
@@ -1017,7 +1015,7 @@ export type PerseusPythonProgramWidgetOptions = {
 };
 export type PerseusIFrameWidgetOptions = {
     url: string;
-    settings?: ReadonlyArray<PerseusCSProgramSetting>;
+    settings?: PerseusCSProgramSetting[];
     width: number | string;
     height: number | string;
     allowFullScreen: boolean;