@vived/core 1.4.1 → 1.4.3

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

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

@@ -1 +1 @@
-{"version":3,"file":"getSingletonComponent.d.ts","sourceRoot":"","sources":["../../../src/AppObject/getSingletonComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,kBAAkB,EAChE,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,aAAa,GACxB,CAAC,GAAG,SAAS,CAEf"}
+{"version":3,"file":"getSingletonComponent.d.ts","sourceRoot":"","sources":["../../../src/AppObject/getSingletonComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,kBAAkB,EAChE,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,aAAa,GACxB,CAAC,GAAG,SAAS,CAEf"}

package/dist/types/Entities/MemoizedAngle.d.ts

@@ -1,10 +1,31 @@
 import { Angle } from "../ValueObjects";
+/**
+ * A wrapper class for Angle objects that tracks changes and triggers callbacks.
+ * Only triggers the callback when the angle value actually changes.
+ */
 export declare class MemoizedAngle {
     private _val;
+    /**
+     * Gets the current angle value
+     */
     get val(): Angle;
+    /**
+     * Sets the angle value and triggers the onChange callback if the value changed
+     * @param b - The new Angle value
+     */
     set val(b: Angle);
+    /**
+     * Sets the value without triggering the onChange callback
+     * @param val - The new Angle value
+     */
     setValQuietly(val: Angle): void;
     private onChangeCallback;
+    /**
+     * Creates a new MemoizedAngle instance
+     *
+     * @param initialValue - The initial Angle value
+     * @param onChangeCallback - Function to call when the value changes
+     */
     constructor(initialValue: Angle, onChangeCallback: () => void);
 }
 //# sourceMappingURL=MemoizedAngle.d.ts.map

package/dist/types/Entities/MemoizedAngle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MemoizedAngle.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedAngle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC,qBAAa,aAAa;IACxB,OAAO,CAAC,IAAI,CAAQ;IACpB,IAAI,GAAG,IAAI,KAAK,CAEf;IACD,IAAI,GAAG,CAAC,CAAC,EAAE,KAAK,EAKf;IAEM,aAAa,CAAC,GAAG,EAAE,KAAK;IAI/B,OAAO,CAAC,gBAAgB,CAAa;gBAEzB,YAAY,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAI9D"}
+{"version":3,"file":"MemoizedAngle.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedAngle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC;;;GAGG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,IAAI,CAAQ;IAEpB;;OAEG;IACH,IAAI,GAAG,IAAI,KAAK,CAEf;IAED;;;OAGG;IACH,IAAI,GAAG,CAAC,CAAC,EAAE,KAAK,EAKf;IAED;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,KAAK;IAI/B,OAAO,CAAC,gBAAgB,CAAa;IAErC;;;;;OAKG;gBACS,YAAY,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAI9D"}

package/dist/types/Entities/MemoizedBoolean.d.ts

@@ -1,9 +1,30 @@
+/**
+ * A wrapper class for boolean values that tracks changes and triggers callbacks.
+ * Only triggers the callback when the value actually changes.
+ */
 export declare class MemoizedBoolean {
     private _val;
+    /**
+     * Gets the current boolean value
+     */
     get val(): boolean;
+    /**
+     * Sets the boolean value and triggers the onChange callback if the value changed
+     * @param b - The new boolean value
+     */
     set val(b: boolean);
+    /**
+     * Sets the value without triggering the onChange callback
+     * @param val - The new boolean value
+     */
     setValQuietly(val: boolean): void;
     private onChangeCallback;
+    /**
+     * Creates a new MemoizedBoolean instance
+     *
+     * @param initialValue - The initial boolean value
+     * @param onChangeCallback - Function to call when the value changes
+     */
     constructor(initialValue: boolean, onChangeCallback: () => void);
 }
 //# sourceMappingURL=MemoizedBoolean.d.ts.map

package/dist/types/Entities/MemoizedBoolean.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MemoizedBoolean.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedBoolean.ts"],"names":[],"mappings":"AAAA,qBAAa,eAAe;IAC1B,OAAO,CAAC,IAAI,CAAU;IACtB,IAAI,GAAG,IAAI,OAAO,CAEjB;IACD,IAAI,GAAG,CAAC,CAAC,EAAE,OAAO,EAKjB;IAEM,aAAa,CAAC,GAAG,EAAE,OAAO;IAIjC,OAAO,CAAC,gBAAgB,CAAa;gBAEzB,YAAY,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAIhE"}
+{"version":3,"file":"MemoizedBoolean.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedBoolean.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,IAAI,CAAU;IAEtB;;OAEG;IACH,IAAI,GAAG,IAAI,OAAO,CAEjB;IAED;;;OAGG;IACH,IAAI,GAAG,CAAC,CAAC,EAAE,OAAO,EAKjB;IAED;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,OAAO;IAIjC,OAAO,CAAC,gBAAgB,CAAa;IAErC;;;;;OAKG;gBACS,YAAY,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAIhE"}

package/dist/types/Entities/MemoizedColor.d.ts

@@ -1,10 +1,31 @@
 import { Color } from "../ValueObjects";
+/**
+ * A wrapper class for Color objects that tracks changes and triggers callbacks.
+ * Only triggers the callback when the color value actually changes.
+ */
 export declare class MemoizedColor {
     private _val;
+    /**
+     * Gets the current Color value
+     */
     get val(): Color;
+    /**
+     * Sets the Color value and triggers the onChange callback if the value changed
+     * @param v - The new Color value
+     */
     set val(v: Color);
+    /**
+     * Sets the value without triggering the onChange callback
+     * @param val - The new Color value
+     */
     setValQuietly(val: Color): void;
     private onChangeCallback;
+    /**
+     * Creates a new MemoizedColor instance
+     *
+     * @param initialValue - The initial Color value
+     * @param onChangeCallback - Function to call when the value changes
+     */
     constructor(initialValue: Color, onChangeCallback: () => void);
 }
 //# sourceMappingURL=MemoizedColor.d.ts.map

package/dist/types/Entities/MemoizedColor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MemoizedColor.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedColor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC,qBAAa,aAAa;IACxB,OAAO,CAAC,IAAI,CAAQ;IAEpB,IAAI,GAAG,IAAI,KAAK,CAEf;IAED,IAAI,GAAG,CAAC,CAAC,EAAE,KAAK,EAKf;IAEM,aAAa,CAAC,GAAG,EAAE,KAAK;IAI/B,OAAO,CAAC,gBAAgB,CAAa;gBAEzB,YAAY,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAI9D"}
+{"version":3,"file":"MemoizedColor.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedColor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC;;;GAGG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,IAAI,CAAQ;IAEpB;;OAEG;IACH,IAAI,GAAG,IAAI,KAAK,CAEf;IAED;;;OAGG;IACH,IAAI,GAAG,CAAC,CAAC,EAAE,KAAK,EAKf;IAED;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,KAAK;IAI/B,OAAO,CAAC,gBAAgB,CAAa;IAErC;;;;;OAKG;gBACS,YAAY,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAI9D"}

package/dist/types/Entities/MemoizedNumber.d.ts

@@ -1,9 +1,30 @@
+/**
+ * A wrapper class for numeric values that tracks changes and triggers callbacks.
+ * Only triggers the callback when the value actually changes.
+ */
 export declare class MemoizedNumber {
     private _val;
+    /**
+     * Gets the current numeric value
+     */
     get val(): number;
+    /**
+     * Sets the numeric value and triggers the onChange callback if the value changed
+     * @param b - The new numeric value
+     */
     set val(b: number);
+    /**
+     * Sets the value without triggering the onChange callback
+     * @param val - The new numeric value
+     */
     setValQuietly(val: number): void;
     private onChangeCallback;
+    /**
+     * Creates a new MemoizedNumber instance
+     *
+     * @param initialValue - The initial numeric value
+     * @param onChangeCallback - Function to call when the value changes
+     */
     constructor(initialValue: number, onChangeCallback: () => void);
 }
 //# sourceMappingURL=MemoizedNumber.d.ts.map

package/dist/types/Entities/MemoizedNumber.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MemoizedNumber.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedNumber.ts"],"names":[],"mappings":"AAAA,qBAAa,cAAc;IACzB,OAAO,CAAC,IAAI,CAAS;IACrB,IAAI,GAAG,IAAI,MAAM,CAEhB;IACD,IAAI,GAAG,CAAC,CAAC,EAAE,MAAM,EAKhB;IAEM,aAAa,CAAC,GAAG,EAAE,MAAM;IAIhC,OAAO,CAAC,gBAAgB,CAAa;gBAEzB,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAI/D"}
+{"version":3,"file":"MemoizedNumber.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedNumber.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,IAAI,CAAS;IAErB;;OAEG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;;OAGG;IACH,IAAI,GAAG,CAAC,CAAC,EAAE,MAAM,EAKhB;IAED;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,MAAM;IAIhC,OAAO,CAAC,gBAAgB,CAAa;IAErC;;;;;OAKG;gBACS,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAI/D"}

package/dist/types/Entities/MemoizedQuaternion.d.ts

@@ -1,10 +1,31 @@
 import { Quaternion } from "../ValueObjects";
+/**
+ * A wrapper class for Quaternion objects that tracks changes and triggers callbacks.
+ * Only triggers the callback when the quaternion value actually changes.
+ */
 export declare class MemoizedQuaternion {
     private _val;
+    /**
+     * Gets the current Quaternion value
+     */
     get val(): Quaternion;
+    /**
+     * Sets the Quaternion value and triggers the onChange callback if the value changed
+     * @param v - The new Quaternion value
+     */
     set val(v: Quaternion);
+    /**
+     * Sets the value without triggering the onChange callback
+     * @param val - The new Quaternion value
+     */
     setValQuietly(val: Quaternion): void;
     private onChangeCallback;
+    /**
+     * Creates a new MemoizedQuaternion instance
+     *
+     * @param initialValue - The initial Quaternion value
+     * @param onChangeCallback - Function to call when the value changes
+     */
     constructor(initialValue: Quaternion, onChangeCallback: () => void);
 }
 //# sourceMappingURL=MemoizedQuaternion.d.ts.map

package/dist/types/Entities/MemoizedQuaternion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MemoizedQuaternion.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedQuaternion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,IAAI,CAAa;IAEzB,IAAI,GAAG,IAAI,UAAU,CAEpB;IAED,IAAI,GAAG,CAAC,CAAC,EAAE,UAAU,EAKpB;IAEM,aAAa,CAAC,GAAG,EAAE,UAAU;IAIpC,OAAO,CAAC,gBAAgB,CAAa;gBAEzB,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAInE"}
+{"version":3,"file":"MemoizedQuaternion.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedQuaternion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,IAAI,CAAa;IAEzB;;OAEG;IACH,IAAI,GAAG,IAAI,UAAU,CAEpB;IAED;;;OAGG;IACH,IAAI,GAAG,CAAC,CAAC,EAAE,UAAU,EAKpB;IAED;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,UAAU;IAIpC,OAAO,CAAC,gBAAgB,CAAa;IAErC;;;;;OAKG;gBACS,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAInE"}

package/dist/types/Entities/MemoizedString.d.ts

@@ -1,9 +1,30 @@
+/**
+ * A wrapper class for string values that tracks changes and triggers callbacks.
+ * Only triggers the callback when the value actually changes.
+ */
 export declare class MemoizedString {
     private _val;
+    /**
+     * Gets the current string value
+     */
     get val(): string;
+    /**
+     * Sets the string value and triggers the onChange callback if the value changed
+     * @param b - The new string value
+     */
     set val(b: string);
+    /**
+     * Sets the value without triggering the onChange callback
+     * @param val - The new string value
+     */
     setValQuietly(val: string): void;
     private onChangeCallback;
+    /**
+     * Creates a new MemoizedString instance
+     *
+     * @param initialValue - The initial string value
+     * @param onChangeCallback - Function to call when the value changes
+     */
     constructor(initialValue: string, onChangeCallback: () => void);
 }
 //# sourceMappingURL=MemoizedString.d.ts.map