@vived/core 1.4.2 → 1.4.4

package/dist/cjs/ValueObjects/Vector2.js

@@ -59,17 +59,24 @@ class Vector2 {
     /**
      * Get the magnitude (length) of the vector
      */
-    get magnitued() {
+    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.magnitued;
+        const mag = this.magnitude;
         if (mag === 0) {
             return Vector2.Zero();
         }
@@ -78,14 +85,14 @@ class Vector2 {
         return new Vector2(unitX, unitY);
     }
     /**
-     * Returns the angle of the direction of this angle in degrees.
+     * 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;
     }
     /**
-     * Retuns the vector as an array of numbers [x,y]
+     * Returns the vector as an array of numbers [x,y]
      */
     get array() {
         return [this.x, this.y];
@@ -111,7 +118,7 @@ exports.Vector2 = Vector2;
  */
 Vector2.Close = (a, b, threshold = 0.01) => {
     const diff = Vector2.Subtract(a, b);
-    const diffMag = diff.magnitued;
+    const diffMag = diff.magnitude;
     if (diffMag < threshold)
         return true;
     else
@@ -140,7 +147,7 @@ Vector2.Scale = (vector, scale) => {
     return new Vector2(x, y);
 };
 /**
- * Creates a new vector of a given lenght and a unit that is equal to the original vector
+ * 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
@@ -168,8 +175,8 @@ Vector2.Dot = (a, b) => {
  */
 Vector2.AngleBetween = (a, b) => {
     const dot = Vector2.Dot(a, b);
-    const magnitues = a.magnitued * b.magnitued;
-    const angRadians = Math.acos(dot / magnitues);
+    const magnitudes = a.magnitude * b.magnitude;
+    const angRadians = Math.acos(dot / magnitudes);
     return _1.Angle.FromRadians(angRadians);
 };
 /**

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

@@ -1 +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;;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;;AA7MH,0BA8MC;AApJC;;;;;;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,SAAS,GAAG,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC;IAE5C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;IAE9C,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.magnitued;\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 lenght 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 magnitues = a.magnitued * b.magnitued;\r\n\r\n    const angRadians = Math.acos(dot / magnitues);\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 magnitued(): 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   * Get the unit vector\r\n   */\r\n  get unit(): Vector2 {\r\n    const mag = this.magnitued;\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 angle 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   * Retuns 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"]}
+{"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/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AppObject"), exports);
 __exportStar(require("./Entities"), exports);
+__exportStar(require("./ExampleFeature"), exports);
 __exportStar(require("./Types"), exports);
 __exportStar(require("./Utilities"), exports);
 __exportStar(require("./ValueObjects"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,6CAA2B;AAC3B,0CAAwB;AACxB,8CAA4B;AAC5B,iDAA+B","sourcesContent":["export * from \"./AppObject\";\r\nexport * from \"./Entities\";\r\nexport * from \"./Types\";\r\nexport * from \"./Utilities\";\r\nexport * from \"./ValueObjects\";\r\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,6CAA2B;AAC3B,mDAAgC;AAChC,0CAAwB;AACxB,8CAA4B;AAC5B,iDAA+B","sourcesContent":["export * from \"./AppObject\";\r\nexport * from \"./Entities\";\r\nexport * from \"./ExampleFeature\"\r\nexport * from \"./Types\";\r\nexport * from \"./Utilities\";\r\nexport * from \"./ValueObjects\";\r\n"]}

package/dist/esm/AppObject/AppObject.js

@@ -1,13 +1,42 @@
 import { ObservableEntity } from "../Entities";
+/**
+ * AppObject is the central class in the VIVED application architecture.
+ * It serves as a container for components that implement the application's functionality.
+ * Each AppObject is identified by a unique ID and registered with an AppObjectRepo.
+ *
+ * AppObjects are observable entities that notify observers when their components change.
+ * This enables reactive programming patterns throughout the application.
+ */
 export class AppObject extends ObservableEntity {
 }
+/**
+ * Factory function to create a new AppObject
+ * @param id Unique identifier for the new AppObject
+ * @param repo Repository to register the AppObject with
+ * @returns A new AppObject instance
+ */
 export function makeAppObject(id, repo) {
     return new AppObjectImp(id, repo);
 }
+/**
+ * Implementation of the AppObject abstract class
+ * This class handles the component management functionality
+ */
 class AppObjectImp extends AppObject {
+    /**
+     * Checks if a component of the specified type exists
+     * @param type The component type identifier
+     * @returns True if the component exists, false otherwise
+     */
     hasComponent(type) {
         return this.componentLookup.has(type);
     }
+    /**
+     * Adds a component to this AppObject
+     * If a component of the same type already exists, it will be disposed and replaced
+     * Notifies observers after adding the component
+     * @param component The component to add
+     */
     addComponent(component) {
         const currentComponent = this.componentLookup.get(component.type);
         if (currentComponent) {
@@ -17,6 +46,11 @@ class AppObjectImp extends AppObject {
         this.componentLookup.set(component.type, component);
         this.notify();
     }
+    /**
+     * Retrieves a component by type
+     * @param type The component type identifier
+     * @returns The component cast to type T, or undefined if not found
+     */
     getComponent(type) {
         if (this.componentLookup.has(type)) {
             return this.componentLookup.get(type);
@@ -25,6 +59,10 @@ class AppObjectImp extends AppObject {
             return undefined;
         }
     }
+    /**
+     * Removes a component by type and notifies observers
+     * @param type The component type identifier
+     */
     removeComponent(type) {
         const component = this.componentLookup.get(type);
         if (!component)
@@ -32,12 +70,27 @@ class AppObjectImp extends AppObject {
         this.componentLookup.delete(type);
         this.notify();
     }
+    /**
+     * Gets all components attached to this AppObject
+     * @returns Array of all components
+     */
     allComponents() {
         return Array.from(this.componentLookup.values());
     }
+    /**
+     * Creates a new AppObject instance
+     * @param id Unique identifier for this AppObject
+     * @param repo Repository to register with
+     */
     constructor(id, repo) {
         super();
+        /** Map of component types to component instances */
         this.componentLookup = new Map();
+        /**
+         * Cleans up resources by:
+         * 1. Disposing all attached components
+         * 2. Removing this AppObject from its repository
+         */
         this.dispose = () => {
             const components = Array.from(this.componentLookup.values());
             this.componentLookup.clear();

package/dist/esm/AppObject/AppObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppObject.js","sourceRoot":"","sources":["../../../src/AppObject/AppObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAI/C,MAAM,OAAgB,SAAU,SAAQ,gBAAgB;CAWvD;AAED,MAAM,UAAU,aAAa,CAAC,EAAU,EAAE,IAAmB;IAC3D,OAAO,IAAI,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,YAAa,SAAQ,SAAS;IAMlC,YAAY,CAAC,IAAY;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED,YAAY,CAAC,SAA6B;QACxC,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAClE,IAAI,gBAAgB,EAAE,CAAC;YACrB,OAAO,CAAC,IAAI,CACV,yBAAyB,SAAS,CAAC,IAAI,yBAAyB,IAAI,CAAC,EAAE,EAAE,CAC1E,CAAC;YACF,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAC7B,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACpD,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,YAAY,CAA+B,IAAY;QACrD,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAM,CAAC;QAC7C,CAAC;aAAM,CAAC;YACN,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED,eAAe,CAAC,IAAY;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEjD,IAAI,CAAC,SAAS;YAAE,OAAO;QAEvB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC;IACnD,CAAC;IAaD,YAAY,EAAU,EAAE,IAAmB;QACzC,KAAK,EAAE,CAAC;QApDF,oBAAe,GAAG,IAAI,GAAG,EAA8B,CAAC;QAyChE,YAAO,GAAG,GAAS,EAAE;YACnB,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC;YAC7D,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YAC7B,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YAErC,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;gBACpC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrC,CAAC;QACH,CAAC,CAAC;QAIA,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF","sourcesContent":["import { ObservableEntity } from \"../Entities\";\r\nimport { AppObjectComponent } from \"./AppObjectComponent\";\r\nimport { AppObjectRepo } from \"./AppObjectRepo\";\r\n\r\nexport abstract class AppObject extends ObservableEntity {\r\n  abstract readonly id: string;\r\n  abstract readonly appObjectRepo: AppObjectRepo;\r\n\r\n  abstract hasComponent(type: string): boolean;\r\n  abstract addComponent(component: AppObjectComponent): void;\r\n  abstract getComponent<T extends AppObjectComponent>(type: string): T | undefined;\r\n  abstract removeComponent(type: string): void;\r\n  abstract allComponents(): AppObjectComponent[];\r\n\r\n  abstract dispose(): void;\r\n}\r\n\r\nexport function makeAppObject(id: string, repo: AppObjectRepo): AppObject {\r\n  return new AppObjectImp(id, repo);\r\n}\r\n\r\nclass AppObjectImp extends AppObject {\r\n  readonly id: string;\r\n  readonly appObjectRepo: AppObjectRepo;\r\n\r\n  private componentLookup = new Map<string, AppObjectComponent>();\r\n\r\n  hasComponent(type: string): boolean {\r\n    return this.componentLookup.has(type);\r\n  }\r\n\r\n  addComponent(component: AppObjectComponent): void {\r\n    const currentComponent = this.componentLookup.get(component.type);\r\n    if (currentComponent) {\r\n      console.warn(\r\n        `[AppObject] Component ${component.type} is being replaced on ${this.id}`\r\n      );\r\n      currentComponent.dispose();\r\n    }\r\n\r\n    this.componentLookup.set(component.type, component);\r\n    this.notify();\r\n  }\r\n\r\n  getComponent<T extends AppObjectComponent>(type: string): T | undefined {\r\n    if (this.componentLookup.has(type)) {\r\n      return this.componentLookup.get(type) as T;\r\n    } else {\r\n      return undefined;\r\n    }\r\n  }\r\n\r\n  removeComponent(type: string): void {\r\n    const component = this.componentLookup.get(type);\r\n\r\n    if (!component) return;\r\n\r\n    this.componentLookup.delete(type);\r\n    this.notify();\r\n  }\r\n\r\n  allComponents(): AppObjectComponent[] {\r\n    return Array.from(this.componentLookup.values());\r\n  }\r\n\r\n\r\n  dispose = (): void => {\r\n    const components = Array.from(this.componentLookup.values());\r\n    this.componentLookup.clear();\r\n    components.forEach(c => c.dispose());\r\n\r\n    if (this.appObjectRepo.has(this.id)) {\r\n      this.appObjectRepo.remove(this.id);\r\n    }\r\n  };\r\n\r\n  constructor(id: string, repo: AppObjectRepo) {\r\n    super();\r\n    this.id = id;\r\n    this.appObjectRepo = repo;\r\n    this.appObjectRepo.add(this);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"AppObject.js","sourceRoot":"","sources":["../../../src/AppObject/AppObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAI/C;;;;;;;GAOG;AACH,MAAM,OAAgB,SAAU,SAAQ,gBAAgB;CA4CvD;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,EAAU,EAAE,IAAmB;IAC3D,OAAO,IAAI,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,MAAM,YAAa,SAAQ,SAAS;IAOlC;;;;OAIG;IACH,YAAY,CAAC,IAAY;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,SAA6B;QACxC,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAClE,IAAI,gBAAgB,EAAE,CAAC;YACrB,OAAO,CAAC,IAAI,CACV,yBAAyB,SAAS,CAAC,IAAI,yBAAyB,IAAI,CAAC,EAAE,EAAE,CAC1E,CAAC;YACF,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAC7B,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACpD,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,YAAY,CAA+B,IAAY;QACrD,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAM,CAAC;QAC7C,CAAC;aAAM,CAAC;YACN,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,IAAY;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEjD,IAAI,CAAC,SAAS;YAAE,OAAO;QAEvB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC;IACnD,CAAC;IAiBD;;;;OAIG;IACH,YAAY,EAAU,EAAE,IAAmB;QACzC,KAAK,EAAE,CAAC;QAtFV,oDAAoD;QAC5C,oBAAe,GAAG,IAAI,GAAG,EAA8B,CAAC;QAgEhE;;;;WAIG;QACH,YAAO,GAAG,GAAS,EAAE;YACnB,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC;YAC7D,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YAC7B,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YAErC,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;gBACpC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrC,CAAC;QACH,CAAC,CAAC;QASA,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF","sourcesContent":["import { ObservableEntity } from \"../Entities\";\r\nimport { AppObjectComponent } from \"./AppObjectComponent\";\r\nimport { AppObjectRepo } from \"./AppObjectRepo\";\r\n\r\n/**\r\n * AppObject is the central class in the VIVED application architecture.\r\n * It serves as a container for components that implement the application's functionality.\r\n * Each AppObject is identified by a unique ID and registered with an AppObjectRepo.\r\n * \r\n * AppObjects are observable entities that notify observers when their components change.\r\n * This enables reactive programming patterns throughout the application.\r\n */\r\nexport abstract class AppObject extends ObservableEntity {\r\n  /** Unique identifier for this AppObject */\r\n  abstract readonly id: string;\r\n  \r\n  /** Repository that manages this AppObject */\r\n  abstract readonly appObjectRepo: AppObjectRepo;\r\n\r\n  /**\r\n   * Checks if this AppObject has a component of the specified type\r\n   * @param type The component type identifier\r\n   * @returns True if the component exists, false otherwise\r\n   */\r\n  abstract hasComponent(type: string): boolean;\r\n  \r\n  /**\r\n   * Adds a component to this AppObject\r\n   * If a component of the same type already exists, it will be replaced\r\n   * @param component The component to add\r\n   */\r\n  abstract addComponent(component: AppObjectComponent): void;\r\n  \r\n  /**\r\n   * Retrieves a component by type\r\n   * @param type The component type identifier\r\n   * @returns The component cast to type T, or undefined if not found\r\n   */\r\n  abstract getComponent<T extends AppObjectComponent>(type: string): T | undefined;\r\n  \r\n  /**\r\n   * Removes a component by type\r\n   * @param type The component type identifier\r\n   */\r\n  abstract removeComponent(type: string): void;\r\n  \r\n  /**\r\n   * Gets all components attached to this AppObject\r\n   * @returns Array of all components\r\n   */\r\n  abstract allComponents(): AppObjectComponent[];\r\n\r\n  /**\r\n   * Cleans up resources and removes this AppObject from its repository\r\n   */\r\n  abstract dispose(): void;\r\n}\r\n\r\n/**\r\n * Factory function to create a new AppObject\r\n * @param id Unique identifier for the new AppObject\r\n * @param repo Repository to register the AppObject with\r\n * @returns A new AppObject instance\r\n */\r\nexport function makeAppObject(id: string, repo: AppObjectRepo): AppObject {\r\n  return new AppObjectImp(id, repo);\r\n}\r\n\r\n/**\r\n * Implementation of the AppObject abstract class\r\n * This class handles the component management functionality\r\n */\r\nclass AppObjectImp extends AppObject {\r\n  readonly id: string;\r\n  readonly appObjectRepo: AppObjectRepo;\r\n\r\n  /** Map of component types to component instances */\r\n  private componentLookup = new Map<string, AppObjectComponent>();\r\n\r\n  /**\r\n   * Checks if a component of the specified type exists\r\n   * @param type The component type identifier\r\n   * @returns True if the component exists, false otherwise\r\n   */\r\n  hasComponent(type: string): boolean {\r\n    return this.componentLookup.has(type);\r\n  }\r\n\r\n  /**\r\n   * Adds a component to this AppObject\r\n   * If a component of the same type already exists, it will be disposed and replaced\r\n   * Notifies observers after adding the component\r\n   * @param component The component to add\r\n   */\r\n  addComponent(component: AppObjectComponent): void {\r\n    const currentComponent = this.componentLookup.get(component.type);\r\n    if (currentComponent) {\r\n      console.warn(\r\n        `[AppObject] Component ${component.type} is being replaced on ${this.id}`\r\n      );\r\n      currentComponent.dispose();\r\n    }\r\n\r\n    this.componentLookup.set(component.type, component);\r\n    this.notify();\r\n  }\r\n\r\n  /**\r\n   * Retrieves a component by type\r\n   * @param type The component type identifier\r\n   * @returns The component cast to type T, or undefined if not found\r\n   */\r\n  getComponent<T extends AppObjectComponent>(type: string): T | undefined {\r\n    if (this.componentLookup.has(type)) {\r\n      return this.componentLookup.get(type) as T;\r\n    } else {\r\n      return undefined;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Removes a component by type and notifies observers\r\n   * @param type The component type identifier\r\n   */\r\n  removeComponent(type: string): void {\r\n    const component = this.componentLookup.get(type);\r\n\r\n    if (!component) return;\r\n\r\n    this.componentLookup.delete(type);\r\n    this.notify();\r\n  }\r\n\r\n  /**\r\n   * Gets all components attached to this AppObject\r\n   * @returns Array of all components\r\n   */\r\n  allComponents(): AppObjectComponent[] {\r\n    return Array.from(this.componentLookup.values());\r\n  }\r\n\r\n  /**\r\n   * Cleans up resources by:\r\n   * 1. Disposing all attached components\r\n   * 2. Removing this AppObject from its repository\r\n   */\r\n  dispose = (): void => {\r\n    const components = Array.from(this.componentLookup.values());\r\n    this.componentLookup.clear();\r\n    components.forEach(c => c.dispose());\r\n\r\n    if (this.appObjectRepo.has(this.id)) {\r\n      this.appObjectRepo.remove(this.id);\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Creates a new AppObject instance\r\n   * @param id Unique identifier for this AppObject\r\n   * @param repo Repository to register with\r\n   */\r\n  constructor(id: string, repo: AppObjectRepo) {\r\n    super();\r\n    this.id = id;\r\n    this.appObjectRepo = repo;\r\n    this.appObjectRepo.add(this);\r\n  }\r\n}\r\n"]}

package/dist/esm/AppObject/AppObjectComponent.js

@@ -1,16 +1,49 @@
+/**
+ * Enumeration of the different types of components in the architecture.
+ * Each type serves a specific purpose in the application structure.
+ */
 export var AppObjectComponentType;
 (function (AppObjectComponentType) {
+    /** Stores and manages application state */
     AppObjectComponentType["ENTITY"] = "Entity";
+    /** Transforms application state into view models */
     AppObjectComponentType["PM"] = "Presentation Manager";
+    /** Implements business logic and coordinates between layers */
     AppObjectComponentType["UC"] = "Use Case";
+    /** Handles user inputs and external events */
     AppObjectComponentType["CONTROLLER"] = "Controller";
+    /** Renders UI elements and interacts with the DOM/rendering system */
     AppObjectComponentType["VIEW"] = "View";
+    /** Default type for components that don't fit the standard categories */
     AppObjectComponentType["UNKNOWN"] = "Unknown";
 })(AppObjectComponentType || (AppObjectComponentType = {}));
+/**
+ * Base class for all components in the AppObject architecture.
+ *
+ * Components attach to AppObjects and provide specific functionality based on their type.
+ * The architecture follows a clean separation of concerns, with each component type
+ * having a well-defined responsibility in the application.
+ *
+ * Components can communicate with each other through various mechanisms:
+ * - Direct access via parent AppObject
+ * - Repository-level singleton access
+ * - Observer patterns for reactive updates
+ */
 export class AppObjectComponent {
+    /**
+     * Convenience accessor for the repository containing all AppObjects
+     * @returns The application's AppObjectRepo
+     */
     get appObjects() {
         return this.appObject.appObjectRepo;
     }
+    /**
+     * Retrieves a singleton component of the specified type from the repository
+     * Results are cached for better performance in repeated calls
+     *
+     * @param type The component type identifier to look up
+     * @returns The singleton component cast to type T, or undefined if not found
+     */
     getCachedSingleton(type) {
         if (!this.cachedComponents.has(type)) {
             const component = this.appObjects.getSingleton(type);
@@ -23,6 +56,13 @@ export class AppObjectComponent {
         }
         return this.cachedComponents.get(type);
     }
+    /**
+     * Retrieves a component from the same AppObject as this component
+     * Results are cached for better performance in repeated calls
+     *
+     * @param type The component type identifier to look up
+     * @returns The component cast to type T, or undefined if not found
+     */
     getCachedLocalComponent(type) {
         if (!this.cachedComponents.has(type)) {
             const component = this.appObject.getComponent(type);
@@ -35,6 +75,14 @@ export class AppObjectComponent {
         }
         return this.cachedComponents.get(type);
     }
+    /**
+     * Retrieves a singleton component from the repository with customizable logging
+     * Unlike getCachedSingleton, results are not cached
+     *
+     * @param type The component type identifier to look up
+     * @param logType The severity level for logging if component isn't found
+     * @returns The singleton component cast to type T, or undefined if not found
+     */
     getSingleton(type, logType = "WARN") {
         const comp = this.appObjects.getSingleton(type);
         if (!comp) {
@@ -53,22 +101,52 @@ export class AppObjectComponent {
         }
         return comp;
     }
+    /**
+     * Cleans up resources used by this component
+     * Removes itself from the parent AppObject if it's still attached
+     */
     dispose() {
         if (this.appObject.getComponent(this.type) === this) {
             this.appObject.removeComponent(this.type);
         }
     }
+    /**
+     * Logs an informational message to the application's logging system
+     * Messages are prefixed with the AppObject ID and component type for easier debugging
+     *
+     * @param message The message to log
+     */
     log(message) {
         this.appObjects.submitLog(`${this.appObject.id}/${this.type}`, message);
     }
+    /**
+     * Logs a warning message to the application's logging system
+     * Messages are prefixed with the AppObject ID and component type for easier debugging
+     *
+     * @param message The warning message to log
+     */
     warn(message) {
         this.appObjects.submitWarning(`${this.appObject.id}/${this.type}`, message);
     }
+    /**
+     * Logs an error message to the application's logging system
+     * Messages are prefixed with the AppObject ID and component type for easier debugging
+     *
+     * @param message The error message to log
+     */
     error(message) {
         this.appObjects.submitError(`${this.appObject.id}/${this.type}`, message);
     }
+    /**
+     * Creates a new component and attaches it to the specified AppObject
+     *
+     * @param appObject The parent AppObject this component will be attached to
+     * @param type The unique type identifier for this component
+     */
     constructor(appObject, type) {
+        /** The type category of this component */
         this.componentType = AppObjectComponentType.UNKNOWN;
+        /** Cache for components to avoid repeated lookups */
         this.cachedComponents = new Map();
         this.appObject = appObject;
         this.type = type;

package/dist/esm/AppObject/AppObjectComponent.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppObjectComponent.js","sourceRoot":"","sources":["../../../src/AppObject/AppObjectComponent.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,sBAOX;AAPD,WAAY,sBAAsB;IAChC,2CAAiB,CAAA;IACjB,qDAA2B,CAAA;IAC3B,yCAAe,CAAA;IACf,mDAAyB,CAAA;IACzB,uCAAa,CAAA;IACb,6CAAmB,CAAA;AACrB,CAAC,EAPW,sBAAsB,KAAtB,sBAAsB,QAOjC;AAED,MAAM,OAAO,kBAAkB;IAI7B,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC;IACtC,CAAC;IAGD,kBAAkB,CAChB,IAAY;QAEZ,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACrD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,IAAI,CAAC,IAAI,CAAC,sCAAsC,GAAG,IAAI,CAAC,CAAC;YAC3D,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAM,CAAC;IAC9C,CAAC;IAED,uBAAuB,CACrB,IAAY;QAEZ,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YAEpD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,IAAI,CAAC,IAAI,CAAC,wCAAwC,GAAG,IAAI,CAAC,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAM,CAAC;IAC9C,CAAC;IAED,YAAY,CACV,IAAY,EACZ,UAAoC,MAAM;QAE1C,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAI,IAAI,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,GAAG,GAAG,+BAA+B,GAAG,IAAI,CAAC;YACnD,QAAQ,OAAO,EAAE,CAAC;gBAChB,KAAK,OAAO;oBACV,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAChB,MAAM;gBACR,KAAK,KAAK;oBACR,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBACd,MAAM;gBACR,KAAK,MAAM;oBACT,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACf,MAAM;YACV,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YACpD,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,GAAG,CAAC,OAAe;QACjB,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,CAAC,OAAe;QAClB,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED,KAAK,CAAC,OAAe;QACnB,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED,YAAY,SAAoB,EAAE,IAAY;QAjFrC,kBAAa,GAA2B,sBAAsB,CAAC,OAAO,CAAC;QAOxE,qBAAgB,GAAG,IAAI,GAAG,EAA8B,CAAC;QA2E/D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF","sourcesContent":["import { AppObject } from \"./AppObject\";\r\nimport { AppObjectRepo } from \"./AppObjectRepo\";\r\n\r\nexport enum AppObjectComponentType {\r\n  ENTITY = \"Entity\",\r\n  PM = \"Presentation Manager\",\r\n  UC = \"Use Case\",\r\n  CONTROLLER = \"Controller\",\r\n  VIEW = \"View\",\r\n  UNKNOWN = \"Unknown\",\r\n}\r\n\r\nexport class AppObjectComponent {\r\n  readonly componentType: AppObjectComponentType = AppObjectComponentType.UNKNOWN;\r\n  readonly type: string;\r\n  readonly appObject: AppObject;\r\n  get appObjects(): AppObjectRepo {\r\n    return this.appObject.appObjectRepo;\r\n  }\r\n\r\n  private cachedComponents = new Map<string, AppObjectComponent>();\r\n  getCachedSingleton<T extends AppObjectComponent>(\r\n    type: string\r\n  ): T | undefined {\r\n    if (!this.cachedComponents.has(type)) {\r\n      const component = this.appObjects.getSingleton(type);\r\n      if (!component) {\r\n        this.warn(\"Unable to get cached singleton type \" + type);\r\n      } else {\r\n        this.cachedComponents.set(type, component);\r\n      }\r\n    }\r\n\r\n    return this.cachedComponents.get(type) as T;\r\n  }\r\n\r\n  getCachedLocalComponent<T extends AppObjectComponent>(\r\n    type: string\r\n  ): T | undefined {\r\n    if (!this.cachedComponents.has(type)) {\r\n      const component = this.appObject.getComponent(type);\r\n\r\n      if (!component) {\r\n        this.warn(\"Unable to get local component of type \" + type);\r\n      } else {\r\n        this.cachedComponents.set(type, component);\r\n      }\r\n    }\r\n\r\n    return this.cachedComponents.get(type) as T;\r\n  }\r\n\r\n  getSingleton<T extends AppObjectComponent>(\r\n    type: string,\r\n    logType: \"LOG\" | \"WARN\" | \"ERROR\" = \"WARN\"\r\n  ): T | undefined {\r\n    const comp = this.appObjects.getSingleton<T>(type);\r\n\r\n    if (!comp) {\r\n      const msg = \"Unable to get singleton type \" + type;\r\n      switch (logType) {\r\n        case \"ERROR\":\r\n          this.error(msg);\r\n          break;\r\n        case \"LOG\":\r\n          this.log(msg);\r\n          break;\r\n        case \"WARN\":\r\n          this.warn(msg);\r\n          break;\r\n      }\r\n    }\r\n\r\n    return comp;\r\n  }\r\n\r\n  dispose() {\r\n    if (this.appObject.getComponent(this.type) === this) {\r\n      this.appObject.removeComponent(this.type);\r\n    }\r\n  }\r\n\r\n  log(message: string) {\r\n    this.appObjects.submitLog(`${this.appObject.id}/${this.type}`, message);\r\n  }\r\n\r\n  warn(message: string) {\r\n    this.appObjects.submitWarning(`${this.appObject.id}/${this.type}`, message);\r\n  }\r\n\r\n  error(message: string) {\r\n    this.appObjects.submitError(`${this.appObject.id}/${this.type}`, message);\r\n  }\r\n\r\n  constructor(appObject: AppObject, type: string) {\r\n    this.appObject = appObject;\r\n    this.type = type;\r\n    appObject.addComponent(this);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"AppObjectComponent.js","sourceRoot":"","sources":["../../../src/AppObject/AppObjectComponent.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,CAAN,IAAY,sBAkBX;AAlBD,WAAY,sBAAsB;IAChC,2CAA2C;IAC3C,2CAAiB,CAAA;IAEjB,oDAAoD;IACpD,qDAA2B,CAAA;IAE3B,+DAA+D;IAC/D,yCAAe,CAAA;IAEf,8CAA8C;IAC9C,mDAAyB,CAAA;IAEzB,sEAAsE;IACtE,uCAAa,CAAA;IAEb,yEAAyE;IACzE,6CAAmB,CAAA;AACrB,CAAC,EAlBW,sBAAsB,KAAtB,sBAAsB,QAkBjC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,kBAAkB;IAU7B;;;OAGG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC;IACtC,CAAC;IAKD;;;;;;OAMG;IACH,kBAAkB,CAChB,IAAY;QAEZ,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACrD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,IAAI,CAAC,IAAI,CAAC,sCAAsC,GAAG,IAAI,CAAC,CAAC;YAC3D,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAM,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACH,uBAAuB,CACrB,IAAY;QAEZ,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YAEpD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,IAAI,CAAC,IAAI,CAAC,wCAAwC,GAAG,IAAI,CAAC,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAM,CAAC;IAC9C,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CACV,IAAY,EACZ,UAAoC,MAAM;QAE1C,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAI,IAAI,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,GAAG,GAAG,+BAA+B,GAAG,IAAI,CAAC;YACnD,QAAQ,OAAO,EAAE,CAAC;gBAChB,KAAK,OAAO;oBACV,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAChB,MAAM;gBACR,KAAK,KAAK;oBACR,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBACd,MAAM;gBACR,KAAK,MAAM;oBACT,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACf,MAAM;YACV,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YACpD,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,OAAe;QACjB,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,OAAe;QAClB,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAe;QACnB,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACH,YAAY,SAAoB,EAAE,IAAY;QA/I9C,0CAA0C;QACjC,kBAAa,GAA2B,sBAAsB,CAAC,OAAO,CAAC;QAgBhF,qDAAqD;QAC7C,qBAAgB,GAAG,IAAI,GAAG,EAA8B,CAAC;QA8H/D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF","sourcesContent":["import { AppObject } from \"./AppObject\";\r\nimport { AppObjectRepo } from \"./AppObjectRepo\";\r\n\r\n/**\r\n * Enumeration of the different types of components in the architecture.\r\n * Each type serves a specific purpose in the application structure.\r\n */\r\nexport enum AppObjectComponentType {\r\n  /** Stores and manages application state */\r\n  ENTITY = \"Entity\",\r\n  \r\n  /** Transforms application state into view models */\r\n  PM = \"Presentation Manager\",\r\n  \r\n  /** Implements business logic and coordinates between layers */\r\n  UC = \"Use Case\",\r\n  \r\n  /** Handles user inputs and external events */\r\n  CONTROLLER = \"Controller\",\r\n  \r\n  /** Renders UI elements and interacts with the DOM/rendering system */\r\n  VIEW = \"View\",\r\n  \r\n  /** Default type for components that don't fit the standard categories */\r\n  UNKNOWN = \"Unknown\",\r\n}\r\n\r\n/**\r\n * Base class for all components in the AppObject architecture.\r\n * \r\n * Components attach to AppObjects and provide specific functionality based on their type.\r\n * The architecture follows a clean separation of concerns, with each component type\r\n * having a well-defined responsibility in the application.\r\n * \r\n * Components can communicate with each other through various mechanisms:\r\n * - Direct access via parent AppObject\r\n * - Repository-level singleton access\r\n * - Observer patterns for reactive updates\r\n */\r\nexport class AppObjectComponent {\r\n  /** The type category of this component */\r\n  readonly componentType: AppObjectComponentType = AppObjectComponentType.UNKNOWN;\r\n  \r\n  /** Unique type identifier for this specific component */\r\n  readonly type: string;\r\n  \r\n  /** The parent AppObject this component is attached to */\r\n  readonly appObject: AppObject;\r\n  \r\n  /**\r\n   * Convenience accessor for the repository containing all AppObjects\r\n   * @returns The application's AppObjectRepo\r\n   */\r\n  get appObjects(): AppObjectRepo {\r\n    return this.appObject.appObjectRepo;\r\n  }\r\n\r\n  /** Cache for components to avoid repeated lookups */\r\n  private cachedComponents = new Map<string, AppObjectComponent>();\r\n  \r\n  /**\r\n   * Retrieves a singleton component of the specified type from the repository\r\n   * Results are cached for better performance in repeated calls\r\n   * \r\n   * @param type The component type identifier to look up\r\n   * @returns The singleton component cast to type T, or undefined if not found\r\n   */\r\n  getCachedSingleton<T extends AppObjectComponent>(\r\n    type: string\r\n  ): T | undefined {\r\n    if (!this.cachedComponents.has(type)) {\r\n      const component = this.appObjects.getSingleton(type);\r\n      if (!component) {\r\n        this.warn(\"Unable to get cached singleton type \" + type);\r\n      } else {\r\n        this.cachedComponents.set(type, component);\r\n      }\r\n    }\r\n\r\n    return this.cachedComponents.get(type) as T;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a component from the same AppObject as this component\r\n   * Results are cached for better performance in repeated calls\r\n   * \r\n   * @param type The component type identifier to look up\r\n   * @returns The component cast to type T, or undefined if not found\r\n   */\r\n  getCachedLocalComponent<T extends AppObjectComponent>(\r\n    type: string\r\n  ): T | undefined {\r\n    if (!this.cachedComponents.has(type)) {\r\n      const component = this.appObject.getComponent(type);\r\n\r\n      if (!component) {\r\n        this.warn(\"Unable to get local component of type \" + type);\r\n      } else {\r\n        this.cachedComponents.set(type, component);\r\n      }\r\n    }\r\n\r\n    return this.cachedComponents.get(type) as T;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a singleton component from the repository with customizable logging\r\n   * Unlike getCachedSingleton, results are not cached\r\n   * \r\n   * @param type The component type identifier to look up\r\n   * @param logType The severity level for logging if component isn't found\r\n   * @returns The singleton component cast to type T, or undefined if not found\r\n   */\r\n  getSingleton<T extends AppObjectComponent>(\r\n    type: string,\r\n    logType: \"LOG\" | \"WARN\" | \"ERROR\" = \"WARN\"\r\n  ): T | undefined {\r\n    const comp = this.appObjects.getSingleton<T>(type);\r\n\r\n    if (!comp) {\r\n      const msg = \"Unable to get singleton type \" + type;\r\n      switch (logType) {\r\n        case \"ERROR\":\r\n          this.error(msg);\r\n          break;\r\n        case \"LOG\":\r\n          this.log(msg);\r\n          break;\r\n        case \"WARN\":\r\n          this.warn(msg);\r\n          break;\r\n      }\r\n    }\r\n\r\n    return comp;\r\n  }\r\n\r\n  /**\r\n   * Cleans up resources used by this component\r\n   * Removes itself from the parent AppObject if it's still attached\r\n   */\r\n  dispose() {\r\n    if (this.appObject.getComponent(this.type) === this) {\r\n      this.appObject.removeComponent(this.type);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Logs an informational message to the application's logging system\r\n   * Messages are prefixed with the AppObject ID and component type for easier debugging\r\n   * \r\n   * @param message The message to log\r\n   */\r\n  log(message: string) {\r\n    this.appObjects.submitLog(`${this.appObject.id}/${this.type}`, message);\r\n  }\r\n\r\n  /**\r\n   * Logs a warning message to the application's logging system\r\n   * Messages are prefixed with the AppObject ID and component type for easier debugging\r\n   * \r\n   * @param message The warning message to log\r\n   */\r\n  warn(message: string) {\r\n    this.appObjects.submitWarning(`${this.appObject.id}/${this.type}`, message);\r\n  }\r\n\r\n  /**\r\n   * Logs an error message to the application's logging system\r\n   * Messages are prefixed with the AppObject ID and component type for easier debugging\r\n   * \r\n   * @param message The error message to log\r\n   */\r\n  error(message: string) {\r\n    this.appObjects.submitError(`${this.appObject.id}/${this.type}`, message);\r\n  }\r\n\r\n  /**\r\n   * Creates a new component and attaches it to the specified AppObject\r\n   * \r\n   * @param appObject The parent AppObject this component will be attached to\r\n   * @param type The unique type identifier for this component\r\n   */\r\n  constructor(appObject: AppObject, type: string) {\r\n    this.appObject = appObject;\r\n    this.type = type;\r\n    appObject.addComponent(this);\r\n  }\r\n}\r\n"]}

package/dist/esm/AppObject/AppObjectController.js

@@ -1,7 +1,29 @@
 import { AppObjectComponent, AppObjectComponentType, } from "./AppObjectComponent";
+/**
+ * AppObjectController serves as a base controller class within the application framework.
+ *
+ * Controllers are components that handle logic-related operations for an AppObject,
+ * such as user input processing, state management, or business logic implementation.
+ * Extend this class to create specialized controllers for specific application features.
+ *
+ * @extends AppObjectComponent
+ * @example
+ * ```typescript
+ * class PlayerController extends AppObjectController {
+ *   handleUserInput(input: UserInput) {
+ *     // Process user input to control player object
+ *   }
+ * }
+ * ```
+ */
 export class AppObjectController extends AppObjectComponent {
     constructor() {
         super(...arguments);
+        /**
+         * The component type identifier used to categorize this component as a controller
+         * This property helps the component system identify and manage controller components.
+         * @readonly
+         */
         this.componentType = AppObjectComponentType.CONTROLLER;
     }
 }

package/dist/esm/AppObject/AppObjectController.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppObjectController.js","sourceRoot":"","sources":["../../../src/AppObject/AppObjectController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,OAAO,mBAAoB,SAAQ,kBAAkB;IAA3D;;QACW,kBAAa,GAAG,sBAAsB,CAAC,UAAU,CAAC;IAC7D,CAAC;CAAA","sourcesContent":["import {\r\n  AppObjectComponent,\r\n  AppObjectComponentType,\r\n} from \"./AppObjectComponent\";\r\n\r\nexport class AppObjectController extends AppObjectComponent {\r\n  readonly componentType = AppObjectComponentType.CONTROLLER;\r\n}\r\n"]}
+{"version":3,"file":"AppObjectController.js","sourceRoot":"","sources":["../../../src/AppObject/AppObjectController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,sBAAsB,CAAC;AAE9B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,mBAAoB,SAAQ,kBAAkB;IAA3D;;QACE;;;;WAIG;QACM,kBAAa,GAAG,sBAAsB,CAAC,UAAU,CAAC;IAC7D,CAAC;CAAA","sourcesContent":["import {\r\n  AppObjectComponent,\r\n  AppObjectComponentType,\r\n} from \"./AppObjectComponent\";\r\n\r\n/**\r\n * AppObjectController serves as a base controller class within the application framework.\r\n *\r\n * Controllers are components that handle logic-related operations for an AppObject,\r\n * such as user input processing, state management, or business logic implementation.\r\n * Extend this class to create specialized controllers for specific application features.\r\n *\r\n * @extends AppObjectComponent\r\n * @example\r\n * ```typescript\r\n * class PlayerController extends AppObjectController {\r\n *   handleUserInput(input: UserInput) {\r\n *     // Process user input to control player object\r\n *   }\r\n * }\r\n * ```\r\n */\r\nexport class AppObjectController extends AppObjectComponent {\r\n  /**\r\n   * The component type identifier used to categorize this component as a controller\r\n   * This property helps the component system identify and manage controller components.\r\n   * @readonly\r\n   */\r\n  readonly componentType = AppObjectComponentType.CONTROLLER;\r\n}\r\n"]}

package/dist/esm/AppObject/AppObjectEntity.js

@@ -1,6 +1,27 @@
 import { ObserverList } from "../Entities";
 import { AppObjectComponent, AppObjectComponentType } from "./AppObjectComponent";
+/**
+ * Entity component that manages application state
+ *
+ * AppObjectEntity is responsible for storing and managing state data within the application.
+ * It uses the observer pattern to notify interested parties of changes to its state.
+ *
+ * In a typical application flow:
+ * 1. Controllers modify entity state in response to user actions
+ * 2. Entities notify observers (typically PMs) of state changes
+ * 3. PMs transform entity state into view models
+ * 4. Views render based on the view models
+ */
 export class AppObjectEntity extends AppObjectComponent {
+    /**
+     * Cleans up resources and notifies dispose observers
+     *
+     * This method:
+     * 1. Removes the change observer from the parent AppObject
+     * 2. Notifies all dispose observers
+     * 3. Clears all observer lists
+     * 4. Calls the parent class dispose method
+     */
     dispose() {
         this.removeChangeObserver(this.appObject.notify);
         this.onDisposeObserverList.notify();
@@ -8,26 +29,57 @@ export class AppObjectEntity extends AppObjectComponent {
         this.onDisposeObserverList.clear();
         super.dispose();
     }
+    /**
+     * Creates a new entity component and attaches it to the specified AppObject
+     * Automatically adds the AppObject's notify method as a change observer
+     *
+     * @param appObject The parent AppObject this component will be attached to
+     * @param type The unique type identifier for this component
+     */
     constructor(appObject, type) {
         super(appObject, type);
+        /** Identifies this as an Entity component */
         this.componentType = AppObjectComponentType.ENTITY;
+        /** List of observers to notify when this entity is disposed */
         this.onDisposeObserverList = new ObserverList();
+        /**
+         * Adds an observer to be notified when this entity is disposed
+         * @param observer Function to call on disposal
+         */
         this.addOnDisposeObserver = (observer) => {
             this.onDisposeObserverList.add(observer);
         };
+        /**
+         * Removes a previously added dispose observer
+         * @param observer The observer function to remove
+         */
         this.removeOnDisposeObserver = (observer) => {
             this.onDisposeObserverList.remove(observer);
         };
+        /** List of observers to notify when this entity's state changes */
         this.onChangeObserverList = new ObserverList();
+        /**
+         * Adds an observer to be notified when this entity's state changes
+         * @param observer Function to call on state change
+         */
         this.addChangeObserver = (observer) => {
             this.onChangeObserverList.add(observer);
         };
+        /**
+         * Removes a previously added change observer
+         * @param observer The observer function to remove
+         */
         this.removeChangeObserver = (observer) => {
             this.onChangeObserverList.remove(observer);
         };
+        /**
+         * Notifies all change observers that this entity's state has changed
+         * This should be called by derived classes when their state changes
+         */
         this.notifyOnChange = () => {
             this.onChangeObserverList.notify();
         };
+        // When this entity changes, notify the parent AppObject
         this.addChangeObserver(appObject.notify);
     }
 }

package/dist/esm/AppObject/AppObjectEntity.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppObjectEntity.js","sourceRoot":"","sources":["../../../src/AppObject/AppObjectEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAIlF,MAAM,OAAO,eAAgB,SAAQ,kBAAkB;IAuBrD,OAAO;QACL,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAEjD,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,CAAC;QACpC,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;QAClC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QAEnC,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;IAED,YAAY,SAAoB,EAAE,IAAY;QAC5C,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;QAjCf,kBAAa,GAAG,sBAAsB,CAAC,MAAM,CAAC;QAE/C,0BAAqB,GAAG,IAAI,YAAY,EAAQ,CAAC;QACzD,yBAAoB,GAAG,CAAC,QAAiC,EAAE,EAAE;YAC3D,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC,CAAC;QACF,4BAAuB,GAAG,CAAC,QAAiC,EAAQ,EAAE;YACpE,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC,CAAC;QAEM,yBAAoB,GAAG,IAAI,YAAY,EAAQ,CAAC;QACxD,sBAAiB,GAAG,CAAC,QAAiC,EAAQ,EAAE;YAC9D,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF,yBAAoB,GAAG,CAAC,QAAiC,EAAQ,EAAE;YACjE,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF,mBAAc,GAAG,GAAG,EAAE;YACpB,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC;QACrC,CAAC,CAAC;QAeA,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;CACF","sourcesContent":["import { ObserverList } from \"../Entities\";\r\nimport { AppObject } from \"./AppObject\";\r\nimport { AppObjectComponent, AppObjectComponentType } from \"./AppObjectComponent\";\r\n\r\nexport type AppObjectEntityObserver = () => void;\r\n\r\nexport class AppObjectEntity extends AppObjectComponent {\r\n  readonly componentType = AppObjectComponentType.ENTITY;\r\n  \r\n  private onDisposeObserverList = new ObserverList<void>();\r\n  addOnDisposeObserver = (observer: AppObjectEntityObserver) => {\r\n    this.onDisposeObserverList.add(observer);\r\n  };\r\n  removeOnDisposeObserver = (observer: AppObjectEntityObserver): void => {\r\n    this.onDisposeObserverList.remove(observer);\r\n  };\r\n\r\n  private onChangeObserverList = new ObserverList<void>();\r\n  addChangeObserver = (observer: AppObjectEntityObserver): void => {\r\n    this.onChangeObserverList.add(observer);\r\n  };\r\n  removeChangeObserver = (observer: AppObjectEntityObserver): void => {\r\n    this.onChangeObserverList.remove(observer);\r\n  };\r\n\r\n  notifyOnChange = () => {\r\n    this.onChangeObserverList.notify();\r\n  };\r\n\r\n  dispose() {\r\n    this.removeChangeObserver(this.appObject.notify);\r\n\r\n    this.onDisposeObserverList.notify();\r\n    this.onChangeObserverList.clear();\r\n    this.onDisposeObserverList.clear();\r\n\r\n    super.dispose();\r\n  }\r\n\r\n  constructor(appObject: AppObject, type: string) {\r\n    super(appObject, type)\r\n    \r\n    this.addChangeObserver(appObject.notify);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"AppObjectEntity.js","sourceRoot":"","sources":["../../../src/AppObject/AppObjectEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAQlF;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,eAAgB,SAAQ,kBAAkB;IAkDrD;;;;;;;;OAQG;IACH,OAAO;QACL,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAEjD,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,CAAC;QACpC,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;QAClC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QAEnC,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,YAAY,SAAoB,EAAE,IAAY;QAC5C,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;QA5ExB,6CAA6C;QACpC,kBAAa,GAAG,sBAAsB,CAAC,MAAM,CAAC;QAEvD,+DAA+D;QACvD,0BAAqB,GAAG,IAAI,YAAY,EAAQ,CAAC;QAEzD;;;WAGG;QACH,yBAAoB,GAAG,CAAC,QAAiC,EAAE,EAAE;YAC3D,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC,CAAC;QAEF;;;WAGG;QACH,4BAAuB,GAAG,CAAC,QAAiC,EAAQ,EAAE;YACpE,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC,CAAC;QAEF,mEAAmE;QAC3D,yBAAoB,GAAG,IAAI,YAAY,EAAQ,CAAC;QAExD;;;WAGG;QACH,sBAAiB,GAAG,CAAC,QAAiC,EAAQ,EAAE;YAC9D,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,CAAC,CAAC;QAEF;;;WAGG;QACH,yBAAoB,GAAG,CAAC,QAAiC,EAAQ,EAAE;YACjE,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF;;;WAGG;QACH,mBAAc,GAAG,GAAG,EAAE;YACpB,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC;QACrC,CAAC,CAAC;QA+BA,wDAAwD;QACxD,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;CACF","sourcesContent":["import { ObserverList } from \"../Entities\";\r\nimport { AppObject } from \"./AppObject\";\r\nimport { AppObjectComponent, AppObjectComponentType } from \"./AppObjectComponent\";\r\n\r\n/**\r\n * Observer function type for entity state changes or disposal\r\n * No parameters are passed to the observer functions\r\n */\r\nexport type AppObjectEntityObserver = () => void;\r\n\r\n/**\r\n * Entity component that manages application state\r\n * \r\n * AppObjectEntity is responsible for storing and managing state data within the application.\r\n * It uses the observer pattern to notify interested parties of changes to its state.\r\n * \r\n * In a typical application flow:\r\n * 1. Controllers modify entity state in response to user actions\r\n * 2. Entities notify observers (typically PMs) of state changes\r\n * 3. PMs transform entity state into view models\r\n * 4. Views render based on the view models\r\n */\r\nexport class AppObjectEntity extends AppObjectComponent {\r\n  /** Identifies this as an Entity component */\r\n  readonly componentType = AppObjectComponentType.ENTITY;\r\n  \r\n  /** List of observers to notify when this entity is disposed */\r\n  private onDisposeObserverList = new ObserverList<void>();\r\n  \r\n  /**\r\n   * Adds an observer to be notified when this entity is disposed\r\n   * @param observer Function to call on disposal\r\n   */\r\n  addOnDisposeObserver = (observer: AppObjectEntityObserver) => {\r\n    this.onDisposeObserverList.add(observer);\r\n  };\r\n  \r\n  /**\r\n   * Removes a previously added dispose observer\r\n   * @param observer The observer function to remove\r\n   */\r\n  removeOnDisposeObserver = (observer: AppObjectEntityObserver): void => {\r\n    this.onDisposeObserverList.remove(observer);\r\n  };\r\n\r\n  /** List of observers to notify when this entity's state changes */\r\n  private onChangeObserverList = new ObserverList<void>();\r\n  \r\n  /**\r\n   * Adds an observer to be notified when this entity's state changes\r\n   * @param observer Function to call on state change\r\n   */\r\n  addChangeObserver = (observer: AppObjectEntityObserver): void => {\r\n    this.onChangeObserverList.add(observer);\r\n  };\r\n  \r\n  /**\r\n   * Removes a previously added change observer\r\n   * @param observer The observer function to remove\r\n   */\r\n  removeChangeObserver = (observer: AppObjectEntityObserver): void => {\r\n    this.onChangeObserverList.remove(observer);\r\n  };\r\n\r\n  /**\r\n   * Notifies all change observers that this entity's state has changed\r\n   * This should be called by derived classes when their state changes\r\n   */\r\n  notifyOnChange = () => {\r\n    this.onChangeObserverList.notify();\r\n  };\r\n\r\n  /**\r\n   * Cleans up resources and notifies dispose observers\r\n   * \r\n   * This method:\r\n   * 1. Removes the change observer from the parent AppObject\r\n   * 2. Notifies all dispose observers\r\n   * 3. Clears all observer lists\r\n   * 4. Calls the parent class dispose method\r\n   */\r\n  dispose() {\r\n    this.removeChangeObserver(this.appObject.notify);\r\n\r\n    this.onDisposeObserverList.notify();\r\n    this.onChangeObserverList.clear();\r\n    this.onDisposeObserverList.clear();\r\n\r\n    super.dispose();\r\n  }\r\n\r\n  /**\r\n   * Creates a new entity component and attaches it to the specified AppObject\r\n   * Automatically adds the AppObject's notify method as a change observer\r\n   * \r\n   * @param appObject The parent AppObject this component will be attached to\r\n   * @param type The unique type identifier for this component\r\n   */\r\n  constructor(appObject: AppObject, type: string) {\r\n    super(appObject, type)\r\n    \r\n    // When this entity changes, notify the parent AppObject\r\n    this.addChangeObserver(appObject.notify);\r\n  }\r\n}\r\n"]}