@vived/core 1.4.2 → 1.4.4

package/dist/types/AppObject/AppObjectComponent.d.ts

@@ -1,26 +1,106 @@
 import { AppObject } from "./AppObject";
 import { AppObjectRepo } from "./AppObjectRepo";
+/**
+ * Enumeration of the different types of components in the architecture.
+ * Each type serves a specific purpose in the application structure.
+ */
 export declare enum AppObjectComponentType {
+    /** Stores and manages application state */
     ENTITY = "Entity",
+    /** Transforms application state into view models */
     PM = "Presentation Manager",
+    /** Implements business logic and coordinates between layers */
     UC = "Use Case",
+    /** Handles user inputs and external events */
     CONTROLLER = "Controller",
+    /** Renders UI elements and interacts with the DOM/rendering system */
     VIEW = "View",
+    /** Default type for components that don't fit the standard categories */
     UNKNOWN = "Unknown"
 }
+/**
+ * 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 declare class AppObjectComponent {
+    /** The type category of this component */
     readonly componentType: AppObjectComponentType;
+    /** Unique type identifier for this specific component */
     readonly type: string;
+    /** The parent AppObject this component is attached to */
     readonly appObject: AppObject;
+    /**
+     * Convenience accessor for the repository containing all AppObjects
+     * @returns The application's AppObjectRepo
+     */
     get appObjects(): AppObjectRepo;
+    /** Cache for components to avoid repeated lookups */
     private cachedComponents;
+    /**
+     * 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<T extends AppObjectComponent>(type: string): T | undefined;
+    /**
+     * 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<T extends AppObjectComponent>(type: string): T | undefined;
+    /**
+     * 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<T extends AppObjectComponent>(type: string, logType?: "LOG" | "WARN" | "ERROR"): T | undefined;
+    /**
+     * Cleans up resources used by this component
+     * Removes itself from the parent AppObject if it's still attached
+     */
     dispose(): void;
+    /**
+     * 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: string): void;
+    /**
+     * 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: string): void;
+    /**
+     * 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: string): void;
+    /**
+     * 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: AppObject, type: string);
 }
 //# sourceMappingURL=AppObjectComponent.d.ts.map

package/dist/types/AppObject/AppObjectComponent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppObjectComponent.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,oBAAY,sBAAsB;IAChC,MAAM,WAAW;IACjB,EAAE,yBAAyB;IAC3B,EAAE,aAAa;IACf,UAAU,eAAe;IACzB,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED,qBAAa,kBAAkB;IAC7B,QAAQ,CAAC,aAAa,EAAE,sBAAsB,CAAkC;IAChF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,IAAI,UAAU,IAAI,aAAa,CAE9B;IAED,OAAO,CAAC,gBAAgB,CAAyC;IACjE,kBAAkB,CAAC,CAAC,SAAS,kBAAkB,EAC7C,IAAI,EAAE,MAAM,GACX,CAAC,GAAG,SAAS;IAahB,uBAAuB,CAAC,CAAC,SAAS,kBAAkB,EAClD,IAAI,EAAE,MAAM,GACX,CAAC,GAAG,SAAS;IAchB,YAAY,CAAC,CAAC,SAAS,kBAAkB,EACvC,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,KAAK,GAAG,MAAM,GAAG,OAAgB,GACzC,CAAC,GAAG,SAAS;IAqBhB,OAAO;IAMP,GAAG,CAAC,OAAO,EAAE,MAAM;IAInB,IAAI,CAAC,OAAO,EAAE,MAAM;IAIpB,KAAK,CAAC,OAAO,EAAE,MAAM;gBAIT,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM;CAK/C"}
+{"version":3,"file":"AppObjectComponent.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;GAGG;AACH,oBAAY,sBAAsB;IAChC,2CAA2C;IAC3C,MAAM,WAAW;IAEjB,oDAAoD;IACpD,EAAE,yBAAyB;IAE3B,+DAA+D;IAC/D,EAAE,aAAa;IAEf,8CAA8C;IAC9C,UAAU,eAAe;IAEzB,sEAAsE;IACtE,IAAI,SAAS;IAEb,yEAAyE;IACzE,OAAO,YAAY;CACpB;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,kBAAkB;IAC7B,0CAA0C;IAC1C,QAAQ,CAAC,aAAa,EAAE,sBAAsB,CAAkC;IAEhF,yDAAyD;IACzD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,yDAAyD;IACzD,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B;;;OAGG;IACH,IAAI,UAAU,IAAI,aAAa,CAE9B;IAED,qDAAqD;IACrD,OAAO,CAAC,gBAAgB,CAAyC;IAEjE;;;;;;OAMG;IACH,kBAAkB,CAAC,CAAC,SAAS,kBAAkB,EAC7C,IAAI,EAAE,MAAM,GACX,CAAC,GAAG,SAAS;IAahB;;;;;;OAMG;IACH,uBAAuB,CAAC,CAAC,SAAS,kBAAkB,EAClD,IAAI,EAAE,MAAM,GACX,CAAC,GAAG,SAAS;IAchB;;;;;;;OAOG;IACH,YAAY,CAAC,CAAC,SAAS,kBAAkB,EACvC,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,KAAK,GAAG,MAAM,GAAG,OAAgB,GACzC,CAAC,GAAG,SAAS;IAqBhB;;;OAGG;IACH,OAAO;IAMP;;;;;OAKG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM;IAInB;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM;IAIpB;;;;;OAKG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM;IAIrB;;;;;OAKG;gBACS,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM;CAK/C"}

package/dist/types/AppObject/AppObjectController.d.ts

@@ -1,5 +1,27 @@
 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 declare class AppObjectController extends AppObjectComponent {
+    /**
+     * The component type identifier used to categorize this component as a controller
+     * This property helps the component system identify and manage controller components.
+     * @readonly
+     */
     readonly componentType = AppObjectComponentType.CONTROLLER;
 }
 //# sourceMappingURL=AppObjectController.d.ts.map

package/dist/types/AppObject/AppObjectController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppObjectController.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAE9B,qBAAa,mBAAoB,SAAQ,kBAAkB;IACzD,QAAQ,CAAC,aAAa,qCAAqC;CAC5D"}
+{"version":3,"file":"AppObjectController.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAE9B;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,mBAAoB,SAAQ,kBAAkB;IACzD;;;;OAIG;IACH,QAAQ,CAAC,aAAa,qCAAqC;CAC5D"}

package/dist/types/AppObject/AppObjectEntity.d.ts

@@ -1,16 +1,71 @@
 import { AppObject } from "./AppObject";
 import { AppObjectComponent, AppObjectComponentType } from "./AppObjectComponent";
+/**
+ * Observer function type for entity state changes or disposal
+ * No parameters are passed to the observer functions
+ */
 export type AppObjectEntityObserver = () => void;
+/**
+ * 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 declare class AppObjectEntity extends AppObjectComponent {
+    /** Identifies this as an Entity component */
     readonly componentType = AppObjectComponentType.ENTITY;
+    /** List of observers to notify when this entity is disposed */
     private onDisposeObserverList;
+    /**
+     * Adds an observer to be notified when this entity is disposed
+     * @param observer Function to call on disposal
+     */
     addOnDisposeObserver: (observer: AppObjectEntityObserver) => void;
+    /**
+     * Removes a previously added dispose observer
+     * @param observer The observer function to remove
+     */
     removeOnDisposeObserver: (observer: AppObjectEntityObserver) => void;
+    /** List of observers to notify when this entity's state changes */
     private onChangeObserverList;
+    /**
+     * Adds an observer to be notified when this entity's state changes
+     * @param observer Function to call on state change
+     */
     addChangeObserver: (observer: AppObjectEntityObserver) => void;
+    /**
+     * Removes a previously added change observer
+     * @param observer The observer function to remove
+     */
     removeChangeObserver: (observer: AppObjectEntityObserver) => void;
+    /**
+     * Notifies all change observers that this entity's state has changed
+     * This should be called by derived classes when their state changes
+     */
     notifyOnChange: () => void;
+    /**
+     * 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(): void;
+    /**
+     * 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: AppObject, type: string);
 }
 //# sourceMappingURL=AppObjectEntity.d.ts.map

package/dist/types/AppObject/AppObjectEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppObjectEntity.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectEntity.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAElF,MAAM,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC;AAEjD,qBAAa,eAAgB,SAAQ,kBAAkB;IACrD,QAAQ,CAAC,aAAa,iCAAiC;IAEvD,OAAO,CAAC,qBAAqB,CAA4B;IACzD,oBAAoB,GAAI,UAAU,uBAAuB,UAEvD;IACF,uBAAuB,GAAI,UAAU,uBAAuB,KAAG,IAAI,CAEjE;IAEF,OAAO,CAAC,oBAAoB,CAA4B;IACxD,iBAAiB,GAAI,UAAU,uBAAuB,KAAG,IAAI,CAE3D;IACF,oBAAoB,GAAI,UAAU,uBAAuB,KAAG,IAAI,CAE9D;IAEF,cAAc,aAEZ;IAEF,OAAO;gBAUK,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM;CAK/C"}
+{"version":3,"file":"AppObjectEntity.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectEntity.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAElF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC;AAEjD;;;;;;;;;;;GAWG;AACH,qBAAa,eAAgB,SAAQ,kBAAkB;IACrD,6CAA6C;IAC7C,QAAQ,CAAC,aAAa,iCAAiC;IAEvD,+DAA+D;IAC/D,OAAO,CAAC,qBAAqB,CAA4B;IAEzD;;;OAGG;IACH,oBAAoB,GAAI,UAAU,uBAAuB,UAEvD;IAEF;;;OAGG;IACH,uBAAuB,GAAI,UAAU,uBAAuB,KAAG,IAAI,CAEjE;IAEF,mEAAmE;IACnE,OAAO,CAAC,oBAAoB,CAA4B;IAExD;;;OAGG;IACH,iBAAiB,GAAI,UAAU,uBAAuB,KAAG,IAAI,CAE3D;IAEF;;;OAGG;IACH,oBAAoB,GAAI,UAAU,uBAAuB,KAAG,IAAI,CAE9D;IAEF;;;OAGG;IACH,cAAc,aAEZ;IAEF;;;;;;;;OAQG;IACH,OAAO;IAUP;;;;;;OAMG;gBACS,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM;CAM/C"}

package/dist/types/AppObject/AppObjectEntityRepo.d.ts

@@ -1,16 +1,91 @@
 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 declare class AppObjectEntityRepo<T extends AppObjectEntity> extends AppObjectEntity {
     private entityLookup;
     private onEntityAddedObservers;
+    /**
+     * 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
+     */
     addEntityAddedObserver: (observer: (addedEntity: T) => void) => void;
+    /**
+     * Removes an observer previously registered for entity addition notifications.
+     *
+     * @param {(addedEntity: T) => void} observer - The callback function to remove
+     */
     removeEntityAddedObserver: (observer: (addedEntity: T) => void) => void;
     private onEntityRemovedObservers;
+    /**
+     * 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
+     */
     addEntityRemovedObserver: (observer: (removedEntity: T) => void) => void;
+    /**
+     * Removes an observer previously registered for entity removal notifications.
+     *
+     * @param {(removedEntity: T) => void} observer - The callback function to remove
+     */
     removeEntityRemovedObserver: (observer: (removedEntity: T) => void) => void;
+    /**
+     * 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
+     */
     hasForAppObject: (appObjectID: string) => boolean;
+    /**
+     * 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: T): void;
+    /**
+     * 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
+     */
     removeForAppObject: (id: string) => void;
+    /**
+     * 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
+     */
     getForAppObject: (appObjectID: string) => T | undefined;
+    /**
+     * Gets all entities in the repository.
+     *
+     * @returns {T[]} An array of all entities
+     */
     getAll: () => T[];
 }
 //# sourceMappingURL=AppObjectEntityRepo.d.ts.map

package/dist/types/AppObject/AppObjectEntityRepo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppObjectEntityRepo.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectEntityRepo.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,qBAAa,mBAAmB,CAC9B,CAAC,SAAS,eAAe,CACzB,SAAQ,eAAe;IAEvB,OAAO,CAAC,YAAY,CAAwB;IAE5C,OAAO,CAAC,sBAAsB,CAAyB;IACvD,sBAAsB,GAAI,UAAU,CAAC,WAAW,EAAE,CAAC,KAAK,IAAI,UAE1D;IACF,yBAAyB,GAAI,UAAU,CAAC,WAAW,EAAE,CAAC,KAAK,IAAI,KAAG,IAAI,CAEpE;IAEF,OAAO,CAAC,wBAAwB,CAAyB;IACzD,wBAAwB,GAAI,UAAU,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,UAE9D;IACF,2BAA2B,GACzB,UAAU,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,KACnC,IAAI,CAEL;IAEF,eAAe,GAAI,aAAa,MAAM,KAAG,OAAO,CAE9C;IAEF,GAAG,CAAC,MAAM,EAAE,CAAC;IAYb,kBAAkB,GAAI,IAAI,MAAM,UAQ9B;IAEF,eAAe,GAAI,aAAa,MAAM,KAAG,CAAC,GAAG,SAAS,CAEpD;IAEF,MAAM,QAAO,CAAC,EAAE,CAEd;CACH"}
+{"version":3,"file":"AppObjectEntityRepo.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectEntityRepo.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,mBAAmB,CAC9B,CAAC,SAAS,eAAe,CACzB,SAAQ,eAAe;IACvB,OAAO,CAAC,YAAY,CAAwB;IAE5C,OAAO,CAAC,sBAAsB,CAAyB;IACvD;;;;OAIG;IACH,sBAAsB,GAAI,UAAU,CAAC,WAAW,EAAE,CAAC,KAAK,IAAI,UAE1D;IAEF;;;;OAIG;IACH,yBAAyB,GAAI,UAAU,CAAC,WAAW,EAAE,CAAC,KAAK,IAAI,KAAG,IAAI,CAEpE;IAEF,OAAO,CAAC,wBAAwB,CAAyB;IACzD;;;;OAIG;IACH,wBAAwB,GAAI,UAAU,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,UAE9D;IAEF;;;;OAIG;IACH,2BAA2B,GACzB,UAAU,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,KACnC,IAAI,CAEL;IAEF;;;;;OAKG;IACH,eAAe,GAAI,aAAa,MAAM,KAAG,OAAO,CAE9C;IAEF;;;;;;;OAOG;IACH,GAAG,CAAC,MAAM,EAAE,CAAC;IAYb;;;;;;OAMG;IACH,kBAAkB,GAAI,IAAI,MAAM,UAQ9B;IAEF;;;;;OAKG;IACH,eAAe,GAAI,aAAa,MAAM,KAAG,CAAC,GAAG,SAAS,CAEpD;IAEF;;;;OAIG;IACH,MAAM,QAAO,CAAC,EAAE,CAEd;CACH"}

package/dist/types/AppObject/AppObjectPM.d.ts

@@ -1,13 +1,66 @@
 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 declare abstract class AppObjectPM<T> extends AppObjectComponent {
+    /** Identifies this as a Presentation Manager component */
     readonly componentType = AppObjectComponentType.PM;
+    /**
+     * Compares two view models to determine if they're equivalent
+     * Used to prevent unnecessary view updates when the view model hasn't changed
+     *
+     * @param a First view model to compare
+     * @param b Second view model to compare
+     * @returns True if the view models are considered equal, false otherwise
+     */
     abstract vmsAreEqual(a: T, b: T): boolean;
+    /** The most recently generated view model */
     private _lastVM?;
+    /**
+     * Gets the most recently generated view model
+     * @returns The last view model or undefined if none has been generated
+     */
     get lastVM(): T | undefined;
+    /** List of view update functions to notify when the view model changes */
     private observerList;
+    /**
+     * 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: (vm: T) => void): void;
+    /**
+     * Unregisters a previously added view update function
+     *
+     * @param updateView The view update function to remove
+     */
     removeView(updateView: (vm: T) => void): void;
+    /**
+     * 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: T): void;
+    /**
+     * Cleans up resources and detaches this PM from its parent AppObject
+     */
     dispose(): void;
 }
 //# sourceMappingURL=AppObjectPM.d.ts.map

package/dist/types/AppObject/AppObjectPM.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppObjectPM.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectPM.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAElF,8BAAsB,WAAW,CAAC,CAAC,CAAE,SAAQ,kBAAkB;IAC7D,QAAQ,CAAC,aAAa,6BAA6B;IACnD,QAAQ,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,OAAO;IAEzC,OAAO,CAAC,OAAO,CAAC,CAAI;IACpB,IAAI,MAAM,IAAI,CAAC,GAAG,SAAS,CAE1B;IAED,OAAO,CAAC,YAAY,CAAyB;IAE7C,OAAO,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,IAAI,GAAG,IAAI;IAQ1C,UAAU,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,IAAI,GAAG,IAAI;IAI7C,YAAY,CAAC,EAAE,EAAE,CAAC;IASlB,OAAO;CAOR"}
+{"version":3,"file":"AppObjectPM.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectPM.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAElF;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,WAAW,CAAC,CAAC,CAAE,SAAQ,kBAAkB;IAC7D,0DAA0D;IAC1D,QAAQ,CAAC,aAAa,6BAA6B;IAEnD;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,OAAO;IAEzC,6CAA6C;IAC7C,OAAO,CAAC,OAAO,CAAC,CAAI;IAEpB;;;OAGG;IACH,IAAI,MAAM,IAAI,CAAC,GAAG,SAAS,CAE1B;IAED,0EAA0E;IAC1E,OAAO,CAAC,YAAY,CAAyB;IAE7C;;;;;OAKG;IACH,OAAO,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,IAAI,GAAG,IAAI;IAS1C;;;;OAIG;IACH,UAAU,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,IAAI,GAAG,IAAI;IAI7C;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,EAAE,CAAC;IAUlB;;OAEG;IACH,OAAO;CAOR"}

package/dist/types/AppObject/AppObjectRepo.d.ts

@@ -1,26 +1,150 @@
 import { ObservableEntity } from "../Entities";
 import { AppObject } from "./AppObject";
 import { AppObjectComponent } from "./AppObjectComponent";
+/**
+ * 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 declare abstract class AppObjectRepo extends ObservableEntity {
+    /**
+     * Checks if an AppObject with the specified ID exists in the repository.
+     *
+     * @param {string} appObjectID - The ID of the AppObject to check
+     * @returns {boolean} True if the AppObject exists, false otherwise
+     */
     abstract has(appObjectID: string): boolean;
+    /**
+     * Adds an AppObject to the repository.
+     *
+     * @param {AppObject} appObject - The AppObject to add
+     */
     abstract add(appObject: AppObject): void;
+    /**
+     * Removes an AppObject with the specified ID from the repository.
+     *
+     * @param {string} appObjectID - The ID of the AppObject to remove
+     */
     abstract remove(appObjectID: string): void;
+    /**
+     * Gets an AppObject by its ID.
+     *
+     * @param {string} appObjectID - The ID of the AppObject to retrieve
+     * @returns {AppObject | undefined} The AppObject if found, undefined otherwise
+     */
     abstract get(appObjectID: string): AppObject | undefined;
+    /**
+     * Gets an AppObject by its ID, or creates a new one if it doesn't exist.
+     *
+     * @param {string} appObjectID - The ID of the AppObject to retrieve or create
+     * @returns {AppObject} The existing or newly created AppObject
+     */
     abstract getOrCreate(appObjectID: string): AppObject;
+    /**
+     * Gets all AppObjects in the repository.
+     *
+     * @returns {AppObject[]} An array of all AppObjects
+     */
     abstract getAll(): AppObject[];
+    /**
+     * Logs an informational message.
+     *
+     * @param {string} sender - The identifier of the message sender
+     * @param {string} message - The message to log
+     */
     abstract submitLog(sender: string, message: string): void;
+    /**
+     * Logs a warning message.
+     *
+     * @param {string} sender - The identifier of the message sender
+     * @param {string} message - The warning message to log
+     */
     abstract submitWarning(sender: string, message: string): void;
+    /**
+     * Logs an error message.
+     *
+     * @param {string} sender - The identifier of the message sender
+     * @param {string} message - The error message to log
+     */
     abstract submitError(sender: string, message: string): void;
+    /**
+     * Logs a fatal error message.
+     *
+     * @param {string} sender - The identifier of the message sender
+     * @param {string} message - The fatal error message to log
+     */
     abstract submitFatal(sender: string, message: string): void;
+    /**
+     * Registers a component as a singleton in the repository.
+     *
+     * @param {AppObjectComponent} component - The component to register as a singleton
+     */
     abstract registerSingleton(component: AppObjectComponent): void;
+    /**
+     * Gets a singleton component of the specified type.
+     *
+     * @template T - Type of the component to retrieve, must extend AppObjectComponent
+     * @param {string} type - The type of the singleton to retrieve
+     * @returns {T | undefined} The singleton component if found, undefined otherwise
+     */
     abstract getSingleton<T extends AppObjectComponent>(type: string): T | undefined;
+    /**
+     * Gets a component of the specified type from an AppObject.
+     *
+     * @template T - Type of the component to retrieve, must extend AppObjectComponent
+     * @param {string} appObjectID - The ID of the AppObject containing the component
+     * @param {string} type - The type of the component to retrieve
+     * @returns {T | undefined} The component if found, undefined otherwise
+     */
     abstract getAppObjectComponent<T extends AppObjectComponent>(appObjectID: string, type: string): T | undefined;
+    /**
+     * Gets all AppObjects that have a component of the specified type.
+     *
+     * @param {string} componentType - The component type to filter by
+     * @returns {AppObject[]} An array of AppObjects having the specified component type
+     */
     abstract getAllAppObjectsWithComponent(componentType: string): AppObject[];
+    /**
+     * Gets all components of the specified type across all AppObjects.
+     *
+     * @template T - Type of the components to retrieve, must extend AppObjectComponent
+     * @param {string} type - The type of components to retrieve
+     * @returns {T[]} An array of all components of the specified type
+     */
     abstract getAllComponents<T extends AppObjectComponent>(type: string): T[];
+    /**
+     * Adds an observer to be notified when an AppObject is added to the repository.
+     *
+     * @param {(addedEntity: AppObject) => void} observer - The observer function
+     */
     abstract addAppObjectAddedObserver: (observer: (addedEntity: AppObject) => void) => void;
+    /**
+     * Removes an observer previously registered for AppObject addition notifications.
+     *
+     * @param {(addedEntity: AppObject) => void} observer - The observer function to remove
+     */
     abstract removeAppObjectAddedObserver: (observer: (addedEntity: AppObject) => void) => void;
+    /**
+     * Adds an observer to be notified when an AppObject is removed from the repository.
+     *
+     * @param {(addedEntity: AppObject) => void} observer - The observer function
+     */
     abstract addAppObjectRemovedObserver: (observer: (addedEntity: AppObject) => void) => void;
+    /**
+     * Removes an observer previously registered for AppObject removal notifications.
+     *
+     * @param {(addedEntity: AppObject) => void} observer - The observer function to remove
+     */
     abstract removedAppObjectRemovedObserver: (observer: (addedEntity: AppObject) => void) => void;
 }
+/**
+ * Creates and returns a new AppObjectRepo instance.
+ *
+ * @returns {AppObjectRepo} A new AppObjectRepo instance
+ */
 export declare function makeAppObjectRepo(): AppObjectRepo;
 //# sourceMappingURL=AppObjectRepo.d.ts.map

package/dist/types/AppObject/AppObjectRepo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppObjectRepo.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectRepo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAgB,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAiB,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,8BAAsB,aAAc,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAC1C,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IACxC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAC1C,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IACxD,QAAQ,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS;IACpD,QAAQ,CAAC,MAAM,IAAI,SAAS,EAAE;IAE9B,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IACzD,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAC7D,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAC3D,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAE3D,QAAQ,CAAC,iBAAiB,CAAC,SAAS,EAAE,kBAAkB,GAAG,IAAI;IAC/D,QAAQ,CAAC,YAAY,CAAC,CAAC,SAAS,kBAAkB,EAChD,IAAI,EAAE,MAAM,GACX,CAAC,GAAG,SAAS;IAEhB,QAAQ,CAAC,qBAAqB,CAAC,CAAC,SAAS,kBAAkB,EACzD,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,GACX,CAAC,GAAG,SAAS;IAChB,QAAQ,CAAC,6BAA6B,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,EAAE;IAC1E,QAAQ,CAAC,gBAAgB,CAAC,CAAC,SAAS,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE;IAE1E,QAAQ,CAAC,yBAAyB,EAAE,CAClC,QAAQ,EAAE,CAAC,WAAW,EAAE,SAAS,KAAK,IAAI,KACvC,IAAI,CAAC;IACV,QAAQ,CAAC,4BAA4B,EAAE,CACrC,QAAQ,EAAE,CAAC,WAAW,EAAE,SAAS,KAAK,IAAI,KACvC,IAAI,CAAC;IAEV,QAAQ,CAAC,2BAA2B,EAAE,CACpC,QAAQ,EAAE,CAAC,WAAW,EAAE,SAAS,KAAK,IAAI,KACvC,IAAI,CAAC;IACV,QAAQ,CAAC,+BAA+B,EAAE,CACxC,QAAQ,EAAE,CAAC,WAAW,EAAE,SAAS,KAAK,IAAI,KACvC,IAAI,CAAC;CACX;AAED,wBAAgB,iBAAiB,IAAI,aAAa,CAEjD"}
+{"version":3,"file":"AppObjectRepo.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectRepo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAgB,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAiB,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;;;;;;;GAQG;AACH,8BAAsB,aAAc,SAAQ,gBAAgB;IAC1D;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAE1C;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAExC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAE1C;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAExD;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS;IAEpD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,IAAI,SAAS,EAAE;IAE9B;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAEzD;;;;;OAKG;IACH,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAE7D;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAE3D;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAE3D;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,SAAS,EAAE,kBAAkB,GAAG,IAAI;IAE/D;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,CAAC,SAAS,kBAAkB,EAChD,IAAI,EAAE,MAAM,GACX,CAAC,GAAG,SAAS;IAEhB;;;;;;;OAOG;IACH,QAAQ,CAAC,qBAAqB,CAAC,CAAC,SAAS,kBAAkB,EACzD,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,GACX,CAAC,GAAG,SAAS;IAEhB;;;;;OAKG;IACH,QAAQ,CAAC,6BAA6B,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,EAAE;IAE1E;;;;;;OAMG;IACH,QAAQ,CAAC,gBAAgB,CAAC,CAAC,SAAS,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE;IAE1E;;;;OAIG;IACH,QAAQ,CAAC,yBAAyB,EAAE,CAClC,QAAQ,EAAE,CAAC,WAAW,EAAE,SAAS,KAAK,IAAI,KACvC,IAAI,CAAC;IAEV;;;;OAIG;IACH,QAAQ,CAAC,4BAA4B,EAAE,CACrC,QAAQ,EAAE,CAAC,WAAW,EAAE,SAAS,KAAK,IAAI,KACvC,IAAI,CAAC;IAEV;;;;OAIG;IACH,QAAQ,CAAC,2BAA2B,EAAE,CACpC,QAAQ,EAAE,CAAC,WAAW,EAAE,SAAS,KAAK,IAAI,KACvC,IAAI,CAAC;IAEV;;;;OAIG;IACH,QAAQ,CAAC,+BAA+B,EAAE,CACxC,QAAQ,EAAE,CAAC,WAAW,EAAE,SAAS,KAAK,IAAI,KACvC,IAAI,CAAC;CACX;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,aAAa,CAEjD"}

package/dist/types/AppObject/AppObjectUC.d.ts

@@ -1,5 +1,28 @@
 import { AppObjectComponent, AppObjectComponentType } from "./AppObjectComponent";
+/**
+ * AppObjectUC (Use Case) serves as a base use case class within the application framework.
+ *
+ * Use Cases are components that represent specific application operations or workflows.
+ * They encapsulate business rules and coordinate interactions between different parts
+ * of the application. Extend this class to implement specific use case scenarios.
+ *
+ * @extends AppObjectComponent
+ * @example
+ * ```typescript
+ * class PurchaseItemUC extends AppObjectUC {
+ *   execute(itemId: string, quantity: number): boolean {
+ *     // Implement the purchase item use case
+ *     return true; // if successful
+ *   }
+ * }
+ * ```
+ */
 export declare class AppObjectUC extends AppObjectComponent {
+    /**
+     * The component type identifier used to categorize this component as a use case
+     * This property helps the component system identify and manage use case components.
+     * @readonly
+     */
     readonly componentType = AppObjectComponentType.UC;
 }
 //# sourceMappingURL=AppObjectUC.d.ts.map

package/dist/types/AppObject/AppObjectUC.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppObjectUC.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectUC.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAElF,qBAAa,WAAY,SAAQ,kBAAkB;IAClD,QAAQ,CAAC,aAAa,6BAA6B;CACnD"}
+{"version":3,"file":"AppObjectUC.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectUC.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAE9B;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,WAAY,SAAQ,kBAAkB;IACjD;;;;OAIG;IACH,QAAQ,CAAC,aAAa,6BAA6B;CACpD"}

package/dist/types/AppObject/AppObjectView.d.ts

@@ -1,5 +1,27 @@
 import { AppObjectComponent, AppObjectComponentType } from "./AppObjectComponent";
+/**
+ * AppObjectView serves as a base view class within the application framework.
+ *
+ * Views are components that handle the visual representation of an AppObject,
+ * such as rendering, animations, or user interface elements. Extend this class
+ * to create custom visual representations for specific application objects.
+ *
+ * @extends AppObjectComponent
+ * @example
+ * ```typescript
+ * class PlayerView extends AppObjectView {
+ *   render(renderContext: RenderContext) {
+ *     // Render the player character on screen
+ *   }
+ * }
+ * ```
+ */
 export declare class AppObjectView extends AppObjectComponent {
+    /**
+     * The component type identifier used to categorize this component as a view
+     * This property helps the component system identify and manage view components.
+     * @readonly
+     */
     readonly componentType = AppObjectComponentType.VIEW;
 }
 //# sourceMappingURL=AppObjectView.d.ts.map

package/dist/types/AppObject/AppObjectView.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppObjectView.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectView.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAElF,qBAAa,aAAc,SAAQ,kBAAkB;IACpD,QAAQ,CAAC,aAAa,+BAA+B;CACrD"}
+{"version":3,"file":"AppObjectView.d.ts","sourceRoot":"","sources":["../../../src/AppObject/AppObjectView.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAE9B;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,aAAc,SAAQ,kBAAkB;IACnD;;;;OAIG;IACH,QAAQ,CAAC,aAAa,+BAA+B;CACtD"}

package/dist/types/AppObject/getSingletonComponent.d.ts

@@ -1,4 +1,23 @@
 import { AppObjectComponent } from "./AppObjectComponent";
 import { AppObjectRepo } from "./AppObjectRepo";
+/**
+ * Retrieves a singleton component of the specified type from the application objects repository.
+ *
+ * This utility function provides a convenient way to access singleton components that should
+ * have only one instance across the entire application.
+ *
+ * @template T - Type of the component to retrieve, must extend AppObjectComponent
+ * @param {string} type - The type identifier of the component to retrieve
+ * @param {AppObjectRepo} appObjects - The repository containing all application objects
+ * @returns {T | undefined} The singleton component instance if found, otherwise undefined
+ *
+ * @example
+ * ```typescript
+ * const cameraController = getSingletonComponent<CameraController>(CameraController.type, appObjectRepo);
+ * if (cameraController) {
+ *   cameraController.focusOn(targetObject);
+ * }
+ * ```
+ */
 export declare function getSingletonComponent<T extends AppObjectComponent>(type: string, appObjects: AppObjectRepo): T | undefined;
 //# sourceMappingURL=getSingletonComponent.d.ts.map