vim-web 0.3.40 → 0.3.42-dev.0

package/dist/types/core-viewers/ultra/index.d.ts

@@ -5,4 +5,5 @@ export * from './viewer/vim';
 export * from './utils/math3d';
 export * from './viewer/color';
 export type { ILoadRequest, VimRequestErrorType } from './viewer/loadRequest';
-export type { ClientState } from './viewer/socketClient';
+export type { ClientState, ConnectionSettings } from './viewer/socketClient';
+export type { VimSource } from './viewer/rpcSafeClient';

package/dist/types/core-viewers/ultra/viewer/logger.d.ts

@@ -1,5 +1,5 @@
 export interface ILogger {
-    log(message: string): void;
+    log(message: string, obj?: any): void;
     error: (message: string, e: unknown) => void;
 }
 export declare const defaultLogger: ILogger;

package/dist/types/core-viewers/ultra/viewer/renderer.d.ts

@@ -1,4 +1,5 @@
 import { RGBA } from "../utils/math3d";
+import { ILogger } from "./logger";
 import { RpcSafeClient, SceneSettings } from "./rpcSafeClient";
 import { ClientStreamError } from "./socketClient";
 /**
@@ -32,6 +33,7 @@ export interface IRenderer {
  */
 export declare class Renderer implements IRenderer {
     private _rpc;
+    private _logger;
     private _settings;
     private _animationFrame;
     private _updateLighting;
@@ -42,7 +44,7 @@ export declare class Renderer implements IRenderer {
      * @param rpc - RPC client for communication with the rendering backend
      * @param settings - Optional partial render settings to override defaults
      */
-    constructor(rpc: RpcSafeClient, settings?: Partial<RenderSettings>);
+    constructor(rpc: RpcSafeClient, logger: ILogger, settings?: Partial<RenderSettings>);
     /**
      * Validates the connection to the server by attempting to start a scene.
      * @returns A promise that resolves to a ClientStreamError if the connection fails, or undefined if successful.

package/dist/types/core-viewers/ultra/viewer/rpcClient.d.ts

@@ -18,6 +18,7 @@ export declare const materialHandles: MaterialHandle[];
 export declare class RpcClient {
     private readonly _messenger;
     get url(): string;
+    get connected(): boolean;
     constructor(_messenger: SocketClient);
     readonly API_VERSION = "5.0.0";
     RPCAddNodeFlags(componentHandle: number, nodes: number[], flags: number): void;

package/dist/types/core-viewers/ultra/viewer/rpcSafeClient.d.ts

@@ -1,6 +1,10 @@
 import { Box3, RGBA, RGBA32, Segment, Vector2, Vector3 } from "../utils/math3d";
 import { HitCheckResult } from "./marshal";
 import { MaterialHandle, RpcClient } from "./rpcClient";
+export type VimSource = {
+    url: string;
+    authToken?: string;
+};
 export type VimLoadingState = {
     status: VimLoadingStatus;
     progress: number;
@@ -34,6 +38,7 @@ export declare class RpcSafeClient {
     private readonly rpc;
     private readonly batchSize;
     get url(): string;
+    get connected(): boolean;
     constructor(rpc: RpcClient, batchSize?: number);
     /*******************************************************************************
      * SCENE MANAGEMENT METHODS
@@ -213,18 +218,18 @@ export declare class RpcSafeClient {
      ******************************************************************************/
     /**
      * Loads a VIM file from the local filesystem.
-     * @param fileName - The path to the VIM file (supports file:// protocol)
+     * @param source - The path to the VIM file (supports file:// protocol)
      * @returns Promise resolving to the handle of the loaded VIM component
      * @throws {Error} If the filename is invalid or empty
      */
-    RPCLoadVim(fileName: string): Promise<number>;
+    RPCLoadVim(source: VimSource): Promise<number>;
     /**
      * Loads a VIM file from a remote URL.
      * @param url - The URL of the VIM file to load
      * @returns Promise resolving to the handle of the loaded VIM component
      * @throws {Error} If the URL is invalid
      */
-    RPCLoadVimURL(url: string): Promise<number>;
+    RPCLoadVimURL(source: VimSource): Promise<number>;
     /**
      * Retrieves the current loading state and progress of a VIM component.
      * @param componentHandle - The handle of the VIM component

package/dist/types/core-viewers/ultra/viewer/socketClient.d.ts

@@ -1,6 +1,11 @@
 import * as Protocol from './protocol';
 import { Marshal } from './marshal';
 import { ILogger } from './logger';
+export declare const DEFAULT_LOCAL_ULTRA_SERVER_URL = "ws://localhost:8123";
+export type ConnectionSettings = {
+    url?: string;
+    attempts?: number;
+};
 export type ClientState = ClientStateConnecting | ClientStateConnected | ClientStateDisconnected | ClientStateValidating | ClientError;
 export type ClientError = ClientStateCompatibilityError | ClientStateConnectionError | ClientStreamError;
 export type ClientStateConnecting = {
@@ -53,6 +58,7 @@ export declare class SocketClient {
     private _rpcCallId;
     private _reconnectTimeout;
     private _connectionTimeout;
+    private _attempts;
     private _validateConnection;
     /**
      * Callback function to handle incoming video frames.
@@ -94,7 +100,7 @@ export declare class SocketClient {
      * @param url - The WebSocket URL to connect to.
      * @returns A promise that resolves when the connection is established.
      */
-    connect(url: string): Promise<void>;
+    connect(settings: ConnectionSettings): Promise<void>;
     /**
      * Disconnects from the current WebSocket server.
      */

package/dist/types/core-viewers/ultra/viewer/viewer.d.ts

@@ -1,5 +1,5 @@
 import { IInputs } from './inputs/inputs';
-import { ClientState } from './socketClient';
+import { ClientState, ConnectionSettings } from './socketClient';
 import { IDecoder } from './decoder';
 import { Vim } from './vim';
 import { ILoadRequest } from './loadRequest';
@@ -7,11 +7,10 @@ import { ILogger } from './logger';
 import { IViewport } from './viewport';
 import { ColorManager } from './colorManager';
 import { ICamera } from './camera';
-import { RpcSafeClient } from './rpcSafeClient';
+import { RpcSafeClient, VimSource } from './rpcSafeClient';
 import { ISimpleEvent } from 'ste-simple-events';
 import { IReadonlyVimCollection } from './vimCollection';
 import { IRenderer } from './renderer';
-export declare const DEFAULT_LOCAL_ULTRA_SERVER_URL = "ws://localhost:8123";
 export declare const INVALID_HANDLE = 4294967295;
 /**
  * The main Viewer class responsible for managing VIM files,
@@ -97,17 +96,17 @@ export declare class Viewer {
      * @param url - The server URL to connect to. Defaults to 'ws://localhost:8123'.
      * @returns A promise that resolves when the connection is established.
      */
-    connect(url?: string): Promise<void>;
+    connect(settings?: ConnectionSettings): Promise<void>;
     /**
      * Disconnects from the current VIM Ultra server.
      */
     disconnect(): void;
     /**
      * Requests the server to load the given URL or file path.
-     * @param path - The path or URL to the VIM file.
+     * @param source - The path or URL to the VIM file.
      * @returns A load request object that can be used to wait for the load to complete.
      */
-    loadVim(path: string): ILoadRequest;
+    loadVim(source: VimSource): ILoadRequest;
     /**
      * Unloads the given VIM from the viewer.
      * @param vim - The VIM instance to unload.

package/dist/types/core-viewers/ultra/viewer/viewport.d.ts

@@ -1,3 +1,4 @@
+import { ILogger } from "./logger";
 import { RpcSafeClient } from "./rpcSafeClient";
 /**
  * Interface defining viewport functionality
@@ -15,6 +16,7 @@ export declare class Viewport {
     /** The HTML canvas element used for rendering */
     canvas: HTMLCanvasElement;
     private _rpc;
+    private _logger;
     private _observer;
     private _clearTimeout;
     /**
@@ -22,7 +24,7 @@ export declare class Viewport {
      * @param canvas - The HTML canvas element to observe and manage
      * @param rpc - RPC client for viewport communication
      */
-    constructor(canvas: HTMLCanvasElement, rpc: RpcSafeClient);
+    constructor(canvas: HTMLCanvasElement, rpc: RpcSafeClient, logger: ILogger);
     /**
      * Handles resize events for the canvas
      * @private

package/dist/types/core-viewers/ultra/viewer/vim.d.ts

@@ -1,12 +1,12 @@
 import { ColorHandle } from './color';
 import { ColorManager } from './colorManager';
 import { LoadRequest } from './loadRequest';
-import { RpcSafeClient } from './rpcSafeClient';
+import { RpcSafeClient, VimSource } from './rpcSafeClient';
 import { ILogger } from './logger';
 import { Box3 } from '../utils/math3d';
 type NodeState = 'visible' | 'hidden' | 'ghosted' | 'highlighted';
 export declare class Vim {
-    readonly source: string;
+    readonly source: VimSource;
     private _handle;
     private _request;
     private readonly _rpc;
@@ -24,7 +24,7 @@ export declare class Vim {
      * @param source - The source URL or file path of the Vim.
      * @param logger - The logger for logging messages.
      */
-    constructor(rpc: RpcSafeClient, color: ColorManager, source: string, logger: ILogger);
+    constructor(rpc: RpcSafeClient, color: ColorManager, source: VimSource, logger: ILogger);
     get handle(): number;
     /**
      * Indicates whether the Vim is connected.
@@ -44,7 +44,7 @@ export declare class Vim {
     disconnect(): void;
     /**
      * Requests for the server to load the given URL or file path.
-     * @param url - The URL or file path to load.
+     * @param source - The URL or file path to load.
      * @param result - The load request object to update.
      * @returns The updated load request.
      */

package/dist/types/core-viewers/webgl/viewer/gizmos/sectionBox/sectionBoxInputs.d.ts

@@ -26,6 +26,7 @@ export declare class BoxInputs {
     constructor(viewer: Viewer, cube: THREE.Object3D, box: THREE.Box3);
     private reg;
     register(): void;
+    onPointerLeave(event: PointerEvent): void;
     capturePointer(pointerId: number): void;
     releasePointer(): void;
     unregister(): void;

package/dist/types/react-viewers/ultra/errors/serverFileDownloadingError.d.ts

@@ -1,2 +1,2 @@
 import { MessageBoxProps } from '../../panels/messageBox';
-export declare function serverFileDownloadingError(url: string, server?: string): MessageBoxProps;
+export declare function serverFileDownloadingError(url: string, authToken?: string, server?: string): MessageBoxProps;

package/dist/types/react-viewers/ultra/errors/ultraErrors.d.ts

@@ -1,3 +1,3 @@
 import * as Ultra from '../../../core-viewers/ultra';
 export declare function getErrorMessage(state: Ultra.ClientState): import("../..").MessageBoxProps;
-export declare function getRequestErrorMessage(url: string, error: Ultra.VimRequestErrorType): import("../..").MessageBoxProps;
+export declare function getRequestErrorMessage(source: Ultra.VimSource, error: Ultra.VimRequestErrorType): import("../..").MessageBoxProps;

package/dist/types/react-viewers/ultra/ultraComponent.d.ts

@@ -5,7 +5,7 @@ export type UltraComponentRef = {
     viewer: Ultra.Viewer;
     modal: ModalRef;
     dispose: () => void;
-    load(url: string): Ultra.ILoadRequest;
+    load(url: Ultra.VimSource): Ultra.ILoadRequest;
 };
 /**
  * Creates a UI container along with a VIM.Viewer and its associated React component.