@khanacademy/perseus-core 3.2.0 → 3.3.0

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

@@ -0,0 +1,17 @@
+import type { PerseusCategorizerWidgetOptions } from "@khanacademy/perseus-core";
+/**
+ * For details on the individual options, see the
+ * PerseusCategorizerWidgetOptions type
+ */
+type CategorizerPublicWidgetOptions = {
+    items: PerseusCategorizerWidgetOptions["items"];
+    categories: PerseusCategorizerWidgetOptions["categories"];
+    randomizeItems: PerseusCategorizerWidgetOptions["randomizeItems"];
+    static: PerseusCategorizerWidgetOptions["static"];
+};
+/**
+ * Given a PerseusCategorizerWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+declare function getCategorizerPublicWidgetOptions(options: PerseusCategorizerWidgetOptions): CategorizerPublicWidgetOptions;
+export default getCategorizerPublicWidgetOptions;

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

@@ -0,0 +1,5 @@
+import type { PerseusCategorizerWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type CategorizerDefaultWidgetOptions = Pick<PerseusCategorizerWidgetOptions, "items" | "categories" | "values" | "randomizeItems">;
+declare const categorizerWidgetLogic: WidgetLogic;
+export default categorizerWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusCSProgramWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type CSProgramDefaultWidgetOptions = Pick<PerseusCSProgramWidgetOptions, "programID" | "programType" | "settings" | "showEditor" | "showButtons" | "height">;
+declare const csProgramWidgetLogic: WidgetLogic;
+export default csProgramWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusDefinitionWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type DefinitionDefaultWidgetOptions = Pick<PerseusDefinitionWidgetOptions, "togglePrompt" | "definition">;
+declare const definitionWidgetLogic: WidgetLogic;
+export default definitionWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusDropdownWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type DropdownDefaultWidgetOptions = Pick<PerseusDropdownWidgetOptions, "placeholder" | "choices">;
+declare const dropdownWidgetLogic: WidgetLogic;
+export default dropdownWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusExplanationWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type ExplanationDefaultWidgetOptions = Pick<PerseusExplanationWidgetOptions, "showPrompt" | "hidePrompt" | "explanation" | "widgets">;
+declare const explanationWidgetLogic: WidgetLogic;
+export default explanationWidgetLogic;

package/dist/widgets/expression/expression-upgrade.d.ts

@@ -0,0 +1,10 @@
+import type { PerseusExpressionWidgetOptions } from "../../data-schema";
+export declare const currentVersion: {
+    major: number;
+    minor: number;
+};
+export declare const widgetOptionsUpgrades: {
+    readonly "1": (v0options: any) => PerseusExpressionWidgetOptions;
+};
+export type ExpressionDefaultWidgetOptions = Pick<PerseusExpressionWidgetOptions, "answerForms" | "times" | "buttonSets" | "functions">;
+export declare const defaultWidgetOptions: ExpressionDefaultWidgetOptions;

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

@@ -0,0 +1,19 @@
+import type { PerseusExpressionWidgetOptions } from "@khanacademy/perseus-core";
+/**
+ * For details on the individual options, see the
+ * PerseusExpressionWidgetOptions type
+ */
+type ExpressionPublicWidgetOptions = {
+    buttonSets: PerseusExpressionWidgetOptions["buttonSets"];
+    functions: PerseusExpressionWidgetOptions["functions"];
+    times: PerseusExpressionWidgetOptions["times"];
+    visibleLabel?: PerseusExpressionWidgetOptions["visibleLabel"];
+    ariaLabel?: PerseusExpressionWidgetOptions["ariaLabel"];
+    buttonsVisible?: PerseusExpressionWidgetOptions["buttonsVisible"];
+};
+/**
+ * Given a PerseusExpressionWidgetOptions object, return a new object with only
+ * the public options that should be exposed to the client.
+ */
+declare function getExpressionPublicWidgetOptions(options: PerseusExpressionWidgetOptions): ExpressionPublicWidgetOptions;
+export default getExpressionPublicWidgetOptions;

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

@@ -0,0 +1,4 @@
+import type { WidgetLogic } from "../logic-export.types";
+export type { ExpressionDefaultWidgetOptions } from "./expression-upgrade";
+declare const expressionWidgetLogic: WidgetLogic;
+export default expressionWidgetLogic;

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

@@ -0,0 +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;

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

@@ -0,0 +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;

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

@@ -0,0 +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;

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

@@ -0,0 +1,5 @@
+import type { PerseusIFrameWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type IFrameDefaultWidgetOptions = Pick<PerseusIFrameWidgetOptions, "url" | "settings" | "width" | "height" | "allowFullScreen" | "allowTopNavigation">;
+declare const iframeWidgetLogic: WidgetLogic;
+export default iframeWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusImageWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type ImageDefaultWidgetOptions = Pick<PerseusImageWidgetOptions, "title" | "range" | "box" | "backgroundImage" | "labels" | "alt" | "caption">;
+declare const imageWidgetLogic: WidgetLogic;
+export default imageWidgetLogic;

package/dist/widgets/input-number/index.d.ts

@@ -0,0 +1,5 @@
+import type { PerseusInputNumberWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type InputNumberDefaultWidgetOptions = Pick<PerseusInputNumberWidgetOptions, "value" | "simplify" | "size" | "inexact" | "maxError" | "answerType" | "rightAlign">;
+declare const inputNumberWidgetLogic: WidgetLogic;
+export default inputNumberWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusInteractionWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type InteractionDefaultWidgetOptions = Pick<PerseusInteractionWidgetOptions, "graph" | "elements">;
+declare const interactionWidgetLogic: WidgetLogic;
+export default interactionWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusInteractiveGraphWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type InteractiveGraphDefaultWidgetOptions = Pick<PerseusInteractiveGraphWidgetOptions, "labels" | "range" | "step" | "backgroundImage" | "markings" | "showTooltips" | "showProtractor" | "graph" | "correct">;
+declare const interactiveGraphWidgetLogic: WidgetLogic;
+export default interactiveGraphWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusLabelImageWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type LabelImageDefaultWidgetOptions = Pick<PerseusLabelImageWidgetOptions, "choices" | "imageAlt" | "imageUrl" | "imageWidth" | "imageHeight" | "markers" | "multipleAnswers" | "hideChoicesFromInstructions">;
+declare const labelImageWidgetLogic: WidgetLogic;
+export default labelImageWidgetLogic;

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

@@ -0,0 +1,10 @@
+import type { Version } from "../data-schema";
+export type WidgetOptionsUpgradeMap = {
+    [targetMajorVersion: string]: (arg1: any) => any;
+};
+export type WidgetLogic = {
+    name: string;
+    version?: Version;
+    widgetOptionsUpgrades?: WidgetOptionsUpgradeMap;
+    defaultWidgetOptions?: any;
+};

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

@@ -0,0 +1,5 @@
+import type { PerseusMatcherWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type MatcherDefaultWidgetOptions = Pick<PerseusMatcherWidgetOptions, "left" | "right" | "labels" | "orderMatters" | "padding">;
+declare const matcherWidgetLogic: WidgetLogic;
+export default matcherWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusMatrixWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type MatrixDefaultWidgetOptions = Pick<PerseusMatrixWidgetOptions, "matrixBoardSize" | "answers" | "prefix" | "suffix" | "cursorPosition">;
+declare const matrixWidgetLogic: WidgetLogic;
+export default matrixWidgetLogic;

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

@@ -0,0 +1,4 @@
+import type { WidgetLogic } from "../logic-export.types";
+export type { MeasurerDefaultWidgetOptions } from "./measurer-upgrade";
+declare const measurerWidgetLogic: WidgetLogic;
+export default measurerWidgetLogic;

package/dist/widgets/measurer/measurer-upgrade.d.ts

@@ -0,0 +1,10 @@
+import type { PerseusMeasurerWidgetOptions } from "../../data-schema";
+export declare const currentVersion: {
+    major: number;
+    minor: number;
+};
+export declare const widgetOptionsUpgrades: {
+    readonly "1": (v0options: any) => PerseusMeasurerWidgetOptions;
+};
+export type MeasurerDefaultWidgetOptions = Pick<PerseusMeasurerWidgetOptions, "box" | "image" | "showProtractor" | "showRuler" | "rulerLabel" | "rulerTicks" | "rulerPixels" | "rulerLength">;
+export declare const defaultWidgetOptions: MeasurerDefaultWidgetOptions;

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

@@ -0,0 +1,5 @@
+import type { PerseusNumberLineWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type NumberLineDefaultWidgetOptions = Pick<PerseusNumberLineWidgetOptions, "range" | "labelRange" | "labelStyle" | "labelTicks" | "divisionRange" | "numDivisions" | "snapDivisions" | "tickStep" | "correctRel" | "correctX" | "initialX" | "showTooltips">;
+declare const numberLineWidgetLogic: WidgetLogic;
+export default numberLineWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusNumericInputWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type NumericInputDefaultWidgetOptions = Pick<PerseusNumericInputWidgetOptions, "answers" | "size" | "coefficient" | "labelText" | "rightAlign">;
+declare const numericInputWidgetLogic: WidgetLogic;
+export default numericInputWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusOrdererWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type OrdererDefaultWidgetOptions = Pick<PerseusOrdererWidgetOptions, "correctOptions" | "otherOptions" | "height" | "layout">;
+declare const ordererWidgetLogic: WidgetLogic;
+export default ordererWidgetLogic;

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

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

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

@@ -0,0 +1,5 @@
+import type { PerseusPassageWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type PassageDefaultWidgetOptions = Pick<PerseusPassageWidgetOptions, "passageTitle" | "passageText" | "footnotes" | "showLineNumbers">;
+declare const passageWidgetLogic: WidgetLogic;
+export default passageWidgetLogic;

package/dist/widgets/passage-ref/index.d.ts

@@ -0,0 +1,4 @@
+import type { WidgetLogic } from "../logic-export.types";
+export type { PassageRefDefaultWidgetOptions } from "./passage-ref-upgrade";
+declare const passageRefWidgetLogic: WidgetLogic;
+export default passageRefWidgetLogic;

package/dist/widgets/passage-ref/passage-ref-upgrade.d.ts

@@ -0,0 +1,7 @@
+import type { PerseusPassageRefWidgetOptions } from "../../data-schema";
+export declare const currentVersion: {
+    major: number;
+    minor: number;
+};
+export type PassageRefDefaultWidgetOptions = Pick<PerseusPassageRefWidgetOptions, "passageNumber" | "referenceNumber" | "summaryText">;
+export declare const defaultWidgetOptions: PassageRefDefaultWidgetOptions;

package/dist/widgets/passage-ref-target/index.d.ts

@@ -0,0 +1,5 @@
+import type { PerseusPassageRefTargetWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type PassageRefTargetDefaultWidgetOptions = Pick<PerseusPassageRefTargetWidgetOptions, "content">;
+declare const passageRefTargetWidgetLogic: WidgetLogic;
+export default passageRefTargetWidgetLogic;

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

@@ -0,0 +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;

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

@@ -0,0 +1,5 @@
+import type { PerseusPlotterWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type PlotterDefaultWidgetOptions = Pick<PerseusPlotterWidgetOptions, "scaleY" | "maxY" | "snapsPerLine" | "correct" | "starting" | "type" | "labels" | "categories" | "picSize" | "picBoxHeight" | "plotDimensions" | "labelInterval" | "picUrl">;
+declare const plotterWidgetLogic: WidgetLogic;
+export default plotterWidgetLogic;

package/dist/widgets/python-program/index.d.ts

@@ -0,0 +1,5 @@
+import type { PerseusPythonProgramWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type PythonProgramDefaultWidgetOptions = Pick<PerseusPythonProgramWidgetOptions, "programID" | "height">;
+declare const pythonProgramWidgetLogic: WidgetLogic;
+export default pythonProgramWidgetLogic;

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

@@ -0,0 +1,4 @@
+import type { WidgetLogic } from "../logic-export.types";
+export type { RadioDefaultWidgetOptions } from "./radio-upgrade";
+declare const radioWidgetLogic: WidgetLogic;
+export default radioWidgetLogic;

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

@@ -0,0 +1,10 @@
+import type { PerseusRadioWidgetOptions } from "../../data-schema";
+export declare const currentVersion: {
+    major: number;
+    minor: number;
+};
+export declare const widgetOptionsUpgrades: {
+    readonly "1": (v0props: any) => PerseusRadioWidgetOptions;
+};
+export type RadioDefaultWidgetOptions = Pick<PerseusRadioWidgetOptions, "choices" | "displayCount" | "randomize" | "hasNoneOfTheAbove" | "multipleSelect" | "countChoices" | "deselectEnabled">;
+export declare const defaultWidgetOptions: RadioDefaultWidgetOptions;

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

@@ -0,0 +1,5 @@
+import type { PerseusSorterWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type SorterDefaultWidgetOptions = Pick<PerseusSorterWidgetOptions, "correct" | "layout" | "padding">;
+declare const sorterWidgetLogic: WidgetLogic;
+export default sorterWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusTableWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type TableDefaultWidgetOptions = Pick<PerseusTableWidgetOptions, "headers" | "rows" | "columns" | "answers">;
+declare const tableWidgetLogic: WidgetLogic;
+export default tableWidgetLogic;

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

@@ -0,0 +1,5 @@
+import type { PerseusVideoWidgetOptions } from "../../data-schema";
+import type { WidgetLogic } from "../logic-export.types";
+export type VideoDefaultWidgetOptions = Pick<PerseusVideoWidgetOptions, "location">;
+declare const videoWidgetLogic: WidgetLogic;
+export default videoWidgetLogic;

package/package.json

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