@virtualdisplay.io/client 3.5.0 → 3.6.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.6.0](https://github.com/virtualdisplay-io/client/compare/v3.5.1...v3.6.0) (2025-07-23)
+
+### ✨ Features
+
+* add camera configuration support ([#6](https://github.com/virtualdisplay-io/client/issues/6)) ([a6bce4b](https://github.com/virtualdisplay-io/client/commit/a6bce4bfd0d55362e76c893ddf5ed28409dc8bec))
+
+## [3.5.1](https://github.com/virtualdisplay-io/client/compare/v3.5.0...v3.5.1) (2025-07-18)
+
+### ♻️ Code Refactoring
+
+* remove validation of outgoing message types ([#5](https://github.com/virtualdisplay-io/client/issues/5)) ([5f4f985](https://github.com/virtualdisplay-io/client/commit/5f4f9853d65af676aec3a865864f43461fdb6ca5))
+
 ## [3.5.0](https://github.com/virtualdisplay-io/client/compare/v3.4.1...v3.5.0) (2025-07-16)
 
 ### ✨ Features

package/dist/index.d.ts

@@ -163,6 +163,19 @@ export declare interface CameraCommand {
     readonly value?: number;
 }
 
+/**
+ * Camera configuration options
+ */
+export declare interface CameraConfig {
+    readonly initialRotate?: number;
+    readonly initialTilt?: number;
+    readonly initialZoom?: number;
+    readonly minZoom?: number;
+    readonly maxZoom?: number;
+    readonly minTilt?: number;
+    readonly maxTilt?: number;
+}
+
 /**
  * Camera message sent to server
  */
@@ -183,6 +196,8 @@ export declare interface ClientOptions {
     readonly arEnabled?: boolean;
     readonly fullscreenEnabled?: boolean;
     readonly loadingIndicatorEnabled?: boolean;
+    readonly ui?: UIConfig;
+    readonly camera?: CameraConfig;
 }
 
 /**
@@ -225,6 +240,7 @@ export declare const ERROR_CODES: {
     readonly INVALID_MAPPING: "INVALID_MAPPING";
     readonly PARENT_NOT_FOUND: "PARENT_NOT_FOUND";
     readonly INVALID_MUTATIONS: "INVALID_MUTATIONS";
+    readonly INVALID_PARAMETER: "INVALID_PARAMETER";
 };
 
 export declare type ErrorCode = typeof ERROR_CODES[keyof typeof ERROR_CODES];
@@ -240,6 +256,8 @@ export declare const EVENT_NAMES: {
     readonly MESSAGE_RECEIVED: "message:received";
     readonly STATE_CHANGED: "state:changed";
     readonly INITIAL_STATE_RECEIVED: "state:initial-received";
+    readonly SNAPSHOT_MESSAGE: "snapshot:take";
+    readonly SNAPSHOT_DEVELOPED: "snapshot:developed";
 };
 
 /**
@@ -358,7 +376,7 @@ export declare class MappingValidator {
 /**
  * Union of all possible messages
  */
-export declare type Message = MutationMessage | StateMessage | ConfigMessage | CameraMessage;
+export declare type Message = MutationMessage | StateMessage | ConfigMessage | CameraMessage | SnapshotRequestMessage | SnapshotDevelopedMessage;
 
 /**
  * Types of messages exchanged between client and server
@@ -369,6 +387,7 @@ export declare const MESSAGE_TYPES: {
     readonly STATE: "state";
     readonly CONFIG: "config";
     readonly CAMERA: "camera";
+    readonly SNAPSHOT: "snapshot";
 };
 
 /**
@@ -476,6 +495,80 @@ export declare class NodeSelector {
 
 declare type NodeType = typeof NODE_TYPES[keyof typeof NODE_TYPES];
 
+/**
+ * Represents a photo being captured
+ * Pure domain object that manages callbacks for when the photo is developed
+ */
+export declare class Photo {
+    private readonly filename;
+    private readonly callbacks;
+    private developed;
+    private photoData;
+    constructor(filename: string);
+    /**
+     * Register a callback for when the photo is developed
+     * If the photo is already developed, the callback is called immediately
+     *
+     * @param callback Function to call with photo data
+     * @returns This Photo instance for chaining
+     */
+    onDeveloped(callback: (photo: PhotoData) => void): this;
+    /**
+     * Get the filename for this photo
+     */
+    getFilename(): string;
+    /**
+     * Mark the photo as developed and notify all callbacks
+     * This method is called by the SnapshotMessageHandler when the photo data arrives
+     */
+    develop(photoData: PhotoData): void;
+}
+
+export declare interface PhotoData {
+    readonly filename: string;
+    readonly data: string;
+}
+
+/**
+ * API for taking screenshots of the 3D model
+ * Following the camera analogy: take() triggers capture, onDeveloped() gets result
+ */
+export declare class Snapshot {
+    private readonly eventBus;
+    private readonly validExtensions;
+    private readonly messageHandler;
+    constructor(eventBus: EventBus);
+    /**
+     * Take a snapshot of the current 3D model view
+     *
+     * @param filename The filename for the snapshot (must include valid extension)
+     * @returns Photo object for registering callbacks
+     * @throws VirtualdisplayError if filename is invalid
+     */
+    take(filename: string): Photo;
+    /**
+     * Validate filename has a valid image extension
+     */
+    private validateFilename;
+}
+
+/**
+ * Snapshot developed message received from server
+ */
+export declare interface SnapshotDevelopedMessage {
+    readonly type: typeof MESSAGE_TYPES.SNAPSHOT;
+    readonly filename: string;
+    readonly data: string;
+}
+
+/**
+ * Snapshot request message sent to server
+ */
+export declare interface SnapshotRequestMessage {
+    readonly type: typeof MESSAGE_TYPES.SNAPSHOT;
+    readonly filename: string;
+}
+
 declare interface StateChangedEvent {
     nodes: ModelNode[];
 }
@@ -524,6 +617,7 @@ export declare interface UIConfig {
  */
 export declare interface ViewerConfig {
     readonly ui?: UIConfig;
+    readonly camera?: CameraConfig;
 }
 
 /**
@@ -537,6 +631,7 @@ export declare class VirtualdisplayClient {
     private readonly messageHandler;
     private readonly viewerService;
     private readonly cameraApi;
+    private readonly snapshotApi;
     private readonly options;
     private iframe;
     constructor(options: ClientOptions);
@@ -578,6 +673,10 @@ export declare class VirtualdisplayClient {
      * Get the camera control API
      */
     get camera(): Camera;
+    /**
+     * Get the snapshot API for taking screenshots
+     */
+    get snapshot(): Snapshot;
     destroy(): void;
 }
 
@@ -604,9 +703,24 @@ export declare class VirtualdisplayViewerService {
     constructor(eventBus: EventBus);
     /**
      * Send initial configuration based on client options
-     * Only sends config when values are false (server defaults to true)
+     * Supports both individual properties and ui object
      */
     sendInitialConfig(options: ClientOptions): void;
+    /**
+     * Build UI configuration from client options
+     *
+     * Supports both legacy properties (options.arEnabled) and the newer ui object
+     * for backward compatibility. Legacy properties take precedence when both exist.
+     */
+    private buildUIConfig;
+    /**
+     * Extract UI values from options, with legacy properties taking precedence
+     */
+    private extractUIValues;
+    /**
+     * Build viewer configuration from UI config and camera config
+     */
+    private buildViewerConfig;
     /**
      * Update AR button visibility
      */
@@ -635,6 +749,10 @@ export declare class VirtualdisplayViewerService {
      * Send UI configuration to server
      */
     private sendUIConfig;
+    /**
+     * Send full viewer configuration to server
+     */
+    private sendConfig;
 }
 
 declare interface VoidEvent {