@teachinglab/omd 0.5.7 → 0.5.8

package/index.js

@@ -36,6 +36,9 @@ export { omdBalanceHanger } from './src/omdBalanceHanger.js';
 export { omdCoordinatePlane } from './src/omdCoordinatePlane.js';
 export { omdTapeDiagram } from './src/omdTapeDiagram.js';
 
+// Export factory functions
+export { createFromJSON, getSupportedTypes, isTypeSupported } from './src/omdFactory.js';
+
 // Default export combining core and visualizations
 export default {
     // Core OMD framework (from omd/core/index.js)

package/npm-docs/DOCUMENTATION_SUMMARY.md

@@ -0,0 +1,220 @@
+# NPM Documentation Summary
+
+This document provides an overview of the organized NPM documentation structure for the OMD library.
+
+## 📁 Folder Structure
+
+```
+npm-docs/
+├── README.md                          # Main entry point (start here!)
+├── json-schemas.md                    # Complete JSON reference for all components
+├── guides/                            # User guides and tutorials
+│   ├── getting-started.md             # Installation and basic setup
+│   ├── quick-examples.md              # Code examples for common use cases
+│   ├── visualizations.md              # Complete visualization components guide
+│   └── equations.md                   # Complete equations and expressions guide
+└── api/                               # Detailed API documentation
+    ├── api-reference.md               # Main API reference
+    └── [individual component docs]    # Copied from docs/api/
+```
+
+## 📖 Documentation Organization
+
+The documentation follows the requested presentation order:
+
+### 1. **Global Context & Configuration** (First)
+   - Configuration Manager
+   - Display System
+   - Canvas System
+   - Event Manager
+   - Helpers & Utilities
+
+### 2. **Visualizations** (Second)
+   - Number & Ratio Visualizations
+     - Number Line
+     - Number Tiles
+     - Tape Diagrams
+     - Ratio Charts
+     - Balance Hanger
+   - Graphing & Geometry
+     - Coordinate Plane
+     - Shapes
+     - Spinner
+   - Data Display
+     - Tables
+     - Function Graphs
+
+### 3. **Equations & Expressions** (Third - Separate Section)
+   - Core Components
+     - Numbers
+     - Variables
+     - Operators
+     - Terms
+     - Expressions
+     - Equations
+   - Advanced Expressions
+     - Power Expressions
+     - Rational Expressions
+     - Functions
+     - Tile Equations
+   - Step-by-Step Solutions
+     - Equation Stack
+     - Step Visualizer
+     - Simplification Engine
+
+## 🚀 Quick Navigation
+
+### For New Users
+1. **Start Here**: `README.md`
+2. **Get Setup**: `guides/getting-started.md`
+3. **Try Examples**: `guides/quick-examples.md`
+
+### For Developers
+1. **JSON Reference**: `json-schemas.md`
+2. **Visualizations**: `guides/visualizations.md`
+3. **Equations**: `guides/equations.md`
+4. **API Details**: `api/api-reference.md`
+
+## 📝 Key Files
+
+### README.md
+- **Purpose**: Main entry point for NPM documentation
+- **Content**: 
+  - Quick start guide
+  - Feature overview
+  - Documentation index organized by the 3 main categories
+  - Installation instructions
+  - Basic examples
+
+### json-schemas.md
+- **Purpose**: Complete JSON reference for all components
+- **Content**:
+  - Organized by category (Global Context, Visualizations, Equations)
+  - TypeScript-style type definitions
+  - JSON schema for each component
+  - Usage examples for each component
+  - Corrected and verified against source code
+
+### guides/getting-started.md
+- **Purpose**: Installation and basic setup
+- **Content**:
+  - Installation instructions (npm/yarn)
+  - Basic setup example
+  - Complete HTML example
+  - Common use cases
+  - Configuration options
+  - Integration with build tools (Vite, Webpack, React)
+  - Troubleshooting guide
+  - Browser support
+
+### guides/visualizations.md
+- **Purpose**: Complete guide to all visualization components
+- **Content**:
+  - Number & Ratio visualizations
+  - Graphing & Geometry components
+  - Data display components
+  - Properties tables for each component
+  - Multiple examples for each component
+  - Best practices
+
+### guides/equations.md
+- **Purpose**: Complete guide to equations and expressions
+- **Content**:
+  - Core components (numbers, variables, operators, terms)
+  - Expressions and equations
+  - Advanced expressions (power, rational, functions)
+  - Tile equations
+  - Step-by-step solutions
+  - Simplification engine
+  - Expression parsing
+  - Best practices
+
+### guides/quick-examples.md
+- **Purpose**: Ready-to-use code examples
+- **Content**:
+  - Basic equations
+  - Visualization examples
+  - Step-by-step solutions
+  - Advanced features
+  - Complete working HTML example
+
+## ✅ Verification Checklist
+
+- [x] Main README.md created with proper organization
+- [x] json-schemas.md corrected and verified
+- [x] Getting started guide created
+- [x] Visualizations guide created (comprehensive)
+- [x] Equations guide created (comprehensive)
+- [x] Quick examples guide created
+- [x] API documentation copied to npm-docs/api
+- [x] Documentation follows requested order: Global Context → Visualizations → Equations
+
+## 🎯 Next Steps (Before Publishing)
+
+1. **Review the documentation**:
+   - Check `npm-docs/README.md` for accuracy
+   - Verify `json-schemas.md` schemas are correct
+   - Review all guide files
+
+2. **Update package.json** (when ready):
+   ```json
+   {
+     "files": [
+       "index.js",
+       "src/",
+       "omd/",
+       "npm-docs/",
+       "canvas/",
+       "jsvg/"
+     ]
+   }
+   ```
+
+3. **Test the documentation**:
+   - Verify all examples work
+   - Check all internal links
+   - Ensure code samples are accurate
+
+4. **Publish** (when approved):
+   ```bash
+   npm version patch  # or minor/major
+   npm publish
+   ```
+
+## 📋 Documentation Standards Used
+
+- **Markdown formatting**: Proper headings, code blocks, tables
+- **Code examples**: Syntax-highlighted JavaScript
+- **Consistent structure**: Each component documented with:
+  - Basic usage
+  - Properties table
+  - Multiple examples
+  - JSON schema
+- **Navigation aids**: Table of contents, cross-references
+- **Accessibility**: Clear descriptions, organized content
+
+## 🔗 Internal Link Structure
+
+All documentation files are cross-linked:
+- README.md → All guides and API docs
+- Each guide → Related guides and API reference
+- json-schemas.md → API reference and guides
+
+## 📊 Coverage
+
+The documentation covers:
+- ✅ All visualization components
+- ✅ All equation components
+- ✅ Configuration system
+- ✅ Step-by-step solution system
+- ✅ JSON schemas for all components
+- ✅ Installation and setup
+- ✅ Integration guides (React, Vite, Webpack)
+- ✅ Best practices
+- ✅ Troubleshooting
+
+---
+
+**Documentation Status**: ✅ Complete and ready for review
+
+**Do NOT publish to NPM until reviewed and approved!**

package/npm-docs/README.md

@@ -0,0 +1,251 @@
+# OMD (Open Math Display)
+
+> A JavaScript library for creating interactive mathematical interfaces in web applications
+
+[![npm version](https://img.shields.io/npm/v/@teachinglab/omd.svg)](https://www.npmjs.com/package/@teachinglab/omd)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+OMD is a comprehensive JavaScript library for building rich, interactive mathematical experiences in the browser. From simple equation displays to complex step-by-step solution systems with full visual feedback and user interaction.
+
+![OMD Demo](https://i.imgur.com/CdtEi33.png)
+
+## Quick Start
+
+### Installation
+
+```bash
+npm install @teachinglab/omd
+```
+
+### Basic Usage
+
+```javascript
+import { omdDisplay } from '@teachinglab/omd';
+
+// Create a math display
+const container = document.getElementById('math-container');
+const display = new omdDisplay(container);
+
+// Render an equation
+display.render('2x + 3 = 11');
+```
+
+## Documentation
+
+### Getting Started
+- **[Installation & Setup](./guides/getting-started.md)** - Get up and running with OMD
+- **[Quick Examples](./guides/quick-examples.md)** - Common use cases and code snippets
+- **[Factory Functions](./guides/factory-functions.md)** - Creating objects from JSON (AI-friendly)
+
+### Core Concepts
+
+#### 1. Global Context & Configuration
+Learn about the foundational systems that power OMD:
+
+- **[Configuration Manager](./api/omdConfigManager.md)** - Library-wide settings and theming
+- **[Configuration Options](./api/configuration-options.md)** - Complete list of available settings
+- **[Display System](./api/omdDisplay.md)** - Main rendering engine
+- **[Canvas System](./api/omdCanvas.md)** - Multi-expression layout manager
+- **[Event Manager](./api/eventManager.md)** - Event handling and coordination
+- **[Helpers & Utilities](./api/omdHelpers.md)** - Utility functions for common tasks
+
+#### 2. Visualizations
+Interactive visual components for teaching and learning:
+
+##### Number & Ratio Visualizations
+- **[Number Line](./guides/visualizations.md#number-line)** - `omdNumberLine` - Interactive number lines with dots and labels
+- **[Number Tiles](./guides/visualizations.md#number-tiles)** - `omdNumberTile` - Visual counting tiles with dots
+- **[Tape Diagrams](./guides/visualizations.md#tape-diagrams)** - `omdTapeDiagram` - Part-whole relationship diagrams
+- **[Ratio Charts](./guides/visualizations.md#ratio-charts)** - `omdRatioChart` - Pie and bar chart ratio visualizations
+- **[Balance Hanger](./guides/visualizations.md#balance-hanger)** - `omdBalanceHanger` - Balance scale visualizations
+
+##### Graphing & Geometry
+- **[Coordinate Plane](./guides/visualizations.md#coordinate-plane)** - `omdCoordinatePlane` - 2D graphing with functions and shapes
+- **[Shapes](./guides/visualizations.md#shapes)** - `omdShapes` - Geometric shapes (circles, rectangles, polygons, triangles)
+- **[Spinner](./guides/visualizations.md#spinner)** - `omdSpinner` - Interactive circular spinners
+
+##### Data Display
+- **[Tables](./guides/visualizations.md#tables)** - `omdTable` - Data tables with customizable styling
+- **[Function Graphs](./guides/visualizations.md#function-graphs)** - Plotting mathematical functions
+
+#### 3. Equations & Expressions
+The heart of mathematical notation and manipulation:
+
+##### Core Expression Components
+- **[Expression Nodes](./api/expression-nodes.md)** - Understanding the node tree structure and omdEquationNode class
+- **[omdEquationNode](./api/omdEquationNode.md)** - Complete equations with manipulation methods (e.g., `2x + 3 = 11`)
+- **[omdExpression](./guides/equations.md#expressions)** - Mathematical expressions (e.g., `3x² + 5`)
+- **[omdTerm](./guides/equations.md#terms)** - Individual terms (e.g., `3x²`)
+- **[omdNumber](./guides/equations.md#numbers)** - Numeric constants
+- **[omdVariable](./guides/equations.md#variables)** - Variables (e.g., `x`, `y`)
+- **[omdOperator](./guides/equations.md#operators)** - Mathematical operators (+, -, ×, ÷)
+
+##### Advanced Expression Types
+- **[omdPowerExpression](./guides/equations.md#power-expressions)** - Exponentiation (e.g., `(x+1)²`)
+- **[omdRationalExpression](./guides/equations.md#rational-expressions)** - Fractions (e.g., `(x+1)/(x-1)`)
+- **[omdFunction](./guides/equations.md#functions)** - Mathematical functions (e.g., `f(x) = 2x + 1`)
+- **[omdTileEquation](./guides/equations.md#tile-equations)** - Visual tile-based equations
+
+##### Step-by-Step Solutions
+- **[Equation Stack](./api/omdEquationStack.md)** - Sequenced solution steps
+- **[Step Visualizer](./api/omdStepVisualizer.md)** - Interactive step visualization
+- **[Simplification Engine](./api/omdSimplification.md)** - Rule-based expression simplification
+- **[Simplification Rules](./api/simplificationRules.md)** - Available transformation rules
+
+### Complete API Reference
+- **[Full API Documentation](./api/api-reference.md)** - Complete reference for all components
+- **[JSON Schemas](./json-schemas.md)** - Detailed JSON structure for all components
+
+## Features
+
+### **Interactive Math Rendering**
+- High-quality SVG-based mathematical notation
+- Real-time expression manipulation and visualization
+- Automatic layout and alignment for complex equations
+
+### **Step-by-Step Solutions**
+- Visual step tracking with detailed explanations
+- Simplification engine with rule-based transformations
+- Provenance tracking for highlighting related elements
+
+### **Rich UI Components**
+- Built-in toolbar for common mathematical operations
+- Drag & drop interface for intuitive manipulation
+- Customizable canvas for multi-expression layouts
+
+### **Educational Features**
+- Interactive learning experiences
+- Progressive step revelation
+- Visual operation feedback and highlighting
+
+## Guides
+
+### By Use Case
+- **[Creating Equations](./guides/equations.md)** - Work with equations and expressions
+- **[Visualizations Guide](./guides/visualizations.md)** - All visualization components
+- **[Step-by-Step Solutions](./guides/step-by-step.md)** - Building interactive solutions
+- **[Interactive Features](./guides/interactive-features.md)** - Drag & drop, toolbars, and more
+
+### Advanced Topics
+- **[Expression Tree Structure](./guides/expression-tree.md)** - Understanding the AST
+- **[Custom Simplification Rules](./guides/custom-rules.md)** - Extending the simplification engine
+- **[Theming & Styling](./guides/theming.md)** - Customizing appearance
+- **[Performance Optimization](./guides/performance.md)** - Best practices for large applications
+
+## Architecture
+
+```
+OMD Library Structure
+├── Core Systems
+│   ├── Configuration Manager (Global settings)
+│   ├── Display System (Rendering engine)
+│   └── Event Manager (Coordination)
+│
+├── Visualizations
+│   ├── Number Visualizations (Number line, tiles, tape diagrams)
+│   ├── Graphing (Coordinate plane, functions)
+│   └── Data Display (Tables, charts)
+│
+└── Equations & Expressions
+    ├── Node System (Expression tree)
+    ├── Equation Components (Equations, terms, operators)
+    ├── Advanced Expressions (Powers, rationals, functions)
+    └── Step-by-Step System (Simplification, visualization)
+```
+
+## Examples
+
+### Creating Objects from JSON (Factory Method)
+
+```javascript
+import { createFromJSON } from '@teachinglab/omd';
+
+// AI-generated or dynamic JSON data
+const jsonData = {
+    omdType: 'numberLine',
+    min: 0,
+    max: 10,
+    dotValues: [2, 5, 8]
+};
+
+// Create the object - no switch statement needed!
+const numberLine = createFromJSON(jsonData);
+```
+
+### Basic Equation
+```javascript
+import { omdDisplay, omdEquationNode } from '@teachinglab/omd';
+
+const display = new omdDisplay(document.getElementById('container'));
+const equation = omdEquationNode.fromString('2x + 3 = 11');
+display.render(equation);
+```
+
+### Step-by-Step Solution
+```javascript
+import { omdEquationStack } from '@teachinglab/omd';
+
+const steps = [
+    '2x + 3 = 11',
+    '2x = 8',
+    'x = 4'
+];
+
+const stack = new omdEquationStack(steps.map(s => 
+    omdEquationNode.fromString(s)
+), {
+    toolbar: true,
+    stepVisualizer: true
+});
+
+display.render(stack);
+```
+
+### Coordinate Plane with Function
+```javascript
+import { omdCoordinatePlane } from '@teachinglab/omd';
+
+const plane = new omdCoordinatePlane();
+plane.loadFromJSON({
+    xMin: -10, xMax: 10,
+    yMin: -10, yMax: 10,
+    graphEquations: [
+        { equation: 'y = x^2 - 4', color: '#e11d48', strokeWidth: 2 }
+    ]
+});
+
+display.render(plane);
+```
+
+### Number Line Visualization
+```javascript
+import { omdNumberLine } from '@teachinglab/omd';
+
+const numberLine = new omdNumberLine();
+numberLine.loadFromJSON({
+    min: 0,
+    max: 10,
+    dotValues: [2, 5, 8],
+    label: 'Number Line Example'
+});
+
+display.render(numberLine);
+```
+
+## Dependencies
+
+- **JSVG** (`@teachinglab/jsvg`) - High-performance SVG rendering
+- **math.js** - Mathematical expression parsing
+- **Modern Browser** - ES6 modules, SVG support required
+
+## License
+
+MIT License - see [LICENSE](../LICENSE) for details
+
+## Contributing
+
+We welcome contributions! See our [contributing guidelines](../CONTRIBUTING.md) for more information.
+
+---
+
+**Ready to get started?** Check out the [Getting Started Guide](./guides/getting-started.md) or explore the [JSON Schemas](./json-schemas.md) for detailed component configurations.

package/npm-docs/api/api-reference.md

@@ -0,0 +1,85 @@
+# OMD Library API Reference
+
+> This is the complete API reference for the OMD (Open Math Display) library. Use the table of contents below to navigate to the detailed documentation for each module and class.
+
+---
+
+## Table of Contents
+
+The API is organized into the following categories for clarity:
+
+| Category                | Description                                                                       |
+| ----------------------- | --------------------------------------------------------------------------------- |
+| **[Core Components](#core-components)**    | The main entry points for rendering and managing expressions.                     |
+| **[Node Types](#node-types)**              | The building blocks of all mathematical expressions.                              |
+| **[UI Components](#ui-components)**        | Interactive components for user interfaces.                                       |
+| **[Helper Utilities](#helper-utilities)**  | Utility functions for common tasks like node creation and visualization.          |
+| **[Configuration](#configuration)**        | Modules for managing the library's settings and behavior.                         |
+| **[Simplification](#simplification)**      | The expression simplification engine and its components.                          |
+
+---
+
+
+### Core Components
+
+The foundational classes for interacting with the OMD library.
+
+- **[`omdNode`](./api/omdNode.md)**: The abstract base class for all mathematical nodes in the expression tree.
+- **[`omdDisplay`](./api/omdDisplay.md)**: A component for rendering a single, auto-centered mathematical expression.
+- **[`omdEquationStack`](./api/omdEquationStack.md)**: A component for managing and displaying a sequence of equation steps.
+
+### Node Types
+
+These classes represent the different parts of a mathematical expression.
+
+- **[`omdConstantNode`](./api/omdConstantNode.md)**: Represents numeric constants (e.g., `5`, `3.14`).
+- **[`omdVariableNode`](./api/omdVariableNode.md)**: Represents variables (e.g., `x`, `y`).
+- **[`omdBinaryExpressionNode`](./api/omdBinaryExpressionNode.md)**: Represents binary operations (`+`, `-`, `*`, `/`).
+- **[`omdUnaryExpressionNode`](./api/omdUnaryExpressionNode.md)**: Represents unary operations (e.g., negation `-x`).
+- **[`omdPowerNode`](./api/omdPowerNode.md)**: Represents exponentiation (`x^2`).
+- **[`omdSqrtNode`](./api/omdSqrtNode.md)**: Represents square roots (`√x`).
+- **[`omdRationalNode`](./api/omdRationalNode.md)**: Represents fractions and rational numbers (`x/y`).
+- **[`omdEquationNode`](./api/omdEquationNode.md)**: Represents equations with a left and right side.
+- **[`omdFunctionNode`](./api/omdFunctionNode.md)**: Represents mathematical functions (e.g., `sin(x)`).
+- **[`omdParenthesisNode`](./api/omdParenthesisNode.md)**: Represents expressions enclosed in parentheses.
+- **[`omdEquationSequenceNode`](./api/omdEquationSequenceNode.md)**: A container for displaying step-by-step solutions.
+- **[`omdOperationDisplayNode`](./api/omdOperationDisplayNode.md)**: Represents visual operation hints.
+- **[`omdGroupNode`](./api/omdGroupNode.md)**: A container for grouping related nodes.
+
+### UI Components
+
+Interactive components for building math interfaces.
+
+- **[`omdToolbar`](./api/omdToolbar.md)**: A customizable toolbar for mathematical operations.
+- **[`omdStepVisualizer`](./api/omdStepVisualizer.md)**: Component for visualizing step-by-step solutions.
+- **[`omdStepVisualizerHighlighting`](./api/omdStepVisualizerHighlighting.md)**: Manages highlighting of nodes in step visualizations.
+- **[`omdStepVisualizerLayout`](./api/omdStepVisualizerLayout.md)**: Handles layout and positioning of step visualizer elements.
+- **[`omdStepVisualizerTextBoxes`](./api/omdStepVisualizerTextBoxes.md)**: Manages interactive text boxes for step explanations.
+- **[`omdStepVisualizerInteractiveSteps`](./api/omdStepVisualizerInteractiveSteps.md)**: Creates interactive step elements for explanations.
+
+### Helper Utilities
+
+- **[`omdHelpers`](./api/omdHelpers.md)**: Utility functions for node creation.
+- **[`omdUtilities`](./api/omdUtilities.md)**: General utilities for AST mapping and text bounds.
+- **[`omdStepVisualizerNodeUtils`](./api/omdStepVisualizerNodeUtils.md)**: Utilities for node operations in step visualizations.
+- **[`omdTreeDiff`](./api/omdTreeDiff.md)**: Utilities for comparing expression trees.
+
+### Configuration
+
+- **[`omdConfigManager`](./api/omdConfigManager.md)**: The main object for managing library configuration.
+- **[`Configuration Options`](./api/configuration-options.md)**: A detailed list of all available configuration settings.
+
+### Simplification
+
+- **[`omdSimplification`](./api/omdSimplification.md)**: The main simplification module.
+- **[`omdSimplificationEngine`](./api/simplificationEngine.md)**: Core simplification engine.
+- **[`Simplification Rules`](./api/simplificationRules.md)**: Available simplification rules.
+- **[`Simplification Utilities`](./api/simplificationUtils.md)**: Helper functions for simplification rules.
+
+
+---
+
+
+## See Also
+- **[User Guide](user-guide.md)**: Getting started, usage, and tutorials (in progress)
+- **[Examples](../examples/)**: A directory of live, interactive examples.