@teachinglab/omd 0.1.4 → 0.1.6

package/docs/api/omdGroupNode.md

@@ -1,182 +1,79 @@
-
-Represents a single grouping symbol, such as `(` or `)`, as a leaf node in the expression tree. This node is typically used for visual representation.
-
-## Class: `omdGroupNode extends omdLeafNode`
-
-```javascript
-import { omdGroupNode } from './omd/nodes/omdGroupNode.js';
-```
-
-### Constructor
-
-```javascript
-new omdGroupNode(nodeData)
-```
-
-**Parameters:**
-
-**Description:**
-Creates a leaf node that visually represents a grouping symbol.
-
-### Properties
-
-Inherits all properties from [`omdLeafNode`](./omdLeafNode.md), plus:
-
-#### `symbol`
-
-#### `type`
-
-#### `textElement`
-
-### Methods
-
-Inherits all methods from [`omdLeafNode`](./omdLeafNode.md), plus:
-
-#### `parseSymbol(nodeData)`
-Internal method to extract symbol from input.
-
-
-#### `parseType()`
-Internal method to set node type.
-
-
-#### `clone()`
-Creates a clone of the group node.
-  - Same text content
-  - Original node's ID added to provenance array
-
-
-#### `computeDimensions()`
-Calculates node dimensions based on text content.
-Does NOT add padding, unlike other leaf nodes.
-Overrides base class method.
-
-
-#### `updateLayout()`
-Updates the position of the node.
-Overrides base class method.
-
-
-#### `toMathJSNode()`
-Converts to math.js AST format.
-  - `type`: "SymbolNode"
-  - `name`: The grouping symbol
-
-### Examples
-
-```javascript
-// Create grouping symbols
-const leftParen = new omdGroupNode('(');
-const rightParen = new omdGroupNode(')');
-const leftBracket = new omdGroupNode('[');
-
-// Render a symbol
-const node = new omdGroupNode('(');
-node.setFontSize(24);
-node.computeDimensions(); // Calculate size (no padding)
-node.updateLayout(); // Position the text element
-```
-
-### See Also
-
-# omdGroupNode
-
-Represents a single grouping symbol, such as `(` or `)`, as a leaf node in the expression tree. This node is typically used for visual representation.
-
-## Class: `omdGroupNode extends omdLeafNode`
-
-```javascript
-import { omdGroupNode } from './omd/nodes/omdGroupNode.js';
-```
-
-### Constructor
-
-```javascript
-new omdGroupNode(nodeData)
-```
-
-**Parameters:**
-- `nodeData` {string} - The grouping symbol character to display
-
-**Description:**
-Creates a leaf node that visually represents a grouping symbol.
-
-### Properties
-
-Inherits all properties from [`omdLeafNode`](./omdLeafNode.md), plus:
-
-#### `symbol`
-- **Type:** string
-- **Description:** The grouping symbol character (e.g., '(' or ')')
-
-#### `type`
-- **Type:** string
-- **Description:** Always "parenthesis"
-
-#### `textElement`
-- **Type:** jsvgTextLine
-- **Description:** The SVG text element displaying the symbol
-
-### Methods
-
-Inherits all methods from [`omdLeafNode`](./omdLeafNode.md), plus:
-
-#### `parseSymbol(nodeData)`
-Internal method to extract symbol from input.
-- **Returns:** string - The input symbol unchanged
-
----
-
-#### `parseType()`
-Internal method to set node type.
-- **Returns:** "parenthesis"
-
----
-
-#### `clone()`
-Creates a clone of the group node.
-- **Returns:** omdGroupNode - A new instance with:
-  - Same text content
-  - Original node's ID added to provenance array
-
----
-
-#### `computeDimensions()`
-Calculates node dimensions based on text content.
-Does NOT add padding, unlike other leaf nodes.
-Overrides base class method.
-
----
-
-#### `updateLayout()`
-Updates the position of the node.
-Overrides base class method.
-
----
-
-#### `toMathJSNode()`
-Converts to math.js AST format.
-- **Returns:** Object - A math.js-compatible AST node with:
-  - `type`: "SymbolNode"
-  - `name`: The grouping symbol
-
-### Example
-
-```javascript
-// Create grouping symbols
-const leftParen = new omdGroupNode('(');
-const rightParen = new omdGroupNode(')');
-const leftBracket = new omdGroupNode('[');
-
-// Render a symbol
-const node = new omdGroupNode('(');
-node.setFontSize(24);
-node.computeDimensions(); // Calculate size (no padding)
-node.updateLayout(); // Position the text element
-```
-
-### See Also
-
-- [omdLeafNode](./omdLeafNode.md) - Parent class
-- [omdNode](./omdNode.md) - Base class
-- [omdParenthesisNode](./omdParenthesisNode.md) - For complete parenthetical expressions
+# omdGroupNode
+
+Represents a single grouping symbol, such as `(` or `)`, as a leaf node in the expression tree. This node is primarily used for visual representation and layout, rather than mathematical operations.
+
+## Class Definition
+
+```javascript
+export class omdGroupNode extends omdLeafNode
+```
+
+## Constructor
+
+### `new omdGroupNode(nodeData)`
+
+Creates a new `omdGroupNode` instance.
+
+-   **`nodeData`** (`string`): The single character string representing the grouping symbol (e.g., `'('`, `')'`, `'['`, `']'`).
+
+## Public Properties
+
+-   **`symbol`** (`string`): The grouping symbol character (e.g., `'('`).
+-   **`type`** (`string`): Always `"parenthesis"` for this node type.
+-   **`textElement`** (`jsvgTextLine`): The internal `jsvgTextLine` instance responsible for rendering the symbol.
+
+## Public Methods
+
+### `clone()`
+
+Creates a deep clone of the group node. The new node's `provenance` array is updated to include the original node's ID.
+
+-   **Returns**: `omdGroupNode` - A new, identical instance of the group node.
+
+### `computeDimensions()`
+
+Calculates the dimensions of the node based on its text content. Unlike other leaf nodes, `omdGroupNode` does *not* add extra padding around the symbol, allowing for tighter visual integration.
+
+-   **Overrides**: `omdLeafNode.computeDimensions()`.
+
+### `updateLayout()`
+
+Updates the position of the node's internal text element. This method primarily calls the superclass's `updateLayout`.
+
+-   **Overrides**: `omdLeafNode.updateLayout()`.
+
+### `toMathJSNode()`
+
+Converts the `omdGroupNode` to a math.js-compatible AST format. It represents the grouping symbol as a `SymbolNode`.
+
+-   **Returns**: `object` - A math.js-compatible AST node with `type: "SymbolNode"` and `name` set to the grouping symbol. The returned object also includes a `clone` method for compatibility.
+
+## Internal Methods
+
+-   **`parseSymbol(nodeData)`**: Extracts the symbol from the constructor's `nodeData`. Returns the input string unchanged.
+-   **`parseType()`**: Sets the node's type. Always returns `"parenthesis"`.
+
+## Example
+
+```javascript
+// Create grouping symbols
+const leftParen = new omdGroupNode('(');
+const rightParen = new omdGroupNode(')');
+const leftBracket = new omdGroupNode('[');
+
+// Render a symbol
+const node = new omdGroupNode('(');
+node.setFontSize(24);
+node.initialize(); // Computes dimensions and layout
+
+// Add to an SVG container to display
+// const svgContainer = new jsvgContainer();
+// svgContainer.addChild(node);
+// document.body.appendChild(svgContainer.svgObject);
+```
+
+## See Also
+
+-   [`omdLeafNode`](./omdLeafNode.md) - The parent class for all leaf nodes.
+-   [`omdNode`](./omdNode.md) - The base class for all OMD nodes.
+-   [`omdParenthesisNode`](./omdParenthesisNode.md) - For complete parenthetical expressions that contain other nodes.

package/docs/api/omdHelpers.md

@@ -1,96 +1,88 @@
-
-# omdHelpers
-
-`omdHelpers` is a collection of convenience functions designed to simplify common tasks when working with the OMD library. These helpers abstract away underlying complexities, making it easier to create and manipulate mathematical expressions and visualizations.
-
-## Overview
-
-The `omdHelpers` object is exported from the main `omd/index.js` entry point, making its functions readily available for use in your project.
-
-## Functions
-
-### `createNodeFromExpression(expression, mathjs)`
-
-Creates an `omdNode` instance from a string representation of a mathematical expression. This function parses the expression using math.js and instantiates the appropriate `omdNode` subclass.
-
-- **Parameters:**
-    - `expression` {string} - The mathematical expression as a string (e.g., `"x^2 + 2x + 1"`).
-    - `mathjs` {object} - The math.js instance to use for parsing the expression.
-- **Returns:** {omdNode} The root `omdNode` of the created expression tree.
-
-```javascript
-import { omdHelpers } from 'omd-library';
-import * as math from 'mathjs';
-
-const expressionNode = omdHelpers.createNodeFromExpression('2x + 5', math);
-// expressionNode will be an instance of omdBinaryExpressionNode or another omdNode subclass
-```
-
----
-
-### `createEquation(equationString)`
-
-Creates an `omdEquationNode` instance from a string representation of an equation. This is a specialized helper for equations, ensuring proper parsing and node creation.
-
-- **Parameters:**
-    - `equationString` {string} - The equation as a string (e.g., `"x + 2 = 5"`).
-- **Returns:** {omdEquationNode} The created `omdEquationNode`.
-
-```javascript
-import { omdHelpers } from 'omd-library';
-
-const equation = omdHelpers.createEquation('3y - 7 = 14');
-// equation will be an instance of omdEquationNode
-```
-
----
-
-### `createStepVisualizer(equationStrings)`
-
-Creates an `omdStepVisualizer` instance from an array of equation strings. This is useful for quickly setting up a step-by-step solution display.
-
-- **Parameters:**
-    - `equationStrings` {Array<string>} - An array of strings, where each string represents an equation step (e.g., `["2x = 10", "x = 5"]`).
-- **Returns:** {omdStepVisualizer} The created `omdStepVisualizer` instance.
-
-```javascript
-import { omdHelpers } from 'omd-library';
-
-const steps = [
-    '4x + 8 = 20',
-    '4x = 12',
-    'x = 3'
-];
-const visualizer = omdHelpers.createStepVisualizer(steps);
-// visualizer will be an instance of omdStepVisualizer
-```
-
-## Example Usage
-
-```javascript
-import { omdDisplay, omdHelpers } from 'omd-library';
-import * as math from 'mathjs';
-
-// Get a container element (assuming it exists in your HTML)
-const container = document.getElementById('math-display-area');
-
-// Create an expression node using a helper
-const expression = omdHelpers.createNodeFromExpression('a^2 + b^2', math);
-
-// Create an equation using a helper
-const equation = omdHelpers.createEquation('E = mc^2');
-
-// Create a step visualizer using a helper
-const solutionSteps = [
-    'x + 5 = 10',
-    'x = 5'
-];
-const stepVisualizer = omdHelpers.createStepVisualizer(solutionSteps);
-
-// You can then render these nodes using omdDisplay or omdCanvas
-const display = new omdDisplay(container);
-display.render(expression);
-
-// Or for the step visualizer
-// display.render(stepVisualizer);
-```
+# omdHelpers
+
+`omdHelpers` is a collection of convenience functions designed to simplify common tasks when working with the OMD library. These helpers abstract away underlying complexities, making it easier to create and manipulate mathematical expressions and visualizations.
+
+## Overview
+
+The `omdHelpers` object is exported from the main `omd/core/index.js` entry point, making its functions readily available for use in your project.
+
+## Functions
+
+### `createNodeFromExpression(expression, mathInstance)`
+
+Creates an `omdNode` instance from a string representation of a mathematical expression. This function parses the expression using the provided math.js instance and instantiates the appropriate `omdNode` subclass.
+
+-   **`expression`** (`string`): The mathematical expression as a string (e.g., `"x^2 + 2x + 1"`).
+-   **`mathInstance`** (`object`): The math.js instance to use for parsing the expression (e.g., `window.math`).
+-   **Returns**: `omdNode` - The root `omdNode` of the created expression tree.
+
+```javascript
+import { omdHelpers } from '@teachinglab/omd';
+// Assuming math.js is loaded globally as window.math
+
+const expressionNode = omdHelpers.createNodeFromExpression('2x + 5', window.math);
+// expressionNode will be an instance of omdBinaryExpressionNode or another omdNode subclass
+```
+
+### `createEquation(equationString)`
+
+Creates an `omdEquationNode` instance from a string representation of an equation. This is a specialized helper for equations, ensuring proper parsing and node creation.
+
+-   **`equationString`** (`string`): The equation as a string (e.g., `"x + 2 = 5"`).
+-   **Returns**: `omdEquationNode` - The created `omdEquationNode`.
+
+```javascript
+import { omdHelpers } from '@teachinglab/omd';
+
+const equation = omdHelpers.createEquation('3y - 7 = 14');
+// equation will be an instance of omdEquationNode
+```
+
+### `createStepVisualizer(equationStrings)`
+
+Creates an `omdStepVisualizer` instance from an array of equation strings. This is useful for quickly setting up a step-by-step solution display.
+
+-   **`equationStrings`** (`Array<string>`): An array of strings, where each string represents an equation step (e.g., `["2x = 10", "x = 5"]`).
+-   **Returns**: `omdStepVisualizer` - The created `omdStepVisualizer` instance.
+
+```javascript
+import { omdHelpers } from '@teachinglab/omd';
+
+const steps = [
+    '4x + 8 = 20',
+    '4x = 12',
+    'x = 3'
+];
+const visualizer = omdHelpers.createStepVisualizer(steps);
+// visualizer will be an instance of omdStepVisualizer
+```
+
+## Example Usage
+
+```javascript
+import { omdDisplay, omdHelpers } from '@teachinglab/omd';
+// Assuming math.js is loaded globally as window.math
+
+// Get a container element (assuming it exists in your HTML)
+const container = document.getElementById('math-display-area');
+
+// Create an expression node using a helper
+const expression = omdHelpers.createNodeFromExpression('a^2 + b^2', window.math);
+
+// Create an equation using a helper
+const equation = omdHelpers.createEquation('E = mc^2');
+
+// Create a step visualizer using a helper
+const solutionSteps = [
+    'x + 5 = 10',
+    'x = 5'
+];
+const stepVisualizer = omdHelpers.createStepVisualizer(solutionSteps);
+
+// You can then render these nodes using omdDisplay or omdCanvas
+const display = new omdDisplay(container);
+display.render(expression);
+
+// Or for the step visualizer
+// display.render(stepVisualizer);
+```