@teachinglab/omd 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (144) hide show
  1. package/README.md +138 -0
  2. package/canvas/core/canvasConfig.js +203 -0
  3. package/canvas/core/omdCanvas.js +475 -0
  4. package/canvas/drawing/segment.js +168 -0
  5. package/canvas/drawing/stroke.js +386 -0
  6. package/canvas/events/eventManager.js +435 -0
  7. package/canvas/events/pointerEventHandler.js +263 -0
  8. package/canvas/features/focusFrameManager.js +287 -0
  9. package/canvas/index.js +49 -0
  10. package/canvas/tools/eraserTool.js +322 -0
  11. package/canvas/tools/pencilTool.js +319 -0
  12. package/canvas/tools/selectTool.js +457 -0
  13. package/canvas/tools/tool.js +223 -0
  14. package/canvas/tools/toolManager.js +394 -0
  15. package/canvas/ui/cursor.js +438 -0
  16. package/canvas/ui/toolbar.js +304 -0
  17. package/canvas/utils/boundingBox.js +378 -0
  18. package/canvas/utils/mathUtils.js +259 -0
  19. package/docs/api/configuration-options.md +104 -0
  20. package/docs/api/eventManager.md +68 -0
  21. package/docs/api/focusFrameManager.md +150 -0
  22. package/docs/api/index.md +91 -0
  23. package/docs/api/main.md +58 -0
  24. package/docs/api/omdBinaryExpressionNode.md +227 -0
  25. package/docs/api/omdCanvas.md +142 -0
  26. package/docs/api/omdConfigManager.md +192 -0
  27. package/docs/api/omdConstantNode.md +117 -0
  28. package/docs/api/omdDisplay.md +121 -0
  29. package/docs/api/omdEquationNode.md +161 -0
  30. package/docs/api/omdEquationSequenceNode.md +301 -0
  31. package/docs/api/omdEquationStack.md +139 -0
  32. package/docs/api/omdFunctionNode.md +141 -0
  33. package/docs/api/omdGroupNode.md +182 -0
  34. package/docs/api/omdHelpers.md +96 -0
  35. package/docs/api/omdLeafNode.md +163 -0
  36. package/docs/api/omdNode.md +101 -0
  37. package/docs/api/omdOperationDisplayNode.md +139 -0
  38. package/docs/api/omdOperatorNode.md +127 -0
  39. package/docs/api/omdParenthesisNode.md +122 -0
  40. package/docs/api/omdPopup.md +117 -0
  41. package/docs/api/omdPowerNode.md +127 -0
  42. package/docs/api/omdRationalNode.md +128 -0
  43. package/docs/api/omdSequenceNode.md +128 -0
  44. package/docs/api/omdSimplification.md +110 -0
  45. package/docs/api/omdSqrtNode.md +79 -0
  46. package/docs/api/omdStepVisualizer.md +115 -0
  47. package/docs/api/omdStepVisualizerHighlighting.md +61 -0
  48. package/docs/api/omdStepVisualizerInteractiveSteps.md +129 -0
  49. package/docs/api/omdStepVisualizerLayout.md +60 -0
  50. package/docs/api/omdStepVisualizerNodeUtils.md +140 -0
  51. package/docs/api/omdStepVisualizerTextBoxes.md +68 -0
  52. package/docs/api/omdToolbar.md +102 -0
  53. package/docs/api/omdTranscriptionService.md +76 -0
  54. package/docs/api/omdTreeDiff.md +134 -0
  55. package/docs/api/omdUnaryExpressionNode.md +174 -0
  56. package/docs/api/omdUtilities.md +70 -0
  57. package/docs/api/omdVariableNode.md +148 -0
  58. package/docs/api/selectTool.md +74 -0
  59. package/docs/api/simplificationEngine.md +98 -0
  60. package/docs/api/simplificationRules.md +77 -0
  61. package/docs/api/simplificationUtils.md +64 -0
  62. package/docs/api/transcribe.md +43 -0
  63. package/docs/api-reference.md +85 -0
  64. package/docs/index.html +454 -0
  65. package/docs/user-guide.md +9 -0
  66. package/index.js +67 -0
  67. package/omd/config/omdConfigManager.js +267 -0
  68. package/omd/core/index.js +150 -0
  69. package/omd/core/omdEquationStack.js +347 -0
  70. package/omd/core/omdUtilities.js +115 -0
  71. package/omd/display/omdDisplay.js +443 -0
  72. package/omd/display/omdToolbar.js +502 -0
  73. package/omd/nodes/omdBinaryExpressionNode.js +460 -0
  74. package/omd/nodes/omdConstantNode.js +142 -0
  75. package/omd/nodes/omdEquationNode.js +1223 -0
  76. package/omd/nodes/omdEquationSequenceNode.js +1273 -0
  77. package/omd/nodes/omdFunctionNode.js +352 -0
  78. package/omd/nodes/omdGroupNode.js +68 -0
  79. package/omd/nodes/omdLeafNode.js +77 -0
  80. package/omd/nodes/omdNode.js +557 -0
  81. package/omd/nodes/omdOperationDisplayNode.js +322 -0
  82. package/omd/nodes/omdOperatorNode.js +109 -0
  83. package/omd/nodes/omdParenthesisNode.js +293 -0
  84. package/omd/nodes/omdPowerNode.js +236 -0
  85. package/omd/nodes/omdRationalNode.js +295 -0
  86. package/omd/nodes/omdSqrtNode.js +308 -0
  87. package/omd/nodes/omdUnaryExpressionNode.js +178 -0
  88. package/omd/nodes/omdVariableNode.js +123 -0
  89. package/omd/simplification/omdSimplification.js +171 -0
  90. package/omd/simplification/omdSimplificationEngine.js +886 -0
  91. package/omd/simplification/package.json +6 -0
  92. package/omd/simplification/rules/binaryRules.js +1037 -0
  93. package/omd/simplification/rules/functionRules.js +111 -0
  94. package/omd/simplification/rules/index.js +48 -0
  95. package/omd/simplification/rules/parenthesisRules.js +19 -0
  96. package/omd/simplification/rules/powerRules.js +143 -0
  97. package/omd/simplification/rules/rationalRules.js +475 -0
  98. package/omd/simplification/rules/sqrtRules.js +48 -0
  99. package/omd/simplification/rules/unaryRules.js +37 -0
  100. package/omd/simplification/simplificationRules.js +32 -0
  101. package/omd/simplification/simplificationUtils.js +1056 -0
  102. package/omd/step-visualizer/omdStepVisualizer.js +597 -0
  103. package/omd/step-visualizer/omdStepVisualizerHighlighting.js +206 -0
  104. package/omd/step-visualizer/omdStepVisualizerLayout.js +245 -0
  105. package/omd/step-visualizer/omdStepVisualizerTextBoxes.js +163 -0
  106. package/omd/utils/omdNodeOverlay.js +638 -0
  107. package/omd/utils/omdPopup.js +1084 -0
  108. package/omd/utils/omdStepVisualizerInteractiveSteps.js +491 -0
  109. package/omd/utils/omdStepVisualizerNodeUtils.js +268 -0
  110. package/omd/utils/omdTranscriptionService.js +125 -0
  111. package/omd/utils/omdTreeDiff.js +734 -0
  112. package/package.json +46 -0
  113. package/src/index.js +62 -0
  114. package/src/json-schemas.md +109 -0
  115. package/src/omd-json-samples.js +115 -0
  116. package/src/omd.js +109 -0
  117. package/src/omdApp.js +391 -0
  118. package/src/omdAppCanvas.js +336 -0
  119. package/src/omdBalanceHanger.js +172 -0
  120. package/src/omdColor.js +13 -0
  121. package/src/omdCoordinatePlane.js +467 -0
  122. package/src/omdEquation.js +125 -0
  123. package/src/omdExpression.js +104 -0
  124. package/src/omdFunction.js +113 -0
  125. package/src/omdMetaExpression.js +287 -0
  126. package/src/omdNaturalExpression.js +564 -0
  127. package/src/omdNode.js +384 -0
  128. package/src/omdNumber.js +53 -0
  129. package/src/omdNumberLine.js +107 -0
  130. package/src/omdNumberTile.js +119 -0
  131. package/src/omdOperator.js +73 -0
  132. package/src/omdPowerExpression.js +92 -0
  133. package/src/omdProblem.js +55 -0
  134. package/src/omdRatioChart.js +232 -0
  135. package/src/omdRationalExpression.js +115 -0
  136. package/src/omdSampleData.js +215 -0
  137. package/src/omdShapes.js +476 -0
  138. package/src/omdSpinner.js +148 -0
  139. package/src/omdString.js +39 -0
  140. package/src/omdTable.js +369 -0
  141. package/src/omdTapeDiagram.js +245 -0
  142. package/src/omdTerm.js +92 -0
  143. package/src/omdTileEquation.js +349 -0
  144. package/src/omdVariable.js +51 -0
@@ -0,0 +1,111 @@
1
+ import { omdSqrtNode } from '../../nodes/omdSqrtNode.js';
2
+ import { SimplificationEngine } from '../omdSimplificationEngine.js';
3
+ import * as utils from '../simplificationUtils.js';
4
+
5
+ // ===== FUNCTION INVERSE PAIRS =====
6
+ // Bidirectional inverse function pairs - each pair only needs to be defined once
7
+ const FUNCTION_INVERSE_PAIRS = [
8
+ // Trigonometric functions
9
+ ['sin', 'arcsin'],
10
+ ['cos', 'arccos'],
11
+ ['tan', 'arctan'],
12
+
13
+ // Logarithmic/exponential functions
14
+ ['ln', 'exp'],
15
+ ['log', 'pow10'], // log base 10 and 10^x
16
+
17
+ // Square root and square (for function nodes, not sqrt/power nodes)
18
+ ['sqrt', 'square'],
19
+
20
+ // Hyperbolic functions
21
+ ['sinh', 'asinh'],
22
+ ['cosh', 'acosh'],
23
+ ['tanh', 'atanh'],
24
+ ];
25
+
26
+ /**
27
+ * Gets the inverse of a function (works bidirectionally)
28
+ * @param {string} functionName - The function name to find the inverse for
29
+ * @returns {string|null} The inverse function name, or null if not found
30
+ */
31
+ function getInverse(functionName) {
32
+ for (const [func1, func2] of FUNCTION_INVERSE_PAIRS) {
33
+ if (func1 === functionName) return func2;
34
+ if (func2 === functionName) return func1;
35
+ }
36
+ return null;
37
+ }
38
+
39
+ // ===== FUNCTION NODE RULES =====
40
+ export const functionRules = [
41
+ // General inverse function rule - handles all f(g(x)) = x where f and g are inverses
42
+ SimplificationEngine.createRule("Function Inverse Simplification",
43
+ (node) => {
44
+ // Check if this is a function node with exactly one argument
45
+ if (node.type !== 'omdFunctionNode' || !node.functionName || !node.argNodes || node.argNodes.length !== 1) {
46
+ return false;
47
+ }
48
+
49
+ const outerFunction = node.functionName;
50
+ const arg = node.argNodes[0];
51
+
52
+ // Check if the argument is also a function node with one argument
53
+ if (arg.type !== 'omdFunctionNode' || !arg.functionName || !arg.argNodes || arg.argNodes.length !== 1) {
54
+ return false;
55
+ }
56
+
57
+ const innerFunction = arg.functionName;
58
+
59
+ // Check if these are inverse functions
60
+ const expectedInverse = getInverse(outerFunction);
61
+ if (expectedInverse === innerFunction) {
62
+ return {
63
+ outerFunction,
64
+ innerFunction,
65
+ innerArg: arg.argNodes[0]
66
+ };
67
+ }
68
+
69
+ return false;
70
+ },
71
+ (node, data) => {
72
+ const newNode = data.innerArg.clone();
73
+ newNode.provenance.push(node.id, node.argNodes[0].id);
74
+ return newNode;
75
+ },
76
+ (originalNode, ruleData, newNode) => {
77
+ const { outerFunction, innerFunction } = ruleData;
78
+ const argStr = utils.nodeToString(ruleData.innerArg);
79
+ return `Simplified inverse functions: ${outerFunction}(${innerFunction}(${argStr})) = ${argStr}`;
80
+ }
81
+ ),
82
+
83
+ // Square root function to sqrt node conversion: sqrt(x) → √x
84
+ SimplificationEngine.createRule("Function to Sqrt Node",
85
+ (node) => {
86
+ if (node.type !== 'omdFunctionNode' || node.functionName !== 'sqrt' || !node.argNodes || node.argNodes.length !== 1) {
87
+ return false;
88
+ }
89
+
90
+ return { argument: node.argNodes[0] };
91
+ },
92
+ (node, data) => {
93
+ // Create sqrt AST
94
+ const sqrtAst = {
95
+ type: 'FunctionNode',
96
+ fn: { type: 'SymbolNode', name: 'sqrt' },
97
+ args: [data.argument.toMathJSNode()]
98
+ };
99
+
100
+ const newNode = new omdSqrtNode(sqrtAst);
101
+ newNode.setFontSize(node.getFontSize());
102
+ newNode.initialize();
103
+ newNode.provenance.push(node.id);
104
+ return newNode;
105
+ },
106
+ (originalNode, ruleData, newNode) => {
107
+ const argStr = utils.nodeToString(ruleData.argument);
108
+ return `Converted function to sqrt node: sqrt(${argStr}) = √${argStr}`;
109
+ }
110
+ )
111
+ ];
@@ -0,0 +1,48 @@
1
+ // Import all rule categories
2
+ import { binaryRules } from './binaryRules.js';
3
+ import { rationalRules } from './rationalRules.js';
4
+ import { parenthesisRules } from './parenthesisRules.js';
5
+ import { unaryRules } from './unaryRules.js';
6
+ import { powerRules } from './powerRules.js';
7
+ import { sqrtRules } from './sqrtRules.js';
8
+ import { functionRules } from './functionRules.js';
9
+
10
+ // ===== RULES ORGANIZED BY NODE TYPE =====
11
+ export const rules = {
12
+ // ===== BINARY EXPRESSION RULES =====
13
+ binary: binaryRules,
14
+
15
+ // ===== RATIONAL NODE RULES =====
16
+ rational: rationalRules,
17
+
18
+ // ===== PARENTHESIS NODE RULES =====
19
+ parenthesis: parenthesisRules,
20
+
21
+ // ===== UNARY EXPRESSION RULES =====
22
+ unary: unaryRules,
23
+
24
+ // ===== POWER NODE RULES =====
25
+ power: powerRules,
26
+
27
+ // ===== SQRT NODE RULES =====
28
+ sqrt: sqrtRules,
29
+
30
+ // ===== FUNCTION NODE RULES =====
31
+ function: functionRules
32
+ };
33
+
34
+ // ===== RULE LOOKUP MAP =====
35
+ export const ruleMap = {
36
+ 'omdBinaryExpressionNode': rules.binary,
37
+ 'omdRationalNode': rules.rational,
38
+ 'omdParenthesisNode': rules.parenthesis,
39
+ 'omdUnaryExpressionNode': rules.unary,
40
+ 'omdPowerNode': rules.power,
41
+ 'omdSqrtNode': rules.sqrt,
42
+ 'omdFunctionNode': rules.function
43
+ };
44
+
45
+ // ===== HELPER FUNCTION =====
46
+ export function getRulesForNode(node) {
47
+ return ruleMap[node.type] || [];
48
+ }
@@ -0,0 +1,19 @@
1
+ import { SimplificationEngine } from '../omdSimplificationEngine.js';
2
+ import * as utils from '../simplificationUtils.js';
3
+
4
+ // ===== PARENTHESIS NODE RULES =====
5
+ export const parenthesisRules = [
6
+ // Remove redundant parentheses (e.g., ((x))) → (x)
7
+ SimplificationEngine.createRule("Remove Redundant Parentheses",
8
+ (node) => SimplificationEngine.isType(node.expression, 'omdParenthesisNode'),
9
+ (node) => {
10
+ const newNode = node.expression.clone();
11
+ newNode.provenance.push(node.id);
12
+ return newNode;
13
+ },
14
+ (originalNode, ruleData, newNode) => {
15
+ const childStr = utils.nodeToString(originalNode.content);
16
+ return `Removed redundant parentheses around "${childStr}"`;
17
+ }
18
+ )
19
+ ];
@@ -0,0 +1,143 @@
1
+ import { omdSqrtNode } from '../../nodes/omdSqrtNode.js';
2
+ import { SimplificationEngine } from '../omdSimplificationEngine.js';
3
+ import * as utils from '../simplificationUtils.js';
4
+
5
+ // ===== POWER NODE RULES =====
6
+ export const powerRules = [
7
+ // Calculate constant powers (2^3 → 8)
8
+ SimplificationEngine.createRule("Calculate Powers",
9
+ (node) => {
10
+ if (!node.base.isConstant() || !node.exponent.isConstant()) return false;
11
+ const base = node.base.getValue();
12
+ const exp = node.exponent.getValue();
13
+ return { value: Math.pow(base, exp) };
14
+ },
15
+ (node, data) => {
16
+ const newNode = SimplificationEngine.createConstant(data.value, node.getFontSize());
17
+ newNode.provenance.push(node.id);
18
+ return newNode;
19
+ },
20
+ (originalNode, ruleData, newNode) => {
21
+ const { base, exponent } = originalNode;
22
+ const result = ruleData.value;
23
+ return `Calculated power: ${utils.nodeToString(base)}^${utils.nodeToString(exponent)} = ${result}`;
24
+ }
25
+ ),
26
+
27
+ // Power of zero (x^0 → 1)
28
+ SimplificationEngine.createRule("Power of Zero",
29
+ (node) => node.exponent.isConstant() && node.exponent.getValue() === 0,
30
+ (node) => {
31
+ const newNode = SimplificationEngine.createConstant(1, node.getFontSize());
32
+ newNode.provenance.push(node.id);
33
+ return newNode;
34
+ },
35
+ (originalNode, ruleData, newNode) => {
36
+ const { base } = originalNode;
37
+ return `Simplified power of zero: ${utils.nodeToString(base)}^0 = 1`;
38
+ }
39
+ ),
40
+
41
+ // Power of one (x^1 → x)
42
+ SimplificationEngine.createRule("Power of One",
43
+ (node) => node.exponent.isConstant() && node.exponent.getValue() === 1,
44
+ (node) => {
45
+ const newNode = node.base.clone();
46
+ newNode.provenance.push(node.id);
47
+ return newNode;
48
+ },
49
+ (originalNode, ruleData, newNode) => {
50
+ const { base } = originalNode;
51
+ return `Simplified power of one: ${utils.nodeToString(base)}^1 = ${utils.nodeToString(base)}`;
52
+ }
53
+ ),
54
+
55
+ // Expand polynomial powers like (x-2)^2 or (a+b)^3
56
+ SimplificationEngine.createRule("Expand Polynomial Power",
57
+ (node) => {
58
+ if (!node.exponent.isConstant()) return false;
59
+ const exp = node.exponent.getValue();
60
+ if (!Number.isInteger(exp) || exp < 2 || exp > 4) return false;
61
+
62
+ let baseExpr = SimplificationEngine.unwrapParentheses(node.base);
63
+
64
+ if (!SimplificationEngine.isBinaryOp(baseExpr, 'add') &&
65
+ !SimplificationEngine.isBinaryOp(baseExpr, 'subtract')) {
66
+ return false;
67
+ }
68
+
69
+ const terms = [];
70
+ utils.flattenSum(baseExpr, terms);
71
+
72
+ if (terms.length > 5) return false;
73
+
74
+ return { baseExpression: baseExpr, terms, exponent: exp };
75
+ },
76
+ (node, data) => {
77
+ const { terms, exponent } = data;
78
+ const expandedTerms = utils.expandPolynomialPower(terms, exponent, node.getFontSize());
79
+ const result = utils.buildSumTree(expandedTerms, node.getFontSize());
80
+
81
+ if (result) {
82
+ result.provenance.push(node.id);
83
+ }
84
+
85
+ return result;
86
+ },
87
+ (originalNode, ruleData, newNode) => {
88
+ const { baseExpression, exponent } = ruleData;
89
+ const baseStr = utils.nodeToString(baseExpression);
90
+ return `Expanded polynomial power: (${baseStr})^${exponent}`;
91
+ }
92
+ ),
93
+
94
+ // Simplify (√x)² → x
95
+ SimplificationEngine.createRule("Square of Square Root",
96
+ (node) => {
97
+ if (!node.exponent.isConstant() || node.exponent.getValue() !== 2) return false;
98
+ if (node.base.type !== 'omdSqrtNode') return false;
99
+
100
+ return { innerArg: node.base.argument };
101
+ },
102
+ (node, data) => {
103
+ const newNode = data.innerArg.clone();
104
+ newNode.provenance.push(node.id, node.base.id);
105
+ return newNode;
106
+ },
107
+ (originalNode, ruleData, newNode) => {
108
+ const argStr = utils.nodeToString(ruleData.innerArg);
109
+ return `Simplified square of square root: (√${argStr})² = ${argStr}`;
110
+ }
111
+ ),
112
+
113
+ // Simplify x^(1/2) → √x
114
+ SimplificationEngine.createRule("Fractional Exponent to Square Root",
115
+ (node) => {
116
+ if (!node.exponent.isConstant()) return false;
117
+
118
+ // Check if exponent is 1/2 (0.5)
119
+ const exp = node.exponent.getValue();
120
+ if (Math.abs(exp - 0.5) > 0.0001) return false;
121
+
122
+ return { base: node.base };
123
+ },
124
+ (node, data) => {
125
+ // Create sqrt AST
126
+ const sqrtAst = {
127
+ type: 'FunctionNode',
128
+ fn: { type: 'SymbolNode', name: 'sqrt' },
129
+ args: [data.base.toMathJSNode()]
130
+ };
131
+
132
+ const newNode = new omdSqrtNode(sqrtAst);
133
+ newNode.setFontSize(node.getFontSize());
134
+ newNode.initialize();
135
+ newNode.provenance.push(node.id);
136
+ return newNode;
137
+ },
138
+ (originalNode, ruleData, newNode) => {
139
+ const baseStr = utils.nodeToString(ruleData.base);
140
+ return `Converted fractional exponent to square root: ${baseStr}^(1/2) = √${baseStr}`;
141
+ }
142
+ )
143
+ ];