@fluidframework/debugger 2.0.0-internal.6.4.0 → 2.0.0-internal.7.1.0

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # @fluidframework/debugger
 
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    This included the following changes from the protocol-definitions release:
+
+    -   Updating signal interfaces for some planned improvements. The intention is split the interface between signals
+        submitted by clients to the server and the resulting signals sent from the server to clients.
+        -   A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
+            been added, which will be the typing for signals sent from the client to the server. Both extend a new
+            ISignalMessageBase interface that contains common members.
+    -   The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
+
+-   Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dependencies on the following Fluid server package have been updated to version 2.0.1:
+
+    -   @fluidframework/gitresources: 2.0.1
+    -   @fluidframework/server-kafka-orderer: 2.0.1
+    -   @fluidframework/server-lambdas: 2.0.1
+    -   @fluidframework/server-lambdas-driver: 2.0.1
+    -   @fluidframework/server-local-server: 2.0.1
+    -   @fluidframework/server-memory-orderer: 2.0.1
+    -   @fluidframework/protocol-base: 2.0.1
+    -   @fluidframework/server-routerlicious: 2.0.1
+    -   @fluidframework/server-routerlicious-base: 2.0.1
+    -   @fluidframework/server-services: 2.0.1
+    -   @fluidframework/server-services-client: 2.0.1
+    -   @fluidframework/server-services-core: 2.0.1
+    -   @fluidframework/server-services-ordering-kafkanode: 2.0.1
+    -   @fluidframework/server-services-ordering-rdkafka: 2.0.1
+    -   @fluidframework/server-services-ordering-zookeeper: 2.0.1
+    -   @fluidframework/server-services-shared: 2.0.1
+    -   @fluidframework/server-services-telemetry: 2.0.1
+    -   @fluidframework/server-services-utils: 2.0.1
+    -   @fluidframework/server-test-utils: 2.0.1
+    -   tinylicious: 2.0.1
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
 ## 2.0.0-internal.6.4.0
 
 Dependency updates only.

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "@fluidframework/build-common/api-extractor-common-report.json"
+	"extends": "@fluidframework/build-common/api-extractor-base.json"
 }

package/api-report/debugger.api.md

@@ -0,0 +1,156 @@
+## API Report File for "@fluidframework/debugger"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Deferred } from '@fluidframework/core-utils';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
+import { ReplayController } from '@fluidframework/replay-driver';
+
+// @public (undocumented)
+export class DebuggerUI {
+    protected constructor(controller: IDebuggerController, debuggerWindow: Window);
+    // (undocumented)
+    addVersions(versions: IVersion[]): void;
+    // (undocumented)
+    protected buttonOps?: HTMLButtonElement;
+    // (undocumented)
+    static create(controller: IDebuggerController): DebuggerUI | null;
+    // (undocumented)
+    disableNextOpButton(disable: boolean): void;
+    // (undocumented)
+    protected documentClosed: boolean;
+    // (undocumented)
+    protected lastOpText?: HTMLDivElement;
+    // (undocumented)
+    protected selector?: HTMLSelectElement;
+    // (undocumented)
+    protected text1?: HTMLDivElement;
+    // (undocumented)
+    protected text2?: HTMLDivElement;
+    // (undocumented)
+    protected text3?: HTMLDivElement;
+    // (undocumented)
+    updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
+    // (undocumented)
+    updateNextOpText(ops: ISequencedDocumentMessage[]): void;
+    // (undocumented)
+    updateVersion(index: number, version: IVersion, seqNumber: number): void;
+    // (undocumented)
+    updateVersionText(versionCount: number): void;
+    // (undocumented)
+    protected versions: IVersion[];
+    // (undocumented)
+    versionSelected(seqNumber: number, version: IVersion | string): void;
+    // (undocumented)
+    protected versionText: HTMLDivElement;
+    // (undocumented)
+    protected wasVersionSelected: boolean;
+}
+
+// @public (undocumented)
+export type debuggerUIFactory = (controller: IDebuggerController) => IDebuggerUI | null;
+
+// @public
+export class DebugReplayController extends ReplayController implements IDebuggerController {
+    // (undocumented)
+    connectToUi(ui: IDebuggerUI): void;
+    // (undocumented)
+    static create(createUi: debuggerUIFactory): DebugReplayController | null;
+    // (undocumented)
+    protected documentService?: IDocumentService;
+    // (undocumented)
+    protected documentStorageService?: IDocumentStorageService;
+    // (undocumented)
+    downloadVersionInfo(documentStorageService: IDocumentStorageService, prevRequest: Promise<void>, index: number, version: IVersion): Promise<void>;
+    // (undocumented)
+    fetchTo(currentOp: number): number | undefined;
+    // (undocumented)
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    // (undocumented)
+    getStartingOpSequence(): Promise<number>;
+    // (undocumented)
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    // (undocumented)
+    initStorage(documentService: IDocumentService): Promise<boolean>;
+    isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
+    // (undocumented)
+    isSelectionMade(): boolean;
+    // (undocumented)
+    protected lastOpReached: boolean;
+    // (undocumented)
+    onClose(): void;
+    // (undocumented)
+    onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
+    // (undocumented)
+    onOpButtonClick(steps: number): void;
+    // (undocumented)
+    onSnapshotFileSelection(file: File): void;
+    // (undocumented)
+    onVersionSelection(version: IVersion): Promise<void>;
+    // (undocumented)
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+    // (undocumented)
+    replay(emitter: (op: ISequencedDocumentMessage[]) => void, fetchedOps: ISequencedDocumentMessage[]): Promise<void>;
+    // (undocumented)
+    protected resolveStorage(seq: number, storage: ReadDocumentStorageServiceBase, version: IVersion | string): void;
+    // (undocumented)
+    protected retryFetchOpsOnEndOfFile: boolean;
+    // (undocumented)
+    protected static seqFromTree(documentStorageService: IDocumentStorageService, tree: ISnapshotTree | null): Promise<number>;
+    // (undocumented)
+    protected startSeqDeferred: Deferred<number>;
+    // (undocumented)
+    protected stepsDeferred?: Deferred<number>;
+    // (undocumented)
+    protected stepsToPlay: number;
+    // (undocumented)
+    protected storage?: ReadDocumentStorageServiceBase;
+    // (undocumented)
+    protected ui: IDebuggerUI;
+    // (undocumented)
+    protected versionCount: number;
+    // (undocumented)
+    protected versions: IVersion[];
+    // (undocumented)
+    protected static readonly WindowClosedSeq = -1;
+}
+
+// @public (undocumented)
+export namespace FluidDebugger {
+    export function createFromService(documentService: IDocumentService): Promise<IDocumentService>;
+    // (undocumented)
+    export function createFromServiceFactory(documentServiceFactory: IDocumentServiceFactory): Promise<IDocumentServiceFactory>;
+}
+
+// @public (undocumented)
+export interface IDebuggerController {
+    connectToUi(ui: IDebuggerUI): any;
+    onClose(): void;
+    onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
+    onOpButtonClick(steps: number): void;
+    onSnapshotFileSelection(file: File): void;
+    onVersionSelection(version: IVersion): void;
+}
+
+// @public (undocumented)
+export interface IDebuggerUI {
+    addVersions(version: IVersion[]): void;
+    disableNextOpButton(disable: boolean): void;
+    updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
+    updateNextOpText(ops: ISequencedDocumentMessage[]): void;
+    updateVersion(index: number, version: IVersion, seqNumber: number): void;
+    updateVersionText(versionsLeft: number): void;
+    versionSelected(seqNumber: number, version: IVersion | string): void;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/debugger-alpha.d.ts

@@ -0,0 +1,190 @@
+import { Deferred } from '@fluidframework/core-utils';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
+import { ReplayController } from '@fluidframework/replay-driver';
+
+/**
+ * @public
+ */
+export declare class DebuggerUI {
+    private readonly controller;
+    private readonly debuggerWindow;
+    static create(controller: IDebuggerController): DebuggerUI | null;
+    private static formatDate;
+    protected selector?: HTMLSelectElement;
+    protected versionText: HTMLDivElement;
+    protected buttonOps?: HTMLButtonElement;
+    protected text1?: HTMLDivElement;
+    protected text2?: HTMLDivElement;
+    protected text3?: HTMLDivElement;
+    protected lastOpText?: HTMLDivElement;
+    protected wasVersionSelected: boolean;
+    protected versions: IVersion[];
+    protected documentClosed: boolean;
+    protected constructor(controller: IDebuggerController, debuggerWindow: Window);
+    private attachDownloadOpsListener;
+    addVersions(versions: IVersion[]): void;
+    updateVersion(index: number, version: IVersion, seqNumber: number): void;
+    versionSelected(seqNumber: number, version: IVersion | string): void;
+    disableNextOpButton(disable: boolean): void;
+    updateNextOpText(ops: ISequencedDocumentMessage[]): void;
+    updateVersionText(versionCount: number): void;
+    updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
+    private download;
+}
+
+/**
+ * @public
+ */
+export declare type debuggerUIFactory = (controller: IDebuggerController) => IDebuggerUI | null;
+
+/**
+ * Replay controller that uses pop-up window to control op playback
+ *
+ * @public
+ */
+export declare class DebugReplayController extends ReplayController implements IDebuggerController {
+    static create(createUi: debuggerUIFactory): DebugReplayController | null;
+    protected static readonly WindowClosedSeq = -1;
+    protected static seqFromTree(documentStorageService: IDocumentStorageService, tree: ISnapshotTree | null): Promise<number>;
+    protected ui: IDebuggerUI;
+    protected stepsDeferred?: Deferred<number>;
+    protected startSeqDeferred: Deferred<number>;
+    protected retryFetchOpsOnEndOfFile: boolean;
+    protected documentService?: IDocumentService;
+    protected documentStorageService?: IDocumentStorageService;
+    protected versions: IVersion[];
+    protected stepsToPlay: number;
+    protected lastOpReached: boolean;
+    protected versionCount: number;
+    protected storage?: ReadDocumentStorageServiceBase;
+    private shouldUseController;
+    connectToUi(ui: IDebuggerUI): void;
+    onClose(): void;
+    onVersionSelection(version: IVersion): Promise<void>;
+    onOpButtonClick(steps: number): void;
+    onSnapshotFileSelection(file: File): void;
+    onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
+    private fetchOpsFromDeltaStorage;
+    fetchTo(currentOp: number): number | undefined;
+    isSelectionMade(): boolean;
+    downloadVersionInfo(documentStorageService: IDocumentStorageService, prevRequest: Promise<void>, index: number, version: IVersion): Promise<void>;
+    initStorage(documentService: IDocumentService): Promise<boolean>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    getStartingOpSequence(): Promise<number>;
+    /**
+     * Return true if we are done processing ops
+     */
+    isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
+    replay(emitter: (op: ISequencedDocumentMessage[]) => void, fetchedOps: ISequencedDocumentMessage[]): Promise<void>;
+    protected resolveStorage(seq: number, storage: ReadDocumentStorageServiceBase, version: IVersion | string): void;
+}
+
+/**
+ * @public
+ */
+export declare namespace FluidDebugger {
+    /**
+     * Creates document service wrapper that pops up Debugger window and allows user to play ops one by one.
+     * User can chose to start with any snapshot
+     * If pop-ups are disabled, we continue without debugger.
+     * @param documentService - original document service to use to fetch ops / snapshots.
+     */
+    export function createFromService(documentService: IDocumentService): Promise<IDocumentService>;
+    export function createFromServiceFactory(documentServiceFactory: IDocumentServiceFactory): Promise<IDocumentServiceFactory>;
+}
+
+/**
+ * @public
+ */
+export declare interface IDebuggerController {
+    /**
+     * Initialization. UI layers calls into controller to connect the two.
+     * @param ui - UI layer
+     */
+    connectToUi(ui: IDebuggerUI): any;
+    /**
+     * Called by UI layer when debugger window is closed by user
+     * If called before user makes selection of snapshot/file, original
+     * document service is returned to loader (instead of debugger service) and normal document load continues.
+     */
+    onClose(): void;
+    /**
+     * UI Layer notifies about selection of version to continue.
+     * On successful load, versionSelected() is called.
+     * @param version - Snapshot version to start from.
+     */
+    onVersionSelection(version: IVersion): void;
+    /**
+     * UI Layer notifies about selection of version to continue.
+     * On successful load, versionSelected() is called.
+     * @param version - File to load snapshot from
+     */
+    onSnapshotFileSelection(file: File): void;
+    /**
+     * "next op" button is clicked in the UI
+     * @param steps - number of ops to play.
+     */
+    onOpButtonClick(steps: number): void;
+    /**
+     * "Download ops" option is clicked in the UI. Returns JSON of the full opStream when available.
+     * @param anonymize - anonymize the ops json using the sanitization tool
+     */
+    onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
+}
+
+/**
+ * @public
+ */
+export declare interface IDebuggerUI {
+    /**
+     * Version information is provided.
+     * Expect updates (information about seq#, timestamp) through updateVersion() calls
+     */
+    addVersions(version: IVersion[]): void;
+    /**
+     * Call when new version is downloaded from storage
+     * Expect multiple callbacks.
+     */
+    updateVersion(index: number, version: IVersion, seqNumber: number): void;
+    /**
+     * Called in response to successful onVersionSelection() or onSnapshotFileSelection() call
+     * and provides extra information about selection.
+     * It expected that UI layer would change its mode as result of this call, i.e. switch to
+     * displaying op playback controls (if this is supported)
+     * Note: There maybe no call to versionSelected() in response to onSnapshotFileSelection() call
+     * if file does not exist, has wrong name of wrong format.
+     * @param version - version, file name, or undefined if playing ops.
+     */
+    versionSelected(seqNumber: number, version: IVersion | string): void;
+    /**
+     * Called by controller in response to new ops being downloaded
+     * Called with disable = true if there are no (currently) ops to play
+     */
+    disableNextOpButton(disable: boolean): void;
+    /**
+     * Called by controller when new ops arrive (or we are done playing previous batch)
+     * Indicates next batch of ops that would be played when UI calls controller's onOpButtonClick()
+     * Called with ops=[] when there are no ops to play.
+     */
+    updateNextOpText(ops: ISequencedDocumentMessage[]): void;
+    /**
+     * Called periodically when new versions are downloaded from server
+     */
+    updateVersionText(versionsLeft: number): void;
+    /**
+     * Called periodically to notify about last known op
+     * @param lastKnownOp - seq number of last known op. -1 if can't play ops in this mode (load from file)
+     * @param stillLoading - true if we did not reach yet the end of the stream
+     */
+    updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
+}
+
+export { }

package/dist/debugger-beta.d.ts

@@ -0,0 +1,190 @@
+import { Deferred } from '@fluidframework/core-utils';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
+import { ReplayController } from '@fluidframework/replay-driver';
+
+/**
+ * @public
+ */
+export declare class DebuggerUI {
+    private readonly controller;
+    private readonly debuggerWindow;
+    static create(controller: IDebuggerController): DebuggerUI | null;
+    private static formatDate;
+    protected selector?: HTMLSelectElement;
+    protected versionText: HTMLDivElement;
+    protected buttonOps?: HTMLButtonElement;
+    protected text1?: HTMLDivElement;
+    protected text2?: HTMLDivElement;
+    protected text3?: HTMLDivElement;
+    protected lastOpText?: HTMLDivElement;
+    protected wasVersionSelected: boolean;
+    protected versions: IVersion[];
+    protected documentClosed: boolean;
+    protected constructor(controller: IDebuggerController, debuggerWindow: Window);
+    private attachDownloadOpsListener;
+    addVersions(versions: IVersion[]): void;
+    updateVersion(index: number, version: IVersion, seqNumber: number): void;
+    versionSelected(seqNumber: number, version: IVersion | string): void;
+    disableNextOpButton(disable: boolean): void;
+    updateNextOpText(ops: ISequencedDocumentMessage[]): void;
+    updateVersionText(versionCount: number): void;
+    updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
+    private download;
+}
+
+/**
+ * @public
+ */
+export declare type debuggerUIFactory = (controller: IDebuggerController) => IDebuggerUI | null;
+
+/**
+ * Replay controller that uses pop-up window to control op playback
+ *
+ * @public
+ */
+export declare class DebugReplayController extends ReplayController implements IDebuggerController {
+    static create(createUi: debuggerUIFactory): DebugReplayController | null;
+    protected static readonly WindowClosedSeq = -1;
+    protected static seqFromTree(documentStorageService: IDocumentStorageService, tree: ISnapshotTree | null): Promise<number>;
+    protected ui: IDebuggerUI;
+    protected stepsDeferred?: Deferred<number>;
+    protected startSeqDeferred: Deferred<number>;
+    protected retryFetchOpsOnEndOfFile: boolean;
+    protected documentService?: IDocumentService;
+    protected documentStorageService?: IDocumentStorageService;
+    protected versions: IVersion[];
+    protected stepsToPlay: number;
+    protected lastOpReached: boolean;
+    protected versionCount: number;
+    protected storage?: ReadDocumentStorageServiceBase;
+    private shouldUseController;
+    connectToUi(ui: IDebuggerUI): void;
+    onClose(): void;
+    onVersionSelection(version: IVersion): Promise<void>;
+    onOpButtonClick(steps: number): void;
+    onSnapshotFileSelection(file: File): void;
+    onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
+    private fetchOpsFromDeltaStorage;
+    fetchTo(currentOp: number): number | undefined;
+    isSelectionMade(): boolean;
+    downloadVersionInfo(documentStorageService: IDocumentStorageService, prevRequest: Promise<void>, index: number, version: IVersion): Promise<void>;
+    initStorage(documentService: IDocumentService): Promise<boolean>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    getStartingOpSequence(): Promise<number>;
+    /**
+     * Return true if we are done processing ops
+     */
+    isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
+    replay(emitter: (op: ISequencedDocumentMessage[]) => void, fetchedOps: ISequencedDocumentMessage[]): Promise<void>;
+    protected resolveStorage(seq: number, storage: ReadDocumentStorageServiceBase, version: IVersion | string): void;
+}
+
+/**
+ * @public
+ */
+export declare namespace FluidDebugger {
+    /**
+     * Creates document service wrapper that pops up Debugger window and allows user to play ops one by one.
+     * User can chose to start with any snapshot
+     * If pop-ups are disabled, we continue without debugger.
+     * @param documentService - original document service to use to fetch ops / snapshots.
+     */
+    export function createFromService(documentService: IDocumentService): Promise<IDocumentService>;
+    export function createFromServiceFactory(documentServiceFactory: IDocumentServiceFactory): Promise<IDocumentServiceFactory>;
+}
+
+/**
+ * @public
+ */
+export declare interface IDebuggerController {
+    /**
+     * Initialization. UI layers calls into controller to connect the two.
+     * @param ui - UI layer
+     */
+    connectToUi(ui: IDebuggerUI): any;
+    /**
+     * Called by UI layer when debugger window is closed by user
+     * If called before user makes selection of snapshot/file, original
+     * document service is returned to loader (instead of debugger service) and normal document load continues.
+     */
+    onClose(): void;
+    /**
+     * UI Layer notifies about selection of version to continue.
+     * On successful load, versionSelected() is called.
+     * @param version - Snapshot version to start from.
+     */
+    onVersionSelection(version: IVersion): void;
+    /**
+     * UI Layer notifies about selection of version to continue.
+     * On successful load, versionSelected() is called.
+     * @param version - File to load snapshot from
+     */
+    onSnapshotFileSelection(file: File): void;
+    /**
+     * "next op" button is clicked in the UI
+     * @param steps - number of ops to play.
+     */
+    onOpButtonClick(steps: number): void;
+    /**
+     * "Download ops" option is clicked in the UI. Returns JSON of the full opStream when available.
+     * @param anonymize - anonymize the ops json using the sanitization tool
+     */
+    onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
+}
+
+/**
+ * @public
+ */
+export declare interface IDebuggerUI {
+    /**
+     * Version information is provided.
+     * Expect updates (information about seq#, timestamp) through updateVersion() calls
+     */
+    addVersions(version: IVersion[]): void;
+    /**
+     * Call when new version is downloaded from storage
+     * Expect multiple callbacks.
+     */
+    updateVersion(index: number, version: IVersion, seqNumber: number): void;
+    /**
+     * Called in response to successful onVersionSelection() or onSnapshotFileSelection() call
+     * and provides extra information about selection.
+     * It expected that UI layer would change its mode as result of this call, i.e. switch to
+     * displaying op playback controls (if this is supported)
+     * Note: There maybe no call to versionSelected() in response to onSnapshotFileSelection() call
+     * if file does not exist, has wrong name of wrong format.
+     * @param version - version, file name, or undefined if playing ops.
+     */
+    versionSelected(seqNumber: number, version: IVersion | string): void;
+    /**
+     * Called by controller in response to new ops being downloaded
+     * Called with disable = true if there are no (currently) ops to play
+     */
+    disableNextOpButton(disable: boolean): void;
+    /**
+     * Called by controller when new ops arrive (or we are done playing previous batch)
+     * Indicates next batch of ops that would be played when UI calls controller's onOpButtonClick()
+     * Called with ops=[] when there are no ops to play.
+     */
+    updateNextOpText(ops: ISequencedDocumentMessage[]): void;
+    /**
+     * Called periodically when new versions are downloaded from server
+     */
+    updateVersionText(versionsLeft: number): void;
+    /**
+     * Called periodically to notify about last known op
+     * @param lastKnownOp - seq number of last known op. -1 if can't play ops in this mode (load from file)
+     * @param stillLoading - true if we did not reach yet the end of the stream
+     */
+    updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
+}
+
+export { }