@virtualdisplay.io/client 3.4.0 → 3.5.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [3.5.0](https://github.com/virtualdisplay-io/client/compare/v3.4.1...v3.5.0) (2025-07-16)
+
+### ✨ Features
+
+* camera control API ([#4](https://github.com/virtualdisplay-io/client/issues/4)) ([1e4c147](https://github.com/virtualdisplay-io/client/commit/1e4c14747cad2a4617c4cc763522b50941adaa7f))
+
+## [3.4.1](https://github.com/virtualdisplay-io/client/compare/v3.4.0...v3.4.1) (2025-07-10)
+
+### 🐛 Bug Fixes
+
+* EventBus once handlers and logging improvements ([#3](https://github.com/virtualdisplay-io/client/issues/3)) ([5a99d8d](https://github.com/virtualdisplay-io/client/commit/5a99d8d6ef82d058799734b54c98ca171d17dd36))
+
 ## [3.4.0](https://github.com/virtualdisplay-io/client/compare/v3.3.0...v3.4.0) (2025-07-09)
 
 ### ✨ Features

package/dist/index.d.ts

@@ -121,6 +121,56 @@ export declare interface AttributeValueConfig {
     readonly isSelected?: boolean;
 }
 
+/**
+ * Camera control API for positioning and zoom
+ * Uses chaining pattern for building commands
+ */
+export declare class Camera {
+    private readonly eventBus;
+    private commands;
+    constructor(eventBus: EventBus);
+    /**
+     * Rotate camera horizontally
+     * @param degrees - Absolute rotation in degrees (0 = front view)
+     */
+    rotate(degrees: number): this;
+    /**
+     * Tilt camera vertically
+     * @param degrees - Absolute tilt in degrees (0 = top view, 90 = horizontal)
+     */
+    tilt(degrees: number): this;
+    /**
+     * Zoom camera
+     * @param percentage - Zoom percentage (100 = normal, >100 = zoom in, <100 = zoom out)
+     */
+    zoom(percentage: number): this;
+    /**
+     * Execute accumulated camera commands
+     */
+    set(): void;
+    /**
+     * Reset camera to initial position
+     * This is not chainable and executes immediately
+     */
+    reset(): void;
+}
+
+/**
+ * Camera command
+ */
+export declare interface CameraCommand {
+    readonly action: 'rotate' | 'tilt' | 'zoom' | 'reset';
+    readonly value?: number;
+}
+
+/**
+ * Camera message sent to server
+ */
+export declare interface CameraMessage {
+    readonly type: typeof MESSAGE_TYPES.CAMERA;
+    readonly commands: CameraCommand[];
+}
+
 /**
  * Configuration options for VirtualdisplayClient
  */
@@ -157,6 +207,7 @@ export declare interface DomainEvents extends Record<string, unknown> {
     [EVENT_NAMES.IFRAME_READY]: VoidEvent;
     [EVENT_NAMES.MUTATION_MESSAGE]: MessageEvent_2<MutationMessage>;
     [EVENT_NAMES.CONFIG_MESSAGE]: MessageEvent_2<ConfigMessage>;
+    [EVENT_NAMES.CAMERA_MESSAGE]: MessageEvent_2<CameraMessage>;
     [EVENT_NAMES.MESSAGE_RECEIVED]: MessageEvent_2;
     [EVENT_NAMES.STATE_CHANGED]: StateChangedEvent;
     [EVENT_NAMES.INITIAL_STATE_RECEIVED]: VoidEvent;
@@ -185,6 +236,7 @@ export declare const EVENT_NAMES: {
     readonly IFRAME_READY: "iframe:ready";
     readonly MUTATION_MESSAGE: "mutation:message";
     readonly CONFIG_MESSAGE: "config:message";
+    readonly CAMERA_MESSAGE: "camera:message";
     readonly MESSAGE_RECEIVED: "message:received";
     readonly STATE_CHANGED: "state:changed";
     readonly INITIAL_STATE_RECEIVED: "state:initial-received";
@@ -198,7 +250,14 @@ declare class EventBus {
     private readonly listeners;
     on<K extends keyof DomainEvents>(event: K, listener: EventListener_2<DomainEvents[K]>): void;
     emit<K extends keyof DomainEvents>(event: K, payload: DomainEvents[K]): void;
+    /**
+     * Register a listener that will be called only once
+     * The listener is automatically removed after the first call
+     */
     once<K extends keyof DomainEvents>(event: K, listener: EventListener_2<DomainEvents[K]>): void;
+    /**
+     * Remove a specific listener for an event
+     */
     off<K extends keyof DomainEvents>(event: K, listener: EventListener_2<DomainEvents[K]>): void;
 }
 
@@ -299,7 +358,7 @@ export declare class MappingValidator {
 /**
  * Union of all possible messages
  */
-export declare type Message = MutationMessage | StateMessage | ConfigMessage;
+export declare type Message = MutationMessage | StateMessage | ConfigMessage | CameraMessage;
 
 /**
  * Types of messages exchanged between client and server
@@ -309,6 +368,7 @@ export declare const MESSAGE_TYPES: {
     readonly MUTATION: "mutation";
     readonly STATE: "state";
     readonly CONFIG: "config";
+    readonly CAMERA: "camera";
 };
 
 /**
@@ -476,6 +536,7 @@ export declare class VirtualdisplayClient {
     private readonly stateService;
     private readonly messageHandler;
     private readonly viewerService;
+    private readonly cameraApi;
     private readonly options;
     private iframe;
     constructor(options: ClientOptions);
@@ -513,6 +574,10 @@ export declare class VirtualdisplayClient {
      * Get the viewer service for UI configuration
      */
     get viewer(): VirtualdisplayViewerService;
+    /**
+     * Get the camera control API
+     */
+    get camera(): Camera;
     destroy(): void;
 }