@vertexvis/stream-api 0.13.2-canary.7 → 0.14.0

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 { EventMessage, GetStencilBufferPayload, HitItemsPayload, LoadSceneViewStatePayload, ReconnectPayload, RecordPerformancePayload, ReplaceCameraPayload, RequestMessage, ResponseError, ResponseMessage, ResponseResult, StartStreamPayload, SyncTimePayload, UpdateCrossSectioningPayload, UpdateDimensionsPayload, UpdateStreamPayload } from './types';
+import { BeginInteractionPayload, EndInteractionPayload, EventMessage, GetStencilBufferPayload, HitItemsPayload, LoadSceneViewStatePayload, ReconnectPayload, RecordPerformancePayload, ReplaceCameraPayload, RequestMessage, ResponseError, ResponseMessage, ResponseResult, StartStreamPayload, SyncTimePayload, UpdateCrossSectioningPayload, UpdateDimensionsPayload, UpdateInteractionPayload, UpdateStreamPayload } from './types';
 import { WebSocketClient } from './webSocketClient';
 export declare type RequestMessageHandler = (msg: RequestMessage) => void;
 export declare type ResponseMessageHandler = (msg: ResponseMessage) => void;
@@ -106,7 +106,7 @@ export declare class StreamApi {
      * @param withResponse Indicates if the server should reply with a response.
      * Defaults to `true`.
      */
-    beginInteraction(withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    beginInteraction(payload?: BeginInteractionPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
     /**
      * Sends a request to update the position of the scene's camera.
      *
@@ -140,6 +140,18 @@ export declare class StreamApi {
      * @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.
      *
@@ -223,7 +235,7 @@ export declare class StreamApi {
      * @param withResponse Indicates if the server should reply with a response.
      * Defaults to `true`.
      */
-    endInteraction(withResponse?: boolean): Promise<vertexvis.protobuf.stream.IBeginInteractionResult>;
+    endInteraction(payload?: EndInteractionPayload, withResponse?: boolean): Promise<vertexvis.protobuf.stream.IBeginInteractionResult>;
     /**
      * Sends a request to sync the clocks between the client and server.
      *

package/dist/types.d.ts

@@ -34,6 +34,15 @@ export declare type LoadSceneViewStatePayload = DeepRequired<vertexvis.protobuf.
 ]>;
 export declare type GetStencilBufferPayload = DeepRequired<vertexvis.protobuf.stream.IGetStencilBufferPayload, [
 ]>;
+export declare type BeginInteractionPayload = DeepRequired<vertexvis.protobuf.stream.IBeginInteractionPayload, [
+    'transform'
+]>;
+export declare type UpdateInteractionPayload = DeepRequired<vertexvis.protobuf.stream.IUpdateInteractionPayload, [
+    'transform'
+]>;
+export declare type EndInteractionPayload = DeepRequired<vertexvis.protobuf.stream.IEndInteractionPayload, [
+    'transform'
+]>;
 export declare type DrawFrameResult = DeepRequired<Pick<vertexvis.protobuf.stream.IStreamResponse, 'drawFrame'>, ['drawFrame', 'timing', 'receiveToPaintDuration'] | ['drawFrame', 'timing', 'sendToReceiveDuration']>;
 export declare type StartStreamResult = DeepRequired<vertexvis.protobuf.stream.IStartStreamResult, [
 ]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/stream-api",
-  "version": "0.13.2-canary.7",
+  "version": "0.14.0",
   "description": "A websocket client for interacting with Vertex's stream API.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
@@ -35,14 +35,14 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@vertexvis/frame-streaming-protos": "^0.6.19"
+    "@vertexvis/frame-streaming-protos": "^0.6.22"
   },
   "devDependencies": {
     "@types/jest": "^26.0.20",
     "@vertexvis/eslint-config-vertexvis-typescript": "^0.5.0",
     "@vertexvis/jest-config-vertexvis": "^0.5.4",
-    "@vertexvis/utils": "0.13.2-canary.7",
-    "@vertexwebsdk/build": "0.13.2-canary.7",
+    "@vertexvis/utils": "0.14.0",
+    "@vertexwebsdk/build": "0.14.0",
     "eslint": "^8.6.0",
     "jest": "^26.6.3",
     "protobufjs": "^6.9.0",
@@ -56,5 +56,5 @@
     "protobufjs": ">=6.9.0 <7.0.0",
     "tslib": ">=2.1.0"
   },
-  "gitHead": "e54e07ff42889270cdd42f4d9c3187916115446b"
+  "gitHead": "933bf93aab0d356bc6a0e906c8240a6e428e9614"
 }