@pie-element/explicit-constructed-response 12.0.4-next.20261011174919 → 12.0.4

package/dist/controller/defaults.d.ts

@@ -1,17 +1,18 @@
+import type { Choices } from '../types.js';
 declare const _default: {
-    choices: {};
+    choices: Choices;
     displayType: string;
     markup: string;
-    maxLengthPerChoiceEnabled: boolean;
-    playerSpellCheckEnabled: boolean;
+    maxLengthPerChoiceEnabled: true;
+    playerSpellCheckEnabled: false;
     prompt: string;
-    promptEnabled: boolean;
+    promptEnabled: true;
     rationale: string;
-    rationaleEnabled: boolean;
-    spellCheckEnabled: boolean;
-    studentInstructionsEnabled: boolean;
+    rationaleEnabled: true;
+    spellCheckEnabled: true;
+    studentInstructionsEnabled: true;
     teacherInstructions: string;
-    teacherInstructionsEnabled: boolean;
-    toolbarEditorPosition: string;
+    teacherInstructionsEnabled: true;
+    toolbarEditorPosition: "bottom";
 };
 export default _default;

package/dist/controller/index.d.ts

@@ -1,37 +1,91 @@
-export declare const prepareChoice: (mode: any, defaultFeedback: any) => (choice: any) => {
-    label: any;
-    value: any;
+import type { PieEnvironment } from '@pie-element/shared-types';
+import type { Choice, Choices, ExplicitConstructedResponseConfiguration, ExplicitConstructedResponseModel, ExplicitConstructedResponseSession } from '../types.js';
+/** Errors `validate()` reports, keyed by field. */
+export type ExplicitConstructedResponseValidationErrors = {
+    teacherInstructions?: string;
+    prompt?: string;
+    rationale?: string;
+    responseAreas?: string;
+    /** Per response area index, the error for each choice, keyed by the choice's `value` */
+    choices?: Record<string, Record<string, string>>;
+};
+/** A choice as the controller hands it to the delivery */
+type PreparedChoice = {
+    label: string;
+    value: string;
+    correct?: boolean;
+    feedback?: string;
+};
+type DefaultFeedback = {
+    correct: string;
+    incorrect: string;
+};
+export declare const prepareChoice: (mode: PieEnvironment["mode"], defaultFeedback: DefaultFeedback) => (choice: Choice) => PreparedChoice;
+export declare const normalize: (question: ExplicitConstructedResponseModel) => {
+    choices: Choices;
+    displayType: string;
+    markup: string;
+    slateMarkup?: string;
+    prompt: string;
+    promptEnabled: boolean;
+    spellCheckEnabled: boolean;
+    playerSpellCheckEnabled: boolean;
+    rationale: string;
+    autoScoring?: "allOrNothing" | "partial";
+    partialScoring?: boolean;
+    studentInstructions?: string;
+    teacherInstructions: string;
+    rubric?: string;
+    rationaleEnabled: boolean;
+    studentInstructionsEnabled: boolean;
+    teacherInstructionsEnabled: boolean;
+    note?: string;
+    toolbarEditorPosition: "bottom" | "top";
+    maxLengthPerChoice?: number[];
+    maxLengthPerChoiceEnabled: boolean;
+    rubricEnabled?: boolean;
+    language?: string;
+    spanishInputEnabled?: boolean;
+    responseAreaInputConfiguration?: import("@pie-element/shared-types").EditableHtmlConfigureProp;
+    defaultFeedback?: {
+        correct?: string;
+        incorrect?: string;
+    };
+    extraCSSRules?: import("@pie-element/shared-types").ExtraCSSRules;
+    disabled?: boolean;
+    id: string;
+    element: string;
+    accessibilityCatalogs?: import("@pie-element/shared-types").AccessibilityCatalog[];
 };
-export declare const normalize: (question: any) => any;
 /**
  *
  * @param {*} question
  * @param {*} session
  * @param {*} env
  */
-export declare function model(question: any, session: any, env: any): Promise<{
-    choices: {};
+export declare function model(question: ExplicitConstructedResponseModel, session: ExplicitConstructedResponseSession | undefined, env: PieEnvironment): Promise<{
+    choices: Record<string, PreparedChoice[]>;
     disabled: boolean;
-    displayType: any;
-    mode: any;
-    role: any;
-    feedback: {};
-    language: any;
-    markup: any;
-    maxLengthPerChoice: any;
-    maxLengthPerChoiceEnabled: any;
-    note: any;
+    displayType: string;
+    mode: "gather" | "view" | "evaluate";
+    role: "student" | "instructor";
+    feedback: Record<string, "correct" | "incorrect">;
+    language: string | undefined;
+    markup: string;
+    maxLengthPerChoice: number[];
+    maxLengthPerChoiceEnabled: boolean;
+    note: string;
     playerSpellCheckEnabled: boolean;
-    prompt: any;
+    prompt: string;
     rationale: string;
     responseCorrect: boolean | undefined;
     showNote: boolean;
     teacherInstructions: string;
-    responseAreaInputConfiguration: any;
-    extraCSSRules: any;
+    responseAreaInputConfiguration: import("@pie-element/shared-types").EditableHtmlConfigureProp | undefined;
+    extraCSSRules: import("@pie-element/shared-types").ExtraCSSRules | undefined;
 }>;
-export declare const prepareVal: (html: any) => any;
-export declare const getScore: (config: any, session: any) => number;
+export declare const prepareVal: (html: string | undefined) => string;
+export declare const getScore: (config: Pick<ExplicitConstructedResponseModel, "choices" | "markup">, session: ExplicitConstructedResponseSession | undefined) => number;
 /**
 * Generates detailed trace log for scoring evaluation
 * @param {Object} model - the question model
@@ -39,7 +93,7 @@ export declare const getScore: (config: any, session: any) => number;
 * @param {Object} env - the environment
 * @returns {Array} traceLog - array of trace messages
 */
-export declare const getLogTrace: (model: any, session: any, env: any) => string[];
+export declare const getLogTrace: (model: ExplicitConstructedResponseModel, session: ExplicitConstructedResponseSession | undefined, env: Partial<PieEnvironment>) => string[];
 /**
  * The score is partial by default for checkbox mode, allOrNothing for radio mode.
  * To disable partial scoring for checkbox mode you either set model.partialScoring = false or env.partialScoring =
@@ -51,6 +105,11 @@ export declare const getLogTrace: (model: any, session: any, env: any) => string
  * @param {boolean} env.partialScoring - is partial scoring enabled (if undefined default to true) This overrides
  *   `model.partialScoring`.
  */
-export declare function outcome(model: any, session: any, env?: {}): Promise<unknown>;
-export declare const createCorrectResponseSession: (question: any, env: any) => Promise<unknown>;
-export declare const validate: (model?: {}, config?: {}) => {};
+export declare function outcome(model: ExplicitConstructedResponseModel, session: ExplicitConstructedResponseSession | undefined, env?: Partial<PieEnvironment>): Promise<{
+    score: number;
+    empty: boolean;
+    traceLog: string[];
+}>;
+export declare const createCorrectResponseSession: (question: ExplicitConstructedResponseModel, env: PieEnvironment) => Promise<ExplicitConstructedResponseSession | null>;
+export declare const validate: (model?: Partial<ExplicitConstructedResponseModel>, config?: ExplicitConstructedResponseConfiguration) => ExplicitConstructedResponseValidationErrors;
+export {};

package/dist/controller/index.js

@@ -13,7 +13,7 @@ var l = e(), { translator: u } = o, d = s("explicit-constructed-response:control
 	if (e === "evaluate") {
 		r.correct = !0;
 		let e = n.feedback && n.feedback.type || "none";
-		e === "default" ? r.feedback = t.correct : e === "custom" && (r.feedback = n.feedback.value);
+		e === "default" ? r.feedback = t.correct : e === "custom" && (r.feedback = n.feedback?.value);
 	}
 	return r;
 }, p = (e) => e ? "correct" : "incorrect", m = (e) => Math.abs(e) === Infinity ? 2 : e <= 2 ? e + 2 : e <= 4 ? e + 3 : e <= 6 ? e + 4 : e + 5, h = (e) => e ? e.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&quot;/g, "\"").replace(/&#x27;|&#39;/g, "'").replace(/&amp;/g, "&") : "", g = (e) => ({
@@ -67,12 +67,12 @@ var v = (e) => w(C(e).trim()), y = (e, t) => {
 	let o = e.markup && e.markup.match(/\{\{(.+?)\}\}/g), s = o ? o.length : 0, c = a(e.choices, (e, t, a) => {
 		let o = i && i[a];
 		return r(o) || !n(t, (e) => v(e.label) === v(o)) ? e : e + 1;
-	}, 0), l = s ? (c / s).toFixed(2) : 0;
+	}, 0), l = s ? (c / s).toFixed(2) : "0";
 	return parseFloat(l);
 }, b = (e, t, n) => {
 	let i = [], { value: a } = t || {}, { choices: o, markup: s } = e || {}, l = s ? s.match(/\{\{(.+?)\}\}/g) : [], u = l ? l.length : 0;
 	if (i.push(`${u} response area(s) defined in this question.`), a && Object.keys(a).length > 0) {
-		let e = Object.entries(a).filter(([e, t]) => t && t.trim()).length;
+		let e = Object.entries(a).filter(([, e]) => e && e.trim()).length;
 		i.push(`Student filled ${e} out of ${u} response area(s).`), Object.keys(o || {}).forEach((e) => {
 			let t = a && a[e] || "", n = o[e] || [], s = !r(t.trim()) && n.some((e) => v(e.label) === v(t));
 			t.trim() ? i.push(`Response area ${parseInt(e) + 1}: ${s ? "CORRECT" : "INCORRECT"}.`) : i.push(`Response area ${parseInt(e) + 1}: left empty.`);
@@ -133,7 +133,7 @@ var S = (e, t) => new Promise((n) => {
 		}), r(i) || (o[e] = i);
 	});
 	let c = (i.match(/\{\{(\d+)\}\}/g) || []).length;
-	return c > a ? s.responseAreas = `No more than ${a} response areas should be defined.` : c < 1 && (s.responseAreas = "There should be at least 1 response area defined."), r(o) || (s.choices = o), s;
+	return a !== void 0 && c > a ? s.responseAreas = `No more than ${a} response areas should be defined.` : c < 1 && (s.responseAreas = "There should be at least 1 response area defined."), r(o) || (s.choices = o), s;
 };
 //#endregion
 export { S as createCorrectResponseSession, b as getLogTrace, y as getScore, _ as model, g as normalize, x as outcome, f as prepareChoice, v as prepareVal, E as validate };

package/dist/index.d.ts

@@ -1 +1,2 @@
 export { default } from './delivery/index.js';
+export type * from './types.js';

package/dist/schemas/configuration.schema.json

@@ -0,0 +1,426 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://cdn.jsdelivr.net/npm/@pie-element/explicit-constructed-response@12.0.4/dist/schemas/configuration.schema.json",
+  "type": "object",
+  "properties": {
+    "baseInputConfiguration": {
+      "$ref": "#/definitions/EditableHtmlConfigureProp",
+      "description": "Base editable html input configuration regarding plugins that are enabled/disabled E.g. audio, video, image"
+    },
+    "choices": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Not read by this element"
+    },
+    "prompt": {
+      "$ref": "#/definitions/EditableHtmlPluginConfigureRequired",
+      "description": "Item Stem configuration"
+    },
+    "rationale": {
+      "$ref": "#/definitions/EditableHtmlPluginConfigureRequired",
+      "description": "Rationale configuration"
+    },
+    "settingsPanelDisabled": {
+      "type": "boolean",
+      "description": "Indicates if the settings panel is not available"
+    },
+    "spellCheck": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Configuration for the author's spellcheck; `enabled` is not read"
+    },
+    "playerSpellCheck": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Configuration for the player's spellcheck; `enabled` is not read"
+    },
+    "editSource": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Settings Panel control for editing the source; the control writes `enabled`, which is not read"
+    },
+    "partialScoring": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Settings Panel control for partial scoring"
+    },
+    "autoScoring": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Not read by this element: `partialScoring` shows the scoring control"
+    },
+    "studentInstructions": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Not read by this element"
+    },
+    "teacherInstructions": {
+      "$ref": "#/definitions/EditableHtmlPluginConfigureRequired",
+      "description": "Teacher Instructions configuration"
+    },
+    "template": {
+      "$ref": "#/definitions/EditableHtmlPluginConfigure",
+      "description": "Template configuration"
+    },
+    "rubric": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Not read by this element: `withRubric` shows the rubric control"
+    },
+    "alternates": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Not read by this element"
+    },
+    "maxLengthPerChoice": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Maximum Length Per Choice Configuration: the settings panel control for `maxLengthPerChoiceEnabled`"
+    },
+    "maxResponseAreas": {
+      "type": "number",
+      "description": "Maximum number of response areas"
+    },
+    "maxImageWidth": {
+      "$ref": "#/definitions/ConfigureMaxImageDimensionsProp",
+      "description": "Maximum image width for input fields"
+    },
+    "maxImageHeight": {
+      "$ref": "#/definitions/ConfigureMaxImageDimensionsProp",
+      "description": "Maximum image height for input fields"
+    },
+    "withRubric": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Rubric configuration - only relevant in environments that use pie-player-components"
+    },
+    "mathMlOptions": {
+      "$ref": "#/definitions/ConfigureMathMLProp",
+      "description": "Configuration for editable-html"
+    },
+    "language": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Language configuration"
+    },
+    "languageChoices": {
+      "$ref": "#/definitions/ConfigureLanguageOptions",
+      "description": "Language choices configuration Only available if language is enabled"
+    },
+    "spanishInput": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Not read by this element: `spanishButton` shows the Spanish characters control"
+    },
+    "spanishButton": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Settings Panel control that disables the Spanish characters in the response areas' inputs"
+    },
+    "responseAreaInputConfiguration": {
+      "$ref": "#/definitions/EditableHtmlPluginConfigure",
+      "description": "Toolbar plugins of the response areas' inputs, under `inputConfiguration`"
+    },
+    "contentDimensions": {
+      "$ref": "#/definitions/ContentDimensions",
+      "description": "Dimensions of the authoring container"
+    },
+    "showPrompt": {
+      "type": "boolean",
+      "description": "Not read by this element: the model's `promptEnabled` shows the prompt"
+    },
+    "promptLabel": {
+      "type": "string",
+      "description": "Not read by this element: `prompt.label` labels the prompt"
+    },
+    "settingsPartialScoring": {
+      "type": "boolean",
+      "description": "Not read by this element: `partialScoring.settings` shows the partial scoring control"
+    }
+  },
+  "description": "Config Object for `@pie-element/explicit-constructed-response`",
+  "definitions": {
+    "EditableHtmlConfigureProp": {
+      "type": "object",
+      "properties": {
+        "math": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "audio": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "video": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "image": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "customPlugins": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CustomPlugin"
+          },
+          "description": "An array of objects that determine custom plugins. A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when the button gets pressed (event)."
+        },
+        "blockquote": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "h3": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "characters": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "bold": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "html": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "italic": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "ol_list": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "redo": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "strikethrough": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "sub": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "sup": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "table": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "ul_list": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "underline": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "undo": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "textAlign": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "showParagraphs": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "separateParagraphs": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "pasteFormatting": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "superscript": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "subscript": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "languageCharacters": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "responseArea": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        }
+      },
+      "description": "Toolbar plugins of an editable-html field, keyed by plugin name."
+    },
+    "EditableHtmlButtonConfigure": {
+      "type": "object",
+      "properties": {
+        "disabled": {
+          "type": "boolean",
+          "description": "Indicates if the plugin is disabled or not"
+        }
+      }
+    },
+    "CustomPlugin": {
+      "type": "object",
+      "properties": {
+        "event": {
+          "type": "string",
+          "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used). The event is emitted with the \"PIE-\" prefix."
+        },
+        "iconAlt": {
+          "type": "string",
+          "description": "The alt for the custom button icon"
+        },
+        "iconType": {
+          "type": "string",
+          "description": "The icon type. Currently, only \"SVG\" is supported."
+        },
+        "icon": {
+          "type": "string",
+          "description": "The icon string. Currently, only SVG is supported, so it needs to be a valid svg."
+        }
+      },
+      "required": [
+        "event",
+        "iconAlt",
+        "iconType",
+        "icon"
+      ]
+    },
+    "ConfigureProp": {
+      "type": "object",
+      "properties": {
+        "settings": {
+          "type": "boolean",
+          "description": "Indicates if the item has to be displayed in the Settings Panel"
+        },
+        "label": {
+          "type": "string",
+          "description": "Indicates the label for the item that has to be displayed in the Settings Panel"
+        }
+      },
+      "description": "Building blocks of an element's authoring configuration: the object a host passes to the `<tag>-config` custom element to decide which settings the author sees and how editors behave.\n\nEach element declares its own `<Name>Configuration` interface from these, and its JSON Schema is generated from that interface. Descriptions are carried over from the legacy `pie-elements` config schemas, so they appear in the generated schemas unchanged."
+    },
+    "EditableHtmlPluginConfigureRequired": {
+      "type": "object",
+      "properties": {
+        "settings": {
+          "type": "boolean",
+          "description": "Indicates if the item has to be displayed in the Settings Panel"
+        },
+        "label": {
+          "type": "string",
+          "description": "Indicates the label for the item that has to be displayed in the Settings Panel"
+        },
+        "inputConfiguration": {
+          "$ref": "#/definitions/EditableHtmlConfigureProp",
+          "description": "Configuration for editable-html"
+        },
+        "required": {
+          "type": "boolean",
+          "description": "Indicates if the item is required and the value cannot be empty"
+        }
+      }
+    },
+    "ConfigurePropWithEnabled": {
+      "type": "object",
+      "properties": {
+        "settings": {
+          "type": "boolean",
+          "description": "Indicates if the item has to be displayed in the Settings Panel"
+        },
+        "label": {
+          "type": "string",
+          "description": "Indicates the label for the item that has to be displayed in the Settings Panel"
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Indicates the value of the item if it affects config-ui (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)"
+        }
+      }
+    },
+    "EditableHtmlPluginConfigure": {
+      "type": "object",
+      "properties": {
+        "settings": {
+          "type": "boolean",
+          "description": "Indicates if the item has to be displayed in the Settings Panel"
+        },
+        "label": {
+          "type": "string",
+          "description": "Indicates the label for the item that has to be displayed in the Settings Panel"
+        },
+        "inputConfiguration": {
+          "$ref": "#/definitions/EditableHtmlConfigureProp",
+          "description": "Configuration for editable-html"
+        }
+      }
+    },
+    "ConfigureMaxImageDimensionsProp": {
+      "type": "object",
+      "properties": {
+        "teacherInstructions": {
+          "type": "number",
+          "description": "Indicates the max dimension for images in teacher instructions"
+        },
+        "prompt": {
+          "type": "number",
+          "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified"
+        },
+        "rationale": {
+          "type": "number",
+          "description": "Indicates the max dimension for images in rationale"
+        }
+      },
+      "description": "Maximum image dimensions per editable field. Elements extend it with their own fields."
+    },
+    "ConfigureMathMLProp": {
+      "type": "object",
+      "properties": {
+        "mmlOutput": {
+          "type": "boolean",
+          "description": "Indicates if model should have mathML output instead of latex"
+        },
+        "mmlEditing": {
+          "type": "boolean",
+          "description": "Indicates if mathML that's already in model should be editable"
+        }
+      }
+    },
+    "ConfigureLanguageOptions": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string"
+        },
+        "options": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ConfigureLanguageOptionsProp"
+          }
+        }
+      },
+      "required": [
+        "label",
+        "options"
+      ]
+    },
+    "ConfigureLanguageOptionsProp": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": "string",
+          "description": "Value of the language option"
+        },
+        "label": {
+          "type": "string",
+          "description": "Label of the language option"
+        }
+      },
+      "required": [
+        "value",
+        "label"
+      ]
+    },
+    "ContentDimensions": {
+      "type": "object",
+      "properties": {
+        "maxHeight": {
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "maxWidth": {
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "minHeight": {
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "minWidth": {
+          "type": [
+            "string",
+            "number"
+          ]
+        }
+      },
+      "description": "Indicates the dimensions configuration for the authoring container. Note: Some items have a default minimum width because of their content, but if a lower minWidth is provided, it will be used."
+    }
+  },
+  "additionalProperties": false
+}