mathjs 10.6.0 → 10.6.3

package/lib/cjs/header.js

@@ -6,8 +6,8 @@
  * It features real and complex numbers, units, matrices, a large set of
  * mathematical functions, and a flexible expression parser.
  *
- * @version 10.6.0
- * @date    2022-05-24
+ * @version 10.6.3
+ * @date    2022-06-24
  *
  * @license
  * Copyright (C) 2013-2022 Jos de Jong <wjosdejong@gmail.com>

package/lib/cjs/version.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.version = void 0;
-var version = '10.6.0'; // Note: This file is automatically generated when building math.js.
+var version = '10.6.3'; // Note: This file is automatically generated when building math.js.
 // Changes made in this file will be overwritten.
 
 exports.version = version;

package/lib/esm/version.js

@@ -1,2 +1,2 @@
-export var version = '10.6.0'; // Note: This file is automatically generated when building math.js.
+export var version = '10.6.3'; // Note: This file is automatically generated when building math.js.
 // Changes made in this file will be overwritten.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mathjs",
-  "version": "10.6.0",
+  "version": "10.6.3",
   "description": "Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with different data types like numbers, big numbers, complex numbers, fractions, units, and matrices.",
   "author": "Jos de Jong <wjosdejong@gmail.com> (https://github.com/josdejong)",
   "homepage": "https://mathjs.org",
@@ -25,7 +25,7 @@
     "unit"
   ],
   "dependencies": {
-    "@babel/runtime": "^7.17.9",
+    "@babel/runtime": "^7.18.3",
     "complex.js": "^2.1.1",
     "decimal.js": "^10.3.1",
     "escape-latex": "^1.2.0",
@@ -36,28 +36,28 @@
     "typed-function": "^2.1.0"
   },
   "devDependencies": {
-    "@babel/core": "7.17.10",
+    "@babel/core": "7.18.5",
     "@babel/plugin-transform-object-assign": "7.16.7",
-    "@babel/plugin-transform-runtime": "7.17.10",
-    "@babel/preset-env": "7.17.10",
+    "@babel/plugin-transform-runtime": "7.18.5",
+    "@babel/preset-env": "7.18.2",
     "@babel/register": "7.17.7",
     "@types/assert": "1.5.6",
     "@types/mocha": "9.1.1",
-    "@typescript-eslint/eslint-plugin": "5.22.0",
-    "@typescript-eslint/parser": "5.22.0",
+    "@typescript-eslint/eslint-plugin": "5.29.0",
+    "@typescript-eslint/parser": "5.29.0",
     "assert": "2.0.0",
     "babel-loader": "8.2.5",
     "benchmark": "2.1.4",
     "codecov": "3.8.3",
-    "core-js": "3.22.4",
-    "del": "6.0.0",
+    "core-js": "3.23.2",
+    "del": "6.1.1",
     "dtslint": "4.2.1",
-    "eslint": "8.15.0",
+    "eslint": "8.18.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-config-standard": "17.0.0",
     "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-mocha": "10.0.4",
-    "eslint-plugin-n": "15.2.0",
+    "eslint-plugin-mocha": "10.0.5",
+    "eslint-plugin-n": "15.2.3",
     "eslint-plugin-prettier": "4.0.0",
     "eslint-plugin-promise": "6.0.0",
     "expect-type": "0.13.0",
@@ -69,7 +69,7 @@
     "handlebars": "4.7.7",
     "istanbul": "0.4.5",
     "jsep": "1.3.6",
-    "karma": "6.3.19",
+    "karma": "6.4.0",
     "karma-browserstack-launcher": "1.6.0",
     "karma-firefox-launcher": "2.1.2",
     "karma-mocha": "2.0.1",
@@ -86,11 +86,11 @@
     "numericjs": "1.2.6",
     "nyc": "15.1.0",
     "pad-right": "0.2.2",
-    "prettier": "2.6.2",
+    "prettier": "2.7.1",
     "process": "0.11.10",
     "sylvester": "0.0.21",
-    "ts-node": "10.7.0",
-    "typescript": "4.6.4",
+    "ts-node": "10.8.1",
+    "typescript": "4.7.4",
     "webpack": "4.46.0",
     "zeros": "1.0.0"
   },

package/types/index.d.ts

@@ -276,32 +276,77 @@ declare namespace math {
     new (properties: Record<string, MathNode>): ObjectNode
   }
 
-  interface OperatorNode extends MathNodeCommon {
+  type OperatorNodeMap = {
+    xor: 'xor'
+    and: 'and'
+    bitOr: '|'
+    bitXor: '^|'
+    bitAnd: '&'
+    equal: '=='
+    unequal: '!='
+    smaller: '<'
+    larger: '>'
+    smallerEq: '<='
+    leftShift: '<<'
+    rightArithShift: '>>'
+    rightLogShift: '>>>'
+    to: 'to'
+    add: '+'
+    subtract: '-'
+    multiply: '*'
+    divide: '/'
+    dotMultiply: '.*'
+    dotDivide: './'
+    mod: 'mod'
+    unaryPlus: '+'
+    unaryMinus: '-'
+    bitNot: '~'
+    not: 'not'
+    pow: '^'
+    dotPow: '.^'
+    factorial: '!'
+  }
+
+  type OperatorNodeOp = OperatorNodeMap[keyof OperatorNodeMap]
+  type OperatorNodeFn = keyof OperatorNodeMap
+
+  interface OperatorNode<
+    TOp extends OperatorNodeMap[TFn] = never,
+    TFn extends OperatorNodeFn = never,
+    TArgs extends MathNode[] = MathNode[]
+  > extends MathNodeCommon {
     type: 'OperatorNode'
     isOperatorNode: true
-    op: string
-    fn: string
-    args: MathNode[]
+    op: TOp
+    fn: TFn
+    args: TArgs
     implicit: boolean
     isUnary(): boolean
     isBinary(): boolean
   }
-  interface OperatorNodeCtor {
-    new (
-      op: string,
-      fn: string,
-      args: MathNode[],
+
+  interface OperatorNodeCtor extends MathNodeCommon {
+    new <
+      TOp extends OperatorNodeMap[TFn],
+      TFn extends OperatorNodeFn,
+      TArgs extends MathNode[]
+    >(
+      op: TOp,
+      fn: TFn,
+      args: TArgs,
       implicit?: boolean
-    ): OperatorNode
+    ): OperatorNode<TOp, TFn, TArgs>
   }
-
-  interface ParenthesisNode extends MathNodeCommon {
+  interface ParenthesisNode<TContent extends MathNode = MathNode>
+    extends MathNodeCommon {
     type: 'ParenthesisNode'
     isParenthesisNode: true
-    content: MathNode
+    content: TContent
   }
   interface ParenthesisNodeCtor {
-    new (content: MathNode): ParenthesisNode
+    new <TContent extends MathNode>(
+      content: TContent
+    ): ParenthesisNode<TContent>
   }
 
   interface RangeNode extends MathNodeCommon {
@@ -345,7 +390,7 @@ declare namespace math {
     | FunctionNode
     | IndexNode
     | ObjectNode
-    | OperatorNode
+    | OperatorNode<OperatorNodeOp, OperatorNodeFn>
     | ParenthesisNode
     | RangeNode
     | RelationalNode
@@ -3095,7 +3140,9 @@ declare namespace math {
 
     isObjectNode(x: unknown): x is ObjectNode
 
-    isOperatorNode(x: unknown): x is OperatorNode
+    isOperatorNode(
+      x: unknown
+    ): x is OperatorNode<OperatorNodeOp, OperatorNodeFn>
 
     isParenthesisNode(x: unknown): x is ParenthesisNode
 
@@ -3762,22 +3809,7 @@ declare namespace math {
   interface MathNodeCommon {
     isNode: true
     comment: string
-    type:
-      | 'AccessorNode'
-      | 'ArrayNode'
-      | 'AssignmentNode'
-      | 'BlockNode'
-      | 'ConditionalNode'
-      | 'ConstantNode'
-      | 'FunctionAssignmentNode'
-      | 'FunctionNode'
-      | 'IndexNode'
-      | 'ObjectNode'
-      | 'OperatorNode'
-      | 'ParenthesisNode'
-      | 'RangeNode'
-      | 'RelationalNode'
-      | 'SymbolNode'
+    type: string
 
     isUpdateNode?: boolean
 
@@ -3901,9 +3933,9 @@ declare namespace math {
      * transformed.toString(); // returns '(3 ^ 2) + (5 * 3)'
      * ```
      */
-    transform(
-      callback: (node: MathNode, path: string, parent: MathNode) => MathNode
-    ): MathNode
+    transform<TResult>(
+      callback: (node: this, path: string, parent: MathNode) => TResult
+    ): TResult
 
     /**
      * `traverse(callback)`

package/types/index.ts

@@ -25,6 +25,10 @@ import {
   MathNumericType,
   ConstantNode,
   OperatorNode,
+  OperatorNodeFn,
+  OperatorNodeOp,
+  SymbolNode,
+  ParenthesisNode,
 } from 'mathjs'
 import * as assert from 'assert'
 import { expectTypeOf } from 'expect-type'
@@ -822,6 +826,17 @@ Complex numbers examples
   }
 }
 
+/*
+Parenthesis examples
+*/
+{
+  const math = create(all, {})
+
+  expectTypeOf(
+    new math.ParenthesisNode(new math.ConstantNode(3))
+  ).toMatchTypeOf<ParenthesisNode<ConstantNode>>()
+}
+
 /*
 Expressions examples
 */
@@ -921,6 +936,46 @@ Fractions examples
   const _a = math.fraction('2/3')
 }
 
+/*
+Transform examples
+*/
+{
+  const math = create(all, {})
+  {
+    const myTransform1 = (node: MathNode): OperatorNode<'+', 'add'> =>
+      new OperatorNode('+', 'add', [node, new ConstantNode(1)])
+    const myTransform2 = (
+      node: OperatorNode<'+', 'add'>
+    ): OperatorNode<'-', 'subtract'> =>
+      new OperatorNode('-', 'subtract', [node, new ConstantNode(5)])
+
+    expectTypeOf(
+      math.parse('sqrt(3^2 + 4^2)').transform(myTransform1)
+    ).toMatchTypeOf<OperatorNode<'+', 'add', MathNode[]>>()
+
+    assert.deepStrictEqual(
+      math.parse('sqrt(3^2 + 4^2)').transform(myTransform1).toString(),
+      'sqrt(3 ^ 2 + 4 ^ 2) + 1'
+    )
+
+    expectTypeOf(
+      math
+        .parse('sqrt(3^2 + 4^2)')
+        .transform(myTransform1)
+        .transform(myTransform2)
+    ).toMatchTypeOf<OperatorNode<'-', 'subtract', MathNode[]>>()
+
+    assert.deepStrictEqual(
+      math
+        .parse('sqrt(3^2 + 4^2)')
+        .transform(myTransform1)
+        .transform(myTransform2)
+        .toString(),
+      'sqrt(3 ^ 2 + 4 ^ 2) + 1 - 5'
+    )
+  }
+}
+
 /*
 Matrices examples
 */
@@ -1527,23 +1582,34 @@ Function round examples
   */
 {
   const math = create(all, {})
+  expectTypeOf(
+    new math.OperatorNode('/', 'divide', [
+      new math.ConstantNode(3),
+      new math.SymbolNode('x'),
+    ])
+  ).toMatchTypeOf<OperatorNode<'/', 'divide', (ConstantNode | SymbolNode)[]>>()
+
   expectTypeOf(new math.ConstantNode(1).clone()).toMatchTypeOf<ConstantNode>()
   expectTypeOf(
     new math.OperatorNode('*', 'multiply', [
       new math.ConstantNode(3),
       new math.SymbolNode('x'),
     ]).clone()
-  ).toMatchTypeOf<OperatorNode>()
+  ).toMatchTypeOf<
+    OperatorNode<'*', 'multiply', (ConstantNode | SymbolNode)[]>
+  >()
 
   expectTypeOf(
     new math.ConstantNode(1).cloneDeep()
   ).toMatchTypeOf<ConstantNode>()
   expectTypeOf(
-    new math.OperatorNode('*', 'multiply', [
+    new math.OperatorNode('+', 'unaryPlus', [
       new math.ConstantNode(3),
       new math.SymbolNode('x'),
     ]).cloneDeep()
-  ).toMatchTypeOf<OperatorNode>()
+  ).toMatchTypeOf<
+    OperatorNode<'+', 'unaryPlus', (ConstantNode | SymbolNode)[]>
+  >()
 
   expectTypeOf(
     math.clone(new math.ConstantNode(1))
@@ -1900,7 +1966,9 @@ Factory Test
     expectTypeOf(x).toMatchTypeOf<math.ObjectNode>()
   }
   if (math.isOperatorNode(x)) {
-    expectTypeOf(x).toMatchTypeOf<math.OperatorNode>()
+    expectTypeOf(x).toMatchTypeOf<
+      OperatorNode<OperatorNodeOp, OperatorNodeFn, MathNode[]>
+    >()
   }
   if (math.isParenthesisNode(x)) {
     expectTypeOf(x).toMatchTypeOf<math.ParenthesisNode>()