@khanacademy/perseus-core 20.4.0 → 21.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,3 @@
1
+ import type { DefinitionWidget, PerseusDefinitionWidgetOptions } from "../../data-schema";
2
+ export declare function generateDefinitionOptions(options?: Partial<PerseusDefinitionWidgetOptions>): PerseusDefinitionWidgetOptions;
3
+ export declare function generateDefinitionWidget(definitionWidgetProperties?: Partial<Omit<DefinitionWidget, "type">>): DefinitionWidget;
@@ -0,0 +1,3 @@
1
+ import type { DropdownWidget, PerseusDropdownWidgetOptions } from "../../data-schema";
2
+ export declare function generateDropdownOptions(options?: Partial<PerseusDropdownWidgetOptions>): PerseusDropdownWidgetOptions;
3
+ export declare function generateDropdownWidget(dropdownWidgetProperties?: Partial<Omit<DropdownWidget, "type">>): DropdownWidget;
@@ -0,0 +1,3 @@
1
+ import type { ExplanationWidget, PerseusExplanationWidgetOptions } from "../../data-schema";
2
+ export declare function generateExplanationOptions(options?: Partial<PerseusExplanationWidgetOptions>): PerseusExplanationWidgetOptions;
3
+ export declare function generateExplanationWidget(explanationWidgetProperties?: Partial<Omit<ExplanationWidget, "type">>): ExplanationWidget;
@@ -0,0 +1,4 @@
1
+ import type { PerseusExpressionWidgetOptions, ExpressionWidget, PerseusExpressionAnswerForm } from "../../data-schema";
2
+ export declare function generateExpressionOptions(options?: Partial<PerseusExpressionWidgetOptions>): PerseusExpressionWidgetOptions;
3
+ export declare function generateExpressionAnswerForm(answerFormOptions?: Partial<PerseusExpressionAnswerForm>): PerseusExpressionAnswerForm;
4
+ export declare function generateExpressionWidget(expressionWidgetProperties?: Partial<Omit<ExpressionWidget, "type">>): ExpressionWidget;
@@ -0,0 +1,4 @@
1
+ import type { PerseusNumericInputWidgetOptions, NumericInputWidget, PerseusNumericInputAnswer } from "../../data-schema";
2
+ export declare function generateNumericInputOptions(options?: Partial<PerseusNumericInputWidgetOptions>): PerseusNumericInputWidgetOptions;
3
+ export declare function generateNumericInputAnswer(answerOptions?: Partial<PerseusNumericInputAnswer>): PerseusNumericInputAnswer;
4
+ export declare function generateNumericInputWidget(numericInputWidgetProperties?: Partial<Omit<NumericInputWidget, "type">>): NumericInputWidget;
@@ -0,0 +1,16 @@
1
+ import type { PerseusItem, PerseusRadioChoice, PerseusRadioWidgetOptions, RadioWidget } from "../../data-schema";
2
+ export declare function generateRadioOptions(options?: Partial<PerseusRadioWidgetOptions>): PerseusRadioWidgetOptions;
3
+ export declare function generateRadioWidget(radioWidgetProperties?: Partial<Omit<RadioWidget, "type">>): RadioWidget;
4
+ export declare function generateRadioChoice(text: string, options?: Partial<PerseusRadioChoice>): PerseusRadioChoice;
5
+ /**
6
+ * A simple question (PerseusRenderer) with a single radio widget,
7
+ * in which the `content` is only "[[☃ radio 1]]" and the widget has
8
+ * no properties other than the options.
9
+ */
10
+ export declare function generateSimpleRadioQuestion(options?: Partial<PerseusRadioWidgetOptions>): import("../..").PerseusRenderer;
11
+ /**
12
+ * A simple item (PerseusItem) with a single radio widget,
13
+ * in which the `content` is only "[[☃ radio 1]]" and the widget has
14
+ * no properties other than the options.
15
+ */
16
+ export declare function generateSimpleRadioItem(options?: Partial<PerseusRadioWidgetOptions>): PerseusItem;
@@ -0,0 +1,9 @@
1
+ import { type LockedEllipseType, type LockedFigure, type LockedFigureType, type LockedFunctionType, type LockedLabelType, type LockedLineType, type LockedPointType, type LockedPolygonType, type LockedVectorType } from "../data-schema";
2
+ export declare function getDefaultFigureForType(type: "point"): LockedPointType;
3
+ export declare function getDefaultFigureForType(type: "line"): LockedLineType;
4
+ export declare function getDefaultFigureForType(type: "vector"): LockedVectorType;
5
+ export declare function getDefaultFigureForType(type: "ellipse"): LockedEllipseType;
6
+ export declare function getDefaultFigureForType(type: "polygon"): LockedPolygonType;
7
+ export declare function getDefaultFigureForType(type: "function"): LockedFunctionType;
8
+ export declare function getDefaultFigureForType(type: "label"): LockedLabelType;
9
+ export declare function getDefaultFigureForType(type: LockedFigureType): LockedFigure;
@@ -28,7 +28,7 @@
28
28
  * } & Perseus<Widget>ValidationData;
29
29
  * ```
30
30
  */
31
- import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType, MakeWidgetMap, PerseusFreeResponseWidgetScoringCriterion } from "./data-schema";
31
+ import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType, MakeWidgetMap, PerseusFreeResponseWidgetScoringCriterion, PerseusRenderer } from "./data-schema";
32
32
  import type { ErrorCode } from "./error-codes";
33
33
  import type { Relationship } from "./types";
34
34
  export type WidgetValidatorFunction = (userInput: UserInput | undefined, validationData: ValidationData, locale: string) => ValidationResult;
@@ -72,9 +72,7 @@ export type PerseusExpressionRubric = {
72
72
  };
73
73
  export type PerseusExpressionUserInput = string;
74
74
  export type PerseusGroupRubric = PerseusGroupWidgetOptions;
75
- export type PerseusGroupValidationData = {
76
- widgets: ValidationDataMap;
77
- };
75
+ export type PerseusGroupValidationData = PerseusRenderer;
78
76
  export type PerseusGroupUserInput = UserInputMap;
79
77
  export type PerseusGradedGroupRubric = PerseusGradedGroupWidgetOptions;
80
78
  export type PerseusGradedGroupSetRubric = PerseusGradedGroupSetWidgetOptions;
@@ -267,24 +265,6 @@ export interface ValidationDataTypes {
267
265
  group: PerseusGroupValidationData;
268
266
  plotter: PerseusPlotterValidationData;
269
267
  }
270
- /**
271
- * A map of validation data, keyed by `widgetId`. This data is used to check if
272
- * a question is answerable. This data represents the minimal intersection of
273
- * data that's available in the client (widget options) and server (scoring
274
- * data) and is represented by a group of types known as "validation data".
275
- *
276
- * NOTE: The value in this map is intentionally a subset of WidgetOptions<T>.
277
- * By using the same shape (minus any unneeded data), we are able to pass a
278
- * `PerseusWidgetsMap` or ` into any function that accepts a
279
- * `ValidationDataMap` without any mutation of data.
280
- */
281
- export type ValidationDataMap = {
282
- [Property in keyof ValidationDataTypes as `${Property} ${number}`]: {
283
- type: Property;
284
- static?: boolean;
285
- options: ValidationDataTypes[Property];
286
- };
287
- };
288
268
  /**
289
269
  * A union type of all the different widget validation data types that exist.
290
270
  */
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "description": "Shared Perseus infrastructure",
4
4
  "author": "Khan Academy",
5
5
  "license": "MIT",
6
- "version": "20.4.0",
6
+ "version": "21.0.0",
7
7
  "publishConfig": {
8
8
  "access": "public"
9
9
  },
@@ -1 +0,0 @@
1
- export {};