@vived/host 4.3.0 → 4.4.1

package/dist/types/ZSpaceHost/UCs/checkForZSpaceSupport.d.ts

@@ -1,3 +1,39 @@
 import { AppObjectRepo } from "@vived/core";
+/**
+ * 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
+ */
 export declare function checkForWebXRSupport(appObjects: AppObjectRepo): Promise<void>;
 //# sourceMappingURL=checkForZSpaceSupport.d.ts.map

package/dist/types/ZSpaceHost/UCs/checkForZSpaceSupport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkForZSpaceSupport.d.ts","sourceRoot":"","sources":["../../../../src/ZSpaceHost/UCs/checkForZSpaceSupport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CA4B7E"}
+{"version":3,"file":"checkForZSpaceSupport.d.ts","sourceRoot":"","sources":["../../../../src/ZSpaceHost/UCs/checkForZSpaceSupport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CA4B7E"}

package/dist/types/ZSpaceHost/index.d.ts

@@ -1,3 +1,71 @@
+/**
+ * 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
+ */
 export * from "./Adapters";
 export * from "./Controllers";
 export * from "./Entities";

package/dist/types/ZSpaceHost/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ZSpaceHost/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ZSpaceHost/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vived/host",
-  "version": "4.3.0",
+  "version": "4.4.1",
   "description": "Public Host package for the VIVED Learning App system",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",