@fluidframework/odsp-driver 2.0.0-dev-rc.1.0.0.228517 → 2.0.0-dev-rc.1.0.0.232845

package/src/compactSnapshotParser.ts

@@ -6,7 +6,7 @@
 import { assert } from "@fluidframework/core-utils";
 import { ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
-import { ISnapshotContents } from "./odspPublicUtils";
+import { ISnapshot } from "@fluidframework/driver-definitions";
 import { ReadBuffer } from "./ReadBufferUtils";
 import {
 	assertBlobCoreInstance,
@@ -29,7 +29,7 @@ export const currentReadVersion = "1.0";
  * represents how many times slower parsing path is executed. This will be then logged into telemetry.
  * @internal
  */
-export interface ISnapshotContentsWithProps extends ISnapshotContents {
+export interface ISnapshotContentsWithProps extends ISnapshot {
 	telemetryProps: Record<string, number>;
 }
 
@@ -40,7 +40,7 @@ export interface ISnapshotContentsWithProps extends ISnapshotContents {
 function readBlobSection(node: NodeTypes) {
 	assertNodeCoreInstance(node, "TreeBlobs should be of type NodeCore");
 	let slowBlobStructureCount = 0;
-	const blobs: Map<string, ArrayBuffer> = new Map();
+	const blobContents: Map<string, ArrayBuffer> = new Map();
 	for (const blob of node) {
 		assertNodeCoreInstance(blob, "blob should be node");
 
@@ -56,7 +56,7 @@ function readBlobSection(node: NodeTypes) {
 		) {
 			// "id": <node name>
 			// "data": <blob>
-			blobs.set(blob.getString(1), blob.getBlob(3).arrayBuffer);
+			blobContents.set(blob.getString(1), blob.getBlob(3).arrayBuffer);
 			continue;
 		}
 
@@ -67,9 +67,9 @@ function readBlobSection(node: NodeTypes) {
 		const records = getNodeProps(blob);
 		assertBlobCoreInstance(records.data, "data should be of BlobCore type");
 		const id = getStringInstance(records.id, "blob id should be string");
-		blobs.set(id, records.data.arrayBuffer);
+		blobContents.set(id, records.data.arrayBuffer);
 	}
-	return { blobs, slowBlobStructureCount };
+	return { blobContents, slowBlobStructureCount };
 }
 
 /**
@@ -249,19 +249,20 @@ export function parseCompactSnapshotResponse(
 	);
 
 	const [snapshot, durationSnapshotTree] = measure(() => readSnapshotSection(records.snapshot));
-	const [blobs, durationBlobs] = measure(() => readBlobSection(records.blobs));
+	const [blobContents, durationBlobs] = measure(() => readBlobSection(records.blobs));
 
 	return {
 		...snapshot,
-		...blobs,
+		...blobContents,
 		ops: records.deltas !== undefined ? readOpsSection(records.deltas) : [],
 		latestSequenceNumber: records.lsn,
+		snapshotFormatV: 1,
 		telemetryProps: {
 			...telemetryProps,
 			durationSnapshotTree,
 			durationBlobs,
 			slowTreeStructureCount: snapshot.slowTreeStructureCount,
-			slowBlobStructureCount: blobs.slowBlobStructureCount,
+			slowBlobStructureCount: blobContents.slowBlobStructureCount,
 		},
 	};
 }

package/src/compactSnapshotWriter.ts

@@ -10,8 +10,8 @@ import {
 	ISequencedDocumentMessage,
 	ISnapshotTree,
 } from "@fluidframework/protocol-definitions";
+import { ISnapshot } from "@fluidframework/driver-definitions";
 import { snapshotMinReadVersion } from "./compactSnapshotParser";
-import { ISnapshotContents } from "./odspPublicUtils";
 import { TreeBuilderSerializer } from "./WriteBufferUtils";
 import {
 	addBoolProperty,
@@ -144,7 +144,7 @@ function writeOpsSection(rootNode: NodeCore, ops: ISequencedDocumentMessage[]) {
  * @param snapshotContents - snapshot tree contents to serialize
  * @returns ReadBuffer - binary representation of the data.
  */
-export function convertToCompactSnapshot(snapshotContents: ISnapshotContents): Uint8Array {
+export function convertToCompactSnapshot(snapshotContents: ISnapshot): Uint8Array {
 	const builder = new TreeBuilderSerializer();
 	// Create the root node.
 	const rootNode = builder.addNode();
@@ -166,7 +166,7 @@ export function convertToCompactSnapshot(snapshotContents: ISnapshotContents): U
 	writeSnapshotSection(rootNode, snapshotContents.snapshotTree, snapshotContents.sequenceNumber);
 
 	// Add Blobs
-	writeBlobsSection(rootNode, snapshotContents.blobs);
+	writeBlobsSection(rootNode, snapshotContents.blobContents);
 
 	// Then write the ops node.
 	writeOpsSection(rootNode, snapshotContents.ops);

package/src/contracts.ts

@@ -5,6 +5,7 @@
 
 import * as api from "@fluidframework/protocol-definitions";
 import { HostStoragePolicy } from "@fluidframework/odsp-driver-definitions";
+import { ISnapshot } from "@fluidframework/driver-definitions";
 import { ISnapshotContents } from "./odspPublicUtils";
 
 /**
@@ -165,6 +166,8 @@ export interface IOdspSnapshot {
  */
 export interface HostStoragePolicyInternal extends HostStoragePolicy {
 	summarizerClient?: boolean;
+
+	supportGetSnapshotApi?: boolean;
 }
 
 export interface ICreateFileResponse {
@@ -207,7 +210,21 @@ export interface IFlushOpsResponse {
 
 /**
  * Represents the cached snapshot value.
+ * @deprecated - This will be replaced with ISnapshotCachedEntry2 which wraps the new ISnapshot interface.
+ * For now, to support back compat from cache, we need to keep it for now.
  */
 export interface ISnapshotCachedEntry extends ISnapshotContents {
 	cacheEntryTime: number;
 }
+
+/**
+ * Represents the cached snapshot value.
+ */
+export interface ISnapshotCachedEntry2 extends ISnapshot {
+	cacheEntryTime: number;
+}
+
+/**
+ * Represents the type of signal containing the sensitivity policy labels for the container.
+ */
+export const policyLabelsUpdatesSignalType = "PolicyLabelsUpdate";

package/src/createFile.ts

@@ -10,13 +10,11 @@ import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry
 import {
 	InstrumentedStorageTokenFetcher,
 	IOdspResolvedUrl,
-	OdspErrorType,
+	OdspErrorTypes,
 	ShareLinkInfoType,
-	ISharingLinkKind,
-	ShareLinkTypes,
 	IFileEntry,
 } from "@fluidframework/odsp-driver-definitions";
-import { DriverErrorType } from "@fluidframework/driver-definitions";
+import { ISnapshot } from "@fluidframework/driver-definitions";
 import { ICreateFileResponse } from "./contracts";
 import { getUrlAndHeadersWithAuth } from "./getUrlAndHeadersWithAuth";
 import {
@@ -26,7 +24,6 @@ import {
 	INewFileInfo,
 	getOrigin,
 } from "./odspUtils";
-import { ISnapshotContents } from "./odspPublicUtils";
 import { createOdspUrl } from "./createOdspUrl";
 import { getApiRoot } from "./odspUrlHelper";
 import { EpochTracker } from "./epochTracker";
@@ -60,14 +57,13 @@ export async function createNewFluidFile(
 	forceAccessTokenViaAuthorizationHeader: boolean,
 	isClpCompliantApp?: boolean,
 	enableSingleRequestForShareLinkWithCreate?: boolean,
-	enableShareLinkWithCreate?: boolean,
 ): Promise<IOdspResolvedUrl> {
 	// Check for valid filename before the request to create file is actually made.
 	if (isInvalidFileName(newFileInfo.filename)) {
 		throw new NonRetryableError(
 			// pre-0.58 error message: Invalid filename
 			"Invalid filename for createNew",
-			OdspErrorType.invalidFileNameError,
+			OdspErrorTypes.invalidFileNameError,
 			{ driverVersion },
 		);
 	}
@@ -95,12 +91,7 @@ export async function createNewFluidFile(
 		itemId = content.itemId;
 		summaryHandle = content.id;
 
-		shareLinkInfo = extractShareLinkData(
-			newFileInfo.createLinkType,
-			content,
-			enableSingleRequestForShareLinkWithCreate,
-			enableShareLinkWithCreate,
-		);
+		shareLinkInfo = extractShareLinkData(content, enableSingleRequestForShareLinkWithCreate);
 	}
 
 	const odspUrl = createOdspUrl({ ...newFileInfo, itemId, dataStorePath: "/" });
@@ -117,7 +108,7 @@ export async function createNewFluidFile(
 	if (createNewSummary !== undefined && createNewCaching) {
 		assert(summaryHandle !== undefined, 0x203 /* "Summary handle is undefined" */);
 		// converting summary and getting sequence number
-		const snapshot: ISnapshotContents = convertCreateNewSummaryTreeToTreeAndBlobs(
+		const snapshot: ISnapshot = convertCreateNewSummaryTreeToTreeAndBlobs(
 			createNewSummary,
 			summaryHandle,
 		);
@@ -128,9 +119,9 @@ export async function createNewFluidFile(
 }
 
 /**
- * If user requested creation of a sharing link along with the creation of the file by providing either
- * createLinkType (now deprecated) or createLinkScope in the request parameters, extract and save
- * sharing link information from the response if it is available.
+ * If user requested creation of a sharing link along with the creation of the file by providing
+ * createLinkScope in the request parameters then extract and save the sharing link information from
+ * the response if it is available.
  * In case there was an error in creation of the sharing link, error is provided back in the response,
  * and does not impact the creation of file in ODSP.
  * @param requestedSharingLinkKind - Kind of sharing link requested to be created along with the creation of file.
@@ -138,14 +129,9 @@ export async function createNewFluidFile(
  * @returns Sharing link information received in the response from a successful creation of a file.
  */
 function extractShareLinkData(
-	requestedSharingLinkKind: ShareLinkTypes | ISharingLinkKind | undefined,
 	response: ICreateFileResponse,
 	enableSingleRequestForShareLinkWithCreate?: boolean,
-	enableShareLinkWithCreate?: boolean,
 ): ShareLinkInfoType | undefined {
-	if (!requestedSharingLinkKind) {
-		return;
-	}
 	let shareLinkInfo: ShareLinkInfoType | undefined;
 	if (enableSingleRequestForShareLinkWithCreate) {
 		const { sharing } = response;
@@ -154,7 +140,6 @@ function extractShareLinkData(
 		}
 		shareLinkInfo = {
 			createLink: {
-				type: requestedSharingLinkKind,
 				link: sharing.sharingLink
 					? {
 							scope: sharing.sharingLink.scope,
@@ -167,19 +152,6 @@ function extractShareLinkData(
 				shareId: sharing.shareId,
 			},
 		};
-	} else if (enableShareLinkWithCreate) {
-		const { sharing, sharingLink, sharingLinkErrorReason } = response;
-		if (!sharingLink && !sharingLinkErrorReason) {
-			return;
-		}
-		shareLinkInfo = {
-			createLink: {
-				type: requestedSharingLinkKind,
-				link: sharingLink,
-				error: sharingLinkErrorReason,
-				shareId: sharing?.shareId,
-			},
-		};
 	}
 	return shareLinkInfo;
 }
@@ -232,7 +204,7 @@ export async function createNewEmptyFluidFile(
 					throw new NonRetryableError(
 						// pre-0.58 error message: ODSP CreateFile call returned no item ID
 						"ODSP CreateFile call returned no item ID (for empty file)",
-						DriverErrorType.incorrectServerResponse,
+						OdspErrorTypes.incorrectServerResponse,
 						{ driverVersion },
 					);
 				}
@@ -283,7 +255,7 @@ export async function createNewFluidFileFromSummary(
 			if (!content?.itemId) {
 				throw new NonRetryableError(
 					"ODSP CreateFile call returned no item ID",
-					DriverErrorType.incorrectServerResponse,
+					OdspErrorTypes.incorrectServerResponse,
 					{ driverVersion },
 				);
 			}

package/src/createNewContainerOnExistingFile.ts

@@ -6,6 +6,7 @@
 import { ISummaryTree } from "@fluidframework/protocol-definitions";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { UsageError } from "@fluidframework/driver-utils";
+import { ISnapshot } from "@fluidframework/driver-definitions";
 import {
 	IFileEntry,
 	InstrumentedStorageTokenFetcher,
@@ -13,7 +14,6 @@ import {
 } from "@fluidframework/odsp-driver-definitions";
 import { IWriteSummaryResponse } from "./contracts";
 import { createCacheSnapshotKey, getOrigin, IExistingFileInfo } from "./odspUtils";
-import { ISnapshotContents } from "./odspPublicUtils";
 import { createOdspUrl } from "./createOdspUrl";
 import { getApiRoot } from "./odspUrlHelper";
 import { EpochTracker } from "./epochTracker";
@@ -81,7 +81,7 @@ export async function createNewContainerOnExistingFile(
 
 	if (createNewCaching) {
 		// converting summary and getting sequence number
-		const snapshot: ISnapshotContents = convertCreateNewSummaryTreeToTreeAndBlobs(
+		const snapshot: ISnapshot = convertCreateNewSummaryTreeToTreeAndBlobs(
 			createNewSummary,
 			summaryHandle,
 		);

package/src/createNewUtils.ts

@@ -19,6 +19,7 @@ import { unreachableCase } from "@fluidframework/core-utils";
 import { getGitType } from "@fluidframework/protocol-base";
 import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { InstrumentedStorageTokenFetcher } from "@fluidframework/odsp-driver-definitions";
+import { ISnapshot } from "@fluidframework/driver-definitions";
 import {
 	IOdspSummaryPayload,
 	IOdspSummaryTree,
@@ -26,7 +27,6 @@ import {
 	OdspSummaryTreeValue,
 } from "./contracts";
 import { getWithRetryForTokenRefresh, maxUmpPostBodySize } from "./odspUtils";
-import { ISnapshotContents } from "./odspPublicUtils";
 import { EpochTracker, FetchType } from "./epochTracker";
 import { getUrlAndHeadersWithAuth } from "./getUrlAndHeadersWithAuth";
 import { runWithRetry } from "./retryUtils";
@@ -37,19 +37,20 @@ import { runWithRetry } from "./retryUtils";
 export function convertCreateNewSummaryTreeToTreeAndBlobs(
 	summary: ISummaryTree,
 	treeId: string,
-): ISnapshotContents {
+): ISnapshot {
 	const protocolSummary = summary.tree[".protocol"] as ISummaryTree;
 	const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);
 	const sequenceNumber = documentAttributes.sequenceNumber;
-	const blobs = new Map<string, ArrayBuffer>();
-	const snapshotTree = convertCreateNewSummaryTreeToTreeAndBlobsCore(summary, blobs);
+	const blobContents = new Map<string, ArrayBuffer>();
+	const snapshotTree = convertCreateNewSummaryTreeToTreeAndBlobsCore(summary, blobContents);
 	snapshotTree.id = treeId;
-	const snapshotTreeValue: ISnapshotContents = {
+	const snapshotTreeValue: ISnapshot = {
 		snapshotTree,
-		blobs,
+		blobContents,
 		ops: [],
 		sequenceNumber,
 		latestSequenceNumber: sequenceNumber,
+		snapshotFormatV: 1,
 	};
 
 	return snapshotTreeValue;

package/src/createOdspCreateContainerRequest.ts

@@ -4,7 +4,7 @@
  */
 import { IRequest } from "@fluidframework/core-interfaces";
 import { DriverHeader } from "@fluidframework/driver-definitions";
-import { ShareLinkTypes, ISharingLinkKind } from "@fluidframework/odsp-driver-definitions";
+import { ISharingLinkKind } from "@fluidframework/odsp-driver-definitions";
 import { buildOdspShareLinkReqParams } from "./odspUtils";
 
 /**
@@ -22,7 +22,7 @@ export function createOdspCreateContainerRequest(
 	driveId: string,
 	filePath: string,
 	fileName: string,
-	createShareLinkType?: ShareLinkTypes | ISharingLinkKind,
+	createShareLinkType?: ISharingLinkKind,
 ): IRequest {
 	const shareLinkRequestParams = buildOdspShareLinkReqParams(createShareLinkType);
 	const createNewRequest: IRequest = {

package/src/epochTracker.ts

@@ -20,6 +20,7 @@ import {
 	LocationRedirectionError,
 } from "@fluidframework/driver-utils";
 import {
+	OdspErrorTypes,
 	snapshotKey,
 	ICacheEntry,
 	IEntry,
@@ -29,7 +30,6 @@ import {
 	IOdspErrorAugmentations,
 	IOdspResolvedUrl,
 } from "@fluidframework/odsp-driver-definitions";
-import { DriverErrorType } from "@fluidframework/driver-definitions";
 import {
 	fetchAndParseAsJSONHelper,
 	fetchArray,
@@ -292,7 +292,7 @@ export class EpochTracker implements IPersistedFileCache {
 				// location info.
 				if (
 					isFluidError(error) &&
-					error.errorType === DriverErrorType.fileNotFoundOrAccessDeniedError
+					error.errorType === OdspErrorTypes.fileNotFoundOrAccessDeniedError
 				) {
 					const redirectLocation = (error as IOdspErrorAugmentations).redirectLocation;
 					if (redirectLocation !== undefined) {
@@ -436,7 +436,7 @@ export class EpochTracker implements IPersistedFileCache {
 		fetchType: FetchTypeInternal,
 		fromCache: boolean = false,
 	) {
-		if (isFluidError(error) && error.errorType === DriverErrorType.fileOverwrittenInStorage) {
+		if (isFluidError(error) && error.errorType === OdspErrorTypes.fileOverwrittenInStorage) {
 			const epochError = this.checkForEpochErrorCore(epochFromResponse);
 			if (epochError !== undefined) {
 				epochError.addTelemetryProperties({
@@ -470,7 +470,7 @@ export class EpochTracker implements IPersistedFileCache {
 			// Difference - client detected mismatch, instead of server detecting it.
 			return new NonRetryableError(
 				"Epoch mismatch",
-				DriverErrorType.fileOverwrittenInStorage,
+				OdspErrorTypes.fileOverwrittenInStorage,
 				{ driverVersion, serverEpoch: epochFromResponse, clientEpoch: this.fluidEpoch },
 			);
 		}

package/src/fetchSnapshot.ts

@@ -13,11 +13,11 @@ import {
 import { fromUtf8ToBase64 } from "@fluid-internal/client-utils";
 import { assert } from "@fluidframework/core-utils";
 import { getW3CData } from "@fluidframework/driver-base";
-import { DriverErrorType } from "@fluidframework/driver-definitions";
+import { ISnapshot } from "@fluidframework/driver-definitions";
 import {
 	IOdspResolvedUrl,
 	ISnapshotOptions,
-	OdspErrorType,
+	OdspErrorTypes,
 	InstrumentedStorageTokenFetcher,
 } from "@fluidframework/odsp-driver-definitions";
 import { ISnapshotTree } from "@fluidframework/protocol-definitions";
@@ -29,7 +29,7 @@ import {
 import { fetchIncorrectResponse, throwOdspNetworkError } from "@fluidframework/odsp-doclib-utils";
 import {
 	IOdspSnapshot,
-	ISnapshotCachedEntry,
+	ISnapshotCachedEntry2,
 	IVersionedValueWithEpoch,
 	persistedCacheValueVersion,
 } from "./contracts";
@@ -44,7 +44,6 @@ import {
 	measure,
 	measureP,
 } from "./odspUtils";
-import { ISnapshotContents } from "./odspPublicUtils";
 import { convertOdspSnapshotToSnapshotTreeAndBlobs } from "./odspSnapshotParser";
 import {
 	currentReadVersion,
@@ -86,7 +85,7 @@ export async function fetchSnapshot(
 		url: string,
 		fetchOptions: { [index: string]: any },
 	) => Promise<IOdspResponse<unknown>>,
-): Promise<ISnapshotContents> {
+): Promise<ISnapshot> {
 	const path = `/trees/${versionId}`;
 	let queryParams: ISnapshotOptions = {};
 
@@ -126,7 +125,7 @@ export async function fetchSnapshotWithRedeem(
 	putInCache: (valueWithEpoch: IVersionedValueWithEpoch) => Promise<void>,
 	removeEntries: () => Promise<void>,
 	enableRedeemFallback?: boolean,
-): Promise<ISnapshotContents> {
+): Promise<ISnapshot> {
 	// back-compat: This block to be removed with #8784 when we only consume/consider odsp resolvers that are >= 0.51
 	const sharingLinkToRedeem = (odspResolvedUrl as any).sharingLinkToRedeem;
 	if (sharingLinkToRedeem) {
@@ -191,8 +190,8 @@ export async function fetchSnapshotWithRedeem(
 			if (
 				(typeof error === "object" &&
 					error !== null &&
-					error.errorType === DriverErrorType.authorizationError) ||
-				error.errorType === DriverErrorType.fileNotFoundOrAccessDeniedError
+					error.errorType === OdspErrorTypes.authorizationError) ||
+				error.errorType === OdspErrorTypes.fileNotFoundOrAccessDeniedError
 			) {
 				await removeEntries();
 			}
@@ -249,7 +248,7 @@ async function fetchLatestSnapshotCore(
 	) => Promise<ISnapshotRequestAndResponseOptions>,
 	putInCache: (valueWithEpoch: IVersionedValueWithEpoch) => Promise<void>,
 	enableRedeemFallback?: boolean,
-): Promise<ISnapshotContents> {
+): Promise<ISnapshot> {
 	return getWithRetryForTokenRefresh(async (tokenFetchOptions) => {
 		const storageToken = await storageTokenFetcher(tokenFetchOptions, "TreesLatest", true);
 		assert(storageToken !== null, 0x1e5 /* "Storage token should not be null" */);
@@ -328,7 +327,7 @@ async function fetchLatestSnapshotCore(
 						let content: IOdspSnapshot;
 						[content, parseTime] = measure(() => JSON.parse(text) as IOdspSnapshot);
 						validateBlobsAndTrees(content);
-						const snapshotContents: ISnapshotContents =
+						const snapshotContents: ISnapshot =
 							convertOdspSnapshotToSnapshotTreeAndBlobs(content);
 						parsedSnapshotContents = {
 							...odspResponse,
@@ -365,7 +364,7 @@ async function fetchLatestSnapshotCore(
 						) {
 							throw new NonRetryableError(
 								"Returned odsp snapshot is malformed. No trees or blobs!",
-								DriverErrorType.incorrectServerResponse,
+								OdspErrorTypes.incorrectServerResponse,
 								propsToLog,
 							);
 						}
@@ -386,7 +385,7 @@ async function fetchLatestSnapshotCore(
 					default:
 						throw new NonRetryableError(
 							"Unknown snapshot content type",
-							DriverErrorType.incorrectServerResponse,
+							OdspErrorTypes.incorrectServerResponse,
 							propsToLog,
 						);
 				}
@@ -400,7 +399,7 @@ async function fetchLatestSnapshotCore(
 					(errorMessage) =>
 						new NonRetryableError(
 							`Error parsing snapshot response: ${errorMessage}`,
-							DriverErrorType.genericError,
+							OdspErrorTypes.genericError,
 							propsToLog,
 						),
 				);
@@ -437,7 +436,7 @@ async function fetchLatestSnapshotCore(
 					fluidEpoch !== undefined,
 					0x1e6 /* "Epoch  should be present in response" */,
 				);
-				const value: ISnapshotCachedEntry = {
+				const value: ISnapshotCachedEntry2 = {
 					...snapshot,
 					cacheEntryTime: Date.now(),
 				};
@@ -452,7 +451,7 @@ async function fetchLatestSnapshotCore(
 
 			event.end({
 				trees,
-				blobs: snapshot.blobs?.size ?? 0,
+				blobs: snapshot.blobContents?.size ?? 0,
 				leafNodes: numBlobs,
 				encodedBlobsSize,
 				sequenceNumber,
@@ -490,8 +489,8 @@ async function fetchLatestSnapshotCore(
 			if (
 				typeof error === "object" &&
 				error !== null &&
-				(error.errorType === DriverErrorType.fetchFailure ||
-					error.errorType === OdspErrorType.fetchTimeout)
+				(error.errorType === OdspErrorTypes.fetchFailure ||
+					error.errorType === OdspErrorTypes.fetchTimeout)
 			) {
 				error[getWithRetryForTokenRefreshRepeat] = true;
 			}
@@ -536,11 +535,11 @@ function getFormBodyAndHeaders(
 	return { body: postBody, headers: header };
 }
 
-export function evalBlobsAndTrees(snapshot: ISnapshotContents) {
+export function evalBlobsAndTrees(snapshot: ISnapshot) {
 	const trees = countTreesInSnapshotTree(snapshot.snapshotTree);
-	const numBlobs = snapshot.blobs.size;
+	const numBlobs = snapshot.blobContents.size;
 	let encodedBlobsSize = 0;
-	for (const [_, blobContent] of snapshot.blobs) {
+	for (const [_, blobContent] of snapshot.blobContents) {
 		encodedBlobsSize += blobContent.byteLength;
 	}
 	return { trees, numBlobs, encodedBlobsSize };
@@ -649,8 +648,8 @@ function isRedeemSharingLinkError(odspResolvedUrl: IOdspResolvedUrl, error: any)
 		odspResolvedUrl.shareLinkInfo?.sharingLinkToRedeem !== undefined &&
 		typeof error === "object" &&
 		error !== null &&
-		(error.errorType === DriverErrorType.authorizationError ||
-			error.errorType === DriverErrorType.fileNotFoundOrAccessDeniedError)
+		(error.errorType === OdspErrorTypes.authorizationError ||
+			error.errorType === OdspErrorTypes.fileNotFoundOrAccessDeniedError)
 	) {
 		return true;
 	}

package/src/getFileLink.ts

@@ -6,9 +6,9 @@
 import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { assert } from "@fluidframework/core-utils";
 import { NonRetryableError, runWithRetry } from "@fluidframework/driver-utils";
-import { DriverErrorType } from "@fluidframework/driver-definitions";
 import {
 	IOdspUrlParts,
+	OdspErrorTypes,
 	OdspResourceTokenFetchOptions,
 	TokenFetcher,
 } from "@fluidframework/odsp-driver-definitions";
@@ -150,7 +150,7 @@ async function getFileLinkCore(
 					// This will retry once in getWithRetryForTokenRefresh
 					throw new NonRetryableError(
 						"Malformed GetSharingInformation response",
-						DriverErrorType.incorrectServerResponse,
+						OdspErrorTypes.incorrectServerResponse,
 						{ driverVersion },
 					);
 				}
@@ -229,7 +229,7 @@ async function getFileItemLite(
 					// This will retry once in getWithRetryForTokenRefresh
 					throw new NonRetryableError(
 						"Malformed getFileItemLite response",
-						DriverErrorType.incorrectServerResponse,
+						OdspErrorTypes.incorrectServerResponse,
 						{ driverVersion },
 					);
 				}

package/src/localOdspDriver/localOdspDocumentService.ts

@@ -3,10 +3,12 @@
  * Licensed under the MIT License.
  */
 
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import {
 	IDocumentDeltaStorageService,
 	IDocumentService,
+	IDocumentServiceEvents,
 	IDocumentStorageService,
 	IResolvedUrl,
 } from "@fluidframework/driver-definitions";
@@ -19,7 +21,10 @@ import { LocalOdspDocumentStorageService } from "./localOdspDocumentStorageManag
 /**
  * IDocumentService implementation that provides explicit snapshot to the document storage service.
  */
-export class LocalOdspDocumentService implements IDocumentService {
+export class LocalOdspDocumentService
+	extends TypedEventEmitter<IDocumentServiceEvents>
+	implements IDocumentService
+{
 	public policies = { storageOnly: true };
 	private storageManager?: LocalOdspDocumentStorageService;
 
@@ -27,7 +32,9 @@ export class LocalOdspDocumentService implements IDocumentService {
 		private readonly odspResolvedUrl: IOdspResolvedUrl,
 		private readonly logger: ITelemetryLoggerExt,
 		private readonly localSnapshot: Uint8Array | string,
-	) {}
+	) {
+		super();
+	}
 
 	public get resolvedUrl(): IResolvedUrl {
 		return this.odspResolvedUrl;

package/src/localOdspDriver/localOdspDocumentStorageManager.ts

@@ -5,11 +5,14 @@
 
 import { assert } from "@fluidframework/core-utils";
 import { ITelemetryLoggerExt, loggerToMonitoringContext } from "@fluidframework/telemetry-utils";
-import { ISummaryContext } from "@fluidframework/driver-definitions";
+import {
+	ISnapshot,
+	ISnapshotFetchOptions,
+	ISummaryContext,
+} from "@fluidframework/driver-definitions";
 import { UsageError } from "@fluidframework/driver-utils";
 import * as api from "@fluidframework/protocol-definitions";
 import { OdspDocumentStorageServiceBase } from "../odspDocumentStorageServiceBase";
-import { ISnapshotContents } from "../odspPublicUtils";
 import { IOdspSnapshot } from "../contracts";
 import { convertOdspSnapshotToSnapshotTreeAndBlobs } from "../odspSnapshotParser";
 import { parseCompactSnapshotResponse } from "../compactSnapshotParser";
@@ -45,7 +48,7 @@ export class LocalOdspDocumentStorageService extends OdspDocumentStorageServiceB
 		}
 		this.calledGetVersions = true;
 
-		let snapshotContents: ISnapshotContents;
+		let snapshotContents: ISnapshot;
 
 		if (typeof this.localSnapshot === "string") {
 			const content: IOdspSnapshot = JSON.parse(this.localSnapshot);
@@ -58,6 +61,10 @@ export class LocalOdspDocumentStorageService extends OdspDocumentStorageServiceB
 		return this.getSnapshotVersion();
 	}
 
+	public async getSnapshot(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot> {
+		this.throwUsageError("getSnapshot");
+	}
+
 	private getSnapshotVersion(): api.IVersion[] {
 		return this.snapshotTreeId ? [{ id: this.snapshotTreeId, treeId: undefined! }] : [];
 	}

package/src/odspCache.ts

@@ -12,7 +12,7 @@ import {
 	ISocketStorageDiscovery,
 	getKeyForCacheEntry,
 } from "@fluidframework/odsp-driver-definitions";
-import { ISnapshotContents } from "./odspPublicUtils";
+import { ISnapshot } from "@fluidframework/driver-definitions";
 
 /**
  * Similar to IPersistedCache, but exposes cache interface for single file
@@ -142,7 +142,7 @@ export class NonPersistentCache implements INonPersistentCache {
 /**
  * @alpha
  */
-export interface IPrefetchSnapshotContents extends ISnapshotContents {
+export interface IPrefetchSnapshotContents extends ISnapshot {
 	fluidEpoch: string;
 	prefetchStartTime: number;
 }