@fluidframework/odsp-driver 2.53.1 → 2.61.0-355054

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver",
-  "version": "2.53.1",
+  "version": "2.61.0-355054",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,32 +69,32 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.53.1",
-    "@fluidframework/core-interfaces": "~2.53.1",
-    "@fluidframework/core-utils": "~2.53.1",
-    "@fluidframework/driver-base": "~2.53.1",
-    "@fluidframework/driver-definitions": "~2.53.1",
-    "@fluidframework/driver-utils": "~2.53.1",
-    "@fluidframework/odsp-doclib-utils": "~2.53.1",
-    "@fluidframework/odsp-driver-definitions": "~2.53.1",
-    "@fluidframework/telemetry-utils": "~2.53.1",
+    "@fluid-internal/client-utils": "2.61.0-355054",
+    "@fluidframework/core-interfaces": "2.61.0-355054",
+    "@fluidframework/core-utils": "2.61.0-355054",
+    "@fluidframework/driver-base": "2.61.0-355054",
+    "@fluidframework/driver-definitions": "2.61.0-355054",
+    "@fluidframework/driver-utils": "2.61.0-355054",
+    "@fluidframework/odsp-doclib-utils": "2.61.0-355054",
+    "@fluidframework/odsp-driver-definitions": "2.61.0-355054",
+    "@fluidframework/telemetry-utils": "2.61.0-355054",
     "socket.io-client": "~4.7.5",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.53.1",
-    "@fluid-tools/build-cli": "^0.57.0",
+    "@fluid-internal/mocha-test-setup": "2.61.0-355054",
+    "@fluid-tools/build-cli": "^0.58.2",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.57.0",
-    "@fluidframework/eslint-config-fluid": "^5.7.4",
-    "@fluidframework/odsp-driver-previous": "npm:@fluidframework/odsp-driver@2.53.0",
-    "@microsoft/api-extractor": "7.52.8",
+    "@fluidframework/build-tools": "^0.58.2",
+    "@fluidframework/eslint-config-fluid": "^6.0.0",
+    "@fluidframework/odsp-driver-previous": "npm:@fluidframework/odsp-driver@2.60.0",
+    "@microsoft/api-extractor": "7.52.11",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
     "@types/sinon": "^17.0.3",
-    "c8": "^8.0.1",
+    "c8": "^10.1.3",
     "concurrently": "^8.2.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
@@ -111,8 +111,8 @@
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
+    "api-extractor:commonjs": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
     "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
     "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
@@ -148,8 +148,8 @@
     "test": "npm run test:mocha",
     "test:coverage": "c8 npm test",
     "test:mocha": "npm run test:mocha:cjs && npm run test:mocha:esm",
-    "test:mocha:cjs": "mocha --recursive \"dist/test/**/*.spec.*js\"",
-    "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\"",
+    "test:mocha:cjs": "cross-env MOCHA_SPEC=dist/test mocha",
+    "test:mocha:esm": "mocha",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
     "typetests:gen": "flub generate typetests --dir . -v",

package/src/checkUrl.ts

@@ -13,7 +13,7 @@ import { getLocatorFromOdspUrl } from "./odspFluidFileLink.js";
  * Instead, this should be used as a lightweight check that can filter out easily detectable unsupported URLs
  * before the entire Fluid loading process needs to be kicked off.
  * @legacy
- * @alpha
+ * @beta
  */
 export function checkUrl(documentUrl: URL): DriverPreCheckInfo | undefined {
 	const locator = getLocatorFromOdspUrl(documentUrl);

package/src/constants.ts

@@ -5,12 +5,12 @@
 
 /**
  * @legacy
- * @alpha
+ * @beta
  */
 export const OdcApiSiteOrigin = "https://my.microsoftpersonalcontent.com";
 
 /**
  * @legacy
- * @alpha
+ * @beta
  */
 export const OdcFileSiteOrigin = "https://1drv.ms";

package/src/contractsPublic.ts

@@ -7,7 +7,7 @@ import type { IOdspUrlParts } from "@fluidframework/odsp-driver-definitions/inte
 
 /**
  * @legacy
- * @alpha
+ * @beta
  */
 export interface OdspFluidDataStoreLocator extends IOdspUrlParts {
 	dataStorePath: string;

package/src/createOdspCreateContainerRequest.ts

@@ -23,7 +23,7 @@ import { buildOdspShareLinkReqParams, getContainerPackageName } from "./odspUtil
  * @param containerPackageInfo - Container package information which will be used to extract the container package name.
  * If not given that means that the container package does not have a name.
  * @legacy
- * @alpha
+ * @beta
  */
 export function createOdspCreateContainerRequest(
 	siteUrl: string,

package/src/createOdspUrl.ts

@@ -13,7 +13,7 @@ import type { OdspFluidDataStoreLocator } from "./contractsPublic.js";
  * Encodes ODC/SPO information into a URL format that can be handled by the Loader
  * @param l -The property bag of necessary properties to locate a Fluid data store and craft a url for it
  * @legacy
- * @alpha
+ * @beta
  */
 export function createOdspUrl(l: OdspFluidDataStoreLocator): string {
 	let odspUrl = `${l.siteUrl}?driveId=${encodeURIComponent(

package/src/epochTracker.ts

@@ -48,7 +48,7 @@ import { pkgVersion as driverVersion } from "./packageVersion.js";
 
 /**
  * @legacy
- * @alpha
+ * @beta
  */
 export type FetchType =
 	| "blob"
@@ -66,7 +66,7 @@ export type FetchType =
 
 /**
  * @legacy
- * @alpha
+ * @beta
  */
 export type FetchTypeInternal = FetchType | "cache";
 
@@ -87,7 +87,7 @@ export const Odsp409Error = "Odsp409Error";
  * It also validates the epoch value received in response of fetch calls. If the epoch does not match,
  * then it also clears all the cached entries for the given container.
  * @legacy
- * @alpha
+ * @beta
  */
 export class EpochTracker implements IPersistedFileCache {
 	private _fluidEpoch: string | undefined;
@@ -619,7 +619,7 @@ export class EpochTrackerWithRedemption extends EpochTracker {
 
 /**
  * @legacy
- * @alpha
+ * @beta
  */
 export interface ICacheAndTracker {
 	cache: IOdspCache;

package/src/fetchSnapshot.ts

@@ -66,7 +66,7 @@ import { pkgVersion } from "./packageVersion.js";
 /**
  * Enum to support different types of snapshot formats.
  * @legacy
- * @alpha
+ * @beta
  */
 export enum SnapshotFormatSupportType {
 	Json = 0,

package/src/getFileLink.ts

@@ -115,7 +115,7 @@ export const getFileLink = mockify(
  * @param logger - logger to send events.
  * @returns Response from the API call.
  * @legacy
- * @alpha
+ * @beta
  */
 async function getFileLinkWithLocationRedirectionHandling(
 	getToken: TokenFetcher<OdspResourceTokenFetchOptions>,

package/src/odspCache.ts

@@ -18,7 +18,7 @@ import {
 /**
  * Similar to IPersistedCache, but exposes cache interface for single file
  * @legacy
- * @alpha
+ * @beta
  */
 export interface IPersistedFileCache {
 	// TODO: use a stronger type
@@ -97,7 +97,7 @@ export class PromiseCacheWithOneHourSlidingExpiry<T> extends PromiseCache<string
 /**
  * Internal cache interface used within driver only
  * @legacy
- * @alpha
+ * @beta
  */
 export interface INonPersistentCache {
 	/**
@@ -123,7 +123,7 @@ export interface INonPersistentCache {
 /**
  * Internal cache interface used within driver only
  * @legacy
- * @alpha
+ * @beta
  */
 export interface IOdspCache extends INonPersistentCache {
 	/**
@@ -148,7 +148,7 @@ export class NonPersistentCache implements INonPersistentCache {
 
 /**
  * @legacy
- * @alpha
+ * @beta
  */
 export interface IPrefetchSnapshotContents extends ISnapshot {
 	fluidEpoch: string;

package/src/odspDocumentService.ts

@@ -225,10 +225,11 @@ export class OdspDocumentService
 			async (from, to, telemetryProps, fetchReason) =>
 				service.get(from, to, telemetryProps, fetchReason),
 			// Get cachedOps Callback.
-			async (from, to) => {
-				const res = await this.opsCache?.get(from, to);
-				return (res as ISequencedDocumentMessage[]) ?? [];
-			},
+			// TODO AB#47218: This condition will be removed when file version can be read from the cache entry for an op.
+			this.odspResolvedUrl.fileVersion === undefined
+				? async (from, to) =>
+						((await this.opsCache?.get(from, to)) as ISequencedDocumentMessage[]) ?? []
+				: async () => [],
 			// Ops requestFromSocket Callback.
 			(from, to) => {
 				const currentConnection = this.odspDelayLoadedDeltaStream?.currentDeltaConnection;

package/src/odspDocumentServiceFactory.ts

@@ -19,7 +19,7 @@ import { OdspDocumentServiceFactoryCore } from "./odspDocumentServiceFactoryCore
  * Factory for creating the sharepoint document service. Use this if you want to
  * use the sharepoint implementation.
  * @legacy
- * @alpha
+ * @beta
  */
 export class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {
 	constructor(
@@ -39,7 +39,7 @@ export class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {
  * content directly.
  *
  * @legacy
- * @alpha
+ * @beta
  */
 export function createLocalOdspDocumentServiceFactory(
 	localSnapshot: Uint8Array | string,

package/src/odspDocumentServiceFactoryCore.ts

@@ -60,7 +60,7 @@ import {
  * This constructor should be used by environments that support dynamic imports and that wish
  * to leverage code splitting as a means to keep bundles as small as possible.
  * @legacy
- * @alpha
+ * @beta
  */
 export class OdspDocumentServiceFactoryCore
 	implements IDocumentServiceFactory, IRelaySessionAwareDriverFactory

package/src/odspDriverUrlResolver.ts

@@ -94,7 +94,7 @@ const isFluidPackage = (pkg: Record<string, unknown>): boolean =>
  * Resolver to resolve urls like the ones created by createOdspUrl which is driver inner
  * url format. Ex: `${siteUrl}?driveId=${driveId}&itemId=${itemId}&path=${path}`
  * @legacy
- * @alpha
+ * @beta
  */
 export class OdspDriverUrlResolver implements IUrlResolver {
 	constructor() {}

package/src/odspDriverUrlResolverForShareLink.ts

@@ -37,7 +37,7 @@ import {
 /**
  * Properties passed to the code responsible for fetching share link for a file.
  * @legacy
- * @alpha
+ * @beta
  */
 export interface ShareLinkFetcherProps {
 	/**
@@ -55,7 +55,7 @@ export interface ShareLinkFetcherProps {
  * url format and the ones which have things like driveId, siteId, itemId etc encoded in nav param.
  * This resolver also handles share links and try to generate one for the use by the app.
  * @legacy
- * @alpha
+ * @beta
  */
 export class OdspDriverUrlResolverForShareLink implements IUrlResolver {
 	private readonly logger: ITelemetryLoggerExt;

package/src/odspFluidFileLink.ts

@@ -24,7 +24,7 @@ const additionalContextParamName = "x";
  * @param locator - describes Fluid data store locator info to be encoded
  * @returns string representing encoded Fluid data store locator info
  * @legacy
- * @alpha
+ * @beta
  */
 export function encodeOdspFluidDataStoreLocator(locator: OdspFluidDataStoreLocator): string {
 	const siteUrl = new URL(locator.siteUrl);
@@ -115,7 +115,7 @@ function decodeOdspFluidDataStoreLocator(
  * This parameter is provided by host in the resolve request and it contains information about the file
  * like driveId, itemId, siteUrl, datastorePath, packageName etc.
  * @legacy
- * @alpha
+ * @beta
  */
 export const locatorQueryParamName = "nav";
 
@@ -124,7 +124,7 @@ export const locatorQueryParamName = "nav";
  * @param url - file url in ODSP format (can be either canonical or share link)
  * @param locator - object representing Fluid data store location in ODSP terms
  * @legacy
- * @alpha
+ * @beta
  */
 export function storeLocatorInOdspUrl(url: URL, locator: OdspFluidDataStoreLocator): void {
 	const encodedLocatorValue = encodeOdspFluidDataStoreLocator(locator);
@@ -140,7 +140,7 @@ export function storeLocatorInOdspUrl(url: URL, locator: OdspFluidDataStoreLocat
  * @param requireFluidSignature - flag representing if the Fluid signature is expected in the url, default true
  * @returns object representing Fluid data store location in ODSP terms
  * @legacy
- * @alpha
+ * @beta
  */
 export function getLocatorFromOdspUrl(
 	url: URL,

package/src/odspPublicUtils.ts

@@ -14,7 +14,7 @@ import type {
  * said document.
  *
  * @legacy
- * @alpha
+ * @beta
  */
 export async function getHashedDocumentId(driveId: string, itemId: string): Promise<string> {
 	const buffer = IsoBuffer.from(`${driveId}_${itemId}`);
@@ -23,7 +23,7 @@ export async function getHashedDocumentId(driveId: string, itemId: string): Prom
 
 /**
  * @legacy
- * @alpha
+ * @beta
  * @deprecated - This is deprecated.
  */
 export interface ISnapshotContents {

package/src/odspUtils.ts

@@ -63,7 +63,7 @@ export const getWithRetryForTokenRefreshRepeat = "getWithRetryForTokenRefreshRep
 
 /**
  * @legacy
- * @alpha
+ * @beta
  */
 export interface IOdspResponse<T> {
 	content: T;
@@ -341,7 +341,7 @@ export function getOdspResolvedUrl(resolvedUrl: IResolvedUrl): IOdspResolvedUrl
  * Type narrowing utility to determine if the provided {@link @fluidframework/driver-definitions#IResolvedUrl}
  * is an {@link @fluidframework/odsp-driver-definitions#IOdspResolvedUrl}.
  * @legacy
- * @alpha
+ * @beta
  */
 export function isOdspResolvedUrl(resolvedUrl: IResolvedUrl): resolvedUrl is IOdspResolvedUrl {
 	return "odspResolvedUrl" in resolvedUrl && resolvedUrl.odspResolvedUrl === true;

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/odsp-driver";
-export const pkgVersion = "2.53.1";
+export const pkgVersion = "2.61.0-355054";

package/src/prefetchLatestSnapshot.ts

@@ -61,7 +61,7 @@ import {
  *
  * @returns `true` if the snapshot is cached, `false` otherwise.
  * @legacy
- * @alpha
+ * @beta
  */
 export async function prefetchLatestSnapshot(
 	resolvedUrl: IResolvedUrl,