symbolicjs 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 John Lott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,116 @@
+# symbolicjs
+
+Computer algebra extensions for [MathJS](https://mathjs.org/), beginning with
+first-class equations.
+
+> Early development release. The initial package provides the equation node and
+> parser boundary; solving is the next milestone.
+
+## Install
+
+    npm install symbolicjs mathjs
+
+## Quick start
+
+    import {all, create} from 'mathjs';
+    import {importsymbolicjs} from 'symbolicjs';
+
+    const math = importsymbolicjs(create(all));
+    const equation = math.parseEquation('x + 1 =:= y / 2');
+
+    equation.type;           // 'EqualityNode'
+    equation.lhs.toString(); // 'x + 1'
+    equation.rhs.toString(); // 'y / 2'
+    equation.toString();     // 'x + 1 =:= y / 2'
+    equation.toTex();        // MathJS LaTeX joined by '='
+
+The lower-level factory array can be imported directly when an application
+manages its own MathJS instance typing:
+
+    import {all, create} from 'mathjs';
+    import {symbolicjsFactories} from 'symbolicjs';
+
+    const math = create(all);
+    math.import([...symbolicjsFactories]);
+
+## Equality syntax
+
+symbolicjs uses **=:=** as its canonical equation operator. This keeps mathematical
+equality distinct from MathJS assignment (**=**) and boolean comparison
+(**==**).
+
+MathJS documents extension through **math.import** and factory functions, but
+it does not expose a supported API for adding an infix grammar token. For that
+reason, symbolicjs imports **EqualityNode** and **parseEquation** into a MathJS
+instance. **parseEquation** recognizes one top-level **=:=**, delegates each
+side to that instance's original MathJS parser, and returns:
+
+    EqualityNode {
+      lhs: MathNode;
+      rhs: MathNode;
+    }
+
+The package does not monkey-patch or silently replace **math.parse**. Ordinary
+MathJS parsing, including assignment parsing, remains unchanged.
+Assignments and function assignments are rejected inside equation sides.
+
+## Initial API
+
+- **importsymbolicjs(math)** imports the symbolicjs factories and returns the same
+  instance with typed **EqualityNode** and **parseEquation** members.
+- **symbolicjsFactories** is the factory array for direct **math.import**.
+- **EqualityNode** is a MathJS node with **lhs** and **rhs** children.
+- **splitEquation(expression)** validates and splits one top-level **=:=**.
+- **isEqualityNode(value)** is the runtime type guard.
+- **EQUALITY_OPERATOR** is the canonical **=:=** token.
+
+**EqualityNode** supports MathJS traversal, transformation, cloning,
+compilation, equality evaluation, string output, LaTeX output, HTML output, and
+its own JSON codec.
+
+## Roadmap
+
+1. First-class equality node, parser boundary, formatting, and serialization.
+2. Symbol discovery, immutable substitution, conservative simplification,
+   domain conditions, and candidate verification.
+3. Single-occurrence isolation for arithmetic, powers, roots, exponential,
+   logarithm, and absolute value.
+4. Target-relative rational and polynomial normalization, with symbolic linear
+   and quadratic solving.
+5. Typed solve cases for finite roots, identities, contradictions, conditions,
+   partial results, unsupported families, and complexity limits.
+6. Numeric cubic fallback when all coefficients are numeric.
+
+The initial solver domain will be real scalar equations. Periodic
+trigonometric families, simultaneous systems, matrices, units, and a general
+equivalence prover are not part of the first solver release.
+
+## Development
+
+Requires Node 22 or newer.
+
+    npm install
+    npm run check
+    npm run pack:dry
+
+The package is tested independently of any consuming application. MathJS is a
+peer dependency and is pinned to 15.2.0 in development so the node contract is
+tested against a known implementation.
+
+## Publishing
+
+The repository includes a tag-triggered GitHub Actions publishing workflow.
+After the package has been created on npm, configure npm trusted publishing for:
+
+- GitHub owner: **Wu-Li**
+- Repository: **symbolicjs**
+- Workflow: **publish.yml**
+- Allowed action: **npm publish**
+
+Then create a version tag such as **v0.0.2**. npm trusted publishing requires no
+long-lived publish token and automatically records provenance for a public
+repository and package.
+
+## License
+
+[MIT](LICENSE)

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "symbolicjs",
+  "version": "0.0.1",
+  "description": "Computer algebra extensions for MathJS, beginning with first-class equations.",
+  "type": "module",
+  "license": "MIT",
+  "author": "John Lott",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Wu-Li/symbolicjs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Wu-Li/symbolicjs/issues"
+  },
+  "homepage": "https://github.com/Wu-Li/symbolicjs#readme",
+  "keywords": [
+    "algebra",
+    "cas",
+    "equation",
+    "mathjs",
+    "symbolic-math"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "check": "npm run typecheck && npm test && npm run build",
+    "pack:dry": "npm pack --dry-run"
+  },
+  "peerDependencies": {
+    "mathjs": ">=15.2.0 <16"
+  },
+  "devDependencies": {
+    "mathjs": "15.2.0",
+    "typescript": "7.0.2",
+    "vitest": "4.1.11"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}