@fluidframework/replay-driver 2.0.0-rc.4.0.5 → 2.0.0-rc.5.0.0

package/src/replayDocumentDeltaConnection.ts

@@ -6,24 +6,22 @@
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { IDisposable } from "@fluidframework/core-interfaces";
 import { delay } from "@fluidframework/core-utils/internal";
+import { ConnectionMode } from "@fluidframework/driver-definitions";
 import {
 	IDocumentDeltaConnection,
 	IDocumentDeltaConnectionEvents,
 	IDocumentDeltaStorageService,
 	IDocumentService,
-} from "@fluidframework/driver-definitions/internal";
-import {
-	ConnectionMode,
 	IClientConfiguration,
 	IConnected,
 	IDocumentMessage,
-	ISequencedDocumentMessage,
 	ISignalClient,
-	ISignalMessage,
 	ITokenClaims,
 	IVersion,
 	ScopeType,
-} from "@fluidframework/protocol-definitions";
+	ISequencedDocumentMessage,
+	ISignalMessage,
+} from "@fluidframework/driver-definitions/internal";
 
 import { ReplayController } from "./replayController.js";
 

package/src/replayDocumentService.ts

@@ -4,8 +4,15 @@
  */
 
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import * as api from "@fluidframework/driver-definitions/internal";
-import { IClient } from "@fluidframework/protocol-definitions";
+import { IClient } from "@fluidframework/driver-definitions";
+import {
+	IDocumentServiceEvents,
+	IDocumentService,
+	IDocumentStorageService,
+	IDocumentDeltaConnection,
+	IResolvedUrl,
+	IDocumentDeltaStorageService,
+} from "@fluidframework/driver-definitions/internal";
 
 import { EmptyDeltaStorageService } from "./emptyDeltaStorageService.js";
 import { ReplayController } from "./replayController.js";
@@ -18,14 +25,14 @@ import { ReplayDocumentDeltaConnection } from "./replayDocumentDeltaConnection.j
  * @internal
  */
 export class ReplayDocumentService
-	extends TypedEventEmitter<api.IDocumentServiceEvents>
+	extends TypedEventEmitter<IDocumentServiceEvents>
 	// eslint-disable-next-line import/namespace
-	implements api.IDocumentService
+	implements IDocumentService
 {
 	public static async create(
-		documentService: api.IDocumentService,
+		documentService: IDocumentService,
 		controller: ReplayController,
-	): Promise<api.IDocumentService> {
+	): Promise<IDocumentService> {
 		const useController = await controller.initStorage(documentService);
 		if (!useController) {
 			return documentService;
@@ -39,8 +46,8 @@ export class ReplayDocumentService
 	}
 
 	constructor(
-		private readonly controller: api.IDocumentStorageService,
-		private readonly deltaStorage: api.IDocumentDeltaConnection,
+		private readonly controller: IDocumentStorageService,
+		private readonly deltaStorage: IDocumentDeltaConnection,
 	) {
 		super();
 	}
@@ -48,7 +55,7 @@ export class ReplayDocumentService
 	public dispose() {}
 
 	// TODO: Issue-2109 Implement detach container api or put appropriate comment.
-	public get resolvedUrl(): api.IResolvedUrl {
+	public get resolvedUrl(): IResolvedUrl {
 		throw new Error("Not implemented");
 	}
 
@@ -56,7 +63,7 @@ export class ReplayDocumentService
 	 * Connects to a storage endpoint for snapshot service and blobs.
 	 * @returns returns the dummy document storage service for replay driver.
 	 */
-	public async connectToStorage(): Promise<api.IDocumentStorageService> {
+	public async connectToStorage(): Promise<IDocumentStorageService> {
 		return this.controller;
 	}
 
@@ -64,7 +71,7 @@ export class ReplayDocumentService
 	 * Connects to a delta storage endpoint for getting ops between a range.
 	 * @returns returns the dummy document delta storage service for replay driver.
 	 */
-	public async connectToDeltaStorage(): Promise<api.IDocumentDeltaStorageService> {
+	public async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {
 		return new EmptyDeltaStorageService();
 	}
 
@@ -74,7 +81,7 @@ export class ReplayDocumentService
 	 * @param client - Client that connects to socket.
 	 * @returns returns the delta stream service which replay ops from --from to --to arguments.
 	 */
-	public async connectToDeltaStream(client: IClient): Promise<api.IDocumentDeltaConnection> {
+	public async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {
 		return this.deltaStorage;
 	}
 }

package/src/replayDocumentServiceFactory.ts

@@ -4,12 +4,12 @@
  */
 
 import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import { ISummaryTree } from "@fluidframework/driver-definitions";
 import {
 	IDocumentService,
 	IDocumentServiceFactory,
 	IResolvedUrl,
 } from "@fluidframework/driver-definitions/internal";
-import { ISummaryTree } from "@fluidframework/protocol-definitions";
 import { createChildLogger } from "@fluidframework/telemetry-utils/internal";
 
 import { ReplayController } from "./replayController.js";

package/src/storageImplementations.ts

@@ -5,6 +5,7 @@
 
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { assert } from "@fluidframework/core-utils/internal";
+import { IClient, ISummaryTree } from "@fluidframework/driver-definitions";
 import {
 	IDocumentDeltaConnection,
 	IDocumentDeltaStorageService,
@@ -13,15 +14,11 @@ import {
 	IDocumentServiceFactory,
 	IDocumentStorageService,
 	IResolvedUrl,
-} from "@fluidframework/driver-definitions/internal";
-import { buildSnapshotTree } from "@fluidframework/driver-utils/internal";
-import {
-	IClient,
 	ISnapshotTree,
-	ISummaryTree,
 	ITree,
 	IVersion,
-} from "@fluidframework/protocol-definitions";
+} from "@fluidframework/driver-definitions/internal";
+import { buildSnapshotTree } from "@fluidframework/driver-utils/internal";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 
 import { EmptyDeltaStorageService } from "./emptyDeltaStorageService.js";

package/tsconfig.json

@@ -5,5 +5,7 @@
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./lib",
+		"exactOptionalPropertyTypes": false,
+		"noUncheckedIndexedAccess": false,
 	},
 }

package/tsdoc.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+	"extends": ["../../../common/build/build-common/tsdoc-base.json"]
+}

package/api-report/replay-driver.api.md

@@ -1,139 +0,0 @@
-## API Report File for "@fluidframework/replay-driver"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import * as api from '@fluidframework/protocol-definitions';
-import * as api_2 from '@fluidframework/driver-definitions/internal';
-import { IClient } from '@fluidframework/protocol-definitions';
-import { IDocumentService } from '@fluidframework/driver-definitions/internal';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
-import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
-import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISummaryContext } from '@fluidframework/driver-definitions/internal';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils/internal';
-import { ITree } from '@fluidframework/protocol-definitions';
-import { IVersion } from '@fluidframework/protocol-definitions';
-import { TypedEventEmitter } from '@fluid-internal/client-utils';
-
-// @internal (undocumented)
-export class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
-    constructor(json: IFileSnapshot);
-    // (undocumented)
-    protected blobs: Map<string, ArrayBufferLike>;
-    // (undocumented)
-    protected readonly commits: {
-        [key: string]: ITree;
-    };
-    // (undocumented)
-    protected docId?: string;
-    // (undocumented)
-    protected docTree: ISnapshotTree;
-    // (undocumented)
-    protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
-    // (undocumented)
-    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
-    // (undocumented)
-    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
-    // (undocumented)
-    readBlob(blobId: string): Promise<ArrayBufferLike>;
-    // (undocumented)
-    protected readonly trees: {
-        [key: string]: ISnapshotTree;
-    };
-}
-
-// @internal
-export interface IFileSnapshot {
-    // (undocumented)
-    commits: {
-        [key: string]: ITree;
-    };
-    // (undocumented)
-    tree: ITree;
-}
-
-// @internal
-export abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
-    // (undocumented)
-    createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
-    // (undocumented)
-    downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
-    // (undocumented)
-    abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
-    // (undocumented)
-    abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
-    // (undocumented)
-    abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
-    // (undocumented)
-    uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
-}
-
-// @internal
-export abstract class ReplayController extends ReadDocumentStorageServiceBase {
-    abstract fetchTo(currentOp: number): number | undefined;
-    abstract getStartingOpSequence(): Promise<number>;
-    abstract initStorage(documentService: IDocumentService): Promise<boolean>;
-    abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
-    abstract replay(emitter: (op: api.ISequencedDocumentMessage[]) => void, fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
-}
-
-// @internal
-export class ReplayDocumentService extends TypedEventEmitter<api_2.IDocumentServiceEvents> implements api_2.IDocumentService {
-    constructor(controller: api_2.IDocumentStorageService, deltaStorage: api_2.IDocumentDeltaConnection);
-    connectToDeltaStorage(): Promise<api_2.IDocumentDeltaStorageService>;
-    connectToDeltaStream(client: IClient): Promise<api_2.IDocumentDeltaConnection>;
-    connectToStorage(): Promise<api_2.IDocumentStorageService>;
-    // (undocumented)
-    static create(documentService: api_2.IDocumentService, controller: ReplayController): Promise<api_2.IDocumentService>;
-    // (undocumented)
-    dispose(): void;
-    // (undocumented)
-    get resolvedUrl(): api_2.IResolvedUrl;
-}
-
-// @internal (undocumented)
-export class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
-    constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);
-    // (undocumented)
-    static create(from: number, to: number, documentServiceFactory: IDocumentServiceFactory): ReplayDocumentServiceFactory;
-    // (undocumented)
-    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-}
-
-// @internal (undocumented)
-export class SnapshotStorage extends ReadDocumentStorageServiceBase {
-    constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
-    // (undocumented)
-    protected docId?: string;
-    // (undocumented)
-    protected readonly docTree: ISnapshotTree | null;
-    // (undocumented)
-    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
-    // (undocumented)
-    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
-    // (undocumented)
-    readBlob(blobId: string): Promise<ArrayBufferLike>;
-    // (undocumented)
-    protected readonly storage: IDocumentStorageService;
-}
-
-// @internal (undocumented)
-export class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
-    constructor(storage: IDocumentStorageService);
-    // (undocumented)
-    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    // (undocumented)
-    createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    // (undocumented)
-    protected readonly storage: IDocumentStorageService;
-}
-
-// (No @packageDocumentation comment for this package)
-
-```