@pie-element/math-templated 8.0.4-next.20261011174919 → 8.0.4

package/dist/controller/defaults.d.ts

@@ -1,20 +1,21 @@
+import type { MathTemplatedResponse } from '../types.js';
 declare const _default: {
     model: {
-        allowTrailingZerosDefault: boolean;
-        equationEditor: string;
-        ignoreOrderDefault: boolean;
+        allowTrailingZerosDefault: false;
+        equationEditor: "8";
+        ignoreOrderDefault: false;
         markup: string;
-        playerSpellCheckEnabled: boolean;
+        playerSpellCheckEnabled: true;
         prompt: string;
-        promptEnabled: boolean;
+        promptEnabled: true;
         rationale: string;
-        rationaleEnabled: boolean;
-        responses: {};
-        spellCheckEnabled: boolean;
+        rationaleEnabled: true;
+        responses: Record<string, MathTemplatedResponse>;
+        spellCheckEnabled: true;
         teacherInstructions: string;
-        teacherInstructionsEnabled: boolean;
-        toolbarEditorPosition: string;
-        validationDefault: string;
+        teacherInstructionsEnabled: true;
+        toolbarEditorPosition: "bottom";
+        validationDefault: "literal";
     };
     configuration: {};
 };

package/dist/controller/index.d.ts

@@ -1,9 +1,47 @@
-export declare const getCorrectness: (question: any, env: any, session: any) => {
-    correctness: string;
+import type { ExtraCSSRules, PieEnvironment } from '@pie-element/shared-types';
+import type { EquationEditor, MathTemplatedConfiguration, MathTemplatedModel, MathTemplatedResponse, MathTemplatedSession } from '../types.js';
+/** Correctness of the learner's answers across every response area. */
+type ResponseCorrectness = {
+    correctness: 'unanswered' | 'correct' | 'incorrect';
     score: number;
     correct: boolean;
-} | undefined;
-export declare const getPartialScore: (question: any, session: any) => 1 | 0;
+};
+/** The model as the delivery view receives it. */
+type MathTemplatedViewModel = {
+    prompt: string | null;
+    markup?: string;
+    responses: Record<string, MathTemplatedResponse> | null;
+    language?: string;
+    equationEditor?: EquationEditor;
+    customKeys?: string[];
+    disabled: boolean;
+    view: boolean;
+    correctness?: ResponseCorrectness;
+    env: PieEnvironment;
+    extraCSSRules?: ExtraCSSRules;
+    correctResponse?: Record<string, never>;
+    showNote?: boolean;
+    note?: string;
+    feedback?: Record<string, boolean>;
+    rationale?: string | null;
+    teacherInstructions?: string | null;
+};
+type MathTemplatedOutcome = {
+    score: number | undefined;
+    completed?: undefined;
+    empty?: boolean;
+    logTrace: string[];
+};
+/** Errors `validate()` reports, keyed by field; `responses` is keyed by response index, then by `answer` or alternate id. */
+export type MathTemplatedValidationErrors = {
+    teacherInstructions?: string;
+    prompt?: string;
+    rationale?: string;
+    responseAreas?: string;
+    responses?: Record<number, Record<string, string>>;
+};
+export declare const getCorrectness: (question: MathTemplatedModel, env: PieEnvironment, session: MathTemplatedSession | null | undefined) => ResponseCorrectness | undefined;
+export declare const getPartialScore: (_question: MathTemplatedModel, session: MathTemplatedSession | null | undefined) => 1 | 0;
 /**
  * Generates detailed trace log for math-templated scoring evaluation
  * @param {Object} question
@@ -11,27 +49,40 @@ export declare const getPartialScore: (question: any, session: any) => 1 | 0;
  * @param {Object} env
  * @returns {Array<string>} traceLog
  */
-export declare const getLogTrace: (question: any, session: any, env: any) => string[];
-export declare const outcome: (question: any, session: any, env: any) => Promise<unknown>;
-export declare const createDefaultModel: (model?: {}) => {
-    responses: {};
-    allowTrailingZerosDefault: boolean;
-    equationEditor: string;
-    ignoreOrderDefault: boolean;
+export declare const getLogTrace: (question: MathTemplatedModel, session: MathTemplatedSession | null | undefined, env: PieEnvironment) => string[];
+export declare const outcome: (question: MathTemplatedModel, session: MathTemplatedSession | null | undefined, env: PieEnvironment) => Promise<MathTemplatedOutcome>;
+export declare const createDefaultModel: (model?: Partial<MathTemplatedModel>) => {
+    responses: Record<string, MathTemplatedResponse>;
     markup: string;
-    playerSpellCheckEnabled: boolean;
+    slateMarkup?: string | undefined;
     prompt: string;
     promptEnabled: boolean;
+    teacherInstructions: string;
+    teacherInstructionsEnabled: boolean;
     rationale: string;
     rationaleEnabled: boolean;
     spellCheckEnabled: boolean;
-    teacherInstructions: string;
-    teacherInstructionsEnabled: boolean;
-    toolbarEditorPosition: string;
-    validationDefault: string;
+    playerSpellCheckEnabled: boolean;
+    equationEditor: EquationEditor;
+    customKeys?: string[] | undefined;
+    ignoreOrderDefault: boolean;
+    allowTrailingZerosDefault: boolean;
+    validationDefault: "literal" | "symbolic";
+    partialScoring?: boolean | undefined;
+    toolbarEditorPosition: "bottom" | "top";
+    note?: string | undefined;
+    language?: string | undefined;
+    extraCSSRules?: ExtraCSSRules | undefined;
+    scoringType?: "auto" | "rubric" | undefined;
+    feedbackEnabled?: boolean | undefined;
+    studentInstructionsEnabled?: boolean | undefined;
+    id?: string | undefined;
+    element?: string | undefined;
+    accessibilityCatalogs?: import("@pie-element/shared-types").AccessibilityCatalog[] | undefined;
 };
-export declare const normalizeSession: (s: any) => any;
-export declare const prepareVal: (html: any) => any;
-export declare const model: (question: any, session: any, env: any) => Promise<unknown>;
-export declare const createCorrectResponseSession: (question: any, env: any) => Promise<unknown>;
-export declare const validate: (model?: {}, config?: {}) => {};
+export declare const normalizeSession: (s: MathTemplatedSession) => MathTemplatedSession;
+export declare const prepareVal: (html: string | undefined) => string;
+export declare const model: (question: Partial<MathTemplatedModel>, session: MathTemplatedSession | null | undefined, env: PieEnvironment) => Promise<MathTemplatedViewModel>;
+export declare const createCorrectResponseSession: (question: MathTemplatedModel, env: PieEnvironment) => Promise<MathTemplatedSession | null>;
+export declare const validate: (model?: Partial<MathTemplatedModel>, config?: MathTemplatedConfiguration) => MathTemplatedValidationErrors;
+export {};

package/dist/controller/index.js

@@ -80,7 +80,7 @@ var { translator: o } = n, s = r("@pie-element:math-templated:controller"), c =
 		logTrace: []
 	});
 	else {
-		let t = f(e, r, n, !0).score;
+		let t = f(e, r, n).score;
 		i({
 			score: o ? t : +(t === 1),
 			logTrace: m(e, n, r)
@@ -126,10 +126,13 @@ var { translator: o } = n, s = r("@pie-element:math-templated:controller"), c =
 		_[e] = u(n, t);
 	}), n.mode === "evaluate" ? (m.correctResponse = {}, m.showNote = p, m.note = d, m.feedback = _) : (m.responses = {}, m.showNote = !1), n.role === "instructor" && (n.mode === "view" || n.mode === "evaluate") ? (m.rationale = i.rationaleEnabled ? i.rationale : null, m.teacherInstructions = i.teacherInstructionsEnabled ? i.teacherInstructions : null) : (m.rationale = null, m.teacherInstructions = null), s("out: ", m), r(m);
 }), x = (e, t) => new Promise((n) => {
-	t.mode !== "evaluate" && t.role === "instructor" ? n({
-		id: "1",
-		answers: Object.keys(e.responses).reduce((t, n) => (t["r" + n] = { value: e.responses[n].answer }, t), {})
-	}) : n(null);
+	if (t.mode !== "evaluate" && t.role === "instructor") {
+		let t = e.responses;
+		n({
+			id: "1",
+			answers: Object.keys(t).reduce((e, n) => (e["r" + n] = { value: t[n].answer }, e), {})
+		});
+	} else n(null);
 }), S = (e = {}, n = {}) => {
 	let { responses: r, markup: i } = e, { maxResponseAreas: a } = n, o = {}, s = {};
 	[
@@ -138,13 +141,13 @@ var { translator: o } = n, s = r("@pie-element:math-templated:controller"), c =
 		"rationale"
 	].forEach((t) => {
 		n[t]?.required && !l(e[t]) && (s[t] = "This field is required.");
-	}), Object.entries(r || {}).forEach(([e, n], r) => {
-		let { answer: i } = n, a = [...Object.entries(n.alternates || {})].reverse(), s = {}, c = {};
-		i === "" && (c.answer = "Content should not be empty."), a.forEach(([e, t], n) => {
-			t === "" ? s[e] = "Content should not be empty." : (i === t || a.slice(n + 1).some(([, e]) => e === t)) && (s[e] = "Content should be unique.");
-		}), (!t(c) || !t(s)) && (o[r] = {
-			...c,
-			...s
+	}), Object.entries(r || {}).forEach(([, e], n) => {
+		let { answer: r } = e, i = [...Object.entries(e.alternates || {})].reverse(), a = {}, s = {};
+		r === "" && (s.answer = "Content should not be empty."), i.forEach(([e, t], n) => {
+			t === "" ? a[e] = "Content should not be empty." : (r === t || i.slice(n + 1).some(([, e]) => e === t)) && (a[e] = "Content should be unique.");
+		}), (!t(s) || !t(a)) && (o[n] = {
+			...s,
+			...a
 		});
 	});
 	let c = (i.match(/\{\{(\d+)\}\}/g) || []).length;

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,382 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://cdn.jsdelivr.net/npm/@pie-element/math-templated@8.0.4/dist/schemas/configuration.schema.json",
+  "type": "object",
+  "properties": {
+    "ignoreOrder": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Ignore Order configuration; `enabled` shows the control on each response"
+    },
+    "allowTrailingZeros": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Allow Trailing Zeros configuration; `enabled` shows the control on each response"
+    },
+    "partialScoring": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Partial Scoring configuration"
+    },
+    "baseInputConfiguration": {
+      "$ref": "#/definitions/EditableHtmlConfigureProp",
+      "description": "Base editable html input configuration regarding plugins that are enabled/disabled E.g. audio, video, image"
+    },
+    "prompt": {
+      "$ref": "#/definitions/EditableHtmlPluginConfigureRequired",
+      "description": "Configuration for the prompt; `inputConfiguration` is not read, the prompt editor takes `teacherInstructions.inputConfiguration`"
+    },
+    "spellCheck": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Configuration for the author's spellcheck; `enabled` is not read"
+    },
+    "editSource": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Configuration for edit Source; `enabled` is not read"
+    },
+    "playerSpellCheck": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Configuration for the player's spellcheck; `enabled` is not read"
+    },
+    "teacherInstructions": {
+      "$ref": "#/definitions/EditableHtmlPluginConfigureRequired",
+      "description": "Teacher Instructions configuration"
+    },
+    "rationale": {
+      "$ref": "#/definitions/EditableHtmlPluginConfigureRequired",
+      "description": "Configuration for Rationale"
+    },
+    "template": {
+      "$ref": "#/definitions/EditableHtmlPluginConfigure",
+      "description": "Template configuration"
+    },
+    "maxImageWidth": {
+      "$ref": "#/definitions/ConfigureMaxImageDimensionsProp",
+      "description": "Maximum image width for input fields"
+    },
+    "maxImageHeight": {
+      "$ref": "#/definitions/ConfigureMaxImageDimensionsProp",
+      "description": "Maximum image height for input fields"
+    },
+    "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"
+    },
+    "maxResponseAreas": {
+      "type": "number",
+      "description": "Maximum number of response areas"
+    },
+    "settingsPanelDisabled": {
+      "type": "boolean",
+      "description": "Indicates if the settings panel is not available"
+    },
+    "contentDimensions": {
+      "$ref": "#/definitions/ContentDimensions",
+      "description": "Dimensions of the authoring container"
+    }
+  },
+  "description": "Config Object for `@pie-element/math-templated`",
+  "definitions": {
+    "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)"
+        }
+      }
+    },
+    "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."
+    },
+    "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"
+      ]
+    },
+    "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"
+        }
+      }
+    },
+    "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
+}