@vived/core 1.4.2 → 1.4.3

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"]}

package/dist/esm/AppObject/AppObjectEntityRepo.js

@@ -1,26 +1,82 @@
 import { ObserverList } from "../Entities";
 import { AppObjectEntity } from "./AppObjectEntity";
+/**
+ * A repository for managing collections of AppObjectEntity instances.
+ *
+ * This generic class provides a centralized way to store, retrieve, and manage
+ * entities that are associated with specific AppObjects. It implements the observer
+ * pattern to notify listeners when entities are added or removed.
+ *
+ * @template T - The type of entities managed by this repository, must extend AppObjectEntity
+ * @extends AppObjectEntity
+ *
+ * @example
+ * ```typescript
+ * // Create a repository for player entities
+ * const playerRepo = new AppObjectEntityRepo<PlayerEntity>();
+ *
+ * // Add a new player
+ * const player = new PlayerEntity(appObject);
+ * playerRepo.add(player);
+ *
+ * // Get a player by its AppObject ID
+ * const retrievedPlayer = playerRepo.getForAppObject("player1");
+ * ```
+ */
 export class AppObjectEntityRepo extends AppObjectEntity {
     constructor() {
         super(...arguments);
         this.entityLookup = new Map();
         this.onEntityAddedObservers = new ObserverList();
+        /**
+         * Registers an observer to be notified when an entity is added to the repository.
+         *
+         * @param {(addedEntity: T) => void} observer - The callback function to invoke when an entity is added
+         */
         this.addEntityAddedObserver = (observer) => {
             this.onEntityAddedObservers.add(observer);
         };
+        /**
+         * Removes an observer previously registered for entity addition notifications.
+         *
+         * @param {(addedEntity: T) => void} observer - The callback function to remove
+         */
         this.removeEntityAddedObserver = (observer) => {
             this.onEntityAddedObservers.remove(observer);
         };
         this.onEntityRemovedObservers = new ObserverList();
+        /**
+         * Registers an observer to be notified when an entity is removed from the repository.
+         *
+         * @param {(removedEntity: T) => void} observer - The callback function to invoke when an entity is removed
+         */
         this.addEntityRemovedObserver = (observer) => {
             this.onEntityRemovedObservers.add(observer);
         };
+        /**
+         * Removes an observer previously registered for entity removal notifications.
+         *
+         * @param {(removedEntity: T) => void} observer - The callback function to remove
+         */
         this.removeEntityRemovedObserver = (observer) => {
             this.onEntityRemovedObservers.remove(observer);
         };
+        /**
+         * Checks if an entity exists for the given AppObject ID.
+         *
+         * @param {string} appObjectID - The ID of the AppObject
+         * @returns {boolean} True if an entity exists for the given AppObject ID, false otherwise
+         */
         this.hasForAppObject = (appObjectID) => {
             return this.entityLookup.has(appObjectID);
         };
+        /**
+         * Removes the entity associated with the specified AppObject ID.
+         *
+         * Notifies all registered observers after the entity is removed.
+         *
+         * @param {string} id - The ID of the AppObject whose entity should be removed
+         */
         this.removeForAppObject = (id) => {
             const existing = this.entityLookup.get(id);
             if (!existing)
@@ -30,13 +86,32 @@ export class AppObjectEntityRepo extends AppObjectEntity {
             this.notifyOnChange();
             this.onEntityRemovedObservers.notify(existing);
         };
+        /**
+         * Gets the entity associated with the specified AppObject ID.
+         *
+         * @param {string} appObjectID - The ID of the AppObject
+         * @returns {T | undefined} The entity if found, undefined otherwise
+         */
         this.getForAppObject = (appObjectID) => {
             return this.entityLookup.get(appObjectID);
         };
+        /**
+         * Gets all entities in the repository.
+         *
+         * @returns {T[]} An array of all entities
+         */
         this.getAll = () => {
             return Array.from(this.entityLookup.values());
         };
     }
+    /**
+     * Adds an entity to the repository.
+     *
+     * If an entity with the same AppObject ID already exists, it is replaced.
+     * Notifies all registered observers after the entity is added.
+     *
+     * @param {T} entity - The entity to add
+     */
     add(entity) {
         const existing = this.entityLookup.get(entity.appObject.id);
         if (existing) {
@@ -47,6 +122,5 @@ export class AppObjectEntityRepo extends AppObjectEntity {
         this.notifyOnChange();
         this.onEntityAddedObservers.notify(entity);
     }
-    ;
 }
 //# sourceMappingURL=AppObjectEntityRepo.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"AppObjectEntityRepo.js","sourceRoot":"","sources":["../../../src/AppObject/AppObjectEntityRepo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,MAAM,OAAO,mBAEX,SAAQ,eAAe;IAFzB;;QAIU,iBAAY,GAAG,IAAI,GAAG,EAAa,CAAC;QAEpC,2BAAsB,GAAG,IAAI,YAAY,EAAK,CAAC;QACvD,2BAAsB,GAAG,CAAC,QAAkC,EAAE,EAAE;YAC9D,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC,CAAC;QACF,8BAAyB,GAAG,CAAC,QAAkC,EAAQ,EAAE;YACvE,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC/C,CAAC,CAAC;QAEM,6BAAwB,GAAG,IAAI,YAAY,EAAK,CAAC;QACzD,6BAAwB,GAAG,CAAC,QAAoC,EAAE,EAAE;YAClE,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC,CAAC;QACF,gCAA2B,GAAG,CAC5B,QAAoC,EAC9B,EAAE;YACR,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF,oBAAe,GAAG,CAAC,WAAmB,EAAW,EAAE;YACjD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC5C,CAAC,CAAC;QAcF,uBAAkB,GAAG,CAAC,EAAU,EAAE,EAAE;YAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC3C,IAAI,CAAC,QAAQ;gBAAE,OAAO;YAEtB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC7B,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACnD,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF,oBAAe,GAAG,CAAC,WAAmB,EAAiB,EAAE;YACvD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC5C,CAAC,CAAC;QAEF,WAAM,GAAG,GAAQ,EAAE;YACjB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAChD,CAAC,CAAC;IACJ,CAAC;IA7BC,GAAG,CAAC,MAAS;QACX,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC5D,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACrD,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9C,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAAA,CAAC;CAmBH","sourcesContent":["import { ObserverList } from \"../Entities\";\r\nimport { AppObjectEntity } from \"./AppObjectEntity\";\r\n\r\nexport class AppObjectEntityRepo<\r\n  T extends AppObjectEntity\r\n> extends AppObjectEntity {\r\n\r\n  private entityLookup = new Map<string, T>();\r\n\r\n  private onEntityAddedObservers = new ObserverList<T>();\r\n  addEntityAddedObserver = (observer: (addedEntity: T) => void) => {\r\n    this.onEntityAddedObservers.add(observer);\r\n  };\r\n  removeEntityAddedObserver = (observer: (addedEntity: T) => void): void => {\r\n    this.onEntityAddedObservers.remove(observer);\r\n  };\r\n\r\n  private onEntityRemovedObservers = new ObserverList<T>();\r\n  addEntityRemovedObserver = (observer: (removedEntity: T) => void) => {\r\n    this.onEntityRemovedObservers.add(observer);\r\n  };\r\n  removeEntityRemovedObserver = (\r\n    observer: (removedEntity: T) => void\r\n  ): void => {\r\n    this.onEntityRemovedObservers.remove(observer);\r\n  };\r\n\r\n  hasForAppObject = (appObjectID: string): boolean => {\r\n    return this.entityLookup.has(appObjectID);\r\n  };\r\n\r\n  add(entity: T) {\r\n    const existing = this.entityLookup.get(entity.appObject.id);\r\n    if (existing) {\r\n      existing.removeChangeObserver(this.notifyOnChange);\r\n    }\r\n\r\n    this.entityLookup.set(entity.appObject.id, entity);\r\n    entity.addChangeObserver(this.notifyOnChange);\r\n    this.notifyOnChange();\r\n    this.onEntityAddedObservers.notify(entity);\r\n  };\r\n\r\n  removeForAppObject = (id: string) => {\r\n    const existing = this.entityLookup.get(id);\r\n    if (!existing) return;\r\n\r\n    this.entityLookup.delete(id);\r\n    existing.removeChangeObserver(this.notifyOnChange);\r\n    this.notifyOnChange();\r\n    this.onEntityRemovedObservers.notify(existing);\r\n  };\r\n\r\n  getForAppObject = (appObjectID: string): T | undefined => {\r\n    return this.entityLookup.get(appObjectID);\r\n  };\r\n\r\n  getAll = (): T[] => {\r\n    return Array.from(this.entityLookup.values());\r\n  };\r\n}\r\n"]}
+{"version":3,"file":"AppObjectEntityRepo.js","sourceRoot":"","sources":["../../../src/AppObject/AppObjectEntityRepo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,mBAEX,SAAQ,eAAe;IAFzB;;QAGU,iBAAY,GAAG,IAAI,GAAG,EAAa,CAAC;QAEpC,2BAAsB,GAAG,IAAI,YAAY,EAAK,CAAC;QACvD;;;;WAIG;QACH,2BAAsB,GAAG,CAAC,QAAkC,EAAE,EAAE;YAC9D,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC,CAAC;QAEF;;;;WAIG;QACH,8BAAyB,GAAG,CAAC,QAAkC,EAAQ,EAAE;YACvE,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC/C,CAAC,CAAC;QAEM,6BAAwB,GAAG,IAAI,YAAY,EAAK,CAAC;QACzD;;;;WAIG;QACH,6BAAwB,GAAG,CAAC,QAAoC,EAAE,EAAE;YAClE,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC,CAAC;QAEF;;;;WAIG;QACH,gCAA2B,GAAG,CAC5B,QAAoC,EAC9B,EAAE;YACR,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF;;;;;WAKG;QACH,oBAAe,GAAG,CAAC,WAAmB,EAAW,EAAE;YACjD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC5C,CAAC,CAAC;QAsBF;;;;;;WAMG;QACH,uBAAkB,GAAG,CAAC,EAAU,EAAE,EAAE;YAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC3C,IAAI,CAAC,QAAQ;gBAAE,OAAO;YAEtB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC7B,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACnD,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF;;;;;WAKG;QACH,oBAAe,GAAG,CAAC,WAAmB,EAAiB,EAAE;YACvD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC5C,CAAC,CAAC;QAEF;;;;WAIG;QACH,WAAM,GAAG,GAAQ,EAAE;YACjB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAChD,CAAC,CAAC;IACJ,CAAC;IAvDC;;;;;;;OAOG;IACH,GAAG,CAAC,MAAS;QACX,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC5D,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACrD,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9C,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;CAqCF","sourcesContent":["import { ObserverList } from \"../Entities\";\r\nimport { AppObjectEntity } from \"./AppObjectEntity\";\r\n\r\n/**\r\n * A repository for managing collections of AppObjectEntity instances.\r\n *\r\n * This generic class provides a centralized way to store, retrieve, and manage\r\n * entities that are associated with specific AppObjects. It implements the observer\r\n * pattern to notify listeners when entities are added or removed.\r\n *\r\n * @template T - The type of entities managed by this repository, must extend AppObjectEntity\r\n * @extends AppObjectEntity\r\n *\r\n * @example\r\n * ```typescript\r\n * // Create a repository for player entities\r\n * const playerRepo = new AppObjectEntityRepo<PlayerEntity>();\r\n *\r\n * // Add a new player\r\n * const player = new PlayerEntity(appObject);\r\n * playerRepo.add(player);\r\n *\r\n * // Get a player by its AppObject ID\r\n * const retrievedPlayer = playerRepo.getForAppObject(\"player1\");\r\n * ```\r\n */\r\nexport class AppObjectEntityRepo<\r\n  T extends AppObjectEntity,\r\n> extends AppObjectEntity {\r\n  private entityLookup = new Map<string, T>();\r\n\r\n  private onEntityAddedObservers = new ObserverList<T>();\r\n  /**\r\n   * Registers an observer to be notified when an entity is added to the repository.\r\n   *\r\n   * @param {(addedEntity: T) => void} observer - The callback function to invoke when an entity is added\r\n   */\r\n  addEntityAddedObserver = (observer: (addedEntity: T) => void) => {\r\n    this.onEntityAddedObservers.add(observer);\r\n  };\r\n\r\n  /**\r\n   * Removes an observer previously registered for entity addition notifications.\r\n   *\r\n   * @param {(addedEntity: T) => void} observer - The callback function to remove\r\n   */\r\n  removeEntityAddedObserver = (observer: (addedEntity: T) => void): void => {\r\n    this.onEntityAddedObservers.remove(observer);\r\n  };\r\n\r\n  private onEntityRemovedObservers = new ObserverList<T>();\r\n  /**\r\n   * Registers an observer to be notified when an entity is removed from the repository.\r\n   *\r\n   * @param {(removedEntity: T) => void} observer - The callback function to invoke when an entity is removed\r\n   */\r\n  addEntityRemovedObserver = (observer: (removedEntity: T) => void) => {\r\n    this.onEntityRemovedObservers.add(observer);\r\n  };\r\n\r\n  /**\r\n   * Removes an observer previously registered for entity removal notifications.\r\n   *\r\n   * @param {(removedEntity: T) => void} observer - The callback function to remove\r\n   */\r\n  removeEntityRemovedObserver = (\r\n    observer: (removedEntity: T) => void\r\n  ): void => {\r\n    this.onEntityRemovedObservers.remove(observer);\r\n  };\r\n\r\n  /**\r\n   * Checks if an entity exists for the given AppObject ID.\r\n   *\r\n   * @param {string} appObjectID - The ID of the AppObject\r\n   * @returns {boolean} True if an entity exists for the given AppObject ID, false otherwise\r\n   */\r\n  hasForAppObject = (appObjectID: string): boolean => {\r\n    return this.entityLookup.has(appObjectID);\r\n  };\r\n\r\n  /**\r\n   * Adds an entity to the repository.\r\n   *\r\n   * If an entity with the same AppObject ID already exists, it is replaced.\r\n   * Notifies all registered observers after the entity is added.\r\n   *\r\n   * @param {T} entity - The entity to add\r\n   */\r\n  add(entity: T) {\r\n    const existing = this.entityLookup.get(entity.appObject.id);\r\n    if (existing) {\r\n      existing.removeChangeObserver(this.notifyOnChange);\r\n    }\r\n\r\n    this.entityLookup.set(entity.appObject.id, entity);\r\n    entity.addChangeObserver(this.notifyOnChange);\r\n    this.notifyOnChange();\r\n    this.onEntityAddedObservers.notify(entity);\r\n  }\r\n\r\n  /**\r\n   * Removes the entity associated with the specified AppObject ID.\r\n   *\r\n   * Notifies all registered observers after the entity is removed.\r\n   *\r\n   * @param {string} id - The ID of the AppObject whose entity should be removed\r\n   */\r\n  removeForAppObject = (id: string) => {\r\n    const existing = this.entityLookup.get(id);\r\n    if (!existing) return;\r\n\r\n    this.entityLookup.delete(id);\r\n    existing.removeChangeObserver(this.notifyOnChange);\r\n    this.notifyOnChange();\r\n    this.onEntityRemovedObservers.notify(existing);\r\n  };\r\n\r\n  /**\r\n   * Gets the entity associated with the specified AppObject ID.\r\n   *\r\n   * @param {string} appObjectID - The ID of the AppObject\r\n   * @returns {T | undefined} The entity if found, undefined otherwise\r\n   */\r\n  getForAppObject = (appObjectID: string): T | undefined => {\r\n    return this.entityLookup.get(appObjectID);\r\n  };\r\n\r\n  /**\r\n   * Gets all entities in the repository.\r\n   *\r\n   * @returns {T[]} An array of all entities\r\n   */\r\n  getAll = (): T[] => {\r\n    return Array.from(this.entityLookup.values());\r\n  };\r\n}\r\n"]}

package/dist/esm/AppObject/AppObjectPM.js

@@ -1,30 +1,76 @@
 import { ObserverList } from "../Entities";
 import { AppObjectComponent, AppObjectComponentType } from "./AppObjectComponent";
+/**
+ * Presentation Manager (PM) component that transforms application state into view models
+ *
+ * AppObjectPM acts as a mediator between application state (entities) and views.
+ * It transforms raw application data into a format that's optimized for presentation,
+ * implementing the presentation model or MVVM pattern.
+ *
+ * A PM typically:
+ * 1. Observes entity changes
+ * 2. Transforms entity data into view models
+ * 3. Notifies attached views when view models change
+ * 4. Handles view model caching and optimization
+ *
+ * @typeparam T The view model type this PM produces
+ */
 export class AppObjectPM extends AppObjectComponent {
     constructor() {
         super(...arguments);
+        /** Identifies this as a Presentation Manager component */
         this.componentType = AppObjectComponentType.PM;
+        /** List of view update functions to notify when the view model changes */
         this.observerList = new ObserverList();
     }
+    /**
+     * Gets the most recently generated view model
+     * @returns The last view model or undefined if none has been generated
+     */
     get lastVM() {
         return this._lastVM;
     }
+    /**
+     * Registers a view update function to be called when the view model changes
+     * If a view model already exists, the provided function is called immediately with that model
+     *
+     * @param updateView Function to call with updated view models
+     */
     addView(updateView) {
         this.observerList.add(updateView);
+        // Immediately update the view with current view model if one exists
         if (this._lastVM !== undefined) {
             updateView(this._lastVM);
         }
     }
+    /**
+     * Unregisters a previously added view update function
+     *
+     * @param updateView The view update function to remove
+     */
     removeView(updateView) {
         this.observerList.remove(updateView);
     }
+    /**
+     * Updates the view model and notifies all registered views if the model has changed
+     * This method should be called by derived classes when the view model needs to be updated
+     *
+     * The method performs equality checking to prevent unnecessary updates when
+     * the new view model is equivalent to the previous one
+     *
+     * @param vm The new view model
+     */
     doUpdateView(vm) {
+        // Skip update if the view model hasn't changed
         if (this._lastVM && this.vmsAreEqual(this._lastVM, vm)) {
             return;
         }
         this._lastVM = vm;
         this.observerList.notify(vm);
     }
+    /**
+     * Cleans up resources and detaches this PM from its parent AppObject
+     */
     dispose() {
         this.observerList.clear();
         if (this.appObject.getComponent(this.type) === this) {

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

@@ -1 +1 @@
-{"version":3,"file":"AppObjectPM.js","sourceRoot":"","sources":["../../../src/AppObject/AppObjectPM.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAElF,MAAM,OAAgB,WAAe,SAAQ,kBAAkB;IAA/D;;QACW,kBAAa,GAAG,sBAAsB,CAAC,EAAE,CAAC;QAQ3C,iBAAY,GAAG,IAAI,YAAY,EAAK,CAAC;IA8B/C,CAAC;IAlCC,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAID,OAAO,CAAC,UAA2B;QACjC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAElC,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,UAAU,CAAC,UAA2B;QACpC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC;IAED,YAAY,CAAC,EAAK;QAChB,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC;YACvD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO;QACL,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1B,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;QACD,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF","sourcesContent":["import { ObserverList } from \"../Entities\";\r\nimport { AppObjectComponent, AppObjectComponentType } from \"./AppObjectComponent\";\r\n\r\nexport abstract class AppObjectPM<T> extends AppObjectComponent {\r\n  readonly componentType = AppObjectComponentType.PM;\r\n  abstract vmsAreEqual(a: T, b: T): boolean;\r\n\r\n  private _lastVM?: T;\r\n  get lastVM(): T | undefined {\r\n    return this._lastVM;\r\n  }\r\n\r\n  private observerList = new ObserverList<T>();\r\n\r\n  addView(updateView: (vm: T) => void): void {\r\n    this.observerList.add(updateView);\r\n\r\n    if (this._lastVM !== undefined) {\r\n      updateView(this._lastVM);\r\n    }\r\n  }\r\n\r\n  removeView(updateView: (vm: T) => void): void {\r\n    this.observerList.remove(updateView);\r\n  }\r\n\r\n  doUpdateView(vm: T) {\r\n    if (this._lastVM && this.vmsAreEqual(this._lastVM, vm)) {\r\n      return;\r\n    }\r\n\r\n    this._lastVM = vm;\r\n    this.observerList.notify(vm);\r\n  }\r\n\r\n  dispose() {\r\n    this.observerList.clear();\r\n    if (this.appObject.getComponent(this.type) === this) {\r\n      this.appObject.removeComponent(this.type);\r\n    }\r\n    super.dispose();\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"AppObjectPM.js","sourceRoot":"","sources":["../../../src/AppObject/AppObjectPM.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAElF;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAgB,WAAe,SAAQ,kBAAkB;IAA/D;;QACE,0DAA0D;QACjD,kBAAa,GAAG,sBAAsB,CAAC,EAAE,CAAC;QAuBnD,0EAA0E;QAClE,iBAAY,GAAG,IAAI,YAAY,EAAK,CAAC;IAuD/C,CAAC;IAhEC;;;OAGG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAKD;;;;;OAKG;IACH,OAAO,CAAC,UAA2B;QACjC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAElC,oEAAoE;QACpE,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,UAA2B;QACpC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAK;QAChB,+CAA+C;QAC/C,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC;YACvD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1B,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;QACD,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF","sourcesContent":["import { ObserverList } from \"../Entities\";\r\nimport { AppObjectComponent, AppObjectComponentType } from \"./AppObjectComponent\";\r\n\r\n/**\r\n * Presentation Manager (PM) component that transforms application state into view models\r\n * \r\n * AppObjectPM acts as a mediator between application state (entities) and views.\r\n * It transforms raw application data into a format that's optimized for presentation,\r\n * implementing the presentation model or MVVM pattern.\r\n * \r\n * A PM typically:\r\n * 1. Observes entity changes\r\n * 2. Transforms entity data into view models\r\n * 3. Notifies attached views when view models change\r\n * 4. Handles view model caching and optimization\r\n * \r\n * @typeparam T The view model type this PM produces\r\n */\r\nexport abstract class AppObjectPM<T> extends AppObjectComponent {\r\n  /** Identifies this as a Presentation Manager component */\r\n  readonly componentType = AppObjectComponentType.PM;\r\n  \r\n  /**\r\n   * Compares two view models to determine if they're equivalent\r\n   * Used to prevent unnecessary view updates when the view model hasn't changed\r\n   * \r\n   * @param a First view model to compare\r\n   * @param b Second view model to compare\r\n   * @returns True if the view models are considered equal, false otherwise\r\n   */\r\n  abstract vmsAreEqual(a: T, b: T): boolean;\r\n\r\n  /** The most recently generated view model */\r\n  private _lastVM?: T;\r\n  \r\n  /**\r\n   * Gets the most recently generated view model\r\n   * @returns The last view model or undefined if none has been generated\r\n   */\r\n  get lastVM(): T | undefined {\r\n    return this._lastVM;\r\n  }\r\n\r\n  /** List of view update functions to notify when the view model changes */\r\n  private observerList = new ObserverList<T>();\r\n\r\n  /**\r\n   * Registers a view update function to be called when the view model changes\r\n   * If a view model already exists, the provided function is called immediately with that model\r\n   * \r\n   * @param updateView Function to call with updated view models\r\n   */\r\n  addView(updateView: (vm: T) => void): void {\r\n    this.observerList.add(updateView);\r\n\r\n    // Immediately update the view with current view model if one exists\r\n    if (this._lastVM !== undefined) {\r\n      updateView(this._lastVM);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Unregisters a previously added view update function\r\n   * \r\n   * @param updateView The view update function to remove\r\n   */\r\n  removeView(updateView: (vm: T) => void): void {\r\n    this.observerList.remove(updateView);\r\n  }\r\n\r\n  /**\r\n   * Updates the view model and notifies all registered views if the model has changed\r\n   * This method should be called by derived classes when the view model needs to be updated\r\n   * \r\n   * The method performs equality checking to prevent unnecessary updates when\r\n   * the new view model is equivalent to the previous one\r\n   * \r\n   * @param vm The new view model\r\n   */\r\n  doUpdateView(vm: T) {\r\n    // Skip update if the view model hasn't changed\r\n    if (this._lastVM && this.vmsAreEqual(this._lastVM, vm)) {\r\n      return;\r\n    }\r\n\r\n    this._lastVM = vm;\r\n    this.observerList.notify(vm);\r\n  }\r\n\r\n  /**\r\n   * Cleans up resources and detaches this PM from its parent AppObject\r\n   */\r\n  dispose() {\r\n    this.observerList.clear();\r\n    if (this.appObject.getComponent(this.type) === this) {\r\n      this.appObject.removeComponent(this.type);\r\n    }\r\n    super.dispose();\r\n  }\r\n}\r\n"]}

package/dist/esm/AppObject/AppObjectRepo.js

@@ -1,10 +1,30 @@
 import { ObservableEntity, ObserverList } from "../Entities";
 import { makeAppObject } from "./AppObject";
+/**
+ * Abstract repository class for managing AppObjects and their components.
+ *
+ * This class provides the interface for storing, retrieving, and managing application
+ * objects, their components, and singletons. It also includes logging functionality
+ * and observer pattern implementation for tracking changes to the repository.
+ *
+ * @extends ObservableEntity
+ */
 export class AppObjectRepo extends ObservableEntity {
 }
+/**
+ * Creates and returns a new AppObjectRepo instance.
+ *
+ * @returns {AppObjectRepo} A new AppObjectRepo instance
+ */
 export function makeAppObjectRepo() {
     return new AppObjectRepoImp();
 }
+/**
+ * Implementation of the AppObjectRepo abstract class.
+ *
+ * @private
+ * @extends AppObjectRepo
+ */
 class AppObjectRepoImp extends AppObjectRepo {
     constructor() {
         super(...arguments);