@fluidframework/driver-definitions 2.0.0-rc.1.0.4 → 2.0.0-rc.2.0.0

package/.eslintrc.cjs

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/strict"), "prettier"],
+	rules: {
+		// TODO: Enabling this may require breaking changes.
+		"@typescript-eslint/consistent-indexed-object-style": "off",
+	},
+};

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @fluidframework/driver-definitions
 
+## 2.0.0-rc.2.0.0
+
+### Minor Changes
+
+-   driver-definitions: Deprecate `ISnapshotContents` ([#19314](https://github.com/microsoft/FluidFramework/issues/19314)) [fc731b69de](https://github.com/microsoft/FluidFramework/commits/fc731b69deed4a2987e9b97d8918492d689bafbc)
+
+    `ISnapshotContents` is deprecated. It has been replaced with `ISnapshot`.
+
+-   driver-definitions: repositoryUrl removed from IDocumentStorageService ([#19522](https://github.com/microsoft/FluidFramework/issues/19522)) [90eb3c9d33](https://github.com/microsoft/FluidFramework/commits/90eb3c9d33d80e24caa1393a50f414c5602f6aa3)
+
+    The `repositoryUrl` member of `IDocumentStorageService` was unused and always equal to the empty string. It has been removed.
+
+-   Deprecated error-related enums have been removed ([#19067](https://github.com/microsoft/FluidFramework/issues/19067)) [59793302e5](https://github.com/microsoft/FluidFramework/commits/59793302e56784cfb6ace0e6469345f3565b3312)
+
+    Error-related enums `ContainerErrorType`, `DriverErrorType`, `OdspErrorType` and `RouterliciousErrorType` were previously
+    deprecated and are now removed. There are replacement object-based enumerations of `ContainerErrorTypes`,
+    `DriverErrorTypes`, `OdspErrorTypes` and `RouterliciousErrorTypes`. Refer to the release notes of [Fluid Framework version
+    2.0.0-internal.7.0.0](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.0.0-internal.7.0.0) for details
+    on the replacements.
+
+-   container-definitions: Added containerMetadata prop on IContainer interface ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
+
+    Added `containerMetadata` prop on IContainer interface.
+
+-   runtime-definitions: Moved ISignalEnvelope interface to core-interfaces ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
+
+    The `ISignalEnvelope` interface has been moved to the @fluidframework/core-interfaces package.
+
 ## 2.0.0-rc.1.0.0
 
 ### Minor Changes

package/{api-extractor-esm.json → api-extractor-cjs.json}

@@ -1,4 +1,8 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base-esm.json"
+	"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
+	// CJS is actually secondary; so, no report.
+	"apiReport": {
+		"enabled": false
+	}
 }

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.json"
+	"extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json"
 }

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

@@ -4,52 +4,30 @@
 
 ```ts
 
-import { ConnectionMode } from '@fluidframework/protocol-definitions';
-import { IClient } from '@fluidframework/protocol-definitions';
-import { IClientConfiguration } from '@fluidframework/protocol-definitions';
-import { ICreateBlobResponse } from '@fluidframework/protocol-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { IErrorEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { INack } from '@fluidframework/protocol-definitions';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISignalClient } from '@fluidframework/protocol-definitions';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISummaryHandle } from '@fluidframework/protocol-definitions';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import { IVersion } from '@fluidframework/protocol-definitions';
+import type { ConnectionMode } from '@fluidframework/protocol-definitions';
+import type { IClient } from '@fluidframework/protocol-definitions';
+import type { IClientConfiguration } from '@fluidframework/protocol-definitions';
+import type { ICreateBlobResponse } from '@fluidframework/protocol-definitions';
+import type { IDisposable } from '@fluidframework/core-interfaces';
+import type { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { IErrorEvent } from '@fluidframework/core-interfaces';
+import type { IEvent } from '@fluidframework/core-interfaces';
+import type { IEventProvider } from '@fluidframework/core-interfaces';
+import type { INack } from '@fluidframework/protocol-definitions';
+import type { IRequest } from '@fluidframework/core-interfaces';
+import type { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { ISignalClient } from '@fluidframework/protocol-definitions';
+import type { ISignalMessage } from '@fluidframework/protocol-definitions';
+import type { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import type { ISummaryHandle } from '@fluidframework/protocol-definitions';
+import type { ISummaryTree } from '@fluidframework/protocol-definitions';
+import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import type { ITokenClaims } from '@fluidframework/protocol-definitions';
+import type { IVersion } from '@fluidframework/protocol-definitions';
 
 // @alpha (undocumented)
 export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
 
-// @public @deprecated
-export enum DriverErrorType {
-    authorizationError = "authorizationError",
-    deltaStreamConnectionForbidden = "deltaStreamConnectionForbidden",
-    fetchFailure = "fetchFailure",
-    fetchTokenError = "fetchTokenError",
-    fileIsLocked = "fileIsLocked",
-    fileNotFoundOrAccessDeniedError = "fileNotFoundOrAccessDeniedError",
-    fileOverwrittenInStorage = "fileOverwrittenInStorage",
-    fluidInvalidSchema = "fluidInvalidSchema",
-    genericError = "genericError",
-    genericNetworkError = "genericNetworkError",
-    incorrectServerResponse = "incorrectServerResponse",
-    locationRedirection = "locationRedirection",
-    offlineError = "offlineError",
-    outOfStorageError = "outOfStorageError",
-    throttlingError = "throttlingError",
-    // (undocumented)
-    unsupportedClientProtocolVersion = "unsupportedClientProtocolVersion",
-    usageError = "usageError",
-    writeError = "writeError"
-}
-
 // @public
 export const DriverErrorTypes: {
     readonly genericNetworkError: "genericNetworkError";
@@ -72,7 +50,7 @@ export const DriverErrorTypes: {
     readonly usageError: "usageError";
 };
 
-// @public (undocumented)
+// @public
 export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
 
 // @alpha
@@ -111,7 +89,7 @@ export interface IAuthorizationError extends IDriverErrorBase {
     // (undocumented)
     readonly claims?: string;
     // (undocumented)
-    readonly errorType: DriverErrorType.authorizationError;
+    readonly errorType: typeof DriverErrorTypes.authorizationError;
     // (undocumented)
     readonly tenantId?: string;
 }
@@ -173,7 +151,7 @@ export interface IDocumentDeltaStorageService {
 }
 
 // @alpha (undocumented)
-export interface IDocumentService {
+export interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {
     connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
     connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
     connectToStorage(): Promise<IDocumentStorageService>;
@@ -183,6 +161,11 @@ export interface IDocumentService {
     resolvedUrl: IResolvedUrl;
 }
 
+// @alpha
+export interface IDocumentServiceEvents extends IEvent {
+    (event: "metadataUpdate", listener: (metadata: Record<string, string>) => void): any;
+}
+
 // @alpha (undocumented)
 export interface IDocumentServiceFactory {
     createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
@@ -193,18 +176,18 @@ export interface IDocumentServiceFactory {
 export interface IDocumentServicePolicies {
     readonly storageOnly?: boolean;
     readonly summarizeProtocolTree?: boolean;
+    readonly supportGetSnapshotApi?: boolean;
 }
 
 // @alpha
 export interface IDocumentStorageService extends Partial<IDisposable> {
     createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
     downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
+    getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
     getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
     getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
     readonly policies?: IDocumentStorageServicePolicies;
     readBlob(id: string): Promise<ArrayBufferLike>;
-    // (undocumented)
-    repositoryUrl: string;
     uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
 }
 
@@ -217,7 +200,7 @@ export interface IDocumentStorageServicePolicies {
 // @alpha
 export interface IDriverBasicError extends IDriverErrorBase {
     // (undocumented)
-    readonly errorType: DriverErrorType.genericError | DriverErrorType.fileNotFoundOrAccessDeniedError | DriverErrorType.offlineError | DriverErrorType.unsupportedClientProtocolVersion | DriverErrorType.writeError | DriverErrorType.fetchFailure | DriverErrorType.fetchTokenError | DriverErrorType.incorrectServerResponse | DriverErrorType.fileOverwrittenInStorage | DriverErrorType.fluidInvalidSchema | DriverErrorType.usageError | DriverErrorType.fileIsLocked | DriverErrorType.outOfStorageError;
+    readonly errorType: typeof DriverErrorTypes.genericError | typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError | typeof DriverErrorTypes.offlineError | typeof DriverErrorTypes.unsupportedClientProtocolVersion | typeof DriverErrorTypes.writeError | typeof DriverErrorTypes.fetchFailure | typeof DriverErrorTypes.fetchTokenError | typeof DriverErrorTypes.incorrectServerResponse | typeof DriverErrorTypes.fileOverwrittenInStorage | typeof DriverErrorTypes.fluidInvalidSchema | typeof DriverErrorTypes.usageError | typeof DriverErrorTypes.fileIsLocked | typeof DriverErrorTypes.outOfStorageError;
     // (undocumented)
     readonly statusCode?: number;
 }
@@ -226,7 +209,7 @@ export interface IDriverBasicError extends IDriverErrorBase {
 export interface IDriverErrorBase {
     canRetry: boolean;
     endpointReached?: boolean;
-    readonly errorType: DriverErrorType;
+    readonly errorType: DriverErrorTypes;
     readonly message: string;
     online?: string;
 }
@@ -242,7 +225,7 @@ export interface IDriverHeader {
 // @alpha (undocumented)
 export interface IGenericNetworkError extends IDriverErrorBase {
     // (undocumented)
-    readonly errorType: DriverErrorType.genericNetworkError;
+    readonly errorType: typeof DriverErrorTypes.genericNetworkError;
     // (undocumented)
     readonly statusCode?: number;
 }
@@ -250,7 +233,7 @@ export interface IGenericNetworkError extends IDriverErrorBase {
 // @alpha (undocumented)
 export interface ILocationRedirectionError extends IDriverErrorBase {
     // (undocumented)
-    readonly errorType: DriverErrorType.locationRedirection;
+    readonly errorType: typeof DriverErrorTypes.locationRedirection;
     // (undocumented)
     readonly redirectUrl: IResolvedUrl;
 }
@@ -272,6 +255,29 @@ export interface IResolvedUrl {
     url: string;
 }
 
+// @alpha (undocumented)
+export interface ISnapshot {
+    // (undocumented)
+    blobContents: Map<string, ArrayBuffer>;
+    latestSequenceNumber: number | undefined;
+    // (undocumented)
+    ops: ISequencedDocumentMessage[];
+    sequenceNumber: number | undefined;
+    // (undocumented)
+    snapshotFormatV: 1;
+    // (undocumented)
+    snapshotTree: ISnapshotTree;
+}
+
+// @alpha
+export interface ISnapshotFetchOptions {
+    cacheSnapshot?: boolean;
+    fetchSource?: FetchSource;
+    loadingGroupIds?: string[];
+    scenarioName?: string;
+    versionId?: string;
+}
+
 // @alpha
 export interface IStream<T> {
     // (undocumented)
@@ -297,7 +303,7 @@ export interface ISummaryContext {
 // @alpha (undocumented)
 export interface IThrottlingWarning extends IDriverErrorBase {
     // (undocumented)
-    readonly errorType: DriverErrorType.throttlingError;
+    readonly errorType: typeof DriverErrorTypes.throttlingError;
     // (undocumented)
     readonly retryAfterSeconds: number;
 }

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

@@ -1,119 +1,29 @@
-import { ConnectionMode } from '@fluidframework/protocol-definitions';
-import { IClient } from '@fluidframework/protocol-definitions';
-import { IClientConfiguration } from '@fluidframework/protocol-definitions';
-import { ICreateBlobResponse } from '@fluidframework/protocol-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { IErrorEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { INack } from '@fluidframework/protocol-definitions';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISignalClient } from '@fluidframework/protocol-definitions';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISummaryHandle } from '@fluidframework/protocol-definitions';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import { IVersion } from '@fluidframework/protocol-definitions';
+import type { ConnectionMode } from '@fluidframework/protocol-definitions';
+import type { IClient } from '@fluidframework/protocol-definitions';
+import type { IClientConfiguration } from '@fluidframework/protocol-definitions';
+import type { ICreateBlobResponse } from '@fluidframework/protocol-definitions';
+import type { IDisposable } from '@fluidframework/core-interfaces';
+import type { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { IErrorEvent } from '@fluidframework/core-interfaces';
+import type { IEvent } from '@fluidframework/core-interfaces';
+import type { IEventProvider } from '@fluidframework/core-interfaces';
+import type { INack } from '@fluidframework/protocol-definitions';
+import type { IRequest } from '@fluidframework/core-interfaces';
+import type { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { ISignalClient } from '@fluidframework/protocol-definitions';
+import type { ISignalMessage } from '@fluidframework/protocol-definitions';
+import type { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import type { ISummaryHandle } from '@fluidframework/protocol-definitions';
+import type { ISummaryTree } from '@fluidframework/protocol-definitions';
+import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import type { ITokenClaims } from '@fluidframework/protocol-definitions';
+import type { IVersion } from '@fluidframework/protocol-definitions';
 
 /**
  * @alpha
  */
 export declare type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
 
-/**
- * Driver Error types
- * Lists types that are likely to be used by all drivers
- *
- * @deprecated Use {@link (DriverErrorTypes:type)} instead.
- * @public
- */
-export declare enum DriverErrorType {
-    /**
-     * A fatal error with no specific interpretation covered by other DriverErrorType values
-     */
-    genericError = "genericError",
-    /**
-     * Some non-categorized (below) networking error
-     * Include errors like  fatal server error (usually 500).
-     */
-    genericNetworkError = "genericNetworkError",
-    /**
-     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file
-     */
-    authorizationError = "authorizationError",
-    /**
-     * File not found, or file deleted during session
-     */
-    fileNotFoundOrAccessDeniedError = "fileNotFoundOrAccessDeniedError",
-    /**
-     * Throttling error from server. Server is busy and is asking not to reconnect for some time
-     */
-    throttlingError = "throttlingError",
-    /**
-     * We can not reach server due to computer being offline.
-     */
-    offlineError = "offlineError",
-    unsupportedClientProtocolVersion = "unsupportedClientProtocolVersion",
-    /**
-     * User does not have write permissions to a file, but is changing content of a file.
-     * That might be indication of some data store error - data stores should not generate ops in readonly mode.
-     */
-    writeError = "writeError",
-    /**
-     * A generic fetch failure that indicates we were not able to get a response from the server.
-     * This may be due to the client being offline (though, if we are able to detect offline state it will be
-     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,
-     * CSP violation, etc.
-     */
-    fetchFailure = "fetchFailure",
-    /**
-     * This error occurs when token provider fails to fetch orderer token
-     */
-    fetchTokenError = "fetchTokenError",
-    /**
-     * Unexpected response from server. Either JSON is malformed, or some required properties are missing
-     */
-    incorrectServerResponse = "incorrectServerResponse",
-    /**
-     * This error occurs when the file is modified externally (not through Fluid protocol) in storage.
-     * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,
-     * and storage / driver / loader detects such mismatch.
-     * When it's hit, client needs to forget all the knowledge about this file and start over.
-     */
-    fileOverwrittenInStorage = "fileOverwrittenInStorage",
-    /**
-     * The document is read-only and delta stream connection is forbidden.
-     */
-    deltaStreamConnectionForbidden = "deltaStreamConnectionForbidden",
-    /**
-     * The location of file/container can change on server. So if the file location moves and we try to access the old
-     * location, then this error is thrown to let the client know about the new location info.
-     */
-    locationRedirection = "locationRedirection",
-    /**
-     * When a file is not a Fluid file, but has Fluid extension such as ".note",
-     * server won't be able to open it and will return this error. The innerMostErrorCode will be
-     * "fluidInvalidSchema"
-     */
-    fluidInvalidSchema = "fluidInvalidSchema",
-    /**
-     * Error indicating an API is being used improperly resulting in an invalid operation.
-     * ! Should match the value of ContainerErrorType.usageError
-     */
-    usageError = "usageError",
-    /**
-     * File is locked for read/write by storage, e.g. whole collection is locked and access denied.
-     */
-    fileIsLocked = "fileIsLocked",
-    /**
-     * Storage is out of space
-     */
-    outOfStorageError = "outOfStorageError"
-}
-
 /**
  * Different error types the Driver may report out to the Host.
  * @public
@@ -193,6 +103,7 @@ export declare const DriverErrorTypes: {
 };
 
 /**
+ * {@inheritDoc (DriverErrorTypes:variable)}
  * @public
  */
 export declare type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
@@ -238,11 +149,13 @@ export declare type FiveDaysMs = 432000000;
 
 /**
  * Interface describing errors and warnings raised by any driver code.
+ *
+ * @remarks
  * Not expected to be implemented by a class or an object literal, but rather used in place of
  * any or unknown in various function signatures that pass errors around.
  *
  * "Any" in the interface name is a nod to the fact that errorType has lost its type constraint.
- * It will be either DriverErrorType or the specific driver's specialized error type enum,
+ * It will be either {@link @fluidframework/driver-definitions#(DriverErrorTypes:variable)} or the specific driver's specialized error type enum,
  * but we can't reference a specific driver's error type enum in this code.
  * @public
  */
@@ -254,7 +167,7 @@ export declare interface IAnyDriverError extends Omit<IDriverErrorBase, "errorTy
  * @alpha
  */
 export declare interface IAuthorizationError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.authorizationError;
+    readonly errorType: typeof DriverErrorTypes.authorizationError;
     readonly claims?: string;
     readonly tenantId?: string;
 }
@@ -372,7 +285,7 @@ export declare interface IDocumentDeltaStorageService {
 /**
  * @alpha
  */
-export declare interface IDocumentService {
+export declare interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {
     resolvedUrl: IResolvedUrl;
     /**
      * Policies implemented/instructed by driver.
@@ -403,6 +316,18 @@ export declare interface IDocumentService {
     dispose(error?: any): void;
 }
 
+/**
+ * Events emitted by {@link IDocumentService}.
+ * @alpha
+ */
+export declare interface IDocumentServiceEvents extends IEvent {
+    /**
+     * This event is used to communicate any metadata related to the container. We might have received metadata from the service.
+     * Read more info on this event from here `IContainer.containerMetadata`.
+     */
+    (event: "metadataUpdate", listener: (metadata: Record<string, string>) => void): any;
+}
+
 /**
  * @alpha
  */
@@ -445,6 +370,12 @@ export declare interface IDocumentServicePolicies {
      * Summarizer uploads the protocol tree too when summarizing.
      */
     readonly summarizeProtocolTree?: boolean;
+    /**
+     * Whether the driver supports the new getSnapshot api which returns snapshot which
+     * contains all contents along with the snapshot tree. Enable this by default when the
+     * driver can fully support the api.
+     */
+    readonly supportGetSnapshotApi?: boolean;
 }
 
 /**
@@ -452,7 +383,6 @@ export declare interface IDocumentServicePolicies {
  * @alpha
  */
 export declare interface IDocumentStorageService extends Partial<IDisposable> {
-    repositoryUrl: string;
     /**
      * Policies implemented/instructed by driver.
      */
@@ -464,6 +394,13 @@ export declare interface IDocumentStorageService extends Partial<IDisposable> {
      * in debugging purposes to see why this call was made.
      */
     getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
+    /**
+     * Returns the snapshot which can contain other artifacts too like blob contents, ops etc. It is different from
+     * `getSnapshotTree` api in that, that API only returns the snapshot tree from the snapshot.
+     * @param snapshotFetchOptions - Options specified by the caller to specify and want certain behavior from the
+     * driver when fetching the snapshot.
+     */
+    getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
     /**
      * Retrieves all versions of the document starting at the specified versionId - or null if from the head
      * @param versionId - Version id of the requested version.
@@ -525,7 +462,7 @@ export declare interface IDocumentStorageServicePolicies {
  * @alpha
  */
 export declare interface IDriverBasicError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.genericError | DriverErrorType.fileNotFoundOrAccessDeniedError | DriverErrorType.offlineError | DriverErrorType.unsupportedClientProtocolVersion | DriverErrorType.writeError | DriverErrorType.fetchFailure | DriverErrorType.fetchTokenError | DriverErrorType.incorrectServerResponse | DriverErrorType.fileOverwrittenInStorage | DriverErrorType.fluidInvalidSchema | DriverErrorType.usageError | DriverErrorType.fileIsLocked | DriverErrorType.outOfStorageError;
+    readonly errorType: typeof DriverErrorTypes.genericError | typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError | typeof DriverErrorTypes.offlineError | typeof DriverErrorTypes.unsupportedClientProtocolVersion | typeof DriverErrorTypes.writeError | typeof DriverErrorTypes.fetchFailure | typeof DriverErrorTypes.fetchTokenError | typeof DriverErrorTypes.incorrectServerResponse | typeof DriverErrorTypes.fileOverwrittenInStorage | typeof DriverErrorTypes.fluidInvalidSchema | typeof DriverErrorTypes.usageError | typeof DriverErrorTypes.fileIsLocked | typeof DriverErrorTypes.outOfStorageError;
     readonly statusCode?: number;
 }
 
@@ -539,7 +476,7 @@ export declare interface IDriverErrorBase {
      *
      * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).
      */
-    readonly errorType: DriverErrorType;
+    readonly errorType: DriverErrorTypes;
     /**
      * Free-form error message
      */
@@ -565,7 +502,7 @@ export declare interface IDriverErrorBase {
  * @alpha
  */
 export declare interface IGenericNetworkError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.genericNetworkError;
+    readonly errorType: typeof DriverErrorTypes.genericNetworkError;
     readonly statusCode?: number;
 }
 
@@ -573,7 +510,7 @@ export declare interface IGenericNetworkError extends IDriverErrorBase {
  * @alpha
  */
 export declare interface ILocationRedirectionError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.locationRedirection;
+    readonly errorType: typeof DriverErrorTypes.locationRedirection;
     readonly redirectUrl: IResolvedUrl;
 }
 
@@ -595,6 +532,58 @@ export declare interface IResolvedUrl {
     };
 }
 
+/**
+ * @alpha
+ */
+export declare interface ISnapshot {
+    snapshotTree: ISnapshotTree;
+    blobContents: Map<string, ArrayBuffer>;
+    ops: ISequencedDocumentMessage[];
+    /**
+     * Sequence number of the snapshot
+     */
+    sequenceNumber: number | undefined;
+    /**
+     * Sequence number for the latest op/snapshot for the file in ODSP
+     */
+    latestSequenceNumber: number | undefined;
+    snapshotFormatV: 1;
+}
+
+/**
+ * Snapshot fetch options which are used to communicate different things to the driver
+ * when fetching the snapshot.
+ * @alpha
+ */
+export declare interface ISnapshotFetchOptions {
+    /**
+     * Indicates scenario in which the snapshot is fetched. It is a free form string  mostly
+     * used for telemetry purposes.
+     */
+    scenarioName?: string;
+    /**
+     * Tell driver to cache the fetched snapshot. Driver is supposed to cache the fetched snapshot if this is
+     * set to true. If undefined, then it is upto the driver, to cache it or not.
+     */
+    cacheSnapshot?: boolean;
+    /**
+     * Version of the snapshot to be fetched. Certain storage services just keep 1 snapshot for the
+     * container, so specifying version is not necessary for storage services.
+     */
+    versionId?: string;
+    /**
+     * List of loading groupId of datastores for which the snapshot needs to be fetched. If not provided, content with
+     * default/missing groupIDs will be requested from the service. It is upto the service, to include snapshot for
+     * content with groupIds or not. Don't provide anything here for fetching content for initial container boot.
+     */
+    loadingGroupIds?: string[];
+    /**
+     * Specify if you want default behavior of the driver to fetch the snapshot like lets say simultaneously fetch from
+     * network and cache or specify FetchSource.noCache to just fetch from network.
+     */
+    fetchSource?: FetchSource;
+}
+
 /**
  * Read interface for the Queue
  * @alpha
@@ -634,7 +623,7 @@ export declare interface ISummaryContext {
  * @alpha
  */
 export declare interface IThrottlingWarning extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.throttlingError;
+    readonly errorType: typeof DriverErrorTypes.throttlingError;
     readonly retryAfterSeconds: number;
 }