@mathscan/math-exercise-engine 1.2.6 → 1.2.7

package/dist/index.mjs

@@ -1886,6 +1886,7 @@ const InlineInputWidgetSchema = z.discriminatedUnion("inputType", [
     inputType: z.literal(INPUT_TYPES.STRING),
     length: z.number().int().positive(),
     placeholder: z.string().max(32).optional(),
+    disabled: z.boolean().optional(),
     answer: z.union([z.string(), z.number()]).optional()
   }),
   z.object({
@@ -1894,6 +1895,7 @@ const InlineInputWidgetSchema = z.discriminatedUnion("inputType", [
     inputType: z.literal(INPUT_TYPES.NUMERIC),
     digits: z.number().int().positive(),
     placeholder: z.string().max(32).optional(),
+    disabled: z.boolean().optional(),
     answer: z.union([z.string(), z.number()]).optional()
   })
 ]);
@@ -2049,7 +2051,7 @@ function createBoldText(value, highlight) {
     highlight
   });
 }
-function createStringInput(name, length, answer, placeholder) {
+function createStringInput(name, length, answer, placeholder, disabled) {
   return parseOrThrow(
     InlineInputWidgetSchema,
     {
@@ -2058,12 +2060,14 @@ function createStringInput(name, length, answer, placeholder) {
       inputType: INPUT_TYPES.STRING,
       length,
       placeholder,
-      answer
+      disabled,
+      // A disabled input is never graded, so its answer is dropped.
+      answer: disabled ? void 0 : answer
     },
     "STRING_INPUT"
   );
 }
-function createNumericInput(name, digits, answer, placeholder) {
+function createNumericInput(name, digits, answer, placeholder, disabled) {
   return parseOrThrow(
     InlineInputWidgetSchema,
     {
@@ -2072,7 +2076,9 @@ function createNumericInput(name, digits, answer, placeholder) {
       inputType: INPUT_TYPES.NUMERIC,
       digits,
       placeholder,
-      answer
+      disabled,
+      // A disabled input is never graded, so its answer is dropped.
+      answer: disabled ? void 0 : answer
     },
     "NUMERIC_INPUT"
   );
@@ -3685,6 +3691,9 @@ class NaturalDSLVisitor extends BaseCstVisitor {
       if (!name) {
         throw new Error("INPUT inside VERTICAL_OPERATION requires parameter: name");
       }
+      if (params.disabled !== void 0) {
+        throw new Error("INPUT inside VERTICAL_OPERATION does not support parameter: disabled");
+      }
       const digits = params.digits !== void 0 ? Number(params.digits) : 1;
       const answer = params.answer;
       return createVopInputCell(name, digits, answer);
@@ -3930,12 +3939,20 @@ class NaturalDSLVisitor extends BaseCstVisitor {
     const name = params.name;
     const answer = params.answer;
     const placeholder = params.placeholder;
+    let disabled;
+    if (params.disabled === true || params.disabled === "true") disabled = true;
+    else if (params.disabled === false || params.disabled === "false") disabled = false;
+    else if (params.disabled !== void 0) {
+      throw new Error(
+        `${ctx.stringInput ? "STRING_INPUT" : "NUMERIC_INPUT"} "${name}": disabled must be true or false, got ${JSON.stringify(params.disabled)}`
+      );
+    }
     if (ctx.stringInput) {
       const length = params.length;
-      return createStringInput(name, length, answer, placeholder);
+      return createStringInput(name, length, answer, placeholder, disabled);
     }
     const digits = params.digits;
-    return createNumericInput(name, digits, answer, placeholder);
+    return createNumericInput(name, digits, answer, placeholder, disabled);
   }
   inlineDragOption(ctx) {
     const valueToken = ctx.StringLiteral[0];
@@ -4531,13 +4548,17 @@ const StringInputJSONSchema = z.object({
   type: z.literal(JSON_TYPES.INLINE_INPUT),
   inputType: z.literal(INPUT_TYPES.STRING),
   length: z.number().int().positive(),
-  placeholder: z.string().max(32).optional()
+  placeholder: z.string().max(32).optional(),
+  /** Gray, non-interactive, never graded (any answer for it is ignored). */
+  disabled: z.boolean().optional()
 });
 const NumericInputJSONSchema = z.object({
   type: z.literal(JSON_TYPES.INLINE_INPUT),
   inputType: z.literal(INPUT_TYPES.NUMERIC),
   digits: z.number().int().positive(),
-  placeholder: z.string().max(32).optional()
+  placeholder: z.string().max(32).optional(),
+  /** Gray, non-interactive, never graded (any answer for it is ignored). */
+  disabled: z.boolean().optional()
 });
 const InlineInputJSONSchema = z.discriminatedUnion("inputType", [
   StringInputJSONSchema,
@@ -4765,6 +4786,9 @@ function isChartItem(item) {
 function isInlineInputJSON(widget) {
   return widget.type === JSON_TYPES.INLINE_INPUT;
 }
+function isDisabledInputJSON(widget) {
+  return isInlineInputJSON(widget) && widget.disabled === true;
+}
 function isDragOptionsJSON(widget) {
   return widget.type === JSON_TYPES.DRAG_OPTIONS;
 }
@@ -10411,14 +10435,16 @@ function toJSON(ast) {
           type: JSON_TYPES.INLINE_INPUT,
           inputType: INPUT_TYPES.STRING,
           length: inline.length,
-          placeholder: inline.placeholder
+          placeholder: inline.placeholder,
+          ...inline.disabled && { disabled: true }
         };
       } else {
         widgets[inline.name] = {
           type: JSON_TYPES.INLINE_INPUT,
           inputType: INPUT_TYPES.NUMERIC,
           digits: inline.digits,
-          placeholder: inline.placeholder
+          placeholder: inline.placeholder,
+          ...inline.disabled && { disabled: true }
         };
       }
       if (inline.answer !== void 0) {
@@ -10538,7 +10564,9 @@ function toJSON(ast) {
   }
   let validationSection = {};
   if (ast.validation) {
-    validationSection = { validation: transformValidation(ast.validation, answers, widgets) };
+    const validation = transformValidation(ast.validation, answers, widgets);
+    const onlyDisabledLeft = validation.mode === VALIDATION_MODES.SIMPLE && Object.keys(answers).length === 0 && Object.values(widgets).some(isDisabledInputJSON);
+    if (!onlyDisabledLeft) validationSection = { validation };
   } else if (Object.keys(answers).length > 0) {
     validationSection = { validation: { mode: VALIDATION_MODES.SIMPLE, answers } };
   }
@@ -10994,7 +11022,8 @@ function transformValidation(validation, answers, widgets) {
       answers
     };
   } else if (validation.type === AST_TYPES.EXPRESSION_VALIDATION) {
-    const validVariableNames = Object.keys(widgets);
+    assertNoDisabledInExpression(validation.expression, widgets);
+    const validVariableNames = getEnabledWidgetNames(widgets);
     const variables = extractVariables$1(validation.expression, validVariableNames);
     return {
       mode: VALIDATION_MODES.EXPRESSION,
@@ -11002,13 +11031,15 @@ function transformValidation(validation, answers, widgets) {
       variables
     };
   } else if (validation.type === AST_TYPES.MIXED_VALIDATION) {
-    const validVariableNames = Object.keys(widgets);
+    assertNoDisabledInExpression(validation.expression, widgets);
+    const validVariableNames = getEnabledWidgetNames(widgets);
     const variables = extractVariables$1(validation.expression, validVariableNames);
     const inExpression = new Set(variables);
     for (const [name, widget] of Object.entries(widgets)) {
       if (name.startsWith("_")) continue;
       if (name in answers) continue;
       if (inExpression.has(name)) continue;
+      if (isDisabledInputJSON(widget)) continue;
       if (widget.type === JSON_TYPES.FRACTION) {
         const w = widget;
         if (w.numerator !== null && w.denominator !== null) continue;
@@ -11030,6 +11061,17 @@ function transformValidation(validation, answers, widgets) {
   }
   throw new Error(`Unknown validation type: ${validation.type}`);
 }
+function assertNoDisabledInExpression(expression, widgets) {
+  const disabled = extractVariables$1(expression, Object.keys(widgets)).filter((name) => widgets[name] && isDisabledInputJSON(widgets[name]));
+  if (disabled.length > 0) {
+    throw new Error(
+      `WIDGET_ANSWER: expression references disabled input(s) ${disabled.map((n) => `"${n}"`).join(", ")} — a disabled input is never filled, so the expression could never be true`
+    );
+  }
+}
+function getEnabledWidgetNames(widgets) {
+  return Object.entries(widgets).filter(([, widget]) => !isDisabledInputJSON(widget)).map(([name]) => name);
+}
 function extractVariables$1(expression, validVariables) {
   const matches = expression.match(/\b[a-zA-Z_][a-zA-Z0-9_]*\b/g) || [];
   const variables = matches.filter(
@@ -11545,7 +11587,43 @@ function preprocessFractionValues(exercise, userInputs) {
   }
   return result;
 }
+function withoutDisabledWidgets(exercise) {
+  const validation = exercise.validation;
+  if (!validation) return exercise;
+  const disabled = new Set(
+    Object.entries(exercise.widgets).filter(([, widget]) => isDisabledInputJSON(widget)).map(([id]) => id)
+  );
+  if (disabled.size === 0) return exercise;
+  return {
+    ...exercise,
+    validation: {
+      ...validation,
+      ...validation.answers && {
+        answers: Object.fromEntries(
+          Object.entries(validation.answers).filter(([id]) => !disabled.has(id))
+        )
+      },
+      ...validation.variables && {
+        variables: validation.variables.filter((v) => !disabled.has(v))
+      }
+    }
+  };
+}
+function findDisabledInExpression(exercise) {
+  const expression = exercise.validation?.expression;
+  if (!expression) return [];
+  return extractVariables(expression, Object.keys(exercise.widgets)).filter((name) => exercise.widgets[name] && isDisabledInputJSON(exercise.widgets[name]));
+}
 function validate(exercise, userInputs) {
+  const disabledInExpression = findDisabledInExpression(exercise);
+  if (disabledInExpression.length > 0) {
+    return {
+      isCorrect: false,
+      details: {},
+      error: `Expression references disabled input(s) ${disabledInExpression.map((n) => `"${n}"`).join(", ")}`
+    };
+  }
+  exercise = withoutDisabledWidgets(exercise);
   if (!exercise.validation) {
     return {
       isCorrect: true,
@@ -11575,6 +11653,7 @@ function validate(exercise, userInputs) {
   }
 }
 function getAnswerableInputs(exercise) {
+  exercise = withoutDisabledWidgets(exercise);
   if (!exercise.validation) return [];
   const keys = /* @__PURE__ */ new Set();
   if (exercise.validation.mode === VALIDATION_MODES.SIMPLE) {
@@ -11589,6 +11668,7 @@ function getAnswerableInputs(exercise) {
 }
 function getMissingInputs(exercise, userInputs) {
   const missing = [];
+  exercise = withoutDisabledWidgets(exercise);
   if (!exercise.validation) {
     return missing;
   }
@@ -16326,6 +16406,7 @@ const InlineInput = ({
   length,
   digits,
   placeholder,
+  disabled = false,
   onChange,
   onFocus
 }) => {
@@ -16340,13 +16421,14 @@ const InlineInput = ({
   const expectedLength = inputType === "numeric" ? digits : length;
   const dynamicWidth = `${(expectedLength || 5) * 0.8 + 1}em`;
   const statusClass = validationStatus ? ` widget--${validationStatus}` : "";
+  const disabledClass = disabled ? " inline-input--disabled" : "";
   return /* @__PURE__ */ jsx(
     Droppable,
     {
       id: widgetId,
       accepts: ["drag-option", "placed-chip"],
       onDrop: handleDrop,
-      disabled: locked,
+      disabled: locked || disabled,
       className: "inline-widget inline-input-droppable",
       children: isDropped && value !== "" ? (
         // Show as chip only when value came from drag-drop
@@ -16366,7 +16448,7 @@ const InlineInput = ({
           {
             id: widgetId + "-input",
             type: "text",
-            className: `inline-input${statusClass}`,
+            className: `inline-input${statusClass}${disabledClass}`,
             value,
             onChange: (e) => handleChange(e.target.value, false),
             onMouseDown: () => {
@@ -16374,6 +16456,7 @@ const InlineInput = ({
             },
             onFocus: () => onFocus?.(widgetId),
             readOnly: locked,
+            disabled,
             maxLength: expectedLength,
             style: { width: dynamicWidth },
             placeholder
@@ -18622,6 +18705,7 @@ const WidgetRenderer = ({
         length: widget.inputType === "string" ? widget.length : void 0,
         digits: widget.inputType === "numeric" ? widget.digits : void 0,
         placeholder: widget.placeholder,
+        disabled: widget.disabled,
         onChange,
         onFocus: onInputFocus
       }
@@ -20879,7 +20963,7 @@ function buildInitialValuesSignature(json) {
 }
 function buildRevealedValues(json) {
   const revealed = {};
-  const validation = json.validation;
+  const validation = withoutDisabledWidgets(json).validation;
   if (!validation) return revealed;
   const answers = validation.answers ?? {};
   for (const [widgetId, expected] of Object.entries(answers)) {