@mathscan/math-exercise-engine 1.0.9 → 1.0.11

package/dist/index.d.ts

@@ -191,12 +191,6 @@ export declare function compile(dsl: string): ExerciseJSON;
  */
 export declare function compileWithAST(dsl: string): {
     ast: {
-        validation: {
-            type: "SimpleValidation";
-        } | {
-            expression: string;
-            type: "ExpressionValidation";
-        };
         type: "ExerciseDocument";
         lines: ({
             type: "LineBlock";
@@ -324,6 +318,12 @@ export declare function compileWithAST(dsl: string): {
             value: string;
             type: "TextBlock";
         } | undefined;
+        validation?: {
+            type: "SimpleValidation";
+        } | {
+            expression: string;
+            type: "ExpressionValidation";
+        } | undefined;
         tools?: ({
             type: "DragOptions";
             options: string[];
@@ -334,12 +334,6 @@ export declare function compileWithAST(dsl: string): {
         })[] | undefined;
     };
     json: {
-        validation: {
-            mode: "simple" | "expression";
-            expression?: string | undefined;
-            answers?: Record<string, string | number> | undefined;
-            variables?: string[] | undefined;
-        };
         version: "2.0";
         layout: any[];
         widgets: Record<string, {
@@ -361,6 +355,12 @@ export declare function compileWithAST(dsl: string): {
             includeOperators?: boolean | undefined;
             includeDecimal?: boolean | undefined;
         }>;
+        validation?: {
+            mode: "simple" | "expression";
+            expression?: string | undefined;
+            answers?: Record<string, string | number> | undefined;
+            variables?: string[] | undefined;
+        } | undefined;
         id?: string | undefined;
         meta?: {
             createdAt?: string | undefined;
@@ -1314,7 +1314,7 @@ export declare function createDragOptions(options: string[]): DragOptionsTool;
 /**
  * Create an exercise document
  */
-export declare function createExerciseDocument(question: z.infer<typeof TextBlockSchema> | undefined, lines: ContentBlock[], validation: z.infer<typeof ValidationNodeSchema>, tools?: z.infer<typeof ToolNodeSchema>[]): ExerciseDocument;
+export declare function createExerciseDocument(question: z.infer<typeof TextBlockSchema> | undefined, lines: ContentBlock[], validation?: z.infer<typeof ValidationNodeSchema>, tools?: z.infer<typeof ToolNodeSchema>[]): ExerciseDocument;
 
 /**
  * Create an expression validation node
@@ -2415,7 +2415,7 @@ export declare const ExerciseDocumentSchema: z.ZodObject<{
         includeOperators?: boolean | undefined;
         includeDecimal?: boolean | undefined;
     }>]>, "many">>;
-    validation: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    validation: z.ZodOptional<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
         type: z.ZodLiteral<"SimpleValidation">;
     }, "strip", z.ZodTypeAny, {
         type: "SimpleValidation";
@@ -2430,14 +2430,8 @@ export declare const ExerciseDocumentSchema: z.ZodObject<{
     }, {
         expression: string;
         type: "ExpressionValidation";
-    }>]>;
+    }>]>>;
 }, "strip", z.ZodTypeAny, {
-    validation: {
-        type: "SimpleValidation";
-    } | {
-        expression: string;
-        type: "ExpressionValidation";
-    };
     type: "ExerciseDocument";
     lines: ({
         type: "LineBlock";
@@ -2565,6 +2559,12 @@ export declare const ExerciseDocumentSchema: z.ZodObject<{
         value: string;
         type: "TextBlock";
     } | undefined;
+    validation?: {
+        type: "SimpleValidation";
+    } | {
+        expression: string;
+        type: "ExpressionValidation";
+    } | undefined;
     tools?: ({
         type: "DragOptions";
         options: string[];
@@ -2574,12 +2574,6 @@ export declare const ExerciseDocumentSchema: z.ZodObject<{
         includeDecimal?: boolean | undefined;
     })[] | undefined;
 }, {
-    validation: {
-        type: "SimpleValidation";
-    } | {
-        expression: string;
-        type: "ExpressionValidation";
-    };
     type: "ExerciseDocument";
     lines: ({
         type: "LineBlock";
@@ -2707,6 +2701,12 @@ export declare const ExerciseDocumentSchema: z.ZodObject<{
         value: string;
         type: "TextBlock";
     } | undefined;
+    validation?: {
+        type: "SimpleValidation";
+    } | {
+        expression: string;
+        type: "ExpressionValidation";
+    } | undefined;
     tools?: ({
         type: "DragOptions";
         options: string[];
@@ -2778,7 +2778,7 @@ export declare const ExerciseJSONSchema: z.ZodObject<{
         includeOperators?: boolean | undefined;
         includeDecimal?: boolean | undefined;
     }>]>>;
-    validation: z.ZodObject<{
+    validation: z.ZodOptional<z.ZodObject<{
         mode: z.ZodEnum<["simple", "expression"]>;
         answers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber]>>>;
         expression: z.ZodOptional<z.ZodString>;
@@ -2793,7 +2793,7 @@ export declare const ExerciseJSONSchema: z.ZodObject<{
         expression?: string | undefined;
         answers?: Record<string, string | number> | undefined;
         variables?: string[] | undefined;
-    }>;
+    }>>;
     meta: z.ZodOptional<z.ZodObject<{
         createdAt: z.ZodOptional<z.ZodString>;
         author: z.ZodOptional<z.ZodString>;
@@ -2811,12 +2811,6 @@ export declare const ExerciseJSONSchema: z.ZodObject<{
         difficulty?: number | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    validation: {
-        mode: "simple" | "expression";
-        expression?: string | undefined;
-        answers?: Record<string, string | number> | undefined;
-        variables?: string[] | undefined;
-    };
     version: "2.0";
     layout: any[];
     widgets: Record<string, {
@@ -2838,6 +2832,12 @@ export declare const ExerciseJSONSchema: z.ZodObject<{
         includeOperators?: boolean | undefined;
         includeDecimal?: boolean | undefined;
     }>;
+    validation?: {
+        mode: "simple" | "expression";
+        expression?: string | undefined;
+        answers?: Record<string, string | number> | undefined;
+        variables?: string[] | undefined;
+    } | undefined;
     id?: string | undefined;
     meta?: {
         createdAt?: string | undefined;
@@ -2846,12 +2846,6 @@ export declare const ExerciseJSONSchema: z.ZodObject<{
         difficulty?: number | undefined;
     } | undefined;
 }, {
-    validation: {
-        mode: "simple" | "expression";
-        expression?: string | undefined;
-        answers?: Record<string, string | number> | undefined;
-        variables?: string[] | undefined;
-    };
     version: "2.0";
     layout: any[];
     widgets: Record<string, {
@@ -2873,6 +2867,12 @@ export declare const ExerciseJSONSchema: z.ZodObject<{
         includeOperators?: boolean | undefined;
         includeDecimal?: boolean | undefined;
     }>;
+    validation?: {
+        mode: "simple" | "expression";
+        expression?: string | undefined;
+        answers?: Record<string, string | number> | undefined;
+        variables?: string[] | undefined;
+    } | undefined;
     id?: string | undefined;
     meta?: {
         createdAt?: string | undefined;
@@ -4944,6 +4944,10 @@ export declare function validate(exercise: ExerciseJSON, userInputs: Record<stri
  */
 export declare function validateBooleanExpression(expression: string): string | null;
 
+declare type ValidatedExerciseJSON = ExerciseJSON & {
+    validation: ValidationJSON;
+};
+
 /**
  * Validate an exercise JSON object at runtime
  *
@@ -4962,12 +4966,6 @@ export declare function validateBooleanExpression(expression: string): string |
  * ```
  */
 export declare function validateExerciseJSON(data: unknown): {
-    validation: {
-        mode: "simple" | "expression";
-        expression?: string | undefined;
-        answers?: Record<string, string | number> | undefined;
-        variables?: string[] | undefined;
-    };
     version: "2.0";
     layout: any[];
     widgets: Record<string, {
@@ -4989,6 +4987,12 @@ export declare function validateExerciseJSON(data: unknown): {
         includeOperators?: boolean | undefined;
         includeDecimal?: boolean | undefined;
     }>;
+    validation?: {
+        mode: "simple" | "expression";
+        expression?: string | undefined;
+        answers?: Record<string, string | number> | undefined;
+        variables?: string[] | undefined;
+    } | undefined;
     id?: string | undefined;
     meta?: {
         createdAt?: string | undefined;
@@ -5015,12 +5019,6 @@ export declare function validateExerciseJSON(data: unknown): {
  * ```
  */
 export declare function validateExerciseJSONSafe(data: unknown): z.SafeParseReturnType<{
-    validation: {
-        mode: "simple" | "expression";
-        expression?: string | undefined;
-        answers?: Record<string, string | number> | undefined;
-        variables?: string[] | undefined;
-    };
     version: "2.0";
     layout: any[];
     widgets: Record<string, {
@@ -5042,6 +5040,12 @@ export declare function validateExerciseJSONSafe(data: unknown): z.SafeParseRetu
         includeOperators?: boolean | undefined;
         includeDecimal?: boolean | undefined;
     }>;
+    validation?: {
+        mode: "simple" | "expression";
+        expression?: string | undefined;
+        answers?: Record<string, string | number> | undefined;
+        variables?: string[] | undefined;
+    } | undefined;
     id?: string | undefined;
     meta?: {
         createdAt?: string | undefined;
@@ -5050,12 +5054,6 @@ export declare function validateExerciseJSONSafe(data: unknown): z.SafeParseRetu
         difficulty?: number | undefined;
     } | undefined;
 }, {
-    validation: {
-        mode: "simple" | "expression";
-        expression?: string | undefined;
-        answers?: Record<string, string | number> | undefined;
-        variables?: string[] | undefined;
-    };
     version: "2.0";
     layout: any[];
     widgets: Record<string, {
@@ -5077,6 +5075,12 @@ export declare function validateExerciseJSONSafe(data: unknown): z.SafeParseRetu
         includeOperators?: boolean | undefined;
         includeDecimal?: boolean | undefined;
     }>;
+    validation?: {
+        mode: "simple" | "expression";
+        expression?: string | undefined;
+        answers?: Record<string, string | number> | undefined;
+        variables?: string[] | undefined;
+    } | undefined;
     id?: string | undefined;
     meta?: {
         createdAt?: string | undefined;
@@ -5089,11 +5093,11 @@ export declare function validateExerciseJSONSafe(data: unknown): z.SafeParseRetu
 /**
  * Validate using expression mode
  *
- * @param exercise - The exercise JSON
+ * @param exercise - The exercise JSON (with validation present)
  * @param userInputs - User's answers keyed by widget ID (variable names)
  * @returns Validation result
  */
-export declare function validateExpression(exercise: ExerciseJSON, userInputs: Record<string, string | number>): ValidationResult;
+export declare function validateExpression(exercise: ValidatedExerciseJSON, userInputs: Record<string, string | number>): ValidationResult;
 
 /**
  * Check if user inputs are valid (proper format, etc.)
@@ -5108,11 +5112,11 @@ export declare function validateInputFormats(exercise: ExerciseJSON, userInputs:
 /**
  * Validate using simple mode (predetermined answers)
  *
- * @param exercise - The exercise JSON
+ * @param exercise - The exercise JSON (with validation present)
  * @param userInputs - User's answers keyed by widget ID
  * @returns Validation result
  */
-export declare function validateSimple(exercise: ExerciseJSON, userInputs: Record<string, string | number>): ValidationResult;
+export declare function validateSimple(exercise: ValidatedExerciseJSON, userInputs: Record<string, string | number>): ValidationResult;
 
 /**
  * Validate a widget JSON object at runtime

package/dist/index.js

@@ -439,13 +439,16 @@ class MathExerciseParser extends chevrotain.CstParser {
       this.OPTION(() => {
         this.SUBRULE(this.question);
       });
-      this.MANY2(() => {
-        this.SUBRULE(this.contentBlock);
+      this.MANY2({
+        GATE: this.BACKTRACK(this.contentBlock),
+        DEF: () => this.SUBRULE(this.contentBlock)
       });
       this.MANY3(() => {
         this.SUBRULE(this.tool);
       });
-      this.SUBRULE(this.validation);
+      this.OPTION2(() => {
+        this.SUBRULE(this.validation);
+      });
       this.MANY4(() => {
         this.OR2([
           { ALT: () => this.CONSUME2(Newline) },
@@ -666,7 +669,7 @@ class MathExerciseParser extends chevrotain.CstParser {
       this.MANY2(() => {
         this.CONSUME2(Space);
       });
-      this.AT_LEAST_ONE2(() => {
+      this.MANY3(() => {
         this.CONSUME(Newline);
       });
     });
@@ -1203,7 +1206,7 @@ const ExerciseDocumentSchema = zod.z.object({
   question: TextBlockSchema.optional(),
   lines: zod.z.array(ContentBlockSchema),
   tools: zod.z.array(ToolNodeSchema).optional(),
-  validation: ValidationNodeSchema
+  validation: ValidationNodeSchema.optional()
 });
 function createExerciseDocument(question, lines, validation, tools) {
   return ExerciseDocumentSchema.parse({
@@ -1230,7 +1233,7 @@ class NaturalDSLVisitor extends BaseCstVisitor {
     const question = ctx.question ? this.visit(ctx.question) : void 0;
     const contentBlocks = ctx.contentBlock ? ctx.contentBlock.map((cb) => this.visit(cb)) : [];
     const tools = ctx.tool ? ctx.tool.map((t) => this.visit(t)) : [];
-    const validation = this.visit(ctx.validation);
+    const validation = ctx.validation ? this.visit(ctx.validation) : void 0;
     return createExerciseDocument(question, contentBlocks, validation, tools);
   }
   // ═══════════════════════════════════════════════════════════════════════════
@@ -1695,7 +1698,7 @@ const ExerciseJSONSchema = zod.z.object({
   id: zod.z.string().optional(),
   layout: zod.z.array(LayoutItemSchema),
   widgets: zod.z.record(WidgetJSONSchema),
-  validation: ValidationJSONSchema,
+  validation: ValidationJSONSchema.optional(),
   meta: ExerciseMetaSchema.optional()
 });
 function validateExerciseJSON(data) {
@@ -1852,13 +1855,12 @@ function toJSON(ast) {
       }
     }
   }
-  const validation = transformValidation(ast.validation, answers, widgets);
   return {
     version: "2.0",
     // Natural DSL version
     layout,
     widgets,
-    validation
+    ...ast.validation ? { validation: transformValidation(ast.validation, answers, widgets) } : {}
   };
 }
 function collectAllInlines(blocks) {
@@ -2329,11 +2331,18 @@ function findValidCombination(expression, ranges) {
   return null;
 }
 function validate(exercise, userInputs) {
-  switch (exercise.validation.mode) {
+  if (!exercise.validation) {
+    return {
+      isCorrect: true,
+      details: {}
+    };
+  }
+  const validatedExercise = exercise;
+  switch (validatedExercise.validation.mode) {
     case VALIDATION_MODES.SIMPLE:
-      return validateSimple(exercise, userInputs);
+      return validateSimple(validatedExercise, userInputs);
     case VALIDATION_MODES.EXPRESSION:
-      return validateExpression(exercise, userInputs);
+      return validateExpression(validatedExercise, userInputs);
     default:
       return {
         isCorrect: false,
@@ -2344,6 +2353,9 @@ function validate(exercise, userInputs) {
 }
 function getMissingInputs(exercise, userInputs) {
   const missing = [];
+  if (!exercise.validation) {
+    return missing;
+  }
   if (exercise.validation.mode === VALIDATION_MODES.SIMPLE && exercise.validation.answers) {
     for (const widgetId of Object.keys(exercise.validation.answers)) {
       if (!(widgetId in userInputs) || userInputs[widgetId] === "") {