Migrate math module to TypeScript (#906)

* chore(eslint): Enforce newline at EOF with `eol-last` rule

Signed-off-by: Drew Hoener <[email protected]>

* refactor(math): Rename files to TS.

This commit will have lint/compile errors but is necessary for git continuity. Without it, git will think the files have been deleted and recreated because of the diff.

Signed-off-by: Drew Hoener <[email protected]>

* refactor(Vector3): Refactor Vector3 to typescript module, add interface to represent structure and type methods.

Signed-off-by: Drew Hoener <[email protected]>

* refactor(Quaternion): Refactor Quaternion to typescript module, add interface to represent structure and type methods.

Signed-off-by: Drew Hoener <[email protected]>

* feat(types): Add utility types

Signed-off-by: Drew Hoener <[email protected]>

* refactor(Transform): Refactor Transform to typescript module, add interface to represent structure and type methods.

Signed-off-by: Drew Hoener <[email protected]>

* refactor(Pose): Refactor Pose to typescript module, add interface to represent structure and type methods.

Signed-off-by: Drew Hoener <[email protected]>

---------

Signed-off-by: Drew Hoener <[email protected]>

Author: drewhoener

eslint.config.js

@@ -61,7 +61,8 @@ export default tseslint.config(
       quotes: [2, 'single'],
       'no-proto': 2,
       'linebreak-style': 2,
-      'key-spacing': [2, {afterColon: true}]
+      'key-spacing': [2, {afterColon: true}],
+      'eol-last': ['error', 'always'],
     },
     files: ['**/*.{js,jsx,ts,tsx,cjs}'],
   }

src/math/Pose.js renamed to src/math/Pose.ts

@@ -2,67 +2,78 @@
  * @fileOverview
  * @author David Gossow - [email protected]
  */
+import Vector3, { type IVector3 } from './Vector3.js';
+import Quaternion, { type IQuaternion } from './Quaternion.js';
+import { type ITransform } from './Transform.js';
+import { PartialNullable } from '../types/interface-types.js';
 
-import Vector3 from './Vector3.js';
-import Quaternion from './Quaternion.js';
-import Transform from './Transform.js';
+export interface IPose {
+  /**
+   * The ROSLIB.Vector3 describing the position.
+   */
+  position: IVector3;
+  /**
+   * The ROSLIB.Quaternion describing the orientation.
+   */
+  orientation: IQuaternion;
+}
 
 /**
  * A Pose in 3D space. Values are copied into this object.
  */
-export default class Pose {
-  /**
-   * @param {Object} [options]
-   * @param {Vector3} [options.position] - The ROSLIB.Vector3 describing the position.
-   * @param {Quaternion} [options.orientation] - The ROSLIB.Quaternion describing the orientation.
-   */
-  constructor(options) {
-    options = options || {};
-    // copy the values into this object if they exist
-    options = options || {};
-    this.position = new Vector3(options.position);
-    this.orientation = new Quaternion(options.orientation);
+export default class Pose implements IPose {
+
+  position: Vector3;
+  orientation: Quaternion;
+
+  constructor(options?: PartialNullable<IPose>) {
+    this.position = new Vector3(options?.position);
+    this.orientation = new Quaternion(options?.orientation);
   }
+
   /**
    * Apply a transform against this pose.
    *
-   * @param {Transform} tf - The transform to be applied.
+   * @param {ITransform} tf - The transform to be applied.
    */
-  applyTransform(tf) {
+  applyTransform(tf: ITransform) {
     this.position.multiplyQuaternion(tf.rotation);
     this.position.add(tf.translation);
-    var tmp = tf.rotation.clone();
+    const tmp = new Quaternion(tf.rotation);
     tmp.multiply(this.orientation);
     this.orientation = tmp;
   }
+
   /**
    * Clone a copy of this pose.
    *
    * @returns {Pose} The cloned pose.
    */
-  clone() {
+  clone(): Pose {
     return new Pose(this);
   }
+
   /**
    * Multiply this pose with another pose without altering this pose.
    *
    * @returns {Pose} The result of the multiplication.
    */
-  multiply(pose) {
-    var p = pose.clone();
+  multiply(pose: Pose): Pose {
+    const p = pose.clone();
     p.applyTransform({
       rotation: this.orientation,
       translation: this.position
     });
     return p;
   }
+
   /**
    * Compute the inverse of this pose.
    *
    * @returns {Pose} The inverse of the pose.
    */
-  getInverse() {
-    var inverse = this.clone();
+  getInverse(): Pose {
+    const inverse = this.clone();
     inverse.orientation.invert();
     inverse.position.multiplyQuaternion(inverse.orientation);
     inverse.position.x *= -1;

src/math/Quaternion.js renamed to src/math/Quaternion.ts

@@ -2,46 +2,69 @@
  * @fileOverview
  * @author David Gossow - [email protected]
  */
+import { type PartialNullable } from '../types/interface-types.js';
+
+export interface IQuaternion {
+  /**
+   * The x value.
+   */
+  x: number;
+
+  /**
+   * The y value.
+   */
+  y: number;
+
+  /**
+   * The z value.
+   */
+  z: number;
+
+  /**
+   * The w value.
+   */
+  w: number;
+}
 
 /**
  * A Quaternion.
  */
-export default class Quaternion {
-  /**
-   * @param {Object} [options]
-   * @param {number|null} [options.x=0] - The x value.
-   * @param {number|null} [options.y=0] - The y value.
-   * @param {number|null} [options.z=0] - The z value.
-   * @param {number|null} [options.w=1] - The w value.
-   */
-  constructor(options) {
-    options = options || {};
-    this.x = options.x || 0;
-    this.y = options.y || 0;
-    this.z = options.z || 0;
-    this.w = typeof options.w === 'number' ? options.w : 1;
+export default class Quaternion implements IQuaternion {
+  x: number;
+  y: number;
+  z: number;
+  w: number;
+
+  constructor(options?: PartialNullable<IQuaternion> | null) {
+    this.x = options?.x ?? 0;
+    this.y = options?.y ?? 0;
+    this.z = options?.z ?? 0;
+    this.w = typeof options?.w === 'number' ? options.w : 1;
   }
+
   /**
    * Perform a conjugation on this quaternion.
    */
-  conjugate() {
+  conjugate(): void {
     this.x *= -1;
     this.y *= -1;
     this.z *= -1;
   }
+
   /**
    * Return the norm of this quaternion.
    */
-  norm() {
+  norm(): number {
     return Math.sqrt(
       this.x * this.x + this.y * this.y + this.z * this.z + this.w * this.w
     );
   }
+
   /**
    * Perform a normalization on this quaternion.
    */
-  normalize() {
-    var l = Math.sqrt(
+  normalize(): void {
+    let l = Math.sqrt(
       this.x * this.x + this.y * this.y + this.z * this.z + this.w * this.w
     );
     if (l === 0) {
@@ -67,24 +90,25 @@ export default class Quaternion {
   /**
    * Set the values of this quaternion to the product of itself and the given quaternion.
    *
-   * @param {Quaternion} q - The quaternion to multiply with.
+   * @param {IQuaternion} q - The quaternion to multiply with.
    */
-  multiply(q) {
-    var newX = this.x * q.w + this.y * q.z - this.z * q.y + this.w * q.x;
-    var newY = -this.x * q.z + this.y * q.w + this.z * q.x + this.w * q.y;
-    var newZ = this.x * q.y - this.y * q.x + this.z * q.w + this.w * q.z;
-    var newW = -this.x * q.x - this.y * q.y - this.z * q.z + this.w * q.w;
+  multiply(q: IQuaternion): void {
+    const newX = this.x * q.w + this.y * q.z - this.z * q.y + this.w * q.x;
+    const newY = -this.x * q.z + this.y * q.w + this.z * q.x + this.w * q.y;
+    const newZ = this.x * q.y - this.y * q.x + this.z * q.w + this.w * q.z;
+    const newW = -this.x * q.x - this.y * q.y - this.z * q.z + this.w * q.w;
     this.x = newX;
     this.y = newY;
     this.z = newZ;
     this.w = newW;
   }
+
   /**
    * Clone a copy of this quaternion.
    *
    * @returns {Quaternion} The cloned quaternion.
    */
-  clone() {
+  clone(): Quaternion {
     return new Quaternion(this);
   }
 }

src/math/Transform.js

@@ -0,0 +1,42 @@
+/**
+ * @fileOverview
+ * @author David Gossow - [email protected]
+ */
+
+import Vector3, { type IVector3 } from './Vector3.js';
+import Quaternion, { type IQuaternion } from './Quaternion.js';
+
+export interface ITransform {
+  /**
+   * The ROSLIB.Vector3 describing the translation.
+   */
+  translation: IVector3;
+  /**
+   * The ROSLIB.Quaternion describing the rotation.
+   */
+  rotation: IQuaternion;
+}
+
+/**
+ * A Transform in 3-space. Values are copied into this object.
+ */
+export default class Transform implements ITransform {
+
+  translation: Vector3;
+  rotation: Quaternion;
+
+  constructor(options: ITransform) {
+    // Copy the values into this object if they exist
+    this.translation = new Vector3(options.translation);
+    this.rotation = new Quaternion(options.rotation);
+  }
+
+  /**
+   * Clone a copy of this transform.
+   *
+   * @returns {Transform} The cloned transform.
+   */
+  clone(): Transform {
+    return new Transform(this);
+  }
+}