@fluidframework/file-driver 2.0.0-dev-rc.5.0.0.265721 → 2.0.0-dev-rc.5.0.0.267932

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/file-driver",
-  "version": "2.0.0-dev-rc.5.0.0.265721",
+  "version": "2.0.0-dev-rc.5.0.0.267932",
   "description": "A driver that reads/write from/to local file storage.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -37,13 +37,12 @@
   "main": "lib/index.js",
   "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.265721",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.265721",
-    "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.265721",
-    "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.265721",
-    "@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.265721",
-    "@fluidframework/protocol-definitions": "^3.2.0",
-    "@fluidframework/replay-driver": "2.0.0-dev-rc.5.0.0.265721"
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.267932",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.267932",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.267932",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.267932",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.267932",
+    "@fluidframework/replay-driver": "2.0.0-dev-rc.5.0.0.267932"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
@@ -53,13 +52,13 @@
     "@fluidframework/build-tools": "^0.39.0-264124",
     "@fluidframework/eslint-config-fluid": "^5.1.0",
     "@fluidframework/file-driver-previous": "npm:@fluidframework/file-driver@2.0.0-rc.4.0.0",
-    "@microsoft/api-extractor": "^7.43.1",
+    "@microsoft/api-extractor": "^7.45.1",
     "@types/node": "^18.19.0",
     "copyfiles": "^2.4.1",
     "eslint": "~8.55.0",
     "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
-    "typescript": "~5.3.3"
+    "typescript": "~5.4.5"
   },
   "fluidBuild": {
     "tasks": {
@@ -69,7 +68,11 @@
     }
   },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "VariableDeclaration_FluidFetchReaderFileSnapshotWriter": {
+        "forwardCompat": false
+      }
+    }
   },
   "scripts": {
     "api": "fluid-build . --task api",

package/src/fileDeltaStorageService.ts

@@ -6,17 +6,17 @@
 import fs from "fs";
 
 import { assert } from "@fluidframework/core-utils/internal";
+import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions";
 import { IDocumentDeltaStorageService, IStream } from "@fluidframework/driver-definitions/internal";
 import { emptyMessageStream } from "@fluidframework/driver-utils/internal";
-import * as api from "@fluidframework/protocol-definitions";
 
 /**
  * Provides access to the underlying delta storage on the local file storage for file driver.
  * @internal
  */
 export class FileDeltaStorageService implements IDocumentDeltaStorageService {
-	private readonly messages: api.ISequencedDocumentMessage[];
-	private lastOps: api.ISequencedDocumentMessage[] = [];
+	private readonly messages: ISequencedDocumentMessage[];
+	private lastOps: ISequencedDocumentMessage[] = [];
 
 	constructor(private readonly path: string) {
 		this.messages = [];
@@ -41,11 +41,11 @@ export class FileDeltaStorageService implements IDocumentDeltaStorageService {
 		to: number | undefined,
 		abortSignal?: AbortSignal,
 		cachedOnly?: boolean,
-	): IStream<api.ISequencedDocumentMessage[]> {
+	): IStream<ISequencedDocumentMessage[]> {
 		return emptyMessageStream;
 	}
 
-	public get ops(): readonly Readonly<api.ISequencedDocumentMessage>[] {
+	public get ops(): readonly Readonly<ISequencedDocumentMessage>[] {
 		return this.messages;
 	}
 
@@ -55,7 +55,7 @@ export class FileDeltaStorageService implements IDocumentDeltaStorageService {
 	 * @param from - First op to be fetched.
 	 * @param to - Last op to be fetched. This is exclusive.
 	 */
-	public getFromWebSocket(from: number, to: number): api.ISequencedDocumentMessage[] {
+	public getFromWebSocket(from: number, to: number): ISequencedDocumentMessage[] {
 		const readFrom = Math.max(from, 0); // Inclusive
 		const readTo = Math.min(to, this.messages.length); // Exclusive
 

package/src/fileDocumentDeltaConnection.ts

@@ -5,21 +5,21 @@
 
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { IDisposable } from "@fluidframework/core-interfaces";
+import {
+	ConnectionMode,
+	ISequencedDocumentMessage,
+	ISignalMessage,
+} from "@fluidframework/driver-definitions";
 import {
 	IDocumentDeltaConnection,
 	IDocumentDeltaConnectionEvents,
-} from "@fluidframework/driver-definitions/internal";
-import {
-	ConnectionMode,
 	IClientConfiguration,
 	IConnected,
 	IDocumentMessage,
-	ISequencedDocumentMessage,
 	ISignalClient,
-	ISignalMessage,
 	ITokenClaims,
 	ScopeType,
-} from "@fluidframework/protocol-definitions";
+} from "@fluidframework/driver-definitions/internal";
 
 import { FileDeltaStorageService } from "./fileDeltaStorageService.js";
 

package/src/fileDocumentService.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,
+	IResolvedUrl,
+	IDocumentStorageService,
+	IDocumentDeltaConnection,
+	IDocumentDeltaStorageService,
+} from "@fluidframework/driver-definitions/internal";
 
 import { FileDeltaStorageService } from "./fileDeltaStorageService.js";
 
@@ -14,26 +21,26 @@ import { FileDeltaStorageService } from "./fileDeltaStorageService.js";
  * underlying storage for file document service.
  */
 export class FileDocumentService
-	extends TypedEventEmitter<api.IDocumentServiceEvents>
+	extends TypedEventEmitter<IDocumentServiceEvents>
 	// eslint-disable-next-line import/namespace
-	implements api.IDocumentService
+	implements IDocumentService
 {
 	constructor(
-		public readonly resolvedUrl: api.IResolvedUrl,
-		private readonly storage: api.IDocumentStorageService,
+		public readonly resolvedUrl: IResolvedUrl,
+		private readonly storage: IDocumentStorageService,
 		private readonly deltaStorage: FileDeltaStorageService,
-		private readonly deltaConnection: api.IDocumentDeltaConnection,
+		private readonly deltaConnection: IDocumentDeltaConnection,
 	) {
 		super();
 	}
 
 	public dispose() {}
 
-	public async connectToStorage(): Promise<api.IDocumentStorageService> {
+	public async connectToStorage(): Promise<IDocumentStorageService> {
 		return this.storage;
 	}
 
-	public async connectToDeltaStorage(): Promise<api.IDocumentDeltaStorageService> {
+	public async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {
 		return this.deltaStorage;
 	}
 
@@ -44,7 +51,7 @@ export class FileDocumentService
 	 * @param client - Client that connects to socket.
 	 * @returns returns the delta stream service.
 	 */
-	public async connectToDeltaStream(client: IClient): Promise<api.IDocumentDeltaConnection> {
+	public async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {
 		return this.deltaConnection;
 	}
 }

package/src/fileDocumentServiceFactory.ts

@@ -4,6 +4,7 @@
  */
 
 import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import { ISummaryTree } from "@fluidframework/driver-definitions";
 import {
 	IDocumentDeltaConnection,
 	IDocumentService,
@@ -11,7 +12,6 @@ import {
 	IDocumentStorageService,
 	IResolvedUrl,
 } from "@fluidframework/driver-definitions/internal";
-import { ISummaryTree } from "@fluidframework/protocol-definitions";
 
 import { FileDeltaStorageService } from "./fileDeltaStorageService.js";
 import { FileDocumentService } from "./fileDocumentService.js";

package/src/fileDocumentStorageService.ts

@@ -7,15 +7,21 @@ import fs from "fs";
 
 import { bufferToString } from "@fluid-internal/client-utils";
 import { assert } from "@fluidframework/core-utils/internal";
+import { ISummaryTree } from "@fluidframework/driver-definitions";
 import {
 	IDocumentStorageService,
 	ISummaryContext,
+	ISnapshotTree,
+	IVersion,
+	ITree,
+	FileMode,
+	TreeEntry,
+	IBlob,
 } from "@fluidframework/driver-definitions/internal";
 import {
 	buildSnapshotTree,
 	convertSummaryTreeToSnapshotITree,
 } from "@fluidframework/driver-utils/internal";
-import * as api from "@fluidframework/protocol-definitions";
 import {
 	IFileSnapshot,
 	ReadDocumentStorageServiceBase,
@@ -39,7 +45,7 @@ export class FluidFetchReader
 	extends ReadDocumentStorageServiceBase
 	implements IDocumentStorageService
 {
-	protected docTree: api.ISnapshotTree | null = null;
+	protected docTree: ISnapshotTree | null = null;
 
 	constructor(
 		private readonly path: string,
@@ -53,7 +59,7 @@ export class FluidFetchReader
 	 * @param version - The version contains the path of the file which contains the snapshot tree.
 	 */
 	// eslint-disable-next-line @rushstack/no-new-null
-	public async getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null> {
+	public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {
 		assert(version !== null, 0x092 /* "version input for reading snapshot tree is null!" */);
 		assert(
 			!version || version.treeId === FileStorageVersionTreeId,
@@ -93,7 +99,7 @@ export class FluidFetchReader
 	 * @param count - Number of versions to be returned.
 	 */
 	// eslint-disable-next-line @rushstack/no-new-null
-	public async getVersions(versionId: string | null, count: number): Promise<api.IVersion[]> {
+	public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
 		if (versionId === FileStorageDocumentName || versionId === null) {
 			if (this.docTree !== null || this.versionName !== undefined) {
 				return [{ id: "latest", treeId: FileStorageVersionTreeId }];
@@ -143,7 +149,7 @@ export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(
 	class extends Base implements ISnapshotWriterStorage {
 		// Note: if variable name has same name as in base class, it overrides it!
 		public blobsWriter = new Map<string, ArrayBufferLike>();
-		public latestWriterTree?: api.ISnapshotTree;
+		public latestWriterTree?: ISnapshotTree;
 		public docId?: string;
 
 		public reset() {
@@ -165,7 +171,7 @@ export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(
 		}
 
 		// eslint-disable-next-line @rushstack/no-new-null
-		public async getVersions(versionId: string | null, count: number): Promise<api.IVersion[]> {
+		public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
 			// If we already saved document, that means we are getting here because of snapshot generation.
 			// Not returning tree ensures that ContainerRuntime.snapshot() would regenerate subtrees for
 			// each unchanged data store.
@@ -183,7 +189,7 @@ export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(
 		}
 
 		// eslint-disable-next-line @rushstack/no-new-null
-		public async getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null> {
+		public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {
 			if (this.latestWriterTree && (!version || version.id === "latest")) {
 				return this.latestWriterTree;
 			}
@@ -191,7 +197,7 @@ export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(
 		}
 
 		public async uploadSummaryWithContext(
-			summary: api.ISummaryTree,
+			summary: ISummaryTree,
 			context: ISummaryContext,
 		): Promise<string> {
 			const tree = convertSummaryTreeToSnapshotITree(summary);
@@ -207,15 +213,15 @@ export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(
 			return "testHandleId";
 		}
 
-		public async buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree> {
-			const tree: api.ITree = { entries: [] };
+		public async buildTree(snapshotTree: ISnapshotTree): Promise<ITree> {
+			const tree: ITree = { entries: [] };
 
 			for (const subTreeId of Object.keys(snapshotTree.trees)) {
 				const subTree = await this.buildTree(snapshotTree.trees[subTreeId]);
 				tree.entries.push({
-					mode: api.FileMode.Directory,
+					mode: FileMode.Directory,
 					path: subTreeId,
-					type: api.TreeEntry.Tree,
+					type: TreeEntry.Tree,
 					value: subTree,
 				});
 			}
@@ -223,14 +229,14 @@ export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(
 			for (const blobName of Object.keys(snapshotTree.blobs)) {
 				const buffer = await this.readBlob(snapshotTree.blobs[blobName]);
 				const contents = bufferToString(buffer, "utf8");
-				const blob: api.IBlob = {
+				const blob: IBlob = {
 					contents,
 					encoding: "utf-8",
 				};
 				tree.entries.push({
-					mode: api.FileMode.File,
+					mode: FileMode.File,
 					path: blobName,
-					type: api.TreeEntry.Blob,
+					type: TreeEntry.Blob,
 					value: blob,
 				});
 			}
@@ -239,9 +245,9 @@ export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(
 		}
 	};
 
-function removeNullTreeIds(tree: api.ITree) {
+function removeNullTreeIds(tree: ITree) {
 	for (const node of tree.entries) {
-		if (node.type === api.TreeEntry.Tree) {
+		if (node.type === TreeEntry.Tree) {
 			removeNullTreeIds(node.value);
 		}
 	}