@fluid-internal/client-utils 2.117.0 → 3.0.0

package/lib/layerCompat.d.ts

@@ -21,29 +21,29 @@ export type FluidLayer = "loader" | "driver" | "runtime" | "dataStore";
  */
 export declare 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.
      */
-    readonly DriverLoader: 12;
+    readonly 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.
      */
-    readonly LoaderDriver: 12;
+    readonly 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.
      */
-    readonly RuntimeLoader: 12;
+    readonly 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.
      */
-    readonly LoaderRuntime: 3;
+    readonly 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.
      */
-    readonly RuntimeDataStore: 3;
+    readonly 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.
      */
-    readonly DataStoreRuntime: 3;
+    readonly NewDataStoreOldRuntime: 3;
 };
 /**
  * Result of a layer compatibility check - whether a layer is compatible with another layer.
@@ -107,11 +107,35 @@ export interface ILayerCompatDetails extends Partial<IProvideLayerCompatDetails>
  * @internal
  */
 export declare const defaultLayerCompatDetails: ILayerCompatDetails;
+/**
+ * Key used to look up {@link (ILayerCompatSupportRequirements:interface)} on a `FluidObject`.
+ * @internal
+ */
+export declare const ILayerCompatSupportRequirements: keyof IProvideLayerCompatSupportRequirements;
+/**
+ * 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/lib/layerCompat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"layerCompat.d.ts","sourceRoot":"","sources":["../src/layerCompat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;AAEvE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oCAAoC;IAChD;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEM,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAC/B;IAAE,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAA;CAAE,GAC/B;IACA,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACzC;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;CAC3D,CAAC;AAEL;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BAAkD,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CAClD;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,OAAO,CAAC,0BAA0B,CAAC;IAC/E;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAChD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC5B;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,EAAE,mBAIvC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC/C;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;CAC7C;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACtC,+BAA+B,EAAE,+BAA+B,EAChE,mBAAmB,EAAE,mBAAmB,GAAG,SAAS,GAClD,sBAAsB,CA4BxB"}
+{"version":3,"file":"layerCompat.d.ts","sourceRoot":"","sources":["../src/layerCompat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;AAEvE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oCAAoC;IAChD;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEM,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAC/B;IAAE,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAA;CAAE,GAC/B;IACA,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACzC;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;CAC3D,CAAC;AAEL;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BAAkD,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CAClD;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,OAAO,CAAC,0BAA0B,CAAC;IAC/E;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAChD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC5B;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,EAAE,mBAIvC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,+BAA+B,EAAE,MAAM,sCAClB,CAAC;AAEnC;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACtD,QAAQ,CAAC,+BAA+B,EAAE,+BAA+B,CAAC;CAC1E;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,+BAChB,SAAQ,OAAO,CAAC,sCAAsC,CAAC;IACvD;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;CAC7C;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACtC,+BAA+B,EAAE,+BAA+B,EAChE,mBAAmB,EAAE,mBAAmB,GAAG,SAAS,GAClD,sBAAsB,CA4BxB"}

package/lib/layerCompat.js

@@ -16,29 +16,29 @@
  */
 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,
 };
 /**
  * @internal
@@ -54,6 +54,11 @@ export const defaultLayerCompatDetails = {
     generation: 0, // 0 is reserved for layers before compatibility enforcement was introduced.
     pkgVersion: "unknown",
 };
+/**
+ * Key used to look up {@link (ILayerCompatSupportRequirements:interface)} on a `FluidObject`.
+ * @internal
+ */
+export const ILayerCompatSupportRequirements = "ILayerCompatSupportRequirements";
 /**
  * Checks compatibility of a layer (layer1) with another layer (layer2).
  * @param compatSupportRequirementsLayer1 - The requirements from layer1 that layer2 needs to meet.

package/lib/layerCompat.js.map

@@ -1 +1 @@
-{"version":3,"file":"layerCompat.js","sourceRoot":"","sources":["../src/layerCompat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG;IACnD;;OAEG;IACH,YAAY,EAAE,EAAE;IAChB;;OAEG;IACH,YAAY,EAAE,EAAE;IAChB;;OAEG;IACH,aAAa,EAAE,EAAE;IACjB;;OAEG;IACH,aAAa,EAAE,CAAC;IAChB;;OAEG;IACH,gBAAgB,EAAE,CAAC;IACnB;;OAEG;IACH,gBAAgB,EAAE,CAAC;CACV,CAAC;AAqBX;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAqC,qBAAqB,CAAC;AAsC3F;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAwB;IAC7D,iBAAiB,EAAE,IAAI,GAAG,EAAE;IAC5B,UAAU,EAAE,CAAC,EAAE,4EAA4E;IAC3F,UAAU,EAAE,SAAS;CACrB,CAAC;AAiBF;;;;;;;;GAQG;AACH,MAAM,UAAU,uBAAuB,CACtC,+BAAgE,EAChE,mBAAoD;IAEpD,MAAM,wBAAwB,GAAG,mBAAmB,IAAI,yBAAyB,CAAC;IAClF,IAAI,sBAAsB,GAAG,IAAI,CAAC;IAClC,MAAM,mBAAmB,GAAa,EAAE,CAAC;IAEzC,2FAA2F;IAC3F,6BAA6B;IAC7B,IACC,wBAAwB,CAAC,UAAU;QACnC,+BAA+B,CAAC,sBAAsB,EACrD,CAAC;QACF,sBAAsB,GAAG,KAAK,CAAC;IAChC,CAAC;IAED,gFAAgF;IAChF,KAAK,MAAM,OAAO,IAAI,+BAA+B,CAAC,gBAAgB,EAAE,CAAC;QACxE,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9D,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC;IACF,CAAC;IAED,OAAO,sBAAsB,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC;QAChE,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE;QACxB,CAAC,CAAC;YACA,YAAY,EAAE,KAAK;YACnB,sBAAsB;YACtB,mBAAmB,EAAE,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS;SACrF,CAAC;AACL,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The different Fluid layers in a client.\n * @internal\n */\nexport type FluidLayer = \"loader\" | \"driver\" | \"runtime\" | \"dataStore\";\n\n/**\n * The policy for compatibility windows that a layer uses to validate compatibility with another layer.\n * The other layer must be within this window relative to the layer to be compatible.\n * Note that the policy is defined in terms of months, but the actual compatibility check is done using generations.\n * Generations are updated every 1+ months depending on the release cadence so they are mostly 1-to-1 with months,\n * but they are always higher than months since releases are not exactly every month.\n *\n * IMPORTANT: When changing these policy values, update the documentation in \"Layer Compatibility Policy\" section of\n * LayerCompatibility.md at the root of the repository.\n *\n * @internal\n */\nexport const LayerCompatibilityPolicyWindowMonths = {\n\t/**\n\t * Driver is compatible with Loader versions up to 12 months (or generations) older.\n\t */\n\tDriverLoader: 12,\n\t/**\n\t * Loader is compatible with Driver versions up to 12 months (or generations) older.\n\t */\n\tLoaderDriver: 12,\n\t/**\n\t * Runtime is compatible with Loader versions up to 12 months (or generations) older.\n\t */\n\tRuntimeLoader: 12,\n\t/**\n\t * Loader is compatible with Runtime versions up to 3 months (or generations) older.\n\t */\n\tLoaderRuntime: 3,\n\t/**\n\t * Runtime is compatible with DataStore versions up to 3 months (or generations) older.\n\t */\n\tRuntimeDataStore: 3,\n\t/**\n\t * DataStore is compatible with Runtime versions up to 3 months (or generations) older.\n\t */\n\tDataStoreRuntime: 3,\n} as const;\n\n/**\n * Result of a layer compatibility check - whether a layer is compatible with another layer.\n * @internal\n */\nexport type LayerCompatCheckResult =\n\t| { readonly isCompatible: true }\n\t| {\n\t\t\treadonly isCompatible: false;\n\t\t\t/**\n\t\t\t * Whether the generation of the layer is compatible with the other layer.\n\t\t\t */\n\t\t\treadonly isGenerationCompatible: boolean;\n\t\t\t/**\n\t\t\t * The features that are required by the layer but are not supported by the other layer. This will only\n\t\t\t * be set if there are unsupported features.\n\t\t\t */\n\t\t\treadonly unsupportedFeatures: readonly string[] | undefined;\n\t  };\n\n/**\n * @internal\n */\nexport const ILayerCompatDetails: keyof IProvideLayerCompatDetails = \"ILayerCompatDetails\";\n\n/**\n * @internal\n */\nexport interface IProvideLayerCompatDetails {\n\treadonly ILayerCompatDetails: ILayerCompatDetails;\n}\n\n/**\n * This interface is used to communicate the compatibility details of a layer to another layer.\n * @internal\n */\nexport interface ILayerCompatDetails extends Partial<IProvideLayerCompatDetails> {\n\t/**\n\t * A list of features supported by the layer at a particular layer boundary. This is used to check if these\n\t * set of features satisfy the requirements of another layer.\n\t */\n\treadonly supportedFeatures: ReadonlySet<string>;\n\t/**\n\t * The generation of the layer. The other layer at the layer boundary uses this to check if this satisfies\n\t * the minimum generation it requires to be compatible.\n\t *\n\t * @remarks Generation is updated on a regular cadence, say, monthly. This will allow us to determine how\n\t * far apart two layers are in terms of time and whether they are compatible.\n\t * For example, say generation is updated every month and the compatibility window between layer1 and layer2 is\n\t * 6 months. Now, if layer1 is at generation 1 and layer2 is at generation 5, then they are 4 months apart and are\n\t * compatible. But if layer1 is at generation 1 and layer2 is at generation 8, then they are 7 months apart and\n\t * are not compatible.\n\t */\n\treadonly generation: number;\n\t/**\n\t * The package version of the layer. When an incompatibility is detected, this is used to provide more context\n\t * on what the versions of the incompatible layers are.\n\t */\n\treadonly pkgVersion: string;\n}\n\n/**\n * This is the default compat details for a layer when it doesn't provide any compat details. This is used for\n * backwards compatibility to allow older layers to work before compatibility enforcement was introduced.\n * @internal\n */\nexport const defaultLayerCompatDetails: ILayerCompatDetails = {\n\tsupportedFeatures: new Set(),\n\tgeneration: 0, // 0 is reserved for layers before compatibility enforcement was introduced.\n\tpkgVersion: \"unknown\",\n};\n\n/**\n * The requirements that a layer needs another layer to support for them to be compatible.\n * @internal\n */\nexport interface ILayerCompatSupportRequirements {\n\t/**\n\t * The minimum supported generation the other layer needs to be at.\n\t */\n\treadonly minSupportedGeneration: number;\n\t/**\n\t * The features that the other layer needs to support.\n\t */\n\treadonly requiredFeatures: readonly string[];\n}\n\n/**\n * Checks compatibility of a layer (layer1) with another layer (layer2).\n * @param compatSupportRequirementsLayer1 - The requirements from layer1 that layer2 needs to meet.\n * @param compatDetailsLayer2 - The compatibility details of the layer2. If this is undefined, then the\n * default compatibility details are used for backwards compatibility.\n * @returns The result of the compatibility check indicating whether layer2 is compatible with layer1.\n *\n * @internal\n */\nexport function checkLayerCompatibility(\n\tcompatSupportRequirementsLayer1: ILayerCompatSupportRequirements,\n\tcompatDetailsLayer2: ILayerCompatDetails | undefined,\n): LayerCompatCheckResult {\n\tconst compatDetailsLayer2ToUse = compatDetailsLayer2 ?? defaultLayerCompatDetails;\n\tlet isGenerationCompatible = true;\n\tconst unsupportedFeatures: string[] = [];\n\n\t// If layer2's generation is less than the required minimum supported generation of layer1,\n\t// then it is not compatible.\n\tif (\n\t\tcompatDetailsLayer2ToUse.generation <\n\t\tcompatSupportRequirementsLayer1.minSupportedGeneration\n\t) {\n\t\tisGenerationCompatible = false;\n\t}\n\n\t// All features required by layer1 must be supported by layer2 to be compatible.\n\tfor (const feature of compatSupportRequirementsLayer1.requiredFeatures) {\n\t\tif (!compatDetailsLayer2ToUse.supportedFeatures.has(feature)) {\n\t\t\tunsupportedFeatures.push(feature);\n\t\t}\n\t}\n\n\treturn isGenerationCompatible && unsupportedFeatures.length === 0\n\t\t? { isCompatible: true }\n\t\t: {\n\t\t\t\tisCompatible: false,\n\t\t\t\tisGenerationCompatible,\n\t\t\t\tunsupportedFeatures: unsupportedFeatures.length > 0 ? unsupportedFeatures : undefined,\n\t\t\t};\n}\n"]}
+{"version":3,"file":"layerCompat.js","sourceRoot":"","sources":["../src/layerCompat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG;IACnD;;OAEG;IACH,kBAAkB,EAAE,EAAE;IACtB;;OAEG;IACH,kBAAkB,EAAE,EAAE;IACtB;;OAEG;IACH,mBAAmB,EAAE,EAAE;IACvB;;OAEG;IACH,mBAAmB,EAAE,CAAC;IACtB;;OAEG;IACH,sBAAsB,EAAE,CAAC;IACzB;;OAEG;IACH,sBAAsB,EAAE,CAAC;CAChB,CAAC;AAqBX;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAqC,qBAAqB,CAAC;AAsC3F;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAwB;IAC7D,iBAAiB,EAAE,IAAI,GAAG,EAAE;IAC5B,UAAU,EAAE,CAAC,EAAE,4EAA4E;IAC3F,UAAU,EAAE,SAAS;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAC3C,iCAAiC,CAAC;AAsCnC;;;;;;;;GAQG;AACH,MAAM,UAAU,uBAAuB,CACtC,+BAAgE,EAChE,mBAAoD;IAEpD,MAAM,wBAAwB,GAAG,mBAAmB,IAAI,yBAAyB,CAAC;IAClF,IAAI,sBAAsB,GAAG,IAAI,CAAC;IAClC,MAAM,mBAAmB,GAAa,EAAE,CAAC;IAEzC,2FAA2F;IAC3F,6BAA6B;IAC7B,IACC,wBAAwB,CAAC,UAAU;QACnC,+BAA+B,CAAC,sBAAsB,EACrD,CAAC;QACF,sBAAsB,GAAG,KAAK,CAAC;IAChC,CAAC;IAED,gFAAgF;IAChF,KAAK,MAAM,OAAO,IAAI,+BAA+B,CAAC,gBAAgB,EAAE,CAAC;QACxE,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9D,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC;IACF,CAAC;IAED,OAAO,sBAAsB,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC;QAChE,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE;QACxB,CAAC,CAAC;YACA,YAAY,EAAE,KAAK;YACnB,sBAAsB;YACtB,mBAAmB,EAAE,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS;SACrF,CAAC;AACL,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The different Fluid layers in a client.\n * @internal\n */\nexport type FluidLayer = \"loader\" | \"driver\" | \"runtime\" | \"dataStore\";\n\n/**\n * The policy for compatibility windows that a layer uses to validate compatibility with another layer.\n * The other layer must be within this window relative to the layer to be compatible.\n * Note that the policy is defined in terms of months, but the actual compatibility check is done using generations.\n * Generations are updated every 1+ months depending on the release cadence so they are mostly 1-to-1 with months,\n * but they are always higher than months since releases are not exactly every month.\n *\n * IMPORTANT: When changing these policy values, update the documentation in \"Layer Compatibility Policy\" section of\n * LayerCompatibility.md at the root of the repository.\n *\n * @internal\n */\nexport const LayerCompatibilityPolicyWindowMonths = {\n\t/**\n\t * A newer Driver is compatible with Loader versions up to 12 months (or generations) older.\n\t */\n\tNewDriverOldLoader: 12,\n\t/**\n\t * A newer Loader is compatible with Driver versions up to 12 months (or generations) older.\n\t */\n\tNewLoaderOldDriver: 12,\n\t/**\n\t * A newer Runtime is compatible with Loader versions up to 12 months (or generations) older.\n\t */\n\tNewRuntimeOldLoader: 12,\n\t/**\n\t * A newer Loader is compatible with Runtime versions up to 3 months (or generations) older.\n\t */\n\tNewLoaderOldRuntime: 3,\n\t/**\n\t * A newer Runtime is compatible with DataStore versions up to 3 months (or generations) older.\n\t */\n\tNewRuntimeOldDataStore: 3,\n\t/**\n\t * A newer DataStore is compatible with Runtime versions up to 3 months (or generations) older.\n\t */\n\tNewDataStoreOldRuntime: 3,\n} as const;\n\n/**\n * Result of a layer compatibility check - whether a layer is compatible with another layer.\n * @internal\n */\nexport type LayerCompatCheckResult =\n\t| { readonly isCompatible: true }\n\t| {\n\t\t\treadonly isCompatible: false;\n\t\t\t/**\n\t\t\t * Whether the generation of the layer is compatible with the other layer.\n\t\t\t */\n\t\t\treadonly isGenerationCompatible: boolean;\n\t\t\t/**\n\t\t\t * The features that are required by the layer but are not supported by the other layer. This will only\n\t\t\t * be set if there are unsupported features.\n\t\t\t */\n\t\t\treadonly unsupportedFeatures: readonly string[] | undefined;\n\t  };\n\n/**\n * @internal\n */\nexport const ILayerCompatDetails: keyof IProvideLayerCompatDetails = \"ILayerCompatDetails\";\n\n/**\n * @internal\n */\nexport interface IProvideLayerCompatDetails {\n\treadonly ILayerCompatDetails: ILayerCompatDetails;\n}\n\n/**\n * This interface is used to communicate the compatibility details of a layer to another layer.\n * @internal\n */\nexport interface ILayerCompatDetails extends Partial<IProvideLayerCompatDetails> {\n\t/**\n\t * A list of features supported by the layer at a particular layer boundary. This is used to check if these\n\t * set of features satisfy the requirements of another layer.\n\t */\n\treadonly supportedFeatures: ReadonlySet<string>;\n\t/**\n\t * The generation of the layer. The other layer at the layer boundary uses this to check if this satisfies\n\t * the minimum generation it requires to be compatible.\n\t *\n\t * @remarks Generation is updated on a regular cadence, say, monthly. This will allow us to determine how\n\t * far apart two layers are in terms of time and whether they are compatible.\n\t * For example, say generation is updated every month and the compatibility window between layer1 and layer2 is\n\t * 6 months. Now, if layer1 is at generation 1 and layer2 is at generation 5, then they are 4 months apart and are\n\t * compatible. But if layer1 is at generation 1 and layer2 is at generation 8, then they are 7 months apart and\n\t * are not compatible.\n\t */\n\treadonly generation: number;\n\t/**\n\t * The package version of the layer. When an incompatibility is detected, this is used to provide more context\n\t * on what the versions of the incompatible layers are.\n\t */\n\treadonly pkgVersion: string;\n}\n\n/**\n * This is the default compat details for a layer when it doesn't provide any compat details. This is used for\n * backwards compatibility to allow older layers to work before compatibility enforcement was introduced.\n * @internal\n */\nexport const defaultLayerCompatDetails: ILayerCompatDetails = {\n\tsupportedFeatures: new Set(),\n\tgeneration: 0, // 0 is reserved for layers before compatibility enforcement was introduced.\n\tpkgVersion: \"unknown\",\n};\n\n/**\n * Key used to look up {@link (ILayerCompatSupportRequirements:interface)} on a `FluidObject`.\n * @internal\n */\nexport const ILayerCompatSupportRequirements: keyof IProvideLayerCompatSupportRequirements =\n\t\"ILayerCompatSupportRequirements\";\n\n/**\n * Provides {@link (ILayerCompatSupportRequirements:interface)} so that a layer can publish, as a `FluidObject`, the\n * requirements another layer must meet to be compatible with it.\n * @internal\n */\nexport interface IProvideLayerCompatSupportRequirements {\n\treadonly ILayerCompatSupportRequirements: ILayerCompatSupportRequirements;\n}\n\n/**\n * The requirements that a layer needs another layer to support for them to be compatible.\n *\n * @remarks\n * A layer can also publish its requirements across a boundary as a `FluidObject` (via\n * {@link IProvideLayerCompatSupportRequirements}) for the case where this layer cannot run the compatibility\n * validation itself and instead needs the layer on the other side of the boundary to check itself against the\n * published requirements. Most boundaries are validated by both layers because each holds\n * a reference to the other (e.g. the Loader and the Runtime). The Driver / Loader boundary is asymmetric: the\n * Loader holds a reference to the Driver, but the Driver has no reference to the Loader and so cannot validate it.\n * To still validate in both directions, the Driver publishes its requirements for the Loader and the Loader\n * validates itself against them on the Driver's behalf.\n *\n * @internal\n */\nexport interface ILayerCompatSupportRequirements\n\textends Partial<IProvideLayerCompatSupportRequirements> {\n\t/**\n\t * The minimum supported generation the other layer needs to be at.\n\t */\n\treadonly minSupportedGeneration: number;\n\t/**\n\t * The features that the other layer needs to support.\n\t */\n\treadonly requiredFeatures: readonly string[];\n}\n\n/**\n * Checks compatibility of a layer (layer1) with another layer (layer2).\n * @param compatSupportRequirementsLayer1 - The requirements from layer1 that layer2 needs to meet.\n * @param compatDetailsLayer2 - The compatibility details of the layer2. If this is undefined, then the\n * default compatibility details are used for backwards compatibility.\n * @returns The result of the compatibility check indicating whether layer2 is compatible with layer1.\n *\n * @internal\n */\nexport function checkLayerCompatibility(\n\tcompatSupportRequirementsLayer1: ILayerCompatSupportRequirements,\n\tcompatDetailsLayer2: ILayerCompatDetails | undefined,\n): LayerCompatCheckResult {\n\tconst compatDetailsLayer2ToUse = compatDetailsLayer2 ?? defaultLayerCompatDetails;\n\tlet isGenerationCompatible = true;\n\tconst unsupportedFeatures: string[] = [];\n\n\t// If layer2's generation is less than the required minimum supported generation of layer1,\n\t// then it is not compatible.\n\tif (\n\t\tcompatDetailsLayer2ToUse.generation <\n\t\tcompatSupportRequirementsLayer1.minSupportedGeneration\n\t) {\n\t\tisGenerationCompatible = false;\n\t}\n\n\t// All features required by layer1 must be supported by layer2 to be compatible.\n\tfor (const feature of compatSupportRequirementsLayer1.requiredFeatures) {\n\t\tif (!compatDetailsLayer2ToUse.supportedFeatures.has(feature)) {\n\t\t\tunsupportedFeatures.push(feature);\n\t\t}\n\t}\n\n\treturn isGenerationCompatible && unsupportedFeatures.length === 0\n\t\t? { isCompatible: true }\n\t\t: {\n\t\t\t\tisCompatible: false,\n\t\t\t\tisGenerationCompatible,\n\t\t\t\tunsupportedFeatures: unsupportedFeatures.length > 0 ? unsupportedFeatures : undefined,\n\t\t\t};\n}\n"]}

package/lib/trace.js

@@ -10,10 +10,12 @@ import { performanceNow } from "./performanceIsomorphic.js";
  * @internal
  */
 export class Trace {
+    startTick;
     static start() {
         const startTick = performanceNow();
         return new Trace(startTick);
     }
+    lastTick;
     constructor(startTick) {
         this.startTick = startTick;
         this.lastTick = startTick;

package/lib/trace.js.map

@@ -1 +1 @@
-{"version":3,"file":"trace.js","sourceRoot":"","sources":["../src/trace.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,OAAO,KAAK;IACV,MAAM,CAAC,KAAK;QAClB,MAAM,SAAS,GAAG,cAAc,EAAE,CAAC;QACnC,OAAO,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAGD,YAAsC,SAAiB;QAAjB,cAAS,GAAT,SAAS,CAAQ;QACtD,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC3B,CAAC;IAEM,KAAK;QACX,MAAM,IAAI,GAAG,cAAc,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG;YACb,gBAAgB,EAAE,IAAI,GAAG,IAAI,CAAC,SAAS;YACvC,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAC,QAAQ;YAC9B,IAAI;SACJ,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,KAAK,CAAC;IACd,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { performanceNow } from \"./performanceIsomorphic.js\";\n\n/**\n * Helper class for tracing performance of events\n * Time measurements are in milliseconds as a floating point with a decimal\n *\n * @internal\n */\nexport class Trace {\n\tpublic static start(): Trace {\n\t\tconst startTick = performanceNow();\n\t\treturn new Trace(startTick);\n\t}\n\n\tprotected lastTick: number;\n\tprotected constructor(public readonly startTick: number) {\n\t\tthis.lastTick = startTick;\n\t}\n\n\tpublic trace(): ITraceEvent {\n\t\tconst tick = performanceNow();\n\t\tconst event = {\n\t\t\ttotalTimeElapsed: tick - this.startTick,\n\t\t\tduration: tick - this.lastTick,\n\t\t\ttick,\n\t\t};\n\t\tthis.lastTick = tick;\n\t\treturn event;\n\t}\n}\n\n/**\n * Event in a performance trace including time elapsed.\n *\n * @internal\n */\nexport interface ITraceEvent {\n\t/**\n\t * Total time elapsed since the start of the Trace.\n\t * Measured in milliseconds as a floating point with a decimal\n\t */\n\treadonly totalTimeElapsed: number;\n\t/**\n\t * Time elapsed since the last trace event.\n\t * Measured in milliseconds as a floating point with a decimal\n\t */\n\treadonly duration: number;\n\t/**\n\t * This number represents a relative time which should\n\t * be consistent for all trace ticks.\n\t */\n\treadonly tick: number;\n}\n"]}
+{"version":3,"file":"trace.js","sourceRoot":"","sources":["../src/trace.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,OAAO,KAAK;IAOqB;IAN/B,MAAM,CAAC,KAAK;QAClB,MAAM,SAAS,GAAG,cAAc,EAAE,CAAC;QACnC,OAAO,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAES,QAAQ,CAAS;IAC3B,YAAsC,SAAiB;QAAjB,cAAS,GAAT,SAAS,CAAQ;QACtD,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC3B,CAAC;IAEM,KAAK;QACX,MAAM,IAAI,GAAG,cAAc,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG;YACb,gBAAgB,EAAE,IAAI,GAAG,IAAI,CAAC,SAAS;YACvC,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAC,QAAQ;YAC9B,IAAI;SACJ,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,KAAK,CAAC;IACd,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { performanceNow } from \"./performanceIsomorphic.js\";\n\n/**\n * Helper class for tracing performance of events\n * Time measurements are in milliseconds as a floating point with a decimal\n *\n * @internal\n */\nexport class Trace {\n\tpublic static start(): Trace {\n\t\tconst startTick = performanceNow();\n\t\treturn new Trace(startTick);\n\t}\n\n\tprotected lastTick: number;\n\tprotected constructor(public readonly startTick: number) {\n\t\tthis.lastTick = startTick;\n\t}\n\n\tpublic trace(): ITraceEvent {\n\t\tconst tick = performanceNow();\n\t\tconst event = {\n\t\t\ttotalTimeElapsed: tick - this.startTick,\n\t\t\tduration: tick - this.lastTick,\n\t\t\ttick,\n\t\t};\n\t\tthis.lastTick = tick;\n\t\treturn event;\n\t}\n}\n\n/**\n * Event in a performance trace including time elapsed.\n *\n * @internal\n */\nexport interface ITraceEvent {\n\t/**\n\t * Total time elapsed since the start of the Trace.\n\t * Measured in milliseconds as a floating point with a decimal\n\t */\n\treadonly totalTimeElapsed: number;\n\t/**\n\t * Time elapsed since the last trace event.\n\t * Measured in milliseconds as a floating point with a decimal\n\t */\n\treadonly duration: number;\n\t/**\n\t * This number represents a relative time which should\n\t * be consistent for all trace ticks.\n\t */\n\treadonly tick: number;\n}\n"]}

package/lib/typedEventEmitter.js

@@ -20,5 +20,12 @@ export class TypedEventEmitter extends EventEmitter {
         this.removeListener = super.removeListener.bind(this);
         this.off = super.off.bind(this);
     }
+    addListener;
+    on;
+    once;
+    prependListener;
+    prependOnceListener;
+    removeListener;
+    off;
 }
 //# sourceMappingURL=typedEventEmitter.js.map

package/lib/typedEventEmitter.js.map

@@ -1 +1 @@
-{"version":3,"file":"typedEventEmitter.js","sourceRoot":"","sources":["../src/typedEventEmitter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AA8BlD;;;;;GAKG;AACH,MAAM,OAAO,iBACZ,SAAQ,YAAY;IAGpB;QACC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;QACrF,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;QACnE,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;QACvE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAGrD,CAAC;QACF,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAG7D,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;QAC3F,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;IACtE,CAAC;CAQD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tIEvent,\n\tIEventProvider,\n\tIEventTransformer,\n\tTransformedEvent,\n} from \"@fluidframework/core-interfaces\";\n\nimport { EventEmitter } from \"./eventEmitter.cjs\";\n\n/**\n * The event emitter polyfill and the node event emitter have different event types:\n * string | symbol vs. string | number\n *\n * The polyfill is now always used, but string is the only event type preferred.\n * @legacy @beta\n */\nexport type EventEmitterEventType = string;\n\n/**\n * @legacy @beta\n */\nexport type TypedEventTransform<TThis, TEvent> =\n\t// Event emitter supports some special events for the emitter itself to use\n\t// this exposes those events for the TypedEventEmitter.\n\t// Since we know what the shape of these events are, we can describe them directly via a TransformedEvent\n\t// which easier than trying to extend TEvent directly\n\tTransformedEvent<\n\t\tTThis,\n\t\t\"newListener\" | \"removeListener\",\n\t\tParameters<(event: string, listener: (...args: any[]) => void) => void>\n\t> &\n\t\t// Expose all the events provides by TEvent\n\t\tIEventTransformer<TThis, TEvent & IEvent> &\n\t\t// Add the default overload so this is covertable to EventEmitter regardless of environment\n\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\tTransformedEvent<TThis, EventEmitterEventType, any[]>;\n\n/**\n * Event Emitter helper class the supports emitting typed events.\n * @privateRemarks\n * This should become internal once the classes extending it become internal.\n * @legacy @beta\n */\nexport class TypedEventEmitter<TEvent>\n\textends EventEmitter\n\timplements IEventProvider<TEvent & IEvent>\n{\n\tpublic constructor() {\n\t\tsuper();\n\t\tthis.addListener = super.addListener.bind(this) as TypedEventTransform<this, TEvent>;\n\t\tthis.on = super.on.bind(this) as TypedEventTransform<this, TEvent>;\n\t\tthis.once = super.once.bind(this) as TypedEventTransform<this, TEvent>;\n\t\tthis.prependListener = super.prependListener.bind(this) as TypedEventTransform<\n\t\t\tthis,\n\t\t\tTEvent\n\t\t>;\n\t\tthis.prependOnceListener = super.prependOnceListener.bind(this) as TypedEventTransform<\n\t\t\tthis,\n\t\t\tTEvent\n\t\t>;\n\t\tthis.removeListener = super.removeListener.bind(this) as TypedEventTransform<this, TEvent>;\n\t\tthis.off = super.off.bind(this) as TypedEventTransform<this, TEvent>;\n\t}\n\tpublic readonly addListener: TypedEventTransform<this, TEvent>;\n\tpublic readonly on: TypedEventTransform<this, TEvent>;\n\tpublic readonly once: TypedEventTransform<this, TEvent>;\n\tpublic readonly prependListener: TypedEventTransform<this, TEvent>;\n\tpublic readonly prependOnceListener: TypedEventTransform<this, TEvent>;\n\tpublic readonly removeListener: TypedEventTransform<this, TEvent>;\n\tpublic readonly off: TypedEventTransform<this, TEvent>;\n}\n"]}
+{"version":3,"file":"typedEventEmitter.js","sourceRoot":"","sources":["../src/typedEventEmitter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AA8BlD;;;;;GAKG;AACH,MAAM,OAAO,iBACZ,SAAQ,YAAY;IAGpB;QACC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;QACrF,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;QACnE,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;QACvE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAGrD,CAAC;QACF,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAG7D,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;QAC3F,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;IACtE,CAAC;IACe,WAAW,CAAoC;IAC/C,EAAE,CAAoC;IACtC,IAAI,CAAoC;IACxC,eAAe,CAAoC;IACnD,mBAAmB,CAAoC;IACvD,cAAc,CAAoC;IAClD,GAAG,CAAoC;CACvD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tIEvent,\n\tIEventProvider,\n\tIEventTransformer,\n\tTransformedEvent,\n} from \"@fluidframework/core-interfaces\";\n\nimport { EventEmitter } from \"./eventEmitter.cjs\";\n\n/**\n * The event emitter polyfill and the node event emitter have different event types:\n * string | symbol vs. string | number\n *\n * The polyfill is now always used, but string is the only event type preferred.\n * @legacy @beta\n */\nexport type EventEmitterEventType = string;\n\n/**\n * @legacy @beta\n */\nexport type TypedEventTransform<TThis, TEvent> =\n\t// Event emitter supports some special events for the emitter itself to use\n\t// this exposes those events for the TypedEventEmitter.\n\t// Since we know what the shape of these events are, we can describe them directly via a TransformedEvent\n\t// which easier than trying to extend TEvent directly\n\tTransformedEvent<\n\t\tTThis,\n\t\t\"newListener\" | \"removeListener\",\n\t\tParameters<(event: string, listener: (...args: any[]) => void) => void>\n\t> &\n\t\t// Expose all the events provides by TEvent\n\t\tIEventTransformer<TThis, TEvent & IEvent> &\n\t\t// Add the default overload so this is covertable to EventEmitter regardless of environment\n\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\tTransformedEvent<TThis, EventEmitterEventType, any[]>;\n\n/**\n * Event Emitter helper class the supports emitting typed events.\n * @privateRemarks\n * This should become internal once the classes extending it become internal.\n * @legacy @beta\n */\nexport class TypedEventEmitter<TEvent>\n\textends EventEmitter\n\timplements IEventProvider<TEvent & IEvent>\n{\n\tpublic constructor() {\n\t\tsuper();\n\t\tthis.addListener = super.addListener.bind(this) as TypedEventTransform<this, TEvent>;\n\t\tthis.on = super.on.bind(this) as TypedEventTransform<this, TEvent>;\n\t\tthis.once = super.once.bind(this) as TypedEventTransform<this, TEvent>;\n\t\tthis.prependListener = super.prependListener.bind(this) as TypedEventTransform<\n\t\t\tthis,\n\t\t\tTEvent\n\t\t>;\n\t\tthis.prependOnceListener = super.prependOnceListener.bind(this) as TypedEventTransform<\n\t\t\tthis,\n\t\t\tTEvent\n\t\t>;\n\t\tthis.removeListener = super.removeListener.bind(this) as TypedEventTransform<this, TEvent>;\n\t\tthis.off = super.off.bind(this) as TypedEventTransform<this, TEvent>;\n\t}\n\tpublic readonly addListener: TypedEventTransform<this, TEvent>;\n\tpublic readonly on: TypedEventTransform<this, TEvent>;\n\tpublic readonly once: TypedEventTransform<this, TEvent>;\n\tpublic readonly prependListener: TypedEventTransform<this, TEvent>;\n\tpublic readonly prependOnceListener: TypedEventTransform<this, TEvent>;\n\tpublic readonly removeListener: TypedEventTransform<this, TEvent>;\n\tpublic readonly off: TypedEventTransform<this, TEvent>;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-internal/client-utils",
-  "version": "2.117.0",
+  "version": "3.0.0",
   "description": "Not intended for use outside the Fluid Framework.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,24 +15,12 @@
   "exports": {
     ".": {
       "node": {
-        "import": {
-          "types": "./lib/indexNode.d.ts",
-          "default": "./lib/indexNode.js"
-        },
-        "require": {
-          "types": "./dist/indexNode.d.ts",
-          "default": "./dist/indexNode.js"
-        }
+        "types": "./lib/indexNode.d.ts",
+        "default": "./lib/indexNode.js"
       },
       "default": {
-        "import": {
-          "types": "./lib/indexBrowser.d.ts",
-          "default": "./lib/indexBrowser.js"
-        },
-        "require": {
-          "types": "./dist/indexBrowser.d.ts",
-          "default": "./dist/indexBrowser.js"
-        }
+        "types": "./lib/indexBrowser.d.ts",
+        "default": "./lib/indexBrowser.js"
       }
     },
     "./internal-api-report/current": {
@@ -52,8 +40,6 @@
       }
     }
   },
-  "main": "lib/indexBrowser.js",
-  "types": "lib/indexBrowser.d.ts",
   "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -77,8 +63,8 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/core-interfaces": "~2.117.0",
-    "@fluidframework/core-utils": "~2.117.0",
+    "@fluidframework/core-interfaces": "~3.0.0",
+    "@fluidframework/core-utils": "~3.0.0",
     "@types/events_pkg": "npm:@types/events@^3.0.0",
     "base64-js": "^1.5.1",
     "buffer": "^6.0.3",
@@ -89,18 +75,15 @@
     "@arethetypeswrong/cli": "^0.18.5",
     "@biomejs/biome": "~2.4.5",
     "@fluid-internal/client-utils-previous": "npm:@fluid-internal/client-utils@2.116.0",
-    "@fluid-internal/mocha-test-setup": "~2.117.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",
     "@microsoft/api-extractor": "7.58.1",
-    "@types/base64-js": "^1.3.2",
-    "@types/jest": "29.5.3",
-    "@types/jest-environment-puppeteer": "~2.117.0",
+    "@playwright/test": "^1.62.1",
     "@types/mocha": "^10.0.10",
     "@types/node": "~22.19.17",
-    "@types/rewire": "^2.5.30",
     "@types/sha.js": "^2.4.4",
     "@types/sinon": "^17.0.3",
     "c8": "^10.1.3",
@@ -109,61 +92,60 @@
     "cross-env": "^10.1.0",
     "eslint": "~9.39.1",
     "eslint-config-prettier": "~10.1.8",
-    "jest": "^29.6.2",
-    "jest-environment-puppeteer": "^10.1.3",
-    "jest-junit": "^16.0.0",
-    "jest-puppeteer": "^10.1.3",
     "jiti": "^2.6.1",
     "mocha": "^11.7.5",
     "mocha-multi-reporters": "^1.5.1",
-    "puppeteer": "^23.6.0",
-    "rewire": "^9.0.1",
     "rimraf": "^6.1.3",
     "sinon": "^18.0.1",
-    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
-    "typescript": "~5.4.5"
+    "typescript": "~6.0.3",
+    "webpack": "^5.94.0",
+    "webpack-cli": "^5.1.4"
   },
   "fluidBuild": {
     "tasks": {
+      "eslint": [
+        "build:esm"
+      ],
       "build:api-reports:browser:current": [
-        "build:exports:browser"
+        "build:exports:browser",
+        "^build:api-reports"
       ],
       "build:api-reports:browser:legacy": [
-        "build:exports:browser"
+        "build:exports:browser",
+        "^build:api-reports"
       ],
       "build:api-reports:node:current": [
-        "build:api-reports:browser:current"
+        "build:api-reports:browser:current",
+        "^build:api-reports"
       ],
       "build:api-reports:node:legacy": [
-        "build:api-reports:browser:legacy"
+        "build:api-reports:browser:legacy",
+        "^build:api-reports"
       ],
       "build:exports:browser": [
-        "build:esnext"
+        "build:esm"
       ],
       "build:exports:node": [
-        "build:esnext"
-      ],
-      "build:test:jest": [
-        "tsc"
+        "build:esm"
       ],
       "build:test:mocha:cjs": [
-        "tsc"
+        "build:cjs"
       ],
       "build:test:mocha:esm": [
-        "build:esnext"
+        "build:esm"
       ],
       "build:test:types": [
-        "build:esnext"
+        "build:esm"
       ],
       "check:exports:bundle-release-tags": [
         "build:exports:browser"
       ],
       "check:exports:cjs:indexBrowser": [
-        "tsc"
+        "build:cjs"
       ],
       "check:exports:cjs:indexNode": [
-        "tsc"
+        "build:cjs"
       ],
       "check:exports:esm:browser:current": [
         "build:exports:browser"
@@ -172,7 +154,7 @@
         "build:exports:browser"
       ],
       "check:exports:esm:indexBrowser": [
-        "build:esnext"
+        "build:esm"
       ],
       "check:exports:esm:indexNode": [
         "build:exports:node"
@@ -184,16 +166,20 @@
         "build:exports:node"
       ],
       "ci:build:api-reports:browser:current": [
-        "build:exports:browser"
+        "build:exports:browser",
+        "^ci:build:api-reports"
       ],
       "ci:build:api-reports:browser:legacy": [
-        "build:exports:browser"
+        "build:exports:browser",
+        "^ci:build:api-reports"
       ],
       "ci:build:api-reports:node:current": [
-        "build:exports:node"
+        "build:exports:node",
+        "^ci:build:api-reports"
       ],
       "ci:build:api-reports:node:legacy": [
-        "build:exports:node"
+        "build:exports:node",
+        "^ci:build:api-reports"
       ],
       "test:mocha:cjs": [
         "build:test:mocha:cjs"
@@ -209,8 +195,24 @@
     "releasePkgVersion": "2.115.0"
   },
   "typeValidation": {
-    "broken": {},
-    "entrypoint": "public"
+    "broken": {
+      "Class_Buffer": {
+        "backCompat": false
+      },
+      "Function_Uint8ArrayToArrayBuffer": {
+        "backCompat": false
+      },
+      "TypeAlias_IsoBuffer": {
+        "backCompat": false
+      },
+      "Variable_IsoBuffer": {
+        "backCompat": false
+      },
+      "Variable_LayerCompatibilityPolicyWindowMonths": {
+        "backCompat": false
+      }
+    },
+    "entrypoint": ""
   },
   "scripts": {
     "build": "fluid-build . --task build",
@@ -219,19 +221,20 @@
     "build:api-reports:browser:legacy": "api-extractor run --local --config api-extractor/api-extractor-report-browser.legacy.json",
     "build:api-reports:node:current": "npm run ci:build:api-reports:node:current",
     "build:api-reports:node:legacy": "npm run ci:build:api-reports:node:legacy",
+    "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 --config api-extractor/api-extractor-model-browser.json",
-    "build:esnext": "tsc --project ./tsconfig.json",
+    "build:esm": "tsc --project ./tsconfig.json",
     "build:exports:browser": "flub generate entrypoints --outFileLegacyBeta legacy --outFilePrefix {@unscopedPackageName}.browser. --mainEntrypoint ./src/indexBrowser.ts --outDir ./lib",
     "build:exports:node": "flub generate entrypoints --outFileLegacyBeta legacy --outFilePrefix {@unscopedPackageName}.node. --mainEntrypoint ./src/indexNode.ts --outDir ./lib",
-    "build:test": "concurrently npm:build:test:mocha npm:build:test:jest npm:build:test:types",
-    "build:test:jest": "fluid-tsc commonjs --project ./src/test/jest/tsconfig.cjs.json",
+    "build:test": "concurrently npm:build:test:mocha npm:build:test:playwright npm:build:test:types",
     "build:test:mocha": "concurrently npm:build:test:mocha:esm npm:build:test:mocha:cjs",
     "build:test:mocha:cjs": "fluid-tsc commonjs --project ./src/test/mocha/tsconfig.cjs.json",
     "build:test:mocha:esm": "tsc --project ./src/test/mocha/tsconfig.json",
+    "build:test:playwright": "tsc --project ./src/test/playwright/tsconfig.json && webpack --config webpack.playwright.cjs",
     "build:test:types": "tsc --project ./src/test/types/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack . --exclude-entrypoints ./internal-api-report/current ./internal-api-report/legacy",
+    "check:are-the-types-wrong": "attw --pack . --profile esm-only --exclude-entrypoints ./internal-api-report/current ./internal-api-report/legacy",
     "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",
@@ -244,6 +247,7 @@
     "check:exports:esm:node:current": "api-extractor run --config api-extractor/api-extractor-lint-node.current.esm.json",
     "check:exports:esm:node:legacy": "api-extractor run --config api-extractor/api-extractor-lint-node.legacy.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:browser:current": "api-extractor run --config api-extractor/api-extractor-report-browser.current.json",
     "ci:build:api-reports:browser:legacy": "api-extractor run --config api-extractor/api-extractor-report-browser.legacy.json",
@@ -258,13 +262,12 @@
     "layerGeneration:gen": "flub generate compatLayerGeneration --dir . -v",
     "lint": "fluid-build . --task lint",
     "lint:fix": "fluid-build . --task eslint:fix --task format",
-    "test": "npm run test:mocha && npm run test:jest",
+    "test": "npm run test:mocha && npm run test:playwright",
     "test:coverage": "c8 npm test",
-    "test:jest": "jest --ci",
     "test:mocha": "npm run test:mocha:esm && npm run test:mocha:cjs",
     "test:mocha:cjs": "cross-env FLUID_TEST_MODULE_SYSTEM=CJS \"MOCHA_SPEC=dist/test/mocha/**/*.spec.*js\" mocha",
     "test:mocha:esm": "cross-env \"MOCHA_SPEC=lib/test/mocha/**/*.spec.*js\" mocha",
-    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
+    "test:playwright": "playwright test",
     "typetests:gen": "flub generate typetests --dir . -v"
   }
 }

package/playwright.config.ts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { defineConfig, devices } from "@playwright/test";
+
+export default defineConfig({
+	// Run against the built test output (matches the pattern used by mocha:esm tests).
+	testDir: "lib/test/playwright",
+	forbidOnly: !!process.env.CI,
+	retries: 0,
+	timeout: 60_000,
+	outputDir: "nyc/test-results",
+	reporter: [["list"], ["junit", { outputFile: "nyc/junit-report.xml" }]],
+	use: {
+		headless: true,
+		launchOptions: {
+			args: ["--no-sandbox", "--disable-setuid-sandbox"],
+		},
+	},
+	projects: [{ name: "chromium", use: { ...devices["Desktop Chrome"] } }],
+});

package/src/base64EncodingBrowser.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 
-// This file is a Node.js-specific implementation of the base64 encoding functions.
+import type { IsoBufferEncoding } from "./buffer.js";
+// This file is a browser-specific implementation of the base64 encoding functions.
 // Aside from the below import statement, this file should be identical to the
 // base64EncodingNode.ts.
 //
@@ -36,7 +37,7 @@ export const fromUtf8ToBase64 = (input: string): string =>
  *
  * @internal
  */
-export const toUtf8 = (input: string, encoding: string): string => {
+export const toUtf8 = (input: string, encoding: IsoBufferEncoding): string => {
 	switch (encoding) {
 		case "utf8":
 		// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged

package/src/base64EncodingNode.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import type { IsoBufferEncoding } from "./buffer.js";
 // This file is a Node.js-specific implementation of the base64 encoding functions.
 // Aside from the below import statement, this file should be identical to the
 // base64EncodingBrowser.ts.
@@ -36,7 +37,7 @@ export const fromUtf8ToBase64 = (input: string): string =>
  *
  * @internal
  */
-export const toUtf8 = (input: string, encoding: string): string => {
+export const toUtf8 = (input: string, encoding: IsoBufferEncoding): string => {
 	switch (encoding) {
 		case "utf8":
 		// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged