@mathscan/math-exercise-engine 1.0.3 → 1.0.5

package/README.md

@@ -137,9 +137,11 @@ Creates an input field for text with up to 5 characters.
 
 ```
 TEXT_HIGHLIGHTER[value="123456", start=2, end=3]
+HIGHLIGHT_TEXT[value="123456", start=2, end=3]  // Alias
 ```
 
 Displays text with specific characters highlighted (useful for highlighting digits in numbers).
+Both `TEXT_HIGHLIGHTER` and `HIGHLIGHT_TEXT` are supported (aliases).
 
 ### Validators
 

package/dist/index.d.ts

@@ -19,6 +19,10 @@ export declare const AST_TYPES: {
     readonly SPACE: "Space";
     /** Text with optional character-range highlighting */
     readonly HIGHLIGHTED_TEXT: "HighlightedText";
+    /** Text with color and optional character-range coloring */
+    readonly COLOR_TEXT: "ColorText";
+    /** Bold text with optional character-range bolding */
+    readonly BOLD_TEXT: "BoldText";
     /** Inline input widget (string or numeric) */
     readonly INLINE_INPUT: "InlineInput";
     /** Question/instruction text block */
@@ -42,6 +46,108 @@ export declare const AST_TYPES: {
  */
 export declare type ASTType = typeof AST_TYPES[keyof typeof AST_TYPES];
 
+export declare type BoldText = z.infer<typeof BoldTextSchema>;
+
+export declare type BoldTextInline = z.infer<typeof BoldTextInlineSchema>;
+
+/**
+ * Bold text inline schema - text with optional range bolding
+ *
+ * highlight: [start, end] character positions for bold range
+ *
+ * @example
+ * {
+ *   type: "BoldText",
+ *   value: "123456",
+ *   highlight: [0, 3]  // Bolds "123"
+ * }
+ */
+export declare const BoldTextInlineSchema: z.ZodObject<{
+    type: z.ZodLiteral<"BoldText">;
+    value: z.ZodString;
+    highlight: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "BoldText";
+    highlight?: [number, number] | undefined;
+}, {
+    value: string;
+    type: "BoldText";
+    highlight?: [number, number] | undefined;
+}>;
+
+export declare const BoldTextSchema: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodLiteral<"bold-text">;
+    value: z.ZodString;
+    highlight: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "bold-text";
+    id: string;
+    highlight?: [number, number] | undefined;
+}, {
+    value: string;
+    type: "bold-text";
+    id: string;
+    highlight?: [number, number] | undefined;
+}>;
+
+export declare type ColorText = z.infer<typeof ColorTextSchema>;
+
+export declare type ColorTextInline = z.infer<typeof ColorTextInlineSchema>;
+
+/**
+ * Color text inline schema - text with color and optional range coloring
+ *
+ * highlight: [start, end] character positions for colored range
+ * color: CSS color value (e.g., "red", "#ff0000")
+ *
+ * @example
+ * {
+ *   type: "ColorText",
+ *   value: "123456",
+ *   color: "red",
+ *   highlight: [0, 3]  // Colors "123" in red
+ * }
+ */
+export declare const ColorTextInlineSchema: z.ZodObject<{
+    type: z.ZodLiteral<"ColorText">;
+    value: z.ZodString;
+    color: z.ZodString;
+    highlight: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "ColorText";
+    color: string;
+    highlight?: [number, number] | undefined;
+}, {
+    value: string;
+    type: "ColorText";
+    color: string;
+    highlight?: [number, number] | undefined;
+}>;
+
+export declare const ColorTextSchema: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodLiteral<"color-text">;
+    value: z.ZodString;
+    color: z.ZodString;
+    highlight: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "color-text";
+    color: string;
+    id: string;
+    highlight?: [number, number] | undefined;
+}, {
+    value: string;
+    type: "color-text";
+    color: string;
+    id: string;
+    highlight?: [number, number] | undefined;
+}>;
+
 /**
  * Compile DSL text directly to JSON (convenience function)
  *
@@ -91,6 +197,15 @@ export declare function compileWithAST(dsl: string): {
                 value: string;
                 type: "HighlightedText";
                 highlight?: [number, number] | undefined;
+            } | {
+                value: string;
+                type: "ColorText";
+                color: string;
+                highlight?: [number, number] | undefined;
+            } | {
+                value: string;
+                type: "BoldText";
+                highlight?: [number, number] | undefined;
             } | {
                 length: number;
                 type: "InlineInput";
@@ -153,6 +268,16 @@ export declare function compileWithAST(dsl: string): {
     };
 };
 
+/**
+ * Create a bold text inline element
+ */
+export declare function createBoldText(value: string, highlight?: [number, number]): BoldTextInline;
+
+/**
+ * Create a color text inline element
+ */
+export declare function createColorText(value: string, color: string, highlight?: [number, number]): ColorTextInline;
+
 /**
  * Create a drag options tool
  */
@@ -347,6 +472,33 @@ export declare const ExerciseDocumentSchema: z.ZodObject<{
             value: string;
             type: "HighlightedText";
             highlight?: [number, number] | undefined;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"ColorText">;
+            value: z.ZodString;
+            color: z.ZodString;
+            highlight: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            type: "ColorText";
+            color: string;
+            highlight?: [number, number] | undefined;
+        }, {
+            value: string;
+            type: "ColorText";
+            color: string;
+            highlight?: [number, number] | undefined;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"BoldText">;
+            value: z.ZodString;
+            highlight: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            type: "BoldText";
+            highlight?: [number, number] | undefined;
+        }, {
+            value: string;
+            type: "BoldText";
+            highlight?: [number, number] | undefined;
         }>, z.ZodDiscriminatedUnion<"inputType", [z.ZodObject<{
             type: z.ZodLiteral<"InlineInput">;
             name: z.ZodString;
@@ -395,6 +547,15 @@ export declare const ExerciseDocumentSchema: z.ZodObject<{
             value: string;
             type: "HighlightedText";
             highlight?: [number, number] | undefined;
+        } | {
+            value: string;
+            type: "ColorText";
+            color: string;
+            highlight?: [number, number] | undefined;
+        } | {
+            value: string;
+            type: "BoldText";
+            highlight?: [number, number] | undefined;
         } | {
             length: number;
             type: "InlineInput";
@@ -419,6 +580,15 @@ export declare const ExerciseDocumentSchema: z.ZodObject<{
             value: string;
             type: "HighlightedText";
             highlight?: [number, number] | undefined;
+        } | {
+            value: string;
+            type: "ColorText";
+            color: string;
+            highlight?: [number, number] | undefined;
+        } | {
+            value: string;
+            type: "BoldText";
+            highlight?: [number, number] | undefined;
         } | {
             length: number;
             type: "InlineInput";
@@ -490,6 +660,15 @@ export declare const ExerciseDocumentSchema: z.ZodObject<{
             value: string;
             type: "HighlightedText";
             highlight?: [number, number] | undefined;
+        } | {
+            value: string;
+            type: "ColorText";
+            color: string;
+            highlight?: [number, number] | undefined;
+        } | {
+            value: string;
+            type: "BoldText";
+            highlight?: [number, number] | undefined;
         } | {
             length: number;
             type: "InlineInput";
@@ -535,6 +714,15 @@ export declare const ExerciseDocumentSchema: z.ZodObject<{
             value: string;
             type: "HighlightedText";
             highlight?: [number, number] | undefined;
+        } | {
+            value: string;
+            type: "ColorText";
+            color: string;
+            highlight?: [number, number] | undefined;
+        } | {
+            value: string;
+            type: "BoldText";
+            highlight?: [number, number] | undefined;
         } | {
             length: number;
             type: "InlineInput";
@@ -1021,6 +1209,33 @@ export declare const InlineNodeSchema: z.ZodUnion<[z.ZodObject<{
     value: string;
     type: "HighlightedText";
     highlight?: [number, number] | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"ColorText">;
+    value: z.ZodString;
+    color: z.ZodString;
+    highlight: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "ColorText";
+    color: string;
+    highlight?: [number, number] | undefined;
+}, {
+    value: string;
+    type: "ColorText";
+    color: string;
+    highlight?: [number, number] | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"BoldText">;
+    value: z.ZodString;
+    highlight: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "BoldText";
+    highlight?: [number, number] | undefined;
+}, {
+    value: string;
+    type: "BoldText";
+    highlight?: [number, number] | undefined;
 }>, z.ZodDiscriminatedUnion<"inputType", [z.ZodObject<{
     type: z.ZodLiteral<"InlineInput">;
     name: z.ZodString;
@@ -1059,6 +1274,20 @@ export declare const InlineNodeSchema: z.ZodUnion<[z.ZodObject<{
     answer?: string | number | undefined;
 }>]>]>;
 
+/**
+ * Type guard for BoldText
+ */
+export declare function isBoldText(item: LayoutItem): item is Extract<LayoutItem, {
+    type: 'bold-text';
+}>;
+
+/**
+ * Type guard for ColorText
+ */
+export declare function isColorText(item: LayoutItem): item is Extract<LayoutItem, {
+    type: 'color-text';
+}>;
+
 export declare function isDragOptions(value: unknown): value is DragOptionsTool;
 
 /**
@@ -1177,6 +1406,10 @@ export declare const JSON_TYPES: {
     readonly SPACE: "space";
     /** Text with optional highlighting */
     readonly HIGHLIGHTED_TEXT: "highlighted-text";
+    /** Text with color styling */
+    readonly COLOR_TEXT: "color-text";
+    /** Bold text */
+    readonly BOLD_TEXT: "bold-text";
     /** Reference to a widget */
     readonly WIDGET_REF: "widget-ref";
     /** Line break element */
@@ -1272,6 +1505,33 @@ export declare const LineBlockSchema: z.ZodObject<{
         value: string;
         type: "HighlightedText";
         highlight?: [number, number] | undefined;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"ColorText">;
+        value: z.ZodString;
+        color: z.ZodString;
+        highlight: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: "ColorText";
+        color: string;
+        highlight?: [number, number] | undefined;
+    }, {
+        value: string;
+        type: "ColorText";
+        color: string;
+        highlight?: [number, number] | undefined;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"BoldText">;
+        value: z.ZodString;
+        highlight: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: "BoldText";
+        highlight?: [number, number] | undefined;
+    }, {
+        value: string;
+        type: "BoldText";
+        highlight?: [number, number] | undefined;
     }>, z.ZodDiscriminatedUnion<"inputType", [z.ZodObject<{
         type: z.ZodLiteral<"InlineInput">;
         name: z.ZodString;
@@ -1320,6 +1580,15 @@ export declare const LineBlockSchema: z.ZodObject<{
         value: string;
         type: "HighlightedText";
         highlight?: [number, number] | undefined;
+    } | {
+        value: string;
+        type: "ColorText";
+        color: string;
+        highlight?: [number, number] | undefined;
+    } | {
+        value: string;
+        type: "BoldText";
+        highlight?: [number, number] | undefined;
     } | {
         length: number;
         type: "InlineInput";
@@ -1344,6 +1613,15 @@ export declare const LineBlockSchema: z.ZodObject<{
         value: string;
         type: "HighlightedText";
         highlight?: [number, number] | undefined;
+    } | {
+        value: string;
+        type: "ColorText";
+        color: string;
+        highlight?: [number, number] | undefined;
+    } | {
+        value: string;
+        type: "BoldText";
+        highlight?: [number, number] | undefined;
     } | {
         length: number;
         type: "InlineInput";