@khanacademy/perseus-core 3.4.0 → 3.6.0

package/dist/parse-perseus-json/general-purpose-parsers/index.d.ts

@@ -14,4 +14,3 @@ export * from "./record";
 export * from "./string";
 export * from "./trio";
 export * from "./union";
-export * from "./unknown";

package/dist/parse-perseus-json/general-purpose-parsers/test-helpers.d.ts

@@ -6,3 +6,4 @@ export declare const anyFailure: Failure<any>;
 export declare const anySuccess: import("../result").Success<any>;
 export declare function parseFailureWith(expected: Partial<Mismatch>): Failure<Mismatch[]>;
 export declare function summonParsedValue<P extends Parser<any>>(): ParsedValue<P>;
+export declare function summon<T>(): T;

package/dist/parse-perseus-json/perseus-parsers/legacy-button-sets.d.ts

@@ -0,0 +1,2 @@
+export declare const parseLegacyButtonSet: import("../parser-types").Parser<"basic" | "basic+div" | "trig" | "prealgebra" | "logarithms" | "basic relations" | "advanced relations" | "scientific">;
+export declare const parseLegacyButtonSets: import("../parser-types").Parser<("basic" | "basic+div" | "trig" | "prealgebra" | "logarithms" | "basic relations" | "advanced relations" | "scientific")[] | readonly ["basic", "trig", "prealgebra", "logarithms"]>;

package/dist/parse-perseus-json/perseus-parsers/legacy-button-sets.typetest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/parse-perseus-json/result.d.ts

@@ -13,4 +13,11 @@ export declare function isFailure<S, F>(result: Result<S, F>): result is Failure
 export declare function isSuccess<S, F>(result: Result<S, F>): result is Success<S>;
 export declare function assertFailure<S, F>(result: Result<S, F>): asserts result is Failure<F>;
 export declare function assertSuccess<S, F>(result: Result<S, F>): asserts result is Success<S>;
+/**
+ * @returns a function that transforms the `detail` value of any Failure result
+ * passed to it, and leaves Success results unchanged. `mapFailure` is curried
+ * for easy composition with Array.map(), mu-lambda's pipe(), etc.
+ * @param f the function to apply to Failure `detail`s.
+ */
+export declare function mapFailure<S, DetailIn, DetailOut>(f: (detail: DetailIn) => DetailOut): (result: Result<S, DetailIn>) => Result<S, DetailOut>;
 export declare function all<S, F>(results: Array<Result<S, F>>, combineFailureDetails?: (a: F, b: F) => F): Result<S[], F>;

package/dist/utils/split-perseus-item.d.ts

@@ -0,0 +1,2 @@
+import type { PerseusRenderer } from "../data-schema";
+export default function splitPerseusItem(originalItem: PerseusRenderer): PerseusRenderer;

package/dist/widgets/core-widget-registry.d.ts

@@ -1,6 +1,8 @@
+import type { PublicWidgetOptionsFunction } from "./logic-export.types";
 import type { Alignment } from "../types";
 export declare function isWidgetRegistered(type: string): boolean;
 export declare function getCurrentVersion(type: string): any;
+export declare const getPublicWidgetOptionsFunction: (name: string) => PublicWidgetOptionsFunction;
 export declare function getWidgetOptionsUpgrades(type: string): any;
 export declare function getDefaultWidgetOptions(type: string): any;
 /**

package/dist/widgets/grapher/grapher-util.d.ts

@@ -0,0 +1,4 @@
+import type { PerseusGrapherWidgetOptions } from "../../data-schema";
+type GrapherPublicWidgetOptions = Pick<PerseusGrapherWidgetOptions, "availableTypes" | "graph">;
+export default function getGrapherPublicWidgetOptions(options: PerseusGrapherWidgetOptions): GrapherPublicWidgetOptions;
+export {};

package/dist/widgets/iframe/iframe-util.d.ts

@@ -0,0 +1,2 @@
+import type { PerseusIFrameWidgetOptions } from "../../data-schema";
+export default function getIFramePublicWidgetOptions(options: PerseusIFrameWidgetOptions): PerseusIFrameWidgetOptions;

package/dist/widgets/interactive-graph/interactive-graph-util.d.ts

@@ -0,0 +1,4 @@
+import type { PerseusInteractiveGraphWidgetOptions } from "@khanacademy/perseus-core";
+type InteractiveGraphPublicWidgetOptions = Pick<PerseusInteractiveGraphWidgetOptions, "step" | "gridStep" | "snapStep" | "backgroundImage" | "markings" | "labels" | "showProtractor" | "showRuler" | "showTooltips" | "rulerLabel" | "rulerTicks" | "range" | "graph" | "lockedFigures" | "fullGraphAriaLabel" | "fullGraphAriaDescription">;
+export default function getInteractiveGraphPublicWidgetOptions(options: PerseusInteractiveGraphWidgetOptions): InteractiveGraphPublicWidgetOptions;
+export {};

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

@@ -1,8 +1,31 @@
+import type getCategorizerPublicWidgetOptions from "./categorizer/categorizer-util";
+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 getGrapherPublicWidgetOptions from "./grapher/grapher-util";
+import type getIFramePublicWidgetOptions from "./iframe/iframe-util";
+import type getInteractiveGraphPublicWidgetOptions from "./interactive-graph/interactive-graph-util";
+import type getLabelImagePublicWidgetOptions from "./label-image/label-image-util";
+import type getMatrixPublicWidgetOptions from "./matrix/matrix-util";
+import type getNumberLinePublicWidgetOptions from "./number-line/number-line-util";
+import type getNumericInputPublicWidgetOptions from "./numeric-input/numeric-input-util";
+import type getOrdererPublicWidgetOptions from "./orderer/orderer-util";
+import type getPlotterPublicWidgetOptions from "./plotter/plotter-util";
+import type getRadioPublicWidgetOptions from "./radio/radio-util";
+import type getSorterPublicWidgetOptions from "./sorter/sorter-util";
+import type getTablePublicWidgetOptions from "./table/table-util";
 import type { Version } from "../data-schema";
 import type { Alignment } from "../types";
 export type WidgetOptionsUpgradeMap = {
     [targetMajorVersion: string]: (arg1: any) => any;
 };
+/**
+ * A union type of all the functions that provide public widget options.
+ *
+ * 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 getPlotterPublicWidgetOptions | typeof getIFramePublicWidgetOptions | typeof getRadioPublicWidgetOptions | typeof getNumericInputPublicWidgetOptions | typeof getDropdownPublicWidgetOptions | typeof getCategorizerPublicWidgetOptions | typeof getOrdererPublicWidgetOptions | typeof getExpressionPublicWidgetOptions | typeof getInteractiveGraphPublicWidgetOptions | typeof getLabelImagePublicWidgetOptions | typeof getSorterPublicWidgetOptions | typeof getCSProgramPublicWidgetOptions | typeof getNumberLinePublicWidgetOptions | typeof getTablePublicWidgetOptions | typeof getGrapherPublicWidgetOptions | typeof getMatrixPublicWidgetOptions;
 export type WidgetLogic = {
     name: string;
     version?: Version;
@@ -10,4 +33,9 @@ export type WidgetLogic = {
     defaultWidgetOptions?: any;
     supportedAlignments?: ReadonlyArray<Alignment>;
     defaultAlignment?: Alignment;
+    /**
+     * A function that provides a public version of the widget options that can
+     * be shared with the client.
+     */
+    getPublicWidgetOptions?: PublicWidgetOptionsFunction;
 };

package/dist/widgets/matrix/matrix-util.d.ts

@@ -0,0 +1,4 @@
+import type { PerseusMatrixWidgetOptions } from "@khanacademy/perseus-core";
+type MatrixPublicWidgetOptions = Pick<PerseusMatrixWidgetOptions, "prefix" | "suffix" | "cursorPosition" | "matrixBoardSize" | "static">;
+export default function getMatrixPublicWidgetOptions(options: PerseusMatrixWidgetOptions): MatrixPublicWidgetOptions;
+export {};

package/dist/widgets/plotter/plotter-util.d.ts

@@ -0,0 +1,12 @@
+import type { PerseusPlotterWidgetOptions } from "@khanacademy/perseus-core";
+/**
+ * For details on the individual options, see the
+ * PerseusPlotterWidgetOptions type
+ */
+type PlotterPublicWidgetOptions = Omit<PerseusPlotterWidgetOptions, "correct">;
+/**
+ * Given a PerseusPlotterWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+declare function getPlotterPublicWidgetOptions(options: PerseusPlotterWidgetOptions): PlotterPublicWidgetOptions;
+export default getPlotterPublicWidgetOptions;

package/dist/widgets/radio/radio-util.d.ts

@@ -0,0 +1,26 @@
+import type { PerseusRadioChoice, PerseusRadioWidgetOptions } from "@khanacademy/perseus-core";
+/**
+ * For details on the individual options, see the
+ * PerseusRadioWidgetOptions type
+ */
+type RadioPublicWidgetOptions = {
+    choices: ReadonlyArray<RadioChoicePublicData>;
+    hasNoneOfTheAbove?: PerseusRadioWidgetOptions["hasNoneOfTheAbove"];
+    countChoices?: PerseusRadioWidgetOptions["countChoices"];
+    randomize?: PerseusRadioWidgetOptions["randomize"];
+    multipleSelect?: PerseusRadioWidgetOptions["multipleSelect"];
+    deselectEnabled?: PerseusRadioWidgetOptions["deselectEnabled"];
+    onePerLine?: PerseusRadioWidgetOptions["onePerLine"];
+    displayCount?: PerseusRadioWidgetOptions["displayCount"];
+    noneOfTheAbove?: PerseusRadioWidgetOptions["noneOfTheAbove"];
+};
+/**
+ * Only the options from each Radio choice that should be exposed to the client.
+ */
+type RadioChoicePublicData = Pick<PerseusRadioChoice, "content" | "isNoneOfTheAbove" | "widgets">;
+/**
+ * Given a PerseusRadioWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+declare function getRadioPublicWidgetOptions(options: PerseusRadioWidgetOptions): RadioPublicWidgetOptions;
+export default getRadioPublicWidgetOptions;

package/dist/widgets/table/table-util.d.ts

@@ -0,0 +1,4 @@
+import type { PerseusTableWidgetOptions } from "@khanacademy/perseus-core";
+type TablePublicWidgetOptions = Pick<PerseusTableWidgetOptions, "headers" | "rows" | "columns">;
+export default function getTablePublicWidgetOptions(options: PerseusTableWidgetOptions): TablePublicWidgetOptions;
+export {};

package/package.json

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

package/dist/parse-perseus-json/general-purpose-parsers/unknown.d.ts

@@ -1,2 +0,0 @@
-import type { Parser } from "../parser-types";
-export declare const unknown: Parser<unknown>;