@khanacademy/perseus-core 11.0.0 → 12.0.0

package/dist/parse-perseus-json/perseus-parsers/free-response-widget.d.ts

@@ -0,0 +1,3 @@
+import type { FreeResponseWidget } from "../../data-schema";
+import type { Parser } from "../parser-types";
+export declare const parseFreeResponseWidget: Parser<FreeResponseWidget>;

package/dist/validation.types.d.ts

@@ -28,7 +28,7 @@
  * } & Perseus<Widget>ValidationData;
  * ```
  */
-import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType, MakeWidgetMap } from "./data-schema";
+import type { GrapherAnswerTypes, PerseusDropdownChoice, PerseusExpressionAnswerForm, PerseusGradedGroupSetWidgetOptions, PerseusGradedGroupWidgetOptions, PerseusGraphType, PerseusGroupWidgetOptions, PerseusMatrixWidgetAnswers, PerseusNumericInputAnswer, PerseusOrdererWidgetOptions, PerseusRadioChoice, PerseusGraphCorrectType, MakeWidgetMap, PerseusFreeResponseWidgetScoringCriterion } from "./data-schema";
 import type { Relationship } from "./types";
 export type WidgetValidatorFunction = (userInput: UserInput, validationData: ValidationData, locale: string) => ValidationResult;
 export type WidgetScorerFunction = (userInput: UserInput, rubric: Rubric, locale?: string) => PerseusScore;
@@ -148,6 +148,13 @@ export type PerseusNumericInputRubric = {
 export type PerseusNumericInputUserInput = {
     currentValue: string;
 };
+export type PerseusFreeResponseUserInput = {
+    currentValue: string;
+};
+export type PerseusFreeResponseRubric = {
+    question: string;
+    scoringCriteria: ReadonlyArray<PerseusFreeResponseWidgetScoringCriterion>;
+};
 export type PerseusOrdererRubric = PerseusOrdererWidgetOptions;
 export type PerseusOrdererUserInput = {
     current: string[];
@@ -225,6 +232,7 @@ interface UserInputRegistry {
     "cs-program": PerseusCSProgramUserInput;
     dropdown: PerseusDropdownUserInput;
     expression: PerseusExpressionUserInput;
+    "free-response": PerseusFreeResponseUserInput;
     grapher: PerseusGrapherUserInput;
     group: PerseusGroupUserInput;
     iframe: PerseusIFrameUserInput;

package/dist/widgets/free-response/free-response-util.d.ts

@@ -0,0 +1,17 @@
+import type { PerseusFreeResponseWidgetOptions } from "../../data-schema";
+/**
+ * For details on the individual options, see the
+ * {@link PerseusFreeResponseWidgetOptions} type
+ */
+export type FreeResponsePublicWidgetOptions = {
+    allowUnlimitedCharacters: PerseusFreeResponseWidgetOptions["allowUnlimitedCharacters"];
+    characterLimit: PerseusFreeResponseWidgetOptions["characterLimit"];
+    placeholder: PerseusFreeResponseWidgetOptions["placeholder"];
+    question: PerseusFreeResponseWidgetOptions["question"];
+};
+/**
+ * Given a FreeResponsePublicWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+declare function getFreeResponsePublicWidgetOptions(options: PerseusFreeResponseWidgetOptions): FreeResponsePublicWidgetOptions;
+export default getFreeResponsePublicWidgetOptions;

package/dist/widgets/free-response/index.d.ts

@@ -0,0 +1,5 @@
+import type { PerseusFreeResponseWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type FreeResponseDefaultWidgetOptions = Pick<PerseusFreeResponseWidgetOptions, "allowUnlimitedCharacters" | "characterLimit" | "placeholder" | "question" | "scoringCriteria">;
+declare const freeResponseWidgetLogic: WidgetLogic;
+export default freeResponseWidgetLogic;

package/dist/widgets/logic-export.types.d.ts

@@ -2,6 +2,7 @@ import type getCategorizerPublicWidgetOptions from "./categorizer/categorizer-ut
 import type getCSProgramPublicWidgetOptions from "./cs-program/cs-program-util";
 import type getDropdownPublicWidgetOptions from "./dropdown/dropdown-util";
 import type getExpressionPublicWidgetOptions from "./expression/expression-util";
+import type getFreeResponsePublicWidgetOptions from "./free-response/free-response-util";
 import type getGrapherPublicWidgetOptions from "./grapher/grapher-util";
 import type getGroupPublicWidgetOptions from "./group/group-util";
 import type getIFramePublicWidgetOptions from "./iframe/iframe-util";
@@ -28,7 +29,7 @@ export type WidgetOptionsUpgradeMap = {
  * TODO(LEMS-2870): figure out how to make this generic so we don't need to be
  * so reliant on a set group of widgets
  */
-export type PublicWidgetOptionsFunction = typeof getCategorizerPublicWidgetOptions | typeof getCSProgramPublicWidgetOptions | typeof getDropdownPublicWidgetOptions | typeof getExpressionPublicWidgetOptions | typeof getGrapherPublicWidgetOptions | typeof getGroupPublicWidgetOptions | typeof getIFramePublicWidgetOptions | typeof getInputNumberPublicWidgetOptions | typeof getInteractiveGraphPublicWidgetOptions | typeof getLabelImagePublicWidgetOptions | typeof getMatcherPublicWidgetOptions | typeof getMatrixPublicWidgetOptions | typeof getNumberLinePublicWidgetOptions | typeof getNumericInputPublicWidgetOptions | typeof getOrdererPublicWidgetOptions | typeof getPlotterPublicWidgetOptions | typeof getRadioPublicWidgetOptions | typeof getSorterPublicWidgetOptions | typeof getTablePublicWidgetOptions;
+export type PublicWidgetOptionsFunction = typeof getCategorizerPublicWidgetOptions | typeof getCSProgramPublicWidgetOptions | typeof getDropdownPublicWidgetOptions | typeof getExpressionPublicWidgetOptions | typeof getFreeResponsePublicWidgetOptions | typeof getGrapherPublicWidgetOptions | typeof getGroupPublicWidgetOptions | typeof getIFramePublicWidgetOptions | typeof getInputNumberPublicWidgetOptions | typeof getInteractiveGraphPublicWidgetOptions | typeof getLabelImagePublicWidgetOptions | typeof getMatcherPublicWidgetOptions | typeof getMatrixPublicWidgetOptions | typeof getNumberLinePublicWidgetOptions | typeof getNumericInputPublicWidgetOptions | typeof getOrdererPublicWidgetOptions | typeof getPlotterPublicWidgetOptions | typeof getRadioPublicWidgetOptions | typeof getSorterPublicWidgetOptions | typeof getTablePublicWidgetOptions;
 export type WidgetLogic = {
     name: string;
     version?: Version;

package/package.json

@@ -3,7 +3,7 @@
   "description": "Shared Perseus infrastructure",
   "author": "Khan Academy",
   "license": "MIT",
-  "version": "11.0.0",
+  "version": "12.0.0",
   "publishConfig": {
     "access": "public"
   },