@vived/host 4.2.0 → 4.4.0

package/dist/cjs/ZSpaceHost/Entities/ZSpaceHost.js

@@ -4,16 +4,50 @@ exports.ZSpaceHostEntity = void 0;
 exports.makeZSpaceHostEntity = makeZSpaceHostEntity;
 const core_1 = require("@vived/core");
 const core_2 = require("@vived/core");
+/**
+ * ZSpaceHostEntity is a singleton entity that manages the state and functionality
+ * for zSpace integration in VIVED applications.
+ *
+ * This entity handles:
+ * 1. zSpace feature detection (isSupported)
+ * 2. Emulation mode toggling (emulate)
+ * 3. Active state management (isActive)
+ * 4. XR Session management
+ *
+ * Usage:
+ * - To check if zSpace is available: ZSpaceHostEntity.get(appObjects)?.isSupported
+ * - To check if zSpace is active: ZSpaceHostEntity.get(appObjects)?.isActive
+ * - To enable/disable emulation: ZSpaceHostEntity.get(appObjects).emulate = true/false
+ *
+ * Important: This is a singleton entity - only one instance exists in the application.
+ * Always access via ZSpaceHostEntity.get(appObjects) rather than creating new instances.
+ */
 class ZSpaceHostEntity extends core_2.AppObjectEntity {
+    /**
+     * Get the singleton ZSpaceHostEntity instance
+     * @param appObjects - The AppObjectRepo instance
+     * @returns The ZSpaceHostEntity instance or undefined if not found
+     */
     static get(appObjects) {
         return (0, core_2.getSingletonComponent)(ZSpaceHostEntity.type, appObjects);
     }
 }
 exports.ZSpaceHostEntity = ZSpaceHostEntity;
 ZSpaceHostEntity.type = "ZSpaceHostEntity";
+/**
+ * Factory function to create the ZSpaceHostEntity
+ * For internal use only - external code should use ZSpaceHostEntity.get()
+ *
+ * @param appObject - The AppObject to attach the entity to
+ * @returns A new ZSpaceHostEntity instance
+ */
 function makeZSpaceHostEntity(appObject) {
     return new ZSpaceHostImp(appObject);
 }
+/**
+ * Implementation of ZSpaceHostEntity
+ * Uses MemoizedBoolean for all properties to ensure proper change notifications
+ */
 class ZSpaceHostImp extends ZSpaceHostEntity {
     get isSupported() {
         return this.memoizedIsSupported.val;

package/dist/cjs/ZSpaceHost/Entities/ZSpaceHost.js.map

@@ -1 +1 @@
-{"version":3,"file":"ZSpaceHost.js","sourceRoot":"","sources":["../../../../src/ZSpaceHost/Entities/ZSpaceHost.ts"],"names":[],"mappings":";;;AA8BA,oDAEC;AAhCD,sCAA8C;AAC9C,sCAKqB;AAErB,MAAsB,gBAAiB,SAAQ,sBAAe;IAc5D,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAC1B,gBAAgB,CAAC,IAAI,EACrB,UAAU,CACX,CAAC;IACJ,CAAC;;AAnBH,4CAoBC;AAnBQ,qBAAI,GAAG,kBAAkB,CAAC;AAqBnC,SAAgB,oBAAoB,CAAC,SAAoB;IACvD,OAAO,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,aAAc,SAAQ,gBAAgB;IAE1C,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC;IACtC,CAAC;IACD,IAAI,WAAW,CAAC,GAAY;QAC1B,IAAI,CAAC,mBAAmB,CAAC,GAAG,GAAG,GAAG,CAAC;IACrC,CAAC;IAGD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC;IAClC,CAAC;IACD,IAAI,OAAO,CAAC,GAAY;QACtB,IAAI,CAAC,eAAe,CAAC,GAAG,GAAG,GAAG,CAAC;IACjC,CAAC;IAGD,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;IACjC,CAAC;IACD,IAAI,QAAQ,CAAC,GAAY;QACvB,IAAI,CAAC,cAAc,CAAC,GAAG,GAAG,GAAG,CAAC;IAChC,CAAC;IAID,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;QA3BlC,wBAAmB,GAAG,IAAI,sBAAe,CAAC,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAQtE,oBAAe,GAAG,IAAI,sBAAe,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAQjE,mBAAc,GAAG,IAAI,sBAAe,CAAC,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAYvE,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import { MemoizedBoolean } from \"@vived/core\";\r\nimport {\r\n  getSingletonComponent,\r\n  AppObject,\r\n  AppObjectEntity,\r\n  AppObjectRepo\r\n} from \"@vived/core\";\r\n\r\nexport abstract class ZSpaceHostEntity extends AppObjectEntity {\r\n  static type = \"ZSpaceHostEntity\";\r\n\r\n  abstract get isSupported(): boolean;\r\n  abstract set isSupported(val: boolean);\r\n\r\n  abstract get emulate(): boolean;\r\n  abstract set emulate(val: boolean);\r\n\r\n  abstract get isActive(): boolean;\r\n  abstract set isActive(val: boolean);\r\n\r\n  abstract session: XRSession | undefined;\r\n\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<ZSpaceHostEntity>(\r\n      ZSpaceHostEntity.type,\r\n      appObjects\r\n    );\r\n  }\r\n}\r\n\r\nexport function makeZSpaceHostEntity(appObject: AppObject): ZSpaceHostEntity {\r\n  return new ZSpaceHostImp(appObject);\r\n}\r\n\r\nclass ZSpaceHostImp extends ZSpaceHostEntity {\r\n  private memoizedIsSupported = new MemoizedBoolean(false, this.notifyOnChange);\r\n  get isSupported(): boolean {\r\n    return this.memoizedIsSupported.val;\r\n  }\r\n  set isSupported(val: boolean) {\r\n    this.memoizedIsSupported.val = val;\r\n  }\r\n\r\n  private memoizedEmulate = new MemoizedBoolean(true, this.notifyOnChange);\r\n  get emulate(): boolean {\r\n    return this.memoizedEmulate.val;\r\n  }\r\n  set emulate(val: boolean) {\r\n    this.memoizedEmulate.val = val;\r\n  }\r\n\r\n  private memoizedActive = new MemoizedBoolean(false, this.notifyOnChange);\r\n  get isActive(): boolean {\r\n    return this.memoizedActive.val;\r\n  }\r\n  set isActive(val: boolean) {\r\n    this.memoizedActive.val = val;\r\n  }\r\n\r\n  session: XRSession | undefined;\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ZSpaceHostEntity.type);\r\n    this.appObjects.registerSingleton(this);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ZSpaceHost.js","sourceRoot":"","sources":["../../../../src/ZSpaceHost/Entities/ZSpaceHost.ts"],"names":[],"mappings":";;;AA2EA,oDAEC;AA7ED,sCAA8C;AAC9C,sCAKqB;AAErB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAsB,gBAAiB,SAAQ,sBAAe;IA6B5D;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAC1B,gBAAgB,CAAC,IAAI,EACrB,UAAU,CACX,CAAC;IACJ,CAAC;;AAvCH,4CAwCC;AAvCQ,qBAAI,GAAG,kBAAkB,CAAC;AAyCnC;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,SAAoB;IACvD,OAAO,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;AACtC,CAAC;AAED;;;GAGG;AACH,MAAM,aAAc,SAAQ,gBAAgB;IAE1C,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC;IACtC,CAAC;IACD,IAAI,WAAW,CAAC,GAAY;QAC1B,IAAI,CAAC,mBAAmB,CAAC,GAAG,GAAG,GAAG,CAAC;IACrC,CAAC;IAGD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC;IAClC,CAAC;IACD,IAAI,OAAO,CAAC,GAAY;QACtB,IAAI,CAAC,eAAe,CAAC,GAAG,GAAG,GAAG,CAAC;IACjC,CAAC;IAGD,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;IACjC,CAAC;IACD,IAAI,QAAQ,CAAC,GAAY;QACvB,IAAI,CAAC,cAAc,CAAC,GAAG,GAAG,GAAG,CAAC;IAChC,CAAC;IAID,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;QA3BlC,wBAAmB,GAAG,IAAI,sBAAe,CAAC,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAQtE,oBAAe,GAAG,IAAI,sBAAe,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAQjE,mBAAc,GAAG,IAAI,sBAAe,CAAC,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAYvE,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import { MemoizedBoolean } from \"@vived/core\";\r\nimport {\r\n  getSingletonComponent,\r\n  AppObject,\r\n  AppObjectEntity,\r\n  AppObjectRepo\r\n} from \"@vived/core\";\r\n\r\n/**\r\n * ZSpaceHostEntity is a singleton entity that manages the state and functionality\r\n * for zSpace integration in VIVED applications.\r\n *\r\n * This entity handles:\r\n * 1. zSpace feature detection (isSupported)\r\n * 2. Emulation mode toggling (emulate)\r\n * 3. Active state management (isActive)\r\n * 4. XR Session management\r\n *\r\n * Usage:\r\n * - To check if zSpace is available: ZSpaceHostEntity.get(appObjects)?.isSupported\r\n * - To check if zSpace is active: ZSpaceHostEntity.get(appObjects)?.isActive\r\n * - To enable/disable emulation: ZSpaceHostEntity.get(appObjects).emulate = true/false\r\n *\r\n * Important: This is a singleton entity - only one instance exists in the application.\r\n * Always access via ZSpaceHostEntity.get(appObjects) rather than creating new instances.\r\n */\r\nexport abstract class ZSpaceHostEntity extends AppObjectEntity {\r\n  static type = \"ZSpaceHostEntity\";\r\n\r\n  /**\r\n   * Whether zSpace hardware is supported in the current environment\r\n   */\r\n  abstract get isSupported(): boolean;\r\n  abstract set isSupported(val: boolean);\r\n\r\n  /**\r\n   * Whether to emulate zSpace hardware when not available\r\n   * When true, the system will simulate zSpace capabilities\r\n   */\r\n  abstract get emulate(): boolean;\r\n  abstract set emulate(val: boolean);\r\n\r\n  /**\r\n   * Whether zSpace is currently active\r\n   * This is true when either real zSpace hardware is active\r\n   * or when emulation is enabled\r\n   */\r\n  abstract get isActive(): boolean;\r\n  abstract set isActive(val: boolean);\r\n\r\n  /**\r\n   * The current XR Session if zSpace is active\r\n   */\r\n  abstract session: XRSession | undefined;\r\n\r\n  /**\r\n   * Get the singleton ZSpaceHostEntity instance\r\n   * @param appObjects - The AppObjectRepo instance\r\n   * @returns The ZSpaceHostEntity instance or undefined if not found\r\n   */\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<ZSpaceHostEntity>(\r\n      ZSpaceHostEntity.type,\r\n      appObjects\r\n    );\r\n  }\r\n}\r\n\r\n/**\r\n * Factory function to create the ZSpaceHostEntity\r\n * For internal use only - external code should use ZSpaceHostEntity.get()\r\n *\r\n * @param appObject - The AppObject to attach the entity to\r\n * @returns A new ZSpaceHostEntity instance\r\n */\r\nexport function makeZSpaceHostEntity(appObject: AppObject): ZSpaceHostEntity {\r\n  return new ZSpaceHostImp(appObject);\r\n}\r\n\r\n/**\r\n * Implementation of ZSpaceHostEntity\r\n * Uses MemoizedBoolean for all properties to ensure proper change notifications\r\n */\r\nclass ZSpaceHostImp extends ZSpaceHostEntity {\r\n  private memoizedIsSupported = new MemoizedBoolean(false, this.notifyOnChange);\r\n  get isSupported(): boolean {\r\n    return this.memoizedIsSupported.val;\r\n  }\r\n  set isSupported(val: boolean) {\r\n    this.memoizedIsSupported.val = val;\r\n  }\r\n\r\n  private memoizedEmulate = new MemoizedBoolean(true, this.notifyOnChange);\r\n  get emulate(): boolean {\r\n    return this.memoizedEmulate.val;\r\n  }\r\n  set emulate(val: boolean) {\r\n    this.memoizedEmulate.val = val;\r\n  }\r\n\r\n  private memoizedActive = new MemoizedBoolean(false, this.notifyOnChange);\r\n  get isActive(): boolean {\r\n    return this.memoizedActive.val;\r\n  }\r\n  set isActive(val: boolean) {\r\n    this.memoizedActive.val = val;\r\n  }\r\n\r\n  session: XRSession | undefined;\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ZSpaceHostEntity.type);\r\n    this.appObjects.registerSingleton(this);\r\n  }\r\n}\r\n"]}

package/dist/cjs/ZSpaceHost/PMs/EmulateZSpacePM.js

@@ -4,13 +4,59 @@ exports.EmulateZSpacePM = void 0;
 exports.makeEmulateZSpacePM = makeEmulateZSpacePM;
 const core_1 = require("@vived/core");
 const Entities_1 = require("../Entities");
+/**
+ * EmulateZSpacePM is a singleton Presentation Manager that provides a boolean view model
+ * indicating whether zSpace emulation is currently enabled.
+ *
+ * This PM allows UI components to observe and (through controllers) control whether
+ * zSpace features should be emulated when actual zSpace hardware is not available.
+ *
+ * Usage in UI components:
+ * 1. Via direct PM access (not recommended for UI components):
+ *    const pm = EmulateZSpacePM.get(appObjects);
+ *    pm?.addView((isEmulating) => { updateUIBasedOn(isEmulating); });
+ *
+ * 2. Via adapter (recommended for React/UI components):
+ *    import { emulateZSpacePMAdapter } from "../Adapters";
+ *
+ *    // In a React component:
+ *    const [isEmulating, setIsEmulating] = useState(emulateZSpacePMAdapter.defaultVM);
+ *
+ *    useEffect(() => {
+ *      emulateZSpacePMAdapter.subscribe(appObjects, setIsEmulating);
+ *      return () => emulateZSpacePMAdapter.unsubscribe(appObjects, setIsEmulating);
+ *    }, [appObjects]);
+ *
+ * 3. To toggle emulation state (in a controller or UI event handler):
+ *    import { toggleEmulateZSpace } from "../Controllers";
+ *
+ *    // When handling a UI event:
+ *    const handleToggleEmulation = () => {
+ *      toggleEmulateZSpace(appObjects);
+ *    };
+ *
+ * Emulation is useful during development or when testing on systems without zSpace hardware.
+ * When emulation is enabled, many zSpace-specific UI features can still be tested.
+ */
 class EmulateZSpacePM extends core_1.AppObjectPM {
+    /**
+     * Get the singleton instance of EmulateZSpacePM
+     * @param appObjects - The AppObjectRepo instance
+     * @returns The EmulateZSpacePM instance or undefined if not found
+     */
     static get(appObjects) {
         return (0, core_1.getSingletonComponent)(EmulateZSpacePM.type, appObjects);
     }
 }
 exports.EmulateZSpacePM = EmulateZSpacePM;
 EmulateZSpacePM.type = "EmulateZSpacePM";
+/**
+ * Factory function to create the EmulateZSpacePM
+ * For internal use only - external code should use EmulateZSpacePM.get()
+ *
+ * @param appObject - The AppObject to attach the PM to
+ * @returns A new EmulateZSpacePM instance
+ */
 function makeEmulateZSpacePM(appObject) {
     return new EmulateZSpacePMImp(appObject);
 }
@@ -18,6 +64,9 @@ class EmulateZSpacePMImp extends EmulateZSpacePM {
     vmsAreEqual(a, b) {
         return a === b;
     }
+    get zSpace() {
+        return this.getCachedSingleton(Entities_1.ZSpaceHostEntity.type);
+    }
     constructor(appObject) {
         super(appObject, EmulateZSpacePM.type);
         this.onEntityChange = () => {
@@ -25,12 +74,12 @@ class EmulateZSpacePMImp extends EmulateZSpacePM {
                 return;
             this.doUpdateView(this.zSpace.emulate);
         };
-        this.zSpace = appObject.getComponent(Entities_1.ZSpaceHostEntity.type);
-        if (!this.zSpace) {
+        const zSpace = this.zSpace;
+        if (!zSpace) {
             this.error("PM Has been added to an app object that does not have a ZSpaceHostEntity");
             return;
         }
-        this.zSpace.addChangeObserver(this.onEntityChange);
+        zSpace.addChangeObserver(this.onEntityChange);
         this.onEntityChange();
         this.appObjects.registerSingleton(this);
     }

package/dist/cjs/ZSpaceHost/PMs/EmulateZSpacePM.js.map

@@ -1 +1 @@
-{"version":3,"file":"EmulateZSpacePM.js","sourceRoot":"","sources":["../../../../src/ZSpaceHost/PMs/EmulateZSpacePM.ts"],"names":[],"mappings":";;;AAmBA,kDAEC;AArBD,sCAKqB;AACrB,0CAA+C;AAE/C,MAAsB,eAAgB,SAAQ,kBAAoB;IAGhE,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAC1B,eAAe,CAAC,IAAI,EACpB,UAAU,CACX,CAAC;IACJ,CAAC;;AARH,0CASC;AARQ,oBAAI,GAAG,iBAAiB,CAAC;AAUlC,SAAgB,mBAAmB,CAAC,SAAoB;IACtD,OAAO,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,kBAAmB,SAAQ,eAAe;IAG9C,WAAW,CAAC,CAAU,EAAE,CAAU;QAChC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAQD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QAPjC,mBAAc,GAAG,GAAG,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,OAAO;YAEzB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC;QAKA,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,YAAY,CAClC,2BAAgB,CAAC,IAAI,CACtB,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,CACR,0EAA0E,CAC3E,CAAC;YACF,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACnD,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import {\r\n  getSingletonComponent,\r\n  AppObject,\r\n  AppObjectPM,\r\n  AppObjectRepo\r\n} from \"@vived/core\";\r\nimport { ZSpaceHostEntity } from \"../Entities\";\r\n\r\nexport abstract class EmulateZSpacePM extends AppObjectPM<boolean> {\r\n  static type = \"EmulateZSpacePM\";\r\n\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<EmulateZSpacePM>(\r\n      EmulateZSpacePM.type,\r\n      appObjects\r\n    );\r\n  }\r\n}\r\n\r\nexport function makeEmulateZSpacePM(appObject: AppObject): EmulateZSpacePM {\r\n  return new EmulateZSpacePMImp(appObject);\r\n}\r\n\r\nclass EmulateZSpacePMImp extends EmulateZSpacePM {\r\n  private zSpace?: ZSpaceHostEntity;\r\n\r\n  vmsAreEqual(a: boolean, b: boolean): boolean {\r\n    return a === b;\r\n  }\r\n\r\n  private onEntityChange = () => {\r\n    if (!this.zSpace) return;\r\n\r\n    this.doUpdateView(this.zSpace.emulate);\r\n  };\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, EmulateZSpacePM.type);\r\n\r\n    this.zSpace = appObject.getComponent<ZSpaceHostEntity>(\r\n      ZSpaceHostEntity.type\r\n    );\r\n    if (!this.zSpace) {\r\n      this.error(\r\n        \"PM Has been added to an app object that does not have a ZSpaceHostEntity\"\r\n      );\r\n      return;\r\n    }\r\n    this.zSpace.addChangeObserver(this.onEntityChange);\r\n    this.onEntityChange();\r\n\r\n    this.appObjects.registerSingleton(this);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"EmulateZSpacePM.js","sourceRoot":"","sources":["../../../../src/ZSpaceHost/PMs/EmulateZSpacePM.ts"],"names":[],"mappings":";;;AAiEA,kDAEC;AAnED,sCAKqB;AACrB,0CAA+C;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAsB,eAAgB,SAAQ,kBAAoB;IAGhE;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAC1B,eAAe,CAAC,IAAI,EACpB,UAAU,CACX,CAAC;IACJ,CAAC;;AAbH,0CAcC;AAbQ,oBAAI,GAAG,iBAAiB,CAAC;AAelC;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,SAAoB;IACtD,OAAO,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,kBAAmB,SAAQ,eAAe;IAC9C,WAAW,CAAC,CAAU,EAAE,CAAU;QAChC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAED,IAAY,MAAM;QAChB,OAAO,IAAI,CAAC,kBAAkB,CAAmB,2BAAgB,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC;IAQD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QAPjC,mBAAc,GAAG,GAAG,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,OAAO;YAEzB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC;QAKA,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,KAAK,CACR,0EAA0E,CAC3E,CAAC;YACF,OAAO;QACT,CAAC;QACD,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9C,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import {\r\n  getSingletonComponent,\r\n  AppObject,\r\n  AppObjectPM,\r\n  AppObjectRepo\r\n} from \"@vived/core\";\r\nimport { ZSpaceHostEntity } from \"../Entities\";\r\n\r\n/**\r\n * EmulateZSpacePM is a singleton Presentation Manager that provides a boolean view model\r\n * indicating whether zSpace emulation is currently enabled.\r\n *\r\n * This PM allows UI components to observe and (through controllers) control whether\r\n * zSpace features should be emulated when actual zSpace hardware is not available.\r\n *\r\n * Usage in UI components:\r\n * 1. Via direct PM access (not recommended for UI components):\r\n *    const pm = EmulateZSpacePM.get(appObjects);\r\n *    pm?.addView((isEmulating) => { updateUIBasedOn(isEmulating); });\r\n *\r\n * 2. Via adapter (recommended for React/UI components):\r\n *    import { emulateZSpacePMAdapter } from \"../Adapters\";\r\n *\r\n *    // In a React component:\r\n *    const [isEmulating, setIsEmulating] = useState(emulateZSpacePMAdapter.defaultVM);\r\n *\r\n *    useEffect(() => {\r\n *      emulateZSpacePMAdapter.subscribe(appObjects, setIsEmulating);\r\n *      return () => emulateZSpacePMAdapter.unsubscribe(appObjects, setIsEmulating);\r\n *    }, [appObjects]);\r\n *\r\n * 3. To toggle emulation state (in a controller or UI event handler):\r\n *    import { toggleEmulateZSpace } from \"../Controllers\";\r\n *\r\n *    // When handling a UI event:\r\n *    const handleToggleEmulation = () => {\r\n *      toggleEmulateZSpace(appObjects);\r\n *    };\r\n *\r\n * Emulation is useful during development or when testing on systems without zSpace hardware.\r\n * When emulation is enabled, many zSpace-specific UI features can still be tested.\r\n */\r\nexport abstract class EmulateZSpacePM extends AppObjectPM<boolean> {\r\n  static type = \"EmulateZSpacePM\";\r\n\r\n  /**\r\n   * Get the singleton instance of EmulateZSpacePM\r\n   * @param appObjects - The AppObjectRepo instance\r\n   * @returns The EmulateZSpacePM instance or undefined if not found\r\n   */\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<EmulateZSpacePM>(\r\n      EmulateZSpacePM.type,\r\n      appObjects\r\n    );\r\n  }\r\n}\r\n\r\n/**\r\n * Factory function to create the EmulateZSpacePM\r\n * For internal use only - external code should use EmulateZSpacePM.get()\r\n *\r\n * @param appObject - The AppObject to attach the PM to\r\n * @returns A new EmulateZSpacePM instance\r\n */\r\nexport function makeEmulateZSpacePM(appObject: AppObject): EmulateZSpacePM {\r\n  return new EmulateZSpacePMImp(appObject);\r\n}\r\n\r\nclass EmulateZSpacePMImp extends EmulateZSpacePM {\r\n  vmsAreEqual(a: boolean, b: boolean): boolean {\r\n    return a === b;\r\n  }\r\n\r\n  private get zSpace() {\r\n    return this.getCachedSingleton<ZSpaceHostEntity>(ZSpaceHostEntity.type);\r\n  }\r\n\r\n  private onEntityChange = () => {\r\n    if (!this.zSpace) return;\r\n\r\n    this.doUpdateView(this.zSpace.emulate);\r\n  };\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, EmulateZSpacePM.type);\r\n\r\n    const zSpace = this.zSpace;\r\n    if (!zSpace) {\r\n      this.error(\r\n        \"PM Has been added to an app object that does not have a ZSpaceHostEntity\"\r\n      );\r\n      return;\r\n    }\r\n    zSpace.addChangeObserver(this.onEntityChange);\r\n    this.onEntityChange();\r\n\r\n    this.appObjects.registerSingleton(this);\r\n  }\r\n}\r\n"]}

package/dist/cjs/ZSpaceHost/PMs/ZSpaceIsActivePM.js

@@ -4,13 +4,52 @@ exports.ZSpaceIsActivePM = void 0;
 exports.makeZSpaceIsActivePM = makeZSpaceIsActivePM;
 const core_1 = require("@vived/core");
 const ZSpaceHost_1 = require("../Entities/ZSpaceHost");
+/**
+ * ZSpaceIsActivePM is a singleton Presentation Manager that provides a boolean view model
+ * indicating whether zSpace is currently active.
+ *
+ * This PM observes ZSpaceHostEntity and updates its view model when the isActive property changes.
+ *
+ * Usage in UI components:
+ * 1. Via direct PM access (not recommended for UI components):
+ *    const pm = ZSpaceIsActivePM.get(appObjects);
+ *    pm?.addView((isActive) => { updateUIBasedOn(isActive); });
+ *
+ * 2. Via adapter (recommended for React/UI components):
+ *    import { zSpaceIsActivePMAdapter } from "../Adapters";
+ *
+ *    // In a React component:
+ *    const [isZSpaceActive, setIsZSpaceActive] = useState(zSpaceIsActivePMAdapter.defaultVM);
+ *
+ *    useEffect(() => {
+ *      zSpaceIsActivePMAdapter.subscribe(appObjects, setIsZSpaceActive);
+ *      return () => zSpaceIsActivePMAdapter.unsubscribe(appObjects, setIsZSpaceActive);
+ *    }, [appObjects]);
+ *
+ * When zSpace is active, UI components may want to:
+ * - Display 3D content differently
+ * - Show zSpace-specific controls
+ * - Adjust UI layouts for stereoscopic viewing
+ */
 class ZSpaceIsActivePM extends core_1.AppObjectPM {
+    /**
+     * Get the singleton instance of ZSpaceIsActivePM
+     * @param appObjects - The AppObjectRepo instance
+     * @returns The ZSpaceIsActivePM instance or undefined if not found
+     */
     static get(appObjects) {
         return (0, core_1.getSingletonComponent)(ZSpaceIsActivePM.type, appObjects);
     }
 }
 exports.ZSpaceIsActivePM = ZSpaceIsActivePM;
 ZSpaceIsActivePM.type = "ZSpaceIsActivePM";
+/**
+ * Factory function to create the ZSpaceIsActivePM
+ * For internal use only - external code should use ZSpaceIsActivePM.get()
+ *
+ * @param appObject - The AppObject to attach the PM to
+ * @returns A new ZSpaceIsActivePM instance
+ */
 function makeZSpaceIsActivePM(appObject) {
     return new ZSpaceIsActivePMImp(appObject);
 }
@@ -18,6 +57,9 @@ class ZSpaceIsActivePMImp extends ZSpaceIsActivePM {
     vmsAreEqual(a, b) {
         return a === b;
     }
+    get zSpace() {
+        return this.getCachedSingleton(ZSpaceHost_1.ZSpaceHostEntity.type);
+    }
     constructor(appObject) {
         super(appObject, ZSpaceIsActivePM.type);
         this.onEntityChange = () => {
@@ -25,12 +67,12 @@ class ZSpaceIsActivePMImp extends ZSpaceIsActivePM {
                 return;
             this.doUpdateView(this.zSpace.isActive);
         };
-        this.zSpace = appObject.getComponent(ZSpaceHost_1.ZSpaceHostEntity.type);
-        if (!this.zSpace) {
+        const zSpace = this.zSpace;
+        if (!zSpace) {
             this.error("PM Has been added to an app object that does not have a ZSpaceHostEntity");
             return;
         }
-        this.zSpace.addChangeObserver(this.onEntityChange);
+        zSpace.addChangeObserver(this.onEntityChange);
         this.onEntityChange();
         this.appObjects.registerSingleton(this);
     }

package/dist/cjs/ZSpaceHost/PMs/ZSpaceIsActivePM.js.map

@@ -1 +1 @@
-{"version":3,"file":"ZSpaceIsActivePM.js","sourceRoot":"","sources":["../../../../src/ZSpaceHost/PMs/ZSpaceIsActivePM.ts"],"names":[],"mappings":";;;AAmBA,oDAEC;AArBD,sCAKqB;AACrB,uDAA0D;AAE1D,MAAsB,gBAAiB,SAAQ,kBAAoB;IAGjE,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAC1B,gBAAgB,CAAC,IAAI,EACrB,UAAU,CACX,CAAC;IACJ,CAAC;;AARH,4CASC;AARQ,qBAAI,GAAG,kBAAkB,CAAC;AAUnC,SAAgB,oBAAoB,CAAC,SAAoB;IACvD,OAAO,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,mBAAoB,SAAQ,gBAAgB;IAGhD,WAAW,CAAC,CAAU,EAAE,CAAU;QAChC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAQD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAPlC,mBAAc,GAAG,GAAG,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,OAAO;YAEzB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC1C,CAAC,CAAC;QAKA,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,YAAY,CAClC,6BAAgB,CAAC,IAAI,CACtB,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,CACR,0EAA0E,CAC3E,CAAC;YACF,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACnD,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import {\r\n  getSingletonComponent,\r\n  AppObject,\r\n  AppObjectPM,\r\n  AppObjectRepo\r\n} from \"@vived/core\";\r\nimport { ZSpaceHostEntity } from \"../Entities/ZSpaceHost\";\r\n\r\nexport abstract class ZSpaceIsActivePM extends AppObjectPM<boolean> {\r\n  static type = \"ZSpaceIsActivePM\";\r\n\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<ZSpaceIsActivePM>(\r\n      ZSpaceIsActivePM.type,\r\n      appObjects\r\n    );\r\n  }\r\n}\r\n\r\nexport function makeZSpaceIsActivePM(appObject: AppObject): ZSpaceIsActivePM {\r\n  return new ZSpaceIsActivePMImp(appObject);\r\n}\r\n\r\nclass ZSpaceIsActivePMImp extends ZSpaceIsActivePM {\r\n  private zSpace?: ZSpaceHostEntity;\r\n\r\n  vmsAreEqual(a: boolean, b: boolean): boolean {\r\n    return a === b;\r\n  }\r\n\r\n  private onEntityChange = () => {\r\n    if (!this.zSpace) return;\r\n\r\n    this.doUpdateView(this.zSpace.isActive);\r\n  };\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ZSpaceIsActivePM.type);\r\n\r\n    this.zSpace = appObject.getComponent<ZSpaceHostEntity>(\r\n      ZSpaceHostEntity.type\r\n    );\r\n    if (!this.zSpace) {\r\n      this.error(\r\n        \"PM Has been added to an app object that does not have a ZSpaceHostEntity\"\r\n      );\r\n      return;\r\n    }\r\n    this.zSpace.addChangeObserver(this.onEntityChange);\r\n    this.onEntityChange();\r\n\r\n    this.appObjects.registerSingleton(this);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ZSpaceIsActivePM.js","sourceRoot":"","sources":["../../../../src/ZSpaceHost/PMs/ZSpaceIsActivePM.ts"],"names":[],"mappings":";;;AA0DA,oDAEC;AA5DD,sCAKqB;AACrB,uDAA0D;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAsB,gBAAiB,SAAQ,kBAAoB;IAGjE;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAC1B,gBAAgB,CAAC,IAAI,EACrB,UAAU,CACX,CAAC;IACJ,CAAC;;AAbH,4CAcC;AAbQ,qBAAI,GAAG,kBAAkB,CAAC;AAenC;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,SAAoB;IACvD,OAAO,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,mBAAoB,SAAQ,gBAAgB;IAChD,WAAW,CAAC,CAAU,EAAE,CAAU;QAChC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAED,IAAY,MAAM;QAChB,OAAO,IAAI,CAAC,kBAAkB,CAAmB,6BAAgB,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC;IAQD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAPlC,mBAAc,GAAG,GAAG,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,OAAO;YAEzB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC1C,CAAC,CAAC;QAKA,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,KAAK,CACR,0EAA0E,CAC3E,CAAC;YACF,OAAO;QACT,CAAC;QACD,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9C,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import {\r\n  getSingletonComponent,\r\n  AppObject,\r\n  AppObjectPM,\r\n  AppObjectRepo\r\n} from \"@vived/core\";\r\nimport { ZSpaceHostEntity } from \"../Entities/ZSpaceHost\";\r\n\r\n/**\r\n * ZSpaceIsActivePM is a singleton Presentation Manager that provides a boolean view model\r\n * indicating whether zSpace is currently active.\r\n *\r\n * This PM observes ZSpaceHostEntity and updates its view model when the isActive property changes.\r\n *\r\n * Usage in UI components:\r\n * 1. Via direct PM access (not recommended for UI components):\r\n *    const pm = ZSpaceIsActivePM.get(appObjects);\r\n *    pm?.addView((isActive) => { updateUIBasedOn(isActive); });\r\n *\r\n * 2. Via adapter (recommended for React/UI components):\r\n *    import { zSpaceIsActivePMAdapter } from \"../Adapters\";\r\n *\r\n *    // In a React component:\r\n *    const [isZSpaceActive, setIsZSpaceActive] = useState(zSpaceIsActivePMAdapter.defaultVM);\r\n *\r\n *    useEffect(() => {\r\n *      zSpaceIsActivePMAdapter.subscribe(appObjects, setIsZSpaceActive);\r\n *      return () => zSpaceIsActivePMAdapter.unsubscribe(appObjects, setIsZSpaceActive);\r\n *    }, [appObjects]);\r\n *\r\n * When zSpace is active, UI components may want to:\r\n * - Display 3D content differently\r\n * - Show zSpace-specific controls\r\n * - Adjust UI layouts for stereoscopic viewing\r\n */\r\nexport abstract class ZSpaceIsActivePM extends AppObjectPM<boolean> {\r\n  static type = \"ZSpaceIsActivePM\";\r\n\r\n  /**\r\n   * Get the singleton instance of ZSpaceIsActivePM\r\n   * @param appObjects - The AppObjectRepo instance\r\n   * @returns The ZSpaceIsActivePM instance or undefined if not found\r\n   */\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<ZSpaceIsActivePM>(\r\n      ZSpaceIsActivePM.type,\r\n      appObjects\r\n    );\r\n  }\r\n}\r\n\r\n/**\r\n * Factory function to create the ZSpaceIsActivePM\r\n * For internal use only - external code should use ZSpaceIsActivePM.get()\r\n *\r\n * @param appObject - The AppObject to attach the PM to\r\n * @returns A new ZSpaceIsActivePM instance\r\n */\r\nexport function makeZSpaceIsActivePM(appObject: AppObject): ZSpaceIsActivePM {\r\n  return new ZSpaceIsActivePMImp(appObject);\r\n}\r\n\r\nclass ZSpaceIsActivePMImp extends ZSpaceIsActivePM {\r\n  vmsAreEqual(a: boolean, b: boolean): boolean {\r\n    return a === b;\r\n  }\r\n\r\n  private get zSpace() {\r\n    return this.getCachedSingleton<ZSpaceHostEntity>(ZSpaceHostEntity.type);\r\n  }\r\n\r\n  private onEntityChange = () => {\r\n    if (!this.zSpace) return;\r\n\r\n    this.doUpdateView(this.zSpace.isActive);\r\n  };\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ZSpaceIsActivePM.type);\r\n\r\n    const zSpace = this.zSpace;\r\n    if (!zSpace) {\r\n      this.error(\r\n        \"PM Has been added to an app object that does not have a ZSpaceHostEntity\"\r\n      );\r\n      return;\r\n    }\r\n    zSpace.addChangeObserver(this.onEntityChange);\r\n    this.onEntityChange();\r\n\r\n    this.appObjects.registerSingleton(this);\r\n  }\r\n}\r\n"]}

package/dist/cjs/ZSpaceHost/UCs/StartZSpace/StartZSpaceUC.js

@@ -2,7 +2,45 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StartZSpaceUC = void 0;
 const core_1 = require("@vived/core");
+/**
+ * StartZSpaceUC is a singleton Use Case responsible for starting a zSpace session.
+ *
+ * This Use Case handles:
+ * 1. Setting up and initializing the zSpace XR session
+ * 2. Updating the ZSpaceHostEntity to reflect the active state
+ * 3. Handling errors in the setup process
+ *
+ * Usage:
+ * ```typescript
+ * // In a controller or UI event handler:
+ * const startZSpace = async (appObjects) => {
+ *   const uc = StartZSpaceUC.get(appObjects);
+ *   if (!uc) {
+ *     console.error("StartZSpaceUC not found");
+ *     return;
+ *   }
+ *
+ *   try {
+ *     await uc.startZSpace();
+ *     console.log("zSpace session started successfully");
+ *   } catch (error) {
+ *     console.error("Failed to start zSpace session:", error);
+ *   }
+ * };
+ * ```
+ *
+ * Important notes:
+ * - This is an asynchronous operation and may take some time to complete
+ * - Success/failure is indicated by the Promise resolution/rejection
+ * - When successful, ZSpaceHostEntity.isActive will be set to true
+ * - UI components should observe ZSpaceIsActivePM to react to state changes
+ */
 class StartZSpaceUC extends core_1.AppObjectUC {
+    /**
+     * Get the singleton instance of StartZSpaceUC
+     * @param appObjects - The AppObjectRepo instance
+     * @returns The StartZSpaceUC instance or undefined if not found
+     */
     static get(appObjects) {
         return (0, core_1.getSingletonComponent)(StartZSpaceUC.type, appObjects);
     }

package/dist/cjs/ZSpaceHost/UCs/StartZSpace/StartZSpaceUC.js.map

@@ -1 +1 @@
-{"version":3,"file":"StartZSpaceUC.js","sourceRoot":"","sources":["../../../../../src/ZSpaceHost/UCs/StartZSpace/StartZSpaceUC.ts"],"names":[],"mappings":";;;AAAA,sCAAgF;AAEhF,MAAsB,aAAc,SAAQ,kBAAW;IAKrD,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAAgB,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC9E,CAAC;;AAPH,sCAQC;AAPQ,kBAAI,GAAG,eAAe,CAAC","sourcesContent":["import { getSingletonComponent, AppObjectRepo, AppObjectUC } from \"@vived/core\";\r\n\r\nexport abstract class StartZSpaceUC extends AppObjectUC {\r\n  static type = \"StartZSpaceUC\";\r\n\r\n  abstract startZSpace(): Promise<void>;\r\n\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<StartZSpaceUC>(StartZSpaceUC.type, appObjects);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"StartZSpaceUC.js","sourceRoot":"","sources":["../../../../../src/ZSpaceHost/UCs/StartZSpace/StartZSpaceUC.ts"],"names":[],"mappings":";;;AAAA,sCAAgF;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAsB,aAAc,SAAQ,kBAAW;IAUrD;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAAgB,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC9E,CAAC;;AAjBH,sCAkBC;AAjBQ,kBAAI,GAAG,eAAe,CAAC","sourcesContent":["import { getSingletonComponent, AppObjectRepo, AppObjectUC } from \"@vived/core\";\r\n\r\n/**\r\n * StartZSpaceUC is a singleton Use Case responsible for starting a zSpace session.\r\n *\r\n * This Use Case handles:\r\n * 1. Setting up and initializing the zSpace XR session\r\n * 2. Updating the ZSpaceHostEntity to reflect the active state\r\n * 3. Handling errors in the setup process\r\n *\r\n * Usage:\r\n * ```typescript\r\n * // In a controller or UI event handler:\r\n * const startZSpace = async (appObjects) => {\r\n *   const uc = StartZSpaceUC.get(appObjects);\r\n *   if (!uc) {\r\n *     console.error(\"StartZSpaceUC not found\");\r\n *     return;\r\n *   }\r\n *\r\n *   try {\r\n *     await uc.startZSpace();\r\n *     console.log(\"zSpace session started successfully\");\r\n *   } catch (error) {\r\n *     console.error(\"Failed to start zSpace session:\", error);\r\n *   }\r\n * };\r\n * ```\r\n *\r\n * Important notes:\r\n * - This is an asynchronous operation and may take some time to complete\r\n * - Success/failure is indicated by the Promise resolution/rejection\r\n * - When successful, ZSpaceHostEntity.isActive will be set to true\r\n * - UI components should observe ZSpaceIsActivePM to react to state changes\r\n */\r\nexport abstract class StartZSpaceUC extends AppObjectUC {\r\n  static type = \"StartZSpaceUC\";\r\n\r\n  /**\r\n   * Start the zSpace session\r\n   * @returns A Promise that resolves when the session has started successfully,\r\n   *          or rejects with an error if the session could not be started\r\n   */\r\n  abstract startZSpace(): Promise<void>;\r\n\r\n  /**\r\n   * Get the singleton instance of StartZSpaceUC\r\n   * @param appObjects - The AppObjectRepo instance\r\n   * @returns The StartZSpaceUC instance or undefined if not found\r\n   */\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<StartZSpaceUC>(StartZSpaceUC.type, appObjects);\r\n  }\r\n}\r\n"]}

package/dist/cjs/ZSpaceHost/UCs/StopZSpace/StopZSpaceUC.js

@@ -2,7 +2,43 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StopZSpaceUC = void 0;
 const core_1 = require("@vived/core");
+/**
+ * StopZSpaceUC is a singleton Use Case responsible for stopping an active zSpace session.
+ *
+ * This Use Case handles:
+ * 1. Properly ending the current zSpace XR session
+ * 2. Cleaning up resources associated with the session
+ * 3. Updating the ZSpaceHostEntity to reflect the inactive state
+ *
+ * Usage:
+ * ```typescript
+ * // In a controller or UI event handler:
+ * const stopZSpace = (appObjects) => {
+ *   const uc = StopZSpaceUC.get(appObjects);
+ *   if (!uc) {
+ *     console.error("StopZSpaceUC not found");
+ *     return;
+ *   }
+ *
+ *   uc.stopZSpace();
+ *   console.log("zSpace session stopped");
+ * };
+ * ```
+ *
+ * Important notes:
+ * - This is a synchronous operation and completes immediately
+ * - When called, ZSpaceHostEntity.isActive will be set to false
+ * - UI components should observe ZSpaceIsActivePM to react to state changes
+ * - This should be called when the application no longer needs zSpace features
+ * - It's good practice to call this before application shutdown or when
+ *   transitioning to a non-zSpace part of the application
+ */
 class StopZSpaceUC extends core_1.AppObjectUC {
+    /**
+     * Get the singleton instance of StopZSpaceUC
+     * @param appObjects - The AppObjectRepo instance
+     * @returns The StopZSpaceUC instance or undefined if not found
+     */
     static get(appObjects) {
         return (0, core_1.getSingletonComponent)(StopZSpaceUC.type, appObjects);
     }

package/dist/cjs/ZSpaceHost/UCs/StopZSpace/StopZSpaceUC.js.map

@@ -1 +1 @@
-{"version":3,"file":"StopZSpaceUC.js","sourceRoot":"","sources":["../../../../../src/ZSpaceHost/UCs/StopZSpace/StopZSpaceUC.ts"],"names":[],"mappings":";;;AAAA,sCAAgF;AAEhF,MAAsB,YAAa,SAAQ,kBAAW;IAKpD,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAAe,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC5E,CAAC;;AAPH,oCAQC;AAPQ,iBAAI,GAAG,cAAc,CAAC","sourcesContent":["import { getSingletonComponent, AppObjectRepo, AppObjectUC } from \"@vived/core\";\r\n\r\nexport abstract class StopZSpaceUC extends AppObjectUC {\r\n  static type = \"StopZSpaceUC\";\r\n\r\n  abstract stopZSpace(): void;\r\n\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<StopZSpaceUC>(StopZSpaceUC.type, appObjects);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"StopZSpaceUC.js","sourceRoot":"","sources":["../../../../../src/ZSpaceHost/UCs/StopZSpace/StopZSpaceUC.ts"],"names":[],"mappings":";;;AAAA,sCAAgF;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAsB,YAAa,SAAQ,kBAAW;IASpD;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAAe,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC5E,CAAC;;AAhBH,oCAiBC;AAhBQ,iBAAI,GAAG,cAAc,CAAC","sourcesContent":["import { getSingletonComponent, AppObjectRepo, AppObjectUC } from \"@vived/core\";\r\n\r\n/**\r\n * StopZSpaceUC is a singleton Use Case responsible for stopping an active zSpace session.\r\n *\r\n * This Use Case handles:\r\n * 1. Properly ending the current zSpace XR session\r\n * 2. Cleaning up resources associated with the session\r\n * 3. Updating the ZSpaceHostEntity to reflect the inactive state\r\n *\r\n * Usage:\r\n * ```typescript\r\n * // In a controller or UI event handler:\r\n * const stopZSpace = (appObjects) => {\r\n *   const uc = StopZSpaceUC.get(appObjects);\r\n *   if (!uc) {\r\n *     console.error(\"StopZSpaceUC not found\");\r\n *     return;\r\n *   }\r\n *\r\n *   uc.stopZSpace();\r\n *   console.log(\"zSpace session stopped\");\r\n * };\r\n * ```\r\n *\r\n * Important notes:\r\n * - This is a synchronous operation and completes immediately\r\n * - When called, ZSpaceHostEntity.isActive will be set to false\r\n * - UI components should observe ZSpaceIsActivePM to react to state changes\r\n * - This should be called when the application no longer needs zSpace features\r\n * - It's good practice to call this before application shutdown or when\r\n *   transitioning to a non-zSpace part of the application\r\n */\r\nexport abstract class StopZSpaceUC extends AppObjectUC {\r\n  static type = \"StopZSpaceUC\";\r\n\r\n  /**\r\n   * Stop the active zSpace session\r\n   * This method completes synchronously and does not return a value\r\n   */\r\n  abstract stopZSpace(): void;\r\n\r\n  /**\r\n   * Get the singleton instance of StopZSpaceUC\r\n   * @param appObjects - The AppObjectRepo instance\r\n   * @returns The StopZSpaceUC instance or undefined if not found\r\n   */\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<StopZSpaceUC>(StopZSpaceUC.type, appObjects);\r\n  }\r\n}\r\n"]}

package/dist/cjs/ZSpaceHost/UCs/checkForZSpaceSupport.js

@@ -2,6 +2,42 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkForWebXRSupport = checkForWebXRSupport;
 const ZSpaceHost_1 = require("../Entities/ZSpaceHost");
+/**
+ * Checks if the current browser environment supports WebXR and zSpace hardware
+ *
+ * This utility function:
+ * 1. Checks if navigator.xr is available (WebXR API support)
+ * 2. Tests if 'immersive-vr' sessions are supported (required for zSpace)
+ * 3. Updates the ZSpaceHostEntity.isSupported property based on results
+ *
+ * Usage:
+ * ```typescript
+ * // Typically called during application initialization:
+ * import { checkForWebXRSupport } from "@vived/host/ZSpaceHost/UCs";
+ *
+ * async function initializeApp(appObjects) {
+ *   // Check for zSpace hardware support
+ *   await checkForWebXRSupport(appObjects);
+ *
+ *   // Get the current support status
+ *   const zSpace = ZSpaceHostEntity.get(appObjects);
+ *   if (zSpace?.isSupported) {
+ *     console.log("zSpace hardware is supported");
+ *   } else {
+ *     console.log("zSpace hardware is not supported, using fallback mode");
+ *   }
+ * }
+ * ```
+ *
+ * Important notes:
+ * - This function should be called during application initialization
+ * - It returns a Promise that resolves when the check is complete
+ * - To observe changes in support status, use the ZSpaceIsActivePM
+ * - If hardware is not supported, you may want to enable emulation mode
+ *
+ * @param appObjects - The AppObjectRepo instance
+ * @returns A Promise that resolves when the check is complete
+ */
 function checkForWebXRSupport(appObjects) {
     return new Promise((resolve) => {
         const zSpace = ZSpaceHost_1.ZSpaceHostEntity.get(appObjects);

package/dist/cjs/ZSpaceHost/UCs/checkForZSpaceSupport.js.map

@@ -1 +1 @@
-{"version":3,"file":"checkForZSpaceSupport.js","sourceRoot":"","sources":["../../../../src/ZSpaceHost/UCs/checkForZSpaceSupport.ts"],"names":[],"mappings":";;AAGA,oDA4BC;AA9BD,uDAA0D;AAE1D,SAAgB,oBAAoB,CAAC,UAAyB;IAC5D,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QACnC,MAAM,MAAM,GAAG,6BAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,UAAU,CAAC,WAAW,CACpB,sBAAsB,EACtB,iCAAiC,CAClC,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,EAAE,GAAS,SAAiB,CAAC,EAAE,CAAC;QAEtC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC;YAC3B,OAAO,EAAE,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,EAAE,CAAC,kBAAkB,CAAC,cAAc,CAAC;iBAClC,IAAI,CAAC,CAAC,WAAoB,EAAE,EAAE;gBAC7B,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;gBACjC,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE;gBACV,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC;gBAC3B,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;QACP,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\r\nimport { ZSpaceHostEntity } from \"../Entities/ZSpaceHost\";\r\n\r\nexport function checkForWebXRSupport(appObjects: AppObjectRepo): Promise<void> {\r\n  return new Promise<void>((resolve) => {\r\n    const zSpace = ZSpaceHostEntity.get(appObjects);\r\n    if (!zSpace) {\r\n      appObjects.submitError(\r\n        \"checkForWebXRSupport\",\r\n        \"Unable to find ZSpaceHostEntity\"\r\n      );\r\n      return;\r\n    }\r\n\r\n    const xr: any = (navigator as any).xr;\r\n\r\n    if (!xr) {\r\n      zSpace.isSupported = false;\r\n      resolve();\r\n    } else {\r\n      xr.isSessionSupported(\"immersive-vr\")\r\n        .then((isSupported: boolean) => {\r\n          zSpace.isSupported = isSupported;\r\n          resolve();\r\n        })\r\n        .catch(() => {\r\n          zSpace.isSupported = false;\r\n          resolve();\r\n        });\r\n    }\r\n  });\r\n}\r\n"]}
+{"version":3,"file":"checkForZSpaceSupport.js","sourceRoot":"","sources":["../../../../src/ZSpaceHost/UCs/checkForZSpaceSupport.ts"],"names":[],"mappings":";;AAuCA,oDA4BC;AAlED,uDAA0D;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,SAAgB,oBAAoB,CAAC,UAAyB;IAC5D,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QACnC,MAAM,MAAM,GAAG,6BAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,UAAU,CAAC,WAAW,CACpB,sBAAsB,EACtB,iCAAiC,CAClC,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,EAAE,GAAS,SAAiB,CAAC,EAAE,CAAC;QAEtC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC;YAC3B,OAAO,EAAE,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,EAAE,CAAC,kBAAkB,CAAC,cAAc,CAAC;iBAClC,IAAI,CAAC,CAAC,WAAoB,EAAE,EAAE;gBAC7B,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;gBACjC,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE;gBACV,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC;gBAC3B,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;QACP,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\r\nimport { ZSpaceHostEntity } from \"../Entities/ZSpaceHost\";\r\n\r\n/**\r\n * Checks if the current browser environment supports WebXR and zSpace hardware\r\n *\r\n * This utility function:\r\n * 1. Checks if navigator.xr is available (WebXR API support)\r\n * 2. Tests if 'immersive-vr' sessions are supported (required for zSpace)\r\n * 3. Updates the ZSpaceHostEntity.isSupported property based on results\r\n *\r\n * Usage:\r\n * ```typescript\r\n * // Typically called during application initialization:\r\n * import { checkForWebXRSupport } from \"@vived/host/ZSpaceHost/UCs\";\r\n *\r\n * async function initializeApp(appObjects) {\r\n *   // Check for zSpace hardware support\r\n *   await checkForWebXRSupport(appObjects);\r\n *\r\n *   // Get the current support status\r\n *   const zSpace = ZSpaceHostEntity.get(appObjects);\r\n *   if (zSpace?.isSupported) {\r\n *     console.log(\"zSpace hardware is supported\");\r\n *   } else {\r\n *     console.log(\"zSpace hardware is not supported, using fallback mode\");\r\n *   }\r\n * }\r\n * ```\r\n *\r\n * Important notes:\r\n * - This function should be called during application initialization\r\n * - It returns a Promise that resolves when the check is complete\r\n * - To observe changes in support status, use the ZSpaceIsActivePM\r\n * - If hardware is not supported, you may want to enable emulation mode\r\n *\r\n * @param appObjects - The AppObjectRepo instance\r\n * @returns A Promise that resolves when the check is complete\r\n */\r\nexport function checkForWebXRSupport(appObjects: AppObjectRepo): Promise<void> {\r\n  return new Promise<void>((resolve) => {\r\n    const zSpace = ZSpaceHostEntity.get(appObjects);\r\n    if (!zSpace) {\r\n      appObjects.submitError(\r\n        \"checkForWebXRSupport\",\r\n        \"Unable to find ZSpaceHostEntity\"\r\n      );\r\n      return;\r\n    }\r\n\r\n    const xr: any = (navigator as any).xr;\r\n\r\n    if (!xr) {\r\n      zSpace.isSupported = false;\r\n      resolve();\r\n    } else {\r\n      xr.isSessionSupported(\"immersive-vr\")\r\n        .then((isSupported: boolean) => {\r\n          zSpace.isSupported = isSupported;\r\n          resolve();\r\n        })\r\n        .catch(() => {\r\n          zSpace.isSupported = false;\r\n          resolve();\r\n        });\r\n    }\r\n  });\r\n}\r\n"]}

package/dist/cjs/ZSpaceHost/index.js

@@ -1,4 +1,72 @@
 "use strict";
+/**
+ * ZSpaceHost Module
+ * -----------------
+ *
+ * This module provides integration with zSpace stereoscopic 3D hardware through WebXR.
+ * It allows applications to detect, start, stop, and monitor zSpace sessions,
+ * as well as provide emulation when real hardware isn't available.
+ *
+ * Typical usage flow:
+ *
+ * 1. Initialization:
+ *    ```typescript
+ *    import { checkForWebXRSupport } from "@vived/host/ZSpaceHost/UCs";
+ *
+ *    // During app initialization
+ *    await checkForWebXRSupport(appObjects);
+ *    ```
+ *
+ * 2. Starting/Stopping zSpace:
+ *    ```typescript
+ *    import { StartZSpaceUC, StopZSpaceUC } from "@vived/host/ZSpaceHost/UCs";
+ *
+ *    // Start zSpace
+ *    const startUC = StartZSpaceUC.get(appObjects);
+ *    await startUC?.startZSpace();
+ *
+ *    // Stop zSpace
+ *    const stopUC = StopZSpaceUC.get(appObjects);
+ *    stopUC?.stopZSpace();
+ *    ```
+ *
+ * 3. Checking Status:
+ *    ```typescript
+ *    import { ZSpaceHostEntity } from "@vived/host/ZSpaceHost/Entities";
+ *
+ *    const zSpace = ZSpaceHostEntity.get(appObjects);
+ *    if (zSpace?.isSupported) {
+ *      console.log("zSpace hardware is supported");
+ *    }
+ *    if (zSpace?.isActive) {
+ *      console.log("zSpace is currently active");
+ *    }
+ *    ```
+ *
+ * 4. UI Integration (React example):
+ *    ```typescript
+ *    import { zSpaceIsActivePMAdapter } from "@vived/host/ZSpaceHost/Adapters";
+ *
+ *    function ZSpaceStatusIndicator() {
+ *      const appObjects = useAppObjects();
+ *      const [isActive, setIsActive] = useState(false);
+ *
+ *      useEffect(() => {
+ *        zSpaceIsActivePMAdapter.subscribe(appObjects, setIsActive);
+ *        return () => zSpaceIsActivePMAdapter.unsubscribe(appObjects, setIsActive);
+ *      }, [appObjects]);
+ *
+ *      return <div>zSpace is {isActive ? "active" : "inactive"}</div>;
+ *    }
+ *    ```
+ *
+ * Key components:
+ * - Entities/ZSpaceHost: Core entity storing zSpace state
+ * - UCs/StartZSpace: Use case to initialize and start zSpace
+ * - UCs/StopZSpace: Use case to stop active zSpace session
+ * - PMs/ZSpaceIsActivePM: Presentation manager for active state
+ * - PMs/EmulateZSpacePM: Presentation manager for emulation control
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ZSpaceHost/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,gDAA8B;AAC9B,6CAA2B;AAC3B,8CAA4B;AAC5B,0CAAwB;AACxB,wCAAsB;AACtB,wCAAsB","sourcesContent":["export * from \"./Adapters\";\r\nexport * from \"./Controllers\";\r\nexport * from \"./Entities\";\r\nexport * from \"./Factories\";\r\nexport * from \"./Mocks\";\r\nexport * from \"./PMs\";\r\nexport * from \"./UCs\";\r\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ZSpaceHost/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;;;;;;;;;;;;;;;;AAEH,6CAA2B;AAC3B,gDAA8B;AAC9B,6CAA2B;AAC3B,8CAA4B;AAC5B,0CAAwB;AACxB,wCAAsB;AACtB,wCAAsB","sourcesContent":["/**\r\n * ZSpaceHost Module\r\n * -----------------\r\n *\r\n * This module provides integration with zSpace stereoscopic 3D hardware through WebXR.\r\n * It allows applications to detect, start, stop, and monitor zSpace sessions,\r\n * as well as provide emulation when real hardware isn't available.\r\n *\r\n * Typical usage flow:\r\n *\r\n * 1. Initialization:\r\n *    ```typescript\r\n *    import { checkForWebXRSupport } from \"@vived/host/ZSpaceHost/UCs\";\r\n *\r\n *    // During app initialization\r\n *    await checkForWebXRSupport(appObjects);\r\n *    ```\r\n *\r\n * 2. Starting/Stopping zSpace:\r\n *    ```typescript\r\n *    import { StartZSpaceUC, StopZSpaceUC } from \"@vived/host/ZSpaceHost/UCs\";\r\n *\r\n *    // Start zSpace\r\n *    const startUC = StartZSpaceUC.get(appObjects);\r\n *    await startUC?.startZSpace();\r\n *\r\n *    // Stop zSpace\r\n *    const stopUC = StopZSpaceUC.get(appObjects);\r\n *    stopUC?.stopZSpace();\r\n *    ```\r\n *\r\n * 3. Checking Status:\r\n *    ```typescript\r\n *    import { ZSpaceHostEntity } from \"@vived/host/ZSpaceHost/Entities\";\r\n *\r\n *    const zSpace = ZSpaceHostEntity.get(appObjects);\r\n *    if (zSpace?.isSupported) {\r\n *      console.log(\"zSpace hardware is supported\");\r\n *    }\r\n *    if (zSpace?.isActive) {\r\n *      console.log(\"zSpace is currently active\");\r\n *    }\r\n *    ```\r\n *\r\n * 4. UI Integration (React example):\r\n *    ```typescript\r\n *    import { zSpaceIsActivePMAdapter } from \"@vived/host/ZSpaceHost/Adapters\";\r\n *\r\n *    function ZSpaceStatusIndicator() {\r\n *      const appObjects = useAppObjects();\r\n *      const [isActive, setIsActive] = useState(false);\r\n *\r\n *      useEffect(() => {\r\n *        zSpaceIsActivePMAdapter.subscribe(appObjects, setIsActive);\r\n *        return () => zSpaceIsActivePMAdapter.unsubscribe(appObjects, setIsActive);\r\n *      }, [appObjects]);\r\n *\r\n *      return <div>zSpace is {isActive ? \"active\" : \"inactive\"}</div>;\r\n *    }\r\n *    ```\r\n *\r\n * Key components:\r\n * - Entities/ZSpaceHost: Core entity storing zSpace state\r\n * - UCs/StartZSpace: Use case to initialize and start zSpace\r\n * - UCs/StopZSpace: Use case to stop active zSpace session\r\n * - PMs/ZSpaceIsActivePM: Presentation manager for active state\r\n * - PMs/EmulateZSpacePM: Presentation manager for emulation control\r\n */\r\n\r\nexport * from \"./Adapters\";\r\nexport * from \"./Controllers\";\r\nexport * from \"./Entities\";\r\nexport * from \"./Factories\";\r\nexport * from \"./Mocks\";\r\nexport * from \"./PMs\";\r\nexport * from \"./UCs\";\r\n"]}

package/dist/esm/Apps/Adapters/activeAppPMAdapter.js

@@ -1,6 +1,36 @@
 import { ActiveAppPM, defaultActiveAppVM } from "../PMs/ActiveAppPM";
+/**
+ * Adapter for the ActiveAppPM singleton presentation manager.
+ *
+ * This adapter provides a simple interface for framework components to connect with
+ * the ActiveAppPM presentation manager, which provides information about the currently
+ * active/selected app in the system.
+ *
+ * Usage in components:
+ * ```
+ * // React component example
+ * const [activeAppVm, setActiveAppVm] = useState(activeAppPMAdapter.defaultVM);
+ *
+ * useEffect(() => {
+ *   activeAppPMAdapter.subscribe(appObjects, setActiveAppVm);
+ *   return () => activeAppPMAdapter.unsubscribe(appObjects, setActiveAppVm);
+ * }, [appObjects]);
+ * ```
+ *
+ * @type {SingletonPmAdapter<ActiveAppVM>} Singleton adapter that provides the active app information
+ */
 export const activeAppPMAdapter = {
+    /**
+     * Default view model to use before the actual data is loaded
+     * or when the presentation manager isn't available
+     */
     defaultVM: defaultActiveAppVM,
+    /**
+     * Subscribes a view callback to the active app presentation manager
+     *
+     * @param appObjects - The app object repository
+     * @param setVM - Callback function that will receive view model updates
+     */
     subscribe: (appObjects, setVM) => {
         const pm = ActiveAppPM.get(appObjects);
         if (!pm) {
@@ -9,6 +39,12 @@ export const activeAppPMAdapter = {
         }
         pm.addView(setVM);
     },
+    /**
+     * Unsubscribes a view callback from the active app presentation manager
+     *
+     * @param appObjects - The app object repository
+     * @param setVM - The callback function to remove
+     */
     unsubscribe: (appObjects, setVM) => {
         const pm = ActiveAppPM.get(appObjects);
         if (!pm) {

package/dist/esm/Apps/Adapters/activeAppPMAdapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"activeAppPMAdapter.js","sourceRoot":"","sources":["../../../../src/Apps/Adapters/activeAppPMAdapter.ts"],"names":[],"mappings":"AACA,OAAO,EACL,WAAW,EAEX,kBAAkB,EACnB,MAAM,oBAAoB,CAAC;AAE5B,MAAM,CAAC,MAAM,kBAAkB,GAAoC;IACjE,SAAS,EAAE,kBAAkB;IAC7B,SAAS,EAAE,CAAC,UAAyB,EAAE,KAAgC,EAAE,EAAE;QACzE,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CACpB,oBAAoB,EACpB,4BAA4B,CAC7B,CAAC;YACF,OAAO;QACT,CAAC;QACD,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IACD,WAAW,EAAE,CACX,UAAyB,EACzB,KAAgC,EAChC,EAAE;QACF,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CACpB,oBAAoB,EACpB,4BAA4B,CAC7B,CAAC;YACF,OAAO;QACT,CAAC;QACD,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;CACF,CAAC","sourcesContent":["import { AppObjectRepo, SingletonPmAdapter } from \"@vived/core\";\r\nimport {\r\n  ActiveAppPM,\r\n  ActiveAppVM,\r\n  defaultActiveAppVM\r\n} from \"../PMs/ActiveAppPM\";\r\n\r\nexport const activeAppPMAdapter: SingletonPmAdapter<ActiveAppVM> = {\r\n  defaultVM: defaultActiveAppVM,\r\n  subscribe: (appObjects: AppObjectRepo, setVM: (vm: ActiveAppVM) => void) => {\r\n    const pm = ActiveAppPM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\r\n        \"activeAppPMAdapter\",\r\n        \"Unable to find ActiveAppPM\"\r\n      );\r\n      return;\r\n    }\r\n    pm.addView(setVM);\r\n  },\r\n  unsubscribe: (\r\n    appObjects: AppObjectRepo,\r\n    setVM: (vm: ActiveAppVM) => void\r\n  ) => {\r\n    const pm = ActiveAppPM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\r\n        \"activeAppPMAdapter\",\r\n        \"Unable to find ActiveAppPM\"\r\n      );\r\n      return;\r\n    }\r\n    pm.removeView(setVM);\r\n  }\r\n};\r\n"]}
+{"version":3,"file":"activeAppPMAdapter.js","sourceRoot":"","sources":["../../../../src/Apps/Adapters/activeAppPMAdapter.ts"],"names":[],"mappings":"AACA,OAAO,EACL,WAAW,EAEX,kBAAkB,EACnB,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAoC;IACjE;;;OAGG;IACH,SAAS,EAAE,kBAAkB;IAE7B;;;;;OAKG;IACH,SAAS,EAAE,CAAC,UAAyB,EAAE,KAAgC,EAAE,EAAE;QACzE,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CACpB,oBAAoB,EACpB,4BAA4B,CAC7B,CAAC;YACF,OAAO;QACT,CAAC;QACD,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,WAAW,EAAE,CACX,UAAyB,EACzB,KAAgC,EAChC,EAAE;QACF,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CACpB,oBAAoB,EACpB,4BAA4B,CAC7B,CAAC;YACF,OAAO;QACT,CAAC;QACD,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;CACF,CAAC","sourcesContent":["import { AppObjectRepo, SingletonPmAdapter } from \"@vived/core\";\r\nimport {\r\n  ActiveAppPM,\r\n  ActiveAppVM,\r\n  defaultActiveAppVM\r\n} from \"../PMs/ActiveAppPM\";\r\n\r\n/**\r\n * Adapter for the ActiveAppPM singleton presentation manager.\r\n *\r\n * This adapter provides a simple interface for framework components to connect with\r\n * the ActiveAppPM presentation manager, which provides information about the currently\r\n * active/selected app in the system.\r\n *\r\n * Usage in components:\r\n * ```\r\n * // React component example\r\n * const [activeAppVm, setActiveAppVm] = useState(activeAppPMAdapter.defaultVM);\r\n *\r\n * useEffect(() => {\r\n *   activeAppPMAdapter.subscribe(appObjects, setActiveAppVm);\r\n *   return () => activeAppPMAdapter.unsubscribe(appObjects, setActiveAppVm);\r\n * }, [appObjects]);\r\n * ```\r\n *\r\n * @type {SingletonPmAdapter<ActiveAppVM>} Singleton adapter that provides the active app information\r\n */\r\nexport const activeAppPMAdapter: SingletonPmAdapter<ActiveAppVM> = {\r\n  /**\r\n   * Default view model to use before the actual data is loaded\r\n   * or when the presentation manager isn't available\r\n   */\r\n  defaultVM: defaultActiveAppVM,\r\n\r\n  /**\r\n   * Subscribes a view callback to the active app presentation manager\r\n   *\r\n   * @param appObjects - The app object repository\r\n   * @param setVM - Callback function that will receive view model updates\r\n   */\r\n  subscribe: (appObjects: AppObjectRepo, setVM: (vm: ActiveAppVM) => void) => {\r\n    const pm = ActiveAppPM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\r\n        \"activeAppPMAdapter\",\r\n        \"Unable to find ActiveAppPM\"\r\n      );\r\n      return;\r\n    }\r\n    pm.addView(setVM);\r\n  },\r\n\r\n  /**\r\n   * Unsubscribes a view callback from the active app presentation manager\r\n   *\r\n   * @param appObjects - The app object repository\r\n   * @param setVM - The callback function to remove\r\n   */\r\n  unsubscribe: (\r\n    appObjects: AppObjectRepo,\r\n    setVM: (vm: ActiveAppVM) => void\r\n  ) => {\r\n    const pm = ActiveAppPM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\r\n        \"activeAppPMAdapter\",\r\n        \"Unable to find ActiveAppPM\"\r\n      );\r\n      return;\r\n    }\r\n    pm.removeView(setVM);\r\n  }\r\n};\r\n"]}

package/dist/esm/Apps/Adapters/appListPMAdapter.js

@@ -1,6 +1,35 @@
 import { AppsListPM } from "../PMs/AppsListPM";
+/**
+ * Adapter for the AppsListPM singleton presentation manager.
+ *
+ * This adapter provides a simple interface for framework components to connect with
+ * the AppsListPM presentation manager, which provides a list of available app IDs.
+ *
+ * Usage in components:
+ * ```
+ * // React component example
+ * const [appIds, setAppIds] = useState(appListPMAdapter.defaultVM);
+ *
+ * useEffect(() => {
+ *   appListPMAdapter.subscribe(appObjects, setAppIds);
+ *   return () => appListPMAdapter.unsubscribe(appObjects, setAppIds);
+ * }, [appObjects]);
+ * ```
+ *
+ * @type {SingletonPmAdapter<string[]>} Singleton adapter that provides a list of app IDs
+ */
 export const appListPMAdapter = {
+    /**
+     * Default view model to use before the actual data is loaded
+     * or when the presentation manager isn't available
+     */
     defaultVM: [],
+    /**
+     * Subscribes a view callback to the apps list presentation manager
+     *
+     * @param appObjects - The app object repository
+     * @param setVM - Callback function that will receive view model updates (array of app IDs)
+     */
     subscribe: (appObjects, setVM) => {
         const pm = AppsListPM.get(appObjects);
         if (!pm) {
@@ -9,6 +38,12 @@ export const appListPMAdapter = {
         }
         pm.addView(setVM);
     },
+    /**
+     * Unsubscribes a view callback from the apps list presentation manager
+     *
+     * @param appObjects - The app object repository
+     * @param setVM - The callback function to remove
+     */
     unsubscribe: (appObjects, setVM) => {
         const pm = AppsListPM.get(appObjects);
         if (!pm) {