@vertexvis/stream-api 0.22.1-canary.7 → 0.22.1-canary.9

package/dist/streamApi.d.ts

@@ -2,7 +2,7 @@ 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, UpdateStreamPayload } from './types';
+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;
@@ -186,6 +186,23 @@ export declare class StreamApi {
      * 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.
      *

package/dist/types.d.ts

@@ -20,6 +20,9 @@ export declare type UpdateDimensionsPayload = DeepRequired<vertexvis.protobuf.st
 export declare type UpdateCrossSectioningPayload = DeepRequired<vertexvis.protobuf.stream.IUpdateCrossSectioningPayload, [
     'frameCorrelationId'
 ]>;
+export declare type UpdateModelViewPayload = DeepRequired<vertexvis.protobuf.stream.IUpdateModelViewPayload, [
+    'frameCorrelationId'
+]>;
 export declare type HitItemsPayload = DeepRequired<vertexvis.protobuf.stream.IHitItemsPayload, [
 ]>;
 export declare type DrawFramePayload = DeepRequired<vertexvis.protobuf.stream.IDrawFramePayload, [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/stream-api",
-  "version": "0.22.1-canary.7",
+  "version": "0.22.1-canary.9",
   "description": "A websocket client for interacting with Vertex's stream API.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
@@ -42,8 +42,8 @@
     "@types/jest": "^27.5.1",
     "@vertexvis/eslint-config-vertexvis-typescript": "^0.5.0",
     "@vertexvis/jest-config-vertexvis": "^0.5.4",
-    "@vertexvis/utils": "0.22.1-canary.7",
-    "@vertexwebsdk/build": "0.22.1-canary.7",
+    "@vertexvis/utils": "0.22.1-canary.9",
+    "@vertexwebsdk/build": "0.22.1-canary.9",
     "eslint": "^8.17.0",
     "jest": "^27.5.1",
     "protobufjs": "^6.9.0",
@@ -57,5 +57,5 @@
     "protobufjs": ">=6.9.0 <7.0.0",
     "tslib": ">=2.1.0"
   },
-  "gitHead": "49374297d121de0696a97a12832a1b6e4077544e"
+  "gitHead": "53eb8d3e242775cfb7b9e2bad1f400315973eb65"
 }