@fluid-internal/client-utils 2.118.1 → 3.0.1

package/src/indexBrowser.ts

@@ -6,9 +6,14 @@
 // Entrypoint for browser-specific code in the package.
 // (See 'Isomorphic Code' section in the package README.md.)
 
+// This export is needed for api-extractor compliance.
+export type { IsoBuffer as IsoBufferInterface } from "./buffer.js";
+export type {
+	IsoBufferConstructor,
+	IsoBufferEncoding,
+} from "./bufferBrowser.js";
 export {
 	bufferToString,
-	isArrayBuffer,
 	IsoBuffer,
 	stringToBuffer,
 	Uint8ArrayToString,
@@ -16,7 +21,11 @@ export {
 export { gitHashFile, hashFile } from "./hashFileBrowser.js";
 
 export { fromBase64ToUtf8, fromUtf8ToBase64, toUtf8 } from "./base64EncodingBrowser.js";
-export { Uint8ArrayToArrayBuffer } from "./bufferShared.js";
+export {
+	AnyUint8ArrayToArrayBuffer,
+	ArrayBufferLikeToArrayBuffer,
+	Uint8ArrayToArrayBufferLike,
+} from "./bufferShared.js";
 export { EventEmitter } from "./eventEmitter.cjs";
 export { performanceNow } from "./performanceIsomorphic.js";
 export { type ITraceEvent, Trace } from "./trace.js";
@@ -35,6 +44,8 @@ export {
 	type ILayerCompatDetails,
 	type IProvideLayerCompatDetails,
 	type ILayerCompatSupportRequirements,
+	type IProvideLayerCompatSupportRequirements,
+	defaultLayerCompatDetails,
 	LayerCompatibilityPolicyWindowMonths,
 } from "./layerCompat.js";
 export { generation } from "./layerGenerationState.js";

package/src/indexNode.ts

@@ -6,7 +6,12 @@
 // Entrypoint for Node.js-specific code in the package.
 // (See 'Isomorphic Code' section in the package README.md.)
 
-export { type Buffer } from "./bufferNode.js";
+export type { IsoBuffer as IsoBufferInterface } from "./buffer.js";
+export type {
+	Buffer,
+	IsoBufferConstructor,
+	IsoBufferEncoding,
+} from "./bufferNode.js";
 export {
 	bufferToString,
 	IsoBuffer,
@@ -16,7 +21,11 @@ export {
 export { gitHashFile, hashFile } from "./hashFileNode.js";
 
 export { fromBase64ToUtf8, fromUtf8ToBase64, toUtf8 } from "./base64EncodingNode.js";
-export { Uint8ArrayToArrayBuffer } from "./bufferShared.js";
+export {
+	AnyUint8ArrayToArrayBuffer,
+	ArrayBufferLikeToArrayBuffer,
+	Uint8ArrayToArrayBufferLike,
+} from "./bufferShared.js";
 export { EventEmitter } from "./eventEmitter.cjs";
 export { performanceNow } from "./performanceIsomorphic.js";
 export { type ITraceEvent, Trace } from "./trace.js";
@@ -35,6 +44,8 @@ export {
 	type ILayerCompatDetails,
 	type IProvideLayerCompatDetails,
 	type ILayerCompatSupportRequirements,
+	type IProvideLayerCompatSupportRequirements,
+	defaultLayerCompatDetails,
 	LayerCompatibilityPolicyWindowMonths,
 } from "./layerCompat.js";
 export { generation } from "./layerGenerationState.js";

package/src/layerCompat.ts

@@ -23,29 +23,29 @@ export type FluidLayer = "loader" | "driver" | "runtime" | "dataStore";
  */
 export const LayerCompatibilityPolicyWindowMonths = {
 	/**
-	 * Driver is compatible with Loader versions up to 12 months (or generations) older.
+	 * A newer Driver is compatible with Loader versions up to 12 months (or generations) older.
 	 */
-	DriverLoader: 12,
+	NewDriverOldLoader: 12,
 	/**
-	 * Loader is compatible with Driver versions up to 12 months (or generations) older.
+	 * A newer Loader is compatible with Driver versions up to 12 months (or generations) older.
 	 */
-	LoaderDriver: 12,
+	NewLoaderOldDriver: 12,
 	/**
-	 * Runtime is compatible with Loader versions up to 12 months (or generations) older.
+	 * A newer Runtime is compatible with Loader versions up to 12 months (or generations) older.
 	 */
-	RuntimeLoader: 12,
+	NewRuntimeOldLoader: 12,
 	/**
-	 * Loader is compatible with Runtime versions up to 3 months (or generations) older.
+	 * A newer Loader is compatible with Runtime versions up to 3 months (or generations) older.
 	 */
-	LoaderRuntime: 3,
+	NewLoaderOldRuntime: 3,
 	/**
-	 * Runtime is compatible with DataStore versions up to 3 months (or generations) older.
+	 * A newer Runtime is compatible with DataStore versions up to 3 months (or generations) older.
 	 */
-	RuntimeDataStore: 3,
+	NewRuntimeOldDataStore: 3,
 	/**
-	 * DataStore is compatible with Runtime versions up to 3 months (or generations) older.
+	 * A newer DataStore is compatible with Runtime versions up to 3 months (or generations) older.
 	 */
-	DataStoreRuntime: 3,
+	NewDataStoreOldRuntime: 3,
 } as const;
 
 /**
@@ -119,11 +119,39 @@ export const defaultLayerCompatDetails: ILayerCompatDetails = {
 	pkgVersion: "unknown",
 };
 
+/**
+ * Key used to look up {@link (ILayerCompatSupportRequirements:interface)} on a `FluidObject`.
+ * @internal
+ */
+export const ILayerCompatSupportRequirements: keyof IProvideLayerCompatSupportRequirements =
+	"ILayerCompatSupportRequirements";
+
+/**
+ * Provides {@link (ILayerCompatSupportRequirements:interface)} so that a layer can publish, as a `FluidObject`, the
+ * requirements another layer must meet to be compatible with it.
+ * @internal
+ */
+export interface IProvideLayerCompatSupportRequirements {
+	readonly ILayerCompatSupportRequirements: ILayerCompatSupportRequirements;
+}
+
 /**
  * The requirements that a layer needs another layer to support for them to be compatible.
+ *
+ * @remarks
+ * A layer can also publish its requirements across a boundary as a `FluidObject` (via
+ * {@link IProvideLayerCompatSupportRequirements}) for the case where this layer cannot run the compatibility
+ * validation itself and instead needs the layer on the other side of the boundary to check itself against the
+ * published requirements. Most boundaries are validated by both layers because each holds
+ * a reference to the other (e.g. the Loader and the Runtime). The Driver / Loader boundary is asymmetric: the
+ * Loader holds a reference to the Driver, but the Driver has no reference to the Loader and so cannot validate it.
+ * To still validate in both directions, the Driver publishes its requirements for the Loader and the Loader
+ * validates itself against them on the Driver's behalf.
+ *
  * @internal
  */
-export interface ILayerCompatSupportRequirements {
+export interface ILayerCompatSupportRequirements
+	extends Partial<IProvideLayerCompatSupportRequirements> {
 	/**
 	 * The minimum supported generation the other layer needs to be at.
 	 */

package/tsconfig.json

@@ -1,9 +1,8 @@
 {
-	"extends": "../../../common/build/build-common/tsconfig.node16.json",
+	"extends": "../../../common/build/build-common/tsconfig.node20.json",
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./lib",
-		"baseUrl": ".",
 		"noUncheckedIndexedAccess": false,
 	},
 	"include": ["src/**/*"],

package/webpack.playwright.cjs

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+const path = require("node:path");
+const webpack = require("webpack");
+
+module.exports = {
+	mode: "development",
+	devtool: "inline-source-map",
+	entry: "./lib/test/playwright/browserHash.js",
+	output: {
+		filename: "browserHash.bundle.js",
+		path: path.resolve(__dirname, "lib/test/playwright"),
+	},
+	plugins: [
+		new webpack.IgnorePlugin({
+			resourceRegExp: /^\.\/hashFileNode\.js$/,
+		}),
+	],
+};

package/jest-puppeteer.config.cjs

@@ -1,16 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	launch: {
-		args: ["--no-sandbox", "--disable-setuid-sandbox"], // https://github.com/puppeteer/puppeteer/blob/master/docs/troubleshooting.md#setting-up-chrome-linux-sandbox
-		dumpio: true, // output browser console to cmd line
-		// slowMo: 500, // slows down process for easier viewing
-
-		// Use chrome-headless-shell since some tests don't work as-is with the new headless mode.
-		// AB#7150: Remove this once we have fixed the tests.
-		headless: "shell",
-	},
-};

package/jest.config.cjs

@@ -1,21 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	preset: "jest-puppeteer",
-	reporters: [
-		"default",
-		[
-			"jest-junit",
-			{
-				outputDirectory: "nyc",
-				outputName: "jest-junit-report.xml",
-			},
-		],
-	],
-	// Only CJS is tested per use of `rewire` in gitHash.spec.ts.
-	testMatch: ["**/dist/test/jest/?(*.)+(spec|test).*js"],
-	testPathIgnorePatterns: ["/node_modules/"],
-};