@fluidframework/debugger 2.0.0-dev.7.4.0.215747 → 2.0.0-dev.7.4.0.216897

package/api-extractor-lint.json

@@ -0,0 +1,13 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json",
+	"messages": {
+		"extractorMessageReporting": {
+			// TODO: remove once base config has this enabled as an error
+			"ae-incompatible-release-tags": {
+				"logLevel": "error",
+				"addToApiReportFile": false
+			}
+		}
+	}
+}

package/api-report/debugger.api.md

@@ -14,7 +14,7 @@ import { IVersion } from '@fluidframework/protocol-definitions';
 import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
 import { ReplayController } from '@fluidframework/replay-driver';
 
-// @public (undocumented)
+// @internal (undocumented)
 export class DebuggerUI {
     protected constructor(controller: IDebuggerController, debuggerWindow: Window);
     // (undocumented)
@@ -55,10 +55,10 @@ export class DebuggerUI {
     protected wasVersionSelected: boolean;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export type debuggerUIFactory = (controller: IDebuggerController) => IDebuggerUI | null;
 
-// @public
+// @internal
 export class DebugReplayController extends ReplayController implements IDebuggerController {
     // (undocumented)
     connectToUi(ui: IDebuggerUI): void;
@@ -123,14 +123,14 @@ export class DebugReplayController extends ReplayController implements IDebugger
     protected static readonly WindowClosedSeq = -1;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export namespace FluidDebugger {
     export function createFromService(documentService: IDocumentService): Promise<IDocumentService>;
     // (undocumented)
     export function createFromServiceFactory(documentServiceFactory: IDocumentServiceFactory): Promise<IDocumentServiceFactory>;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IDebuggerController {
     connectToUi(ui: IDebuggerUI): any;
     onClose(): void;
@@ -140,7 +140,7 @@ export interface IDebuggerController {
     onVersionSelection(version: IVersion): void;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IDebuggerUI {
     addVersions(version: IVersion[]): void;
     disableNextOpButton(disable: boolean): void;

package/dist/debugger-alpha.d.ts

@@ -1,190 +1,29 @@
-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;
-}
+/* Excluded from this release type: DebuggerUI */
 
-/**
- * @public
- */
-export declare type debuggerUIFactory = (controller: IDebuggerController) => IDebuggerUI | null;
+/* Excluded from this release type: debuggerUIFactory */
 
-/**
- * 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;
-}
+/* Excluded from this release type: DebugReplayController */
 
-/**
- * @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>;
-}
+/* Excluded from this release type: Deferred */
 
-/**
- * @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>;
-}
+/* Excluded from this release type: FluidDebugger */
 
-/**
- * @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;
-}
+/* Excluded from this release type: IDebuggerController */
+
+/* Excluded from this release type: IDebuggerUI */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: ReadDocumentStorageServiceBase */
+
+/* Excluded from this release type: ReplayController */
 
 export { }

package/dist/debugger-beta.d.ts

@@ -1,190 +1,29 @@
-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;
-}
+/* Excluded from this release type: DebuggerUI */
 
-/**
- * @public
- */
-export declare type debuggerUIFactory = (controller: IDebuggerController) => IDebuggerUI | null;
+/* Excluded from this release type: debuggerUIFactory */
 
-/**
- * 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;
-}
+/* Excluded from this release type: DebugReplayController */
 
-/**
- * @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>;
-}
+/* Excluded from this release type: Deferred */
 
-/**
- * @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>;
-}
+/* Excluded from this release type: FluidDebugger */
 
-/**
- * @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;
-}
+/* Excluded from this release type: IDebuggerController */
+
+/* Excluded from this release type: IDebuggerUI */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: ReadDocumentStorageServiceBase */
+
+/* Excluded from this release type: ReplayController */
 
 export { }