@vertexvis/stream-api 0.12.0-canary.9 → 0.12.0

package/dist/index.d.ts

@@ -3,7 +3,8 @@
  */
 export * from './connection';
 export * from './encoder';
-export { Settings, FrameDeliverySettings, AdaptiveRenderingSettings, QualityOfServiceSettings, } from './settings';
+export * from './errors';
+export { AdaptiveRenderingSettings, FrameDeliverySettings, QualityOfServiceSettings, Settings, } from './settings';
 export * from './streamApi';
 export * from './testing';
 export * from './time';

package/dist/streamApi.d.ts

@@ -1,23 +1,27 @@
-import { WebSocketClient } from './webSocketClient';
-import { ConnectionDescriptor } from './connection';
-import { HitItemsPayload, ReconnectPayload, ReplaceCameraPayload, StartStreamPayload, ResponseResult, ResponseError, RequestMessage, ResponseMessage, SyncTimePayload, RecordPerformancePayload, UpdateCrossSectioningPayload, UpdateDimensionsPayload, UpdateStreamPayload, LoadSceneViewStatePayload, EventMessage } from './types';
 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 { 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 loggingEnabled;
     private onResponseDispatcher;
     private onRequestDispatcher;
     private onEventDispatcher;
     private messageSubscription?;
-    constructor(websocket?: WebSocketClient, loggingEnabled?: boolean);
+    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
@@ -46,6 +50,12 @@ export declare class StreamApi {
      * @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.
      *
@@ -189,6 +199,19 @@ export declare class StreamApi {
      * 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.
@@ -242,7 +265,15 @@ export declare class StreamApi {
     /**
      * Sends a request to get a stencil buffer image for the current scene view.
      */
-    getStencilBuffer(withResponse?: boolean): Promise<vertexvis.protobuf.stream.IStreamResponse>;
+    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.

package/dist/testing/fixtures/index.d.ts

@@ -1,3 +1,4 @@
-import * as Requests from './requests';
 import * as Events from './events';
-export { Requests, Events };
+import * as Requests from './requests';
+import * as Responses from './responses';
+export { Events, Requests, Responses };

package/dist/testing/fixtures/requests.d.ts

@@ -1,5 +1,5 @@
-import { RequestMessage } from '../../types';
 import { vertexvis } from '@vertexvis/frame-streaming-protos';
+import { RequestMessage } from '../../types';
 declare type Metadata = Partial<Pick<RequestMessage, 'sentAtTime'>>;
 interface RequestId {
     requestId?: string;

package/dist/testing/fixtures/responses.d.ts

@@ -0,0 +1,20 @@
+import { vertexvis } from '@vertexvis/frame-streaming-protos';
+import { ResponseMessage } from '../../types';
+declare type Metadata = Partial<Pick<ResponseMessage, 'sentAtTime'>>;
+interface RequestId {
+    requestId?: string;
+}
+interface Result<T> {
+    result?: T;
+}
+declare type StartStreamResponse = RequestId & Result<vertexvis.protobuf.stream.IStartStreamResult>;
+declare type SyncTimeResponse = RequestId & Result<vertexvis.protobuf.stream.ISyncTimeResult>;
+declare type ReconnectResponse = RequestId & Result<vertexvis.protobuf.stream.IReconnectResult>;
+declare type LoadSceneViewStateResponse = RequestId & Result<vertexvis.protobuf.stream.ILoadSceneViewStateResult>;
+declare type RefreshTokenResponse = RequestId & Result<vertexvis.protobuf.stream.IRefreshTokenResult>;
+export declare function startStream(res?: StartStreamResponse, meta?: Metadata): ResponseMessage;
+export declare function syncTime(res?: SyncTimeResponse, meta?: Metadata): ResponseMessage;
+export declare function reconnect(res?: ReconnectResponse, meta?: Metadata): ResponseMessage;
+export declare function loadSceneViewState(res?: LoadSceneViewStateResponse, meta?: Metadata): ResponseMessage;
+export declare function refreshToken(res?: RefreshTokenResponse, meta?: Metadata): ResponseMessage;
+export {};

package/dist/testing/webSocketClientMock.d.ts

@@ -1,11 +1,13 @@
-import { WebSocketClient, WebSocketSendData, MessageHandler } from '../webSocketClient';
-import { ConnectionDescriptor } from '../connection';
 import { Disposable } from '@vertexvis/utils';
+import { ConnectionDescriptor } from '../connection';
+import { CloseHandler, MessageHandler, WebSocketClient, WebSocketSendData } from '../webSocketClient';
 export declare class WebSocketClientMock implements WebSocketClient {
-    private handlers;
+    private closeHandlers;
+    private msgHandlers;
     private sentMessages;
     close(): void;
     connect(descriptor: ConnectionDescriptor): Promise<void>;
+    onClose(handler: CloseHandler): Disposable;
     onMessage(handler: MessageHandler): Disposable;
     send(data: WebSocketSendData): void;
     reconnect(descriptor: ConnectionDescriptor): Promise<void>;

package/dist/types.d.ts

@@ -1,5 +1,5 @@
-import { DeepRequired, RequiredAndNonNullable } from '@vertexvis/utils';
 import { vertexvis } from '@vertexvis/frame-streaming-protos';
+import { DeepRequired, RequiredAndNonNullable } from '@vertexvis/utils';
 export declare type RequestMessage = RequiredAndNonNullable<Pick<vertexvis.protobuf.stream.IStreamMessage, 'request' | 'sentAtTime'>>;
 export declare type ResponseMessage = RequiredAndNonNullable<Pick<vertexvis.protobuf.stream.IStreamMessage, 'response' | 'sentAtTime'>>;
 export declare type EventMessage = RequiredAndNonNullable<Pick<vertexvis.protobuf.stream.IStreamMessage, 'event' | 'sentAtTime'>>;
@@ -32,7 +32,19 @@ export declare type RecordPerformancePayload = DeepRequired<vertexvis.protobuf.s
 ]>;
 export declare type LoadSceneViewStatePayload = DeepRequired<vertexvis.protobuf.stream.ILoadSceneViewStatePayload, [
 ]>;
+export declare type GetStencilBufferPayload = DeepRequired<vertexvis.protobuf.stream.IGetStencilBufferPayload, [
+]>;
 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, [
+]>;
+export declare type SyncTimeResult = DeepRequired<vertexvis.protobuf.stream.ISyncTimeResult, [
+]>;
+export declare type ReconnectResult = DeepRequired<vertexvis.protobuf.stream.IReconnectResult, [
+]>;
+export declare type LoadSceneViewStateResult = DeepRequired<vertexvis.protobuf.stream.ILoadSceneViewStateResult, [
+]>;
+export declare type RefreshTokenResult = DeepRequired<vertexvis.protobuf.stream.IRefreshTokenResult, [
+]>;
 export declare type ResponseResult = DrawFrameResult;
 export declare type ResponseError = vertexvis.protobuf.stream.IError;
 export declare type AnimationCompletedEvent = DeepRequired<Pick<vertexvis.protobuf.stream.IAnimationCompletedEvent, 'animationId'>, [

package/dist/webSocketClient.d.ts

@@ -7,6 +7,7 @@ export interface WebSocketClient {
     close(): void;
     connect(descriptor: ConnectionDescriptor): Promise<void>;
     onMessage(handler: MessageHandler): Disposable;
+    onClose(handler: CloseHandler): Disposable;
     send(data: WebSocketSendData): void;
 }
 export declare class WebSocketClientImpl implements WebSocketClient {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/stream-api",
-  "version": "0.12.0-canary.9",
+  "version": "0.12.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,26 +35,26 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@vertexvis/frame-streaming-protos": "^0.6.7"
+    "@vertexvis/frame-streaming-protos": "^0.6.16"
   },
   "devDependencies": {
     "@types/jest": "^26.0.20",
-    "@vertexvis/eslint-config-vertexvis-typescript": "^0.4.1",
-    "@vertexvis/jest-config-vertexvis": "^0.5.3",
-    "@vertexvis/utils": "^0.12.0-canary.9",
-    "@vertexwebsdk/build": "^0.12.0-canary.9",
-    "eslint": "^7.20.0",
+    "@vertexvis/eslint-config-vertexvis-typescript": "^0.5.0",
+    "@vertexvis/jest-config-vertexvis": "^0.5.4",
+    "@vertexvis/utils": "0.12.0",
+    "@vertexwebsdk/build": "0.12.0",
+    "eslint": "^8.6.0",
     "jest": "^26.6.3",
     "protobufjs": "^6.9.0",
-    "rollup": "^2.58.0",
+    "rollup": "^2.63.0",
     "ts-jest": "^26.5.2",
     "tslib": "^2.1.0",
-    "typescript": "^4.4.4"
+    "typescript": "^4.5.4"
   },
   "peerDependencies": {
     "@vertexvis/utils": "^0.10.1",
     "protobufjs": ">=6.9.0 <7.0.0",
     "tslib": ">=2.1.0"
   },
-  "gitHead": "8ac5a7e0829943b4d11c8ca49a8b4625316e1a52"
+  "gitHead": "9642bca08f9e57be8234032a62d6ae1e27233977"
 }