@fluidframework/driver-definitions 2.0.0-internal.8.0.0 → 2.0.0-rc.1.0.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @fluidframework/driver-definitions
 
+## 2.0.0-rc.1.0.0
+
+### Minor Changes
+
+-   Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
+
+    The following Fluid server dependencies have been updated to the latest version, 3.0.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/releases/tag/server_v3.0.0)
+
+    -   @fluidframework/gitresources
+    -   @fluidframework/server-kafka-orderer
+    -   @fluidframework/server-lambdas
+    -   @fluidframework/server-lambdas-driver
+    -   @fluidframework/server-local-server
+    -   @fluidframework/server-memory-orderer
+    -   @fluidframework/protocol-base
+    -   @fluidframework/server-routerlicious
+    -   @fluidframework/server-routerlicious-base
+    -   @fluidframework/server-services
+    -   @fluidframework/server-services-client
+    -   @fluidframework/server-services-core
+    -   @fluidframework/server-services-ordering-kafkanode
+    -   @fluidframework/server-services-ordering-rdkafka
+    -   @fluidframework/server-services-ordering-zookeeper
+    -   @fluidframework/server-services-shared
+    -   @fluidframework/server-services-telemetry
+    -   @fluidframework/server-services-utils
+    -   @fluidframework/server-test-utils
+    -   tinylicious
+
+-   Updated @fluidframework/protocol-definitions ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
+
+    The @fluidframework/protocol-definitions dependency has been upgraded to v3.1.0. [See the full
+    changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#310)
+
 ## 2.0.0-internal.8.0.0
 
 Dependency updates only.

package/README.md

@@ -13,12 +13,6 @@ When taking a dependency on a Fluid Framework library, we recommend using a `^`
 While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
 library consumers should always prefer `^`.
 
-Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
-you must use a `>= <` dependency range (such as `>=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0` where `w` is `x+1`).
-Standard `^` and `~` ranges will not work as expected.
-See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
-package for more information including tools to convert between version schemes.
-
 <!-- prettier-ignore-end -->
 
 <!-- AUTO-GENERATED-CONTENT:END -->

package/api-extractor-esm.json

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

package/api-extractor-lint.json

@@ -1,13 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-lint.json",
-	"messages": {
-		"extractorMessageReporting": {
-			// TODO: remove once base config has this enabled as an error
-			"ae-incompatible-release-tags": {
-				"logLevel": "error",
-				"addToApiReportFile": false
-			}
-		}
-	}
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
 }

package/api-extractor.json

@@ -1,12 +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",
-	"messages": {
-		"extractorMessageReporting": {
-			// TODO: Add missing documentation and remove this rule override
-			"ae-undocumented": {
-				"logLevel": "none"
-			}
-		}
-	}
+	"extends": "../../../common/build/build-common/api-extractor-base.json"
 }

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

@@ -24,10 +24,10 @@ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
 import { ITokenClaims } from '@fluidframework/protocol-definitions';
 import { IVersion } from '@fluidframework/protocol-definitions';
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
 
-// @alpha @deprecated
+// @public @deprecated
 export enum DriverErrorType {
     authorizationError = "authorizationError",
     deltaStreamConnectionForbidden = "deltaStreamConnectionForbidden",
@@ -50,7 +50,7 @@ export enum DriverErrorType {
     writeError = "writeError"
 }
 
-// @internal
+// @public
 export const DriverErrorTypes: {
     readonly genericNetworkError: "genericNetworkError";
     readonly authorizationError: "authorizationError";
@@ -72,10 +72,10 @@ export const DriverErrorTypes: {
     readonly usageError: "usageError";
 };
 
-// @internal (undocumented)
+// @public (undocumented)
 export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
 
-// @internal
+// @alpha
 export enum DriverHeader {
     // (undocumented)
     createNew = "createNew",
@@ -83,7 +83,7 @@ export enum DriverHeader {
     summarizingClient = "fluid-client-summarizer"
 }
 
-// @internal
+// @alpha
 export interface DriverPreCheckInfo {
     codeDetailsHint?: string;
     criticalBootDomains?: string[];
@@ -100,13 +100,13 @@ export enum FetchSource {
 // @alpha (undocumented)
 export type FiveDaysMs = 432000000;
 
-// @alpha
+// @public
 export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
     // (undocumented)
     readonly errorType: string;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IAuthorizationError extends IDriverErrorBase {
     // (undocumented)
     readonly claims?: string;
@@ -214,7 +214,7 @@ export interface IDocumentStorageServicePolicies {
     readonly maximumCacheDurationMs?: FiveDaysMs;
 }
 
-// @internal
+// @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;
@@ -222,7 +222,7 @@ export interface IDriverBasicError extends IDriverErrorBase {
     readonly statusCode?: number;
 }
 
-// @alpha
+// @public
 export interface IDriverErrorBase {
     canRetry: boolean;
     endpointReached?: boolean;
@@ -239,7 +239,7 @@ export interface IDriverHeader {
     [DriverHeader.createNew]: any;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IGenericNetworkError extends IDriverErrorBase {
     // (undocumented)
     readonly errorType: DriverErrorType.genericNetworkError;
@@ -247,7 +247,7 @@ export interface IGenericNetworkError extends IDriverErrorBase {
     readonly statusCode?: number;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ILocationRedirectionError extends IDriverErrorBase {
     // (undocumented)
     readonly errorType: DriverErrorType.locationRedirection;
@@ -294,7 +294,7 @@ export interface ISummaryContext {
     readonly referenceSequenceNumber: number;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IThrottlingWarning extends IDriverErrorBase {
     // (undocumented)
     readonly errorType: DriverErrorType.throttlingError;

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

@@ -18,14 +18,17 @@ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
 import { ITokenClaims } from '@fluidframework/protocol-definitions';
 import { IVersion } from '@fluidframework/protocol-definitions';
 
-/* Excluded from this release type: DriverError */
+/**
+ * @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.
- * @alpha
+ * @public
  */
 export declare enum DriverErrorType {
     /**
@@ -111,11 +114,114 @@ export declare enum DriverErrorType {
     outOfStorageError = "outOfStorageError"
 }
 
-/* Excluded from this release type: DriverErrorTypes */
+/**
+ * Different error types the Driver may report out to the Host.
+ * @public
+ */
+export declare const DriverErrorTypes: {
+    /**
+     * Some non-categorized (below) networking error
+     * Include errors like  fatal server error (usually 500).
+     */
+    readonly genericNetworkError: "genericNetworkError";
+    /**
+     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file
+     */
+    readonly authorizationError: "authorizationError";
+    /**
+     * File not found, or file deleted during session
+     */
+    readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
+    /**
+     * We can not reach server due to computer being offline.
+     */
+    readonly offlineError: "offlineError";
+    readonly 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.
+     */
+    readonly 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.
+     */
+    readonly fetchFailure: "fetchFailure";
+    /**
+     * This error occurs when token provider fails to fetch orderer token
+     */
+    readonly fetchTokenError: "fetchTokenError";
+    /**
+     * Unexpected response from server. Either JSON is malformed, or some required properties are missing
+     */
+    readonly 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.
+     */
+    readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
+    /**
+     * The document is read-only and delta stream connection is forbidden.
+     */
+    readonly 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.
+     */
+    readonly 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"
+     */
+    readonly fluidInvalidSchema: "fluidInvalidSchema";
+    /**
+     * File is locked for read/write by storage, e.g. whole collection is locked and access denied.
+     */
+    readonly fileIsLocked: "fileIsLocked";
+    /**
+     * Storage is out of space
+     */
+    readonly outOfStorageError: "outOfStorageError";
+    readonly genericError: "genericError";
+    readonly throttlingError: "throttlingError";
+    readonly usageError: "usageError";
+};
+
+/**
+ * @public
+ */
+export declare type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
 
-/* Excluded from this release type: DriverHeader */
+/**
+ * Additional key in the loader request header
+ * @alpha
+ */
+export declare enum DriverHeader {
+    summarizingClient = "fluid-client-summarizer",
+    createNew = "createNew"
+}
 
-/* Excluded from this release type: DriverPreCheckInfo */
+/**
+ * Information that can be returned by a lightweight, seperately exported driver function. Used to preanalyze a URL
+ * for driver compatibility and preload information.
+ * @alpha
+ */
+export declare interface DriverPreCheckInfo {
+    /**
+     * A code details hint that can potentially be used to prefetch container code prior to having a snapshot.
+     */
+    codeDetailsHint?: string;
+    /**
+     * Domains that will be connected to on the critical boot path. Hosts can choose to preconnect to these for
+     * improved performance.
+     */
+    criticalBootDomains?: string[];
+}
 
 /**
  * @alpha
@@ -138,13 +244,20 @@ export declare type FiveDaysMs = 432000000;
  * "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,
  * but we can't reference a specific driver's error type enum in this code.
- * @alpha
+ * @public
  */
 export declare interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
     readonly errorType: string;
 }
 
-/* Excluded from this release type: IAuthorizationError */
+/**
+ * @alpha
+ */
+export declare interface IAuthorizationError extends IDriverErrorBase {
+    readonly errorType: DriverErrorType.authorizationError;
+    readonly claims?: string;
+    readonly tenantId?: string;
+}
 
 /**
  * Container package info handed off to resolver.
@@ -406,11 +519,19 @@ export declare interface IDocumentStorageServicePolicies {
     readonly maximumCacheDurationMs?: FiveDaysMs;
 }
 
-/* Excluded from this release type: IDriverBasicError */
+/**
+ * Having this uber interface without types that have their own interfaces
+ * allows compiler to differentiate interfaces based on error type
+ * @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 statusCode?: number;
+}
 
 /**
  * Base interface for all errors and warnings
- * @alpha
+ * @public
  */
 export declare interface IDriverErrorBase {
     /**
@@ -440,9 +561,21 @@ export declare interface IDriverErrorBase {
 
 /* Excluded from this release type: IDriverHeader */
 
-/* Excluded from this release type: IGenericNetworkError */
+/**
+ * @alpha
+ */
+export declare interface IGenericNetworkError extends IDriverErrorBase {
+    readonly errorType: DriverErrorType.genericNetworkError;
+    readonly statusCode?: number;
+}
 
-/* Excluded from this release type: ILocationRedirectionError */
+/**
+ * @alpha
+ */
+export declare interface ILocationRedirectionError extends IDriverErrorBase {
+    readonly errorType: DriverErrorType.locationRedirection;
+    readonly redirectUrl: IResolvedUrl;
+}
 
 /**
  * @alpha
@@ -497,7 +630,13 @@ export declare interface ISummaryContext {
     readonly referenceSequenceNumber: number;
 }
 
-/* Excluded from this release type: IThrottlingWarning */
+/**
+ * @alpha
+ */
+export declare interface IThrottlingWarning extends IDriverErrorBase {
+    readonly errorType: DriverErrorType.throttlingError;
+    readonly retryAfterSeconds: number;
+}
 
 /**
  * @alpha

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

@@ -20,9 +20,179 @@ import { IVersion } from '@fluidframework/protocol-definitions';
 
 /* Excluded from this release type: DriverError */
 
-/* Excluded from this release type: DriverErrorType */
-
-/* Excluded from this release type: DriverErrorTypes */
+/**
+ * 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
+ */
+export declare const DriverErrorTypes: {
+    /**
+     * Some non-categorized (below) networking error
+     * Include errors like  fatal server error (usually 500).
+     */
+    readonly genericNetworkError: "genericNetworkError";
+    /**
+     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file
+     */
+    readonly authorizationError: "authorizationError";
+    /**
+     * File not found, or file deleted during session
+     */
+    readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
+    /**
+     * We can not reach server due to computer being offline.
+     */
+    readonly offlineError: "offlineError";
+    readonly 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.
+     */
+    readonly 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.
+     */
+    readonly fetchFailure: "fetchFailure";
+    /**
+     * This error occurs when token provider fails to fetch orderer token
+     */
+    readonly fetchTokenError: "fetchTokenError";
+    /**
+     * Unexpected response from server. Either JSON is malformed, or some required properties are missing
+     */
+    readonly 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.
+     */
+    readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
+    /**
+     * The document is read-only and delta stream connection is forbidden.
+     */
+    readonly 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.
+     */
+    readonly 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"
+     */
+    readonly fluidInvalidSchema: "fluidInvalidSchema";
+    /**
+     * File is locked for read/write by storage, e.g. whole collection is locked and access denied.
+     */
+    readonly fileIsLocked: "fileIsLocked";
+    /**
+     * Storage is out of space
+     */
+    readonly outOfStorageError: "outOfStorageError";
+    readonly genericError: "genericError";
+    readonly throttlingError: "throttlingError";
+    readonly usageError: "usageError";
+};
+
+/**
+ * @public
+ */
+export declare type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
 
 /* Excluded from this release type: DriverHeader */
 
@@ -32,7 +202,19 @@ import { IVersion } from '@fluidframework/protocol-definitions';
 
 /* Excluded from this release type: FiveDaysMs */
 
-/* Excluded from this release type: IAnyDriverError */
+/**
+ * Interface describing errors and warnings raised by any driver code.
+ * 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,
+ * but we can't reference a specific driver's error type enum in this code.
+ * @public
+ */
+export declare interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
+    readonly errorType: string;
+}
 
 /* Excluded from this release type: IAuthorizationError */
 
@@ -42,8 +224,6 @@ import { IVersion } from '@fluidframework/protocol-definitions';
 
 /* Excluded from this release type: IDeltaStorageService */
 
-/* Excluded from this release type: IDisposable */
-
 /* Excluded from this release type: IDocumentDeltaConnection */
 
 /* Excluded from this release type: IDocumentDeltaConnectionEvents */
@@ -62,20 +242,42 @@ import { IVersion } from '@fluidframework/protocol-definitions';
 
 /* Excluded from this release type: IDriverBasicError */
 
-/* Excluded from this release type: IDriverErrorBase */
+/**
+ * Base interface for all errors and warnings
+ * @public
+ */
+export declare interface IDriverErrorBase {
+    /**
+     * Classification of what type of error this is, used programmatically by consumers to interpret the error.
+     *
+     * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).
+     */
+    readonly errorType: DriverErrorType;
+    /**
+     * Free-form error message
+     */
+    readonly message: string;
+    /**
+     * True indicates the caller may retry the failed action. False indicates it's a fatal error
+     */
+    canRetry: boolean;
+    /**
+     * Best guess as to network conditions (online/offline) when the error arose.
+     * See OnlineStatus enum in driver-utils package for expected values.
+     */
+    online?: string;
+    /**
+     * Whether service was reachable and we got some response from service.
+     */
+    endpointReached?: boolean;
+}
 
 /* Excluded from this release type: IDriverHeader */
 
-/* Excluded from this release type: IErrorEvent */
-
-/* Excluded from this release type: IEventProvider */
-
 /* Excluded from this release type: IGenericNetworkError */
 
 /* Excluded from this release type: ILocationRedirectionError */
 
-/* Excluded from this release type: IRequest */
-
 /* Excluded from this release type: IResolvedUrl */
 
 /* Excluded from this release type: IStream */
@@ -84,8 +286,6 @@ import { IVersion } from '@fluidframework/protocol-definitions';
 
 /* Excluded from this release type: ISummaryContext */
 
-/* Excluded from this release type: ITelemetryBaseLogger */
-
 /* Excluded from this release type: IThrottlingWarning */
 
 /* Excluded from this release type: IUrlResolver */