@fluidframework/container-loader 2.118.1 → 3.0.1

package/dist/loaderLayerCompatState.d.ts

@@ -13,7 +13,7 @@ export declare const loaderCoreCompatDetails: {
     /**
      * The package version of the Loader layer.
      */
-    readonly pkgVersion: "2.118.1";
+    readonly pkgVersion: "3.0.1";
     /**
      * The current generation of the Loader layer.
      */
@@ -24,6 +24,11 @@ export declare const loaderCoreCompatDetails: {
  * @internal
  */
 export declare const loaderCompatDetailsForRuntime: ILayerCompatDetails;
+/**
+ * Loader's compatibility details that is validated against the Driver layer's requirements.
+ * @internal
+ */
+export declare const loaderCompatDetailsForDriver: ILayerCompatDetails;
 /**
  * The requirements that the Runtime layer must meet to be compatible with this Loader.
  * @internal
@@ -44,4 +49,23 @@ export declare function validateRuntimeCompatibility(maybeRuntimeCompatDetails:
  * @internal
  */
 export declare function validateDriverCompatibility(maybeDriverCompatDetails: ILayerCompatDetails | undefined, disposeFn: (error?: ICriticalContainerError) => void, mc: MonitoringContext): void;
+/**
+ * Validates that the Loader layer is compatible with the Driver.
+ *
+ * @remarks
+ * This is the reverse of {@link validateDriverCompatibility} and is intentionally a separate function because it
+ * does not follow the standard layer-validation pattern. Normally each layer validates the layer it holds a
+ * reference to - the Loader validates the Driver, the Runtime validates the Loader, and so on. The Driver, however,
+ * has no reference to the Loader and therefore cannot run this validation itself. To still enforce compatibility in
+ * both directions across the Driver / Loader boundary, the Driver publishes the requirements it has for the Loader
+ * (via ILayerCompatSupportRequirements) and the Loader validates itself against them here, on the Driver's behalf.
+ *
+ * @param maybeDriverCompatDetails - The Driver's compatibility details, used only to attribute the version /
+ * generation of the Driver in telemetry if the Loader is found to be incompatible.
+ * @param maybeDriverCompatRequirements - The requirements the Driver has for the Loader. Older Drivers may not
+ * publish these, in which case there is nothing to validate in this direction.
+ *
+ * @internal
+ */
+export declare function validateLoaderCompatibilityWithDriver(maybeDriverCompatDetails: ILayerCompatDetails | undefined, maybeDriverCompatRequirements: ILayerCompatSupportRequirements | undefined, disposeFn: (error?: ICriticalContainerError) => void, mc: MonitoringContext): void;
 //# sourceMappingURL=loaderLayerCompatState.d.ts.map

package/dist/loaderLayerCompatState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loaderLayerCompatState.d.ts","sourceRoot":"","sources":["../src/loaderLayerCompatState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGN,KAAK,mBAAmB,EACxB,KAAK,+BAA+B,EACpC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AACrF,OAAO,EAEN,KAAK,iBAAiB,EACtB,MAAM,0CAA0C,CAAC;AAIlD;;;GAGG;AACH,eAAO,MAAM,uBAAuB;IACnC;;OAEG;;IAEH;;OAEG;;CAEM,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,6BAA6B,EAAE,mBAM3C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mCAAmC,EAAE,+BAejD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kCAAkC,EAAE,+BAehD,CAAC;AAEF;;;GAGG;AACH,wBAAgB,4BAA4B,CAC3C,yBAAyB,EAAE,mBAAmB,GAAG,SAAS,EAC1D,EAAE,EAAE,iBAAiB,GACnB,IAAI,CAUN;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CAC1C,wBAAwB,EAAE,mBAAmB,GAAG,SAAS,EACzD,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,EACpD,EAAE,EAAE,iBAAiB,GACnB,IAAI,CAUN"}
+{"version":3,"file":"loaderLayerCompatState.d.ts","sourceRoot":"","sources":["../src/loaderLayerCompatState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAIN,KAAK,mBAAmB,EACxB,KAAK,+BAA+B,EACpC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AACrF,OAAO,EAEN,KAAK,iBAAiB,EACtB,MAAM,0CAA0C,CAAC;AAIlD;;;GAGG;AACH,eAAO,MAAM,uBAAuB;IACnC;;OAEG;;IAEH;;OAEG;;CAEM,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,6BAA6B,EAAE,mBAM3C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,4BAA4B,EAAE,mBAM1C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mCAAmC,EAAE,+BAgBjD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kCAAkC,EAAE,+BAgBhD,CAAC;AAEF;;;GAGG;AACH,wBAAgB,4BAA4B,CAC3C,yBAAyB,EAAE,mBAAmB,GAAG,SAAS,EAC1D,EAAE,EAAE,iBAAiB,GACnB,IAAI,CAgBN;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CAC1C,wBAAwB,EAAE,mBAAmB,GAAG,SAAS,EACzD,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,EACpD,EAAE,EAAE,iBAAiB,GACnB,IAAI,CAaN;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,qCAAqC,CACpD,wBAAwB,EAAE,mBAAmB,GAAG,SAAS,EACzD,6BAA6B,EAAE,+BAA+B,GAAG,SAAS,EAC1E,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,EACpD,EAAE,EAAE,iBAAiB,GACnB,IAAI,CAgBN"}

package/dist/loaderLayerCompatState.js

@@ -4,7 +4,10 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateDriverCompatibility = exports.validateRuntimeCompatibility = exports.driverSupportRequirementsForLoader = exports.runtimeSupportRequirementsForLoader = exports.loaderCompatDetailsForRuntime = exports.loaderCoreCompatDetails = void 0;
+exports.driverSupportRequirementsForLoader = exports.runtimeSupportRequirementsForLoader = exports.loaderCompatDetailsForDriver = exports.loaderCompatDetailsForRuntime = exports.loaderCoreCompatDetails = void 0;
+exports.validateRuntimeCompatibility = validateRuntimeCompatibility;
+exports.validateDriverCompatibility = validateDriverCompatibility;
+exports.validateLoaderCompatibilityWithDriver = validateLoaderCompatibilityWithDriver;
 const client_utils_1 = require("@fluid-internal/client-utils");
 const internal_1 = require("@fluidframework/telemetry-utils/internal");
 const packageVersion_js_1 = require("./packageVersion.js");
@@ -33,6 +36,17 @@ exports.loaderCompatDetailsForRuntime = {
      */
     supportedFeatures: new Set(),
 };
+/**
+ * Loader's compatibility details that is validated against the Driver layer's requirements.
+ * @internal
+ */
+exports.loaderCompatDetailsForDriver = {
+    ...exports.loaderCoreCompatDetails,
+    /**
+     * The features supported by the Loader layer across the Loader / Driver boundary.
+     */
+    supportedFeatures: new Set(),
+};
 /**
  * The requirements that the Runtime layer must meet to be compatible with this Loader.
  * @internal
@@ -40,11 +54,12 @@ exports.loaderCompatDetailsForRuntime = {
 exports.runtimeSupportRequirementsForLoader = {
     /**
      * Minimum generation that Runtime must be at to be compatible with this Loader. This is calculated
-     * based on the LayerCompatibilityPolicyWindowMonths.LoaderRuntime value which defines how many months old can
-     * the Runtime layer be compared to the Loader layer for them to still be considered compatible.
+     * based on the LayerCompatibilityPolicyWindowMonths.NewLoaderOldRuntime value which defines how many months
+     * old can the Runtime layer be compared to the Loader layer for them to still be considered compatible.
      * The minimum valid generation value is 0.
      */
-    minSupportedGeneration: Math.max(0, exports.loaderCoreCompatDetails.generation - client_utils_1.LayerCompatibilityPolicyWindowMonths.LoaderRuntime),
+    minSupportedGeneration: Math.max(0, exports.loaderCoreCompatDetails.generation -
+        client_utils_1.LayerCompatibilityPolicyWindowMonths.NewLoaderOldRuntime),
     /**
      * The features that the Runtime must support to be compatible with Loader.
      */
@@ -57,11 +72,12 @@ exports.runtimeSupportRequirementsForLoader = {
 exports.driverSupportRequirementsForLoader = {
     /**
      * Minimum generation that Driver must be at to be compatible with this Loader. This is calculated
-     * based on the LayerCompatibilityPolicyWindowMonths.LoaderDriver value which defines how many months old can
-     * the Driver layer be compared to the Loader layer for them to still be considered compatible.
+     * based on the LayerCompatibilityPolicyWindowMonths.NewLoaderOldDriver value which defines how many months
+     * old can the Driver layer be compared to the Loader layer for them to still be considered compatible.
      * The minimum valid generation value is 0.
      */
-    minSupportedGeneration: Math.max(0, exports.loaderCoreCompatDetails.generation - client_utils_1.LayerCompatibilityPolicyWindowMonths.LoaderDriver),
+    minSupportedGeneration: Math.max(0, exports.loaderCoreCompatDetails.generation -
+        client_utils_1.LayerCompatibilityPolicyWindowMonths.NewLoaderOldDriver),
     /**
      * The features that the Driver must support to be compatible with Loader.
      */
@@ -72,15 +88,67 @@ exports.driverSupportRequirementsForLoader = {
  * @internal
  */
 function validateRuntimeCompatibility(maybeRuntimeCompatDetails, mc) {
-    (0, internal_1.validateLayerCompatibility)("loader", "runtime", exports.loaderCompatDetailsForRuntime, exports.runtimeSupportRequirementsForLoader, maybeRuntimeCompatDetails, () => { } /* disposeFn - no op. This will be handled by the caller */, mc);
+    (0, internal_1.validateLayerCompatibility)(
+    /* validatingLayer */ {
+        layer: "loader",
+        packageInfo: exports.loaderCoreCompatDetails,
+        compatSupportRequirements: exports.runtimeSupportRequirementsForLoader,
+    }, 
+    /* targetLayer */ {
+        layer: "runtime",
+        compatDetails: maybeRuntimeCompatDetails,
+    }, {
+        disposeFn: () => { } /* no op. This will be handled by the caller */,
+        mc,
+    });
 }
-exports.validateRuntimeCompatibility = validateRuntimeCompatibility;
 /**
  * Validates that the Driver layer is compatible with the Loader.
  * @internal
  */
 function validateDriverCompatibility(maybeDriverCompatDetails, disposeFn, mc) {
-    (0, internal_1.validateLayerCompatibility)("loader", "driver", exports.loaderCompatDetailsForRuntime, exports.driverSupportRequirementsForLoader, maybeDriverCompatDetails, disposeFn, mc);
+    (0, internal_1.validateLayerCompatibility)(
+    /* validatingLayer */ {
+        layer: "loader",
+        packageInfo: exports.loaderCoreCompatDetails,
+        compatSupportRequirements: exports.driverSupportRequirementsForLoader,
+    }, 
+    /* targetLayer */ {
+        layer: "driver",
+        compatDetails: maybeDriverCompatDetails,
+    }, { disposeFn, mc });
+}
+/**
+ * Validates that the Loader layer is compatible with the Driver.
+ *
+ * @remarks
+ * This is the reverse of {@link validateDriverCompatibility} and is intentionally a separate function because it
+ * does not follow the standard layer-validation pattern. Normally each layer validates the layer it holds a
+ * reference to - the Loader validates the Driver, the Runtime validates the Loader, and so on. The Driver, however,
+ * has no reference to the Loader and therefore cannot run this validation itself. To still enforce compatibility in
+ * both directions across the Driver / Loader boundary, the Driver publishes the requirements it has for the Loader
+ * (via ILayerCompatSupportRequirements) and the Loader validates itself against them here, on the Driver's behalf.
+ *
+ * @param maybeDriverCompatDetails - The Driver's compatibility details, used only to attribute the version /
+ * generation of the Driver in telemetry if the Loader is found to be incompatible.
+ * @param maybeDriverCompatRequirements - The requirements the Driver has for the Loader. Older Drivers may not
+ * publish these, in which case there is nothing to validate in this direction.
+ *
+ * @internal
+ */
+function validateLoaderCompatibilityWithDriver(maybeDriverCompatDetails, maybeDriverCompatRequirements, disposeFn, mc) {
+    if (maybeDriverCompatRequirements === undefined) {
+        return;
+    }
+    (0, internal_1.validateLayerCompatibility)(
+    /* validatingLayer */ {
+        layer: "driver",
+        packageInfo: maybeDriverCompatDetails ?? client_utils_1.defaultLayerCompatDetails,
+        compatSupportRequirements: maybeDriverCompatRequirements,
+    }, 
+    /* targetLayer */ {
+        layer: "loader",
+        compatDetails: exports.loaderCompatDetailsForDriver,
+    }, { disposeFn, mc });
 }
-exports.validateDriverCompatibility = validateDriverCompatibility;
 //# sourceMappingURL=loaderLayerCompatState.js.map

package/dist/loaderLayerCompatState.js.map

@@ -1 +1 @@
-{"version":3,"file":"loaderLayerCompatState.js","sourceRoot":"","sources":["../src/loaderLayerCompatState.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAKsC;AAEtC,uEAGkD;AAElD,2DAAiD;AAEjD;;;GAGG;AACU,QAAA,uBAAuB,GAAG;IACtC;;OAEG;IACH,UAAU,EAAV,8BAAU;IACV;;OAEG;IACH,UAAU,EAAV,yBAAU;CACD,CAAC;AAEX;;;GAGG;AACU,QAAA,6BAA6B,GAAwB;IACjE,GAAG,+BAAuB;IAC1B;;OAEG;IACH,iBAAiB,EAAE,IAAI,GAAG,EAAU;CACpC,CAAC;AAEF;;;GAGG;AACU,QAAA,mCAAmC,GAAoC;IACnF;;;;;OAKG;IACH,sBAAsB,EAAE,IAAI,CAAC,GAAG,CAC/B,CAAC,EACD,+BAAuB,CAAC,UAAU,GAAG,mDAAoC,CAAC,aAAa,CACvF;IACD;;OAEG;IACH,gBAAgB,EAAE,EAAE;CACpB,CAAC;AAEF;;;GAGG;AACU,QAAA,kCAAkC,GAAoC;IAClF;;;;;OAKG;IACH,sBAAsB,EAAE,IAAI,CAAC,GAAG,CAC/B,CAAC,EACD,+BAAuB,CAAC,UAAU,GAAG,mDAAoC,CAAC,YAAY,CACtF;IACD;;OAEG;IACH,gBAAgB,EAAE,EAAE;CACpB,CAAC;AAEF;;;GAGG;AACH,SAAgB,4BAA4B,CAC3C,yBAA0D,EAC1D,EAAqB;IAErB,IAAA,qCAA0B,EACzB,QAAQ,EACR,SAAS,EACT,qCAA6B,EAC7B,2CAAmC,EACnC,yBAAyB,EACzB,GAAG,EAAE,GAAE,CAAC,CAAC,2DAA2D,EACpE,EAAE,CACF,CAAC;AACH,CAAC;AAbD,oEAaC;AAED;;;GAGG;AACH,SAAgB,2BAA2B,CAC1C,wBAAyD,EACzD,SAAoD,EACpD,EAAqB;IAErB,IAAA,qCAA0B,EACzB,QAAQ,EACR,QAAQ,EACR,qCAA6B,EAC7B,0CAAkC,EAClC,wBAAwB,EACxB,SAAS,EACT,EAAE,CACF,CAAC;AACH,CAAC;AAdD,kEAcC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tgeneration,\n\tLayerCompatibilityPolicyWindowMonths,\n\ttype ILayerCompatDetails,\n\ttype ILayerCompatSupportRequirements,\n} from \"@fluid-internal/client-utils\";\nimport type { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport {\n\tvalidateLayerCompatibility,\n\ttype MonitoringContext,\n} from \"@fluidframework/telemetry-utils/internal\";\n\nimport { pkgVersion } from \"./packageVersion.js\";\n\n/**\n * The core compatibility details of the Loader layer that is the same across all layer boundaries.\n * @internal\n */\nexport const loaderCoreCompatDetails = {\n\t/**\n\t * The package version of the Loader layer.\n\t */\n\tpkgVersion,\n\t/**\n\t * The current generation of the Loader layer.\n\t */\n\tgeneration,\n} as const;\n\n/**\n * Loader's compatibility details that is exposed to the Runtime layer.\n * @internal\n */\nexport const loaderCompatDetailsForRuntime: ILayerCompatDetails = {\n\t...loaderCoreCompatDetails,\n\t/**\n\t * The features supported by the Loader layer across the Loader / Runtime boundary.\n\t */\n\tsupportedFeatures: new Set<string>(),\n};\n\n/**\n * The requirements that the Runtime layer must meet to be compatible with this Loader.\n * @internal\n */\nexport const runtimeSupportRequirementsForLoader: ILayerCompatSupportRequirements = {\n\t/**\n\t * Minimum generation that Runtime must be at to be compatible with this Loader. This is calculated\n\t * based on the LayerCompatibilityPolicyWindowMonths.LoaderRuntime value which defines how many months old can\n\t * the Runtime layer be compared to the Loader layer for them to still be considered compatible.\n\t * The minimum valid generation value is 0.\n\t */\n\tminSupportedGeneration: Math.max(\n\t\t0,\n\t\tloaderCoreCompatDetails.generation - LayerCompatibilityPolicyWindowMonths.LoaderRuntime,\n\t),\n\t/**\n\t * The features that the Runtime must support to be compatible with Loader.\n\t */\n\trequiredFeatures: [],\n};\n\n/**\n * The requirements that the Driver layer must meet to be compatible with this Loader.\n * @internal\n */\nexport const driverSupportRequirementsForLoader: ILayerCompatSupportRequirements = {\n\t/**\n\t * Minimum generation that Driver must be at to be compatible with this Loader. This is calculated\n\t * based on the LayerCompatibilityPolicyWindowMonths.LoaderDriver value which defines how many months old can\n\t * the Driver layer be compared to the Loader layer for them to still be considered compatible.\n\t * The minimum valid generation value is 0.\n\t */\n\tminSupportedGeneration: Math.max(\n\t\t0,\n\t\tloaderCoreCompatDetails.generation - LayerCompatibilityPolicyWindowMonths.LoaderDriver,\n\t),\n\t/**\n\t * The features that the Driver must support to be compatible with Loader.\n\t */\n\trequiredFeatures: [],\n};\n\n/**\n * Validates that the Runtime layer is compatible with the Loader. *\n * @internal\n */\nexport function validateRuntimeCompatibility(\n\tmaybeRuntimeCompatDetails: ILayerCompatDetails | undefined,\n\tmc: MonitoringContext,\n): void {\n\tvalidateLayerCompatibility(\n\t\t\"loader\",\n\t\t\"runtime\",\n\t\tloaderCompatDetailsForRuntime,\n\t\truntimeSupportRequirementsForLoader,\n\t\tmaybeRuntimeCompatDetails,\n\t\t() => {} /* disposeFn - no op. This will be handled by the caller */,\n\t\tmc,\n\t);\n}\n\n/**\n * Validates that the Driver layer is compatible with the Loader.\n * @internal\n */\nexport function validateDriverCompatibility(\n\tmaybeDriverCompatDetails: ILayerCompatDetails | undefined,\n\tdisposeFn: (error?: ICriticalContainerError) => void,\n\tmc: MonitoringContext,\n): void {\n\tvalidateLayerCompatibility(\n\t\t\"loader\",\n\t\t\"driver\",\n\t\tloaderCompatDetailsForRuntime,\n\t\tdriverSupportRequirementsForLoader,\n\t\tmaybeDriverCompatDetails,\n\t\tdisposeFn,\n\t\tmc,\n\t);\n}\n"]}
+{"version":3,"file":"loaderLayerCompatState.js","sourceRoot":"","sources":["../src/loaderLayerCompatState.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAwGH,oEAmBC;AAMD,kEAiBC;AAoBD,sFAqBC;AAzLD,+DAMsC;AAEtC,uEAGkD;AAElD,2DAAiD;AAEjD;;;GAGG;AACU,QAAA,uBAAuB,GAAG;IACtC;;OAEG;IACH,UAAU,EAAV,8BAAU;IACV;;OAEG;IACH,UAAU,EAAV,yBAAU;CACD,CAAC;AAEX;;;GAGG;AACU,QAAA,6BAA6B,GAAwB;IACjE,GAAG,+BAAuB;IAC1B;;OAEG;IACH,iBAAiB,EAAE,IAAI,GAAG,EAAU;CACpC,CAAC;AAEF;;;GAGG;AACU,QAAA,4BAA4B,GAAwB;IAChE,GAAG,+BAAuB;IAC1B;;OAEG;IACH,iBAAiB,EAAE,IAAI,GAAG,EAAU;CACpC,CAAC;AAEF;;;GAGG;AACU,QAAA,mCAAmC,GAAoC;IACnF;;;;;OAKG;IACH,sBAAsB,EAAE,IAAI,CAAC,GAAG,CAC/B,CAAC,EACD,+BAAuB,CAAC,UAAU;QACjC,mDAAoC,CAAC,mBAAmB,CACzD;IACD;;OAEG;IACH,gBAAgB,EAAE,EAAE;CACpB,CAAC;AAEF;;;GAGG;AACU,QAAA,kCAAkC,GAAoC;IAClF;;;;;OAKG;IACH,sBAAsB,EAAE,IAAI,CAAC,GAAG,CAC/B,CAAC,EACD,+BAAuB,CAAC,UAAU;QACjC,mDAAoC,CAAC,kBAAkB,CACxD;IACD;;OAEG;IACH,gBAAgB,EAAE,EAAE;CACpB,CAAC;AAEF;;;GAGG;AACH,SAAgB,4BAA4B,CAC3C,yBAA0D,EAC1D,EAAqB;IAErB,IAAA,qCAA0B;IACzB,qBAAqB,CAAC;QACrB,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,+BAAuB;QACpC,yBAAyB,EAAE,2CAAmC;KAC9D;IACD,iBAAiB,CAAC;QACjB,KAAK,EAAE,SAAS;QAChB,aAAa,EAAE,yBAAyB;KACxC,EACD;QACC,SAAS,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,+CAA+C;QACnE,EAAE;KACF,CACD,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,2BAA2B,CAC1C,wBAAyD,EACzD,SAAoD,EACpD,EAAqB;IAErB,IAAA,qCAA0B;IACzB,qBAAqB,CAAC;QACrB,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,+BAAuB;QACpC,yBAAyB,EAAE,0CAAkC;KAC7D;IACD,iBAAiB,CAAC;QACjB,KAAK,EAAE,QAAQ;QACf,aAAa,EAAE,wBAAwB;KACvC,EACD,EAAE,SAAS,EAAE,EAAE,EAAE,CACjB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,qCAAqC,CACpD,wBAAyD,EACzD,6BAA0E,EAC1E,SAAoD,EACpD,EAAqB;IAErB,IAAI,6BAA6B,KAAK,SAAS,EAAE,CAAC;QACjD,OAAO;IACR,CAAC;IACD,IAAA,qCAA0B;IACzB,qBAAqB,CAAC;QACrB,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,wBAAwB,IAAI,wCAAyB;QAClE,yBAAyB,EAAE,6BAA6B;KACxD;IACD,iBAAiB,CAAC;QACjB,KAAK,EAAE,QAAQ;QACf,aAAa,EAAE,oCAA4B;KAC3C,EACD,EAAE,SAAS,EAAE,EAAE,EAAE,CACjB,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tgeneration,\n\tdefaultLayerCompatDetails,\n\tLayerCompatibilityPolicyWindowMonths,\n\ttype ILayerCompatDetails,\n\ttype ILayerCompatSupportRequirements,\n} from \"@fluid-internal/client-utils\";\nimport type { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport {\n\tvalidateLayerCompatibility,\n\ttype MonitoringContext,\n} from \"@fluidframework/telemetry-utils/internal\";\n\nimport { pkgVersion } from \"./packageVersion.js\";\n\n/**\n * The core compatibility details of the Loader layer that is the same across all layer boundaries.\n * @internal\n */\nexport const loaderCoreCompatDetails = {\n\t/**\n\t * The package version of the Loader layer.\n\t */\n\tpkgVersion,\n\t/**\n\t * The current generation of the Loader layer.\n\t */\n\tgeneration,\n} as const;\n\n/**\n * Loader's compatibility details that is exposed to the Runtime layer.\n * @internal\n */\nexport const loaderCompatDetailsForRuntime: ILayerCompatDetails = {\n\t...loaderCoreCompatDetails,\n\t/**\n\t * The features supported by the Loader layer across the Loader / Runtime boundary.\n\t */\n\tsupportedFeatures: new Set<string>(),\n};\n\n/**\n * Loader's compatibility details that is validated against the Driver layer's requirements.\n * @internal\n */\nexport const loaderCompatDetailsForDriver: ILayerCompatDetails = {\n\t...loaderCoreCompatDetails,\n\t/**\n\t * The features supported by the Loader layer across the Loader / Driver boundary.\n\t */\n\tsupportedFeatures: new Set<string>(),\n};\n\n/**\n * The requirements that the Runtime layer must meet to be compatible with this Loader.\n * @internal\n */\nexport const runtimeSupportRequirementsForLoader: ILayerCompatSupportRequirements = {\n\t/**\n\t * Minimum generation that Runtime must be at to be compatible with this Loader. This is calculated\n\t * based on the LayerCompatibilityPolicyWindowMonths.NewLoaderOldRuntime value which defines how many months\n\t * old can the Runtime layer be compared to the Loader layer for them to still be considered compatible.\n\t * The minimum valid generation value is 0.\n\t */\n\tminSupportedGeneration: Math.max(\n\t\t0,\n\t\tloaderCoreCompatDetails.generation -\n\t\t\tLayerCompatibilityPolicyWindowMonths.NewLoaderOldRuntime,\n\t),\n\t/**\n\t * The features that the Runtime must support to be compatible with Loader.\n\t */\n\trequiredFeatures: [],\n};\n\n/**\n * The requirements that the Driver layer must meet to be compatible with this Loader.\n * @internal\n */\nexport const driverSupportRequirementsForLoader: ILayerCompatSupportRequirements = {\n\t/**\n\t * Minimum generation that Driver must be at to be compatible with this Loader. This is calculated\n\t * based on the LayerCompatibilityPolicyWindowMonths.NewLoaderOldDriver value which defines how many months\n\t * old can the Driver layer be compared to the Loader layer for them to still be considered compatible.\n\t * The minimum valid generation value is 0.\n\t */\n\tminSupportedGeneration: Math.max(\n\t\t0,\n\t\tloaderCoreCompatDetails.generation -\n\t\t\tLayerCompatibilityPolicyWindowMonths.NewLoaderOldDriver,\n\t),\n\t/**\n\t * The features that the Driver must support to be compatible with Loader.\n\t */\n\trequiredFeatures: [],\n};\n\n/**\n * Validates that the Runtime layer is compatible with the Loader. *\n * @internal\n */\nexport function validateRuntimeCompatibility(\n\tmaybeRuntimeCompatDetails: ILayerCompatDetails | undefined,\n\tmc: MonitoringContext,\n): void {\n\tvalidateLayerCompatibility(\n\t\t/* validatingLayer */ {\n\t\t\tlayer: \"loader\",\n\t\t\tpackageInfo: loaderCoreCompatDetails,\n\t\t\tcompatSupportRequirements: runtimeSupportRequirementsForLoader,\n\t\t},\n\t\t/* targetLayer */ {\n\t\t\tlayer: \"runtime\",\n\t\t\tcompatDetails: maybeRuntimeCompatDetails,\n\t\t},\n\t\t{\n\t\t\tdisposeFn: () => {} /* no op. This will be handled by the caller */,\n\t\t\tmc,\n\t\t},\n\t);\n}\n\n/**\n * Validates that the Driver layer is compatible with the Loader.\n * @internal\n */\nexport function validateDriverCompatibility(\n\tmaybeDriverCompatDetails: ILayerCompatDetails | undefined,\n\tdisposeFn: (error?: ICriticalContainerError) => void,\n\tmc: MonitoringContext,\n): void {\n\tvalidateLayerCompatibility(\n\t\t/* validatingLayer */ {\n\t\t\tlayer: \"loader\",\n\t\t\tpackageInfo: loaderCoreCompatDetails,\n\t\t\tcompatSupportRequirements: driverSupportRequirementsForLoader,\n\t\t},\n\t\t/* targetLayer */ {\n\t\t\tlayer: \"driver\",\n\t\t\tcompatDetails: maybeDriverCompatDetails,\n\t\t},\n\t\t{ disposeFn, mc },\n\t);\n}\n\n/**\n * Validates that the Loader layer is compatible with the Driver.\n *\n * @remarks\n * This is the reverse of {@link validateDriverCompatibility} and is intentionally a separate function because it\n * does not follow the standard layer-validation pattern. Normally each layer validates the layer it holds a\n * reference to - the Loader validates the Driver, the Runtime validates the Loader, and so on. The Driver, however,\n * has no reference to the Loader and therefore cannot run this validation itself. To still enforce compatibility in\n * both directions across the Driver / Loader boundary, the Driver publishes the requirements it has for the Loader\n * (via ILayerCompatSupportRequirements) and the Loader validates itself against them here, on the Driver's behalf.\n *\n * @param maybeDriverCompatDetails - The Driver's compatibility details, used only to attribute the version /\n * generation of the Driver in telemetry if the Loader is found to be incompatible.\n * @param maybeDriverCompatRequirements - The requirements the Driver has for the Loader. Older Drivers may not\n * publish these, in which case there is nothing to validate in this direction.\n *\n * @internal\n */\nexport function validateLoaderCompatibilityWithDriver(\n\tmaybeDriverCompatDetails: ILayerCompatDetails | undefined,\n\tmaybeDriverCompatRequirements: ILayerCompatSupportRequirements | undefined,\n\tdisposeFn: (error?: ICriticalContainerError) => void,\n\tmc: MonitoringContext,\n): void {\n\tif (maybeDriverCompatRequirements === undefined) {\n\t\treturn;\n\t}\n\tvalidateLayerCompatibility(\n\t\t/* validatingLayer */ {\n\t\t\tlayer: \"driver\",\n\t\t\tpackageInfo: maybeDriverCompatDetails ?? defaultLayerCompatDetails,\n\t\t\tcompatSupportRequirements: maybeDriverCompatRequirements,\n\t\t},\n\t\t/* targetLayer */ {\n\t\t\tlayer: \"loader\",\n\t\t\tcompatDetails: loaderCompatDetailsForDriver,\n\t\t},\n\t\t{ disposeFn, mc },\n\t);\n}\n"]}

package/dist/location-redirection-utilities/resolveWithLocationRedirection.js

@@ -4,7 +4,8 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveWithLocationRedirectionHandling = exports.isLocationRedirectionError = void 0;
+exports.isLocationRedirectionError = isLocationRedirectionError;
+exports.resolveWithLocationRedirectionHandling = resolveWithLocationRedirectionHandling;
 const internal_1 = require("@fluidframework/driver-definitions/internal");
 const internal_2 = require("@fluidframework/telemetry-utils/internal");
 /**
@@ -19,7 +20,6 @@ function isLocationRedirectionError(error) {
         error.errorType ===
             internal_1.DriverErrorTypes.locationRedirection);
 }
-exports.isLocationRedirectionError = isLocationRedirectionError;
 /**
  * Handles location redirection while fulfilling the loader request.
  * @param api - Callback in which user can wrap the loader.resolve or loader.request call.
@@ -51,5 +51,4 @@ async function resolveWithLocationRedirectionHandling(api, request, urlResolver,
         }
     }
 }
-exports.resolveWithLocationRedirectionHandling = resolveWithLocationRedirectionHandling;
 //# sourceMappingURL=resolveWithLocationRedirection.js.map

package/dist/location-redirection-utilities/resolveWithLocationRedirection.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolveWithLocationRedirection.js","sourceRoot":"","sources":["../../src/location-redirection-utilities/resolveWithLocationRedirection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,0EAIqD;AACrD,uEAA6E;AAE7E;;;;;GAKG;AACH,SAAgB,0BAA0B,CACzC,KAAc;IAEd,OAAO,CACN,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACb,KAA4C,CAAC,SAAS;YACtD,2BAAgB,CAAC,mBAAmB,CACrC,CAAC;AACH,CAAC;AATD,gEASC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,sCAAsC,CAC3D,GAAsC,EACtC,OAAiB,EACjB,WAAyB,EACzB,MAA6B;IAE7B,IAAI,GAAG,GAAa,OAAO,CAAC;IAC5B,MAAM,WAAW,GAAG,IAAA,4BAAiB,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,qBAAqB,EAAE,CAAC,CAAC;IACpF,SAAS,CAAC;QACT,IAAI,CAAC;YACJ,OAAO,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACzB,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxC,MAAM,KAAK,CAAC;YACb,CAAC;YACD,WAAW,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,CAAC,CAAC;YAC1E,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;YACtC,yGAAyG;YACzG,kGAAkG;YAClG,oCAAoC;YACpC,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,cAAc,CAAC,WAAW,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;YACjF,GAAG,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC;QAClD,CAAC;IACF,CAAC;AACF,CAAC;AAxBD,wFAwBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IRequest, ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport {\n\ttype ILocationRedirectionError,\n\ttype IUrlResolver,\n\tDriverErrorTypes,\n} from \"@fluidframework/driver-definitions/internal\";\nimport { createChildLogger } from \"@fluidframework/telemetry-utils/internal\";\n\n/**\n * Checks if the error is location redirection error.\n * @param error - error whose type is to be determined.\n * @returns `true` is the error is location redirection error, otherwise `false`.\n * @internal\n */\nexport function isLocationRedirectionError(\n\terror: unknown,\n): error is ILocationRedirectionError {\n\treturn (\n\t\ttypeof error === \"object\" &&\n\t\terror !== null &&\n\t\t(error as Partial<ILocationRedirectionError>).errorType ===\n\t\t\tDriverErrorTypes.locationRedirection\n\t);\n}\n\n/**\n * Handles location redirection while fulfilling the loader request.\n * @param api - Callback in which user can wrap the loader.resolve or loader.request call.\n * @param request - request to be resolved.\n * @param urlResolver - resolver used to resolve the url.\n * @param logger - logger to send events.\n * @returns Response from the API call.\n * @legacy\n * @beta\n */\nexport async function resolveWithLocationRedirectionHandling<T>(\n\tapi: (request: IRequest) => Promise<T>,\n\trequest: IRequest,\n\turlResolver: IUrlResolver,\n\tlogger?: ITelemetryBaseLogger,\n): Promise<T> {\n\tlet req: IRequest = request;\n\tconst childLogger = createChildLogger({ logger, namespace: \"LocationRedirection\" });\n\tfor (;;) {\n\t\ttry {\n\t\t\treturn await api(req);\n\t\t} catch (error: unknown) {\n\t\t\tif (!isLocationRedirectionError(error)) {\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\tchildLogger.sendTelemetryEvent({ eventName: \"LocationRedirectionError\" });\n\t\t\tconst resolvedUrl = error.redirectUrl;\n\t\t\t// Generate the new request with new location details from the resolved url. For datastore/relative path,\n\t\t\t// we don't need to pass \"/\" as host could have asked for a specific data store. So driver need to\n\t\t\t// extract it from the resolved url.\n\t\t\tconst absoluteUrl = await urlResolver.getAbsoluteUrl(resolvedUrl, \"\", undefined);\n\t\t\treq = { url: absoluteUrl, headers: req.headers };\n\t\t}\n\t}\n}\n"]}
+{"version":3,"file":"resolveWithLocationRedirection.js","sourceRoot":"","sources":["../../src/location-redirection-utilities/resolveWithLocationRedirection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAgBH,gEASC;AAYD,wFAwBC;AA1DD,0EAIqD;AACrD,uEAA6E;AAE7E;;;;;GAKG;AACH,SAAgB,0BAA0B,CACzC,KAAc;IAEd,OAAO,CACN,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACb,KAA4C,CAAC,SAAS;YACtD,2BAAgB,CAAC,mBAAmB,CACrC,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,sCAAsC,CAC3D,GAAsC,EACtC,OAAiB,EACjB,WAAyB,EACzB,MAA6B;IAE7B,IAAI,GAAG,GAAa,OAAO,CAAC;IAC5B,MAAM,WAAW,GAAG,IAAA,4BAAiB,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,qBAAqB,EAAE,CAAC,CAAC;IACpF,SAAS,CAAC;QACT,IAAI,CAAC;YACJ,OAAO,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACzB,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxC,MAAM,KAAK,CAAC;YACb,CAAC;YACD,WAAW,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,CAAC,CAAC;YAC1E,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;YACtC,yGAAyG;YACzG,kGAAkG;YAClG,oCAAoC;YACpC,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,cAAc,CAAC,WAAW,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;YACjF,GAAG,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC;QAClD,CAAC;IACF,CAAC;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IRequest, ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport {\n\ttype ILocationRedirectionError,\n\ttype IUrlResolver,\n\tDriverErrorTypes,\n} from \"@fluidframework/driver-definitions/internal\";\nimport { createChildLogger } from \"@fluidframework/telemetry-utils/internal\";\n\n/**\n * Checks if the error is location redirection error.\n * @param error - error whose type is to be determined.\n * @returns `true` is the error is location redirection error, otherwise `false`.\n * @internal\n */\nexport function isLocationRedirectionError(\n\terror: unknown,\n): error is ILocationRedirectionError {\n\treturn (\n\t\ttypeof error === \"object\" &&\n\t\terror !== null &&\n\t\t(error as Partial<ILocationRedirectionError>).errorType ===\n\t\t\tDriverErrorTypes.locationRedirection\n\t);\n}\n\n/**\n * Handles location redirection while fulfilling the loader request.\n * @param api - Callback in which user can wrap the loader.resolve or loader.request call.\n * @param request - request to be resolved.\n * @param urlResolver - resolver used to resolve the url.\n * @param logger - logger to send events.\n * @returns Response from the API call.\n * @legacy\n * @beta\n */\nexport async function resolveWithLocationRedirectionHandling<T>(\n\tapi: (request: IRequest) => Promise<T>,\n\trequest: IRequest,\n\turlResolver: IUrlResolver,\n\tlogger?: ITelemetryBaseLogger,\n): Promise<T> {\n\tlet req: IRequest = request;\n\tconst childLogger = createChildLogger({ logger, namespace: \"LocationRedirection\" });\n\tfor (;;) {\n\t\ttry {\n\t\t\treturn await api(req);\n\t\t} catch (error: unknown) {\n\t\t\tif (!isLocationRedirectionError(error)) {\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\tchildLogger.sendTelemetryEvent({ eventName: \"LocationRedirectionError\" });\n\t\t\tconst resolvedUrl = error.redirectUrl;\n\t\t\t// Generate the new request with new location details from the resolved url. For datastore/relative path,\n\t\t\t// we don't need to pass \"/\" as host could have asked for a specific data store. So driver need to\n\t\t\t// extract it from the resolved url.\n\t\t\tconst absoluteUrl = await urlResolver.getAbsoluteUrl(resolvedUrl, \"\", undefined);\n\t\t\treq = { url: absoluteUrl, headers: req.headers };\n\t\t}\n\t}\n}\n"]}

package/dist/memoryBlobStorage.js

@@ -4,7 +4,8 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMemoryDetachedBlobStorage = exports.tryInitializeMemoryDetachedBlobStorage = void 0;
+exports.tryInitializeMemoryDetachedBlobStorage = tryInitializeMemoryDetachedBlobStorage;
+exports.createMemoryDetachedBlobStorage = createMemoryDetachedBlobStorage;
 const client_utils_1 = require("@fluid-internal/client-utils");
 const internal_1 = require("@fluidframework/core-utils/internal");
 function tryInitializeMemoryDetachedBlobStorage(detachedStorage, attachmentBlobs) {
@@ -15,7 +16,6 @@ function tryInitializeMemoryDetachedBlobStorage(detachedStorage, attachmentBlobs
     // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
     detachedStorage.initialize(maybeAttachmentBlobs);
 }
-exports.tryInitializeMemoryDetachedBlobStorage = tryInitializeMemoryDetachedBlobStorage;
 /**
  * Creates a new instance of `MemoryDetachedBlobStorage`.
  * The returned storage allows for creating, reading, and managing blobs in memory.
@@ -41,5 +41,4 @@ function createMemoryDetachedBlobStorage() {
     };
     return storage;
 }
-exports.createMemoryDetachedBlobStorage = createMemoryDetachedBlobStorage;
 //# sourceMappingURL=memoryBlobStorage.js.map

package/dist/memoryBlobStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"memoryBlobStorage.js","sourceRoot":"","sources":["../src/memoryBlobStorage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAA8E;AAC9E,kEAA6D;AA8B7D,SAAgB,sCAAsC,CACrD,eAA0C,EAC1C,eAAuB;IAEvB,IAAA,iBAAM,EAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;IACjF,mEAAmE;IACnE,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IACzD,IAAA,iBAAM,EAAC,KAAK,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAEjF,iEAAiE;IACjE,eAAe,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAClD,CAAC;AAXD,wFAWC;AAED;;;;;GAKG;AACH,SAAgB,+BAA+B;IAC9C,MAAM,KAAK,GAAsB,EAAE,CAAC;IACpC,MAAM,OAAO,GAA8B;QAC1C,UAAU,EAAE,KAAK,EAAE,IAAqB,EAAgC,EAAE,CAAC,CAAC;YAC3E,EAAE,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;SAC7B,CAAC;QACF,QAAQ,EAAE,KAAK,EAAE,EAAU,EAA4B,EAAE,CACxD,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QACxE,IAAI,IAAI;YACP,OAAO,KAAK,CAAC,MAAM,CAAC;QACrB,CAAC;QACD,UAAU,EAAE,GAAa,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;QACvD,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9B,SAAS,EAAE,GAAG,EAAE,CACf,KAAK,CAAC,MAAM,GAAG,CAAC;YACf,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,6BAAc,EAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAC7D,CAAC,CAAC,SAAS;QACb,UAAU,EAAE,CAAC,eAAyB,EAAE,EAAE,CACzC,KAAK,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,6BAAc,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;KACrF,CAAC;IACF,OAAO,OAAO,CAAC;AAChB,CAAC;AArBD,0EAqBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { bufferToString, stringToBuffer } from \"@fluid-internal/client-utils\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type {\n\tICreateBlobResponse,\n\tIDocumentStorageService,\n} from \"@fluidframework/driver-definitions/internal\";\n\n/**\n * An interface used to manage blobs in memory for detached containers.\n *\n * @remarks\n * On attach of the container the blobs are read, and uploaded to the server.\n * The interface also supports serialization and initialization which is\n * used when serializing and rehydrating a detached container with blobs.\n */\nexport interface MemoryDetachedBlobStorage\n\textends Pick<IDocumentStorageService, \"createBlob\" | \"readBlob\"> {\n\tsize: number;\n\t/**\n\t * Return an array of all blob IDs present in storage\n\t */\n\tgetBlobIds(): string[];\n\n\t/**\n\t * After the container is attached, the detached blob storage is no longer needed and will be disposed.\n\t */\n\tdispose?(): void;\n\tinitialize(attachmentBlobs: string[]): void;\n\tserialize(): string | undefined;\n}\n\nexport function tryInitializeMemoryDetachedBlobStorage(\n\tdetachedStorage: MemoryDetachedBlobStorage,\n\tattachmentBlobs: string,\n): void {\n\tassert(detachedStorage.size === 0, 0x99e /* Blob storage already initialized */);\n\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\tconst maybeAttachmentBlobs = JSON.parse(attachmentBlobs);\n\tassert(Array.isArray(maybeAttachmentBlobs), 0x99f /* Invalid attachmentBlobs */);\n\n\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\tdetachedStorage.initialize(maybeAttachmentBlobs);\n}\n\n/**\n * Creates a new instance of `MemoryDetachedBlobStorage`.\n * The returned storage allows for creating, reading, and managing blobs in memory.\n * It also provides methods for serialization and initialization with attachment blobs.\n * @returns A new `MemoryDetachedBlobStorage` instance.\n */\nexport function createMemoryDetachedBlobStorage(): MemoryDetachedBlobStorage {\n\tconst blobs: ArrayBufferLike[] = [];\n\tconst storage: MemoryDetachedBlobStorage = {\n\t\tcreateBlob: async (file: ArrayBufferLike): Promise<ICreateBlobResponse> => ({\n\t\t\tid: `${blobs.push(file) - 1}`,\n\t\t}),\n\t\treadBlob: async (id: string): Promise<ArrayBufferLike> =>\n\t\t\tblobs[Number(id)] ?? Promise.reject(new Error(`Blob not found: ${id}`)),\n\t\tget size() {\n\t\t\treturn blobs.length;\n\t\t},\n\t\tgetBlobIds: (): string[] => blobs.map((_, i) => `${i}`),\n\t\tdispose: () => blobs.splice(0),\n\t\tserialize: () =>\n\t\t\tblobs.length > 0\n\t\t\t\t? JSON.stringify(blobs.map((b) => bufferToString(b, \"utf8\")))\n\t\t\t\t: undefined,\n\t\tinitialize: (attachmentBlobs: string[]) =>\n\t\t\tblobs.push(...attachmentBlobs.map((maybeBlob) => stringToBuffer(maybeBlob, \"utf8\"))),\n\t};\n\treturn storage;\n}\n"]}
+{"version":3,"file":"memoryBlobStorage.js","sourceRoot":"","sources":["../src/memoryBlobStorage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAiCH,wFAWC;AAQD,0EAqBC;AAvED,+DAA8E;AAC9E,kEAA6D;AA8B7D,SAAgB,sCAAsC,CACrD,eAA0C,EAC1C,eAAuB;IAEvB,IAAA,iBAAM,EAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;IACjF,mEAAmE;IACnE,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IACzD,IAAA,iBAAM,EAAC,KAAK,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAEjF,iEAAiE;IACjE,eAAe,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAClD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,+BAA+B;IAC9C,MAAM,KAAK,GAAsB,EAAE,CAAC;IACpC,MAAM,OAAO,GAA8B;QAC1C,UAAU,EAAE,KAAK,EAAE,IAAqB,EAAgC,EAAE,CAAC,CAAC;YAC3E,EAAE,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;SAC7B,CAAC;QACF,QAAQ,EAAE,KAAK,EAAE,EAAU,EAA4B,EAAE,CACxD,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QACxE,IAAI,IAAI;YACP,OAAO,KAAK,CAAC,MAAM,CAAC;QACrB,CAAC;QACD,UAAU,EAAE,GAAa,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;QACvD,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9B,SAAS,EAAE,GAAG,EAAE,CACf,KAAK,CAAC,MAAM,GAAG,CAAC;YACf,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,6BAAc,EAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAC7D,CAAC,CAAC,SAAS;QACb,UAAU,EAAE,CAAC,eAAyB,EAAE,EAAE,CACzC,KAAK,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,6BAAc,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;KACrF,CAAC;IACF,OAAO,OAAO,CAAC;AAChB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { bufferToString, stringToBuffer } from \"@fluid-internal/client-utils\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type {\n\tICreateBlobResponse,\n\tIDocumentStorageService,\n} from \"@fluidframework/driver-definitions/internal\";\n\n/**\n * An interface used to manage blobs in memory for detached containers.\n *\n * @remarks\n * On attach of the container the blobs are read, and uploaded to the server.\n * The interface also supports serialization and initialization which is\n * used when serializing and rehydrating a detached container with blobs.\n */\nexport interface MemoryDetachedBlobStorage\n\textends Pick<IDocumentStorageService, \"createBlob\" | \"readBlob\"> {\n\tsize: number;\n\t/**\n\t * Return an array of all blob IDs present in storage\n\t */\n\tgetBlobIds(): string[];\n\n\t/**\n\t * After the container is attached, the detached blob storage is no longer needed and will be disposed.\n\t */\n\tdispose?(): void;\n\tinitialize(attachmentBlobs: string[]): void;\n\tserialize(): string | undefined;\n}\n\nexport function tryInitializeMemoryDetachedBlobStorage(\n\tdetachedStorage: MemoryDetachedBlobStorage,\n\tattachmentBlobs: string,\n): void {\n\tassert(detachedStorage.size === 0, 0x99e /* Blob storage already initialized */);\n\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\tconst maybeAttachmentBlobs = JSON.parse(attachmentBlobs);\n\tassert(Array.isArray(maybeAttachmentBlobs), 0x99f /* Invalid attachmentBlobs */);\n\n\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\tdetachedStorage.initialize(maybeAttachmentBlobs);\n}\n\n/**\n * Creates a new instance of `MemoryDetachedBlobStorage`.\n * The returned storage allows for creating, reading, and managing blobs in memory.\n * It also provides methods for serialization and initialization with attachment blobs.\n * @returns A new `MemoryDetachedBlobStorage` instance.\n */\nexport function createMemoryDetachedBlobStorage(): MemoryDetachedBlobStorage {\n\tconst blobs: ArrayBufferLike[] = [];\n\tconst storage: MemoryDetachedBlobStorage = {\n\t\tcreateBlob: async (file: ArrayBufferLike): Promise<ICreateBlobResponse> => ({\n\t\t\tid: `${blobs.push(file) - 1}`,\n\t\t}),\n\t\treadBlob: async (id: string): Promise<ArrayBufferLike> =>\n\t\t\tblobs[Number(id)] ?? Promise.reject(new Error(`Blob not found: ${id}`)),\n\t\tget size() {\n\t\t\treturn blobs.length;\n\t\t},\n\t\tgetBlobIds: (): string[] => blobs.map((_, i) => `${i}`),\n\t\tdispose: () => blobs.splice(0),\n\t\tserialize: () =>\n\t\t\tblobs.length > 0\n\t\t\t\t? JSON.stringify(blobs.map((b) => bufferToString(b, \"utf8\")))\n\t\t\t\t: undefined,\n\t\tinitialize: (attachmentBlobs: string[]) =>\n\t\t\tblobs.push(...attachmentBlobs.map((maybeBlob) => stringToBuffer(maybeBlob, \"utf8\"))),\n\t};\n\treturn storage;\n}\n"]}

package/dist/noopHeuristic.js

@@ -30,10 +30,12 @@ const defaultNoopCountFrequency = 50;
 // 2. If there are more than 50 ops received without sending any ops, send noop to keep collab window small.
 //    Note that system ops (including noops themselves) are excluded, so it's 1 noop per 50 real ops.
 class NoopHeuristic extends client_utils_1.TypedEventEmitter {
+    NoopCountFrequency;
+    opsProcessedSinceOpSent = 0;
+    timer;
     constructor(NoopTimeFrequency = defaultNoopTimeFrequency, NoopCountFrequency = defaultNoopCountFrequency) {
         super();
         this.NoopCountFrequency = NoopCountFrequency;
-        this.opsProcessedSinceOpSent = 0;
         if (NoopTimeFrequency !== Number.POSITIVE_INFINITY) {
             this.timer = new internal_1.Timer(NoopTimeFrequency, () => {
                 // We allow the timer to expire even if an op is sent or we disconnect.

package/dist/noopHeuristic.js.map

@@ -1 +1 @@
-{"version":3,"file":"noopHeuristic.js","sourceRoot":"","sources":["../src/noopHeuristic.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAiE;AAEjE,kEAAoE;AAEpE,oEAAyE;AAEzE,MAAM,wBAAwB,GAAG,IAAI,CAAC;AACtC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AAMrC,6FAA6F;AAC7F,4GAA4G;AAC5G,yGAAyG;AACzG,2CAA2C;AAC3C,oHAAoH;AACpH,2FAA2F;AAC3F,kHAAkH;AAClH,+CAA+C;AAC/C,gHAAgH;AAChH,yFAAyF;AACzF,qHAAqH;AACrH,oDAAoD;AACpD,EAAE;AACF,kDAAkD;AAClD,oGAAoG;AACpG,iHAAiH;AACjH,sEAAsE;AACtE,4GAA4G;AAC5G,qGAAqG;AACrG,MAAa,aAAc,SAAQ,gCAAoC;IAItE,YACC,oBAA4B,wBAAwB,EACnC,qBAA6B,yBAAyB;QAEvE,KAAK,EAAE,CAAC;QAFS,uBAAkB,GAAlB,kBAAkB,CAAoC;QALhE,4BAAuB,GAAG,CAAC,CAAC;QAQnC,IAAI,iBAAiB,KAAK,MAAM,CAAC,iBAAiB,EAAE,CAAC;YACpD,IAAI,CAAC,KAAK,GAAG,IAAI,gBAAK,CAAC,iBAAiB,EAAE,GAAG,EAAE;gBAC9C,uEAAuE;gBACvE,gFAAgF;gBAChF,IAAI,IAAI,CAAC,uBAAuB,KAAK,CAAC,EAAE,CAAC;oBACxC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACxB,CAAC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,OAAkC;QAC/D,gFAAgF;QAChF,+DAA+D;QAC/D,sFAAsF;QACtF,yCAAyC;QACzC,IAAI,CAAC,IAAA,2BAAgB,EAAC,OAAO,CAAC,EAAE,CAAC;YAChC,OAAO;QACR,CAAC;QAED,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,uBAAuB,KAAK,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9D,qGAAqG;YACrG,gJAAgJ;YAChJ,+FAA+F;YAC/F,cAAc,CAAC,GAAG,EAAE;gBACnB,IAAI,IAAI,CAAC,uBAAuB,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC7D,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBACvB,IAAA,iBAAM,EACL,IAAI,CAAC,uBAAuB,KAAK,CAAC,EAClC,KAAK,CAAC,gDAAgD,CACtD,CAAC;gBACH,CAAC;gBACD,OAAO;YACR,CAAC,CAAC,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9B,yDAAyD;YACzD,6HAA6H;YAC7H,IAAI,IAAI,CAAC,uBAAuB,KAAK,CAAC,EAAE,CAAC;gBACxC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACtB,CAAC;YAED,IAAA,iBAAM,EAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACtD,CAAC;IACF,CAAC;IAEM,gBAAgB;QACtB,2GAA2G;QAC3G,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;IAClC,CAAC;IAEM,iBAAiB;QACvB,6DAA6D;QAC7D,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;IAClC,CAAC;CACD;AArED,sCAqEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport type { IEvent } from \"@fluidframework/core-interfaces\";\nimport { assert, Timer } from \"@fluidframework/core-utils/internal\";\nimport type { ISequencedDocumentMessage } from \"@fluidframework/driver-definitions/internal\";\nimport { isRuntimeMessage } from \"@fluidframework/driver-utils/internal\";\n\nconst defaultNoopTimeFrequency = 2000;\nconst defaultNoopCountFrequency = 50;\n\nexport interface INoopSenderEvents extends IEvent {\n\t(event: \"wantsNoop\", listener: () => void);\n}\n\n// Here are key considerations when deciding conditions for when to send non-immediate noops:\n// 1. Sending them too often results in increase in file size and bandwidth, as well as catch up performance\n// 2. Sending too infrequently ensures that collab window is large, and as result Sequence DDS would have\n//    large catchUp blobs - see Issue #6364\n// 3. Similarly, processes that rely on \"core\" snapshot (and can't parse trailing ops, including above), like search\n//    parser in SPO, will result in non-accurate results due to presence of catch up blobs.\n// 4. Ordering service used 250ms timeout to coalesce non-immediate noops. It was changed to 2000 ms to allow more\n//    aggressive noop sending from client side.\n// 5. Number of ops sent by all clients is proportional to number of \"write\" clients (every client sends noops),\n//    but number of sequenced noops is a function of time (one op per 2 seconds at most).\n//    We should consider impact to both outbound traffic (might be huge, depends on number of clients) and file size.\n// Please also see Issue #5629 for more discussions.\n//\n// With that, the current algorithm is as follows:\n// 1. Sent noop 2000 ms of receiving an op if no ops were sent by this client within this timeframe.\n//    This will ensure that MSN moves forward with reasonable speed. If that results in too many sequenced noops,\n//    server timeout of 2000ms should be reconsidered to be increased.\n// 2. If there are more than 50 ops received without sending any ops, send noop to keep collab window small.\n//    Note that system ops (including noops themselves) are excluded, so it's 1 noop per 50 real ops.\nexport class NoopHeuristic extends TypedEventEmitter<INoopSenderEvents> {\n\tprivate opsProcessedSinceOpSent = 0;\n\tprivate readonly timer: Timer | undefined;\n\n\tconstructor(\n\t\tNoopTimeFrequency: number = defaultNoopTimeFrequency,\n\t\tprivate readonly NoopCountFrequency: number = defaultNoopCountFrequency,\n\t) {\n\t\tsuper();\n\t\tif (NoopTimeFrequency !== Number.POSITIVE_INFINITY) {\n\t\t\tthis.timer = new Timer(NoopTimeFrequency, () => {\n\t\t\t\t// We allow the timer to expire even if an op is sent or we disconnect.\n\t\t\t\t// This condition is to guard against trying to send a noop anyway in that case.\n\t\t\t\tif (this.opsProcessedSinceOpSent !== 0) {\n\t\t\t\t\tthis.emit(\"wantsNoop\");\n\t\t\t\t}\n\t\t\t});\n\t\t}\n\t}\n\n\t/**\n\t * Schedules as ack to the server to update the reference sequence number\n\t */\n\tpublic notifyMessageProcessed(message: ISequencedDocumentMessage): void {\n\t\t// We don't acknowledge no-ops to avoid acknowledgement cycles (i.e. ack the MSN\n\t\t// update, which updates the MSN, then ack the update, etc...).\n\t\t// Intent here is for runtime (and DDSes) not to keep too much tracking state / memory\n\t\t// due to runtime ops from other clients.\n\t\tif (!isRuntimeMessage(message)) {\n\t\t\treturn;\n\t\t}\n\n\t\tthis.opsProcessedSinceOpSent++;\n\t\tif (this.opsProcessedSinceOpSent === this.NoopCountFrequency) {\n\t\t\t// Wait to send a noop if we are still synchronously processing ops.  This guards against two things:\n\t\t\t// 1. If we're processing many ops, we may pass the frequency threshold many times.  We only need to send one noop at the very end in this case.\n\t\t\t// 2. We may send another (non-noop) op in response to processing those ops, e.g. an Accept op.\n\t\t\tqueueMicrotask(() => {\n\t\t\t\tif (this.opsProcessedSinceOpSent >= this.NoopCountFrequency) {\n\t\t\t\t\tthis.emit(\"wantsNoop\");\n\t\t\t\t\tassert(\n\t\t\t\t\t\tthis.opsProcessedSinceOpSent === 0,\n\t\t\t\t\t\t0x243 /* \"Expected a noop to be synchronously sent\" */,\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\treturn;\n\t\t\t});\n\t\t}\n\n\t\tif (this.timer !== undefined) {\n\t\t\t// Start the timer if we newly have ops that want a noop.\n\t\t\t// If the timer was already running (e.g. we surpassed the op count and sent a noop) this will reset it to its full duration.\n\t\t\tif (this.opsProcessedSinceOpSent === 1) {\n\t\t\t\tthis.timer.restart();\n\t\t\t}\n\n\t\t\tassert(this.timer.hasTimer, 0x242 /* \"has timer\" */);\n\t\t}\n\t}\n\n\tpublic notifyDisconnect(): void {\n\t\t// No need to noop for any ops processed prior to disconnect - we are already removed from MSN calculation.\n\t\tthis.opsProcessedSinceOpSent = 0;\n\t}\n\n\tpublic notifyMessageSent(): void {\n\t\t// Sending any message is as good as a noop for updating MSN.\n\t\tthis.opsProcessedSinceOpSent = 0;\n\t}\n}\n"]}
+{"version":3,"file":"noopHeuristic.js","sourceRoot":"","sources":["../src/noopHeuristic.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAiE;AAEjE,kEAAoE;AAEpE,oEAAyE;AAEzE,MAAM,wBAAwB,GAAG,IAAI,CAAC;AACtC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AAMrC,6FAA6F;AAC7F,4GAA4G;AAC5G,yGAAyG;AACzG,2CAA2C;AAC3C,oHAAoH;AACpH,2FAA2F;AAC3F,kHAAkH;AAClH,+CAA+C;AAC/C,gHAAgH;AAChH,yFAAyF;AACzF,qHAAqH;AACrH,oDAAoD;AACpD,EAAE;AACF,kDAAkD;AAClD,oGAAoG;AACpG,iHAAiH;AACjH,sEAAsE;AACtE,4GAA4G;AAC5G,qGAAqG;AACrG,MAAa,aAAc,SAAQ,gCAAoC;IAMpD;IALV,uBAAuB,GAAG,CAAC,CAAC;IACnB,KAAK,CAAoB;IAE1C,YACC,oBAA4B,wBAAwB,EACnC,qBAA6B,yBAAyB;QAEvE,KAAK,EAAE,CAAC;QAFS,uBAAkB,GAAlB,kBAAkB,CAAoC;QAGvE,IAAI,iBAAiB,KAAK,MAAM,CAAC,iBAAiB,EAAE,CAAC;YACpD,IAAI,CAAC,KAAK,GAAG,IAAI,gBAAK,CAAC,iBAAiB,EAAE,GAAG,EAAE;gBAC9C,uEAAuE;gBACvE,gFAAgF;gBAChF,IAAI,IAAI,CAAC,uBAAuB,KAAK,CAAC,EAAE,CAAC;oBACxC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACxB,CAAC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,OAAkC;QAC/D,gFAAgF;QAChF,+DAA+D;QAC/D,sFAAsF;QACtF,yCAAyC;QACzC,IAAI,CAAC,IAAA,2BAAgB,EAAC,OAAO,CAAC,EAAE,CAAC;YAChC,OAAO;QACR,CAAC;QAED,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,uBAAuB,KAAK,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9D,qGAAqG;YACrG,gJAAgJ;YAChJ,+FAA+F;YAC/F,cAAc,CAAC,GAAG,EAAE;gBACnB,IAAI,IAAI,CAAC,uBAAuB,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC7D,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBACvB,IAAA,iBAAM,EACL,IAAI,CAAC,uBAAuB,KAAK,CAAC,EAClC,KAAK,CAAC,gDAAgD,CACtD,CAAC;gBACH,CAAC;gBACD,OAAO;YACR,CAAC,CAAC,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9B,yDAAyD;YACzD,6HAA6H;YAC7H,IAAI,IAAI,CAAC,uBAAuB,KAAK,CAAC,EAAE,CAAC;gBACxC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACtB,CAAC;YAED,IAAA,iBAAM,EAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACtD,CAAC;IACF,CAAC;IAEM,gBAAgB;QACtB,2GAA2G;QAC3G,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;IAClC,CAAC;IAEM,iBAAiB;QACvB,6DAA6D;QAC7D,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;IAClC,CAAC;CACD;AArED,sCAqEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport type { IEvent } from \"@fluidframework/core-interfaces\";\nimport { assert, Timer } from \"@fluidframework/core-utils/internal\";\nimport type { ISequencedDocumentMessage } from \"@fluidframework/driver-definitions/internal\";\nimport { isRuntimeMessage } from \"@fluidframework/driver-utils/internal\";\n\nconst defaultNoopTimeFrequency = 2000;\nconst defaultNoopCountFrequency = 50;\n\nexport interface INoopSenderEvents extends IEvent {\n\t(event: \"wantsNoop\", listener: () => void);\n}\n\n// Here are key considerations when deciding conditions for when to send non-immediate noops:\n// 1. Sending them too often results in increase in file size and bandwidth, as well as catch up performance\n// 2. Sending too infrequently ensures that collab window is large, and as result Sequence DDS would have\n//    large catchUp blobs - see Issue #6364\n// 3. Similarly, processes that rely on \"core\" snapshot (and can't parse trailing ops, including above), like search\n//    parser in SPO, will result in non-accurate results due to presence of catch up blobs.\n// 4. Ordering service used 250ms timeout to coalesce non-immediate noops. It was changed to 2000 ms to allow more\n//    aggressive noop sending from client side.\n// 5. Number of ops sent by all clients is proportional to number of \"write\" clients (every client sends noops),\n//    but number of sequenced noops is a function of time (one op per 2 seconds at most).\n//    We should consider impact to both outbound traffic (might be huge, depends on number of clients) and file size.\n// Please also see Issue #5629 for more discussions.\n//\n// With that, the current algorithm is as follows:\n// 1. Sent noop 2000 ms of receiving an op if no ops were sent by this client within this timeframe.\n//    This will ensure that MSN moves forward with reasonable speed. If that results in too many sequenced noops,\n//    server timeout of 2000ms should be reconsidered to be increased.\n// 2. If there are more than 50 ops received without sending any ops, send noop to keep collab window small.\n//    Note that system ops (including noops themselves) are excluded, so it's 1 noop per 50 real ops.\nexport class NoopHeuristic extends TypedEventEmitter<INoopSenderEvents> {\n\tprivate opsProcessedSinceOpSent = 0;\n\tprivate readonly timer: Timer | undefined;\n\n\tconstructor(\n\t\tNoopTimeFrequency: number = defaultNoopTimeFrequency,\n\t\tprivate readonly NoopCountFrequency: number = defaultNoopCountFrequency,\n\t) {\n\t\tsuper();\n\t\tif (NoopTimeFrequency !== Number.POSITIVE_INFINITY) {\n\t\t\tthis.timer = new Timer(NoopTimeFrequency, () => {\n\t\t\t\t// We allow the timer to expire even if an op is sent or we disconnect.\n\t\t\t\t// This condition is to guard against trying to send a noop anyway in that case.\n\t\t\t\tif (this.opsProcessedSinceOpSent !== 0) {\n\t\t\t\t\tthis.emit(\"wantsNoop\");\n\t\t\t\t}\n\t\t\t});\n\t\t}\n\t}\n\n\t/**\n\t * Schedules as ack to the server to update the reference sequence number\n\t */\n\tpublic notifyMessageProcessed(message: ISequencedDocumentMessage): void {\n\t\t// We don't acknowledge no-ops to avoid acknowledgement cycles (i.e. ack the MSN\n\t\t// update, which updates the MSN, then ack the update, etc...).\n\t\t// Intent here is for runtime (and DDSes) not to keep too much tracking state / memory\n\t\t// due to runtime ops from other clients.\n\t\tif (!isRuntimeMessage(message)) {\n\t\t\treturn;\n\t\t}\n\n\t\tthis.opsProcessedSinceOpSent++;\n\t\tif (this.opsProcessedSinceOpSent === this.NoopCountFrequency) {\n\t\t\t// Wait to send a noop if we are still synchronously processing ops.  This guards against two things:\n\t\t\t// 1. If we're processing many ops, we may pass the frequency threshold many times.  We only need to send one noop at the very end in this case.\n\t\t\t// 2. We may send another (non-noop) op in response to processing those ops, e.g. an Accept op.\n\t\t\tqueueMicrotask(() => {\n\t\t\t\tif (this.opsProcessedSinceOpSent >= this.NoopCountFrequency) {\n\t\t\t\t\tthis.emit(\"wantsNoop\");\n\t\t\t\t\tassert(\n\t\t\t\t\t\tthis.opsProcessedSinceOpSent === 0,\n\t\t\t\t\t\t0x243 /* \"Expected a noop to be synchronously sent\" */,\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\treturn;\n\t\t\t});\n\t\t}\n\n\t\tif (this.timer !== undefined) {\n\t\t\t// Start the timer if we newly have ops that want a noop.\n\t\t\t// If the timer was already running (e.g. we surpassed the op count and sent a noop) this will reset it to its full duration.\n\t\t\tif (this.opsProcessedSinceOpSent === 1) {\n\t\t\t\tthis.timer.restart();\n\t\t\t}\n\n\t\t\tassert(this.timer.hasTimer, 0x242 /* \"has timer\" */);\n\t\t}\n\t}\n\n\tpublic notifyDisconnect(): void {\n\t\t// No need to noop for any ops processed prior to disconnect - we are already removed from MSN calculation.\n\t\tthis.opsProcessedSinceOpSent = 0;\n\t}\n\n\tpublic notifyMessageSent(): void {\n\t\t// Sending any message is as good as a noop for updating MSN.\n\t\tthis.opsProcessedSinceOpSent = 0;\n\t}\n}\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/container-loader";
-export declare const pkgVersion = "2.118.1";
+export declare const pkgVersion = "3.0.1";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,YAAY,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,UAAU,CAAC"}

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/container-loader";
-exports.pkgVersion = "2.118.1";
+exports.pkgVersion = "3.0.1";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,kCAAkC,CAAC;AAC7C,QAAA,UAAU,GAAG,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/container-loader\";\nexport const pkgVersion = \"2.118.1\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,kCAAkC,CAAC;AAC7C,QAAA,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/container-loader\";\nexport const pkgVersion = \"3.0.1\";\n"]}

package/dist/pendingLocalStateStore.d.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+import type { FluidIterableIterator } from "@fluidframework/core-interfaces";
 /**
  * A Map-like store for managing pending local container states from attached containers.
  * Optimizes storage by deduplicating shared resources across stored states.
@@ -71,14 +72,14 @@ export declare class PendingLocalStateStore<TKey> {
     /**
      * Returns an iterator over [key, serializedState] pairs.
      */
-    entries(): Iterator<[TKey, string]>;
+    entries(): FluidIterableIterator<[TKey, string]>;
     /**
      * Returns an iterator over the stored keys.
      */
-    keys(): IterableIterator<TKey>;
+    keys(): FluidIterableIterator<TKey>;
     /**
      * Makes the store iterable with `for...of` loops.
      */
-    [Symbol.iterator](): Iterator<[TKey, string]>;
+    [Symbol.iterator](): FluidIterableIterator<[TKey, string]>;
 }
 //# sourceMappingURL=pendingLocalStateStore.d.ts.map

package/dist/pendingLocalStateStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pendingLocalStateStore.d.ts","sourceRoot":"","sources":["../src/pendingLocalStateStore.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAWH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,sBAAsB,CAAC,IAAI;;IAQvC;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO;IAI1B;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS;IAIlC;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO;IAIvB;;;;;;;;OAQG;IACH,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,GAAG,IAAI;IAuC/C;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,OAAO,IAAI,QAAQ,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAcnC;;OAEG;IACH,IAAI,IAAI,gBAAgB,CAAC,IAAI,CAAC;IAI9B;;OAEG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;CAG7C"}
+{"version":3,"file":"pendingLocalStateStore.d.ts","sourceRoot":"","sources":["../src/pendingLocalStateStore.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAU7E;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,sBAAsB,CAAC,IAAI;;IAQvC;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO;IAI1B;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS;IAIlC;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO;IAIvB;;;;;;;;OAQG;IACH,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,GAAG,IAAI;IAuC/C;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,OAAO,IAAI,qBAAqB,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAiBhD;;OAEG;IACH,IAAI,IAAI,qBAAqB,CAAC,IAAI,CAAC;IAInC;;OAEG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,qBAAqB,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;CAG1D"}

package/dist/pendingLocalStateStore.js

@@ -3,18 +3,6 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var _PendingLocalStateStore_firstUrl, _PendingLocalStateStore_pendingStates, _PendingLocalStateStore_savedOps, _PendingLocalStateStore_blobs, _PendingLocalStateStore_attachmentBlobs, _PendingLocalStateStore_loadingGroups;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PendingLocalStateStore = void 0;
 const internal_1 = require("@fluidframework/telemetry-utils/internal");
@@ -48,19 +36,17 @@ const utils_js_1 = require("./utils.js");
  * @legacy @alpha
  */
 class PendingLocalStateStore {
-    constructor() {
-        _PendingLocalStateStore_firstUrl.set(this, void 0);
-        _PendingLocalStateStore_pendingStates.set(this, new Map());
-        _PendingLocalStateStore_savedOps.set(this, {});
-        _PendingLocalStateStore_blobs.set(this, {});
-        _PendingLocalStateStore_attachmentBlobs.set(this, {});
-        _PendingLocalStateStore_loadingGroups.set(this, {});
-    }
+    #firstUrl;
+    #pendingStates = new Map();
+    #savedOps = {};
+    #blobs = {};
+    #attachmentBlobs = {};
+    #loadingGroups = {};
     /**
      * Removes all stored pending states.
      */
     clear() {
-        return __classPrivateFieldGet(this, _PendingLocalStateStore_pendingStates, "f").clear();
+        return this.#pendingStates.clear();
     }
     /**
      * Removes the pending state for the specified key.
@@ -69,7 +55,7 @@ class PendingLocalStateStore {
      * @returns `true` if the state existed and was removed, `false` otherwise
      */
     delete(key) {
-        return __classPrivateFieldGet(this, _PendingLocalStateStore_pendingStates, "f").delete(key);
+        return this.#pendingStates.delete(key);
     }
     /**
      * Retrieves the serialized pending state for the specified key.
@@ -78,13 +64,13 @@ class PendingLocalStateStore {
      * @returns The serialized state as a JSON string, or `undefined` if not found
      */
     get(key) {
-        return JSON.stringify(__classPrivateFieldGet(this, _PendingLocalStateStore_pendingStates, "f").get(key));
+        return JSON.stringify(this.#pendingStates.get(key));
     }
     /**
      * Checks whether a pending state exists for the specified key.
      */
     has(key) {
-        return __classPrivateFieldGet(this, _PendingLocalStateStore_pendingStates, "f").has(key);
+        return this.#pendingStates.has(key);
     }
     /**
      * Stores a pending state from `container.getPendingLocalState()`.
@@ -100,44 +86,44 @@ class PendingLocalStateStore {
         const { savedOps, snapshotBlobs, attachmentBlobContents, loadedGroupIdSnapshots, url } = state;
         // Normalize URL by removing trailing slash for comparison
         const normalizedUrl = url.replace(/\/$/, "");
-        const normalizedFirstUrl = __classPrivateFieldGet(this, _PendingLocalStateStore_firstUrl, "f")?.replace(/\/$/, "");
-        __classPrivateFieldSet(this, _PendingLocalStateStore_firstUrl, __classPrivateFieldGet(this, _PendingLocalStateStore_firstUrl, "f") ?? url, "f");
+        const normalizedFirstUrl = this.#firstUrl?.replace(/\/$/, "");
+        this.#firstUrl ??= url;
         if (normalizedFirstUrl !== undefined && normalizedFirstUrl !== normalizedUrl) {
             throw new internal_1.UsageError("PendingLocalStateStore can only be used with a single container.");
         }
         for (let i = 0; i < savedOps.length; i++) {
-            savedOps[i] = __classPrivateFieldGet(this, _PendingLocalStateStore_savedOps, "f")[savedOps[i].sequenceNumber] ??= savedOps[i];
+            savedOps[i] = this.#savedOps[savedOps[i].sequenceNumber] ??= savedOps[i];
         }
         for (const [id, blob] of Object.entries(snapshotBlobs)) {
-            snapshotBlobs[id] = __classPrivateFieldGet(this, _PendingLocalStateStore_blobs, "f")[id] ??= blob;
+            snapshotBlobs[id] = this.#blobs[id] ??= blob;
         }
         if (attachmentBlobContents !== undefined) {
             for (const [id, blob] of Object.entries(attachmentBlobContents)) {
-                attachmentBlobContents[id] = __classPrivateFieldGet(this, _PendingLocalStateStore_attachmentBlobs, "f")[id] ??= blob;
+                attachmentBlobContents[id] = this.#attachmentBlobs[id] ??= blob;
             }
         }
         if (loadedGroupIdSnapshots !== undefined) {
             for (const [id, lg] of Object.entries(loadedGroupIdSnapshots)) {
-                if (__classPrivateFieldGet(this, _PendingLocalStateStore_loadingGroups, "f")[id] === undefined ||
-                    lg.snapshotSequenceNumber < __classPrivateFieldGet(this, _PendingLocalStateStore_loadingGroups, "f")[id].snapshotSequenceNumber) {
-                    loadedGroupIdSnapshots[id] = __classPrivateFieldGet(this, _PendingLocalStateStore_loadingGroups, "f")[id] = lg;
+                if (this.#loadingGroups[id] === undefined ||
+                    lg.snapshotSequenceNumber < this.#loadingGroups[id].snapshotSequenceNumber) {
+                    loadedGroupIdSnapshots[id] = this.#loadingGroups[id] = lg;
                 }
             }
         }
-        __classPrivateFieldGet(this, _PendingLocalStateStore_pendingStates, "f").set(key, state);
+        this.#pendingStates.set(key, state);
         return this;
     }
     /**
      * Gets the number of stored pending states.
      */
     get size() {
-        return __classPrivateFieldGet(this, _PendingLocalStateStore_pendingStates, "f").size;
+        return this.#pendingStates.size;
     }
     /**
      * Returns an iterator over [key, serializedState] pairs.
      */
     entries() {
-        const iterator = __classPrivateFieldGet(this, _PendingLocalStateStore_pendingStates, "f").entries();
+        const iterator = this.#pendingStates.entries();
         return {
             next: () => {
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
@@ -147,18 +133,21 @@ class PendingLocalStateStore {
                 }
                 return { done, value: [value[0], JSON.stringify(value[1])] };
             },
+            [Symbol.iterator]() {
+                return this;
+            },
         };
     }
     /**
      * Returns an iterator over the stored keys.
      */
     keys() {
-        return __classPrivateFieldGet(this, _PendingLocalStateStore_pendingStates, "f").keys();
+        return this.#pendingStates.keys();
     }
     /**
      * Makes the store iterable with `for...of` loops.
      */
-    [(_PendingLocalStateStore_firstUrl = new WeakMap(), _PendingLocalStateStore_pendingStates = new WeakMap(), _PendingLocalStateStore_savedOps = new WeakMap(), _PendingLocalStateStore_blobs = new WeakMap(), _PendingLocalStateStore_attachmentBlobs = new WeakMap(), _PendingLocalStateStore_loadingGroups = new WeakMap(), Symbol.iterator)]() {
+    [Symbol.iterator]() {
         return this.entries();
     }
 }