@vived/core 1.4.3 → 1.4.4

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

@@ -0,0 +1,87 @@
+"use strict";
+/**
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EditExampleStringUC = void 0;
+exports.makeEditSlideTextUC = makeEditSlideTextUC;
+const AppObject_1 = require("../../AppObject");
+const ExampleEntity_1 = require("../Entities/ExampleEntity");
+/**
+ * EditExampleStringUC provides functionality to update the string property of an ExampleEntity.
+ * Abstract class provides the interface and static helper methods.
+ */
+class EditExampleStringUC extends AppObject_1.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);
+    }
+}
+exports.EditExampleStringUC = EditExampleStringUC;
+/** 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
+ */
+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_1.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/cjs/ExampleFeature/UCs/EditExampleStringUC.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditExampleStringUC.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/UCs/EditExampleStringUC.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;AA+CH,kDAEC;AA/CD,+CAAwE;AACxE,6DAA0D;AAE1D;;;GAGG;AACH,MAAsB,mBAAoB,SAAQ,uBAAW;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;;AA9BH,kDA+BC;AA9BC,gDAAgD;AAChC,wBAAI,GAAG,yBAAyB,CAAC;AA+BnD;;;;GAIG;AACH,SAAgB,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,6BAAa,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/cjs/ExampleFeature/UCs/ToggleExampleBooleanUC.js

@@ -0,0 +1,79 @@
+"use strict";
+/**
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToggleExampleBooleanUC = void 0;
+exports.makeToggleExampleBooleanUC = makeToggleExampleBooleanUC;
+const AppObject_1 = require("../../AppObject");
+const getSingletonComponent_1 = require("../../AppObject/getSingletonComponent");
+const ExampleSingletonEntity_1 = require("../Entities/ExampleSingletonEntity");
+/**
+ * ToggleExampleBooleanUC provides functionality to toggle the boolean property
+ * of the SingletonEntityExample. As a singleton, only one instance exists in the application.
+ */
+class ToggleExampleBooleanUC extends AppObject_1.AppObjectUC {
+}
+exports.ToggleExampleBooleanUC = ToggleExampleBooleanUC;
+/** 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) => (0, getSingletonComponent_1.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
+ */
+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(ExampleSingletonEntity_1.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/cjs/ExampleFeature/UCs/ToggleExampleBooleanUC.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToggleExampleBooleanUC.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/UCs/ToggleExampleBooleanUC.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;AAuCH,gEAIC;AAzCD,+CAIyB;AACzB,iFAA8E;AAC9E,+EAA4E;AAE5E;;;GAGG;AACH,MAAsB,sBAAuB,SAAQ,uBAAW;;AAAhE,wDAkBC;AAjBC,gDAAgD;AAChC,2BAAI,GAAG,4BAA4B,CAAC;AAOpD;;;;GAIG;AACI,0BAAG,GAAG,CACX,UAAyB,EACW,EAAE,CACtC,IAAA,6CAAqB,EAAC,sBAAsB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAGnE;;;;GAIG;AACH,SAAgB,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,+CAAsB,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/cjs/ExampleFeature/UCs/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("./EditExampleStringUC"), exports);
+__exportStar(require("./ToggleExampleBooleanUC"), exports);
+//# sourceMappingURL=index.js.map

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

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

package/dist/cjs/ExampleFeature/index.js

@@ -0,0 +1,24 @@
+"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("./Adapters"), exports);
+__exportStar(require("./Controllers"), exports);
+__exportStar(require("./Entities"), exports);
+__exportStar(require("./Factory"), exports);
+__exportStar(require("./Mocks"), exports);
+__exportStar(require("./PMs"), exports);
+__exportStar(require("./UCs"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ExampleFeature/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,gDAA8B;AAC9B,6CAA2B;AAC3B,4CAA0B;AAC1B,0CAAwB;AACxB,wCAAsB;AACtB,wCAAsB","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/cjs/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AppObject"), exports);
 __exportStar(require("./Entities"), exports);
+__exportStar(require("./ExampleFeature"), exports);
 __exportStar(require("./Types"), exports);
 __exportStar(require("./Utilities"), exports);
 __exportStar(require("./ValueObjects"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,6CAA2B;AAC3B,0CAAwB;AACxB,8CAA4B;AAC5B,iDAA+B","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,8CAA4B;AAC5B,6CAA2B;AAC3B,mDAAgC;AAChC,0CAAwB;AACxB,8CAA4B;AAC5B,iDAA+B","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/esm/ExampleFeature/Adapters/examplePmAdapter.js

@@ -0,0 +1,61 @@
+/**
+ * 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 { ExamplePM } from "../PMs/ExamplePM";
+/**
+ * An adapter that connects UI components to ExamplePM instances.
+ * Implements PmAdapter<string> because ExamplePM provides string view models.
+ */
+export const 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.getById(id, appObjects);
+        if (!pm) {
+            appObjects.submitError("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.getById(id, appObjects)?.removeView(setVM);
+    }
+};
+//# sourceMappingURL=examplePmAdapter.js.map

package/dist/esm/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,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C;;;GAGG;AACH,MAAM,CAAC,MAAM,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,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,CAAC;YACvE,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,SAAS,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.submitError(\"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/esm/ExampleFeature/Adapters/exampleSingletonPmAdapter.js

@@ -0,0 +1,57 @@
+/**
+ * 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 { defaultSlideNavigationVM, ExampleSingletonPM } from "../PMs/ExampleSingletonPM";
+/**
+ * An adapter that connects UI components to the ExampleSingletonPM.
+ * Implements SingletonPmAdapter<ExampleVM> because ExampleSingletonPM provides ExampleVM view models.
+ */
+export const exampleSingletonPmAdapter = {
+    // Default view model to use before data is available
+    defaultVM: 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.get(appObjects);
+        if (!pm) {
+            appObjects.submitError("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.get(appObjects)?.removeView(setVM);
+    }
+};
+//# sourceMappingURL=exampleSingletonPmAdapter.js.map

package/dist/esm/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,OAAO,EACL,wBAAwB,EACxB,kBAAkB,EAEnB,MAAM,2BAA2B,CAAC;AAEnC;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAkC;IACtE,qDAAqD;IACrD,SAAS,EAAE,wBAAwB;IAEnC;;;;OAIG;IACH,SAAS,EAAE,CAAC,UAAyB,EAAE,KAA8B,EAAE,EAAE;QACvE,oDAAoD;QACpD,MAAM,EAAE,GAAG,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CACpB,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,kBAAkB,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.submitError(\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/esm/ExampleFeature/Adapters/index.js

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

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

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

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

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

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

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

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

@@ -0,0 +1,45 @@
+/**
+ * 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 { EditExampleStringUC } from "../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
+ */
+export function setExampleText(text, id, appObjects) {
+    // Find the Use Case using the provided ID
+    const uc = 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/esm/ExampleFeature/Controllers/setExampleText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setExampleText.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Controllers/setExampleText.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEjE;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC5B,IAAY,EACZ,EAAU,EACV,UAAyB;IAEzB,0CAA0C;IAC1C,MAAM,EAAE,GAAG,mBAAmB,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/esm/ExampleFeature/Controllers/toggleExampleBoolean.js

@@ -0,0 +1,44 @@
+/**
+ * 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 { ToggleExampleBooleanUC } from "../UCs/ToggleExampleBooleanUC";
+/**
+ * Controller function to toggle the boolean property of the SingletonEntityExample
+ *
+ * @param appObjects The application's AppObjectRepo
+ */
+export function toggleExampleBoolean(appObjects) {
+    // Access the singleton UC using its static get method
+    const uc = 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/esm/ExampleFeature/Controllers/toggleExampleBoolean.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toggleExampleBoolean.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Controllers/toggleExampleBoolean.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAGH,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAEvE;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,UAAyB;IAC5D,sDAAsD;IACtD,MAAM,EAAE,GAAG,sBAAsB,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/esm/ExampleFeature/Entities/ExampleEntity.js

@@ -0,0 +1,85 @@
+/**
+ * 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 { AppObjectEntity } from "../../AppObject";
+import { MemoizedString } from "../../Entities/MemoizedString";
+/**
+ * ExampleEntity represents a basic entity with a string property.
+ * Abstract class provides the interface and static helper methods.
+ */
+export class ExampleEntity extends 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);
+        }
+    }
+}
+/** 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
+ */
+export 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("", this.notifyOnChange);
+    }
+}
+//# sourceMappingURL=ExampleEntity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleEntity.js","sourceRoot":"","sources":["../../../../src/ExampleFeature/Entities/ExampleEntity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAEL,eAAe,EAEhB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAE/D;;;GAGG;AACH,MAAM,OAAgB,aAAc,SAAQ,eAAe;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;;AAzCD,gDAAgD;AAChC,kBAAI,GAAG,mBAAmB,CAAC;AA2C7C;;;;GAIG;AACH,MAAM,UAAU,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,cAAc,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"]}