@virtualdisplay.io/client 4.0.0-alpha.22 → 4.0.0-alpha.24

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 4.0.0-alpha.24
+
+### Patch Changes
+
+Accept `undefined` for the optional `ClientOptions` fields `language`, `debug` and `traceparent`. Projects that enable `exactOptionalPropertyTypes` can now pass a possibly-undefined value straight through without a type error.
+
+## 4.0.0-alpha.23
+
+### Patch Changes
+
+Fix the sidebar configurator toggle button appearing separated from the AR and fullscreen buttons on narrow embeds. All three controls now sit together in one row instead of the toggle floating above them.
+
 ## 4.0.0-alpha.22
 
 ### Patch Changes

package/dist/index.d.ts

@@ -311,18 +311,6 @@ interface MessengerOptions {
      * When false (default), incoming messages are processed immediately.
      */
     bufferIncoming?: boolean;
-    /**
-     * When buffering, messages where this returns false bypass the buffer
-     * and are routed to handlers immediately. Used for urgent messages
-     * like CONFIG that must be handled before the model loads.
-     */
-    shouldBuffer?: (message: Message) => boolean;
-    /**
-     * Restrict postMessage to a specific origin (e.g. 'https://example.com').
-     * Defaults to '*' when not set. Set this when the target origin is known
-     * to prevent messages from being intercepted by unintended recipients.
-     */
-    targetOrigin?: string;
     /**
      * Which protocol to validate incoming messages against — not whether to validate.
      * Both sides always reject browser-extension noise and unknown message types. The
@@ -357,11 +345,11 @@ interface MessengerOptions {
  * messenger.send({ type: 'mutation', mutations, isInitial: true });
  * ```
  *
- * @example Server (inside iframe — both queues, CONFIG bypasses consumer)
+ * @example Server (inside iframe — both queues)
  * ```ts
  * const messenger = new IframeMessenger(
  *   () => window.parent !== window ? window.parent : null,
- *   { bufferIncoming: true, shouldBuffer: (msg) => msg.type !== 'config' },
+ *   { bufferIncoming: true },
  * );
  * messenger.on('mutation', processMutation);
  * messenger.on('config', applyConfig);
@@ -376,7 +364,6 @@ declare class IframeMessenger {
     private readonly handlers;
     private readonly publisher;
     private readonly consumer;
-    private readonly shouldBuffer;
     private listener;
     private readonly sourceId;
     private targetOrigin;
@@ -386,10 +373,6 @@ declare class IframeMessenger {
      * Register a handler for a specific message type
      */
     on(type: string, handler: MessageCallback): void;
-    /**
-     * Remove a handler for a specific message type
-     */
-    off(type: string): void;
     /**
      * Update the target origin for outgoing postMessage calls.
      * Use when the target origin is discovered at runtime (e.g. from the first incoming message).
@@ -403,8 +386,8 @@ declare class IframeMessenger {
     /**
      * Feed a message through the same routing path as one that just arrived via
      * postMessage, without an actual postMessage round-trip: still validated
-     * against `isValid`, and still respects the consumer queue's buffering and
-     * the `shouldBuffer` bypass. For a transport that delivers messages some
+     * against `isValid`, and still respects the consumer queue's buffering. For
+     * a transport that delivers messages some
      * other way than the iframe channel this messenger already listens on (the
      * viewer engine's SSE-sourced live sync channel, ar-session-handoff) and
      * needs them to land exactly where a postMessage would.
@@ -866,17 +849,17 @@ interface ClientOptions {
     readonly parent: string | HTMLElement;
     readonly model: string;
     readonly license: string;
-    readonly debug?: boolean;
-    readonly language?: string;
+    readonly debug?: boolean | undefined;
+    readonly language?: string | undefined;
     /** W3C traceparent string to propagate to the viewer iframe for end-to-end tracing. */
-    readonly traceparent?: string;
+    readonly traceparent?: string | undefined;
     /**
      * A source viewer session id to restore into this mount (ar-session-handoff): the
      * iframe's metadata fetch merges that session's latest configuration into the
      * attribute defaults, so the viewer boots straight into it. Internal option, used
      * by the AR landing, not a customer-facing setting.
      */
-    readonly session?: string;
+    readonly session?: string | undefined;
     /**
      * Override viewer settings from metadata. Omitted fields use the metadata value.
      * A warning is logged when an override differs from the metadata value.
@@ -966,6 +949,12 @@ interface BaseClientExtensions {
      * so the host cannot be a single build-time env shared by both.
      */
     readonly serverHost?: string;
+    /**
+     * Extra query parameters for the viewer iframe URL. An extension seam like
+     * `serverHost`: a client type's fixed capability flags (the studio client's
+     * metadata-override boot mode), never a per-instance public option.
+     */
+    readonly iframeParams?: Readonly<Record<string, string>>;
     /**
      * The AR flow behind the standard interface's AR button. The public client
      * composes its `ArActivation` here; the studio composes nothing (the editor
@@ -999,6 +988,7 @@ declare class BaseClient {
     private readonly ui;
     private readonly options;
     private readonly serverHost;
+    private readonly iframeParams;
     /** The composed AR flow, or undefined in builds without one (the studio). */
     private readonly arActivation;
     /** The composed sync tracker, or undefined in builds without one (the studio). */