@virtualdisplay.io/client 3.2.2 → 3.4.0

package/dist/virtualdisplay.client.es.js

@@ -54,9 +54,12 @@ const EVENT_NAMES = {
   IFRAME_READY: "iframe:ready",
   // Mutation flow (Client → Server)
   MUTATION_MESSAGE: "mutation:message",
+  // Config flow (Client → Server)
+  CONFIG_MESSAGE: "config:message",
   // State flow (Server → Client)
   MESSAGE_RECEIVED: "message:received",
-  STATE_CHANGED: "state:changed"
+  STATE_CHANGED: "state:changed",
+  INITIAL_STATE_RECEIVED: "state:initial-received"
 };
 const g = Object.freeze({
   debug: 0,
@@ -6925,7 +6928,8 @@ class MappingValidator {
 }
 const MESSAGE_TYPES = {
   MUTATION: "mutation",
-  STATE: "state"
+  STATE: "state",
+  CONFIG: "config"
 };
 function createMutationMessage(mutations) {
   if (!Array.isArray(mutations)) {
@@ -6937,7 +6941,7 @@ function createMutationMessage(mutations) {
   };
 }
 function isValidMessage(data) {
-  return isMutationMessage(data) || isStateMessage(data);
+  return isMutationMessage(data) || isStateMessage(data) || isConfigMessage(data);
 }
 function isMutationMessage(data) {
   if (typeof data !== "object" || data === null) {
@@ -6953,6 +6957,13 @@ function isStateMessage(data) {
   const obj = data;
   return obj.type === MESSAGE_TYPES.STATE && Array.isArray(obj.nodes);
 }
+function isConfigMessage(data) {
+  if (typeof data !== "object" || data === null) {
+    return false;
+  }
+  const obj = data;
+  return obj.type === MESSAGE_TYPES.CONFIG && typeof obj.config === "object" && obj.config !== null;
+}
 class AttributeService {
   attributes = /* @__PURE__ */ new Map();
   eventBus;
@@ -7148,8 +7159,14 @@ class MessageHandler {
     logger.debug("Message handler started listening");
   }
   setupOutgoingMessages() {
-    this.eventBus.on(EVENT_NAMES.MUTATION_MESSAGE, (event) => {
-      this.queueOrSend(event.message);
+    const outgoingEvents = [
+      EVENT_NAMES.MUTATION_MESSAGE,
+      EVENT_NAMES.CONFIG_MESSAGE
+    ];
+    outgoingEvents.forEach((eventName) => {
+      this.eventBus.on(eventName, (event) => {
+        this.queueOrSend(event.message);
+      });
     });
   }
   setupReadyListener() {
@@ -7186,7 +7203,7 @@ class NodeSelector {
       logger.warn(`Cannot toggle node ${this.nodeId}: node not found`);
       return;
     }
-    if (node.isVisible === true) {
+    if (node.isVisible) {
       this.hide();
       return;
     }
@@ -7224,6 +7241,7 @@ class ModelNode {
   name;
   type;
   visible;
+  onChange;
   constructor(params) {
     this.id = params.id;
     this.name = params.name;
@@ -7243,6 +7261,7 @@ class ModelNode {
 class StateService {
   nodes = /* @__PURE__ */ new Map();
   eventBus;
+  hasReceivedInitialSync = false;
   constructor(eventBus) {
     this.eventBus = eventBus;
     this.eventBus.on(EVENT_NAMES.MESSAGE_RECEIVED, (event) => {
@@ -7255,28 +7274,32 @@ class StateService {
       currentNodeCount: this.nodeCount
     });
     if (isStateMessage(message)) {
-      this.updateState(message.nodes);
+      this.updateState(message.nodes, message.isInitial);
     }
   }
-  updateState(newNodes) {
-    const wasInitial = !this.hasInitialState;
+  updateState(newNodes, isInitial) {
     logger.debug("Updating state with nodes from server", {
       incomingNodes: newNodes.length,
-      isInitialState: wasInitial,
+      isInitialState: isInitial,
       currentNodes: this.nodeCount
     });
     for (const nodeData of newNodes) {
-      this.updateOrCreateNode(nodeData);
+      const shouldProcessNode = !isInitial || !this.nodes.has(nodeData.id);
+      if (shouldProcessNode) {
+        this.updateOrCreateNode(nodeData);
+      }
     }
     this.eventBus.emit(EVENT_NAMES.STATE_CHANGED, {
       nodes: this.getAllNodes()
     });
     logger.info("State updated", {
       totalNodes: this.nodeCount,
-      wasInitialState: wasInitial
+      wasInitialState: isInitial
     });
-    if (wasInitial) {
+    if (isInitial && !this.hasReceivedInitialSync) {
+      this.hasReceivedInitialSync = true;
       logger.info("Initial state received - client is now ready");
+      this.eventBus.emit(EVENT_NAMES.INITIAL_STATE_RECEIVED, {});
     }
   }
   updateOrCreateNode(newNodeData) {
@@ -7285,8 +7308,12 @@ class StateService {
       this.createNewNode(newNodeData);
       return;
     }
+    const previousVisibility = existingNode.isVisible;
     const visibilityMethod = newNodeData.visible ? "show" : "hide";
     existingNode[visibilityMethod]();
+    if (previousVisibility !== existingNode.isVisible && existingNode.onChange !== void 0) {
+      existingNode.onChange();
+    }
     logger.debug("Updated existing node", {
       id: existingNode.id,
       name: existingNode.name,
@@ -7316,16 +7343,102 @@ class StateService {
     return Array.from(this.nodes.values());
   }
   get isReady() {
-    return this.hasInitialState;
+    return this.hasReceivedInitialSync;
   }
   get nodeCount() {
     return this.nodes.size;
   }
-  get hasInitialState() {
-    return this.nodeCount > 0;
-  }
   clear() {
     this.nodes.clear();
+    this.hasReceivedInitialSync = false;
+  }
+}
+class VirtualdisplayViewerService {
+  eventBus;
+  constructor(eventBus) {
+    this.eventBus = eventBus;
+  }
+  /**
+   * Send initial configuration based on client options
+   * Only sends config when values are false (server defaults to true)
+   */
+  sendInitialConfig(options) {
+    const config = {};
+    if (options.arEnabled === false) {
+      config.arEnabled = false;
+    }
+    if (options.fullscreenEnabled === false) {
+      config.fullscreenEnabled = false;
+    }
+    if (options.loadingIndicatorEnabled === false) {
+      config.loadingIndicatorEnabled = false;
+    }
+    if (Object.keys(config).length > 0) {
+      logger.debug("Sending initial UI configuration", config);
+      this.sendUIConfig(config);
+    }
+  }
+  /**
+   * Update AR button visibility
+   */
+  setArEnabled(enabled) {
+    logger.debug(`Setting AR button enabled: ${enabled}`);
+    this.sendUIConfig({ arEnabled: enabled });
+  }
+  /**
+   * Update fullscreen button visibility
+   */
+  setFullscreenEnabled(enabled) {
+    logger.debug(`Setting fullscreen button enabled: ${enabled}`);
+    this.sendUIConfig({ fullscreenEnabled: enabled });
+  }
+  /**
+   * Update loading indicator visibility
+   */
+  setLoadingIndicatorEnabled(enabled) {
+    logger.debug(`Setting loading indicator enabled: ${enabled}`);
+    this.sendUIConfig({ loadingIndicatorEnabled: enabled });
+  }
+  /**
+   * Update multiple UI settings at once
+   */
+  updateUIConfig(config) {
+    logger.debug("Updating UI configuration", config);
+    this.sendUIConfig(config);
+  }
+  /**
+   * Hide all UI elements
+   */
+  hideAllUI() {
+    logger.debug("Hiding all UI elements");
+    this.sendUIConfig({
+      arEnabled: false,
+      fullscreenEnabled: false,
+      loadingIndicatorEnabled: false
+    });
+  }
+  /**
+   * Show all UI elements
+   */
+  showAllUI() {
+    logger.debug("Showing all UI elements");
+    this.sendUIConfig({
+      arEnabled: true,
+      fullscreenEnabled: true,
+      loadingIndicatorEnabled: true
+    });
+  }
+  /**
+   * Send UI configuration to server
+   */
+  sendUIConfig(uiConfig) {
+    const config = { ui: uiConfig };
+    const message = {
+      type: MESSAGE_TYPES.CONFIG,
+      config
+    };
+    logger.debug("Emitting CONFIG message", message);
+    this.eventBus.emit(EVENT_NAMES.CONFIG_MESSAGE, { message });
   }
 }
 class VirtualdisplayClient {
@@ -7333,6 +7446,7 @@ class VirtualdisplayClient {
   attributeService;
   stateService;
   messageHandler;
+  viewerService;
   options;
   iframe;
   constructor(options) {
@@ -7341,8 +7455,10 @@ class VirtualdisplayClient {
     this.attributeService = new AttributeService(this.eventBus);
     this.stateService = new StateService(this.eventBus);
     this.messageHandler = new MessageHandler(this.eventBus);
+    this.viewerService = new VirtualdisplayViewerService(this.eventBus);
     this.initializeLogging();
     this.createAndConnectIframe();
+    this.setupInitialConfig();
   }
   initializeLogging() {
     if (this.options.debug === true) {
@@ -7361,6 +7477,11 @@ class VirtualdisplayClient {
     logger.debug("Iframe created, setting up messaging");
     this.messageHandler.setIframe(this.iframe);
   }
+  setupInitialConfig() {
+    this.eventBus.once(EVENT_NAMES.IFRAME_READY, () => {
+      this.viewerService.sendInitialConfig(this.options);
+    });
+  }
   /**
    * Load attribute mapping configuration
    * @throws {VirtualdisplayError} When mapping configuration is invalid
@@ -7405,6 +7526,29 @@ class VirtualdisplayClient {
   getNodes() {
     return this.stateService.getAllNodes();
   }
+  /**
+   * Check if the client has received initial state and is ready
+   */
+  get isReady() {
+    return this.stateService.isReady;
+  }
+  /**
+   * Register a callback to be called when the client is ready
+   * If already ready, the callback is called immediately
+   */
+  onReady(callback) {
+    if (this.stateService.isReady) {
+      callback();
+      return;
+    }
+    this.eventBus.once(EVENT_NAMES.INITIAL_STATE_RECEIVED, callback);
+  }
+  /**
+   * Get the viewer service for UI configuration
+   */
+  get viewer() {
+    return this.viewerService;
+  }
   destroy() {
     logger.info("Destroying Virtualdisplay client");
     this.attributeService.clear();
@@ -7430,6 +7574,7 @@ export {
   NodeSelector,
   VirtualdisplayClient,
   VirtualdisplayError,
+  VirtualdisplayViewerService,
   enableDebugMode,
   isDebugMode,
   logger,