@vived/core 1.4.3 → 1.4.5

package/dist/esm/ExampleFeature/Entities/ExampleRepo.js

@@ -0,0 +1,108 @@
+/**
+ * ExampleRepo.ts
+ *
+ * This file demonstrates how to implement a repository to manage collections of entities.
+ * Repositories are responsible for creating, retrieving, and deleting entities.
+ *
+ * Key concepts:
+ * - Repositories extend AppObjectEntityRepo<T> where T is the entity type
+ * - They provide methods to create and delete entities
+ * - They manage collections of entities and provide access to them
+ * - They can use custom entity factories to create specialized entities
+ *
+ * Usage pattern:
+ * 1. Get or create a repository using getById, get, or addIfMissing
+ * 2. Use the repository to create new entities
+ * 3. Access entities through the repository's getters
+ * 4. Delete entities through the repository when they're no longer needed
+ */
+import { AppObjectEntityRepo } from "../../AppObject";
+import { generateUniqueID } from "../../Utilities/generateUniqueID";
+import { makeExampleEntity } from "./ExampleEntity";
+/**
+ * ExampleRepo manages a collection of ExampleEntity instances.
+ * Abstract class provides the interface and static helper methods.
+ */
+export class ExampleRepo extends AppObjectEntityRepo {
+    /**
+     * Retrieves an ExampleRepo component from an AppObject
+     * @param appObj The AppObject to get the component from
+     * @returns The ExampleRepo component or undefined if not found
+     */
+    static get(appObj) {
+        return appObj.getComponent(this.type);
+    }
+    /**
+     * Retrieves an ExampleRepo by its parent AppObject's ID
+     * @param id The ID of the parent AppObject
+     * @param appObjects The AppObjectRepo to search in
+     * @returns The ExampleRepo component or undefined if not found
+     */
+    static getById(id, appObjects) {
+        return appObjects.get(id)?.getComponent(this.type);
+    }
+    /**
+     * Ensures an ExampleRepo exists on the AppObject, creating one if needed
+     * @param appObject The AppObject to check/add the component to
+     * @returns The existing or newly created ExampleRepo
+     */
+    static addIfMissing(appObject) {
+        const existing = appObject.getComponent(ExampleRepo.type);
+        if (existing) {
+            return existing;
+        }
+        else {
+            return makeExampleRepo(appObject);
+        }
+    }
+}
+/** Unique type identifier for this component */
+ExampleRepo.type = "ExampleRepoType";
+/**
+ * Factory function to create a new ExampleRepo
+ * @param appObject The AppObject to attach the repo to
+ * @returns A new ExampleRepo instance
+ */
+export function makeExampleRepo(appObject) {
+    return new ExampleRepoImp(appObject);
+}
+/**
+ * Concrete implementation of ExampleRepo
+ * This private class handles the actual implementation details
+ */
+class ExampleRepoImp extends ExampleRepo {
+    /**
+     * Deletes an ExampleEntity from the repository by its AppObject ID
+     * @param id The ID of the entity's AppObject
+     */
+    deleteExampleEntity(id) {
+        const entity = this.getForAppObject(id);
+        if (!entity)
+            return;
+        entity.appObject.dispose();
+        this.removeForAppObject(id);
+    }
+    constructor(appObject) {
+        super(appObject, ExampleRepo.type);
+        /**
+         * Creates a new ExampleEntity and adds it to the repository
+         * @param id Optional ID for the entity's AppObject (generates one if not provided)
+         * @returns The newly created ExampleEntity
+         */
+        this.createExampleEntity = (id) => {
+            const idToUse = id ?? generateUniqueID();
+            const entity = this.exampleEntityFactory(idToUse);
+            this.add(entity);
+            return entity;
+        };
+        /**
+         * Default factory implementation for creating ExampleEntity instances
+         * Can be overridden to create specialized entities
+         */
+        this.exampleEntityFactory = (id) => {
+            const ao = this.appObjects.getOrCreate(id);
+            return makeExampleEntity(ao);
+        };
+    }
+}
+//# sourceMappingURL=ExampleRepo.js.map

package/dist/esm/ExampleFeature/Entities/ExampleRepo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleRepo.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Entities/ExampleRepo.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAEL,mBAAmB,EAEpB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAiB,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAKnE;;;GAGG;AACH,MAAM,OAAgB,WAAY,SAAQ,mBAAkC;IAa1E;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,MAAiB;QAC1B,OAAO,MAAM,CAAC,YAAY,CAAc,IAAI,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CACZ,EAAU,EACV,UAAyB;QAEzB,OAAO,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,YAAY,CAAc,IAAI,CAAC,IAAI,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,SAAoB;QACtC,MAAM,QAAQ,GAAG,SAAS,CAAC,YAAY,CAAc,WAAW,CAAC,IAAI,CAAC,CAAC;QACvE,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,QAAQ,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,OAAO,eAAe,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;;AA9CD,gDAAgD;AAChC,gBAAI,GAAG,iBAAiB,CAAC;AAgD3C;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,SAAoB;IAClD,OAAO,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC;AACvC,CAAC;AAED;;;GAGG;AACH,MAAM,cAAe,SAAQ,WAAW;IAatC;;;OAGG;IACH,mBAAmB,CAAC,EAAU;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM;YAAE,OAAO;QAEpB,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QAC3B,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAWD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QAlCrC;;;;WAIG;QACH,wBAAmB,GAAG,CAAC,EAAsB,EAAiB,EAAE;YAC9D,MAAM,OAAO,GAAG,EAAE,IAAI,gBAAgB,EAAE,CAAC;YACzC,MAAM,MAAM,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAClD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACjB,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAcF;;;WAGG;QACH,yBAAoB,GAAG,CAAC,EAAU,EAAiB,EAAE;YACnD,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YAC3C,OAAO,iBAAiB,CAAC,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC;IAIF,CAAC;CACF","sourcesContent":["/**\r\n * ExampleRepo.ts\r\n * \r\n * This file demonstrates how to implement a repository to manage collections of entities.\r\n * Repositories are responsible for creating, retrieving, and deleting entities.\r\n * \r\n * Key concepts:\r\n * - Repositories extend AppObjectEntityRepo<T> where T is the entity type\r\n * - They provide methods to create and delete entities\r\n * - They manage collections of entities and provide access to them\r\n * - They can use custom entity factories to create specialized entities\r\n * \r\n * Usage pattern:\r\n * 1. Get or create a repository using getById, get, or addIfMissing\r\n * 2. Use the repository to create new entities\r\n * 3. Access entities through the repository's getters\r\n * 4. Delete entities through the repository when they're no longer needed\r\n */\r\n\r\nimport {\r\n  AppObject,\r\n  AppObjectEntityRepo,\r\n  AppObjectRepo\r\n} from \"../../AppObject\";\r\nimport { generateUniqueID } from \"../../Utilities/generateUniqueID\";\r\nimport { ExampleEntity, makeExampleEntity } from \"./ExampleEntity\";\r\n\r\n/** Type definition for a factory function that creates ExampleEntity instances */\r\nexport type ExampleEntityFactory = (id: string) => ExampleEntity;\r\n\r\n/**\r\n * ExampleRepo manages a collection of ExampleEntity instances.\r\n * Abstract class provides the interface and static helper methods.\r\n */\r\nexport abstract class ExampleRepo extends AppObjectEntityRepo<ExampleEntity> {\r\n  /** Unique type identifier for this component */\r\n  static readonly type = \"ExampleRepoType\";\r\n\r\n  /** Factory function used to create new entities */\r\n  abstract exampleEntityFactory: ExampleEntityFactory;\r\n\r\n  /** Creates a new entity with an optional ID */\r\n  abstract createExampleEntity(id?: string): ExampleEntity;\r\n  \r\n  /** Deletes an entity by its AppObject ID */\r\n  abstract deleteExampleEntity(id: string): void;\r\n\r\n  /**\r\n   * Retrieves an ExampleRepo component from an AppObject\r\n   * @param appObj The AppObject to get the component from\r\n   * @returns The ExampleRepo component or undefined if not found\r\n   */\r\n  static get(appObj: AppObject): ExampleRepo | undefined {\r\n    return appObj.getComponent<ExampleRepo>(this.type);\r\n  }\r\n\r\n  /**\r\n   * Retrieves an ExampleRepo by its parent AppObject's ID\r\n   * @param id The ID of the parent AppObject\r\n   * @param appObjects The AppObjectRepo to search in\r\n   * @returns The ExampleRepo component or undefined if not found\r\n   */\r\n  static getById(\r\n    id: string,\r\n    appObjects: AppObjectRepo\r\n  ): ExampleRepo | undefined {\r\n    return appObjects.get(id)?.getComponent<ExampleRepo>(this.type);\r\n  }\r\n\r\n  /**\r\n   * Ensures an ExampleRepo exists on the AppObject, creating one if needed\r\n   * @param appObject The AppObject to check/add the component to\r\n   * @returns The existing or newly created ExampleRepo\r\n   */\r\n  static addIfMissing(appObject: AppObject): ExampleRepo {\r\n    const existing = appObject.getComponent<ExampleRepo>(ExampleRepo.type);\r\n    if (existing) {\r\n      return existing;\r\n    } else {\r\n      return makeExampleRepo(appObject);\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * Factory function to create a new ExampleRepo\r\n * @param appObject The AppObject to attach the repo to\r\n * @returns A new ExampleRepo instance\r\n */\r\nexport function makeExampleRepo(appObject: AppObject): ExampleRepo {\r\n  return new ExampleRepoImp(appObject);\r\n}\r\n\r\n/**\r\n * Concrete implementation of ExampleRepo\r\n * This private class handles the actual implementation details\r\n */\r\nclass ExampleRepoImp extends ExampleRepo {\r\n  /**\r\n   * Creates a new ExampleEntity and adds it to the repository\r\n   * @param id Optional ID for the entity's AppObject (generates one if not provided)\r\n   * @returns The newly created ExampleEntity\r\n   */\r\n  createExampleEntity = (id: string | undefined): ExampleEntity => {\r\n    const idToUse = id ?? generateUniqueID();\r\n    const entity = this.exampleEntityFactory(idToUse);\r\n    this.add(entity);\r\n    return entity;\r\n  };\r\n\r\n  /**\r\n   * Deletes an ExampleEntity from the repository by its AppObject ID\r\n   * @param id The ID of the entity's AppObject\r\n   */\r\n  deleteExampleEntity(id: string): void {\r\n    const entity = this.getForAppObject(id);\r\n    if (!entity) return;\r\n\r\n    entity.appObject.dispose();\r\n    this.removeForAppObject(id);\r\n  }\r\n\r\n  /**\r\n   * Default factory implementation for creating ExampleEntity instances\r\n   * Can be overridden to create specialized entities\r\n   */\r\n  exampleEntityFactory = (id: string): ExampleEntity => {\r\n    const ao = this.appObjects.getOrCreate(id);\r\n    return makeExampleEntity(ao);\r\n  };\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ExampleRepo.type);\r\n  }\r\n}\r\n"]}

package/dist/esm/ExampleFeature/Entities/ExampleSingletonEntity.js

@@ -0,0 +1,64 @@
+/**
+ * ExampleSingletonEntity.ts
+ *
+ * This file demonstrates how to implement a singleton entity in the application.
+ * Singleton entities are special entities that exist only once in the application
+ * and can be accessed globally from anywhere.
+ *
+ * Key concepts:
+ * - Singleton entities extend AppObjectEntity like regular entities
+ * - They register themselves as singletons with appObjects.registerSingleton()
+ * - They're accessed through a static get() method using getSingletonComponent()
+ * - There's only one instance of a singleton entity in the entire application
+ *
+ * Usage pattern:
+ * 1. Access the singleton entity using the static get() method
+ * 2. Access or modify properties via getters/setters
+ * 3. Register change observers to react to property updates
+ */
+import { AppObjectEntity } from "../../AppObject";
+import { getSingletonComponent } from "../../AppObject/getSingletonComponent";
+import { MemoizedBoolean } from "../../Entities/MemoizedBoolean";
+/**
+ * SingletonEntityExample represents a global entity with a boolean property.
+ * As a singleton, only one instance exists in the application.
+ */
+export class SingletonEntityExample extends AppObjectEntity {
+}
+/** Unique type identifier for this component */
+SingletonEntityExample.type = "SingletonEntityExampleType";
+/**
+ * Global accessor for the singleton entity
+ * @param appObjects The AppObjectRepo to search in
+ * @returns The singleton entity or undefined if not created yet
+ */
+SingletonEntityExample.get = (appObjects) => getSingletonComponent(SingletonEntityExample.type, appObjects);
+/**
+ * Factory function to create a new SingletonEntityExample
+ * @param appObject The AppObject to attach the entity to
+ * @returns A new SingletonEntityExample instance
+ */
+export function makeSingletonEntityExample(appObject) {
+    return new SingletonEntityExampleImp(appObject);
+}
+/**
+ * Concrete implementation of SingletonEntityExample
+ * This private class handles the actual implementation details
+ */
+class SingletonEntityExampleImp extends SingletonEntityExample {
+    // Property accessors that use the memoized value
+    get aBoolProperty() {
+        return this.memoizedIsAuthoring.val;
+    }
+    set aBoolProperty(val) {
+        this.memoizedIsAuthoring.val = val;
+    }
+    constructor(appObject) {
+        super(appObject, SingletonEntityExample.type);
+        // MemoizedBoolean tracks changes to the boolean value and calls notifyOnChange when updated
+        this.memoizedIsAuthoring = new MemoizedBoolean(false, this.notifyOnChange);
+        // Register this entity as a singleton so it can be accessed globally
+        this.appObjects.registerSingleton(this);
+    }
+}
+//# sourceMappingURL=ExampleSingletonEntity.js.map

package/dist/esm/ExampleFeature/Entities/ExampleSingletonEntity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleSingletonEntity.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Entities/ExampleSingletonEntity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAEL,eAAe,EAEhB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEjE;;;GAGG;AACH,MAAM,OAAgB,sBAAuB,SAAQ,eAAe;;AAClE,gDAAgD;AAChC,2BAAI,GAAG,4BAA4B,CAAC;AAMpD;;;;GAIG;AACI,0BAAG,GAAG,CACX,UAAyB,EACW,EAAE,CACtC,qBAAqB,CAAC,sBAAsB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAGnE;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CACxC,SAAoB;IAEpB,OAAO,IAAI,yBAAyB,CAAC,SAAS,CAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,yBAA0B,SAAQ,sBAAsB;IAI5D,iDAAiD;IACjD,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC;IACtC,CAAC;IAED,IAAI,aAAa,CAAC,GAAY;QAC5B,IAAI,CAAC,mBAAmB,CAAC,GAAG,GAAG,GAAG,CAAC;IACrC,CAAC;IAED,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAbhD,4FAA4F;QACpF,wBAAmB,GAAG,IAAI,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAa5E,qEAAqE;QACrE,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["/**\r\n * ExampleSingletonEntity.ts\r\n * \r\n * This file demonstrates how to implement a singleton entity in the application.\r\n * Singleton entities are special entities that exist only once in the application\r\n * and can be accessed globally from anywhere.\r\n * \r\n * Key concepts:\r\n * - Singleton entities extend AppObjectEntity like regular entities\r\n * - They register themselves as singletons with appObjects.registerSingleton()\r\n * - They're accessed through a static get() method using getSingletonComponent()\r\n * - There's only one instance of a singleton entity in the entire application\r\n * \r\n * Usage pattern:\r\n * 1. Access the singleton entity using the static get() method\r\n * 2. Access or modify properties via getters/setters\r\n * 3. Register change observers to react to property updates\r\n */\r\n\r\nimport {\r\n  AppObject,\r\n  AppObjectEntity,\r\n  AppObjectRepo\r\n} from \"../../AppObject\";\r\nimport { getSingletonComponent } from \"../../AppObject/getSingletonComponent\";\r\nimport { MemoizedBoolean } from \"../../Entities/MemoizedBoolean\";\r\n\r\n/**\r\n * SingletonEntityExample represents a global entity with a boolean property.\r\n * As a singleton, only one instance exists in the application.\r\n */\r\nexport abstract class SingletonEntityExample extends AppObjectEntity {\r\n  /** Unique type identifier for this component */\r\n  static readonly type = \"SingletonEntityExampleType\";\r\n\r\n  /** Boolean property accessor methods that must be implemented */\r\n  abstract get aBoolProperty(): boolean;\r\n  abstract set aBoolProperty(val: boolean);\r\n\r\n  /**\r\n   * Global accessor for the singleton entity\r\n   * @param appObjects The AppObjectRepo to search in\r\n   * @returns The singleton entity or undefined if not created yet\r\n   */\r\n  static get = (\r\n    appObjects: AppObjectRepo\r\n  ): SingletonEntityExample | undefined =>\r\n    getSingletonComponent(SingletonEntityExample.type, appObjects);\r\n}\r\n\r\n/**\r\n * Factory function to create a new SingletonEntityExample\r\n * @param appObject The AppObject to attach the entity to\r\n * @returns A new SingletonEntityExample instance\r\n */\r\nexport function makeSingletonEntityExample(\r\n  appObject: AppObject\r\n): SingletonEntityExample {\r\n  return new SingletonEntityExampleImp(appObject);\r\n}\r\n\r\n/**\r\n * Concrete implementation of SingletonEntityExample\r\n * This private class handles the actual implementation details\r\n */\r\nclass SingletonEntityExampleImp extends SingletonEntityExample {\r\n  // MemoizedBoolean tracks changes to the boolean value and calls notifyOnChange when updated\r\n  private memoizedIsAuthoring = new MemoizedBoolean(false, this.notifyOnChange);\r\n  \r\n  // Property accessors that use the memoized value\r\n  get aBoolProperty() {\r\n    return this.memoizedIsAuthoring.val;\r\n  }\r\n  \r\n  set aBoolProperty(val: boolean) {\r\n    this.memoizedIsAuthoring.val = val;\r\n  }\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, SingletonEntityExample.type);\r\n    // Register this entity as a singleton so it can be accessed globally\r\n    this.appObjects.registerSingleton(this);\r\n  }\r\n}\r\n"]}

package/dist/esm/ExampleFeature/Entities/index.js

@@ -0,0 +1,4 @@
+export * from "./ExampleEntity";
+export * from "./ExampleRepo";
+export * from "./ExampleSingletonEntity";
+//# sourceMappingURL=index.js.map

package/dist/esm/ExampleFeature/Entities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Entities/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC","sourcesContent":["export * from \"./ExampleEntity\";\r\nexport * from \"./ExampleRepo\";\r\nexport * from \"./ExampleSingletonEntity\";\r\n"]}

package/dist/esm/ExampleFeature/Factory/index.js

@@ -0,0 +1,2 @@
+export * from "./setupExampleFeature";
+//# sourceMappingURL=index.js.map

package/dist/esm/ExampleFeature/Factory/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Factory/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC","sourcesContent":["export * from \"./setupExampleFeature\";"]}

package/dist/esm/ExampleFeature/Factory/setupExampleFeature.js

@@ -0,0 +1,26 @@
+/**
+ * setupExampleFeature.ts
+ *
+ * This file provides a setup function to initialize the ExampleFeature components.
+ * It creates a dedicated AppObject for ExampleFeature and adds all required
+ * singleton components to it.
+ */
+import { makeSingletonEntityExample } from "../Entities/ExampleSingletonEntity";
+import { makeExampleSingletonPM } from "../PMs/ExampleSingletonPM";
+import { makeToggleExampleBooleanUC } from "../UCs/ToggleExampleBooleanUC";
+/**
+ * Sets up the ExampleFeature by creating an AppObject and attaching required components.
+ *
+ * @param appObjects - Repository of AppObjects to use for creating the feature
+ * @returns The singleton entity instance
+ */
+export function setupExampleFeature(appObjects) {
+    // Create a dedicated AppObject for ExampleFeature
+    const appObject = appObjects.getOrCreate("ExampleFeature");
+    // Add singleton components to the AppObject
+    const entity = makeSingletonEntityExample(appObject);
+    makeExampleSingletonPM(appObject);
+    makeToggleExampleBooleanUC(appObject);
+    return entity;
+}
+//# sourceMappingURL=setupExampleFeature.js.map

package/dist/esm/ExampleFeature/Factory/setupExampleFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupExampleFeature.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Factory/setupExampleFeature.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,0BAA0B,EAA0B,MAAM,oCAAoC,CAAC;AACxG,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAAyB;IAC3D,kDAAkD;IAClD,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAE3D,4CAA4C;IAC5C,MAAM,MAAM,GAAG,0BAA0B,CAAC,SAAS,CAAC,CAAC;IACrD,sBAAsB,CAAC,SAAS,CAAC,CAAC;IAClC,0BAA0B,CAAC,SAAS,CAAC,CAAC;IAEtC,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["/**\r\n * setupExampleFeature.ts\r\n * \r\n * This file provides a setup function to initialize the ExampleFeature components.\r\n * It creates a dedicated AppObject for ExampleFeature and adds all required\r\n * singleton components to it.\r\n */\r\n\r\nimport { AppObjectRepo } from \"../../AppObject\";\r\nimport { makeSingletonEntityExample, SingletonEntityExample } from \"../Entities/ExampleSingletonEntity\";\r\nimport { makeExampleSingletonPM } from \"../PMs/ExampleSingletonPM\";\r\nimport { makeToggleExampleBooleanUC } from \"../UCs/ToggleExampleBooleanUC\";\r\n\r\n/**\r\n * Sets up the ExampleFeature by creating an AppObject and attaching required components.\r\n * \r\n * @param appObjects - Repository of AppObjects to use for creating the feature\r\n * @returns The singleton entity instance\r\n */\r\nexport function setupExampleFeature(appObjects: AppObjectRepo): SingletonEntityExample {\r\n  // Create a dedicated AppObject for ExampleFeature\r\n  const appObject = appObjects.getOrCreate(\"ExampleFeature\");\r\n  \r\n  // Add singleton components to the AppObject\r\n  const entity = makeSingletonEntityExample(appObject);\r\n  makeExampleSingletonPM(appObject);\r\n  makeToggleExampleBooleanUC(appObject);\r\n  \r\n  return entity;\r\n}"]}

package/dist/esm/ExampleFeature/Mocks/MockEditExampleStringUC.js

@@ -0,0 +1,43 @@
+/**
+ * MockEditExampleStringUC.ts
+ *
+ * This file demonstrates how to implement a mock UC for testing.
+ * Mock UCs extend the real UC classes but override their methods with test implementations.
+ * This allows tests to verify that the UC methods are called correctly without
+ * actually modifying entities or performing real operations.
+ *
+ * Key concepts:
+ * - Mock UCs extend the real UC classes
+ * - They override methods with test implementations (often empty or spy functions)
+ * - They're used in unit tests to isolate components from their dependencies
+ * - They help verify that methods are called with the correct parameters
+ *
+ * Usage pattern (in tests):
+ * ```typescript
+ * // In a test file
+ * const mockUC = new MockEditExampleStringUC(appObject);
+ * const spy = jest.spyOn(mockUC, 'editExampleString');
+ *
+ * // Call the function that should use the UC
+ * someFunction(appObject);
+ *
+ * // Verify the UC method was called correctly
+ * expect(spy).toHaveBeenCalledWith('expected value');
+ * ```
+ */
+import { EditExampleStringUC } from "../UCs/EditExampleStringUC";
+/**
+ * Mock implementation of EditExampleStringUC for testing
+ * Provides a no-op implementation of editExampleString that can be spied on in tests
+ */
+export class MockEditExampleStringUC extends EditExampleStringUC {
+    constructor(appObject) {
+        super(appObject, EditExampleStringUC.type);
+        /**
+         * Mock implementation that does nothing
+         * In tests, this can be replaced with a Jest spy to track calls
+         */
+        this.editExampleString = (text) => { };
+    }
+}
+//# sourceMappingURL=MockEditExampleStringUC.js.map

package/dist/esm/ExampleFeature/Mocks/MockEditExampleStringUC.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockEditExampleStringUC.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Mocks/MockEditExampleStringUC.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEjE;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,mBAAmB;IAO9D,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAP7C;;;WAGG;QACH,sBAAiB,GAAG,CAAC,IAAY,EAAQ,EAAE,GAAE,CAAC,CAAC;IAI/C,CAAC;CACF","sourcesContent":["/**\r\n * MockEditExampleStringUC.ts\r\n * \r\n * This file demonstrates how to implement a mock UC for testing.\r\n * Mock UCs extend the real UC classes but override their methods with test implementations.\r\n * This allows tests to verify that the UC methods are called correctly without\r\n * actually modifying entities or performing real operations.\r\n * \r\n * Key concepts:\r\n * - Mock UCs extend the real UC classes\r\n * - They override methods with test implementations (often empty or spy functions)\r\n * - They're used in unit tests to isolate components from their dependencies\r\n * - They help verify that methods are called with the correct parameters\r\n * \r\n * Usage pattern (in tests):\r\n * ```typescript\r\n * // In a test file\r\n * const mockUC = new MockEditExampleStringUC(appObject);\r\n * const spy = jest.spyOn(mockUC, 'editExampleString');\r\n * \r\n * // Call the function that should use the UC\r\n * someFunction(appObject);\r\n * \r\n * // Verify the UC method was called correctly\r\n * expect(spy).toHaveBeenCalledWith('expected value');\r\n * ```\r\n */\r\n\r\nimport { AppObject } from \"../../AppObject\";\r\nimport { EditExampleStringUC } from \"../UCs/EditExampleStringUC\";\r\n\r\n/**\r\n * Mock implementation of EditExampleStringUC for testing\r\n * Provides a no-op implementation of editExampleString that can be spied on in tests\r\n */\r\nexport class MockEditExampleStringUC extends EditExampleStringUC {\r\n  /**\r\n   * Mock implementation that does nothing\r\n   * In tests, this can be replaced with a Jest spy to track calls\r\n   */\r\n  editExampleString = (text: string): void => {};\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, EditExampleStringUC.type);\r\n  }\r\n}\r\n"]}

package/dist/esm/ExampleFeature/Mocks/MockExamplePM.js

@@ -0,0 +1,44 @@
+/**
+ * MockExamplePM.ts
+ *
+ * This file demonstrates how to implement a mock PM for testing.
+ * Mock PMs extend the real PM classes but override their methods with test implementations.
+ * This allows tests to verify PM behavior without depending on real entities.
+ *
+ * Key concepts:
+ * - Mock PMs extend the real PM classes
+ * - They override methods with test implementations
+ * - They're used in unit tests to isolate components from their dependencies
+ * - They help test adapters and other components that use PMs
+ *
+ * Usage pattern (in tests):
+ * ```typescript
+ * // In a test file
+ * const mockPM = new MockExamplePM(appObject);
+ * const addViewSpy = jest.spyOn(mockPM, 'addView');
+ *
+ * // Test the component that uses the PM
+ * adapter.subscribe(id, appObjects, setVM);
+ *
+ * // Verify the PM method was called correctly
+ * expect(addViewSpy).toHaveBeenCalledWith(setVM);
+ * ```
+ */
+import { ExamplePM } from "../PMs/ExamplePM";
+/**
+ * Mock implementation of ExamplePM for testing
+ * Provides simplified implementations of required methods
+ */
+export class MockExamplePM extends ExamplePM {
+    constructor(appObject) {
+        super(appObject, ExamplePM.type);
+        /**
+         * Simplified implementation that always returns true
+         * This avoids the need to implement real comparison logic in tests
+         */
+        this.vmsAreEqual = () => {
+            return true;
+        };
+    }
+}
+//# sourceMappingURL=MockExamplePM.js.map

package/dist/esm/ExampleFeature/Mocks/MockExamplePM.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockExamplePM.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Mocks/MockExamplePM.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;IAS1C,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QATnC;;;WAGG;QACH,gBAAW,GAAG,GAAG,EAAE;YACjB,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;IAIF,CAAC;CACF","sourcesContent":["/**\r\n * MockExamplePM.ts\r\n * \r\n * This file demonstrates how to implement a mock PM for testing.\r\n * Mock PMs extend the real PM classes but override their methods with test implementations.\r\n * This allows tests to verify PM behavior without depending on real entities.\r\n * \r\n * Key concepts:\r\n * - Mock PMs extend the real PM classes\r\n * - They override methods with test implementations\r\n * - They're used in unit tests to isolate components from their dependencies\r\n * - They help test adapters and other components that use PMs\r\n * \r\n * Usage pattern (in tests):\r\n * ```typescript\r\n * // In a test file\r\n * const mockPM = new MockExamplePM(appObject);\r\n * const addViewSpy = jest.spyOn(mockPM, 'addView');\r\n * \r\n * // Test the component that uses the PM\r\n * adapter.subscribe(id, appObjects, setVM);\r\n * \r\n * // Verify the PM method was called correctly\r\n * expect(addViewSpy).toHaveBeenCalledWith(setVM);\r\n * ```\r\n */\r\n\r\nimport { AppObject } from \"../../AppObject\";\r\nimport { ExamplePM } from \"../PMs/ExamplePM\";\r\n\r\n/**\r\n * Mock implementation of ExamplePM for testing\r\n * Provides simplified implementations of required methods\r\n */\r\nexport class MockExamplePM extends ExamplePM {\r\n  /**\r\n   * Simplified implementation that always returns true\r\n   * This avoids the need to implement real comparison logic in tests\r\n   */\r\n  vmsAreEqual = () => {\r\n    return true;\r\n  };\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ExamplePM.type);\r\n  }\r\n}\r\n"]}

package/dist/esm/ExampleFeature/Mocks/MockExampleSingletonPM.js

@@ -0,0 +1,54 @@
+/**
+ * MockExampleSingletonPM.ts
+ *
+ * This file demonstrates how to implement a mock singleton PM for testing.
+ * Mock singleton PMs extend the real singleton PM classes and provide helper
+ * functions to create and access them in tests.
+ *
+ * Key concepts:
+ * - Mock singleton PMs extend the real singleton PM classes
+ * - They override methods with test implementations
+ * - They include helper functions to create and access them in tests
+ * - They're used to test adapters and controllers that depend on singleton PMs
+ *
+ * Usage pattern (in tests):
+ * ```typescript
+ * // In a test file
+ * const mockPM = makeMockExampleSingletonPM(appObjects);
+ * const addViewSpy = jest.spyOn(mockPM, 'addView');
+ *
+ * // Test the component that uses the singleton PM
+ * adapter.subscribe(appObjects, setVM);
+ *
+ * // Verify the PM method was called correctly
+ * expect(addViewSpy).toHaveBeenCalledWith(setVM);
+ * ```
+ */
+import { ExampleSingletonPM } from "../PMs/ExampleSingletonPM";
+/**
+ * Mock implementation of ExampleSingletonPM for testing
+ * Provides simplified implementations of required methods
+ */
+export class MockExampleSingletonPM extends ExampleSingletonPM {
+    constructor(appObject) {
+        super(appObject, ExampleSingletonPM.type);
+        /**
+         * Simplified implementation that always returns true
+         * This avoids the need to implement real comparison logic in tests
+         */
+        this.vmsAreEqual = () => {
+            return true;
+        };
+    }
+}
+/**
+ * Helper function to create and register a MockExampleSingletonPM
+ * Returns the created mock for use in tests
+ *
+ * @param appObjects The AppObjectRepo to register the mock with
+ * @returns A new MockExampleSingletonPM instance
+ */
+export function makeMockExampleSingletonPM(appObjects) {
+    return new MockExampleSingletonPM(appObjects.getOrCreate("MockExampleSingletonPM"));
+}
+//# sourceMappingURL=MockExampleSingletonPM.js.map

package/dist/esm/ExampleFeature/Mocks/MockExampleSingletonPM.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockExampleSingletonPM.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Mocks/MockExampleSingletonPM.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,kBAAkB;IAS5D,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAT5C;;;WAGG;QACH,gBAAW,GAAG,GAAG,EAAE;YACjB,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;IAIF,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CAAC,UAAyB;IAClE,OAAO,IAAI,sBAAsB,CAC/B,UAAU,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACjD,CAAC;AACJ,CAAC","sourcesContent":["/**\r\n * MockExampleSingletonPM.ts\r\n * \r\n * This file demonstrates how to implement a mock singleton PM for testing.\r\n * Mock singleton PMs extend the real singleton PM classes and provide helper\r\n * functions to create and access them in tests.\r\n * \r\n * Key concepts:\r\n * - Mock singleton PMs extend the real singleton PM classes\r\n * - They override methods with test implementations\r\n * - They include helper functions to create and access them in tests\r\n * - They're used to test adapters and controllers that depend on singleton PMs\r\n * \r\n * Usage pattern (in tests):\r\n * ```typescript\r\n * // In a test file\r\n * const mockPM = makeMockExampleSingletonPM(appObjects);\r\n * const addViewSpy = jest.spyOn(mockPM, 'addView');\r\n * \r\n * // Test the component that uses the singleton PM\r\n * adapter.subscribe(appObjects, setVM);\r\n * \r\n * // Verify the PM method was called correctly\r\n * expect(addViewSpy).toHaveBeenCalledWith(setVM);\r\n * ```\r\n */\r\n\r\nimport { AppObject, AppObjectRepo } from \"../../AppObject\";\r\nimport { ExampleSingletonPM } from \"../PMs/ExampleSingletonPM\";\r\n\r\n/**\r\n * Mock implementation of ExampleSingletonPM for testing\r\n * Provides simplified implementations of required methods\r\n */\r\nexport class MockExampleSingletonPM extends ExampleSingletonPM {\r\n  /**\r\n   * Simplified implementation that always returns true\r\n   * This avoids the need to implement real comparison logic in tests\r\n   */\r\n  vmsAreEqual = () => {\r\n    return true;\r\n  };\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ExampleSingletonPM.type);\r\n  }\r\n}\r\n\r\n/**\r\n * Helper function to create and register a MockExampleSingletonPM\r\n * Returns the created mock for use in tests\r\n * \r\n * @param appObjects The AppObjectRepo to register the mock with\r\n * @returns A new MockExampleSingletonPM instance\r\n */\r\nexport function makeMockExampleSingletonPM(appObjects: AppObjectRepo) {\r\n  return new MockExampleSingletonPM(\r\n    appObjects.getOrCreate(\"MockExampleSingletonPM\")\r\n  );\r\n}\r\n"]}

package/dist/esm/ExampleFeature/Mocks/MockToggleExampleBooleanUC.js

@@ -0,0 +1,52 @@
+/**
+ * MockToggleExampleBooleanUC.ts
+ *
+ * This file demonstrates how to implement a mock singleton UC for testing.
+ * Mock singleton UCs extend the real UC classes and provide helper functions
+ * to create and register them as singletons for tests.
+ *
+ * Key concepts:
+ * - Mock singleton UCs extend the real UC classes
+ * - They override methods with test implementations
+ * - They register themselves as singletons just like the real UCs
+ * - They include helper functions to create them in tests
+ *
+ * Usage pattern (in tests):
+ * ```typescript
+ * // In a test file
+ * const mockUC = makeMockToggleExampleBooleanUC(appObject);
+ * const spy = jest.spyOn(mockUC, 'toggleExampleBoolean');
+ *
+ * // Call the function that should use the UC
+ * toggleExampleBoolean(appObjects);
+ *
+ * // Verify the UC method was called correctly
+ * expect(spy).toHaveBeenCalled();
+ * ```
+ */
+import { ToggleExampleBooleanUC } from "../UCs/ToggleExampleBooleanUC";
+/**
+ * Mock implementation of ToggleExampleBooleanUC for testing
+ * Provides a no-op implementation of toggleExampleBoolean that can be spied on in tests
+ */
+export class MockToggleExampleBooleanUC extends ToggleExampleBooleanUC {
+    constructor(appObject) {
+        super(appObject, ToggleExampleBooleanUC.type);
+        /**
+         * Mock implementation that does nothing
+         * In tests, this can be replaced with a Jest spy to track calls
+         */
+        this.toggleExampleBoolean = () => { };
+        // Register as a singleton just like the real UC
+        this.appObjects.registerSingleton(this);
+    }
+}
+/**
+ * Helper factory function to create a mock ToggleExampleBooleanUC
+ * @param appObject The AppObject to attach the UC to
+ * @returns A new MockToggleExampleBooleanUC instance
+ */
+export function makeMockToggleExampleBooleanUC(appObject) {
+    return new MockToggleExampleBooleanUC(appObject);
+}
+//# sourceMappingURL=MockToggleExampleBooleanUC.js.map

package/dist/esm/ExampleFeature/Mocks/MockToggleExampleBooleanUC.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockToggleExampleBooleanUC.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Mocks/MockToggleExampleBooleanUC.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAGH,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAEvE;;;GAGG;AACH,MAAM,OAAO,0BAA2B,SAAQ,sBAAsB;IAOpE,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAPhD;;;WAGG;QACH,yBAAoB,GAAG,GAAS,EAAE,GAAE,CAAC,CAAC;QAIpC,gDAAgD;QAChD,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAC5C,SAAoB;IAEpB,OAAO,IAAI,0BAA0B,CAAC,SAAS,CAAC,CAAC;AACnD,CAAC","sourcesContent":["/**\r\n * MockToggleExampleBooleanUC.ts\r\n * \r\n * This file demonstrates how to implement a mock singleton UC for testing.\r\n * Mock singleton UCs extend the real UC classes and provide helper functions\r\n * to create and register them as singletons for tests.\r\n * \r\n * Key concepts:\r\n * - Mock singleton UCs extend the real UC classes\r\n * - They override methods with test implementations\r\n * - They register themselves as singletons just like the real UCs\r\n * - They include helper functions to create them in tests\r\n * \r\n * Usage pattern (in tests):\r\n * ```typescript\r\n * // In a test file\r\n * const mockUC = makeMockToggleExampleBooleanUC(appObject);\r\n * const spy = jest.spyOn(mockUC, 'toggleExampleBoolean');\r\n * \r\n * // Call the function that should use the UC\r\n * toggleExampleBoolean(appObjects);\r\n * \r\n * // Verify the UC method was called correctly\r\n * expect(spy).toHaveBeenCalled();\r\n * ```\r\n */\r\n\r\nimport { AppObject } from \"../../AppObject\";\r\nimport { ToggleExampleBooleanUC } from \"../UCs/ToggleExampleBooleanUC\";\r\n\r\n/**\r\n * Mock implementation of ToggleExampleBooleanUC for testing\r\n * Provides a no-op implementation of toggleExampleBoolean that can be spied on in tests\r\n */\r\nexport class MockToggleExampleBooleanUC extends ToggleExampleBooleanUC {\r\n  /**\r\n   * Mock implementation that does nothing\r\n   * In tests, this can be replaced with a Jest spy to track calls\r\n   */\r\n  toggleExampleBoolean = (): void => {};\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ToggleExampleBooleanUC.type);\r\n    // Register as a singleton just like the real UC\r\n    this.appObjects.registerSingleton(this);\r\n  }\r\n}\r\n\r\n/**\r\n * Helper factory function to create a mock ToggleExampleBooleanUC\r\n * @param appObject The AppObject to attach the UC to\r\n * @returns A new MockToggleExampleBooleanUC instance\r\n */\r\nexport function makeMockToggleExampleBooleanUC(\r\n  appObject: AppObject\r\n): MockToggleExampleBooleanUC {\r\n  return new MockToggleExampleBooleanUC(appObject);\r\n}\r\n"]}

package/dist/esm/ExampleFeature/Mocks/index.js

@@ -0,0 +1,5 @@
+export * from "./MockEditExampleStringUC";
+export * from "./MockExamplePM";
+export * from "./MockExampleSingletonPM";
+export * from "./MockToggleExampleBooleanUC";
+//# sourceMappingURL=index.js.map

package/dist/esm/ExampleFeature/Mocks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Mocks/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC","sourcesContent":["export * from \"./MockEditExampleStringUC\";\r\nexport * from \"./MockExamplePM\";\r\nexport * from \"./MockExampleSingletonPM\";\r\nexport * from \"./MockToggleExampleBooleanUC\";\r\n"]}

package/dist/esm/ExampleFeature/PMs/ExamplePM.js

@@ -0,0 +1,92 @@
+/**
+ * ExamplePM.ts
+ *
+ * This file demonstrates how to implement a Presentation Manager (PM) component.
+ * PMs are responsible for transforming entity data into view models (VMs) for the UI.
+ * They observe entities for changes and update their views when data changes.
+ *
+ * Key concepts:
+ * - PMs extend AppObjectPM<VM> where VM is the view model type
+ * - They observe entities and transform entity data into view models
+ * - They notify UI components (views) when view models change
+ * - Each PM instance is associated with a specific AppObject
+ *
+ * Usage pattern:
+ * 1. Get a PM instance using getById
+ * 2. Register UI components as views using addView(callback)
+ * 3. PM will call the view callbacks with updated view models when entities change
+ * 4. Remove UI components with removeView(callback) when they're unmounted
+ */
+import { AppObjectPM } from "../../AppObject";
+import { ExampleEntity } from "../Entities/ExampleEntity";
+/**
+ * ExamplePM transforms ExampleEntity data into a simple string view model.
+ * Abstract class provides the interface and static helper methods.
+ */
+export class ExamplePM extends AppObjectPM {
+    /**
+     * Retrieves an ExamplePM by its parent AppObject's ID
+     * @param id The ID of the parent AppObject
+     * @param appObjects The AppObjectRepo to search in
+     * @returns The ExamplePM component or undefined if not found
+     */
+    static getById(id, appObjects) {
+        return appObjects.get(id)?.getComponent(ExamplePM.type);
+    }
+}
+/** Unique type identifier for this component */
+ExamplePM.type = "ExamplePMType";
+/**
+ * Factory function to create a new ExamplePM
+ * @param appObject The AppObject to attach the PM to
+ * @returns A new ExamplePM instance
+ */
+export function makeExamplePM(appObject) {
+    return new ExamplePMImp(appObject);
+}
+/**
+ * Concrete implementation of ExamplePM
+ * This private class handles the actual implementation details
+ */
+class ExamplePMImp extends ExamplePM {
+    /**
+     * Gets the ExampleEntity from the same AppObject
+     * Uses getCachedLocalComponent for efficient repeated access
+     */
+    get exampleEntity() {
+        return this.getCachedLocalComponent(ExampleEntity.type);
+    }
+    /**
+     * Compares two view models to determine if they're equal
+     * Used to avoid unnecessary view updates when values haven't changed
+     */
+    vmsAreEqual(a, b) {
+        return a === b;
+    }
+    constructor(appObject) {
+        super(appObject, ExamplePM.type);
+        /**
+         * Handler for entity change events
+         * Transforms entity data into a view model and updates views
+         */
+        this.onEntityChange = () => {
+            if (!this.exampleEntity)
+                return;
+            // In this simple case, our view model is just the string property value
+            this.doUpdateView(this.exampleEntity.aStringProperty);
+        };
+        /**
+         * Cleanup method called when the PM is being disposed
+         * Removes any observers to prevent memory leaks
+         */
+        this.dispose = () => {
+            super.dispose();
+            this.exampleEntity?.removeChangeObserver(this.onEntityChange);
+        };
+        // Register as an observer of the entity to receive change notifications
+        this.exampleEntity?.addChangeObserver(this.onEntityChange);
+        // Call the change handler initially to set up the initial view model
+        this.onEntityChange();
+    }
+}
+//# sourceMappingURL=ExamplePM.js.map

package/dist/esm/ExampleFeature/PMs/ExamplePM.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExamplePM.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/PMs/ExamplePM.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAa,WAAW,EAAiB,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D;;;GAGG;AACH,MAAM,OAAgB,SAAU,SAAQ,WAAmB;IAIzD;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,EAAU,EAAE,UAAyB;QAClD,OAAO,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,YAAY,CAAY,SAAS,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC;;AAXD,gDAAgD;AAChC,cAAI,GAAG,eAAe,CAAC;AAazC;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,SAAoB;IAChD,OAAO,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;AACrC,CAAC;AAED;;;GAGG;AACH,MAAM,YAAa,SAAQ,SAAS;IAClC;;;OAGG;IACH,IAAY,aAAa;QACvB,OAAO,IAAI,CAAC,uBAAuB,CAAgB,aAAa,CAAC,IAAI,CAAC,CAAC;IACzE,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,CAAS,EAAE,CAAS;QAC9B,OAAO,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAsBD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QArBnC;;;WAGG;QACH,mBAAc,GAAG,GAAG,EAAE;YACpB,IAAI,CAAC,IAAI,CAAC,aAAa;gBAAE,OAAO;YAEhC,wEAAwE;YACxE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QACxD,CAAC,CAAC;QAEF;;;WAGG;QACH,YAAO,GAAG,GAAS,EAAE;YACnB,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,IAAI,CAAC,aAAa,EAAE,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAChE,CAAC,CAAC;QAKA,wEAAwE;QACxE,IAAI,CAAC,aAAa,EAAE,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAE3D,qEAAqE;QACrE,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;CACF","sourcesContent":["/**\r\n * ExamplePM.ts\r\n * \r\n * This file demonstrates how to implement a Presentation Manager (PM) component.\r\n * PMs are responsible for transforming entity data into view models (VMs) for the UI.\r\n * They observe entities for changes and update their views when data changes.\r\n * \r\n * Key concepts:\r\n * - PMs extend AppObjectPM<VM> where VM is the view model type\r\n * - They observe entities and transform entity data into view models\r\n * - They notify UI components (views) when view models change\r\n * - Each PM instance is associated with a specific AppObject\r\n * \r\n * Usage pattern:\r\n * 1. Get a PM instance using getById\r\n * 2. Register UI components as views using addView(callback)\r\n * 3. PM will call the view callbacks with updated view models when entities change\r\n * 4. Remove UI components with removeView(callback) when they're unmounted\r\n */\r\n\r\nimport { AppObject, AppObjectPM, AppObjectRepo } from \"../../AppObject\";\r\nimport { ExampleEntity } from \"../Entities/ExampleEntity\";\r\n\r\n/**\r\n * ExamplePM transforms ExampleEntity data into a simple string view model.\r\n * Abstract class provides the interface and static helper methods.\r\n */\r\nexport abstract class ExamplePM extends AppObjectPM<string> {\r\n  /** Unique type identifier for this component */\r\n  static readonly type = \"ExamplePMType\";\r\n\r\n  /**\r\n   * Retrieves an ExamplePM by its parent AppObject's ID\r\n   * @param id The ID of the parent AppObject\r\n   * @param appObjects The AppObjectRepo to search in\r\n   * @returns The ExamplePM component or undefined if not found\r\n   */\r\n  static getById(id: string, appObjects: AppObjectRepo) {\r\n    return appObjects.get(id)?.getComponent<ExamplePM>(ExamplePM.type);\r\n  }\r\n}\r\n\r\n/**\r\n * Factory function to create a new ExamplePM\r\n * @param appObject The AppObject to attach the PM to\r\n * @returns A new ExamplePM instance\r\n */\r\nexport function makeExamplePM(appObject: AppObject): ExamplePM {\r\n  return new ExamplePMImp(appObject);\r\n}\r\n\r\n/**\r\n * Concrete implementation of ExamplePM\r\n * This private class handles the actual implementation details\r\n */\r\nclass ExamplePMImp extends ExamplePM {\r\n  /**\r\n   * Gets the ExampleEntity from the same AppObject\r\n   * Uses getCachedLocalComponent for efficient repeated access\r\n   */\r\n  private get exampleEntity() {\r\n    return this.getCachedLocalComponent<ExampleEntity>(ExampleEntity.type);\r\n  }\r\n\r\n  /**\r\n   * Compares two view models to determine if they're equal\r\n   * Used to avoid unnecessary view updates when values haven't changed\r\n   */\r\n  vmsAreEqual(a: string, b: string): boolean {\r\n    return a === b;\r\n  }\r\n\r\n  /**\r\n   * Handler for entity change events\r\n   * Transforms entity data into a view model and updates views\r\n   */\r\n  onEntityChange = () => {\r\n    if (!this.exampleEntity) return;\r\n\r\n    // In this simple case, our view model is just the string property value\r\n    this.doUpdateView(this.exampleEntity.aStringProperty);\r\n  };\r\n\r\n  /**\r\n   * Cleanup method called when the PM is being disposed\r\n   * Removes any observers to prevent memory leaks\r\n   */\r\n  dispose = (): void => {\r\n    super.dispose();\r\n    this.exampleEntity?.removeChangeObserver(this.onEntityChange);\r\n  };\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ExamplePM.type);\r\n\r\n    // Register as an observer of the entity to receive change notifications\r\n    this.exampleEntity?.addChangeObserver(this.onEntityChange);\r\n    \r\n    // Call the change handler initially to set up the initial view model\r\n    this.onEntityChange();\r\n  }\r\n}\r\n"]}