@fluidframework/odsp-driver 2.118.1 → 3.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver",
-  "version": "2.118.1",
+  "version": "3.0.1",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,58 +14,35 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": {
-        "types": "./lib/public.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/public.d.ts",
-        "default": "./dist/index.js"
+      "types": "./lib/public.d.ts",
+      "default": "./lib/index.js",
+      "internal-entrypoint-generation": {
+        "types": "./dist/public.d.ts"
       }
     },
     "./legacy": {
-      "import": {
-        "types": "./lib/legacy.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/legacy.d.ts",
-        "default": "./dist/index.js"
+      "types": "./lib/legacy.d.ts",
+      "default": "./lib/index.js",
+      "internal-entrypoint-generation": {
+        "types": "./dist/legacy.d.ts"
       }
     },
     "./legacy/alpha": {
-      "import": {
-        "types": "./lib/legacyAlpha.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/legacyAlpha.d.ts",
-        "default": "./dist/index.js"
+      "types": "./lib/legacyAlpha.d.ts",
+      "default": "./lib/index.js",
+      "internal-entrypoint-generation": {
+        "types": "./dist/legacyAlpha.d.ts"
       }
     },
     "./legacy/point-in-time": {
-      "import": {
-        "types": "./lib/pointInTime.d.ts",
-        "default": "./lib/pointInTime.js"
-      },
-      "require": {
-        "types": "./dist/pointInTime.d.ts",
-        "default": "./dist/pointInTime.js"
-      }
+      "types": "./lib/pointInTime.d.ts",
+      "default": "./lib/pointInTime.js"
     },
     "./internal": {
-      "import": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
     }
   },
-  "main": "lib/index.js",
-  "types": "lib/public.d.ts",
   "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -89,22 +66,22 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.118.1",
-    "@fluidframework/core-interfaces": "~2.118.1",
-    "@fluidframework/core-utils": "~2.118.1",
-    "@fluidframework/driver-base": "~2.118.1",
-    "@fluidframework/driver-definitions": "~2.118.1",
-    "@fluidframework/driver-utils": "~2.118.1",
-    "@fluidframework/odsp-doclib-utils": "~2.118.1",
-    "@fluidframework/odsp-driver-definitions": "~2.118.1",
-    "@fluidframework/telemetry-utils": "~2.118.1",
+    "@fluid-internal/client-utils": "~3.0.1",
+    "@fluidframework/core-interfaces": "~3.0.1",
+    "@fluidframework/core-utils": "~3.0.1",
+    "@fluidframework/driver-base": "~3.0.1",
+    "@fluidframework/driver-definitions": "~3.0.1",
+    "@fluidframework/driver-utils": "~3.0.1",
+    "@fluidframework/odsp-doclib-utils": "~3.0.1",
+    "@fluidframework/odsp-driver-definitions": "~3.0.1",
+    "@fluidframework/telemetry-utils": "~3.0.1",
     "socket.io-client": "^4.8.3",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",
     "@biomejs/biome": "~2.4.5",
-    "@fluid-internal/mocha-test-setup": "~2.118.1",
+    "@fluid-internal/mocha-test-setup": "~3.0.1",
     "@fluid-tools/build-cli": "^0.67.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.67.0",
@@ -124,30 +101,35 @@
     "mocha-multi-reporters": "^1.5.1",
     "rimraf": "^6.1.3",
     "sinon": "^18.0.1",
-    "typescript": "~5.4.5"
+    "typescript": "~6.0.3"
   },
   "typeValidation": {
-    "broken": {},
+    "broken": {
+      "Function_getOdspPointInTimeDocumentServiceFactory": {
+        "backCompat": false
+      }
+    },
     "entrypoint": "legacy"
   },
   "scripts": {
     "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",
-    "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
+    "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor-report.current.json",
+    "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor-report.legacy.json",
     "build:api-reports:pointInTime": "api-extractor run --local --config api-extractor/api-extractor-report.pointInTime.json",
+    "build:cjs": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "api-extractor run --local",
+    "build:docs": "api-extractor run --local --config api-extractor/api-extractor-model.json",
     "build:entrypoints": "fluid-build . --task build:entrypoints",
     "build:entrypoints:cjs": "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./dist",
-    "build:entrypoints:esm": "flub generate entrypoints --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./lib --node10TypeCompat",
-    "build:esnext": "tsc --project ./tsconfig.json",
+    "build:entrypoints:esm": "flub generate entrypoints --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./lib",
+    "build:esm": "tsc --project ./tsconfig.json",
     "build:genver": "gen-version",
     "build:test": "concurrently npm:build:test:esm npm:build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack .",
+    "check:are-the-types-wrong": "attw --pack . --profile esm-only",
     "check:biome": "biome check .",
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
@@ -161,10 +143,10 @@
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
     "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
-    "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
-    "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
+    "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor-report.current.json",
+    "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor-report.legacy.json",
     "ci:build:api-reports:pointInTime": "api-extractor run --config api-extractor/api-extractor-report.pointInTime.json",
-    "ci:build:docs": "api-extractor run",
+    "ci:build:docs": "api-extractor run --config api-extractor/api-extractor-model.json",
     "clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.d.ts legacyAlpha.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --quiet --format stylish src",
     "eslint:fix": "eslint --quiet --format stylish src --fix --fix-type problem,suggestion,layout",
@@ -178,7 +160,6 @@
     "test:mocha:cjs": "cross-env FLUID_TEST_MODULE_SYSTEM=CJS 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/compactSnapshotParser.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { ArrayBufferLikeToArrayBuffer } from "@fluid-internal/client-utils";
 import { assert } from "@fluidframework/core-utils/internal";
 import type {
 	ISnapshot,
@@ -63,7 +64,10 @@ function readBlobSection(node: NodeTypes): {
 		) {
 			// "id": <node name>
 			// "data": <blob>
-			blobContents.set(blob.getString(1), blob.getBlob(3).arrayBuffer);
+			blobContents.set(
+				blob.getString(1),
+				ArrayBufferLikeToArrayBuffer(blob.getBlob(3).arrayBuffer),
+			);
 		} else {
 			/**
 			 * More generalized workflow
@@ -72,7 +76,7 @@ function readBlobSection(node: NodeTypes): {
 			const records = getNodeProps(blob);
 			assertBlobCoreInstance(records.data, "data should be of BlobCore type");
 			const id = getStringInstance(records.id, "blob id should be string");
-			blobContents.set(id, records.data.arrayBuffer);
+			blobContents.set(id, ArrayBufferLikeToArrayBuffer(records.data.arrayBuffer));
 		}
 	}
 	return { blobContents, slowBlobStructureCount };

package/src/createFile/createNewUtils.ts

@@ -3,7 +3,11 @@
  * Licensed under the MIT License.
  */
 
-import { Uint8ArrayToString, stringToBuffer } from "@fluid-internal/client-utils";
+import {
+	AnyUint8ArrayToArrayBuffer,
+	Uint8ArrayToString,
+	stringToBuffer,
+} from "@fluid-internal/client-utils";
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import {
 	type ISummaryBlob,
@@ -87,7 +91,7 @@ function convertCreateNewSummaryTreeToTreeAndBlobsCore(
 				const contentBuffer =
 					typeof summaryObject.content === "string"
 						? stringToBuffer(summaryObject.content, "utf8")
-						: summaryObject.content;
+						: AnyUint8ArrayToArrayBuffer(summaryObject.content);
 				const blobId = uuid();
 				treeNode.blobs[key] = blobId;
 				blobs.set(blobId, contentBuffer);

package/src/index.ts

@@ -28,7 +28,6 @@ export { prefetchLatestSnapshot } from "./prefetchLatestSnapshot.js";
 export {
 	createLocalOdspDocumentServiceFactory,
 	createOdspDocumentServiceFactory,
-	getOdspPointInTimeDocumentServiceFactory,
 	type IOdspDocumentServiceFactoryOptions,
 	OdspDocumentServiceFactory,
 } from "./odspDocumentServiceFactory.js";
@@ -77,4 +76,7 @@ export {
 } from "./compactSnapshotParser.js";
 
 // Layer Compat details
-export { odspDriverCompatDetailsForLoader } from "./odspLayerCompatState.js";
+export {
+	odspDriverCompatDetailsForLoader,
+	odspDriverCompatRequirementsForLoader,
+} from "./odspLayerCompatState.js";

package/src/odspDocumentServiceFactory.ts

@@ -102,40 +102,6 @@ export function createOdspDocumentServiceFactory(
 		options.hostPolicy,
 	);
 }
-
-/**
- * Creates an ODSP document service factory that supports point-in-time loading.
- *
- * @param getStorageToken - Fetches storage access tokens.
- * @param getWebsocketToken - Fetches websocket access tokens, or `undefined` when unavailable.
- * @param persistedCache - Optional persisted ODSP cache.
- * @param hostPolicy - Optional host storage policy.
- * @returns An ODSP document service factory with point-in-time loading capability.
- *
- * @deprecated Use
- * {@link createOdspDocumentServiceFactory} with a point-in-time implementation instead.
- * See {@link https://github.com/microsoft/FluidFramework/issues/26500} for context.
- *
- * @legacy @beta
- */
-export function getOdspPointInTimeDocumentServiceFactory(
-	getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,
-	getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined,
-	persistedCache?: IPersistedCache,
-	hostPolicy?: HostStoragePolicy,
-): IPointInTimeDocumentServiceFactory {
-	return createOdspDocumentServiceFactory({
-		getStorageToken,
-		getWebsocketToken,
-		persistedCache,
-		hostPolicy,
-		pointInTimeDocumentServiceImplementation: async (props) => {
-			const { createPointInTimeDocumentService } = await import("./pointInTime.js");
-			return createPointInTimeDocumentService(props);
-		},
-	}) as IPointInTimeDocumentServiceFactory;
-}
-
 /**
  * Creates a factory instance for creating a sharepoint document service from a provided snapshot.
  *

package/src/odspDocumentServiceFactoryCore.ts

@@ -41,7 +41,10 @@ import {
 	NonPersistentCache,
 } from "./odspCache.js";
 import { OdspDocumentService } from "./odspDocumentService.js";
-import { odspDriverCompatDetailsForLoader } from "./odspLayerCompatState.js";
+import {
+	odspDriverCompatDetailsForLoader,
+	odspDriverCompatRequirementsForLoader,
+} from "./odspLayerCompatState.js";
 import {
 	type IExistingFileInfo,
 	type INewFileInfo,
@@ -327,6 +330,17 @@ export class OdspDocumentServiceFactoryCore
 	 */
 	public readonly ILayerCompatDetails?: unknown = odspDriverCompatDetailsForLoader;
 
+	/**
+	 * The requirements that the Loader layer must meet to be compatible with this ODSP Driver. This is exposed to
+	 * the Loader layer so that it can validate Loader / Driver compatibility on this Driver's behalf (the Driver has
+	 * no reference to the Loader to validate it directly).
+	 * @remarks This is for internal use only.
+	 * The type of this should be ILayerCompatSupportRequirements. However, ILayerCompatSupportRequirements is
+	 * internal and this class is currently marked as legacy alpha. So, using unknown here.
+	 */
+	public readonly ILayerCompatSupportRequirements?: unknown =
+		odspDriverCompatRequirementsForLoader;
+
 	public async createDocumentService(
 		resolvedUrl: IResolvedUrl,
 		logger?: ITelemetryBaseLogger,

package/src/odspDocumentStorageManager.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { performanceNow } from "@fluid-internal/client-utils";
+import { ArrayBufferLikeToArrayBuffer, performanceNow } from "@fluid-internal/client-utils";
 import { LogLevel } from "@fluidframework/core-interfaces";
 import { assert, delay } from "@fluidframework/core-utils/internal";
 import { promiseRaceWithWinner } from "@fluidframework/driver-base/internal";
@@ -158,7 +158,7 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 						this.epochTracker.fetchAndParseAsJSON<ICreateBlobResponse>(
 							url,
 							{
-								body: file,
+								body: ArrayBufferLikeToArrayBuffer(file),
 								headers,
 								method,
 							},

package/src/odspLayerCompatState.ts

@@ -3,7 +3,12 @@
  * Licensed under the MIT License.
  */
 
-import { generation, type ILayerCompatDetails } from "@fluid-internal/client-utils";
+import {
+	generation,
+	LayerCompatibilityPolicyWindowMonths,
+	type ILayerCompatDetails,
+	type ILayerCompatSupportRequirements,
+} from "@fluid-internal/client-utils";
 
 import { pkgVersion } from "./packageVersion.js";
 
@@ -25,3 +30,26 @@ export const odspDriverCompatDetailsForLoader: ILayerCompatDetails = {
 	 */
 	supportedFeatures: new Set<string>(),
 };
+
+/**
+ * The requirements that the Loader layer must meet to be compatible with this ODSP Driver. This is published to
+ * the Loader layer (which holds the reference to this Driver) so that it can validate Loader / Driver compatibility
+ * on this Driver's behalf.
+ * @internal
+ */
+export const odspDriverCompatRequirementsForLoader: ILayerCompatSupportRequirements = {
+	/**
+	 * Minimum generation that Loader must be at to be compatible with this Driver. This is calculated based on the
+	 * LayerCompatibilityPolicyWindowMonths.NewDriverOldLoader value which defines how many months old can the Loader
+	 * layer be compared to the Driver layer for them to still be considered compatible.
+	 * The minimum valid generation value is 0.
+	 */
+	minSupportedGeneration: Math.max(
+		0,
+		generation - LayerCompatibilityPolicyWindowMonths.NewDriverOldLoader,
+	),
+	/**
+	 * The features that the Loader must support to be compatible with this Driver.
+	 */
+	requiredFeatures: [],
+};

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/odsp-driver";
-export const pkgVersion = "2.118.1";
+export const pkgVersion = "3.0.1";

package/src/pointInTimeDriver/createPointInTimeDocumentService.ts

@@ -165,12 +165,25 @@ export async function createPointInTimeDocumentServiceCore(
 		cacheAndTracker,
 		clientIsSummarizer,
 	);
-	const liveDocumentService = await createDocumentService(
-		resolvedUrl,
-		odspLogger,
-		cacheAndTracker,
-		clientIsSummarizer,
-	);
+	let liveDocumentService: IDocumentService;
+	try {
+		liveDocumentService = await createDocumentService(
+			resolvedUrl,
+			odspLogger,
+			cacheAndTracker,
+			clientIsSummarizer,
+		);
+	} catch (error) {
+		try {
+			recoverableDocumentService.dispose();
+		} catch (disposeError) {
+			extLogger.sendErrorEvent(
+				{ eventName: "PointInTimeRecoverableDocumentServiceDisposeError" },
+				disposeError,
+			);
+		}
+		throw error;
+	}
 	return new OdspPointInTimeDocumentService(
 		recoverableResolvedUrl,
 		recoverableDocumentService,

package/src/zipItDataRepresentationUtils.ts

@@ -8,7 +8,7 @@
  * https://microsoft.sharepoint-df.com/:w:/t/ODSPFileStore/ER06b64K_XdDjEyAKl-UT60BJiId39SCVkYSyo_2pvH9gQ?e=KYQ0c5
  */
 
-import { Uint8ArrayToArrayBuffer, Uint8ArrayToString } from "@fluid-internal/client-utils";
+import { Uint8ArrayToArrayBufferLike, Uint8ArrayToString } from "@fluid-internal/client-utils";
 import { assert } from "@fluidframework/core-utils/internal";
 import { NonRetryableError } from "@fluidframework/driver-utils/internal";
 import { OdspErrorTypes } from "@fluidframework/odsp-driver-definitions/internal";
@@ -186,7 +186,7 @@ class BlobDeepCopy extends BlobCore {
 	}
 
 	public get arrayBuffer(): ArrayBufferLike {
-		return Uint8ArrayToArrayBuffer(this.buffer);
+		return Uint8ArrayToArrayBufferLike(this.buffer);
 	}
 
 	public static read(buffer: ReadBuffer, lengthLen: number): BlobCore {
@@ -222,7 +222,7 @@ export class BlobShallowCopy extends BlobCore {
 		return this.data.subarray(this.start, this.end);
 	}
 
-	// Equivalent to Uint8ArrayToArrayBuffer(this.buffer)
+	// Equivalent to Uint8ArrayToArrayBufferLike(this.buffer)
 	public get arrayBuffer(): ArrayBufferLike {
 		const offset = this.data.byteOffset;
 		return this.data.buffer.slice(this.start + offset, this.end + offset);

package/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "../../../common/build/build-common/tsconfig.node16.json",
+	"extends": "../../../common/build/build-common/tsconfig.node20.json",
 	"include": ["src/**/*"],
 	"exclude": ["src/test/**/*"],
 	"compilerOptions": {

package/internal.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "./lib/index.js";

package/legacy/alpha.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "../lib/legacyAlpha.js";

package/legacy/point-in-time.d.ts

@@ -1,6 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-export * from "../lib/pointInTime.js";

package/legacy.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "./lib/legacy.js";