debugger.api.md

API Report File for "@fluidframework/debugger"

Do not edit this file. It is a report generated by API Extractor.

import { Deferred } from '@fluidframework/common-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)