@fluidframework/odsp-driver

The ODSP (OneDrive/Sharepoint) driver is an implementation of a Fluid driver that facilitate communication between the client and the ODSP server to retrieve Fluid content and connect to the Fluid collaboration session.

The ODSP Fluid service is not a publicly available service, and currently it is not possible to use this driver to connect to it. This driver is present as an illustration of a different Fluid driver implementation. Developers should not depend on this driver for their own solutions.

Telemetry Event names to SPO API mapping:

These event names are suffixed by _end in case they are successful API calls or by _cancel in case they are failures. In the table I have used the failure ones.

| Event Name | Endpoint | Notes | |:---|:---|:---| | fluid:telemetry:OdspDriver:TreesLatest_cancel | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream/snapshots/trees/latest?ump=1 | Error when fetching snapshot from storage, typically during document load. (Storage Call) | | fluid:telemetry:OdspDriver:GetDeltas_cancelfluid:telemetry:OdspDriver:OpsFetch_cancel | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream?ump=1&filter=sequenceNumber ge START and sequenceNumber le END | Error when fetching ops from the storage. (Storage Call) | | fluid:telemetry:OdspDriver:JoinSession_cancel | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream/joinSession?ump=1 | Error when getting the details needed to connect to socket. It is also called every 15 mins to renew session. (Storage Call) | | fluid:telemetry:BlobManager:AttachmentReadBlob_cancelfluid:telemetry:OdspDriver:readDataBlob_cancel | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream/attachments/BLOB_ID/content | Error when reading attachment blobs (e.g. images). (Storage Call) | | fluid:telemetry:OdspDriver:createBlob_cancel | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream/attachment/content | Error when creating an attachment blob (e.g. an inserted image). (Storage Call) | | fluid:telemetry:OdspDriver:CreateNewFile_cancel | /_api/v2.1/drives/DRIVEID/items/root:%2f<path>.fluid:/opStream/snapshots/snapshot?ump=1 | Error when creating a new Fluid file, during Container Attach. (Storage Call) | | fluid:telemetry:OdspDriver:createNewEmptyFile_cancel | /_api/v2.1/drives/DRIVEID/items/root://FILEPATH/FILENAME:/[email protected]=rename&select=id,name,parentReference&ump=1 | Error when creating a new empty Fluid file. When we have attachment blobs in detached container, we first create empty file, then upload attachment blobs and then upload summary so that summary can refer to those blobs. (Storage Call) | | fluid:telemetry:OdspDriver:uploadSummary_cancel | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream/snapshots/snapshot | Error when uploading Fluid summary to storage. (Storage Call) | | fluid:telemetry:OdspDriver:RedeemShareLink_cancel | _api/v2.0/shares/${encodedShareUrl}/driveItem | Error when redeeming the share link after single Round Trip redeem during snapshot fetch already failed. Read more about single RT Redeem here. | | OdspDriver:odspFileLink_cancelOdspDriver:getShareLink_cancel | /_api/v2.0/drives/${driveId}/items/${itemId}?select=webUrl,webDavUrl,sharepointIds | Error when fetching sharing link with requestName = getFileItemLite in Telemetry. getShareLink event is parent of odspFileLink event. | | OdspDriver:odspFileLink_cancelOdspDriver:getShareLink_cancel | /_api/web/GetFileById(@a1)/ListItemAllFields/GetSharingInformation?@a1=guid${encodeURIComponent('${fileItem.sharepointIds.listItemUniqueId}')} | Error when fetching sharing link with requestName = getSharingInformation in Telemetry. getShareLink event is parent of odspFileLink event. |

Using Fluid Framework libraries

For a dependency on a Fluid Framework library's public APIs, we recommend a ^ (caret) version range. For example, use ^1.3.4.

For a dependency on an unstable API, such as a beta API, we recommend a more restrictive version range. For example, use a ~ version range.

Installation

Run this command to install the package:

npm i @fluidframework/odsp-driver

Importing from this package

This package uses package.json exports to separate APIs by support level. For information about the support guarantees, read API Support Levels.

Import the public APIs from @fluidframework/odsp-driver.

Import the legacy APIs from @fluidframework/odsp-driver/legacy.

API Documentation

Read the @fluidframework/odsp-driver API documentation at https://fluidframework.com/docs/apis/odsp-driver.

ODSP APIs

Documenting some basics about opds-driver specific apis that are relevant for creation or loading of a Fluid file from ODSP.

/snapshot API

• Creates a new Fluid file with the contents as the summary provided in the request body.
• The creation of file along with the summary is done in a single api call to reduce the number of round trips during new file creation.
• Also supports creation of sharing link for the file if appropriate request headers are provided in the api call. This feature was introduced to save the number of round trips that a host app makes while creating a file and then creating a sharing link.
  1. Earlier only &createLinkType=csl parameter was supported which could create organizational scoped sharing links. Feature is gated by enableShareLinkWithCreate provided via HostStoragePolicy. (createLinkType is now deprecated, so prefer using option 2 below)
  2. Now, providing appropriate values for &createLinkScope and &createLinkRole request parameters will let you create sharing links with various permission scopes. See resolvedUrl definition for more details. Feature is gated by enableSingleRequestForShareLinkWithCreate provided via HostStoragePolicy.

/trees/latest API

• Fetches the snapshot of an existing Fluid file.
• Earlier, application needed to redeem the sharing link of the file before a /trees/latest fetch could be made. To reduce the number of round trips made to ODSP, redemption of the share link now happens along with fetching latest snapshot in the same api request by passing share link in &sl request parameter.
• This api is also preflight-less, which means it is not preceded by an OPTIONS call in the browsers to reduce the network trips to the server.

Minimum Client Requirements

Fluid Framework client libraries support the platforms in this document. These requirements are intentionally restrictive. Within a major version series, we can relax these requirements, but we cannot make them stricter. For a Long Term Support (LTS) version, we might need to support these platforms for several years.

Other configurations can work, but Fluid Framework does not support them. If an unsupported configuration stops working, we do not classify this as a bug. To request support for a configuration that is not listed, file an issue. The product team will evaluate your request. In the issue, specify the current status of the configuration:

• The configuration works but needs official support.
• The configuration does not work and requires changes.

Supported Runtimes

• Fluid Framework supports Node.js versions 22 and 24 while they receive upstream support.
  • Fluid Framework will stop support for version 22 when upstream support ends on 2027-04-30.
  • Fluid Framework does not support Node.js with the --no-experimental-fetch flag.
• Fluid Framework supports modern browsers that support the ES2022 standard library.

Supported Tools

• TypeScript 6.0:
  • Fluid Framework supports all strict options.
  • Set the build targets (lib, target) to ES2022 or later.
  • Enable strictNullChecks.
  • Fluid Framework does not support configuration options deprecated in TypeScript 6.0.
  • Fluid Framework does not fully support exactOptionalPropertyTypes. If you enable this option, do not use in, Reflect.has, Object.hasOwn, or Object.prototype.hasOwnProperty to narrow members of Fluid Framework types. These methods can incorrectly exclude undefined from the possible values.
• webpack 5
  • We do not require a specific bundler. Other bundlers that handle ES Modules can work, but we actively test only webpack.

Module Resolution

In TypeScript compilerOptions, use Node16, Node20, NodeNext, or Bundler module resolution. These settings follow the Node.js v12+ ESM Resolution and Loading algorithm.

Do not use Node10 module resolution.

Module Formats

• ES Modules: Use ES Modules to consume Fluid Framework client packages, including in Node.js.
• CommonJS: Fluid Framework does not officially support CommonJS in version 3.0 or later.

Contribution Guidelines

You can contribute to Fluid Framework in these ways:

• Answer questions in GitHub Discussions.
• Submit bug reports and help verify fixes.
• Review source code changes.
• Contribute bug fixes.

For detailed instructions, read the repo documentation.

This project follows the Microsoft Open Source Code of Conduct. For more information, read the Code of Conduct frequently asked questions. For questions or comments, contact [email protected].

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services. Use of these trademarks or logos must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.

Help

Read the Fluid Framework documentation for information about Fluid Framework concepts and APIs.

To request information that the documentation does not contain, create an issue.

Trademark

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.

Use of these trademarks or logos must follow Microsoft's Trademark & Brand Guidelines.

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.