@vived/core 1.4.1 → 1.4.3

package/dist/cjs/ValueObjects/Vector2.js

@@ -0,0 +1,191 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Vector2 = void 0;
+const _1 = require(".");
+class Vector2 {
+    /**
+     * Creates a zero vector
+     * @returns Vector [0,0]
+     */
+    static Zero() {
+        return new Vector2(0, 0);
+    }
+    /**
+     * Creates a one vector
+     * @returns Vector [1,1]
+     */
+    static One() {
+        return new Vector2(1, 1);
+    }
+    /**
+     * Checks to see if Vector A equals Vector B
+     * @param a Vector A
+     * @param b Vector B
+     * @returns True if Vector A === Vector B
+     */
+    static Equal(a, b) {
+        if (a.x !== b.x)
+            return false;
+        if (a.y !== b.y)
+            return false;
+        return true;
+    }
+    /**
+     * Creates a Vector from a Data Transfer Object
+     * @param dto The Data Transfer Object
+     * @returns The Vector
+     */
+    static FromDTO(dto) {
+        return new Vector2(dto.x, dto.y);
+    }
+    /**
+     * Adds Vector B to Vector A
+     * @param a Vector A
+     * @param b Vector B
+     * @returns A + B
+     */
+    static Add(a, b) {
+        return new Vector2(a.x + b.x, a.y + b.y);
+    }
+    /**
+     * Subtracts Vector B from Vector A
+     * @param a Vector A
+     * @param b Vector B
+     * @returns A - B
+     */
+    static Subtract(a, b) {
+        return new Vector2(a.x - b.x, a.y - b.y);
+    }
+    /**
+     * Get the magnitude (length) of the vector
+     */
+    get magnitude() {
+        const xSqr = this.x * this.x;
+        const ySqr = this.y * this.y;
+        const magnitude = Math.sqrt(xSqr + ySqr);
+        return magnitude;
+    }
+    /**
+     * @deprecated Use magnitude instead - this property is kept for backward compatibility
+     * Get the magnitude (length) of the vector
+     */
+    get magnitued() {
+        return this.magnitude;
+    }
+    /**
+     * Get the unit vector
+     */
+    get unit() {
+        const mag = this.magnitude;
+        if (mag === 0) {
+            return Vector2.Zero();
+        }
+        const unitX = this.x / mag;
+        const unitY = this.y / mag;
+        return new Vector2(unitX, unitY);
+    }
+    /**
+     * Returns the angle of the direction of this vector in degrees.
+     * A right vector [1,0] will return 0, a left vector [-1,0] will return 180, an up vector [0,1] will return 90 and a down vector [0,-1] will return -90
+     */
+    get theta() {
+        return (Math.atan2(this.y, this.x) * 180) / Math.PI;
+    }
+    /**
+     * Returns the vector as an array of numbers [x,y]
+     */
+    get array() {
+        return [this.x, this.y];
+    }
+    /**
+     * Get the vector as a Data Transfer Object
+     */
+    get dto() {
+        return { x: this.x, y: this.y };
+    }
+    constructor(x, y) {
+        this.x = x;
+        this.y = y;
+    }
+}
+exports.Vector2 = Vector2;
+/**
+ * Checks to see if Vector A is close to Vector B
+ * @param a Vector A
+ * @param b Vector B
+ * @param threshold Tolerance to define "close". Defaults to 0.01
+ * @returns True if A and B are close enough
+ */
+Vector2.Close = (a, b, threshold = 0.01) => {
+    const diff = Vector2.Subtract(a, b);
+    const diffMag = diff.magnitude;
+    if (diffMag < threshold)
+        return true;
+    else
+        return false;
+};
+/**
+ * Rotates a vector by an angle
+ * @param vec The original vector
+ * @param angle The angle
+ * @returns A new Vector that has been rotated from the original by an angle
+ */
+Vector2.Rotate = (vec, angle) => {
+    const x = vec.x * Math.cos(angle.radians) - vec.y * Math.sin(angle.radians);
+    const y = vec.x * Math.sin(angle.radians) + vec.y * Math.cos(angle.radians);
+    return new Vector2(x, y);
+};
+/**
+ * Scales a vector uniformly
+ * @param vector The original vector
+ * @param scale Scale factor
+ * @returns A new, scaled vector
+ */
+Vector2.Scale = (vector, scale) => {
+    const x = scale * vector.x;
+    const y = scale * vector.y;
+    return new Vector2(x, y);
+};
+/**
+ * Creates a new vector of a given length and a unit that is equal to the original vector
+ * @param vector The original vector. This determines the unit of the final vector
+ * @param length The desired length of the final vector
+ * @returns The final vector
+ */
+Vector2.NewVectorOfLength = (vector, length) => {
+    const unit = vector.unit;
+    const x = length * unit.x;
+    const y = length * unit.y;
+    return new Vector2(x, y);
+};
+/**
+ * Calculate the dot product between Vectors A and B
+ * @param a Vector A
+ * @param b Vector B
+ * @returns The Dot product between A and B
+ */
+Vector2.Dot = (a, b) => {
+    return a.x * b.x + a.y * b.y;
+};
+/**
+ * Calculates the dot product between Vectors A and B
+ * @param a Vector A
+ * @param b Vector B
+ * @returns A . B
+ */
+Vector2.AngleBetween = (a, b) => {
+    const dot = Vector2.Dot(a, b);
+    const magnitudes = a.magnitude * b.magnitude;
+    const angRadians = Math.acos(dot / magnitudes);
+    return _1.Angle.FromRadians(angRadians);
+};
+/**
+ * Calculates the Cross product between Vectors A and B
+ * @param a Vector A
+ * @param b Vector B
+ * @returns A X B
+ */
+Vector2.Cross = (a, b) => {
+    return a.x * b.y - a.y * b.x;
+};
+//# sourceMappingURL=Vector2.js.map

package/dist/cjs/ValueObjects/Vector2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Vector2.js","sourceRoot":"","sources":["../../../src/ValueObjects/Vector2.ts"],"names":[],"mappings":";;;AAAA,wBAA0B;AAE1B,MAAa,OAAO;IAClB;;;OAGG;IACI,MAAM,CAAC,IAAI;QAChB,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,GAAG;QACf,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,CAAU,EAAE,CAAU;QACxC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QAC9B,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,GAA6B;QACjD,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,GAAG,CAAC,CAAU,EAAE,CAAU;QACtC,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CAAC,CAAU,EAAE,CAAU;QAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAmGD;;OAEG;IACH,IAAI,SAAS;QACX,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAE7B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;QACzC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC;QAC3B,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;YACd,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;QACxB,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;QAC3B,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,GAAG;QACL,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;IAClC,CAAC;IAED,YAAY,CAAS,EAAE,CAAS;QAC9B,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;;AArNH,0BAsNC;AA5JC;;;;;;GAMG;AACW,aAAK,GAAG,CACpB,CAAU,EACV,CAAU,EACV,YAAoB,IAAI,EACf,EAAE;IACX,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC;IAE/B,IAAI,OAAO,GAAG,SAAS;QAAE,OAAO,IAAI,CAAC;;QAChC,OAAO,KAAK,CAAC;AACpB,CAAC,CAAC;AAEF;;;;;GAKG;AACW,cAAM,GAAG,CAAC,GAAY,EAAE,KAAY,EAAW,EAAE;IAC7D,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5E,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5E,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC3B,CAAC,CAAC;AAEF;;;;;GAKG;AACW,aAAK,GAAG,CAAC,MAAe,EAAE,KAAa,EAAW,EAAE;IAChE,MAAM,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC;IAC3B,MAAM,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC;IAC3B,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC3B,CAAC,CAAC;AAEF;;;;;GAKG;AACW,yBAAiB,GAAG,CAChC,MAAe,EACf,MAAc,EACL,EAAE;IACX,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IACzB,MAAM,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;IAC1B,MAAM,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;IAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC3B,CAAC,CAAC;AAEF;;;;;GAKG;AACW,WAAG,GAAG,CAAC,CAAU,EAAE,CAAU,EAAU,EAAE;IACrD,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF;;;;;GAKG;AACW,oBAAY,GAAG,CAAC,CAAU,EAAE,CAAU,EAAS,EAAE;IAC7D,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,MAAM,UAAU,GAAG,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC;IAE7C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,CAAC;IAE/C,OAAO,QAAK,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF;;;;;GAKG;AACW,aAAK,GAAG,CAAC,CAAU,EAAE,CAAU,EAAU,EAAE;IACvD,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC,CAAC","sourcesContent":["import { Angle } from \".\";\r\n\r\nexport class Vector2 {\r\n  /**\r\n   * Creates a zero vector\r\n   * @returns Vector [0,0]\r\n   */\r\n  public static Zero(): Vector2 {\r\n    return new Vector2(0, 0);\r\n  }\r\n\r\n  /**\r\n   * Creates a one vector\r\n   * @returns Vector [1,1]\r\n   */\r\n  public static One(): Vector2 {\r\n    return new Vector2(1, 1);\r\n  }\r\n\r\n  /**\r\n   * Checks to see if Vector A equals Vector B\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @returns True if Vector A === Vector B\r\n   */\r\n  public static Equal(a: Vector2, b: Vector2): boolean {\r\n    if (a.x !== b.x) return false;\r\n    if (a.y !== b.y) return false;\r\n    return true;\r\n  }\r\n\r\n  /**\r\n   * Creates a Vector from a Data Transfer Object\r\n   * @param dto The Data Transfer Object\r\n   * @returns The Vector\r\n   */\r\n  public static FromDTO(dto: { x: number; y: number }): Vector2 {\r\n    return new Vector2(dto.x, dto.y);\r\n  }\r\n\r\n  /**\r\n   * Adds Vector B to Vector A\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @returns A + B\r\n   */\r\n  public static Add(a: Vector2, b: Vector2): Vector2 {\r\n    return new Vector2(a.x + b.x, a.y + b.y);\r\n  }\r\n\r\n  /**\r\n   * Subtracts Vector B from Vector A\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @returns A - B\r\n   */\r\n  public static Subtract(a: Vector2, b: Vector2): Vector2 {\r\n    return new Vector2(a.x - b.x, a.y - b.y);\r\n  }\r\n\r\n  /**\r\n   * Checks to see if Vector A is close to Vector B\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @param threshold Tolerance to define \"close\". Defaults to 0.01\r\n   * @returns True if A and B are close enough\r\n   */\r\n  public static Close = (\r\n    a: Vector2,\r\n    b: Vector2,\r\n    threshold: number = 0.01\r\n  ): boolean => {\r\n    const diff = Vector2.Subtract(a, b);\r\n    const diffMag = diff.magnitude;\r\n\r\n    if (diffMag < threshold) return true;\r\n    else return false;\r\n  };\r\n\r\n  /**\r\n   * Rotates a vector by an angle\r\n   * @param vec The original vector\r\n   * @param angle The angle\r\n   * @returns A new Vector that has been rotated from the original by an angle\r\n   */\r\n  public static Rotate = (vec: Vector2, angle: Angle): Vector2 => {\r\n    const x = vec.x * Math.cos(angle.radians) - vec.y * Math.sin(angle.radians);\r\n    const y = vec.x * Math.sin(angle.radians) + vec.y * Math.cos(angle.radians);\r\n    return new Vector2(x, y);\r\n  };\r\n\r\n  /**\r\n   * Scales a vector uniformly\r\n   * @param vector The original vector\r\n   * @param scale Scale factor\r\n   * @returns A new, scaled vector\r\n   */\r\n  public static Scale = (vector: Vector2, scale: number): Vector2 => {\r\n    const x = scale * vector.x;\r\n    const y = scale * vector.y;\r\n    return new Vector2(x, y);\r\n  };\r\n\r\n  /**\r\n   * Creates a new vector of a given length and a unit that is equal to the original vector\r\n   * @param vector The original vector. This determines the unit of the final vector\r\n   * @param length The desired length of the final vector\r\n   * @returns The final vector\r\n   */\r\n  public static NewVectorOfLength = (\r\n    vector: Vector2,\r\n    length: number\r\n  ): Vector2 => {\r\n    const unit = vector.unit;\r\n    const x = length * unit.x;\r\n    const y = length * unit.y;\r\n    return new Vector2(x, y);\r\n  };\r\n\r\n  /**\r\n   * Calculate the dot product between Vectors A and B\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @returns The Dot product between A and B\r\n   */\r\n  public static Dot = (a: Vector2, b: Vector2): number => {\r\n    return a.x * b.x + a.y * b.y;\r\n  };\r\n\r\n  /**\r\n   * Calculates the dot product between Vectors A and B\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @returns A . B\r\n   */\r\n  public static AngleBetween = (a: Vector2, b: Vector2): Angle => {\r\n    const dot = Vector2.Dot(a, b);\r\n    const magnitudes = a.magnitude * b.magnitude;\r\n\r\n    const angRadians = Math.acos(dot / magnitudes);\r\n\r\n    return Angle.FromRadians(angRadians);\r\n  };\r\n\r\n  /**\r\n   * Calculates the Cross product between Vectors A and B\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @returns A X B\r\n   */\r\n  public static Cross = (a: Vector2, b: Vector2): number => {\r\n    return a.x * b.y - a.y * b.x;\r\n  };\r\n\r\n  readonly x: number;\r\n  readonly y: number;\r\n\r\n  /**\r\n   * Get the magnitude (length) of the vector\r\n   */\r\n  get magnitude(): number {\r\n    const xSqr = this.x * this.x;\r\n    const ySqr = this.y * this.y;\r\n\r\n    const magnitude = Math.sqrt(xSqr + ySqr);\r\n    return magnitude;\r\n  }\r\n  \r\n  /**\r\n   * @deprecated Use magnitude instead - this property is kept for backward compatibility\r\n   * Get the magnitude (length) of the vector\r\n   */\r\n  get magnitued(): number {\r\n    return this.magnitude;\r\n  }\r\n\r\n  /**\r\n   * Get the unit vector\r\n   */\r\n  get unit(): Vector2 {\r\n    const mag = this.magnitude;\r\n    if (mag === 0) {\r\n      return Vector2.Zero();\r\n    }\r\n\r\n    const unitX = this.x / mag;\r\n    const unitY = this.y / mag;\r\n    return new Vector2(unitX, unitY);\r\n  }\r\n\r\n  /**\r\n   * Returns the angle of the direction of this vector in degrees.\r\n   * A right vector [1,0] will return 0, a left vector [-1,0] will return 180, an up vector [0,1] will return 90 and a down vector [0,-1] will return -90\r\n   */\r\n  get theta(): number {\r\n    return (Math.atan2(this.y, this.x) * 180) / Math.PI;\r\n  }\r\n\r\n  /**\r\n   * Returns the vector as an array of numbers [x,y]\r\n   */\r\n  get array(): [number, number] {\r\n    return [this.x, this.y];\r\n  }\r\n\r\n  /**\r\n   * Get the vector as a Data Transfer Object\r\n   */\r\n  get dto(): { x: number; y: number } {\r\n    return { x: this.x, y: this.y };\r\n  }\r\n\r\n  constructor(x: number, y: number) {\r\n    this.x = x;\r\n    this.y = y;\r\n  }\r\n}\r\n"]}

package/dist/cjs/ValueObjects/Vector3.js

@@ -0,0 +1,231 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Vector3 = void 0;
+class Vector3 {
+    /**
+     * Creates a zero vector
+     * @returns Vector [0,0,0]
+     */
+    static Zero() {
+        return new Vector3(0, 0, 0);
+    }
+    /**
+     * Creates a vector of ones
+     * @returns Vector [1,1,1]
+     */
+    static One() {
+        return new Vector3(1, 1, 1);
+    }
+    /**
+     * Creates a Right vector (positive X)
+     * @param length optional length of the right unit. Default is 1
+     * @returns Vector [length, 0,0]
+     */
+    static Right(length = 1) {
+        return new Vector3(length, 0, 0);
+    }
+    /**
+     * Creates a Left vector (negative X)
+     * @param length optional length of the left unit. Default is 1
+     * @returns Vector [-length, 0, 0]
+     */
+    static Left(length = 1) {
+        return new Vector3(-length, 0, 0);
+    }
+    /**
+     * Creates an Up vector (positive Y)
+     * @param length optional length of the vector. Default is 1
+     * @returns Vector [0, length, 0]
+     */
+    static Up(length = 1) {
+        return new Vector3(0, length, 0);
+    }
+    /**
+     * Creates a Down vector (negative Y)
+     * @param length optional length of the vector. Default is 1
+     * @returns Vector [0, -length, 0]
+     */
+    static Down(length = 1) {
+        return new Vector3(0, -length, 0);
+    }
+    /**
+     * Creates a Forward vector (positive Z)
+     * @param length optional length of the vector. Default is 1
+     * @returns Vector [0, 0, length]
+     */
+    static Forward(length = 1) {
+        return new Vector3(0, 0, length);
+    }
+    /**
+     * Creates a Backward vector (negative Z)
+     * @param length optional length of the vector. Default is 1
+     * @returns Vector [0, 0, -length]
+     */
+    static Backward(length = 1) {
+        return new Vector3(0, 0, -length);
+    }
+    /**
+     * Creates a Vector from an array of components
+     * @param values The x, y, z components as an array
+     * @returns The Vector
+     */
+    static FromArray(values) {
+        return new Vector3(values[0], values[1], values[2]);
+    }
+    /**
+     * Creates a Vector from a Data Transfer Object
+     * @param dto The Data Transfer Object
+     * @returns The Vector
+     */
+    static FromDTO(dto) {
+        return new Vector3(dto.x, dto.y, dto.z);
+    }
+    static interpolateNumber(a, b, percent) {
+        return a + (b - a) * percent;
+    }
+    /**
+     * Gets the magnitude of the Vector3
+     * @returns the magnitude of the Vector3
+     */
+    get magnitude() {
+        const xSqr = this.x * this.x;
+        const ySqr = this.y * this.y;
+        const zSqr = this.z * this.z;
+        const magnitude = Math.sqrt(xSqr + ySqr + zSqr);
+        return magnitude;
+    }
+    /**
+     * Gets the unit vector for this Vector3
+     * @returns the unit vector
+     */
+    get unit() {
+        const mag = this.magnitude;
+        if (mag === 0) {
+            return Vector3.Zero();
+        }
+        const unitX = this.x / mag;
+        const unitY = this.y / mag;
+        const unitZ = this.z / mag;
+        return new Vector3(unitX, unitY, unitZ);
+    }
+    /**
+     * Gets the vector as an array
+     * @returns an array representing the vector
+     */
+    get array() {
+        return [this.x, this.y, this.z];
+    }
+    /**
+     * Get the vector as a Data Transfer Object
+     */
+    get dto() {
+        return { x: this.x, y: this.y, z: this.z };
+    }
+    constructor(x, y, z) {
+        this.x = x;
+        this.y = y;
+        this.z = z;
+    }
+}
+exports.Vector3 = Vector3;
+/**
+ * Adds Vector B to Vector A
+ * @param a Vector A
+ * @param b Vector B
+ * @return Result of A + B
+ */
+Vector3.Add = (a, b) => {
+    return new Vector3(a.x + b.x, a.y + b.y, a.z + b.z);
+};
+/**
+ * Subtracts Vector B from Vector A
+ * @param a Vector A
+ * @param b Vector B
+ * @return Result of A - B
+ */
+Vector3.Subtract = (a, b) => {
+    return new Vector3(a.x - b.x, a.y - b.y, a.z - b.z);
+};
+/**
+ * Checks to see if the two vectors are equal
+ * @param a Vector A
+ * @param b Vector B
+ * @return True if the two vectors are equal, otherwise false
+ */
+Vector3.Equal = (a, b) => {
+    if (a.x === b.x && a.y === b.y && a.z === b.z)
+        return true;
+    else
+        return false;
+};
+/**
+ * Checks to see if the two vectors are close
+ * @param a Vector A
+ * @param b Vector B
+ * @param tolerance Tolerance for checking. Defaulted to 0.01
+ * @return True if the distance between the two vectors is less than the tolerance, otherwise false
+ */
+Vector3.Close = (a, b, tolerance = 0.01) => {
+    const diff = Vector3.Subtract(a, b);
+    const diffMag = diff.magnitude;
+    if (diffMag < tolerance)
+        return true;
+    else
+        return false;
+};
+/**
+ * Calculates the Cross Product between two vectors
+ * @param a Vector A
+ * @param b Vector B
+ * @return the cross product between the two vectors
+ */
+Vector3.Cross = (a, b) => {
+    const x = a.y * b.z - a.z * b.y;
+    const y = a.z * b.x - a.x * b.z;
+    const z = a.x * b.y - a.y * b.x;
+    return new Vector3(x, y, z);
+};
+/**
+ * Calculates the Dot Product between two vectors
+ * @param a Vector A
+ * @param b Vector B
+ * @return the dot product between the two vectors
+ */
+Vector3.Dot = (a, b) => {
+    return a.x * b.x + a.y * b.y + a.z * b.z;
+};
+/**
+ * Create a new vector that will have the same unit as the original vector but set to the desired length
+ * @param vec The original vector
+ * @param length Desired length of the final vector
+ * @return The resulting vector
+ */
+Vector3.NewVectorOfLength = (vec, length) => {
+    const unit = vec.unit;
+    return new Vector3(length * unit.x, length * unit.y, length * unit.z);
+};
+Vector3.Transform = (vector, matrix) => {
+    const m = matrix.m;
+    const rx = vector.x * m[0] + vector.y * m[4] + vector.z * m[8] + m[12];
+    const ry = vector.x * m[1] + vector.y * m[5] + vector.z * m[9] + m[13];
+    const rz = vector.x * m[2] + vector.y * m[6] + vector.z * m[10] + m[14];
+    const rw = 1 / (vector.x * m[3] + vector.y * m[7] + vector.z * m[11] + m[15]);
+    const x = rx * rw;
+    const y = ry * rw;
+    const z = rz * rw;
+    return new Vector3(x, y, z);
+};
+/**
+ * Linearly interpolates between two vectors
+ * @param initial The starting point
+ * @param final The end point
+ * @param percent Percent of the lerp. 0 will return initial and 1 will return final
+ * @return the LERP result Vector3
+ */
+Vector3.Lerp = (initial, final, percent) => {
+    const x = Vector3.interpolateNumber(initial.x, final.x, percent);
+    const y = Vector3.interpolateNumber(initial.y, final.y, percent);
+    const z = Vector3.interpolateNumber(initial.z, final.z, percent);
+    return new Vector3(x, y, z);
+};
+//# sourceMappingURL=Vector3.js.map

package/dist/cjs/ValueObjects/Vector3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Vector3.js","sourceRoot":"","sources":["../../../src/ValueObjects/Vector3.ts"],"names":[],"mappings":";;;AAQA,MAAa,OAAO;IAClB;;;OAGG;IACI,MAAM,CAAC,IAAI;QAChB,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,GAAG;QACf,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QAC5B,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;QAC3B,OAAO,IAAI,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC;QACzB,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;QAC3B,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;QAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;QAC/B,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,MAAgC;QACtD,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,GAAe;QACnC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC;IAoHO,MAAM,CAAC,iBAAiB,CAAC,CAAS,EAAE,CAAS,EAAE,OAAe;QACpE,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC;IAC/B,CAAC;IAMD;;;OAGG;IACH,IAAI,SAAS;QACX,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAE7B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;QAChD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC;QAC3B,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;YACd,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;QACxB,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;QAC3B,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAI,GAAG;QACL,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;IAC7C,CAAC;IAED,YAAY,CAAS,EAAE,CAAS,EAAE,CAAS;QACzC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;;AAnQH,0BAoQC;AA3KC;;;;;GAKG;AACI,WAAG,GAAG,CAAC,CAAU,EAAE,CAAU,EAAW,EAAE;IAC/C,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF;;;;;GAKG;AACI,gBAAQ,GAAG,CAAC,CAAU,EAAE,CAAU,EAAW,EAAE;IACpD,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF;;;;;GAKG;AACI,aAAK,GAAG,CAAC,CAAU,EAAE,CAAU,EAAW,EAAE;IACjD,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;;QACtD,OAAO,KAAK,CAAC;AACpB,CAAC,CAAC;AAEF;;;;;;GAMG;AACI,aAAK,GAAG,CAAC,CAAU,EAAE,CAAU,EAAE,SAAS,GAAG,IAAI,EAAW,EAAE;IACnE,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC;IAE/B,IAAI,OAAO,GAAG,SAAS;QAAE,OAAO,IAAI,CAAC;;QAChC,OAAO,KAAK,CAAC;AACpB,CAAC,CAAC;AAEF;;;;;GAKG;AACI,aAAK,GAAG,CAAC,CAAU,EAAE,CAAU,EAAW,EAAE;IACjD,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAChC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAChC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAChC,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF;;;;;GAKG;AACI,WAAG,GAAG,CAAC,CAAU,EAAE,CAAU,EAAU,EAAE;IAC9C,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;GAKG;AACI,yBAAiB,GAAG,CAAC,GAAY,EAAE,MAAc,EAAW,EAAE;IACnE,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IACtB,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;AACxE,CAAC,CAAC;AAEK,iBAAS,GAAG,CAAC,MAAe,EAAE,MAAc,EAAW,EAAE;IAC9D,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IACnB,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IACvE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IACvE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IACxE,MAAM,EAAE,GACN,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAErE,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;IAClB,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;IAClB,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;IAElB,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF;;;;;;GAMG;AACI,YAAI,GAAG,CACZ,OAAgB,EAChB,KAAc,EACd,OAAe,EACN,EAAE;IACX,MAAM,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACjE,MAAM,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACjE,MAAM,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAEjE,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9B,CAAC,CAAC","sourcesContent":["import { Matrix } from \"./Matrix\";\r\n\r\nexport interface Vector3DTO {\r\n  x: number;\r\n  y: number;\r\n  z: number;\r\n}\r\n\r\nexport class Vector3 {\r\n  /**\r\n   * Creates a zero vector\r\n   * @returns Vector [0,0,0]\r\n   */\r\n  public static Zero() {\r\n    return new Vector3(0, 0, 0);\r\n  }\r\n\r\n  /**\r\n   * Creates a vector of ones\r\n   * @returns Vector [1,1,1]\r\n   */\r\n  public static One() {\r\n    return new Vector3(1, 1, 1);\r\n  }\r\n\r\n  /**\r\n   * Creates a Right vector (positive X)\r\n   * @param length optional length of the right unit. Default is 1\r\n   * @returns Vector [length, 0,0]\r\n   */\r\n  public static Right(length = 1) {\r\n    return new Vector3(length, 0, 0);\r\n  }\r\n\r\n  /**\r\n   * Creates a Left vector (negative X)\r\n   * @param length optional length of the left unit. Default is 1\r\n   * @returns Vector [-length, 0, 0]\r\n   */\r\n  public static Left(length = 1) {\r\n    return new Vector3(-length, 0, 0);\r\n  }\r\n\r\n  /**\r\n   * Creates an Up vector (positive Y)\r\n   * @param length optional length of the vector. Default is 1\r\n   * @returns Vector [0, length, 0]\r\n   */\r\n  public static Up(length = 1) {\r\n    return new Vector3(0, length, 0);\r\n  }\r\n\r\n  /**\r\n   * Creates a Down vector (negative Y)\r\n   * @param length optional length of the vector. Default is 1\r\n   * @returns Vector [0, -length, 0]\r\n   */\r\n  public static Down(length = 1) {\r\n    return new Vector3(0, -length, 0);\r\n  }\r\n\r\n  /**\r\n   * Creates a Forward vector (positive Z)\r\n   * @param length optional length of the vector. Default is 1\r\n   * @returns Vector [0, 0, length]\r\n   */\r\n  public static Forward(length = 1) {\r\n    return new Vector3(0, 0, length);\r\n  }\r\n\r\n  /**\r\n   * Creates a Backward vector (negative Z)\r\n   * @param length optional length of the vector. Default is 1\r\n   * @returns Vector [0, 0, -length]\r\n   */\r\n  public static Backward(length = 1) {\r\n    return new Vector3(0, 0, -length);\r\n  }\r\n\r\n  /**\r\n   * Creates a Vector from an array of components\r\n   * @param values The x, y, z components as an array\r\n   * @returns The Vector\r\n   */\r\n  public static FromArray(values: [number, number, number]): Vector3 {\r\n    return new Vector3(values[0], values[1], values[2]);\r\n  }\r\n\r\n  /**\r\n   * Creates a Vector from a Data Transfer Object\r\n   * @param dto The Data Transfer Object\r\n   * @returns The Vector\r\n   */\r\n  public static FromDTO(dto: Vector3DTO): Vector3 {\r\n    return new Vector3(dto.x, dto.y, dto.z);\r\n  }\r\n\r\n  /**\r\n   * Adds Vector B to Vector A\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @return Result of A + B\r\n   */\r\n  static Add = (a: Vector3, b: Vector3): Vector3 => {\r\n    return new Vector3(a.x + b.x, a.y + b.y, a.z + b.z);\r\n  };\r\n\r\n  /**\r\n   * Subtracts Vector B from Vector A\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @return Result of A - B\r\n   */\r\n  static Subtract = (a: Vector3, b: Vector3): Vector3 => {\r\n    return new Vector3(a.x - b.x, a.y - b.y, a.z - b.z);\r\n  };\r\n\r\n  /**\r\n   * Checks to see if the two vectors are equal\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @return True if the two vectors are equal, otherwise false\r\n   */\r\n  static Equal = (a: Vector3, b: Vector3): boolean => {\r\n    if (a.x === b.x && a.y === b.y && a.z === b.z) return true;\r\n    else return false;\r\n  };\r\n\r\n  /**\r\n   * Checks to see if the two vectors are close\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @param tolerance Tolerance for checking. Defaulted to 0.01\r\n   * @return True if the distance between the two vectors is less than the tolerance, otherwise false\r\n   */\r\n  static Close = (a: Vector3, b: Vector3, tolerance = 0.01): boolean => {\r\n    const diff = Vector3.Subtract(a, b);\r\n    const diffMag = diff.magnitude;\r\n\r\n    if (diffMag < tolerance) return true;\r\n    else return false;\r\n  };\r\n\r\n  /**\r\n   * Calculates the Cross Product between two vectors\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @return the cross product between the two vectors\r\n   */\r\n  static Cross = (a: Vector3, b: Vector3): Vector3 => {\r\n    const x = a.y * b.z - a.z * b.y;\r\n    const y = a.z * b.x - a.x * b.z;\r\n    const z = a.x * b.y - a.y * b.x;\r\n    return new Vector3(x, y, z);\r\n  };\r\n\r\n  /**\r\n   * Calculates the Dot Product between two vectors\r\n   * @param a Vector A\r\n   * @param b Vector B\r\n   * @return the dot product between the two vectors\r\n   */\r\n  static Dot = (a: Vector3, b: Vector3): number => {\r\n    return a.x * b.x + a.y * b.y + a.z * b.z;\r\n  };\r\n\r\n  /**\r\n   * Create a new vector that will have the same unit as the original vector but set to the desired length\r\n   * @param vec The original vector\r\n   * @param length Desired length of the final vector\r\n   * @return The resulting vector\r\n   */\r\n  static NewVectorOfLength = (vec: Vector3, length: number): Vector3 => {\r\n    const unit = vec.unit;\r\n    return new Vector3(length * unit.x, length * unit.y, length * unit.z);\r\n  };\r\n\r\n  static Transform = (vector: Vector3, matrix: Matrix): Vector3 => {\r\n    const m = matrix.m;\r\n    const rx = vector.x * m[0] + vector.y * m[4] + vector.z * m[8] + m[12];\r\n    const ry = vector.x * m[1] + vector.y * m[5] + vector.z * m[9] + m[13];\r\n    const rz = vector.x * m[2] + vector.y * m[6] + vector.z * m[10] + m[14];\r\n    const rw =\r\n      1 / (vector.x * m[3] + vector.y * m[7] + vector.z * m[11] + m[15]);\r\n\r\n    const x = rx * rw;\r\n    const y = ry * rw;\r\n    const z = rz * rw;\r\n\r\n    return new Vector3(x, y, z);\r\n  };\r\n\r\n  /**\r\n   * Linearly interpolates between two vectors\r\n   * @param initial The starting point\r\n   * @param final The end point\r\n   * @param percent Percent of the lerp. 0 will return initial and 1 will return final\r\n   * @return the LERP result Vector3\r\n   */\r\n  static Lerp = (\r\n    initial: Vector3,\r\n    final: Vector3,\r\n    percent: number\r\n  ): Vector3 => {\r\n    const x = Vector3.interpolateNumber(initial.x, final.x, percent);\r\n    const y = Vector3.interpolateNumber(initial.y, final.y, percent);\r\n    const z = Vector3.interpolateNumber(initial.z, final.z, percent);\r\n\r\n    return new Vector3(x, y, z);\r\n  };\r\n\r\n  private static interpolateNumber(a: number, b: number, percent: number) {\r\n    return a + (b - a) * percent;\r\n  }\r\n\r\n  readonly x: number;\r\n  readonly y: number;\r\n  readonly z: number;\r\n\r\n  /**\r\n   * Gets the magnitude of the Vector3\r\n   * @returns the magnitude of the Vector3\r\n   */\r\n  get magnitude(): number {\r\n    const xSqr = this.x * this.x;\r\n    const ySqr = this.y * this.y;\r\n    const zSqr = this.z * this.z;\r\n\r\n    const magnitude = Math.sqrt(xSqr + ySqr + zSqr);\r\n    return magnitude;\r\n  }\r\n\r\n  /**\r\n   * Gets the unit vector for this Vector3\r\n   * @returns the unit vector\r\n   */\r\n  get unit(): Vector3 {\r\n    const mag = this.magnitude;\r\n    if (mag === 0) {\r\n      return Vector3.Zero();\r\n    }\r\n\r\n    const unitX = this.x / mag;\r\n    const unitY = this.y / mag;\r\n    const unitZ = this.z / mag;\r\n    return new Vector3(unitX, unitY, unitZ);\r\n  }\r\n\r\n  /**\r\n   * Gets the vector as an array\r\n   * @returns an array representing the vector\r\n   */\r\n  get array(): [number, number, number] {\r\n    return [this.x, this.y, this.z];\r\n  }\r\n\r\n  /**\r\n   * Get the vector as a Data Transfer Object\r\n   */\r\n  get dto(): Vector3DTO {\r\n    return { x: this.x, y: this.y, z: this.z };\r\n  }\r\n\r\n  constructor(x: number, y: number, z: number) {\r\n    this.x = x;\r\n    this.y = y;\r\n    this.z = z;\r\n  }\r\n}\r\n"]}

package/dist/cjs/ValueObjects/Version.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Version = exports.VersionStage = void 0;
+var VersionStage;
+(function (VersionStage) {
+    VersionStage["RELEASED"] = "released";
+    VersionStage["BETA"] = "beta";
+    VersionStage["ALPHA"] = "alpha";
+})(VersionStage || (exports.VersionStage = VersionStage = {}));
+class Version {
+    static GetLatest(versions) {
+        let latest;
+        for (const v of versions) {
+            if (latest === undefined) {
+                latest = v;
+                continue;
+            }
+            if (v.major > latest.major) {
+                latest = v;
+            }
+            else if (v.major === latest.major) {
+                if (v.minor > latest.minor) {
+                    latest = v;
+                }
+                else if (v.minor === latest.minor) {
+                    if (v.patch > latest.patch) {
+                        latest = v;
+                    }
+                }
+            }
+        }
+        return latest;
+    }
+    static GetLatestWithMajor(versions, major) {
+        let latest;
+        for (const v of versions) {
+            if (v.major !== major)
+                continue;
+            if (latest === undefined) {
+                latest = v;
+                continue;
+            }
+            if (v.minor > latest.minor) {
+                latest = v;
+            }
+            else if (v.minor === latest.minor) {
+                if (v.patch > latest.patch) {
+                    latest = v;
+                }
+            }
+        }
+        return latest;
+    }
+    static GetLatestWithMajorMinor(versions, major, minor) {
+        let latest;
+        for (const v of versions) {
+            if (v.major !== major)
+                continue;
+            if (v.minor !== minor)
+                continue;
+            if (latest === undefined) {
+                latest = v;
+                continue;
+            }
+            if (v.patch > latest.patch) {
+                latest = v;
+            }
+        }
+        return latest;
+    }
+    static FromString(versionString) {
+        const stringSplit = versionString.split('.');
+        if (stringSplit.length !== 3) {
+            throw new Error(`Unable to parse version string: ${versionString} because it could not be split into 3 parts`);
+        }
+        const major = parseInt(stringSplit[0], 10);
+        const minor = parseInt(stringSplit[1], 10);
+        const patchStageLabel = stringSplit[2];
+        let patch = NaN;
+        let stageLabel;
+        const indexOfDash = patchStageLabel.indexOf('-');
+        if (indexOfDash > 0) {
+            const patchStr = patchStageLabel.substring(0, indexOfDash);
+            patch = parseInt(patchStr, 10);
+            stageLabel = patchStageLabel.substring(indexOfDash + 1);
+        }
+        else {
+            patch = parseInt(patchStageLabel, 10);
+        }
+        if (isNaN(major)) {
+            throw new Error(`Unable to parse version string: ${versionString} because Major is not a number`);
+        }
+        if (isNaN(minor)) {
+            throw new Error(`Unable to parse version string: ${versionString} because Minor is not a number`);
+        }
+        if (isNaN(patch)) {
+            throw new Error(`Unable to parse version string: ${versionString} because Patch is not a number`);
+        }
+        let stage = VersionStage.RELEASED;
+        let label;
+        if (stageLabel) {
+            const stageLabelSplit = stageLabel.split('-');
+            if (stageLabelSplit.length > 0) {
+                const stringAsStage = this.stringToStage(stageLabelSplit[0]);
+                if (stringAsStage === undefined) {
+                    label = stageLabel;
+                }
+                else {
+                    stage = stringAsStage;
+                    if (stageLabelSplit.length > 1) {
+                        label = stageLabel.replace(`${stageLabelSplit[0]}-`, '');
+                    }
+                }
+            }
+        }
+        const version = new Version(major, minor, patch, stage, label);
+        return version;
+    }
+    static stringToStage(str) {
+        if (str === VersionStage.ALPHA) {
+            return VersionStage.ALPHA;
+        }
+        else if (str === VersionStage.BETA) {
+            return VersionStage.BETA;
+        }
+        return undefined;
+    }
+    static AreEqual(v1, v2) {
+        if (v1.major !== v2.major)
+            return false;
+        if (v1.minor !== v2.minor)
+            return false;
+        if (v1.patch !== v2.patch)
+            return false;
+        if (v1.stage !== v2.stage)
+            return false;
+        if (v1.label !== v2.label)
+            return false;
+        return true;
+    }
+    static IsNewerVersion(a, b) {
+        if (a.major < b.major)
+            return true;
+        if (a.minor < b.minor)
+            return true;
+        if (a.patch < b.patch)
+            return true;
+        return false;
+    }
+    constructor(major, minor, patch, stage, label) {
+        this.major = major;
+        this.minor = minor;
+        this.patch = patch;
+        this.stage = stage;
+        this.label = label;
+        this.baseVersionString = `${major}.${minor}.${patch}`;
+        let displayString = this.baseVersionString;
+        if (stage === VersionStage.ALPHA) {
+            displayString = displayString + '-alpha';
+        }
+        else if (this.stage === VersionStage.BETA) {
+            displayString = displayString + '-beta';
+        }
+        if (this.label) {
+            displayString = displayString + `-${label}`;
+        }
+        this.displayString = displayString;
+    }
+}
+exports.Version = Version;
+//# sourceMappingURL=Version.js.map

package/dist/cjs/ValueObjects/Version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Version.js","sourceRoot":"","sources":["../../../src/ValueObjects/Version.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,6BAAa,CAAA;IACb,+BAAe,CAAA;AACjB,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AAED,MAAa,OAAO;IAClB,MAAM,CAAC,SAAS,CACd,QAAmB;QAEnB,IAAI,MAA2B,CAAC;QAEhC,KAAI,MAAM,CAAC,IAAI,QAAQ,EAAC,CAAC;YACvB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,GAAG,CAAC,CAAC;gBACX,SAAS;YACX,CAAC;YAED,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC3B,MAAM,GAAG,CAAC,CAAC;YACb,CAAC;iBAAM,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC;gBACpC,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;oBAC3B,MAAM,GAAG,CAAC,CAAC;gBACb,CAAC;qBAAM,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC;oBACpC,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;wBAC3B,MAAM,GAAG,CAAC,CAAC;oBACb,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,kBAAkB,CACvB,QAAmB,EACnB,KAAa;QAEb,IAAI,MAA2B,CAAC;QAEhC,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK;gBAAE,SAAS;YAEhC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,GAAG,CAAC,CAAC;gBACX,SAAS;YACX,CAAC;YAED,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC3B,MAAM,GAAG,CAAC,CAAC;YACb,CAAC;iBAAM,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC;gBACpC,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;oBAC3B,MAAM,GAAG,CAAC,CAAC;gBACb,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,uBAAuB,CAC5B,QAAmB,EACnB,KAAa,EACb,KAAa;QAEb,IAAI,MAA2B,CAAC;QAEhC,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK;gBAAE,SAAS;YAChC,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK;gBAAE,SAAS;YAEhC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,GAAG,CAAC,CAAC;gBACX,SAAS;YACX,CAAC;YAED,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC3B,MAAM,GAAG,CAAC,CAAC;YACb,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,aAAqB;QACrC,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE7C,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,mCAAmC,aAAa,6CAA6C,CAAC,CAAC;QACjH,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3C,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3C,MAAM,eAAe,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QACvC,IAAI,KAAK,GAAG,GAAG,CAAC;QAChB,IAAI,UAA8B,CAAC;QAEnC,MAAM,WAAW,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEjD,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,QAAQ,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;YAC3D,KAAK,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC/B,UAAU,GAAG,eAAe,CAAC,SAAS,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,QAAQ,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,mCAAmC,aAAa,gCAAgC,CAAC,CAAC;QACpG,CAAC;QACD,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,mCAAmC,aAAa,gCAAgC,CAAC,CAAC;QACpG,CAAC;QACD,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,mCAAmC,aAAa,gCAAgC,CAAC,CAAC;QACpG,CAAC;QAED,IAAI,KAAK,GAAG,YAAY,CAAC,QAAQ,CAAC;QAClC,IAAI,KAAyB,CAAC;QAE9B,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,eAAe,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAE9C,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC/B,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE7D,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;oBAChC,KAAK,GAAG,UAAU,CAAC;gBACrB,CAAC;qBAAM,CAAC;oBACN,KAAK,GAAG,aAAa,CAAC;oBACtB,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC/B,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBAC3D,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC/D,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,GAAW;QACtC,IAAI,GAAG,KAAK,YAAY,CAAC,KAAK,EAAE,CAAC;YAC/B,OAAO,YAAY,CAAC,KAAK,CAAC;QAC5B,CAAC;aAAM,IAAI,GAAG,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;YACrC,OAAO,YAAY,CAAC,IAAI,CAAC;QAC3B,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,EAAW,EAAE,EAAW;QACtC,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QACxC,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QACxC,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QACxC,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QACxC,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,CAAU,EAAE,CAAU;QAC1C,IAAI,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACnC,IAAI,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACnC,IAAI,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QAEnC,OAAO,KAAK,CAAC;IACf,CAAC;IAUD,YAAY,KAAa,EAAE,KAAa,EAAE,KAAa,EAAE,KAAmB,EAAE,KAAc;QAC1F,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAEnB,IAAI,CAAC,iBAAiB,GAAE,GAAG,KAAK,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;QAErD,IAAI,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAC3C,IAAI,KAAK,KAAK,YAAY,CAAC,KAAK,EAAE,CAAC;YACjC,aAAa,GAAG,aAAa,GAAG,QAAQ,CAAC;QAC3C,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;YAC5C,aAAa,GAAG,aAAa,GAAG,OAAO,CAAC;QAC1C,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,aAAa,GAAG,aAAa,GAAG,IAAI,KAAK,EAAE,CAAC;QAC9C,CAAC;QAED,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;CACF;AAhMD,0BAgMC","sourcesContent":["export enum VersionStage {\r\n  RELEASED = 'released',\r\n  BETA = 'beta',\r\n  ALPHA = 'alpha',\r\n}\r\n\r\nexport class Version {\r\n  static GetLatest(\r\n    versions: Version[],\r\n  ): Version | undefined {\r\n    let latest: Version | undefined;\r\n\r\n    for(const v of versions){\r\n      if (latest === undefined) {\r\n        latest = v;\r\n        continue;\r\n      }\r\n\r\n      if (v.major > latest.major) {\r\n        latest = v;\r\n      } else if (v.major === latest.major) {\r\n        if (v.minor > latest.minor) {\r\n          latest = v;\r\n        } else if (v.minor === latest.minor) {\r\n          if (v.patch > latest.patch) {\r\n            latest = v;\r\n          }\r\n        }\r\n      }\r\n    }\r\n\r\n    return latest;\r\n  }\r\n\r\n  static GetLatestWithMajor(\r\n    versions: Version[],\r\n    major: number,\r\n  ): Version | undefined {\r\n    let latest: Version | undefined;\r\n\r\n    for (const v of versions) {\r\n      if (v.major !== major) continue;\r\n\r\n      if (latest === undefined) {\r\n        latest = v;\r\n        continue;\r\n      }\r\n\r\n      if (v.minor > latest.minor) {\r\n        latest = v;\r\n      } else if (v.minor === latest.minor) {\r\n        if (v.patch > latest.patch) {\r\n          latest = v;\r\n        }\r\n      }\r\n    }\r\n\r\n    return latest;\r\n  }\r\n\r\n  static GetLatestWithMajorMinor(\r\n    versions: Version[],\r\n    major: number,\r\n    minor: number,\r\n  ): Version | undefined {\r\n    let latest: Version | undefined;\r\n\r\n    for (const v of versions) {\r\n      if (v.major !== major) continue;\r\n      if (v.minor !== minor) continue;\r\n\r\n      if (latest === undefined) {\r\n        latest = v;\r\n        continue;\r\n      }\r\n\r\n      if (v.patch > latest.patch) {\r\n        latest = v;\r\n      }\r\n    }\r\n\r\n    return latest;\r\n  }\r\n\r\n  static FromString(versionString: string): Version {\r\n    const stringSplit = versionString.split('.');\r\n\r\n    if (stringSplit.length !== 3) {\r\n      throw new Error(`Unable to parse version string: ${versionString} because it could not be split into 3 parts`);\r\n    }\r\n\r\n    const major = parseInt(stringSplit[0], 10);\r\n    const minor = parseInt(stringSplit[1], 10);\r\n    const patchStageLabel = stringSplit[2];\r\n    let patch = NaN;\r\n    let stageLabel: string | undefined;\r\n\r\n    const indexOfDash = patchStageLabel.indexOf('-');\r\n\r\n    if (indexOfDash > 0) {\r\n      const patchStr = patchStageLabel.substring(0, indexOfDash);\r\n      patch = parseInt(patchStr, 10);\r\n      stageLabel = patchStageLabel.substring(indexOfDash + 1);\r\n    } else {\r\n      patch = parseInt(patchStageLabel, 10);\r\n    }\r\n\r\n    if (isNaN(major)) {\r\n      throw new Error(`Unable to parse version string: ${versionString} because Major is not a number`);\r\n    }\r\n    if (isNaN(minor)) {\r\n      throw new Error(`Unable to parse version string: ${versionString} because Minor is not a number`);\r\n    }\r\n    if (isNaN(patch)) {\r\n      throw new Error(`Unable to parse version string: ${versionString} because Patch is not a number`);\r\n    }\r\n\r\n    let stage = VersionStage.RELEASED;\r\n    let label: string | undefined;\r\n\r\n    if (stageLabel) {\r\n      const stageLabelSplit = stageLabel.split('-');\r\n\r\n      if (stageLabelSplit.length > 0) {\r\n        const stringAsStage = this.stringToStage(stageLabelSplit[0]);\r\n\r\n        if (stringAsStage === undefined) {\r\n          label = stageLabel;\r\n        } else {\r\n          stage = stringAsStage;\r\n          if (stageLabelSplit.length > 1) {\r\n            label = stageLabel.replace(`${stageLabelSplit[0]}-`, '');\r\n          }\r\n        }\r\n      }\r\n    }\r\n\r\n    const version = new Version(major, minor, patch, stage, label);\r\n    return version;\r\n  }\r\n\r\n  private static stringToStage(str: string): VersionStage | undefined {\r\n    if (str === VersionStage.ALPHA) {\r\n      return VersionStage.ALPHA;\r\n    } else if (str === VersionStage.BETA) {\r\n      return VersionStage.BETA;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  static AreEqual(v1: Version, v2: Version): boolean {\r\n    if (v1.major !== v2.major) return false;\r\n    if (v1.minor !== v2.minor) return false;\r\n    if (v1.patch !== v2.patch) return false;\r\n    if (v1.stage !== v2.stage) return false;\r\n    if (v1.label !== v2.label) return false;\r\n    return true;\r\n  }\r\n\r\n  static IsNewerVersion(a: Version, b: Version): boolean {\r\n    if (a.major < b.major) return true;\r\n    if (a.minor < b.minor) return true;\r\n    if (a.patch < b.patch) return true;\r\n\r\n    return false;\r\n  }\r\n\r\n  readonly major: number;\r\n  readonly minor: number;\r\n  readonly patch: number;\r\n  readonly stage: VersionStage;\r\n  readonly label?: string;\r\n  readonly displayString: string;\r\n  readonly baseVersionString: string;\r\n\r\n  constructor(major: number, minor: number, patch: number, stage: VersionStage, label?: string) {\r\n    this.major = major;\r\n    this.minor = minor;\r\n    this.patch = patch;\r\n    this.stage = stage;\r\n    this.label = label;\r\n\r\n    this.baseVersionString= `${major}.${minor}.${patch}`;\r\n\r\n    let displayString = this.baseVersionString;\r\n    if (stage === VersionStage.ALPHA) {\r\n      displayString = displayString + '-alpha';\r\n    } else if (this.stage === VersionStage.BETA) {\r\n      displayString = displayString + '-beta';\r\n    }\r\n\r\n    if (this.label) {\r\n      displayString = displayString + `-${label}`;\r\n    }\r\n\r\n    this.displayString = displayString;\r\n  }\r\n}\r\n"]}