@fluidframework/local-driver 2.118.0 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/local-driver",
-  "version": "2.118.0",
+  "version": "3.0.0",
   "description": "Fluid local driver",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -13,48 +13,31 @@
   "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"
       }
     },
     "./alpha": {
-      "import": {
-        "types": "./lib/alpha.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/alpha.d.ts",
-        "default": "./dist/index.js"
+      "types": "./lib/alpha.d.ts",
+      "default": "./lib/index.js",
+      "internal-entrypoint-generation": {
+        "types": "./dist/alpha.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"
       }
     },
     "./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",
@@ -78,37 +61,37 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.118.0",
-    "@fluidframework/container-definitions": "~2.118.0",
-    "@fluidframework/container-loader": "~2.118.0",
-    "@fluidframework/container-runtime": "~2.118.0",
-    "@fluidframework/container-runtime-definitions": "~2.118.0",
-    "@fluidframework/core-interfaces": "~2.118.0",
-    "@fluidframework/core-utils": "~2.118.0",
-    "@fluidframework/driver-base": "~2.118.0",
-    "@fluidframework/driver-definitions": "~2.118.0",
-    "@fluidframework/driver-utils": "~2.118.0",
+    "@fluid-internal/client-utils": "~3.0.0",
+    "@fluidframework/container-definitions": "~3.0.0",
+    "@fluidframework/container-loader": "~3.0.0",
+    "@fluidframework/container-runtime": "~3.0.0",
+    "@fluidframework/container-runtime-definitions": "~3.0.0",
+    "@fluidframework/core-interfaces": "~3.0.0",
+    "@fluidframework/core-utils": "~3.0.0",
+    "@fluidframework/driver-base": "~3.0.0",
+    "@fluidframework/driver-definitions": "~3.0.0",
+    "@fluidframework/driver-utils": "~3.0.0",
     "@fluidframework/protocol-base": "^7.0.1",
-    "@fluidframework/routerlicious-driver": "~2.118.0",
-    "@fluidframework/runtime-utils": "~2.118.0",
+    "@fluidframework/routerlicious-driver": "~3.0.0",
+    "@fluidframework/runtime-utils": "~3.0.0",
     "@fluidframework/server-local-server": "^7.0.1",
     "@fluidframework/server-services-client": "^7.0.1",
     "@fluidframework/server-services-core": "^7.0.1",
     "@fluidframework/server-test-utils": "^7.0.1",
-    "@fluidframework/telemetry-utils": "~2.118.0",
+    "@fluidframework/telemetry-utils": "~3.0.0",
     "jsrsasign": "^11.1.1",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",
     "@biomejs/biome": "~2.4.5",
-    "@fluid-internal/mocha-test-setup": "~2.118.0",
+    "@fluid-internal/mocha-test-setup": "~3.0.0",
     "@fluid-tools/build-cli": "^0.67.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.67.0",
     "@fluidframework/eslint-config-fluid": "^14.0.0",
     "@fluidframework/local-driver-previous": "npm:@fluidframework/local-driver@2.116.0",
-    "@fluidframework/shared-object-base": "~2.118.0",
+    "@fluidframework/shared-object-base": "~3.0.0",
     "@microsoft/api-extractor": "7.58.1",
     "@types/jsrsasign": "^10.5.12",
     "@types/mocha": "^10.0.10",
@@ -123,7 +106,7 @@
     "mocha-multi-reporters": "^1.5.1",
     "rimraf": "^6.1.3",
     "socket.io-client": "^4.8.3",
-    "typescript": "~5.4.5"
+    "typescript": "~6.0.3"
   },
   "typeValidation": {
     "broken": {},
@@ -132,20 +115,21 @@
   "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: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 --outDir ./dist",
-    "build:entrypoints:esm": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat",
-    "build:esnext": "tsc --project ./tsconfig.json",
+    "build:entrypoints:esm": "flub generate entrypoints --outFileLegacyBeta legacy --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",
@@ -156,10 +140,11 @@
     "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
+    "check:types:inexactOptionalPropertyTypes": "tsc --project ./tsconfig.json --noEmit --exactOptionalPropertyTypes false --skipLibCheck --emitDeclarationOnly false --tsBuildInfoFile ./tsconfig.inexactOptionalPropertyTypes.tsbuildinfo",
     "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:docs": "api-extractor run",
+    "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:docs": "api-extractor run --config api-extractor/api-extractor-model.json",
     "clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.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",
@@ -173,7 +158,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/ephemeralService.ts

@@ -421,7 +421,7 @@ const containerRuntimeLoader: ContainerRuntimeLoader = async (
 		registry: parameters.registry,
 		provideEntryPoint: parameters.provideEntryPoint,
 		existing: parameters.existing,
-		minVersionForCollab: parameters.minVersionForCollab,
+		oldestSupportedClient: parameters.minVersionForCollab,
 		runtimeOptions: { enableRuntimeIdCompressor: "on" },
 	});
 	if (!parameters.existing) {

package/src/index.ts

@@ -9,7 +9,10 @@ export { createLocalDocumentService, LocalDocumentService } from "./localDocumen
 export { LocalDocumentServiceFactory } from "./localDocumentServiceFactory.js";
 export { LocalDocumentStorageService } from "./localDocumentStorageService.js";
 export { createLocalResolverCreateNewRequest, LocalResolver } from "./localResolver.js";
-export { localDriverCompatDetailsForLoader } from "./localLayerCompatState.js";
+export {
+	localDriverCompatDetailsForLoader,
+	localDriverCompatRequirementsForLoader,
+} from "./localLayerCompatState.js";
 export { LocalSessionStorageDbFactory } from "./localSessionStorageDb.js";
 export type {
 	EphemeralService,

package/src/localDocumentServiceFactory.ts

@@ -18,7 +18,10 @@ import type { ILocalDeltaConnectionServer } from "@fluidframework/server-local-s
 import { createDocument } from "./localCreateDocument.js";
 import type { LocalDocumentDeltaConnection } from "./localDocumentDeltaConnection.js";
 import { createLocalDocumentService } from "./localDocumentService.js";
-import { localDriverCompatDetailsForLoader } from "./localLayerCompatState.js";
+import {
+	localDriverCompatDetailsForLoader,
+	localDriverCompatRequirementsForLoader,
+} from "./localLayerCompatState.js";
 
 /**
  * Implementation of document service factory for local use.
@@ -47,6 +50,17 @@ export class LocalDocumentServiceFactory implements IDocumentServiceFactory {
 	 */
 	public readonly ILayerCompatDetails?: unknown = localDriverCompatDetailsForLoader;
 
+	/**
+	 * The requirements that the Loader layer must meet to be compatible with this Local 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 =
+		localDriverCompatRequirementsForLoader;
+
 	public async createContainer(
 		createNewSummary: ISummaryTree | undefined,
 		resolvedUrl: IResolvedUrl,

package/src/localDocumentStorageService.ts

@@ -3,7 +3,9 @@
  * Licensed under the MIT License.
  */
 
+import type { IsoBufferEncoding } from "@fluid-internal/client-utils";
 import {
+	ArrayBufferLikeToArrayBuffer,
 	IsoBuffer,
 	Uint8ArrayToString,
 	bufferToString,
@@ -150,7 +152,7 @@ export class LocalDocumentStorageService implements IDocumentStorageService {
 		const groupId = await this.readGroupId(tree);
 		if (groupId === undefined || loadingGroupIds.has(groupId)) {
 			for (const id of Object.values(tree.blobs)) {
-				blobContents.set(id, await this.readBlob(id));
+				blobContents.set(id, ArrayBufferLikeToArrayBuffer(await this.readBlob(id)));
 			}
 			await Promise.all(
 				Object.values(tree.trees).map(async (childTree) => {
@@ -204,7 +206,7 @@ export class LocalDocumentStorageService implements IDocumentStorageService {
 		// Collect blobsIds so that we can return blob contents only for these blobs.
 		if (groupIdInLoadingGroupIds || isChildOfAncestorWithGroupId) {
 			for (const id of Object.values(tree.blobs)) {
-				blobContents.set(id, await this.readBlob(id));
+				blobContents.set(id, ArrayBufferLikeToArrayBuffer(await this.readBlob(id)));
 			}
 		}
 		// Keep tree if it has a child that has a groupId that is in loadingGroupIds
@@ -291,7 +293,11 @@ export class LocalDocumentStorageService implements IDocumentStorageService {
 	public async readBlob(blobId: string): Promise<ArrayBufferLike> {
 		const blob = await this.manager.getBlob(blobId);
 		this.blobsShaCache.set(blob.sha, "");
-		const bufferContent = stringToBuffer(blob.content, blob.encoding);
+		// stringToBuffer has only ever reliably supported limited encodings.
+		// Despite server `IBlob.encoding` type being string, cast as one of
+		// the supported types and expect throw under browser if not.
+		// TODO: AB:#81373: Consider formalizing `IBlob.encoding` literals allowed.
+		const bufferContent = stringToBuffer(blob.content, blob.encoding as IsoBufferEncoding);
 		return bufferContent;
 	}
 

package/src/localLayerCompatState.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 localDriverCompatDetailsForLoader: ILayerCompatDetails = {
 	 */
 	supportedFeatures: new Set<string>(),
 };
+
+/**
+ * The requirements that the Loader layer must meet to be compatible with this Local 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 localDriverCompatRequirementsForLoader: 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/local-driver";
-export const pkgVersion = "2.118.0";
+export const pkgVersion = "3.0.0";

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/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 --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "./lib/alpha.js";

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 --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "./lib/index.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 --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "./lib/legacy.js";