@vived/core 1.4.3 → 1.4.5

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

@@ -0,0 +1,97 @@
+/**
+ * ExampleSingletonPM.ts
+ *
+ * This file demonstrates how to implement a Singleton Presentation Manager (PM).
+ * Singleton PMs are special PMs that exist only once in the application and can be
+ * accessed globally. They transform data from singleton entities into view models.
+ *
+ * Key concepts:
+ * - Singleton PMs extend AppObjectPM<VM> like regular PMs
+ * - They register themselves as singletons with appObjects.registerSingleton()
+ * - They're accessed through a static get() method using getSingletonComponent()
+ * - They typically observe singleton entities and provide data to multiple UI components
+ *
+ * Usage pattern:
+ * 1. Access the singleton PM using the static get() method
+ * 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 { getSingletonComponent } from "../../AppObject/getSingletonComponent";
+import { SingletonEntityExample } from "../Entities/ExampleSingletonEntity";
+/**
+ * ExampleSingletonPM transforms SingletonEntityExample data into an ExampleVM.
+ * As a singleton, only one instance exists in the application.
+ */
+export class ExampleSingletonPM extends AppObjectPM {
+}
+/** Unique type identifier for this component */
+ExampleSingletonPM.type = "ExampleSingletonPMType";
+/**
+ * Global accessor for the singleton PM
+ * @param appObjects The AppObjectRepo to search in
+ * @returns The singleton PM or undefined if not created yet
+ */
+ExampleSingletonPM.get = (appObjects) => getSingletonComponent(ExampleSingletonPM.type, appObjects);
+/**
+ * Default view model used when no data is available
+ * UI components can use this initially or when the PM is not found
+ */
+export const defaultSlideNavigationVM = {
+    aBoolProperty: true
+};
+/**
+ * Factory function to create a new ExampleSingletonPM
+ * @param appObject The AppObject to attach the PM to
+ * @returns A new ExampleSingletonPM instance
+ */
+export function makeExampleSingletonPM(appObject) {
+    return new ExampleSingletonPMImp(appObject);
+}
+/**
+ * Concrete implementation of ExampleSingletonPM
+ * This private class handles the actual implementation details
+ */
+class ExampleSingletonPMImp extends ExampleSingletonPM {
+    /**
+     * Gets the SingletonEntityExample from the application
+     * Uses getCachedSingleton for efficient repeated access
+     */
+    get exampleEntity() {
+        return this.getCachedSingleton(SingletonEntityExample.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) {
+        if (a.aBoolProperty !== b.aBoolProperty)
+            return false;
+        return true;
+    }
+    constructor(appObject) {
+        super(appObject, ExampleSingletonPM.type);
+        /**
+         * Handler for entity change events
+         * Transforms entity data into a view model and updates views
+         */
+        this.onEntityChange = () => {
+            if (!this.exampleEntity)
+                return;
+            // Extract the boolean property from the entity
+            const aBoolProperty = this.exampleEntity.aBoolProperty;
+            // Create a view model with the extracted data
+            const vm = { aBoolProperty };
+            // Update all registered views with the new view model
+            this.doUpdateView(vm);
+        };
+        // 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();
+        // Register this PM as a singleton so it can be accessed globally
+        this.appObjects.registerSingleton(this);
+    }
+}
+//# sourceMappingURL=ExampleSingletonPM.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleSingletonPM.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/PMs/ExampleSingletonPM.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAEL,WAAW,GAEZ,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAS5E;;;GAGG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,WAAsB;;AACrE,gDAAgD;AAChC,uBAAI,GAAG,wBAAwB,CAAC;AAEhD;;;;GAIG;AACI,sBAAG,GAAG,CAAC,UAAyB,EAAkC,EAAE,CACzE,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAG/D;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAc;IACjD,aAAa,EAAE,IAAI;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,SAAoB;IAEpB,OAAO,IAAI,qBAAqB,CAAC,SAAS,CAAC,CAAC;AAC9C,CAAC;AAED;;;GAGG;AACH,MAAM,qBAAsB,SAAQ,kBAAkB;IACpD;;;OAGG;IACH,IAAY,aAAa;QACvB,OAAO,IAAI,CAAC,kBAAkB,CAC5B,sBAAsB,CAAC,IAAI,CAC5B,CAAC;IACJ,CAAC;IAmBD;;;OAGG;IACH,WAAW,CAAC,CAAY,EAAE,CAAY;QACpC,IAAI,CAAC,CAAC,aAAa,KAAK,CAAC,CAAC,aAAa;YAAE,OAAO,KAAK,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;QA3B5C;;;WAGG;QACH,mBAAc,GAAG,GAAG,EAAE;YACpB,IAAI,CAAC,IAAI,CAAC,aAAa;gBAAE,OAAO;YAEhC,+CAA+C;YAC/C,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;YAEvD,8CAA8C;YAC9C,MAAM,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC;YAE7B,sDAAsD;YACtD,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACxB,CAAC,CAAC;QAcA,wEAAwE;QACxE,IAAI,CAAC,aAAa,EAAE,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAE3D,qEAAqE;QACrE,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,iEAAiE;QACjE,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["/**\r\n * ExampleSingletonPM.ts\r\n * \r\n * This file demonstrates how to implement a Singleton Presentation Manager (PM).\r\n * Singleton PMs are special PMs that exist only once in the application and can be\r\n * accessed globally. They transform data from singleton entities into view models.\r\n * \r\n * Key concepts:\r\n * - Singleton PMs extend AppObjectPM<VM> like regular PMs\r\n * - They register themselves as singletons with appObjects.registerSingleton()\r\n * - They're accessed through a static get() method using getSingletonComponent()\r\n * - They typically observe singleton entities and provide data to multiple UI components\r\n * \r\n * Usage pattern:\r\n * 1. Access the singleton PM using the static get() method\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 {\r\n  AppObject,\r\n  AppObjectPM,\r\n  AppObjectRepo,\r\n} from \"../../AppObject\";\r\nimport { getSingletonComponent } from \"../../AppObject/getSingletonComponent\";\r\nimport { SingletonEntityExample } from \"../Entities/ExampleSingletonEntity\";\r\n\r\n/**\r\n * Interface defining the structure of the view model provided by ExampleSingletonPM\r\n */\r\nexport interface ExampleVM {\r\n  aBoolProperty: boolean;\r\n}\r\n\r\n/**\r\n * ExampleSingletonPM transforms SingletonEntityExample data into an ExampleVM.\r\n * As a singleton, only one instance exists in the application.\r\n */\r\nexport abstract class ExampleSingletonPM extends AppObjectPM<ExampleVM> {\r\n  /** Unique type identifier for this component */\r\n  static readonly type = \"ExampleSingletonPMType\";\r\n\r\n  /**\r\n   * Global accessor for the singleton PM\r\n   * @param appObjects The AppObjectRepo to search in\r\n   * @returns The singleton PM or undefined if not created yet\r\n   */\r\n  static get = (appObjects: AppObjectRepo): ExampleSingletonPM | undefined =>\r\n    getSingletonComponent(ExampleSingletonPM.type, appObjects);\r\n}\r\n\r\n/**\r\n * Default view model used when no data is available\r\n * UI components can use this initially or when the PM is not found\r\n */\r\nexport const defaultSlideNavigationVM: ExampleVM = {\r\n  aBoolProperty: true\r\n};\r\n\r\n/**\r\n * Factory function to create a new ExampleSingletonPM\r\n * @param appObject The AppObject to attach the PM to\r\n * @returns A new ExampleSingletonPM instance\r\n */\r\nexport function makeExampleSingletonPM(\r\n  appObject: AppObject\r\n): ExampleSingletonPM {\r\n  return new ExampleSingletonPMImp(appObject);\r\n}\r\n\r\n/**\r\n * Concrete implementation of ExampleSingletonPM\r\n * This private class handles the actual implementation details\r\n */\r\nclass ExampleSingletonPMImp extends ExampleSingletonPM {\r\n  /**\r\n   * Gets the SingletonEntityExample from the application\r\n   * Uses getCachedSingleton for efficient repeated access\r\n   */\r\n  private get exampleEntity() {\r\n    return this.getCachedSingleton<SingletonEntityExample>(\r\n      SingletonEntityExample.type\r\n    );\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    // Extract the boolean property from the entity\r\n    const aBoolProperty = this.exampleEntity.aBoolProperty;\r\n\r\n    // Create a view model with the extracted data\r\n    const vm = { aBoolProperty };\r\n\r\n    // Update all registered views with the new view model\r\n    this.doUpdateView(vm);\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: ExampleVM, b: ExampleVM): boolean {\r\n    if (a.aBoolProperty !== b.aBoolProperty) return false;\r\n    return true;\r\n  }\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ExampleSingletonPM.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    // Register this PM 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/PMs/index.js

@@ -0,0 +1,3 @@
+export * from "./ExamplePM";
+export * from "./ExampleSingletonPM";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/PMs/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC","sourcesContent":["export * from \"./ExamplePM\";\r\nexport * from \"./ExampleSingletonPM\";\r\n"]}

package/dist/esm/ExampleFeature/UCs/EditExampleStringUC.js

@@ -0,0 +1,82 @@
+/**
+ * EditExampleStringUC.ts
+ *
+ * This file demonstrates how to implement a Use Case (UC) component.
+ * UCs handle business logic and operations that modify entities.
+ * They encapsulate specific actions that can be performed in the application.
+ *
+ * Key concepts:
+ * - UCs extend AppObjectUC and provide methods for specific operations
+ * - They implement business logic for modifying entities
+ * - They validate inputs and handle errors
+ * - Each UC instance is associated with a specific AppObject
+ *
+ * Usage pattern:
+ * 1. Get a UC instance using getById or get
+ * 2. Call the UC's methods to perform operations
+ * 3. The UC will update entities, which will trigger PM updates and UI refreshes
+ */
+import { AppObjectUC } from "../../AppObject";
+import { ExampleEntity } from "../Entities/ExampleEntity";
+/**
+ * EditExampleStringUC provides functionality to update the string property of an ExampleEntity.
+ * Abstract class provides the interface and static helper methods.
+ */
+export class EditExampleStringUC extends AppObjectUC {
+    /**
+     * Retrieves an EditExampleStringUC component from an AppObject
+     * @param appObj The AppObject to get the component from
+     * @returns The EditExampleStringUC component or undefined if not found
+     */
+    static get(appObj) {
+        return appObj.getComponent(this.type);
+    }
+    /**
+     * Retrieves an EditExampleStringUC by its parent AppObject's ID
+     * @param id The ID of the parent AppObject
+     * @param appObjects The AppObjectRepo to search in
+     * @returns The EditExampleStringUC component or undefined if not found
+     */
+    static getById(id, appObjects) {
+        return appObjects.get(id)?.getComponent(this.type);
+    }
+}
+/** Unique type identifier for this component */
+EditExampleStringUC.type = "EditExampleStringUCType";
+/**
+ * Factory function to create a new EditExampleStringUC
+ * @param appObject The AppObject to attach the UC to
+ * @returns A new EditExampleStringUC instance
+ */
+export function makeEditSlideTextUC(appObject) {
+    return new EditSlideTextUCImp(appObject);
+}
+/**
+ * Concrete implementation of EditExampleStringUC
+ * This private class handles the actual implementation details
+ */
+class EditSlideTextUCImp extends EditExampleStringUC {
+    /**
+     * Gets the ExampleEntity from the same AppObject
+     * Uses getCachedLocalComponent for efficient repeated access
+     */
+    get exampleEntity() {
+        return this.getCachedLocalComponent(ExampleEntity.type);
+    }
+    constructor(appObject) {
+        super(appObject, EditExampleStringUC.type);
+        /**
+         * Implements the editExampleString method to update the entity's string property
+         * @param text The new string value to set
+         */
+        this.editExampleString = (text) => {
+            if (!this.exampleEntity) {
+                this.warn("Unable to find AppState");
+                return;
+            }
+            // Update the entity property, which will trigger PM updates and UI refreshes
+            this.exampleEntity.aStringProperty = text;
+        };
+    }
+}
+//# sourceMappingURL=EditExampleStringUC.js.map

package/dist/esm/ExampleFeature/UCs/EditExampleStringUC.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditExampleStringUC.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/UCs/EditExampleStringUC.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAA4B,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D;;;GAGG;AACH,MAAM,OAAgB,mBAAoB,SAAQ,WAAW;IAU3D;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,MAAiB;QAC1B,OAAO,MAAM,CAAC,YAAY,CAAsB,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CACZ,EAAU,EACV,UAAyB;QAEzB,OAAO,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,YAAY,CAAsB,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC;;AA7BD,gDAAgD;AAChC,wBAAI,GAAG,yBAAyB,CAAC;AA+BnD;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,SAAoB;IACtD,OAAO,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;AAC3C,CAAC;AAED;;;GAGG;AACH,MAAM,kBAAmB,SAAQ,mBAAmB;IAClD;;;OAGG;IACH,IAAY,aAAa;QACvB,OAAO,IAAI,CAAC,uBAAuB,CAAgB,aAAa,CAAC,IAAI,CAAC,CAAC;IACzE,CAAC;IAgBD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAf7C;;;WAGG;QACH,sBAAiB,GAAG,CAAC,IAAY,EAAE,EAAE;YACnC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;gBACxB,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;gBACrC,OAAO;YACT,CAAC;YAED,6EAA6E;YAC7E,IAAI,CAAC,aAAa,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5C,CAAC,CAAC;IAIF,CAAC;CACF","sourcesContent":["/**\r\n * EditExampleStringUC.ts\r\n * \r\n * This file demonstrates how to implement a Use Case (UC) component.\r\n * UCs handle business logic and operations that modify entities.\r\n * They encapsulate specific actions that can be performed in the application.\r\n * \r\n * Key concepts:\r\n * - UCs extend AppObjectUC and provide methods for specific operations\r\n * - They implement business logic for modifying entities\r\n * - They validate inputs and handle errors\r\n * - Each UC instance is associated with a specific AppObject\r\n * \r\n * Usage pattern:\r\n * 1. Get a UC instance using getById or get\r\n * 2. Call the UC's methods to perform operations\r\n * 3. The UC will update entities, which will trigger PM updates and UI refreshes\r\n */\r\n\r\nimport { AppObject, AppObjectRepo, AppObjectUC } from \"../../AppObject\";\r\nimport { ExampleEntity } from \"../Entities/ExampleEntity\";\r\n\r\n/**\r\n * EditExampleStringUC provides functionality to update the string property of an ExampleEntity.\r\n * Abstract class provides the interface and static helper methods.\r\n */\r\nexport abstract class EditExampleStringUC extends AppObjectUC {\r\n  /** Unique type identifier for this component */\r\n  static readonly type = \"EditExampleStringUCType\";\r\n\r\n  /**\r\n   * Updates the string property of the associated ExampleEntity\r\n   * @param text The new string value to set\r\n   */\r\n  abstract editExampleString(text: string): void;\r\n\r\n  /**\r\n   * Retrieves an EditExampleStringUC component from an AppObject\r\n   * @param appObj The AppObject to get the component from\r\n   * @returns The EditExampleStringUC component or undefined if not found\r\n   */\r\n  static get(appObj: AppObject): EditExampleStringUC | undefined {\r\n    return appObj.getComponent<EditExampleStringUC>(this.type);\r\n  }\r\n\r\n  /**\r\n   * Retrieves an EditExampleStringUC 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 EditExampleStringUC component or undefined if not found\r\n   */\r\n  static getById(\r\n    id: string,\r\n    appObjects: AppObjectRepo\r\n  ): EditExampleStringUC | undefined {\r\n    return appObjects.get(id)?.getComponent<EditExampleStringUC>(this.type);\r\n  }\r\n}\r\n\r\n/**\r\n * Factory function to create a new EditExampleStringUC\r\n * @param appObject The AppObject to attach the UC to\r\n * @returns A new EditExampleStringUC instance\r\n */\r\nexport function makeEditSlideTextUC(appObject: AppObject): EditExampleStringUC {\r\n  return new EditSlideTextUCImp(appObject);\r\n}\r\n\r\n/**\r\n * Concrete implementation of EditExampleStringUC\r\n * This private class handles the actual implementation details\r\n */\r\nclass EditSlideTextUCImp extends EditExampleStringUC {\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   * Implements the editExampleString method to update the entity's string property\r\n   * @param text The new string value to set\r\n   */\r\n  editExampleString = (text: string) => {\r\n    if (!this.exampleEntity) {\r\n      this.warn(\"Unable to find AppState\");\r\n      return;\r\n    }\r\n\r\n    // Update the entity property, which will trigger PM updates and UI refreshes\r\n    this.exampleEntity.aStringProperty = text;\r\n  };\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, EditExampleStringUC.type);\r\n  }\r\n}\r\n"]}

package/dist/esm/ExampleFeature/UCs/ToggleExampleBooleanUC.js

@@ -0,0 +1,74 @@
+/**
+ * ToggleExampleBooleanUC.ts
+ *
+ * This file demonstrates how to implement a Singleton Use Case (UC) component.
+ * Singleton UCs are special UCs that exist only once in the application and can be
+ * accessed globally. They handle business logic and operations that modify singleton entities.
+ *
+ * Key concepts:
+ * - Singleton UCs extend AppObjectUC like regular UCs
+ * - They register themselves as singletons with appObjects.registerSingleton()
+ * - They're accessed through a static get() method using getSingletonComponent()
+ * - They typically operate on singleton entities
+ *
+ * Usage pattern:
+ * 1. Access the singleton UC using the static get() method
+ * 2. Call the UC's methods to perform operations
+ * 3. The UC will update entities, which will trigger PM updates and UI refreshes
+ */
+import { AppObjectUC } from "../../AppObject";
+import { getSingletonComponent } from "../../AppObject/getSingletonComponent";
+import { SingletonEntityExample } from "../Entities/ExampleSingletonEntity";
+/**
+ * ToggleExampleBooleanUC provides functionality to toggle the boolean property
+ * of the SingletonEntityExample. As a singleton, only one instance exists in the application.
+ */
+export class ToggleExampleBooleanUC extends AppObjectUC {
+}
+/** Unique type identifier for this component */
+ToggleExampleBooleanUC.type = "ToggleExampleBooleanUCType";
+/**
+ * Global accessor for the singleton UC
+ * @param appObjects The AppObjectRepo to search in
+ * @returns The singleton UC or undefined if not created yet
+ */
+ToggleExampleBooleanUC.get = (appObjects) => getSingletonComponent(ToggleExampleBooleanUC.type, appObjects);
+/**
+ * Factory function to create a new ToggleExampleBooleanUC
+ * @param appObject The AppObject to attach the UC to
+ * @returns A new ToggleExampleBooleanUC instance
+ */
+export function makeToggleExampleBooleanUC(appObject) {
+    return new ToggleExampleBooleanUCImp(appObject);
+}
+/**
+ * Concrete implementation of ToggleExampleBooleanUC
+ * This private class handles the actual implementation details
+ */
+class ToggleExampleBooleanUCImp extends ToggleExampleBooleanUC {
+    /**
+     * Gets the SingletonEntityExample from the application
+     * Uses getCachedSingleton for efficient repeated access
+     */
+    get singletonEntityExample() {
+        return this.getCachedSingleton(SingletonEntityExample.type);
+    }
+    constructor(appObject) {
+        super(appObject, ToggleExampleBooleanUC.type);
+        /**
+         * Implements the toggleExampleBoolean method to invert the entity's boolean property
+         */
+        this.toggleExampleBoolean = () => {
+            if (!this.singletonEntityExample) {
+                this.warn("Unable to find SingletonEntityExample");
+                return;
+            }
+            // Toggle the boolean property by inverting its current value
+            this.singletonEntityExample.aBoolProperty =
+                !this.singletonEntityExample?.aBoolProperty;
+        };
+        // Register this UC as a singleton so it can be accessed globally
+        this.appObjects.registerSingleton(this);
+    }
+}
+//# sourceMappingURL=ToggleExampleBooleanUC.js.map

package/dist/esm/ExampleFeature/UCs/ToggleExampleBooleanUC.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToggleExampleBooleanUC.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/UCs/ToggleExampleBooleanUC.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAGL,WAAW,EACZ,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAE5E;;;GAGG;AACH,MAAM,OAAgB,sBAAuB,SAAQ,WAAW;;AAC9D,gDAAgD;AAChC,2BAAI,GAAG,4BAA4B,CAAC;AAOpD;;;;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;IAC5D;;;OAGG;IACH,IAAY,sBAAsB;QAChC,OAAO,IAAI,CAAC,kBAAkB,CAC5B,sBAAsB,CAAC,IAAI,CAC5B,CAAC;IACJ,CAAC;IAgBD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAfhD;;WAEG;QACH,yBAAoB,GAAG,GAAG,EAAE;YAC1B,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBACjC,IAAI,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;gBACnD,OAAO;YACT,CAAC;YAED,6DAA6D;YAC7D,IAAI,CAAC,sBAAsB,CAAC,aAAa;gBACvC,CAAC,IAAI,CAAC,sBAAsB,EAAE,aAAa,CAAC;QAChD,CAAC,CAAC;QAIA,iEAAiE;QACjE,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["/**\r\n * ToggleExampleBooleanUC.ts\r\n * \r\n * This file demonstrates how to implement a Singleton Use Case (UC) component.\r\n * Singleton UCs are special UCs that exist only once in the application and can be\r\n * accessed globally. They handle business logic and operations that modify singleton entities.\r\n * \r\n * Key concepts:\r\n * - Singleton UCs extend AppObjectUC like regular UCs\r\n * - They register themselves as singletons with appObjects.registerSingleton()\r\n * - They're accessed through a static get() method using getSingletonComponent()\r\n * - They typically operate on singleton entities\r\n * \r\n * Usage pattern:\r\n * 1. Access the singleton UC using the static get() method\r\n * 2. Call the UC's methods to perform operations\r\n * 3. The UC will update entities, which will trigger PM updates and UI refreshes\r\n */\r\n\r\nimport {\r\n  AppObject,\r\n  AppObjectRepo,\r\n  AppObjectUC\r\n} from \"../../AppObject\";\r\nimport { getSingletonComponent } from \"../../AppObject/getSingletonComponent\";\r\nimport { SingletonEntityExample } from \"../Entities/ExampleSingletonEntity\";\r\n\r\n/**\r\n * ToggleExampleBooleanUC provides functionality to toggle the boolean property\r\n * of the SingletonEntityExample. As a singleton, only one instance exists in the application.\r\n */\r\nexport abstract class ToggleExampleBooleanUC extends AppObjectUC {\r\n  /** Unique type identifier for this component */\r\n  static readonly type = \"ToggleExampleBooleanUCType\";\r\n\r\n  /**\r\n   * Toggles the boolean property of the SingletonEntityExample\r\n   */\r\n  abstract toggleExampleBoolean(): void;\r\n\r\n  /**\r\n   * Global accessor for the singleton UC\r\n   * @param appObjects The AppObjectRepo to search in\r\n   * @returns The singleton UC or undefined if not created yet\r\n   */\r\n  static get = (\r\n    appObjects: AppObjectRepo\r\n  ): ToggleExampleBooleanUC | undefined =>\r\n    getSingletonComponent(ToggleExampleBooleanUC.type, appObjects);\r\n}\r\n\r\n/**\r\n * Factory function to create a new ToggleExampleBooleanUC\r\n * @param appObject The AppObject to attach the UC to\r\n * @returns A new ToggleExampleBooleanUC instance\r\n */\r\nexport function makeToggleExampleBooleanUC(\r\n  appObject: AppObject\r\n): ToggleExampleBooleanUC {\r\n  return new ToggleExampleBooleanUCImp(appObject);\r\n}\r\n\r\n/**\r\n * Concrete implementation of ToggleExampleBooleanUC\r\n * This private class handles the actual implementation details\r\n */\r\nclass ToggleExampleBooleanUCImp extends ToggleExampleBooleanUC {\r\n  /**\r\n   * Gets the SingletonEntityExample from the application\r\n   * Uses getCachedSingleton for efficient repeated access\r\n   */\r\n  private get singletonEntityExample() {\r\n    return this.getCachedSingleton<SingletonEntityExample>(\r\n      SingletonEntityExample.type\r\n    );\r\n  }\r\n\r\n  /**\r\n   * Implements the toggleExampleBoolean method to invert the entity's boolean property\r\n   */\r\n  toggleExampleBoolean = () => {\r\n    if (!this.singletonEntityExample) {\r\n      this.warn(\"Unable to find SingletonEntityExample\");\r\n      return;\r\n    }\r\n\r\n    // Toggle the boolean property by inverting its current value\r\n    this.singletonEntityExample.aBoolProperty =\r\n      !this.singletonEntityExample?.aBoolProperty;\r\n  };\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ToggleExampleBooleanUC.type);\r\n    // Register this UC 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/UCs/index.js

@@ -0,0 +1,3 @@
+export * from "./EditExampleStringUC";
+export * from "./ToggleExampleBooleanUC";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/UCs/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC","sourcesContent":["export * from \"./EditExampleStringUC\";\r\nexport * from \"./ToggleExampleBooleanUC\";\r\n"]}

package/dist/esm/ExampleFeature/index.js

@@ -0,0 +1,8 @@
+export * from "./Adapters";
+export * from "./Controllers";
+export * from "./Entities";
+export * from "./Factory";
+export * from "./Mocks";
+export * from "./PMs";
+export * from "./UCs";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ExampleFeature/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC","sourcesContent":["export * from \"./Adapters\";\r\nexport * from \"./Controllers\";\r\nexport * from \"./Entities\";\r\nexport * from \"./Factory\";\r\nexport * from \"./Mocks\";\r\nexport * from \"./PMs\";\r\nexport * from \"./UCs\";"]}

package/dist/esm/index.js

@@ -1,5 +1,6 @@
 export * from "./AppObject";
 export * from "./Entities";
+export * from "./ExampleFeature";
 export * from "./Types";
 export * from "./Utilities";
 export * from "./ValueObjects";

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC","sourcesContent":["export * from \"./AppObject\";\r\nexport * from \"./Entities\";\r\nexport * from \"./Types\";\r\nexport * from \"./Utilities\";\r\nexport * from \"./ValueObjects\";\r\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC","sourcesContent":["export * from \"./AppObject\";\r\nexport * from \"./Entities\";\r\nexport * from \"./ExampleFeature\"\r\nexport * from \"./Types\";\r\nexport * from \"./Utilities\";\r\nexport * from \"./ValueObjects\";\r\n"]}

package/dist/types/ExampleFeature/Adapters/examplePmAdapter.d.ts

@@ -0,0 +1,29 @@
+/**
+ * examplePmAdapter.ts
+ *
+ * This file demonstrates how to implement a PM Adapter to connect UI components to PMs.
+ * PM Adapters provide a standardized way for UI frameworks to subscribe to PM updates.
+ * This adapter connects to regular (non-singleton) PMs that require an AppObject ID.
+ *
+ * Key concepts:
+ * - PM Adapters implement the PmAdapter<VM> interface where VM is the view model type
+ * - They handle subscribing UI components to PMs and unsubscribing when done
+ * - They provide a default view model for initial rendering before data is available
+ * - They abstract away the details of finding and connecting to specific PMs
+ *
+ * Usage pattern (React example):
+ * ```typescript
+ * // In a React component
+ * function MyComponent({ id }) {
+ *   const viewModel = usePmAdapter(examplePmAdapter, id);
+ *   return <div>{viewModel}</div>;
+ * }
+ * ```
+ */
+import { PmAdapter } from "../../Types/PmAdapter";
+/**
+ * An adapter that connects UI components to ExamplePM instances.
+ * Implements PmAdapter<string> because ExamplePM provides string view models.
+ */
+export declare const examplePmAdapter: PmAdapter<string>;
+//# sourceMappingURL=examplePmAdapter.d.ts.map

package/dist/types/ExampleFeature/Adapters/examplePmAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"examplePmAdapter.d.ts","sourceRoot":"","sources":["../../../../src/ExampleFeature/Adapters/examplePmAdapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAGlD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAAS,CAAC,MAAM,CA2C9C,CAAC"}

package/dist/types/ExampleFeature/Adapters/exampleSingletonPmAdapter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * exampleSingletonPmAdapter.ts
+ *
+ * This file demonstrates how to implement a Singleton PM Adapter to connect UI components
+ * to singleton PMs. Singleton PM Adapters provide a standardized way for UI frameworks
+ * to subscribe to singleton PM updates without needing to specify an AppObject ID.
+ *
+ * Key concepts:
+ * - Singleton PM Adapters implement the SingletonPmAdapter<VM> interface
+ * - They handle subscribing UI components to singleton PMs and unsubscribing when done
+ * - They provide a default view model for initial rendering before data is available
+ * - They don't require an AppObject ID since they connect to globally accessible singletons
+ *
+ * Usage pattern (React example):
+ * ```typescript
+ * // In a React component
+ * function MyComponent() {
+ *   // Note: no ID needed since it's connecting to a singleton
+ *   const viewModel = useSingletonPmAdapter(exampleSingletonPmAdapter);
+ *   return <div>{viewModel.aBoolProperty ? "True" : "False"}</div>;
+ * }
+ * ```
+ */
+import { SingletonPmAdapter } from "../../Types/SingletonPmAdapter";
+import { ExampleVM } from "../PMs/ExampleSingletonPM";
+/**
+ * An adapter that connects UI components to the ExampleSingletonPM.
+ * Implements SingletonPmAdapter<ExampleVM> because ExampleSingletonPM provides ExampleVM view models.
+ */
+export declare const exampleSingletonPmAdapter: SingletonPmAdapter<ExampleVM>;
+//# sourceMappingURL=exampleSingletonPmAdapter.d.ts.map

package/dist/types/ExampleFeature/Adapters/exampleSingletonPmAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exampleSingletonPmAdapter.d.ts","sourceRoot":"","sources":["../../../../src/ExampleFeature/Adapters/exampleSingletonPmAdapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAGL,SAAS,EACV,MAAM,2BAA2B,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,kBAAkB,CAAC,SAAS,CAiCnE,CAAC"}

package/dist/types/ExampleFeature/Adapters/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./examplePmAdapter";
+export * from "./exampleSingletonPmAdapter";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/ExampleFeature/Adapters/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ExampleFeature/Adapters/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC"}

package/dist/types/ExampleFeature/Controllers/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./setExampleText";
+export * from "./toggleExampleBoolean";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/ExampleFeature/Controllers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ExampleFeature/Controllers/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC"}

package/dist/types/ExampleFeature/Controllers/setExampleText.d.ts

@@ -0,0 +1,35 @@
+/**
+ * setExampleText.ts
+ *
+ * This file demonstrates how to implement a Controller function.
+ * Controllers are simple functions that provide a simplified API for UI components
+ * to interact with Use Cases (UCs). They handle the details of finding the right
+ * UC and calling its methods with the appropriate parameters.
+ *
+ * Key concepts:
+ * - Controllers are functions that take parameters from UI components
+ * - They find the appropriate UC and call its methods
+ * - They handle error cases and provide appropriate feedback
+ * - They simplify the API for UI components
+ *
+ * Usage pattern (React example):
+ * ```typescript
+ * // In a React component
+ * function ExampleTextInput({ id, appObjects }) {
+ *   const handleChange = (e) => {
+ *     setExampleText(e.target.value, id, appObjects);
+ *   };
+ *   return <input onChange={handleChange} />;
+ * }
+ * ```
+ */
+import { AppObjectRepo } from "../../AppObject";
+/**
+ * Controller function to update the text of an ExampleEntity
+ *
+ * @param text The new text to set
+ * @param id The ID of the AppObject containing the EditExampleStringUC
+ * @param appObjects The application's AppObjectRepo
+ */
+export declare function setExampleText(text: string, id: string, appObjects: AppObjectRepo): void;
+//# sourceMappingURL=setExampleText.d.ts.map

package/dist/types/ExampleFeature/Controllers/setExampleText.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setExampleText.d.ts","sourceRoot":"","sources":["../../../../src/ExampleFeature/Controllers/setExampleText.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,aAAa,QAgB1B"}

package/dist/types/ExampleFeature/Controllers/toggleExampleBoolean.d.ts

@@ -0,0 +1,34 @@
+/**
+ * toggleExampleBoolean.ts
+ *
+ * This file demonstrates how to implement a Controller function for a singleton UC.
+ * This controller provides a simplified API for UI components to interact with
+ * the ToggleExampleBooleanUC singleton, handling the details of finding the UC
+ * and calling its method.
+ *
+ * Key concepts:
+ * - Controllers for singleton UCs don't need an ID parameter
+ * - They access the singleton UC using its static get() method
+ * - They handle error cases and provide appropriate feedback
+ * - They simplify the API for UI components
+ *
+ * Usage pattern (React example):
+ * ```typescript
+ * // In a React component
+ * function ToggleButton({ appObjects }) {
+ *   return (
+ *     <button onClick={() => toggleExampleBoolean(appObjects)}>
+ *       Toggle
+ *     </button>
+ *   );
+ * }
+ * ```
+ */
+import { AppObjectRepo } from "../../AppObject";
+/**
+ * Controller function to toggle the boolean property of the SingletonEntityExample
+ *
+ * @param appObjects The application's AppObjectRepo
+ */
+export declare function toggleExampleBoolean(appObjects: AppObjectRepo): void;
+//# sourceMappingURL=toggleExampleBoolean.d.ts.map

package/dist/types/ExampleFeature/Controllers/toggleExampleBoolean.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toggleExampleBoolean.d.ts","sourceRoot":"","sources":["../../../../src/ExampleFeature/Controllers/toggleExampleBoolean.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,aAAa,QAe7D"}

package/dist/types/ExampleFeature/Entities/ExampleEntity.d.ts

@@ -0,0 +1,55 @@
+/**
+ * ExampleEntity.ts
+ *
+ * This file demonstrates how to implement a standard (non-singleton) entity in the application.
+ * Entities store and manage data, track state changes, and notify observers when changes occur.
+ *
+ * Key concepts:
+ * - Entity classes extend AppObjectEntity
+ * - They provide access to data properties
+ * - They use Memoized types (MemoizedString, MemoizedBoolean, etc.) to track changes
+ * - They notify observers when properties change
+ *
+ * Usage pattern:
+ * 1. Get or create an entity instance using getById, get, or addIfMissing
+ * 2. Access or modify properties via getters/setters
+ * 3. Register change observers to react to property updates
+ */
+import { AppObject, AppObjectEntity, AppObjectRepo } from "../../AppObject";
+/**
+ * ExampleEntity represents a basic entity with a string property.
+ * Abstract class provides the interface and static helper methods.
+ */
+export declare abstract class ExampleEntity extends AppObjectEntity {
+    /** Unique type identifier for this component */
+    static readonly type = "ExampleEntityType";
+    /** String property accessor methods that must be implemented */
+    abstract get aStringProperty(): string;
+    abstract set aStringProperty(val: string);
+    /**
+     * Retrieves an ExampleEntity component from an AppObject
+     * @param appObj The AppObject to get the component from
+     * @returns The ExampleEntity component or undefined if not found
+     */
+    static get(appObj: AppObject): ExampleEntity | undefined;
+    /**
+     * Retrieves an ExampleEntity by its parent AppObject's ID
+     * @param id The ID of the parent AppObject
+     * @param appObjects The AppObjectRepo to search in
+     * @returns The ExampleEntity component or undefined if not found
+     */
+    static getById(id: string, appObjects: AppObjectRepo): ExampleEntity | undefined;
+    /**
+     * Ensures an ExampleEntity exists on the AppObject, creating one if needed
+     * @param appObj The AppObject to check/add the component to
+     * @returns The existing or newly created ExampleEntity
+     */
+    static addIfMissing(appObj: AppObject): ExampleEntity;
+}
+/**
+ * Factory function to create a new ExampleEntity
+ * @param appObject The AppObject to attach the entity to
+ * @returns A new ExampleEntity instance
+ */
+export declare function makeExampleEntity(appObject: AppObject): ExampleEntity;
+//# sourceMappingURL=ExampleEntity.d.ts.map

package/dist/types/ExampleFeature/Entities/ExampleEntity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleEntity.d.ts","sourceRoot":"","sources":["../../../../src/ExampleFeature/Entities/ExampleEntity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EACL,SAAS,EACT,eAAe,EACf,aAAa,EACd,MAAM,iBAAiB,CAAC;AAGzB;;;GAGG;AACH,8BAAsB,aAAc,SAAQ,eAAe;IACzD,gDAAgD;IAChD,MAAM,CAAC,QAAQ,CAAC,IAAI,uBAAuB;IAE3C,gEAAgE;IAChE,QAAQ,KAAK,eAAe,IAAI,MAAM,CAAC;IACvC,QAAQ,KAAK,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE;IAE1C;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,SAAS;IAIxD;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CACZ,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,aAAa,GACxB,aAAa,GAAG,SAAS;IAI5B;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,aAAa;CAQtD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,SAAS,GACnB,aAAa,CAEf"}

package/dist/types/ExampleFeature/Entities/ExampleRepo.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 { AppObject, AppObjectEntityRepo, AppObjectRepo } from "../../AppObject";
+import { ExampleEntity } from "./ExampleEntity";
+/** Type definition for a factory function that creates ExampleEntity instances */
+export type ExampleEntityFactory = (id: string) => ExampleEntity;
+/**
+ * ExampleRepo manages a collection of ExampleEntity instances.
+ * Abstract class provides the interface and static helper methods.
+ */
+export declare abstract class ExampleRepo extends AppObjectEntityRepo<ExampleEntity> {
+    /** Unique type identifier for this component */
+    static readonly type = "ExampleRepoType";
+    /** Factory function used to create new entities */
+    abstract exampleEntityFactory: ExampleEntityFactory;
+    /** Creates a new entity with an optional ID */
+    abstract createExampleEntity(id?: string): ExampleEntity;
+    /** Deletes an entity by its AppObject ID */
+    abstract deleteExampleEntity(id: string): void;
+    /**
+     * 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: AppObject): ExampleRepo | undefined;
+    /**
+     * 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: string, appObjects: AppObjectRepo): ExampleRepo | undefined;
+    /**
+     * 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: AppObject): ExampleRepo;
+}
+/**
+ * Factory function to create a new ExampleRepo
+ * @param appObject The AppObject to attach the repo to
+ * @returns A new ExampleRepo instance
+ */
+export declare function makeExampleRepo(appObject: AppObject): ExampleRepo;
+//# sourceMappingURL=ExampleRepo.d.ts.map

package/dist/types/ExampleFeature/Entities/ExampleRepo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleRepo.d.ts","sourceRoot":"","sources":["../../../../src/ExampleFeature/Entities/ExampleRepo.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EACL,SAAS,EACT,mBAAmB,EACnB,aAAa,EACd,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,aAAa,EAAqB,MAAM,iBAAiB,CAAC;AAEnE,kFAAkF;AAClF,MAAM,MAAM,oBAAoB,GAAG,CAAC,EAAE,EAAE,MAAM,KAAK,aAAa,CAAC;AAEjE;;;GAGG;AACH,8BAAsB,WAAY,SAAQ,mBAAmB,CAAC,aAAa,CAAC;IAC1E,gDAAgD;IAChD,MAAM,CAAC,QAAQ,CAAC,IAAI,qBAAqB;IAEzC,mDAAmD;IACnD,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IAEpD,+CAA+C;IAC/C,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,aAAa;IAExD,4CAA4C;IAC5C,QAAQ,CAAC,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAE9C;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,SAAS;IAItD;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CACZ,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,aAAa,GACxB,WAAW,GAAG,SAAS;IAI1B;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,WAAW;CAQvD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,WAAW,CAEjE"}