@vived/core 1.4.3 → 1.4.5

package/README.md

@@ -55,7 +55,29 @@ The architecture implements a clean separation of concerns through specialized c
    - UI representation components
    - Consumes view models and renders UI
 
-## Example Usage
+## Example Implementation
+
+The package includes a fully implemented `ExampleFeature` that demonstrates the App Object Component architecture. This example demonstrates how to structure your code following the recommended patterns:
+
+### Directory Structure
+- **Entities/** - Domain models for storing and managing state
+- **PMs/** - Presentation Managers that transform data for UI consumption
+- **UCs/** - Use Cases that implement business logic operations
+- **Controllers/** - Simplified API for UI interaction
+- **Adapters/** - Connect UI frameworks to PMs
+- **Mocks/** - Test doubles for unit testing
+
+### Implementation Patterns
+The example demonstrates:
+- Observable entities with memoized properties
+- Presentation managers with view model transformation
+- Use cases that implement business logic
+- Controllers that provide a simple UI-friendly API
+- Component registration and retrieval
+- Singleton component access
+- Test patterns for each component type
+
+### Sample Usage
 
 ```typescript
 // Create a repository and an app object
@@ -93,6 +115,8 @@ class MyPM extends AppObjectPM<{value: number}> {
 // The architecture enables clean, testable, and maintainable code
 ```
 
+Refer to the `ExampleFeature` directory for a complete implementation example that shows the interaction between all component types.
+
 ## Value Objects
 
 The package provides immutable value objects for mathematical and graphical operations:

package/dist/cjs/ExampleFeature/Adapters/examplePmAdapter.js

@@ -0,0 +1,64 @@
+"use strict";
+/**
+ * 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>;
+ * }
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.examplePmAdapter = void 0;
+const ExamplePM_1 = require("../PMs/ExamplePM");
+/**
+ * An adapter that connects UI components to ExamplePM instances.
+ * Implements PmAdapter<string> because ExamplePM provides string view models.
+ */
+exports.examplePmAdapter = {
+    // Default view model to use before data is available
+    defaultVM: "",
+    /**
+     * Subscribes a UI component to updates from an ExamplePM
+     * @param id The ID of the AppObject containing the PM
+     * @param appObjects The application's AppObjectRepo
+     * @param setVM Callback function that updates the UI component
+     */
+    subscribe: (id, appObjects, setVM) => {
+        // Return early if no ID is provided
+        if (!id)
+            return;
+        // Find the PM using the provided ID
+        const pm = ExamplePM_1.ExamplePM.getById(id, appObjects);
+        if (!pm) {
+            appObjects.submitWarning("examplePmAdapter", "Unable to find ExamplePM");
+            return;
+        }
+        // Register the UI component's callback to receive updates
+        pm.addView(setVM);
+    },
+    /**
+     * Unsubscribes a UI component from updates when it's no longer needed
+     * @param id The ID of the AppObject containing the PM
+     * @param appObjects The application's AppObjectRepo
+     * @param setVM The same callback function that was used to subscribe
+     */
+    unsubscribe: (id, appObjects, setVM) => {
+        // Find the PM and remove the view if it exists
+        ExamplePM_1.ExamplePM.getById(id, appObjects)?.removeView(setVM);
+    }
+};
+//# sourceMappingURL=examplePmAdapter.js.map

package/dist/cjs/ExampleFeature/Adapters/examplePmAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"examplePmAdapter.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Adapters/examplePmAdapter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;AAIH,gDAA6C;AAE7C;;;GAGG;AACU,QAAA,gBAAgB,GAAsB;IACjD,qDAAqD;IACrD,SAAS,EAAE,EAAE;IAEb;;;;;OAKG;IACH,SAAS,EAAE,CACT,EAAU,EACV,UAAyB,EACzB,KAA2B,EAC3B,EAAE;QACF,oCAAoC;QACpC,IAAI,CAAC,EAAE;YAAE,OAAO;QAEhB,oCAAoC;QACpC,MAAM,EAAE,GAAG,qBAAS,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,aAAa,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,CAAC;YACzE,OAAO;QACT,CAAC;QAED,0DAA0D;QAC1D,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,WAAW,EAAE,CACX,EAAU,EACV,UAAyB,EACzB,KAA2B,EAC3B,EAAE;QACF,+CAA+C;QAC/C,qBAAS,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;CACF,CAAC","sourcesContent":["/**\r\n * examplePmAdapter.ts\r\n * \r\n * This file demonstrates how to implement a PM Adapter to connect UI components to PMs.\r\n * PM Adapters provide a standardized way for UI frameworks to subscribe to PM updates.\r\n * This adapter connects to regular (non-singleton) PMs that require an AppObject ID.\r\n * \r\n * Key concepts:\r\n * - PM Adapters implement the PmAdapter<VM> interface where VM is the view model type\r\n * - They handle subscribing UI components to PMs and unsubscribing when done\r\n * - They provide a default view model for initial rendering before data is available\r\n * - They abstract away the details of finding and connecting to specific PMs\r\n * \r\n * Usage pattern (React example):\r\n * ```typescript\r\n * // In a React component\r\n * function MyComponent({ id }) {\r\n *   const viewModel = usePmAdapter(examplePmAdapter, id);\r\n *   return <div>{viewModel}</div>;\r\n * }\r\n * ```\r\n */\r\n\r\nimport { AppObjectRepo } from \"../../AppObject\";\r\nimport { PmAdapter } from \"../../Types/PmAdapter\";\r\nimport { ExamplePM } from \"../PMs/ExamplePM\";\r\n\r\n/**\r\n * An adapter that connects UI components to ExamplePM instances.\r\n * Implements PmAdapter<string> because ExamplePM provides string view models.\r\n */\r\nexport const examplePmAdapter: PmAdapter<string> = {\r\n  // Default view model to use before data is available\r\n  defaultVM: \"\",\r\n  \r\n  /**\r\n   * Subscribes a UI component to updates from an ExamplePM\r\n   * @param id The ID of the AppObject containing the PM\r\n   * @param appObjects The application's AppObjectRepo\r\n   * @param setVM Callback function that updates the UI component\r\n   */\r\n  subscribe: (\r\n    id: string,\r\n    appObjects: AppObjectRepo,\r\n    setVM: (vm: string) => void\r\n  ) => {\r\n    // Return early if no ID is provided\r\n    if (!id) return;\r\n\r\n    // Find the PM using the provided ID\r\n    const pm = ExamplePM.getById(id, appObjects);\r\n    if (!pm) {\r\n      appObjects.submitWarning(\"examplePmAdapter\", \"Unable to find ExamplePM\");\r\n      return;\r\n    }\r\n    \r\n    // Register the UI component's callback to receive updates\r\n    pm.addView(setVM);\r\n  },\r\n  \r\n  /**\r\n   * Unsubscribes a UI component from updates when it's no longer needed\r\n   * @param id The ID of the AppObject containing the PM\r\n   * @param appObjects The application's AppObjectRepo\r\n   * @param setVM The same callback function that was used to subscribe\r\n   */\r\n  unsubscribe: (\r\n    id: string,\r\n    appObjects: AppObjectRepo,\r\n    setVM: (vm: string) => void\r\n  ) => {\r\n    // Find the PM and remove the view if it exists\r\n    ExamplePM.getById(id, appObjects)?.removeView(setVM);\r\n  }\r\n};\r\n"]}

package/dist/cjs/ExampleFeature/Adapters/exampleSingletonPmAdapter.js

@@ -0,0 +1,60 @@
+"use strict";
+/**
+ * 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>;
+ * }
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exampleSingletonPmAdapter = void 0;
+const ExampleSingletonPM_1 = require("../PMs/ExampleSingletonPM");
+/**
+ * An adapter that connects UI components to the ExampleSingletonPM.
+ * Implements SingletonPmAdapter<ExampleVM> because ExampleSingletonPM provides ExampleVM view models.
+ */
+exports.exampleSingletonPmAdapter = {
+    // Default view model to use before data is available
+    defaultVM: ExampleSingletonPM_1.defaultSlideNavigationVM,
+    /**
+     * Subscribes a UI component to updates from the ExampleSingletonPM
+     * @param appObjects The application's AppObjectRepo
+     * @param setVM Callback function that updates the UI component
+     */
+    subscribe: (appObjects, setVM) => {
+        // Find the singleton PM using its static get method
+        const pm = ExampleSingletonPM_1.ExampleSingletonPM.get(appObjects);
+        if (!pm) {
+            appObjects.submitWarning("exampleSingletonPmAdapter", "Unable to find ExampleSingletonPM");
+            return;
+        }
+        // Register the UI component's callback to receive updates
+        pm.addView(setVM);
+    },
+    /**
+     * Unsubscribes a UI component from updates when it's no longer needed
+     * @param appObjects The application's AppObjectRepo
+     * @param setVM The same callback function that was used to subscribe
+     */
+    unsubscribe: (appObjects, setVM) => {
+        // Find the singleton PM and remove the view if it exists
+        ExampleSingletonPM_1.ExampleSingletonPM.get(appObjects)?.removeView(setVM);
+    }
+};
+//# sourceMappingURL=exampleSingletonPmAdapter.js.map

package/dist/cjs/ExampleFeature/Adapters/exampleSingletonPmAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exampleSingletonPmAdapter.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Adapters/exampleSingletonPmAdapter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;AAIH,kEAImC;AAEnC;;;GAGG;AACU,QAAA,yBAAyB,GAAkC;IACtE,qDAAqD;IACrD,SAAS,EAAE,6CAAwB;IAEnC;;;;OAIG;IACH,SAAS,EAAE,CAAC,UAAyB,EAAE,KAA8B,EAAE,EAAE;QACvE,oDAAoD;QACpD,MAAM,EAAE,GAAG,uCAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,aAAa,CACtB,2BAA2B,EAC3B,mCAAmC,CACpC,CAAC;YACF,OAAO;QACT,CAAC;QAED,0DAA0D;QAC1D,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,WAAW,EAAE,CAAC,UAAyB,EAAE,KAA8B,EAAE,EAAE;QACzE,yDAAyD;QACzD,uCAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;CACF,CAAC","sourcesContent":["/**\r\n * exampleSingletonPmAdapter.ts\r\n * \r\n * This file demonstrates how to implement a Singleton PM Adapter to connect UI components\r\n * to singleton PMs. Singleton PM Adapters provide a standardized way for UI frameworks\r\n * to subscribe to singleton PM updates without needing to specify an AppObject ID.\r\n * \r\n * Key concepts:\r\n * - Singleton PM Adapters implement the SingletonPmAdapter<VM> interface\r\n * - They handle subscribing UI components to singleton PMs and unsubscribing when done\r\n * - They provide a default view model for initial rendering before data is available\r\n * - They don't require an AppObject ID since they connect to globally accessible singletons\r\n * \r\n * Usage pattern (React example):\r\n * ```typescript\r\n * // In a React component\r\n * function MyComponent() {\r\n *   // Note: no ID needed since it's connecting to a singleton\r\n *   const viewModel = useSingletonPmAdapter(exampleSingletonPmAdapter);\r\n *   return <div>{viewModel.aBoolProperty ? \"True\" : \"False\"}</div>;\r\n * }\r\n * ```\r\n */\r\n\r\nimport { AppObjectRepo } from \"../../AppObject\";\r\nimport { SingletonPmAdapter } from \"../../Types/SingletonPmAdapter\";\r\nimport {\r\n  defaultSlideNavigationVM,\r\n  ExampleSingletonPM,\r\n  ExampleVM\r\n} from \"../PMs/ExampleSingletonPM\";\r\n\r\n/**\r\n * An adapter that connects UI components to the ExampleSingletonPM.\r\n * Implements SingletonPmAdapter<ExampleVM> because ExampleSingletonPM provides ExampleVM view models.\r\n */\r\nexport const exampleSingletonPmAdapter: SingletonPmAdapter<ExampleVM> = {\r\n  // Default view model to use before data is available\r\n  defaultVM: defaultSlideNavigationVM,\r\n  \r\n  /**\r\n   * Subscribes a UI component to updates from the ExampleSingletonPM\r\n   * @param appObjects The application's AppObjectRepo\r\n   * @param setVM Callback function that updates the UI component\r\n   */\r\n  subscribe: (appObjects: AppObjectRepo, setVM: (vm: ExampleVM) => void) => {\r\n    // Find the singleton PM using its static get method\r\n    const pm = ExampleSingletonPM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitWarning(\r\n        \"exampleSingletonPmAdapter\",\r\n        \"Unable to find ExampleSingletonPM\"\r\n      );\r\n      return;\r\n    }\r\n    \r\n    // Register the UI component's callback to receive updates\r\n    pm.addView(setVM);\r\n  },\r\n  \r\n  /**\r\n   * Unsubscribes a UI component from updates when it's no longer needed\r\n   * @param appObjects The application's AppObjectRepo\r\n   * @param setVM The same callback function that was used to subscribe\r\n   */\r\n  unsubscribe: (appObjects: AppObjectRepo, setVM: (vm: ExampleVM) => void) => {\r\n    // Find the singleton PM and remove the view if it exists\r\n    ExampleSingletonPM.get(appObjects)?.removeView(setVM);\r\n  }\r\n};\r\n"]}

package/dist/cjs/ExampleFeature/Adapters/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./examplePmAdapter"), exports);
+__exportStar(require("./exampleSingletonPmAdapter"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/ExampleFeature/Adapters/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Adapters/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,8DAA4C","sourcesContent":["export * from \"./examplePmAdapter\";\r\nexport * from \"./exampleSingletonPmAdapter\";\r\n"]}

package/dist/cjs/ExampleFeature/Controllers/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./setExampleText"), exports);
+__exportStar(require("./toggleExampleBoolean"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/ExampleFeature/Controllers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Controllers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,yDAAuC","sourcesContent":["export * from \"./setExampleText\";\r\nexport * from \"./toggleExampleBoolean\";\r\n"]}

package/dist/cjs/ExampleFeature/Controllers/setExampleText.js

@@ -0,0 +1,48 @@
+"use strict";
+/**
+ * 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} />;
+ * }
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setExampleText = setExampleText;
+const EditExampleStringUC_1 = require("../UCs/EditExampleStringUC");
+/**
+ * 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
+ */
+function setExampleText(text, id, appObjects) {
+    // Find the Use Case using the provided ID
+    const uc = EditExampleStringUC_1.EditExampleStringUC.getById(id, appObjects);
+    // Handle the case where the UC doesn't exist
+    if (!uc) {
+        appObjects.submitWarning("setExampleText", "Unable to find EditExampleStringUC");
+        return;
+    }
+    // Call the UC method to perform the operation
+    uc.editExampleString(text);
+}
+//# sourceMappingURL=setExampleText.js.map

package/dist/cjs/ExampleFeature/Controllers/setExampleText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setExampleText.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Controllers/setExampleText.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;;AAYH,wCAmBC;AA5BD,oEAAiE;AAEjE;;;;;;GAMG;AACH,SAAgB,cAAc,CAC5B,IAAY,EACZ,EAAU,EACV,UAAyB;IAEzB,0CAA0C;IAC1C,MAAM,EAAE,GAAG,yCAAmB,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IAEvD,6CAA6C;IAC7C,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,UAAU,CAAC,aAAa,CACtB,gBAAgB,EAChB,oCAAoC,CACrC,CAAC;QACF,OAAO;IACT,CAAC;IAED,8CAA8C;IAC9C,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC","sourcesContent":["/**\r\n * setExampleText.ts\r\n * \r\n * This file demonstrates how to implement a Controller function.\r\n * Controllers are simple functions that provide a simplified API for UI components\r\n * to interact with Use Cases (UCs). They handle the details of finding the right\r\n * UC and calling its methods with the appropriate parameters.\r\n * \r\n * Key concepts:\r\n * - Controllers are functions that take parameters from UI components\r\n * - They find the appropriate UC and call its methods\r\n * - They handle error cases and provide appropriate feedback\r\n * - They simplify the API for UI components\r\n * \r\n * Usage pattern (React example):\r\n * ```typescript\r\n * // In a React component\r\n * function ExampleTextInput({ id, appObjects }) {\r\n *   const handleChange = (e) => {\r\n *     setExampleText(e.target.value, id, appObjects);\r\n *   };\r\n *   return <input onChange={handleChange} />;\r\n * }\r\n * ```\r\n */\r\n\r\nimport { AppObjectRepo } from \"../../AppObject\";\r\nimport { EditExampleStringUC } from \"../UCs/EditExampleStringUC\";\r\n\r\n/**\r\n * Controller function to update the text of an ExampleEntity\r\n * \r\n * @param text The new text to set\r\n * @param id The ID of the AppObject containing the EditExampleStringUC\r\n * @param appObjects The application's AppObjectRepo\r\n */\r\nexport function setExampleText(\r\n  text: string,\r\n  id: string,\r\n  appObjects: AppObjectRepo\r\n) {\r\n  // Find the Use Case using the provided ID\r\n  const uc = EditExampleStringUC.getById(id, appObjects);\r\n  \r\n  // Handle the case where the UC doesn't exist\r\n  if (!uc) {\r\n    appObjects.submitWarning(\r\n      \"setExampleText\",\r\n      \"Unable to find EditExampleStringUC\"\r\n    );\r\n    return;\r\n  }\r\n\r\n  // Call the UC method to perform the operation\r\n  uc.editExampleString(text);\r\n}\r\n"]}

package/dist/cjs/ExampleFeature/Controllers/toggleExampleBoolean.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * 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>
+ *   );
+ * }
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toggleExampleBoolean = toggleExampleBoolean;
+const ToggleExampleBooleanUC_1 = require("../UCs/ToggleExampleBooleanUC");
+/**
+ * Controller function to toggle the boolean property of the SingletonEntityExample
+ *
+ * @param appObjects The application's AppObjectRepo
+ */
+function toggleExampleBoolean(appObjects) {
+    // Access the singleton UC using its static get method
+    const uc = ToggleExampleBooleanUC_1.ToggleExampleBooleanUC.get(appObjects);
+    // Handle the case where the UC doesn't exist yet
+    if (!uc) {
+        appObjects.submitWarning("toggleExampleBoolean", "Unable to find ToggleExampleBooleanUC");
+        return;
+    }
+    // Call the UC method to perform the operation
+    uc.toggleExampleBoolean();
+}
+//# sourceMappingURL=toggleExampleBoolean.js.map

package/dist/cjs/ExampleFeature/Controllers/toggleExampleBoolean.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toggleExampleBoolean.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Controllers/toggleExampleBoolean.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;AAUH,oDAeC;AAtBD,0EAAuE;AAEvE;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,UAAyB;IAC5D,sDAAsD;IACtD,MAAM,EAAE,GAAG,+CAAsB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAElD,iDAAiD;IACjD,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,UAAU,CAAC,aAAa,CACtB,sBAAsB,EACtB,uCAAuC,CACxC,CAAC;QACF,OAAO;IACT,CAAC;IAED,8CAA8C;IAC9C,EAAE,CAAC,oBAAoB,EAAE,CAAC;AAC5B,CAAC","sourcesContent":["/**\r\n * toggleExampleBoolean.ts\r\n * \r\n * This file demonstrates how to implement a Controller function for a singleton UC.\r\n * This controller provides a simplified API for UI components to interact with \r\n * the ToggleExampleBooleanUC singleton, handling the details of finding the UC\r\n * and calling its method.\r\n * \r\n * Key concepts:\r\n * - Controllers for singleton UCs don't need an ID parameter\r\n * - They access the singleton UC using its static get() method\r\n * - They handle error cases and provide appropriate feedback\r\n * - They simplify the API for UI components\r\n * \r\n * Usage pattern (React example):\r\n * ```typescript\r\n * // In a React component\r\n * function ToggleButton({ appObjects }) {\r\n *   return (\r\n *     <button onClick={() => toggleExampleBoolean(appObjects)}>\r\n *       Toggle\r\n *     </button>\r\n *   );\r\n * }\r\n * ```\r\n */\r\n\r\nimport { AppObjectRepo } from \"../../AppObject\";\r\nimport { ToggleExampleBooleanUC } from \"../UCs/ToggleExampleBooleanUC\";\r\n\r\n/**\r\n * Controller function to toggle the boolean property of the SingletonEntityExample\r\n * \r\n * @param appObjects The application's AppObjectRepo\r\n */\r\nexport function toggleExampleBoolean(appObjects: AppObjectRepo) {\r\n  // Access the singleton UC using its static get method\r\n  const uc = ToggleExampleBooleanUC.get(appObjects);\r\n  \r\n  // Handle the case where the UC doesn't exist yet\r\n  if (!uc) {\r\n    appObjects.submitWarning(\r\n      \"toggleExampleBoolean\",\r\n      \"Unable to find ToggleExampleBooleanUC\"\r\n    );\r\n    return;\r\n  }\r\n\r\n  // Call the UC method to perform the operation\r\n  uc.toggleExampleBoolean();\r\n}\r\n"]}

package/dist/cjs/ExampleFeature/Entities/ExampleEntity.js

@@ -0,0 +1,90 @@
+"use strict";
+/**
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExampleEntity = void 0;
+exports.makeExampleEntity = makeExampleEntity;
+const AppObject_1 = require("../../AppObject");
+const MemoizedString_1 = require("../../Entities/MemoizedString");
+/**
+ * ExampleEntity represents a basic entity with a string property.
+ * Abstract class provides the interface and static helper methods.
+ */
+class ExampleEntity extends AppObject_1.AppObjectEntity {
+    /**
+     * 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) {
+        return appObj.getComponent(this.type);
+    }
+    /**
+     * 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, appObjects) {
+        return appObjects.get(id)?.getComponent(this.type);
+    }
+    /**
+     * 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) {
+        const existing = appObj.getComponent(this.type);
+        if (existing) {
+            return existing;
+        }
+        else {
+            return makeExampleEntity(appObj);
+        }
+    }
+}
+exports.ExampleEntity = ExampleEntity;
+/** Unique type identifier for this component */
+ExampleEntity.type = "ExampleEntityType";
+/**
+ * Factory function to create a new ExampleEntity
+ * @param appObject The AppObject to attach the entity to
+ * @returns A new ExampleEntity instance
+ */
+function makeExampleEntity(appObject) {
+    return new ExampleEntityImp(appObject);
+}
+/**
+ * Concrete implementation of ExampleEntity
+ * This private class handles the actual implementation details
+ */
+class ExampleEntityImp extends ExampleEntity {
+    // Property accessors that use the memoized value
+    get aStringProperty() {
+        return this.memoizedIsAuthoring.val;
+    }
+    set aStringProperty(val) {
+        this.memoizedIsAuthoring.val = val;
+    }
+    constructor(appObject) {
+        super(appObject, ExampleEntity.type);
+        // MemoizedString tracks changes to the string value and calls notifyOnChange when updated
+        this.memoizedIsAuthoring = new MemoizedString_1.MemoizedString("", this.notifyOnChange);
+    }
+}
+//# sourceMappingURL=ExampleEntity.js.map

package/dist/cjs/ExampleFeature/Entities/ExampleEntity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleEntity.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Entities/ExampleEntity.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;AA+DH,8CAIC;AAjED,+CAIyB;AACzB,kEAA+D;AAE/D;;;GAGG;AACH,MAAsB,aAAc,SAAQ,2BAAe;IAQzD;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,MAAiB;QAC1B,OAAO,MAAM,CAAC,YAAY,CAAgB,IAAI,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CACZ,EAAU,EACV,UAAyB;QAEzB,OAAO,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,YAAY,CAAgB,IAAI,CAAC,IAAI,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,MAAiB;QACnC,MAAM,QAAQ,GAAG,MAAM,CAAC,YAAY,CAAgB,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,QAAQ,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;;AA1CH,sCA2CC;AA1CC,gDAAgD;AAChC,kBAAI,GAAG,mBAAmB,CAAC;AA2C7C;;;;GAIG;AACH,SAAgB,iBAAiB,CAC/B,SAAoB;IAEpB,OAAO,IAAI,gBAAgB,CAAC,SAAS,CAAC,CAAC;AACzC,CAAC;AAED;;;GAGG;AACH,MAAM,gBAAiB,SAAQ,aAAa;IAI1C,iDAAiD;IACjD,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC;IACtC,CAAC;IAED,IAAI,eAAe,CAAC,GAAW;QAC7B,IAAI,CAAC,mBAAmB,CAAC,GAAG,GAAG,GAAG,CAAC;IACrC,CAAC;IAED,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;QAbvC,0FAA0F;QAClF,wBAAmB,GAAG,IAAI,+BAAc,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAa1E,CAAC;CACF","sourcesContent":["/**\r\n * ExampleEntity.ts\r\n * \r\n * This file demonstrates how to implement a standard (non-singleton) entity in the application.\r\n * Entities store and manage data, track state changes, and notify observers when changes occur.\r\n * \r\n * Key concepts:\r\n * - Entity classes extend AppObjectEntity\r\n * - They provide access to data properties\r\n * - They use Memoized types (MemoizedString, MemoizedBoolean, etc.) to track changes\r\n * - They notify observers when properties change\r\n * \r\n * Usage pattern:\r\n * 1. Get or create an entity instance using getById, get, or addIfMissing\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 { MemoizedString } from \"../../Entities/MemoizedString\";\r\n\r\n/**\r\n * ExampleEntity represents a basic entity with a string property.\r\n * Abstract class provides the interface and static helper methods.\r\n */\r\nexport abstract class ExampleEntity extends AppObjectEntity {\r\n  /** Unique type identifier for this component */\r\n  static readonly type = \"ExampleEntityType\";\r\n\r\n  /** String property accessor methods that must be implemented */\r\n  abstract get aStringProperty(): string;\r\n  abstract set aStringProperty(val: string);\r\n\r\n  /**\r\n   * Retrieves an ExampleEntity component from an AppObject\r\n   * @param appObj The AppObject to get the component from\r\n   * @returns The ExampleEntity component or undefined if not found\r\n   */\r\n  static get(appObj: AppObject): ExampleEntity | undefined {\r\n    return appObj.getComponent<ExampleEntity>(this.type);\r\n  }\r\n\r\n  /**\r\n   * Retrieves an ExampleEntity 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 ExampleEntity component or undefined if not found\r\n   */\r\n  static getById(\r\n    id: string,\r\n    appObjects: AppObjectRepo\r\n  ): ExampleEntity | undefined {\r\n    return appObjects.get(id)?.getComponent<ExampleEntity>(this.type);\r\n  }\r\n\r\n  /**\r\n   * Ensures an ExampleEntity exists on the AppObject, creating one if needed\r\n   * @param appObj The AppObject to check/add the component to\r\n   * @returns The existing or newly created ExampleEntity\r\n   */\r\n  static addIfMissing(appObj: AppObject): ExampleEntity {\r\n    const existing = appObj.getComponent<ExampleEntity>(this.type);\r\n    if (existing) {\r\n      return existing;\r\n    } else {\r\n      return makeExampleEntity(appObj);\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * Factory function to create a new ExampleEntity\r\n * @param appObject The AppObject to attach the entity to\r\n * @returns A new ExampleEntity instance\r\n */\r\nexport function makeExampleEntity(\r\n  appObject: AppObject\r\n): ExampleEntity {\r\n  return new ExampleEntityImp(appObject);\r\n}\r\n\r\n/**\r\n * Concrete implementation of ExampleEntity\r\n * This private class handles the actual implementation details\r\n */\r\nclass ExampleEntityImp extends ExampleEntity {\r\n  // MemoizedString tracks changes to the string value and calls notifyOnChange when updated\r\n  private memoizedIsAuthoring = new MemoizedString(\"\", this.notifyOnChange);\r\n  \r\n  // Property accessors that use the memoized value\r\n  get aStringProperty() {\r\n    return this.memoizedIsAuthoring.val;\r\n  }\r\n  \r\n  set aStringProperty(val: string) {\r\n    this.memoizedIsAuthoring.val = val;\r\n  }\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ExampleEntity.type);\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,113 @@
+"use strict";
+/**
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExampleRepo = void 0;
+exports.makeExampleRepo = makeExampleRepo;
+const AppObject_1 = require("../../AppObject");
+const generateUniqueID_1 = require("../../Utilities/generateUniqueID");
+const ExampleEntity_1 = require("./ExampleEntity");
+/**
+ * ExampleRepo manages a collection of ExampleEntity instances.
+ * Abstract class provides the interface and static helper methods.
+ */
+class ExampleRepo extends AppObject_1.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);
+        }
+    }
+}
+exports.ExampleRepo = ExampleRepo;
+/** 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
+ */
+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 ?? (0, generateUniqueID_1.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 (0, ExampleEntity_1.makeExampleEntity)(ao);
+        };
+    }
+}
+//# sourceMappingURL=ExampleRepo.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleRepo.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Entities/ExampleRepo.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;AAwEH,0CAEC;AAxED,+CAIyB;AACzB,uEAAoE;AACpE,mDAAmE;AAKnE;;;GAGG;AACH,MAAsB,WAAY,SAAQ,+BAAkC;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;;AA/CH,kCAgDC;AA/CC,gDAAgD;AAChC,gBAAI,GAAG,iBAAiB,CAAC;AAgD3C;;;;GAIG;AACH,SAAgB,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,IAAA,mCAAgB,GAAE,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,IAAA,iCAAiB,EAAC,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/cjs/ExampleFeature/Entities/ExampleSingletonEntity.js

@@ -0,0 +1,69 @@
+"use strict";
+/**
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SingletonEntityExample = void 0;
+exports.makeSingletonEntityExample = makeSingletonEntityExample;
+const AppObject_1 = require("../../AppObject");
+const getSingletonComponent_1 = require("../../AppObject/getSingletonComponent");
+const MemoizedBoolean_1 = require("../../Entities/MemoizedBoolean");
+/**
+ * SingletonEntityExample represents a global entity with a boolean property.
+ * As a singleton, only one instance exists in the application.
+ */
+class SingletonEntityExample extends AppObject_1.AppObjectEntity {
+}
+exports.SingletonEntityExample = SingletonEntityExample;
+/** 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) => (0, getSingletonComponent_1.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
+ */
+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_1.MemoizedBoolean(false, this.notifyOnChange);
+        // Register this entity as a singleton so it can be accessed globally
+        this.appObjects.registerSingleton(this);
+    }
+}
+//# sourceMappingURL=ExampleSingletonEntity.js.map