@vertexvis/stream-api 0.24.5 → 1.0.0-canary.0

package/dist/streamApi.d.ts

@@ -1,327 +1,327 @@
-import { vertexvis } from '@vertexvis/frame-streaming-protos';
-import { Disposable } from '@vertexvis/utils';
-import { ConnectionDescriptor } from './connection';
-import { Settings } from './settings';
-import { BeginInteractionPayload, EndInteractionPayload, EventMessage, GetStencilBufferPayload, HitItemsPayload, LoadSceneViewStatePayload, ReconnectPayload, RecordPerformancePayload, ReplaceCameraPayload, RequestMessage, ResponseError, ResponseMessage, ResponseResult, StartStreamPayload, SyncTimePayload, UpdateCrossSectioningPayload, UpdateDimensionsPayload, UpdateInteractionPayload, UpdateModelViewPayload, UpdateStreamPayload } from './types';
-import { WebSocketClient } from './webSocketClient';
-export declare type RequestMessageHandler = (msg: RequestMessage) => void;
-export declare type ResponseMessageHandler = (msg: ResponseMessage) => void;
-export declare type EventMessageHandler = (msg: EventMessage) => void;
-export declare type CloseEventHandler = (evt: CloseEvent) => void;
-export interface StreamApiOptions {
-    loggingEnabled?: boolean;
-}
-/**
- * The API client to interact with Vertex's streaming API.
- */
-export declare class StreamApi {
-    private websocket;
-    private onResponseDispatcher;
-    private onRequestDispatcher;
-    private onEventDispatcher;
-    private messageSubscription?;
-    private opts;
-    constructor(websocket?: WebSocketClient, opts?: StreamApiOptions);
-    /**
-     * Initiates a websocket connection to Vertex's streaming API. Returns a
-     * promise that resolves once the connection is established and can begin
-     * accepting messages.
-     *
-     * @param descriptor A function that returns a description of how to establish
-     * a WS connection.
-     * @param settings A configuration to use when initializing the WS connection.
-     */
-    connect(descriptor: ConnectionDescriptor, settings?: Settings): Promise<Disposable>;
-    /**
-     * Closes any open WS connections and disposes of resources.
-     */
-    dispose(): void;
-    /**
-     * Adds a callback that is invoked when the client receives a request from the
-     * server. Returns a `Disposable` that can be used to remove the listener.
-     *
-     * @param handler A handler function.
-     */
-    onRequest(handler: RequestMessageHandler): Disposable;
-    /**
-     * Adds a callback that is invoked when the client receives an event from the
-     * server. Returns a `Disposable` that can be used to remove the listener.
-     *
-     * @param handler - A handler function.
-     */
-    onEvent(handler: EventMessageHandler): Disposable;
-    /**
-     * Adds a callback that is invoked when the websocket connection is closed.
-     *
-     * @param handler A handler function.
-     */
-    onClose(handler: CloseEventHandler): Disposable;
-    /**
-     * Sends a request to initiate a streaming session.
-     *
-     * The payload accepts an optional `frameCorrelationId` that will be sent
-     * back on the frame that is associated to this request. Use `onRequest` to
-     * add a callback that'll be invoked when the server sends a request to draw
-     * the frame.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The payload of the request.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    startStream(payload: StartStreamPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to reconnect to an existing streaming session.
-     *
-     * The payload accepts an optional `frameCorrelationId` that will be sent
-     * back on the frame that is associated to this request. Use `onRequest` to
-     * add a callback that'll be invoked when the server sends a request to draw
-     * the frame.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The payload of the request.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    reconnect(payload: ReconnectPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    updateStream(payload: UpdateStreamPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IUpdateStreamResult>;
-    /**
-     * Sends a request to signal to the rendering pipeline that an interaction has
-     * started. The rendering pipeline will use this as a hint to perform more
-     * aggressive rendering optimizations at the expense of rendering quality.
-     * Call `endInteraction` to signal to the rendering pipeline that an
-     * interaction has finished.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param data The payload of the request.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    beginInteraction(payload?: BeginInteractionPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to update the position of the scene's camera.
-     *
-     * The payload accepts an optional `frameCorrelationId` that will be sent
-     * back on the frame that is associated to this request. Use `onRequest` to
-     * add a callback that'll be invoked when the server sends a request to draw
-     * the frame.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The payload of the request.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    replaceCamera(payload: ReplaceCameraPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to update the position of the scene's camera as a fly operation
-     *
-     * The payload accepts an optional `frameCorrelationId` that will be sent
-     * back on the frame that is associated to this request. Use `onRequest` to
-     * add a callback that'll be invoked when the server sends a request to draw
-     * the frame.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload
-     * @param withResponse
-     */
-    flyTo(payload: vertexvis.protobuf.stream.IFlyToPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to update the specified interaction.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The payload of the request.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    updateInteraction(payload: UpdateInteractionPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to update the dimensions of the frame.
-     *
-     * The payload accepts an optional `frameCorrelationId` that will be sent
-     * back on the frame that is associated to this request. Use `onRequest` to
-     * add a callback that'll be invoked when the server sends a request to draw
-     * the frame.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The payload of the request.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    updateDimensions(payload: UpdateDimensionsPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to update the cross sectioning planes of the frame.
-     *
-     * The payload accepts an optional `frameCorrelationId` that will be sent
-     * back on the frame that is associated to this request. Use `onRequest` to
-     * add a callback that'll be invoked when the server sends a request to draw
-     * the frame.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The payload of the request.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    updateCrossSectioning(payload: UpdateCrossSectioningPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to set or clear the model view of the frame.
-     *
-     * The payload accepts an optional `frameCorrelationId` that will be sent
-     * back on the frame that is associated to this request. Use `onRequest` to
-     * add a callback that'll be invoked when the server sends a request to draw
-     * the frame.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The payload of the request.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    updateModelView(payload: UpdateModelViewPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to perform hit detection.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The payload of the request.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    hitItems(payload: HitItemsPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to perform an alteration to a scene. Alterations include
-     * changing item visibility and changing the materials of items.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The payload of the request.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    createSceneAlteration(payload: vertexvis.protobuf.stream.ICreateSceneAlterationPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to reset all overrides for a given scene and optionally to
-     * reset the camera to that of the base scene.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The payload of the request.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    resetSceneView(payload: vertexvis.protobuf.stream.IResetViewPlayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to tell the rendering pipeline that an interaction has
-     * ended.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    endInteraction(payload?: EndInteractionPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IBeginInteractionResult>;
-    /**
-     * Sends a request to sync the clocks between the client and server.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The request payload.
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    syncTime(payload: SyncTimePayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to record performance timings that were measured in the
-     * client. The server may use these timings as hints to optimize the rendering
-     * performance to provide a better experience.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload The request payload
-     * @param withResponse Indicates if the server should reply with a response.
-     * Defaults to `true`.
-     */
-    recordPerformance(payload: RecordPerformancePayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to update the current scene view with the state present
-     * in the specified scene view state.
-     *
-     * Use `withResponse` to indicate if the server should reply with a response.
-     * If `false`, the returned promise will complete immediately. Otherwise,
-     * it'll complete when a response is received.
-     *
-     * @param payload
-     * @param withResponse
-     */
-    loadSceneViewState(payload: LoadSceneViewStatePayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to get a stencil buffer image for the current scene view.
-     */
-    getStencilBuffer(payload: GetStencilBufferPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Sends a request to retrieve a new token. This token can be used to
-     * authenticate with other Vertex services.
-     *
-     * @param withResponse Indicates if the server should reply with a response.
-     * @returns A promise that completes with the refreshed token.
-     */
-    refreshToken(withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
-    /**
-     * Acknowledges a successful request by sending a reply back to the server
-     * with an optional result body.
-     *
-     * @param reqId The ID of the received request.
-     * @param result A result to reply with.
-     */
-    replyResult(reqId: string, result: ResponseResult): void;
-    /**
-     * Acknowledges a failed request by sending a reply back to the server.
-     *
-     * @param reqId The ID of the received request.
-     * @param error An error to reply with.
-     */
-    replyError(reqId: string, error: ResponseError): void;
-    protected handleMessage(message: MessageEvent): void;
-    protected onResponse(handler: ResponseMessageHandler): Disposable;
-    protected log(msg: string, ...other: unknown[]): void;
-    private sendRequest;
-    private sendMessage;
-    private sendResponse;
-}
+import { vertexvis } from '@vertexvis/frame-streaming-protos';
+import { Disposable } from '@vertexvis/utils';
+import { ConnectionDescriptor } from './connection';
+import { Settings } from './settings';
+import { BeginInteractionPayload, EndInteractionPayload, EventMessage, GetStencilBufferPayload, HitItemsPayload, LoadSceneViewStatePayload, ReconnectPayload, RecordPerformancePayload, ReplaceCameraPayload, RequestMessage, ResponseError, ResponseMessage, ResponseResult, StartStreamPayload, SyncTimePayload, UpdateCrossSectioningPayload, UpdateDimensionsPayload, UpdateInteractionPayload, UpdateModelViewPayload, UpdateStreamPayload } from './types';
+import { WebSocketClient } from './webSocketClient';
+export type RequestMessageHandler = (msg: RequestMessage) => void;
+export type ResponseMessageHandler = (msg: ResponseMessage) => void;
+export type EventMessageHandler = (msg: EventMessage) => void;
+export type CloseEventHandler = (evt: CloseEvent) => void;
+export interface StreamApiOptions {
+    loggingEnabled?: boolean;
+}
+/**
+ * The API client to interact with Vertex's streaming API.
+ */
+export declare class StreamApi {
+    private websocket;
+    private onResponseDispatcher;
+    private onRequestDispatcher;
+    private onEventDispatcher;
+    private messageSubscription?;
+    private opts;
+    constructor(websocket?: WebSocketClient, opts?: StreamApiOptions);
+    /**
+     * Initiates a websocket connection to Vertex's streaming API. Returns a
+     * promise that resolves once the connection is established and can begin
+     * accepting messages.
+     *
+     * @param descriptor A function that returns a description of how to establish
+     * a WS connection.
+     * @param settings A configuration to use when initializing the WS connection.
+     */
+    connect(descriptor: ConnectionDescriptor, settings?: Settings): Promise<Disposable>;
+    /**
+     * Closes any open WS connections and disposes of resources.
+     */
+    dispose(): void;
+    /**
+     * Adds a callback that is invoked when the client receives a request from the
+     * server. Returns a `Disposable` that can be used to remove the listener.
+     *
+     * @param handler A handler function.
+     */
+    onRequest(handler: RequestMessageHandler): Disposable;
+    /**
+     * Adds a callback that is invoked when the client receives an event from the
+     * server. Returns a `Disposable` that can be used to remove the listener.
+     *
+     * @param handler - A handler function.
+     */
+    onEvent(handler: EventMessageHandler): Disposable;
+    /**
+     * Adds a callback that is invoked when the websocket connection is closed.
+     *
+     * @param handler A handler function.
+     */
+    onClose(handler: CloseEventHandler): Disposable;
+    /**
+     * Sends a request to initiate a streaming session.
+     *
+     * The payload accepts an optional `frameCorrelationId` that will be sent
+     * back on the frame that is associated to this request. Use `onRequest` to
+     * add a callback that'll be invoked when the server sends a request to draw
+     * the frame.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The payload of the request.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    startStream(payload: StartStreamPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to reconnect to an existing streaming session.
+     *
+     * The payload accepts an optional `frameCorrelationId` that will be sent
+     * back on the frame that is associated to this request. Use `onRequest` to
+     * add a callback that'll be invoked when the server sends a request to draw
+     * the frame.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The payload of the request.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    reconnect(payload: ReconnectPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    updateStream(payload: UpdateStreamPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IUpdateStreamResult>;
+    /**
+     * Sends a request to signal to the rendering pipeline that an interaction has
+     * started. The rendering pipeline will use this as a hint to perform more
+     * aggressive rendering optimizations at the expense of rendering quality.
+     * Call `endInteraction` to signal to the rendering pipeline that an
+     * interaction has finished.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param data The payload of the request.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    beginInteraction(payload?: BeginInteractionPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to update the position of the scene's camera.
+     *
+     * The payload accepts an optional `frameCorrelationId` that will be sent
+     * back on the frame that is associated to this request. Use `onRequest` to
+     * add a callback that'll be invoked when the server sends a request to draw
+     * the frame.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The payload of the request.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    replaceCamera(payload: ReplaceCameraPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to update the position of the scene's camera as a fly operation
+     *
+     * The payload accepts an optional `frameCorrelationId` that will be sent
+     * back on the frame that is associated to this request. Use `onRequest` to
+     * add a callback that'll be invoked when the server sends a request to draw
+     * the frame.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload
+     * @param withResponse
+     */
+    flyTo(payload: vertexvis.protobuf.stream.IFlyToPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to update the specified interaction.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The payload of the request.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    updateInteraction(payload: UpdateInteractionPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to update the dimensions of the frame.
+     *
+     * The payload accepts an optional `frameCorrelationId` that will be sent
+     * back on the frame that is associated to this request. Use `onRequest` to
+     * add a callback that'll be invoked when the server sends a request to draw
+     * the frame.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The payload of the request.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    updateDimensions(payload: UpdateDimensionsPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to update the cross sectioning planes of the frame.
+     *
+     * The payload accepts an optional `frameCorrelationId` that will be sent
+     * back on the frame that is associated to this request. Use `onRequest` to
+     * add a callback that'll be invoked when the server sends a request to draw
+     * the frame.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The payload of the request.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    updateCrossSectioning(payload: UpdateCrossSectioningPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to set or clear the model view of the frame.
+     *
+     * The payload accepts an optional `frameCorrelationId` that will be sent
+     * back on the frame that is associated to this request. Use `onRequest` to
+     * add a callback that'll be invoked when the server sends a request to draw
+     * the frame.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The payload of the request.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    updateModelView(payload: UpdateModelViewPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to perform hit detection.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The payload of the request.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    hitItems(payload: HitItemsPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to perform an alteration to a scene. Alterations include
+     * changing item visibility and changing the materials of items.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The payload of the request.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    createSceneAlteration(payload: vertexvis.protobuf.stream.ICreateSceneAlterationPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to reset all overrides for a given scene and optionally to
+     * reset the camera to that of the base scene.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The payload of the request.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    resetSceneView(payload: vertexvis.protobuf.stream.IResetViewPlayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to tell the rendering pipeline that an interaction has
+     * ended.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    endInteraction(payload?: EndInteractionPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IBeginInteractionResult>;
+    /**
+     * Sends a request to sync the clocks between the client and server.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The request payload.
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    syncTime(payload: SyncTimePayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to record performance timings that were measured in the
+     * client. The server may use these timings as hints to optimize the rendering
+     * performance to provide a better experience.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload The request payload
+     * @param withResponse Indicates if the server should reply with a response.
+     * Defaults to `true`.
+     */
+    recordPerformance(payload: RecordPerformancePayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to update the current scene view with the state present
+     * in the specified scene view state.
+     *
+     * Use `withResponse` to indicate if the server should reply with a response.
+     * If `false`, the returned promise will complete immediately. Otherwise,
+     * it'll complete when a response is received.
+     *
+     * @param payload
+     * @param withResponse
+     */
+    loadSceneViewState(payload: LoadSceneViewStatePayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to get a stencil buffer image for the current scene view.
+     */
+    getStencilBuffer(payload: GetStencilBufferPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Sends a request to retrieve a new token. This token can be used to
+     * authenticate with other Vertex services.
+     *
+     * @param withResponse Indicates if the server should reply with a response.
+     * @returns A promise that completes with the refreshed token.
+     */
+    refreshToken(withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    /**
+     * Acknowledges a successful request by sending a reply back to the server
+     * with an optional result body.
+     *
+     * @param reqId The ID of the received request.
+     * @param result A result to reply with.
+     */
+    replyResult(reqId: string, result: ResponseResult): void;
+    /**
+     * Acknowledges a failed request by sending a reply back to the server.
+     *
+     * @param reqId The ID of the received request.
+     * @param error An error to reply with.
+     */
+    replyError(reqId: string, error: ResponseError): void;
+    protected handleMessage(message: MessageEvent): void;
+    protected onResponse(handler: ResponseMessageHandler): Disposable;
+    protected log(msg: string, ...other: unknown[]): void;
+    private sendRequest;
+    private sendMessage;
+    private sendResponse;
+}