@fluidframework/driver-definitions Package

Interfaces

Interface	Alerts	Modifiers	Description
DataStoreCreator	Alpha	sealed	A context which has a registry and can create data stores using it.
DataStoreKind	Alpha	sealed	Defines a kind of data store, allowing creating and loading instances of it.
DriverPreCheckInfo	Legacy		Information that can be returned by a lightweight, separately exported driver function. Used to preanalyze a URL for driver compatibility and preload information.
FluidContainer	Alpha	sealed	A Fluid container.
FluidContainerAttached	Alpha	sealed	A Fluid container that has been attached to a service.
FluidContainerWithService	Alpha	sealed	A Fluid container with an associated ServiceClient it can attach to.
IAnyDriverError	Legacy		Interface describing errors and warnings raised by any driver code.
IAttachment	Legacy
IAuthorizationError	Legacy
IBlob	Legacy		Raw blob stored within the tree.
IBranchOrigin	Legacy		Branch origin information.
ICacheEntry	Legacy		Cache entry. Identifies file that this entry belongs to, and type of content stored in it.
ICapabilities			Capabilities of a Client. In particular, whether or not the client is interactive.
IClient			Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.
IClientConfiguration	Legacy		Key value store of service configuration properties provided to the client as part of connection.
IClientDetails			IClient connection / environment metadata.
IConnect	Legacy		Message sent to connect to the given document.
IConnected	Legacy		Message sent to indicate a client has connected to the server.
IContainerPackageInfo	Legacy		Container package info handed off to resolver.
ICreateBlobResponse	Legacy
IDocumentAttributes	Legacy
IDocumentDeltaConnection	Legacy
IDocumentDeltaConnectionEvents	Legacy
IDocumentDeltaStorageService	Legacy		Interface to provide access to stored deltas for a shared object
IDocumentMessage	Legacy		Document-specific message.
IDocumentService	Legacy
IDocumentServiceEvents	Legacy		Events emitted by IDocumentService.
IDocumentServiceFactory	Legacy
IDocumentServicePolicies	Legacy
IDocumentStorageService	Legacy		Interface to provide access to snapshots saved for a shared object
IDocumentStorageServicePolicies	Legacy		Policies describing attributes or characteristics of the driver's storage service, to direct how other components interact with the driver
IDriverBasicError	Legacy		Having this uber interface without types that have their own interfaces allows compiler to differentiate interfaces based on error type
IDriverErrorBase	Legacy		Base interface for all errors and warnings
IEntry	Legacy		Cache entry. Identifies file that this entry belongs to, and type of content stored in it.
IFileEntry	Legacy		File / container identifier. There is overlapping information here - host can use all of it or parts to implement storage / identify files.
IGenericNetworkError	Legacy
ILocationRedirectionError	Legacy
INack	Legacy
INackContent	Legacy		Interface for nack content.
IPersistedCache	Legacy		Persistent cache. This interface can be implemented by the host to provide durable caching across sessions. If not provided at driver factory construction, factory will use in-memory cache implementation that does not survive across sessions. Snapshot entires stored in the IPersistedCache will be considered stale and removed after 2 days. Read the README for more information.
IProcessMessageResult	Legacy
IProposal	Legacy		Proposal to set the given key/value pair.
IQuorum	Legacy		Interface combining tracking of clients as well as proposals in the Quorum.
IQuorumClients			Interface for tracking clients in the Quorum.
IQuorumProposals	Legacy		Interface for tracking proposals in the Quorum.
IResolvedUrl	Legacy
ISequencedClient			A IClient that has been acknowledged by the sequencer.
ISequencedDocumentMessage	Legacy		Sequenced message for a distributed document.
ISignalClient	Legacy
ISignalMessage	Legacy		Interface for signals sent by the server to clients.
ISignalMessageBase	Legacy		Common interface between incoming and outgoing signals.
ISnapshot	Legacy		A "Full" container Snapshot, including ISnapshotTree, blobs and outstanding ops (and other metadata)
ISnapshotFetchOptions	Legacy		Snapshot fetch options which are used to communicate different things to the driver when fetching the snapshot.
ISnapshotTree	Legacy
IStream	Legacy		Read interface for the Queue
ISummaryAck	Legacy		Contents of summary ack expected from the server.
ISummaryAttachment			Unique identifier for blobs uploaded outside of the summary.
ISummaryBlob			String or Binary data to be uploaded to the server as part of the container's Summary.
ISummaryContent	Legacy
ISummaryContext	Legacy		Context for uploading a summary to storage. Indicates the previously acked summary.
ISummaryHandle			Path to a summary tree object from the last successful summary indicating the summary object hasn't changed since it was uploaded. Special characters include '/'. '/' is used as a separator between different parts of the path as a way to traverse different nodes in the previous summary/snapshot tree. Note, our algorithms use encodeURIComponent and decodeURIComponent to handle special characters in the path. If a string causes this path to fail, the id will be invalid.
ISummaryNack	Legacy		Contents of summary nack expected from the server.
ISummaryProposal	Legacy		Data about the original proposed summary message.
ISummaryTree			Tree Node data structure with children that are nodes of SummaryObject type: Blob, Handle, Attachment or another Tree.
IThrottlingWarning	Legacy
ITokenClaims	Legacy		JSON Web Token (JWT) Claims See https://datatracker.ietf.org/doc/html/rfc7519\#section\-4
ITrace	Legacy		Messages to track latency trace.
ITree	Legacy
IUploadedSummaryDetails	Legacy
IUrlResolver	Legacy
IUser			Base user definition. It is valid to extend this interface when adding new details to the user object.
IVersion	Legacy		Represents a version of the snapshot of a data store.
RegistryKey	Alpha	sealed	A strongly typed key for a Registry. Use with lookupInRegistry(registry, key).
ServiceClient	Alpha	sealed	A connection to a Fluid storage service.
ServiceOptions	Alpha		Options for configuring a ServiceClient.

Enumerations

Enum	Alerts	Description
DriverHeader	Legacy	Additional key in the loader request header
FetchSource	Legacy
FileMode	Legacy
LoaderCachingPolicy	Legacy
MessageType	Legacy
NackErrorType	Legacy	Type of the nack.
ScopeType	Legacy	Defines scope access for a Container/Document.
TreeEntry	Legacy	Type of entries that can be stored in a tree.

Types

TypeAlias	Alerts	Description
ConnectionMode		A client's connection mode - either view-only ("read") or allowing edits ("write").
DataStoreKey	Alpha	A RegistryKey for a DataStoreKind.
DataStoreRegistry	Alpha	A registry of DataStoreKinds.
DriverError	Legacy
DriverErrorTypes	Legacy	Different error types the Driver may report out to the Host.
FiveDaysMs	Legacy
IApprovedProposal	Legacy	Adds the sequence number at which the message was approved to an ISequencedProposal.
ICommittedProposal	Legacy	Adds the sequence number at which the message was committed to an IApprovedProposal.
ISequencedProposal	Legacy	Similar to IProposal except it also includes the sequence number when it was made.
IsoDate	Legacy	ISO 8601 format date: YYYY-MM-DDTHH:MM:SSZ.
IStreamResult	Legacy
ITreeEntry	Legacy	A tree entry wraps a path with a type of node.
OldestSupportedServiceClientVersion	Alpha	Oldest Fluid Framework client version that must be able to open and process documents written by a service client.
Registry	Alpha	A collection of entries looked up by a type string.
SummaryObject		Object representing a node within a summary tree.
SummaryTree	Legacy	The root of the summary tree.
SummaryType		Type tag used to distinguish different types of nodes in a ISummaryTree.
SummaryTypeNoHandle		Summary type that ISummaryHandle points to.

Functions

Function	Alerts	Return Type	Description
createBasicRegistryKey(type)	Alpha	RegistryKey<T, T>	Creates a simple RegistryKey which does no type conversion.
featureVersion(version)	Alpha	`${major}.${minor}.0`	Strips patch and prerelease from a SemVer string, returning only the major and minor version.
lookupInRegistry(registry, key)	Alpha	TOut	Lookup an entry in a Registry using a RegistryKey.

Variables

Variable	Alerts	Modifiers	Type	Description
DriverErrorTypes	Legacy	readonly	{ readonly genericNetworkError: "genericNetworkError"; readonly authorizationError: "authorizationError"; readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError"; readonly offlineError: "offlineError"; readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion"; readonly writeError: "writeError"; readonly fetchFailure: "fetchFailure"; readonly fetchTokenError: "fetchTokenError"; readonly incorrectServerResponse: "incorrectServerResponse"; readonly fileOverwrittenInStorage: "fileOverwrittenInStorage"; readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden"; readonly locationRedirection: "locationRedirection"; readonly fluidInvalidSchema: "fluidInvalidSchema"; readonly fileIsLocked: "fileIsLocked"; readonly outOfStorageError: "outOfStorageError"; readonly genericError: "genericError"; readonly throttlingError: "throttlingError"; readonly usageError: "usageError"; readonly layerIncompatibilityError: "layerIncompatibilityError"; }	Different error types the Driver may report out to the Host.

Namespaces

Namespace	Description
SummaryType	Type tag used to distinguish different types of nodes in a ISummaryTree.

Function Details

createBasicRegistryKey

Creates a simple RegistryKey which does no type conversion.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

export declare function createBasicRegistryKey<T>(type: string): RegistryKey<T, T>;

Type Parameters

Parameter	Description
T	The type of the registry entry, which is returned unchanged by the key.

Parameters

Parameter	Type	Description
type	string

Returns

Return type: RegistryKey<T, T>

featureVersion

Strips patch and prerelease from a SemVer string, returning only the major and minor version.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

export declare function featureVersion<major extends `${bigint}`, minor extends `${bigint}`>(version: `${major}.${minor}.${bigint}-${string}` | `${major}.${minor}.${bigint}`): `${major}.${minor}.0`;

Type Parameters

Parameter	Constraint	Description
major	`${bigint}`	The major version number of version as a string, preserved in the result type.
minor	`${bigint}`	The minor version number of version as a string, preserved in the result type.

Remarks

This formats a version in the same style used by OldestSupportedServiceClientVersion, specifying only the major and minor versions, which are the portions used for feature selection.

Parameters

Parameter	Type	Description
version	`${major}.${minor}.${bigint}-${string}` | `${major}.${minor}.${bigint}`

Returns

Return type: `${major}.${minor}.0`

lookupInRegistry

Lookup an entry in a Registry using a RegistryKey.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

export declare function lookupInRegistry<TOut, TIn>(registry: Registry<TIn>, key: RegistryKey<TOut, TIn>): TOut;

Type Parameters

Parameter	Description
TOut	The type produced from the looked-up entry.
TIn	The type of the entries in registry.

Parameters

Parameter	Type	Description
registry	Registry<TIn>
key	RegistryKey<TOut, TIn>

Returns

Return type: TOut

Variable Details

DriverErrorTypes

Different error types the Driver may report out to the Host.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

DriverErrorTypes: {
    readonly genericNetworkError: "genericNetworkError";
    readonly authorizationError: "authorizationError";
    readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
    readonly offlineError: "offlineError";
    readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
    readonly writeError: "writeError";
    readonly fetchFailure: "fetchFailure";
    readonly fetchTokenError: "fetchTokenError";
    readonly incorrectServerResponse: "incorrectServerResponse";
    readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
    readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden";
    readonly locationRedirection: "locationRedirection";
    readonly fluidInvalidSchema: "fluidInvalidSchema";
    readonly fileIsLocked: "fileIsLocked";
    readonly outOfStorageError: "outOfStorageError";
    readonly genericError: "genericError";
    readonly throttlingError: "throttlingError";
    readonly usageError: "usageError";
    readonly layerIncompatibilityError: "layerIncompatibilityError";
}

Type: { readonly genericNetworkError: "genericNetworkError"; readonly authorizationError: "authorizationError"; readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError"; readonly offlineError: "offlineError"; readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion"; readonly writeError: "writeError"; readonly fetchFailure: "fetchFailure"; readonly fetchTokenError: "fetchTokenError"; readonly incorrectServerResponse: "incorrectServerResponse"; readonly fileOverwrittenInStorage: "fileOverwrittenInStorage"; readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden"; readonly locationRedirection: "locationRedirection"; readonly fluidInvalidSchema: "fluidInvalidSchema"; readonly fileIsLocked: "fileIsLocked"; readonly outOfStorageError: "outOfStorageError"; readonly genericError: "genericError"; readonly throttlingError: "throttlingError"; readonly usageError: "usageError"; readonly layerIncompatibilityError: "layerIncompatibilityError"; }