@khanacademy/perseus-core 3.6.0 → 4.0.0

package/LICENSE

@@ -0,0 +1,18 @@
+Copyright 2022 Khan Academy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so, subject
+to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/data-schema.d.ts

@@ -226,7 +226,14 @@ export type PerseusRenderer = {
      * field.
      */
     widgets: PerseusWidgetsMap;
-    metadata?: ReadonlyArray<string>;
+    /**
+     * Formerly used in the PerseusGradedGroup widget.  A list of "tags" that
+     * are keys that represent other content in the system.  Not rendered to
+     * the user. NOTE: perseus_data.go says this is required even though it
+     * isn't necessary.
+     * @deprecated
+     */
+    metadata?: any;
     /**
      * A dictionary of {[imageUrl]: PerseusImageDetail}.
      */
@@ -258,7 +265,7 @@ export type WidgetOptions<Type extends string, Options> = {
     graded?: boolean;
     alignment?: string;
     options: Options;
-    key?: number;
+    key?: number | null;
     version?: Version;
 };
 export type CategorizerWidget = WidgetOptions<'categorizer', PerseusCategorizerWidgetOptions>;
@@ -304,7 +311,7 @@ export type PerseusImageBackground = {
     height?: number;
     top?: number;
     left?: number;
-    scale?: number | string;
+    scale?: number;
     bottom?: number;
 };
 /**
@@ -558,9 +565,20 @@ export type LockedFunctionType = {
     type: "function";
     color: LockedFigureColor;
     strokeStyle: LockedLineStyle;
+    /**
+     * This is the user-defined equation (as it was typed)
+     */
     equation: string;
+    /**
+     * The independent variable of this function
+     */
     directionalAxis: "x" | "y";
-    domain?: [min: number | null, max: number | null];
+    /**
+     * The minimum and maximum values along the `directionalAxis` at which
+     * this function should be graphed. Values of -Infinity and Infinity are
+     * allowed. Note that infinite values are serialized as `null` in JSON.
+     */
+    domain: [min: number, max: number];
     labels?: LockedLabelType[];
     ariaLabel?: string;
 };
@@ -738,9 +756,10 @@ export type PerseusMeasurerWidgetOptions = {
 };
 export type MathFormat = "integer" | "mixed" | "improper" | "proper" | "decimal" | "percent" | "pi";
 export type PerseusNumericInputAnswerForm = {
-    simplify: "required" | "correct" | "enforced" | "optional" | null | undefined;
+    simplify: PerseusNumericInputSimplify | null | undefined;
     name: MathFormat;
 };
+export type PerseusNumericInputSimplify = "required" | "correct" | "enforced" | "optional";
 export type PerseusNumericInputWidgetOptions = {
     answers: ReadonlyArray<PerseusNumericInputAnswer>;
     labelText?: string | undefined;
@@ -748,7 +767,6 @@ export type PerseusNumericInputWidgetOptions = {
     coefficient: boolean;
     rightAlign?: boolean;
     static: boolean;
-    answerForms?: ReadonlyArray<PerseusNumericInputAnswerForm>;
 };
 export type PerseusNumericInputAnswer = {
     message: string;
@@ -757,7 +775,7 @@ export type PerseusNumericInputAnswer = {
     answerForms?: ReadonlyArray<MathFormat>;
     strict: boolean;
     maxError: number | null | undefined;
-    simplify: string | null | undefined;
+    simplify: PerseusNumericInputSimplify | null | undefined;
 };
 export type PerseusNumberLineWidgetOptions = {
     range: ReadonlyArray<number>;