@teachinglab/omd 0.1.5 → 0.1.6

package/omd/core/index.js

@@ -21,6 +21,7 @@ import { omdEquationStack } from './omdEquationStack.js';
 import { omdStepVisualizer } from '../step-visualizer/omdStepVisualizer.js';
 import { omdDisplay } from '../display/omdDisplay.js';
 import { omdToolbar } from '../display/omdToolbar.js';
+import { omdNodeOverlay, omdNodeOverlayPresets } from '../utils/omdNodeOverlay.js';
 
 // Utilities
 import { getNodeForAST } from './omdUtilities.js';
@@ -30,6 +31,7 @@ import {
     setConfig,
     getDefaultConfig
 } from '../config/omdConfigManager.js';
+import { aiNextEquationStep } from '../utils/aiNextEquationStep.js';
 
 // Expression handling
 import { omdExpression } from '../../src/omdExpression.js';
@@ -60,6 +62,8 @@ export {
     omdStepVisualizer,
     omdDisplay,
     omdToolbar,
+    omdNodeOverlay,
+    omdNodeOverlayPresets,
     
     // Utilities
     getNodeForAST,
@@ -69,6 +73,8 @@ export {
     getDefaultConfig,
     omdExpression,
     omdColor
+    ,
+    aiNextEquationStep
 };
 
 // Helper utilities for common operations
@@ -131,6 +137,8 @@ export default {
     omdStepVisualizer,
     omdDisplay,
     omdToolbar,
+    omdNodeOverlay,
+    omdNodeOverlayPresets,
     
     // Utilities
     getNodeForAST,
@@ -140,6 +148,7 @@ export default {
     getDefaultConfig,
     omdExpression,
     omdColor,
+    aiNextEquationStep,
     
     // Helper functions
     helpers: omdHelpers

package/omd/nodes/omdEquationSequenceNode.js

@@ -479,6 +479,21 @@ export class omdEquationSequenceNode extends omdNode {
         this.updateLayout();
     }
 
+    /**
+     * Convenience helper: recompute dimensions, update layout, and optionally render via a renderer.
+     * Use this instead of calling computeDimensions/updateLayout everywhere.
+     * @param {object} [renderer] - Optional renderer (e.g., an omdDisplay instance) to re-render the sequence
+     */
+    refresh(renderer, center=true) {
+        this.computeDimensions();
+        this.updateLayout();
+        renderer.render(this);
+
+        if (center) {
+            renderer.centerNode();
+        }
+    }
+
     /**
      * Applies a specified operation to the current equation in the sequence and adds the result as a new step.
      * @param {number|string} value - The constant value or expression string to apply.

package/omd/utils/aiNextEquationStep.js

@@ -0,0 +1,106 @@
+import OpenAI from 'openai';
+
+/**
+ * Ask the AI for the next algebraic step for an equation.
+ * This helper can be called in Node (server) with an API key, or can proxy to an endpoint.
+ *
+ * @param {string} equation - The equation string (e.g. "3x+2=14")
+ * @param {object} [options]
+ * @param {string} [options.apiKey] - API key for the OpenAI-compatible client (GEMINI_API_KEY)
+ * @param {string} [options.baseURL] - Optional baseURL override for the OpenAI client
+ * @param {string} [options.model] - Model name (default: "gemini-2.0-flash")
+ * @param {string} [options.endpoint] - If provided, POSTs to this endpoint with { equation } and expects the same JSON response
+ */
+export async function aiNextEquationStep(equation, options = {}) {
+    if (!equation) throw new Error('equation is required');
+
+    const prompt = `Given the equation ${equation}, return ONLY the next algebraic step required to solve for the variable, in one of the following strict JSON formats:
+
+For an operation (add, subtract, multiply, divide):
+{ "operation": "add|subtract|multiply|divide", "value": number or string }
+
+For a function applied to both sides (e.g., sqrt, log, sin):
+{ "function": "functionName" }
+
+If the equation is already solved (like x=4) or no valid algebraic step can be applied:
+{ "operation": "none" }
+
+Important rules for solving:
+1. When variables appear on both sides, first move all variables to one side by adding/subtracting variable terms
+2. When constants appear on both sides, move all constants to one side by adding/subtracting constants
+3. Focus on isolating the variable systematically
+4. For equations like 2x-5=3x+7, subtract the smaller variable term (2x) from both sides first
+
+Do not include any explanation, LaTeX, or extra text. Only output the JSON object.`;
+
+    // If an endpoint is provided, proxy the request there (useful for browser usage)
+    if (options.endpoint) {
+        const res = await fetch(options.endpoint, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ equation })
+        });
+
+        if (!res.ok) {
+            const text = await res.text();
+            throw new Error(`Remote endpoint error: ${res.status} ${text}`);
+        }
+
+        const json = await res.json();
+        return json;
+    }
+
+    const apiKey = options.apiKey || (typeof process !== 'undefined' && process.env && process.env.GEMINI_API_KEY);
+    if (!apiKey) throw new Error('API key is required when not using a remote endpoint');
+
+    const baseURL = options.baseURL || 'https://generativelanguage.googleapis.com/v1beta/openai/';
+    const model = options.model || 'gemini-2.0-flash';
+
+    const client = new OpenAI({ apiKey, baseURL });
+
+    const messages = [
+        {
+            role: 'user',
+            content: [
+                {
+                    type: 'text',
+                    text: prompt
+                }
+            ]
+        }
+    ];
+
+    const response = await client.chat.completions.create({
+        model,
+        messages,
+        max_tokens: 150
+    });
+
+    // Extract JSON object from model output
+    let aiText = '';
+    try {
+        aiText = (response.choices && response.choices[0] && response.choices[0].message && response.choices[0].message.content) || '';
+        if (Array.isArray(aiText)) {
+            // Some SDKs return arrays of content objects
+            aiText = aiText.map(c => c.text || c.content || '').join('');
+        }
+        if (typeof aiText === 'object' && aiText.text) aiText = aiText.text;
+        aiText = String(aiText).trim();
+    } catch (e) {
+        throw new Error('Unexpected AI response format');
+    }
+
+    const jsonMatch = aiText.match(/\{[\s\S]*\}/);
+    if (!jsonMatch) throw new Error('AI did not return a JSON object');
+
+    try {
+        const parsed = JSON.parse(jsonMatch[0]);
+        return parsed;
+    } catch (e) {
+        throw new Error('Failed to parse AI JSON response: ' + e.message + ' -- raw: ' + aiText);
+    }
+}
+
+export default aiNextEquationStep;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teachinglab/omd",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "omd",
   "main": "./index.js",
   "module": "./index.js",

package/src/omdBalanceHanger.js

@@ -1,6 +1,6 @@
 
 import { omdColor } from "./omdColor.js";
-import { jsvgGroup, jsvgLine, jsvgEllipse, jsvgRect } from "@teachinglab/jsvg";
+import { jsvgGroup, jsvgLine, jsvgEllipse, jsvgRect, jsvgTextBox } from "@teachinglab/jsvg";
 
 export class omdBalanceHanger extends jsvgGroup
 {

package/src/omdCoordinatePlane.js

@@ -1,5 +1,5 @@
 import { omdColor } from "./omdColor.js";
-import { jsvgGroup, jsvgRect, jsvgClipMask, jsvgLine, jsvgEllipse, jsvgTextBox, jsvgPath } from "@teachinglab/jsvg";
+import { jsvgGroup, jsvgRect, jsvgClipMask, jsvgLine, jsvgEllipse, jsvgTextBox, jsvgTextLine, jsvgPath } from "@teachinglab/jsvg";
 import {
     omdRightTriangle,
     omdIsoscelesTriangle,