@fluidframework/replay-driver 2.0.0-internal.7.0.1 → 2.0.0-internal.7.1.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluidframework/replay-driver
 
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.7.0.0
 
 ### Major Changes

package/api-extractor.json

@@ -1,4 +1,12 @@
 {
 	"$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",
+	"messages": {
+		"extractorMessageReporting": {
+			"ae-missing-release-tag": {
+				// TODO: Fix violations and remove this rule override
+				"logLevel": "none"
+			}
+		}
+	}
 }

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

@@ -0,0 +1,150 @@
+## 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';
+import { IClient } from '@fluidframework/protocol-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+
+// @public (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;
+    };
+}
+
+// @public
+export interface IFileSnapshot {
+    // (undocumented)
+    commits: {
+        [key: string]: ITree;
+    };
+    // (undocumented)
+    tree: ITree;
+}
+
+// @public (undocumented)
+export class OpStorage extends ReadDocumentStorageServiceBase {
+    // (undocumented)
+    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
+    // (undocumented)
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    // (undocumented)
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+// @public
+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)
+    get repositoryUrl(): string;
+    // (undocumented)
+    uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
+}
+
+// @public
+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>;
+}
+
+// @public
+export class ReplayDocumentService 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;
+}
+
+// @public (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>;
+}
+
+// @public (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;
+}
+
+// @public (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)
+
+```

package/dist/replay-driver-alpha.d.ts

@@ -0,0 +1,168 @@
+import * as api from '@fluidframework/protocol-definitions';
+import * as api_2 from '@fluidframework/driver-definitions';
+import { IClient } from '@fluidframework/protocol-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+
+export declare class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
+    protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
+    protected docId?: string;
+    protected docTree: ISnapshotTree;
+    protected blobs: Map<string, ArrayBufferLike>;
+    protected readonly commits: {
+        [key: string]: ITree;
+    };
+    protected readonly trees: {
+        [key: string]: ISnapshotTree;
+    };
+    constructor(json: IFileSnapshot);
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+/**
+ * Structure of snapshot on disk, when we store snapshot as single file
+ */
+export declare interface IFileSnapshot {
+    tree: ITree;
+    commits: {
+        [key: string]: ITree;
+    };
+}
+
+export declare class OpStorage extends ReadDocumentStorageServiceBase {
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+/**
+ * Partial implementation of IDocumentStorageService
+ */
+export declare abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
+    abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
+    abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
+    abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
+    uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
+    createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
+    downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
+    get repositoryUrl(): string;
+}
+
+/**
+ * Replay controller object
+ * It controls where we start (snapshot, local file, no snapshots)
+ * As well as dispatch of ops
+ */
+export declare abstract class ReplayController extends ReadDocumentStorageServiceBase {
+    /**
+     * Initialize reply controller
+     * @param documentService - the real document service
+     * @returns Whether or not the controller should be used.
+     * If `false` is returned, caller should fallback to original storage.
+     */
+    abstract initStorage(documentService: IDocumentService): Promise<boolean>;
+    /**
+     * Returns sequence number to start processing ops
+     * Should be zero if not using snapshot, and snapshot seq# otherwise
+     */
+    abstract getStartingOpSequence(): Promise<number>;
+    /**
+     * Returns last op number to fetch from current op
+     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
+     * @param currentOp - current op
+     */
+    abstract fetchTo(currentOp: number): number | undefined;
+    /**
+     * Returns true if no more ops should be processed (or downloaded for future processing).
+     * It's called at end of each batch with latest op timestamp.
+     * Also it's called when there are no more ops available (lastTimeStamp === undefined).
+     * If false is returned and there are no more ops, request for more ops is made every 2 seconds.
+     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
+     * @param currentOp - current op
+     * @param lastTimeStamp - timestamp of last op (if more ops are available). Undefined otherwise.
+     */
+    abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
+    /**
+     * Replay batch of ops
+     * NOTE: new batch of ops is fetched (fetchTo() & isDoneFetch() APIs are called) while this call is in flights
+     * @param emitter - callback to emit ops
+     * @param fetchedOps - ops to process
+     */
+    abstract replay(emitter: (op: api.ISequencedDocumentMessage[]) => void, fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
+}
+
+/**
+ * The Replay document service dummies out the snapshot and the delta storage.
+ * Delta connection simulates the socket by fetching the ops from delta storage
+ * and emitting them with a pre determined delay
+ */
+export declare class ReplayDocumentService implements api_2.IDocumentService {
+    private readonly controller;
+    private readonly deltaStorage;
+    static create(documentService: api_2.IDocumentService, controller: ReplayController): Promise<api_2.IDocumentService>;
+    constructor(controller: api_2.IDocumentStorageService, deltaStorage: api_2.IDocumentDeltaConnection);
+    dispose(): void;
+    get resolvedUrl(): api_2.IResolvedUrl;
+    /**
+     * Connects to a storage endpoint for snapshot service and blobs.
+     * @returns returns the dummy document storage service for replay driver.
+     */
+    connectToStorage(): Promise<api_2.IDocumentStorageService>;
+    /**
+     * Connects to a delta storage endpoint for getting ops between a range.
+     * @returns returns the dummy document delta storage service for replay driver.
+     */
+    connectToDeltaStorage(): Promise<api_2.IDocumentDeltaStorageService>;
+    /**
+     * Connects to a delta storage endpoint of provided documentService to get ops and then replaying
+     * them so as to mimic a delta stream endpoint.
+     * @param client - Client that connects to socket.
+     * @returns returns the delta stream service which replay ops from --from to --to arguments.
+     */
+    connectToDeltaStream(client: IClient): Promise<api_2.IDocumentDeltaConnection>;
+}
+
+export declare class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
+    private readonly documentServiceFactory;
+    private readonly controller;
+    static create(from: number, to: number, documentServiceFactory: IDocumentServiceFactory): ReplayDocumentServiceFactory;
+    constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);
+    /**
+     * Creates a replay document service which uses the document service of provided
+     * documentServiceFactory for connecting to delta stream endpoint.
+     * @param resolvedUrl - URL to be used for connecting to endpoints.
+     * @returns returns the requested document service
+     */
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+
+export declare class SnapshotStorage extends ReadDocumentStorageServiceBase {
+    protected readonly storage: IDocumentStorageService;
+    protected readonly docTree: ISnapshotTree | null;
+    protected docId?: string;
+    constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+export declare class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
+    protected readonly storage: IDocumentStorageService;
+    constructor(storage: IDocumentStorageService);
+    createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+
+export { }

package/dist/replay-driver-beta.d.ts

@@ -0,0 +1,168 @@
+import * as api from '@fluidframework/protocol-definitions';
+import * as api_2 from '@fluidframework/driver-definitions';
+import { IClient } from '@fluidframework/protocol-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+
+export declare class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
+    protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
+    protected docId?: string;
+    protected docTree: ISnapshotTree;
+    protected blobs: Map<string, ArrayBufferLike>;
+    protected readonly commits: {
+        [key: string]: ITree;
+    };
+    protected readonly trees: {
+        [key: string]: ISnapshotTree;
+    };
+    constructor(json: IFileSnapshot);
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+/**
+ * Structure of snapshot on disk, when we store snapshot as single file
+ */
+export declare interface IFileSnapshot {
+    tree: ITree;
+    commits: {
+        [key: string]: ITree;
+    };
+}
+
+export declare class OpStorage extends ReadDocumentStorageServiceBase {
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+/**
+ * Partial implementation of IDocumentStorageService
+ */
+export declare abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
+    abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
+    abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
+    abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
+    uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
+    createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
+    downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
+    get repositoryUrl(): string;
+}
+
+/**
+ * Replay controller object
+ * It controls where we start (snapshot, local file, no snapshots)
+ * As well as dispatch of ops
+ */
+export declare abstract class ReplayController extends ReadDocumentStorageServiceBase {
+    /**
+     * Initialize reply controller
+     * @param documentService - the real document service
+     * @returns Whether or not the controller should be used.
+     * If `false` is returned, caller should fallback to original storage.
+     */
+    abstract initStorage(documentService: IDocumentService): Promise<boolean>;
+    /**
+     * Returns sequence number to start processing ops
+     * Should be zero if not using snapshot, and snapshot seq# otherwise
+     */
+    abstract getStartingOpSequence(): Promise<number>;
+    /**
+     * Returns last op number to fetch from current op
+     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
+     * @param currentOp - current op
+     */
+    abstract fetchTo(currentOp: number): number | undefined;
+    /**
+     * Returns true if no more ops should be processed (or downloaded for future processing).
+     * It's called at end of each batch with latest op timestamp.
+     * Also it's called when there are no more ops available (lastTimeStamp === undefined).
+     * If false is returned and there are no more ops, request for more ops is made every 2 seconds.
+     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
+     * @param currentOp - current op
+     * @param lastTimeStamp - timestamp of last op (if more ops are available). Undefined otherwise.
+     */
+    abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
+    /**
+     * Replay batch of ops
+     * NOTE: new batch of ops is fetched (fetchTo() & isDoneFetch() APIs are called) while this call is in flights
+     * @param emitter - callback to emit ops
+     * @param fetchedOps - ops to process
+     */
+    abstract replay(emitter: (op: api.ISequencedDocumentMessage[]) => void, fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
+}
+
+/**
+ * The Replay document service dummies out the snapshot and the delta storage.
+ * Delta connection simulates the socket by fetching the ops from delta storage
+ * and emitting them with a pre determined delay
+ */
+export declare class ReplayDocumentService implements api_2.IDocumentService {
+    private readonly controller;
+    private readonly deltaStorage;
+    static create(documentService: api_2.IDocumentService, controller: ReplayController): Promise<api_2.IDocumentService>;
+    constructor(controller: api_2.IDocumentStorageService, deltaStorage: api_2.IDocumentDeltaConnection);
+    dispose(): void;
+    get resolvedUrl(): api_2.IResolvedUrl;
+    /**
+     * Connects to a storage endpoint for snapshot service and blobs.
+     * @returns returns the dummy document storage service for replay driver.
+     */
+    connectToStorage(): Promise<api_2.IDocumentStorageService>;
+    /**
+     * Connects to a delta storage endpoint for getting ops between a range.
+     * @returns returns the dummy document delta storage service for replay driver.
+     */
+    connectToDeltaStorage(): Promise<api_2.IDocumentDeltaStorageService>;
+    /**
+     * Connects to a delta storage endpoint of provided documentService to get ops and then replaying
+     * them so as to mimic a delta stream endpoint.
+     * @param client - Client that connects to socket.
+     * @returns returns the delta stream service which replay ops from --from to --to arguments.
+     */
+    connectToDeltaStream(client: IClient): Promise<api_2.IDocumentDeltaConnection>;
+}
+
+export declare class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
+    private readonly documentServiceFactory;
+    private readonly controller;
+    static create(from: number, to: number, documentServiceFactory: IDocumentServiceFactory): ReplayDocumentServiceFactory;
+    constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);
+    /**
+     * Creates a replay document service which uses the document service of provided
+     * documentServiceFactory for connecting to delta stream endpoint.
+     * @param resolvedUrl - URL to be used for connecting to endpoints.
+     * @returns returns the requested document service
+     */
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+
+export declare class SnapshotStorage extends ReadDocumentStorageServiceBase {
+    protected readonly storage: IDocumentStorageService;
+    protected readonly docTree: ISnapshotTree | null;
+    protected docId?: string;
+    constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+export declare class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
+    protected readonly storage: IDocumentStorageService;
+    constructor(storage: IDocumentStorageService);
+    createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+
+export { }

package/dist/replay-driver-public.d.ts

@@ -0,0 +1,168 @@
+import * as api from '@fluidframework/protocol-definitions';
+import * as api_2 from '@fluidframework/driver-definitions';
+import { IClient } from '@fluidframework/protocol-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+
+export declare class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
+    protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
+    protected docId?: string;
+    protected docTree: ISnapshotTree;
+    protected blobs: Map<string, ArrayBufferLike>;
+    protected readonly commits: {
+        [key: string]: ITree;
+    };
+    protected readonly trees: {
+        [key: string]: ISnapshotTree;
+    };
+    constructor(json: IFileSnapshot);
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+/**
+ * Structure of snapshot on disk, when we store snapshot as single file
+ */
+export declare interface IFileSnapshot {
+    tree: ITree;
+    commits: {
+        [key: string]: ITree;
+    };
+}
+
+export declare class OpStorage extends ReadDocumentStorageServiceBase {
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+/**
+ * Partial implementation of IDocumentStorageService
+ */
+export declare abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
+    abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
+    abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
+    abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
+    uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
+    createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
+    downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
+    get repositoryUrl(): string;
+}
+
+/**
+ * Replay controller object
+ * It controls where we start (snapshot, local file, no snapshots)
+ * As well as dispatch of ops
+ */
+export declare abstract class ReplayController extends ReadDocumentStorageServiceBase {
+    /**
+     * Initialize reply controller
+     * @param documentService - the real document service
+     * @returns Whether or not the controller should be used.
+     * If `false` is returned, caller should fallback to original storage.
+     */
+    abstract initStorage(documentService: IDocumentService): Promise<boolean>;
+    /**
+     * Returns sequence number to start processing ops
+     * Should be zero if not using snapshot, and snapshot seq# otherwise
+     */
+    abstract getStartingOpSequence(): Promise<number>;
+    /**
+     * Returns last op number to fetch from current op
+     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
+     * @param currentOp - current op
+     */
+    abstract fetchTo(currentOp: number): number | undefined;
+    /**
+     * Returns true if no more ops should be processed (or downloaded for future processing).
+     * It's called at end of each batch with latest op timestamp.
+     * Also it's called when there are no more ops available (lastTimeStamp === undefined).
+     * If false is returned and there are no more ops, request for more ops is made every 2 seconds.
+     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
+     * @param currentOp - current op
+     * @param lastTimeStamp - timestamp of last op (if more ops are available). Undefined otherwise.
+     */
+    abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
+    /**
+     * Replay batch of ops
+     * NOTE: new batch of ops is fetched (fetchTo() & isDoneFetch() APIs are called) while this call is in flights
+     * @param emitter - callback to emit ops
+     * @param fetchedOps - ops to process
+     */
+    abstract replay(emitter: (op: api.ISequencedDocumentMessage[]) => void, fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
+}
+
+/**
+ * The Replay document service dummies out the snapshot and the delta storage.
+ * Delta connection simulates the socket by fetching the ops from delta storage
+ * and emitting them with a pre determined delay
+ */
+export declare class ReplayDocumentService implements api_2.IDocumentService {
+    private readonly controller;
+    private readonly deltaStorage;
+    static create(documentService: api_2.IDocumentService, controller: ReplayController): Promise<api_2.IDocumentService>;
+    constructor(controller: api_2.IDocumentStorageService, deltaStorage: api_2.IDocumentDeltaConnection);
+    dispose(): void;
+    get resolvedUrl(): api_2.IResolvedUrl;
+    /**
+     * Connects to a storage endpoint for snapshot service and blobs.
+     * @returns returns the dummy document storage service for replay driver.
+     */
+    connectToStorage(): Promise<api_2.IDocumentStorageService>;
+    /**
+     * Connects to a delta storage endpoint for getting ops between a range.
+     * @returns returns the dummy document delta storage service for replay driver.
+     */
+    connectToDeltaStorage(): Promise<api_2.IDocumentDeltaStorageService>;
+    /**
+     * Connects to a delta storage endpoint of provided documentService to get ops and then replaying
+     * them so as to mimic a delta stream endpoint.
+     * @param client - Client that connects to socket.
+     * @returns returns the delta stream service which replay ops from --from to --to arguments.
+     */
+    connectToDeltaStream(client: IClient): Promise<api_2.IDocumentDeltaConnection>;
+}
+
+export declare class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
+    private readonly documentServiceFactory;
+    private readonly controller;
+    static create(from: number, to: number, documentServiceFactory: IDocumentServiceFactory): ReplayDocumentServiceFactory;
+    constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);
+    /**
+     * Creates a replay document service which uses the document service of provided
+     * documentServiceFactory for connecting to delta stream endpoint.
+     * @param resolvedUrl - URL to be used for connecting to endpoints.
+     * @returns returns the requested document service
+     */
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+
+export declare class SnapshotStorage extends ReadDocumentStorageServiceBase {
+    protected readonly storage: IDocumentStorageService;
+    protected readonly docTree: ISnapshotTree | null;
+    protected docId?: string;
+    constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+export declare class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
+    protected readonly storage: IDocumentStorageService;
+    constructor(storage: IDocumentStorageService);
+    createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+
+export { }

package/dist/replay-driver.d.ts

@@ -0,0 +1,168 @@
+import * as api from '@fluidframework/protocol-definitions';
+import * as api_2 from '@fluidframework/driver-definitions';
+import { IClient } from '@fluidframework/protocol-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+
+export declare class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
+    protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
+    protected docId?: string;
+    protected docTree: ISnapshotTree;
+    protected blobs: Map<string, ArrayBufferLike>;
+    protected readonly commits: {
+        [key: string]: ITree;
+    };
+    protected readonly trees: {
+        [key: string]: ISnapshotTree;
+    };
+    constructor(json: IFileSnapshot);
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+/**
+ * Structure of snapshot on disk, when we store snapshot as single file
+ */
+export declare interface IFileSnapshot {
+    tree: ITree;
+    commits: {
+        [key: string]: ITree;
+    };
+}
+
+export declare class OpStorage extends ReadDocumentStorageServiceBase {
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+/**
+ * Partial implementation of IDocumentStorageService
+ */
+export declare abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
+    abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
+    abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
+    abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
+    uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
+    createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
+    downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
+    get repositoryUrl(): string;
+}
+
+/**
+ * Replay controller object
+ * It controls where we start (snapshot, local file, no snapshots)
+ * As well as dispatch of ops
+ */
+export declare abstract class ReplayController extends ReadDocumentStorageServiceBase {
+    /**
+     * Initialize reply controller
+     * @param documentService - the real document service
+     * @returns Whether or not the controller should be used.
+     * If `false` is returned, caller should fallback to original storage.
+     */
+    abstract initStorage(documentService: IDocumentService): Promise<boolean>;
+    /**
+     * Returns sequence number to start processing ops
+     * Should be zero if not using snapshot, and snapshot seq# otherwise
+     */
+    abstract getStartingOpSequence(): Promise<number>;
+    /**
+     * Returns last op number to fetch from current op
+     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
+     * @param currentOp - current op
+     */
+    abstract fetchTo(currentOp: number): number | undefined;
+    /**
+     * Returns true if no more ops should be processed (or downloaded for future processing).
+     * It's called at end of each batch with latest op timestamp.
+     * Also it's called when there are no more ops available (lastTimeStamp === undefined).
+     * If false is returned and there are no more ops, request for more ops is made every 2 seconds.
+     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
+     * @param currentOp - current op
+     * @param lastTimeStamp - timestamp of last op (if more ops are available). Undefined otherwise.
+     */
+    abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
+    /**
+     * Replay batch of ops
+     * NOTE: new batch of ops is fetched (fetchTo() & isDoneFetch() APIs are called) while this call is in flights
+     * @param emitter - callback to emit ops
+     * @param fetchedOps - ops to process
+     */
+    abstract replay(emitter: (op: api.ISequencedDocumentMessage[]) => void, fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
+}
+
+/**
+ * The Replay document service dummies out the snapshot and the delta storage.
+ * Delta connection simulates the socket by fetching the ops from delta storage
+ * and emitting them with a pre determined delay
+ */
+export declare class ReplayDocumentService implements api_2.IDocumentService {
+    private readonly controller;
+    private readonly deltaStorage;
+    static create(documentService: api_2.IDocumentService, controller: ReplayController): Promise<api_2.IDocumentService>;
+    constructor(controller: api_2.IDocumentStorageService, deltaStorage: api_2.IDocumentDeltaConnection);
+    dispose(): void;
+    get resolvedUrl(): api_2.IResolvedUrl;
+    /**
+     * Connects to a storage endpoint for snapshot service and blobs.
+     * @returns returns the dummy document storage service for replay driver.
+     */
+    connectToStorage(): Promise<api_2.IDocumentStorageService>;
+    /**
+     * Connects to a delta storage endpoint for getting ops between a range.
+     * @returns returns the dummy document delta storage service for replay driver.
+     */
+    connectToDeltaStorage(): Promise<api_2.IDocumentDeltaStorageService>;
+    /**
+     * Connects to a delta storage endpoint of provided documentService to get ops and then replaying
+     * them so as to mimic a delta stream endpoint.
+     * @param client - Client that connects to socket.
+     * @returns returns the delta stream service which replay ops from --from to --to arguments.
+     */
+    connectToDeltaStream(client: IClient): Promise<api_2.IDocumentDeltaConnection>;
+}
+
+export declare class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
+    private readonly documentServiceFactory;
+    private readonly controller;
+    static create(from: number, to: number, documentServiceFactory: IDocumentServiceFactory): ReplayDocumentServiceFactory;
+    constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);
+    /**
+     * Creates a replay document service which uses the document service of provided
+     * documentServiceFactory for connecting to delta stream endpoint.
+     * @param resolvedUrl - URL to be used for connecting to endpoints.
+     * @returns returns the requested document service
+     */
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+
+export declare class SnapshotStorage extends ReadDocumentStorageServiceBase {
+    protected readonly storage: IDocumentStorageService;
+    protected readonly docTree: ISnapshotTree | null;
+    protected docId?: string;
+    constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+}
+
+export declare class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
+    protected readonly storage: IDocumentStorageService;
+    constructor(storage: IDocumentStorageService);
+    createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+
+export { }

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.37.0"
+      "packageVersion": "7.38.0"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/replay-driver",
-  "version": "2.0.0-internal.7.0.1",
+  "version": "2.0.0-internal.7.1.1",
   "description": "Document replay version of Socket.IO implementation",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,27 +15,27 @@
   "module": "lib/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-internal.7.0.1 <2.0.0-internal.7.1.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.0.1 <2.0.0-internal.7.1.0",
-    "@fluidframework/core-utils": ">=2.0.0-internal.7.0.1 <2.0.0-internal.7.1.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-internal.7.0.1 <2.0.0-internal.7.1.0",
-    "@fluidframework/driver-utils": ">=2.0.0-internal.7.0.1 <2.0.0-internal.7.1.0",
+    "@fluid-internal/client-utils": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0",
+    "@fluidframework/core-utils": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0",
+    "@fluidframework/driver-utils": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.7.0.1 <2.0.0-internal.7.1.0"
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.24.0",
-    "@fluidframework/build-common": "^2.0.0",
-    "@fluidframework/build-tools": "^0.24.0",
-    "@fluidframework/eslint-config-fluid": "^2.1.0",
-    "@fluidframework/replay-driver-previous": "npm:@fluidframework/replay-driver@2.0.0-internal.6.3.0",
+    "@fluid-tools/build-cli": "^0.25.0",
+    "@fluidframework/build-common": "^2.0.1",
+    "@fluidframework/build-tools": "^0.25.0",
+    "@fluidframework/eslint-config-fluid": "^3.0.0",
+    "@fluidframework/replay-driver-previous": "npm:@fluidframework/replay-driver@2.0.0-internal.7.1.0",
     "@microsoft/api-extractor": "^7.37.0",
     "@types/nock": "^9.3.0",
     "@types/node": "^16.18.38",
     "copyfiles": "^2.4.1",
-    "eslint": "~8.6.0",
+    "eslint": "~8.50.0",
     "nock": "^13.3.3",
-    "prettier": "~2.6.2",
+    "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
     "typescript": "~5.1.6"
   },
@@ -53,9 +53,9 @@
   "scripts": {
     "build": "fluid-build . --task build",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp'",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",