@teachinglab/omd 0.1.3 → 0.1.5

package/docs/api/omdConfigManager.md

@@ -1,192 +1,113 @@
-# omdConfigManager
-
-A module for managing the configuration of the OMD library. It handles loading settings from a JSON file, providing default values, and allowing runtime modifications.
-
-## Overview
-
-The configuration is managed as a single JSON object. The system can be initialized with a path to a `omdConfig.json` file, or it will fall back to a default configuration. The manager supports both asynchronous and synchronous access to configuration values.
-
-### Default Configuration
-
-If no `omdConfig.json` is found, the following default structure is used:
-
-```json
-{
-    "multiplication": {
-        "symbol": "·",
-        "forceImplicit": false,
-        "implicitCombinations": {
-            "constantVariable": true,
-            "variableConstant": false,
-            "parenthesisAfterVariable": true,
-            "parenthesisAfterConstant": true,
-            "variableParenthesis": true,
-            "parenthesisParenthesis": true,
-            "parenthesisVariable": true,
-            "parenthesisConstant": true,
-            "variableVariable": true
-        }
-    },
-    "stepVisualizer": {
-        "dotSizes": {
-            "level0": 8,
-            "level1": 6,
-            "level2": 4
-        },
-        "fontWeights": {
-            "level0": 400,
-            "level1": 300,
-            "level2": 200
-        }
-    }
-}
-```
-
-## Core Functions
-
-
-```javascript
-import {
-  initializeConfig,
-  getConfig,
-  getConfigSync,
-  setConfig,
-  getConfigValue,
-  setConfigValue,
-  getDefaultConfig,
-  isEnabled,
-  useImplicitMultiplication,
-  getMultiplicationSymbol,
-  updateConfig,
-  resetConfig,
-  reloadConfig,
-  getConfigAsync,
-  getDotRadius,
-  getFontWeight
-} from 'omd-library';
-```
-
-
-#### `initializeConfig(configSource)`
-Loads the configuration. This should be called once when your application starts.
-- **Parameters:**
-  - `configSource` {string | Object} (optional) - A path to a JSON configuration file or a configuration object to use directly.
-- **Returns:** `Promise<void>`
-
-```javascript
-// Load from default path ('./omd/config/omdConfig.json')
-await initializeConfig();
-
-// Or load from a specific path
-await initializeConfig('./my-custom-config.json');
-
-// Or provide a config object directly
-await initializeConfig({ multiplication: { symbol: '*' } });
-```
-
----
-
-
-#### `getConfig()`
-Asynchronously gets the entire configuration object. Loads it with defaults if it hasn't been loaded yet.
-- **Returns:** `Promise<Object>` - A promise that resolves to the configuration object.
-
----
-
-
-#### `getConfigSync()`
-Synchronously gets the entire configuration object. **Note:** If the configuration has not been loaded yet, this will return the default configuration.
-- **Returns:** `Object` - The configuration object.
-
----
-
-
-#### `setConfig(config)`
-Sets the entire configuration, merging it with the default values.
-- **Parameters:**
-  - `config` {Object} - The configuration object to set.
-
----
-
-
-#### `getConfigValue(path)`
-Gets a specific configuration value using a dot-separated path.
-- **Parameters:**
-  - `path` {string} - The path to the value (e.g., `'multiplication.symbol'`).
-- **Returns:** `any` - The value at the specified path.
-
----
-
-
-#### `setConfigValue(path, value)`
-Sets a specific configuration value using a dot-separated path.
-- **Parameters:**
-  - `path` {string} - The path to the value.
-  - `value` {any} - The new value to set.
-
-
-## Utility Functions
-
-#### `getMultiplicationSymbol()`
-- **Returns:** `string` - The configured symbol for multiplication.
-
-#### `useImplicitMultiplication(combination)`
-- **Parameters:**
-  - `combination` {string} (optional) - The context of the multiplication (e.g., `'constantVariable'`).
-- **Returns:** `boolean` - Whether to use implicit multiplication in that context or globally if no combination is provided.
-
-#### `getDotRadius(level)`
-- **Parameters:**
-  - `level` {number} - The step level (0, 1, or 2).
-- **Returns:** `number` - The configured dot radius for that level in the step visualizer.
-
-#### `getFontWeight(level)`
-- **Parameters:**
-  - `level` {number} - The step level (0, 1, or 2).
-- **Returns:** `number` - The configured font weight for that level.
-#### `getDefaultConfig()`
-- **Returns:** `Object` - The default configuration object.
-
-#### `isEnabled(category, setting)`
-- **Parameters:**
-  - `category` {string} - The configuration category (e.g., 'multiplication').
-  - `setting` {string} - The specific setting to check.
-- **Returns:** `boolean` - Whether the setting is enabled.
-
-#### `updateConfig(category, setting, value)`
-- **Parameters:**
-  - `category` {string} - The configuration category.
-  - `setting` {string} - The setting to update.
-  - `value` {any} - The new value.
-
-#### `resetConfig()`
-- **Throws:** Always throws an error. (Direct file editing is required.)
-
-#### `reloadConfig()`
-- **Returns:** `Promise<Object>` - Promise that resolves to the reloaded configuration.
-
-#### `getConfigAsync()`
-- **Returns:** `Promise<Object>` - Promise that resolves to the configuration object.
-
-
-## Example Usage
-
-```javascript
-import { initializeConfig, getConfigValue, setConfigValue, getMultiplicationSymbol } from 'omd-library';
-
-// Initialize at the start of your application
-(async () => {
-    await initializeConfig();
-
-    // Get a specific value
-    const multSymbol = getConfigValue('multiplication.symbol');
-    console.log(`Multiplication symbol is: ${multSymbol}`); // Output: ·
-
-    // Or use a dedicated utility function
-    console.log(`Multiplication symbol is: ${getMultiplicationSymbol()}`); // Output: ·
-
-    // Change a value at runtime
-    setConfigValue('multiplication.symbol', '*');
-    console.log(`New multiplication symbol is: ${getMultiplicationSymbol()}`); // Output: *
-})();
-```
+# omdConfigManager
+
+A module for managing the configuration of the OMD library. It handles loading settings from a JSON file, providing default values, and allowing runtime modifications.
+
+## Overview
+
+The configuration is managed as a single JSON object. The system can be initialized with a path to a `omdConfig.json` file, or it will fall back to a default configuration. The manager supports both asynchronous and synchronous access to configuration values.
+
+### Default Configuration
+
+If no `omdConfig.json` is found, the following default structure is used:
+
+```json
+{
+    "multiplication": {
+        "symbol": "·",
+        "forceImplicit": false,
+        "implicitCombinations": {
+            "constantVariable": true,
+            "variableConstant": false,
+            "parenthesisAfterVariable": true,
+            "parenthesisAfterConstant": true,
+            "variableParenthesis": true,
+            "parenthesisParenthesis": true,
+            "parenthesisVariable": true,
+            "parenthesisConstant": true,
+            "variableVariable": true
+        }
+    },
+    "stepVisualizer": {
+        "dotSizes": {
+            "level0": 8,
+            "level1": 6,
+            "level2": 4
+        },
+        "fontWeights": {
+            "level0": 400,
+            "level1": 400,
+            "level2": 400
+        }
+    }
+}
+```
+
+## Core Functions
+
+### `async initializeConfig(configSource)`
+
+Loads the configuration from a file or object. It automatically detects the environment (browser or Node.js) to use the appropriate file loading mechanism (`fetch` or `fs`). This should be called once when your application starts.
+
+-   **`configSource`** (`string` | `object`, optional): A path to a JSON configuration file or a configuration object to use directly.
+-   **Returns**: `Promise<void>`
+
+### `async getConfig()`
+
+Asynchronously gets the entire configuration object. If it hasn't been loaded yet, it will trigger the loading process with default settings.
+
+-   **Returns**: `Promise<object>` - A promise that resolves to the configuration object.
+
+### `getConfigSync()`
+
+Synchronously gets the configuration object. 
+
+**Warning:** If called before `initializeConfig` has completed, this will return the default configuration, not the loaded one.
+
+-   **Returns**: `object` - The configuration object.
+
+### `setConfig(config)`
+
+Sets the entire configuration directly, merging it with the default values.
+
+-   **`config`** (`object`): The configuration object to set.
+
+### `getConfigValue(path)`
+
+Gets a specific configuration value using a dot-separated path (e.g., `'multiplication.symbol'`).
+
+-   **Returns**: The value at the specified path.
+
+### `setConfigValue(path, value)`
+
+Sets a specific configuration value using a dot-separated path.
+
+## Utility Functions
+
+-   **`getMultiplicationSymbol()`**: Returns the configured symbol for multiplication.
+-   **`useImplicitMultiplication(combination)`**: Checks if implicit multiplication should be used, either globally or for a specific combination of operand types.
+-   **`getDotRadius(level)`**: Gets the dot radius for a given step level in the `omdStepVisualizer`.
+-   **`getFontWeight(level)`**: Gets the font weight for a given step level.
+-   **`getDefaultConfig()`**: Returns a copy of the default configuration object.
+-   **`isEnabled(category, setting)`**: Checks if a specific boolean setting is enabled.
+-   **`updateConfig(category, setting, value)`**: Updates a top-level configuration setting.
+-   **`resetConfig()`**: Throws an error. Direct file editing is required to reset the configuration.
+-   **`async reloadConfig()`**: Forces a reload of the configuration from the original file path.
+-   **`async getConfigAsync()`**: An alias for `getConfig()`.
+
+## Example
+
+```javascript
+import { initializeConfig, getConfigValue, setConfigValue } from '@teachinglab/omd';
+
+// Initialize at the start of your application
+(async () => {
+    await initializeConfig();
+
+    // Get a specific value
+    const multSymbol = getConfigValue('multiplication.symbol'); // -> '·'
+
+    // Change a value at runtime
+    setConfigValue('multiplication.symbol', '*');
+    const newSymbol = getConfigValue('multiplication.symbol'); // -> '*'
+})();
+```

package/docs/api/omdConstantNode.md

@@ -1,117 +1,53 @@
-# omdConstantNode
-
-Represents a numeric constant in a mathematical expression. This is a leaf node, meaning it has no children.
-
-## Class: `omdConstantNode extends omdLeafNode`
-
-```javascript
-import { omdConstantNode } from './omd/nodes/omdConstantNode.js';
-```
-
-### Constructor
-
-```javascript
-new omdConstantNode(nodeData)
-```
-
-
-**Parameters:**
-- `nodeData` {Object|number} - The math.js AST node data (should have a `value` property) or a raw numeric value.
-
-**Description:**
-Creates a node representing a numeric constant. This is typically done automatically by the parser when an expression is processed.
-
-### Static Methods
-
-
-#### `fromValue(value)`
-Creates an `omdConstantNode` from a simple numeric value.
-
-```javascript
-const constantNode = omdConstantNode.fromValue(42);
-```
-- **Parameters:**
-  - `value` {number} - The numeric value for the constant.
-- **Returns:** `omdConstantNode` A new instance of `omdConstantNode`.
-
-### Properties
-
-Inherits all properties from [`omdLeafNode`](./omdLeafNode.md), plus:
-
-
-#### `number`
-- **Type:** `number`
-- **Description:** The numeric value of the constant.
-
-### Methods
-
-Inherits all methods from [`omdLeafNode`](./omdLeafNode.md). Key methods include:
-
-
-#### `getValue()`
-Gets the numeric value of the constant.
-- **Returns:** `number` - The constant's value.
-
----
-
-
-#### `evaluate()`
-Evaluates the node, which for a constant simply returns its value.
-- **Returns:** `number` - The numeric value.
-
----
-
-
-#### `getRationalValue()`
-Gets the value as a rational number (a fraction with a denominator of 1).
-- **Returns:** `Object` - An object `{ num: number, den: 1 }`.
-
----
-
-
-#### `toMathJSNode()`
-Converts the node to its math.js AST representation.
-- **Returns:** `Object` - A math.js-compatible AST node for a constant, with a `clone()` method for compatibility.
-
----
-
-
-#### `simplify()`
-A constant cannot be simplified further.
-- **Returns:** `Object` - An object indicating failure: `{ success: false, ... }`.
-
----
-
-
-#### `toString()`
-Converts the node to its string representation.
-- **Returns:** `string` - The numeric value as a string.
-
-
-#### `isConstant()`
-Checks if the node is a constant (always true for omdConstantNode).
-- **Returns:** `boolean`
-
-### Example
-
-```javascript
-// Create a constant node from a number
-const pi = omdConstantNode.fromValue(3.14159);
-
-// Set its font size and render it
-pi.setFontSize(24);
-pi.initialize(); // Computes dimensions and layout
-
-// Get its value
-console.log(pi.getValue()); // 3.14159
-
-// Add it to an SVG container to display
-const svgContainer = new jsvgContainer();
-svgContainer.addChild(pi);
-document.body.appendChild(svgContainer.svgObject);
-```
-
-### See Also
-
-- [`omdLeafNode`](./omdLeafNode.md) - The parent class.
-- [`omdVariableNode`](./omdVariableNode.md) - For symbolic variables like 'x'.
+# omdConstantNode
+
+Represents a numeric constant in a mathematical expression. This node is a leaf node in the expression tree, meaning it does not have any children.
+
+## Class Definition
+
+```javascript
+export class omdConstantNode extends omdLeafNode
+```
+
+## Constructor
+
+### `new omdConstantNode(ast)`
+
+Creates a new `omdConstantNode` instance.
+
+-   **`ast`** (`object`): The abstract syntax tree (AST) node from a parser like math.js. It must contain:
+    -   `value`: The numeric value of the constant.
+
+## Public Properties
+
+-   **`value`** (`number`): The numeric value of the constant.
+
+## Public Methods
+
+### `isConstant()`
+
+Checks if the node represents a constant value.
+
+-   **Returns**: `boolean` - Always `true` for `omdConstantNode`.
+
+### `evaluate()`
+
+Evaluates the constant node. Since it's a constant, it simply returns its value.
+
+-   **Returns**: `number` - The numeric value of the constant.
+
+### `toMathJSNode()`
+
+Converts the node back into a math.js-compatible AST format.
+
+-   **Returns**: `object` - A math.js ConstantNode.
+
+### `toString()`
+
+Converts the constant node into its string representation.
+
+-   **Returns**: `string` - The string representation of the constant.
+
+## Internal Methods
+
+-   **`computeDimensions()`**: Calculates the bounding box of the constant.
+-   **`updateLayout()`**: Positions the constant within its bounding box.