@khanacademy/perseus-core 3.3.0 → 3.4.0

package/dist/types.d.ts

@@ -29,4 +29,5 @@ export type InteractiveMarkerType = MarkerType & {
     focused?: boolean;
 };
 export type Relationship = "lt" | "gt" | "le" | "ge";
+export type Alignment = "default" | "block" | "inline-block" | "inline" | "float-left" | "float-right" | "full-width";
 export {};

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

@@ -0,0 +1,28 @@
+import type { Alignment } from "../types";
+export declare function isWidgetRegistered(type: string): boolean;
+export declare function getCurrentVersion(type: string): any;
+export declare function getWidgetOptionsUpgrades(type: string): any;
+export declare function getDefaultWidgetOptions(type: string): any;
+/**
+ * Handling for the optional alignments for widgets
+ * See widget-container.jsx for details on how alignments are implemented.
+ */
+/**
+ * Returns the list of supported alignments for the given (string) widget
+ * type. This is used primarily at editing time to display the choices
+ * for the user.
+ *
+ * Supported alignments are given as an array of strings in the exports of
+ * a widget's module.
+ */
+export declare const getSupportedAlignments: (type: string) => ReadonlyArray<Alignment>;
+/**
+ * For the given (string) widget type, determine the default alignment for
+ * the widget. This is used at rendering time to go from "default" alignment
+ * to the actual alignment displayed on the screen.
+ *
+ * The default alignment is given either as a string (called
+ * `defaultAlignment`) or a function (called `getDefaultAlignment`) on
+ * the exports of a widget's module.
+ */
+export declare const getDefaultAlignment: (type: string) => Alignment;

package/dist/widgets/cs-program/cs-program-util.d.ts

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

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

@@ -0,0 +1,20 @@
+import type { PerseusDropdownWidgetOptions } from "@khanacademy/perseus-core";
+/**
+ * For details on the individual options, see the
+ * PerseusDropdownWidgetOptions type
+ */
+type DropdownPublicWidgetOptions = {
+    choices: ReadonlyArray<{
+        content: string;
+    }>;
+    placeholder: PerseusDropdownWidgetOptions["placeholder"];
+    static: PerseusDropdownWidgetOptions["static"];
+    visibleLabel?: PerseusDropdownWidgetOptions["visibleLabel"];
+    ariaLabel?: PerseusDropdownWidgetOptions["ariaLabel"];
+};
+/**
+ * Given a PerseusDropdownWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+declare function getDropdownPublicWidgetOptions(options: PerseusDropdownWidgetOptions): DropdownPublicWidgetOptions;
+export default getDropdownPublicWidgetOptions;

package/dist/widgets/graded-group/index.d.ts

@@ -1,5 +1,5 @@
 import type { PerseusGradedGroupWidgetOptions } from "../../data-schema";
 import type { WidgetLogic } from "../logic-export.types";
 export type GradedGroupDefaultWidgetOptions = Pick<PerseusGradedGroupWidgetOptions, "title" | "content" | "widgets" | "images" | "hint">;
-declare const GradedGroupWidgetLogic: WidgetLogic;
-export default GradedGroupWidgetLogic;
+declare const gradedGroupWidgetLogic: WidgetLogic;
+export default gradedGroupWidgetLogic;

package/dist/widgets/graded-group-set/index.d.ts

@@ -1,5 +1,5 @@
 import type { PerseusGradedGroupSetWidgetOptions } from "../../data-schema";
 import type { WidgetLogic } from "../logic-export.types";
 export type GradedGroupSetDefaultWidgetOptions = Pick<PerseusGradedGroupSetWidgetOptions, "gradedGroups">;
-declare const GradedGroupSetWidgetLogic: WidgetLogic;
-export default GradedGroupSetWidgetLogic;
+declare const gradedGroupSetWidgetLogic: WidgetLogic;
+export default gradedGroupSetWidgetLogic;

package/dist/widgets/grapher/index.d.ts

@@ -0,0 +1,5 @@
+import type { PerseusGrapherWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type GrapherDefaultWidgetOptions = Pick<PerseusGrapherWidgetOptions, "graph" | "correct" | "availableTypes">;
+declare const grapherWidgetLogic: WidgetLogic;
+export default grapherWidgetLogic;

package/dist/widgets/group/index.d.ts

@@ -1,5 +1,5 @@
 import type { PerseusGroupWidgetOptions } from "../../data-schema";
 import type { WidgetLogic } from "../logic-export.types";
 export type GroupDefaultWidgetOptions = Pick<PerseusGroupWidgetOptions, "content" | "widgets" | "images" | "metadata">;
-declare const GroupWidgetLogic: WidgetLogic;
-export default GroupWidgetLogic;
+declare const groupWidgetLogic: WidgetLogic;
+export default groupWidgetLogic;

package/dist/widgets/label-image/label-image-util.d.ts

@@ -0,0 +1,19 @@
+import type { PerseusLabelImageMarker, PerseusLabelImageWidgetOptions } from "@khanacademy/perseus-core";
+/**
+ * For details on the individual options, see the
+ * PerseusLabelImageWidgetOptions type
+ */
+type LabelImagePublicWidgetOptions = {
+    choices: PerseusLabelImageWidgetOptions["choices"];
+    imageUrl: PerseusLabelImageWidgetOptions["imageUrl"];
+    imageAlt: PerseusLabelImageWidgetOptions["imageAlt"];
+    imageHeight: PerseusLabelImageWidgetOptions["imageHeight"];
+    imageWidth: PerseusLabelImageWidgetOptions["imageWidth"];
+    markers: ReadonlyArray<LabelImageMarkerPublicData>;
+    hideChoicesFromInstructions: PerseusLabelImageWidgetOptions["hideChoicesFromInstructions"];
+    multipleAnswers: PerseusLabelImageWidgetOptions["multipleAnswers"];
+    static: PerseusLabelImageWidgetOptions["static"];
+};
+type LabelImageMarkerPublicData = Pick<PerseusLabelImageMarker, "x" | "y" | "label">;
+export default function getLabelImagePublicWidgetOptions(options: PerseusLabelImageWidgetOptions): LabelImagePublicWidgetOptions;
+export {};

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

@@ -1,4 +1,5 @@
 import type { Version } from "../data-schema";
+import type { Alignment } from "../types";
 export type WidgetOptionsUpgradeMap = {
     [targetMajorVersion: string]: (arg1: any) => any;
 };
@@ -7,4 +8,6 @@ export type WidgetLogic = {
     version?: Version;
     widgetOptionsUpgrades?: WidgetOptionsUpgradeMap;
     defaultWidgetOptions?: any;
+    supportedAlignments?: ReadonlyArray<Alignment>;
+    defaultAlignment?: Alignment;
 };

package/dist/widgets/number-line/number-line-util.d.ts

@@ -0,0 +1,4 @@
+import type { PerseusNumberLineWidgetOptions } from "../../data-schema";
+type NumberLinePublicWidgetOptions = Pick<PerseusNumberLineWidgetOptions, "range" | "labelRange" | "labelStyle" | "labelTicks" | "isTickCtrl" | "divisionRange" | "numDivisions" | "snapDivisions" | "tickStep" | "initialX" | "showTooltips" | "static">;
+export default function getNumberLinePublicWidgetOptions(options: PerseusNumberLineWidgetOptions): NumberLinePublicWidgetOptions;
+export {};

package/dist/widgets/numeric-input/numeric-input-util.d.ts

@@ -0,0 +1,19 @@
+import type { PerseusNumericInputWidgetOptions } from "@khanacademy/perseus-core";
+/**
+ * For details on the individual options, see the
+ * PerseusNumericInputWidgetOptions type
+ */
+type NumericInputPublicWidgetOptions = {
+    labelText?: PerseusNumericInputWidgetOptions["labelText"];
+    size: PerseusNumericInputWidgetOptions["size"];
+    coefficient: PerseusNumericInputWidgetOptions["coefficient"];
+    rightAlign?: PerseusNumericInputWidgetOptions["rightAlign"];
+    static: PerseusNumericInputWidgetOptions["static"];
+    answerForms?: PerseusNumericInputWidgetOptions["answerForms"];
+};
+/**
+ * Given a PerseusNumericInputWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+declare function getNumericInputPublicWidgetOptions(options: PerseusNumericInputWidgetOptions): NumericInputPublicWidgetOptions;
+export default getNumericInputPublicWidgetOptions;

package/dist/widgets/phet-simulation/index.d.ts

@@ -1,5 +1,5 @@
 import type { PerseusPhetSimulationWidgetOptions } from "../../data-schema";
 import type { WidgetLogic } from "../logic-export.types";
 export type PhetSimulationDefaultWidgetOptions = Pick<PerseusPhetSimulationWidgetOptions, "url" | "description">;
-declare const PhetSimulationWidgetLogic: WidgetLogic;
-export default PhetSimulationWidgetLogic;
+declare const phetSimulationWidgetLogic: WidgetLogic;
+export default phetSimulationWidgetLogic;

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

@@ -0,0 +1,16 @@
+import type { PerseusSorterWidgetOptions } from "@khanacademy/perseus-core";
+/**
+ * For details on the individual options, see the
+ * PerseusSorterWidgetOptions type
+ */
+type SorterPublicWidgetOptions = {
+    correct: PerseusSorterWidgetOptions["correct"];
+    padding: PerseusSorterWidgetOptions["padding"];
+    layout: PerseusSorterWidgetOptions["layout"];
+};
+/**
+ * Given a PerseusSorterWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+declare function getSorterPublicWidgetOptions(options: PerseusSorterWidgetOptions): SorterPublicWidgetOptions;
+export default getSorterPublicWidgetOptions;

package/dist/widgets/upgrade.d.ts

@@ -0,0 +1,3 @@
+import type { PerseusWidget, PerseusWidgetsMap } from "../data-schema";
+export declare const upgradeWidgetInfoToLatestVersion: (oldWidgetInfo: PerseusWidget) => PerseusWidget;
+export declare function getUpgradedWidgetOptions(oldWidgetOptions: PerseusWidgetsMap): PerseusWidgetsMap;

package/package.json

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