@fluidframework/container-runtime 2.51.0 → 2.53.0-350190

package/src/storageServiceWithAttachBlobs.ts

@@ -4,23 +4,34 @@
  */
 
 import {
-	IDocumentStorageService,
-	IDocumentStorageServicePolicies,
+	type FetchSource,
+	type ICreateBlobResponse,
+	type IDocumentStorageServicePolicies,
+	type ISnapshot,
+	type ISnapshotFetchOptions,
+	type ISnapshotTree,
+	type ISummaryContext,
+	type ISummaryHandle,
+	type ISummaryTree,
+	type IVersion,
 } from "@fluidframework/driver-definitions/internal";
-import { DocumentStorageServiceProxy } from "@fluidframework/driver-utils/internal";
+import type { IRuntimeStorageService } from "@fluidframework/runtime-definitions/internal";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
 /**
- * IDocumentStorageService proxy which intercepts requests if they can be satisfied by the blobs received in the
+ * IRuntimeStorageService proxy which intercepts requests if they can be satisfied by the blobs received in the
  * attach message. We use this to avoid an unnecessary request to the storage service.
  */
-export class StorageServiceWithAttachBlobs extends DocumentStorageServiceProxy {
+export class StorageServiceWithAttachBlobs implements IRuntimeStorageService {
 	constructor(
-		internalStorageService: IDocumentStorageService,
+		private readonly internalStorageService: IRuntimeStorageService,
 		private readonly attachBlobs: Map<string, ArrayBufferLike>,
-	) {
-		super(internalStorageService);
-	}
+	) {}
 
+	/**
+	 * {@link IRuntimeStorageService.policies}.
+	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
+	 */
 	public get policies(): IDocumentStorageServicePolicies | undefined {
 		return this.internalStorageService.policies;
 	}
@@ -32,7 +43,78 @@ export class StorageServiceWithAttachBlobs extends DocumentStorageServiceProxy {
 		}
 
 		// Note that it is intentional not to cache the result of this readBlob - we'll trust the real
-		// IDocumentStorageService to cache appropriately, no need to double-cache.
+		// IRuntimeStorageService to cache appropriately, no need to double-cache.
 		return this.internalStorageService.readBlob(id);
 	}
+
+	/**
+	 * {@link IRuntimeStorageService.getSnapshotTree}.
+	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
+	 */
+	public async getSnapshotTree(
+		version?: IVersion,
+		scenarioName?: string,
+		// eslint-disable-next-line @rushstack/no-new-null
+	): Promise<ISnapshotTree | null> {
+		return this.internalStorageService.getSnapshotTree(version, scenarioName);
+	}
+
+	/**
+	 * {@link IRuntimeStorageService.getSnapshot}.
+	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
+	 */
+	public async getSnapshot(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot> {
+		if (this.internalStorageService.getSnapshot !== undefined) {
+			return this.internalStorageService.getSnapshot(snapshotFetchOptions);
+		}
+		throw new UsageError(
+			"getSnapshot api should exist on internal storage in documentStorageServiceProxy class",
+		);
+	}
+
+	/**
+	 * {@link IRuntimeStorageService.getVersions}.
+	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
+	 */
+	public async getVersions(
+		// eslint-disable-next-line @rushstack/no-new-null
+		versionId: string | null,
+		count: number,
+		scenarioName?: string,
+		fetchSource?: FetchSource,
+	): Promise<IVersion[]> {
+		return this.internalStorageService.getVersions(
+			versionId,
+			count,
+			scenarioName,
+			fetchSource,
+		);
+	}
+
+	/**
+	 * {@link IRuntimeStorageService.uploadSummaryWithContext}.
+	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
+	 */
+	public async uploadSummaryWithContext(
+		summary: ISummaryTree,
+		context: ISummaryContext,
+	): Promise<string> {
+		return this.internalStorageService.uploadSummaryWithContext(summary, context);
+	}
+
+	/**
+	 * {@link IRuntimeStorageService.createBlob}.
+	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
+	 */
+	public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {
+		return this.internalStorageService.createBlob(file);
+	}
+
+	/**
+	 * {@link IRuntimeStorageService.downloadSummary}.
+	 * @deprecated - This will be removed in a future release. The DataStore layer does not need this.
+	 */
+	public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {
+		return this.internalStorageService.downloadSummary(handle);
+	}
 }

package/src/summary/documentSchema.ts

@@ -4,11 +4,11 @@
  */
 
 import { assert } from "@fluidframework/core-utils/internal";
+import type { SemanticVersion } from "@fluidframework/runtime-utils/internal";
 import type { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 import { DataProcessingError } from "@fluidframework/telemetry-utils/internal";
 import { gt, lt, parse } from "semver-ts";
 
-import type { SemanticVersion } from "../compatUtils.js";
 import { pkgVersion } from "../packageVersion.js";
 
 /**

package/src/summary/summaryFormat.ts

@@ -6,7 +6,6 @@
 import { assert } from "@fluidframework/core-utils/internal";
 import { SummaryType } from "@fluidframework/driver-definitions";
 import {
-	IDocumentStorageService,
 	ISnapshotTree,
 	ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
@@ -15,6 +14,7 @@ import {
 	ISummaryTreeWithStats,
 	channelsTreeName,
 	gcTreeKey,
+	type IRuntimeStorageService,
 } from "@fluidframework/runtime-definitions/internal";
 
 import { blobsTreeName } from "../blobManager/index.js";
@@ -287,7 +287,7 @@ export function wrapSummaryInChannelsTree(summarizeResult: ISummaryTreeWithStats
 }
 
 export async function getFluidDataStoreAttributes(
-	storage: IDocumentStorageService,
+	storage: IRuntimeStorageService,
 	snapshot: ISnapshotTree,
 ): Promise<ReadFluidDataStoreAttributes> {
 	const attributes = await readAndParse<ReadFluidDataStoreAttributes>(

package/dist/compatUtils.d.ts

@@ -1,106 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { ContainerRuntimeOptionsInternal } from "./containerRuntime.js";
-/**
- * Our policy is to support N/N-1 compatibility by default, where N is the most
- * recent public major release of the runtime.
- * Therefore, if the customer does not provide a minVersionForCollab, we will
- * default to use N-1.
- *
- * However, this is not consistent with today's behavior. Some options (i.e.
- * batching, compression) are enabled by default despite not being compatible
- * with 1.x clients. Since the policy was introduced during 2.x's lifespan,
- * N/N-1 compatibility by **default** will be in effect starting with 3.0.
- * Importantly though, N/N-2 compatibility is still guaranteed with the proper
- * configurations set.
- *
- * Further to distinguish unspecified `minVersionForCollab` from a specified
- * version and allow `enableExplicitSchemaControl` to default to `true` for
- * any 2.0.0+ version, we will use a special value of `2.0.0-defaults`, which
- * is semantically less than 2.0.0.
- */
-export declare const defaultMinVersionForCollab: "2.0.0-defaults";
-/**
- * String in a valid semver format specifying bottom of a minor version
- * or special "defaults" prerelease of a major.
- * @remarks Only 2.0.0-defaults is expected, but index signatures cannot be a
- * literal; so, just allow any major -defaults prerelease.
- */
-export type MinimumMinorSemanticVersion = `${bigint}.${bigint}.0` | `${bigint}.0.0-defaults`;
-/**
- * String in a valid semver format of a specific version at least specifying minor.
- *
- * @legacy
- * @alpha
- */
-export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
-/**
- * String in a valid semver format of a specific version at least specifying minor.
- * Unlike {@link MinimumVersionForCollab}, this type allows any bigint for the major version.
- * Used as a more generic type that allows major versions other than 1 or 2.
- *
- * @internal
- */
-export type SemanticVersion = `${bigint}.${bigint}.${bigint}` | `${bigint}.${bigint}.${bigint}-${string}`;
-/**
- * Generic type for runtimeOptionsAffectingDocSchemaConfigMap
- */
-export type ConfigMap<T extends Record<string, unknown>> = {
-    [K in keyof T]-?: {
-        [version: MinimumMinorSemanticVersion]: T[K];
-    };
-};
-/**
- * Generic type for runtimeOptionsAffectingDocSchemaConfigValidationMap
- */
-export type ConfigValidationMap<T extends Record<string, unknown>> = {
-    [K in keyof T]-?: (configValue: T[K]) => SemanticVersion | undefined;
-};
-/**
- * Subset of the {@link ContainerRuntimeOptionsInternal} properties which
- * affect {@link IDocumentSchemaFeatures}.
- *
- * @remarks
- * When a new option is added to {@link ContainerRuntimeOptionsInternal}, we
- * must consider if it changes the DocumentSchema. If so, then a corresponding
- * entry must be added to {@link runtimeOptionsAffectingDocSchemaConfigMap}
- * below. If not, then it must be omitted from this type.
- *
- * Note: `Omit` is used instead of `Pick` to ensure that all new options are
- * included in this type by default. If any new properties are added to
- * {@link ContainerRuntimeOptionsInternal}, they will be included in this
- * type unless explicitly omitted. This will prevent us from forgetting to
- * account for any new properties in the future.
- */
-export type RuntimeOptionsAffectingDocSchema = Omit<ContainerRuntimeOptionsInternal, "chunkSizeInBytes" | "maxBatchSizeInBytes" | "loadSequenceNumberVerification" | "summaryOptions">;
-/**
- * Returns the default RuntimeOptionsAffectingDocSchema configuration for a given minVersionForCollab.
- */
-export declare function getMinVersionForCollabDefaults(minVersionForCollab: MinimumVersionForCollab): RuntimeOptionsAffectingDocSchema;
-/**
- * Returns a default configuration given minVersionForCollab and configuration version map.
- */
-export declare function getConfigsForMinVersionForCollab<T extends Record<SemanticVersion, unknown>>(minVersionForCollab: SemanticVersion, configMap: ConfigMap<T>): Partial<T>;
-/**
- * Checks if the minVersionForCollab is valid.
- * A valid minVersionForCollab is a MinimumVersionForCollab that is at least `lowestMinVersionForCollab` and less than or equal to the current package version.
- */
-export declare function isValidMinVersionForCollab(minVersionForCollab: MinimumVersionForCollab): boolean;
-/**
- * Validates if the runtime options passed in from the user are compatible with the minVersionForCollab.
- * For example, if a user sets the `enableGroupedBatching` option to true, but the minVersionForCollab
- * is set to "1.0.0", then we should throw a UsageError since 1.x clients do not support batching.
- * */
-export declare function validateRuntimeOptions(minVersionForCollab: MinimumVersionForCollab, runtimeOptions: Partial<ContainerRuntimeOptionsInternal>): void;
-/**
- * Generic function to validate runtime options against the minVersionForCollab.
- */
-export declare function getValidationForRuntimeOptions<T extends Record<string, unknown>>(minVersionForCollab: SemanticVersion, runtimeOptions: Partial<T>, validationMap: ConfigValidationMap<T>): void;
-/**
- * Helper function to map ContainerRuntimeOptionsInternal config values to
- * minVersionForCollab in {@link runtimeOptionsAffectingDocSchemaConfigValidationMap}.
- */
-export declare function configValueToMinVersionForCollab<T extends string | number | boolean | undefined | object, Arr extends readonly [T, SemanticVersion][]>(configToMinVer: Arr): (configValue: T) => SemanticVersion | undefined;
-//# sourceMappingURL=compatUtils.d.ts.map

package/dist/compatUtils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"compatUtils.d.ts","sourceRoot":"","sources":["../src/compatUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAWH,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAC;AAG7E;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,0BAA0B,kBACqB,CAAC;AAU7D;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GAAG,GAAG,MAAM,IAAI,MAAM,IAAI,GAAG,GAAG,MAAM,eAAe,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAChC,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,EAAE,GAC9B,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GACxB,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,GAC/B,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;KACzD,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG;QACjB,CAAC,OAAO,EAAE,2BAA2B,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAC7C;CACD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;KACnE,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,eAAe,GAAG,SAAS;CACpE,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,gCAAgC,GAAG,IAAI,CAClD,+BAA+B,EAC7B,kBAAkB,GAClB,qBAAqB,GACrB,gCAAgC,GAChC,gBAAgB,CAClB,CAAC;AAsGF;;GAEG;AACH,wBAAgB,8BAA8B,CAC7C,mBAAmB,EAAE,uBAAuB,GAC1C,gCAAgC,CAOlC;AAED;;GAEG;AACH,wBAAgB,gCAAgC,CAAC,CAAC,SAAS,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,EAC1F,mBAAmB,EAAE,eAAe,EACpC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GACrB,OAAO,CAAC,CAAC,CAAC,CAqBZ;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACzC,mBAAmB,EAAE,uBAAuB,GAC1C,OAAO,CAMT;AAED;;;;KAIK;AACL,wBAAgB,sBAAsB,CACrC,mBAAmB,EAAE,uBAAuB,EAC5C,cAAc,EAAE,OAAO,CAAC,+BAA+B,CAAC,GACtD,IAAI,CAMN;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/E,mBAAmB,EAAE,eAAe,EACpC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,EAC1B,aAAa,EAAE,mBAAmB,CAAC,CAAC,CAAC,GACnC,IAAI,CAwBN;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAC/C,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,EACxD,GAAG,SAAS,SAAS,CAAC,CAAC,EAAE,eAAe,CAAC,EAAE,EAC1C,cAAc,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC,KAAK,eAAe,GAAG,SAAS,CAoCtE"}

package/dist/compatUtils.js

@@ -1,251 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.configValueToMinVersionForCollab = exports.getValidationForRuntimeOptions = exports.validateRuntimeOptions = exports.isValidMinVersionForCollab = exports.getConfigsForMinVersionForCollab = exports.getMinVersionForCollabDefaults = exports.defaultMinVersionForCollab = void 0;
-const internal_1 = require("@fluidframework/core-utils/internal");
-const internal_2 = require("@fluidframework/runtime-definitions/internal");
-const internal_3 = require("@fluidframework/telemetry-utils/internal");
-const semver_ts_1 = require("semver-ts");
-const compressionDefinitions_js_1 = require("./compressionDefinitions.js");
-const packageVersion_js_1 = require("./packageVersion.js");
-/**
- * Our policy is to support N/N-1 compatibility by default, where N is the most
- * recent public major release of the runtime.
- * Therefore, if the customer does not provide a minVersionForCollab, we will
- * default to use N-1.
- *
- * However, this is not consistent with today's behavior. Some options (i.e.
- * batching, compression) are enabled by default despite not being compatible
- * with 1.x clients. Since the policy was introduced during 2.x's lifespan,
- * N/N-1 compatibility by **default** will be in effect starting with 3.0.
- * Importantly though, N/N-2 compatibility is still guaranteed with the proper
- * configurations set.
- *
- * Further to distinguish unspecified `minVersionForCollab` from a specified
- * version and allow `enableExplicitSchemaControl` to default to `true` for
- * any 2.0.0+ version, we will use a special value of `2.0.0-defaults`, which
- * is semantically less than 2.0.0.
- */
-exports.defaultMinVersionForCollab = "2.0.0-defaults";
-/**
- * We don't want allow a version before the major public release of the LTS version.
- * Today we use "1.0.0", because our policy supports N/N-1 & N/N-2, which includes
- * all minor versions of N. Though LTS starts at 1.4.0, we should stay consistent
- * with our policy and allow all 1.x versions to be compatible with 2.x.
- */
-const lowestMinVersionForCollab = "1.0.0";
-/**
- * Mapping of RuntimeOptionsAffectingDocSchema to their compatibility related configs.
- *
- * Each key in this map corresponds to a property in RuntimeOptionsAffectingDocSchema. The value is an object that maps MinimumVersionForCollab
- * to the appropriate default value for that property to supporting that MinimumVersionForCollab. If clients running MinimumVersionForCollab X are able to understand
- * the format changes introduced by the property, then the default value for that MinimumVersionForCollab will enable the feature associated with the property.
- * Otherwise, the feature will be disabled.
- *
- * For example if the minVersionForCollab is a 1.x version (i.e. "1.5.0"), then the default value for `enableGroupedBatching` will be false since 1.x
- * clients do not understand the document format when batching is enabled. If the minVersionForCollab is a 2.x client (i.e. "2.0.0" or later), then the
- * default value for `enableGroupedBatching` will be true because clients running 2.0 or later will be able to understand the format changes associated
- * with the batching feature.
- */
-const runtimeOptionsAffectingDocSchemaConfigMap = {
-    enableGroupedBatching: {
-        "1.0.0": false,
-        "2.0.0-defaults": true,
-    },
-    compressionOptions: {
-        "1.0.0": compressionDefinitions_js_1.disabledCompressionConfig,
-        "2.0.0-defaults": compressionDefinitions_js_1.enabledCompressionConfig,
-    },
-    enableRuntimeIdCompressor: {
-        // For IdCompressorMode, `undefined` represents a logical state (off).
-        // However, to satisfy the Required<> constraint while
-        // `exactOptionalPropertyTypes` is `false` (TODO: AB#8215), we need
-        // to have it defined, so we trick the type checker here.
-        "1.0.0": undefined,
-        // We do not yet want to enable idCompressor by default since it will
-        // increase bundle sizes, and not all customers will benefit from it.
-        // Therefore, we will require customers to explicitly enable it. We
-        // are keeping it as a DocSchema affecting option for now as this may
-        // change in the future.
-    },
-    explicitSchemaControl: {
-        "1.0.0": false,
-        // This option's intention is to prevent 1.x clients from joining sessions
-        // when enabled. This is set to true when the minVersionForCollab is set
-        // to >=2.0.0 (explicitly). This is different than other 2.0 defaults
-        // because it was not enabled by default prior to the implementation of
-        // `minVersionForCollab`.
-        // `defaultMinVersionForCollab` is set to "2.0.0-defaults" which "2.0.0"
-        // does not satisfy to avoiding enabling this option by default as of
-        // `minVersionForCollab` introduction, which could be unexpected.
-        // Only enable as a default when `minVersionForCollab` is specified at
-        // 2.0.0+.
-        "2.0.0": true,
-    },
-    flushMode: {
-        // Note: 1.x clients are compatible with TurnBased flushing, but here we elect to remain on Immediate flush mode
-        // as a work-around for inability to send batches larger than 1Mb. Immediate flushing keeps batches smaller as
-        // fewer messages will be included per flush.
-        "1.0.0": internal_2.FlushMode.Immediate,
-        "2.0.0-defaults": internal_2.FlushMode.TurnBased,
-    },
-    gcOptions: {
-        "1.0.0": {},
-        // Although sweep is supported in 2.x, it is disabled by default until minVersionForCollab>=3.0.0 to be extra safe.
-        "3.0.0": { enableGCSweep: true },
-    },
-    createBlobPayloadPending: {
-        // This feature is new and disabled by default. In the future we will enable it by default, but we have not
-        // closed on the version where that will happen yet.  Probably a .10 release since blob functionality is not
-        // exposed on the `@public` API surface.
-        "1.0.0": undefined,
-    },
-};
-const runtimeOptionsAffectingDocSchemaConfigValidationMap = {
-    enableGroupedBatching: configValueToMinVersionForCollab([
-        [false, "1.0.0"],
-        [true, "2.0.0-defaults"],
-    ]),
-    compressionOptions: configValueToMinVersionForCollab([
-        [{ ...compressionDefinitions_js_1.disabledCompressionConfig }, "1.0.0"],
-        [{ ...compressionDefinitions_js_1.enabledCompressionConfig }, "2.0.0-defaults"],
-    ]),
-    enableRuntimeIdCompressor: configValueToMinVersionForCollab([
-        [undefined, "1.0.0"],
-        ["on", "2.0.0-defaults"],
-        ["delayed", "2.0.0-defaults"],
-    ]),
-    explicitSchemaControl: configValueToMinVersionForCollab([
-        [false, "1.0.0"],
-        [true, "2.0.0-defaults"],
-    ]),
-    flushMode: configValueToMinVersionForCollab([
-        [internal_2.FlushMode.Immediate, "1.0.0"],
-        [internal_2.FlushMode.TurnBased, "2.0.0-defaults"],
-    ]),
-    gcOptions: configValueToMinVersionForCollab([
-        [{ enableGCSweep: undefined }, "1.0.0"],
-        [{ enableGCSweep: true }, "2.0.0-defaults"],
-    ]),
-    createBlobPayloadPending: configValueToMinVersionForCollab([
-        [undefined, "1.0.0"],
-        [true, "2.40.0"],
-    ]),
-};
-/**
- * Returns the default RuntimeOptionsAffectingDocSchema configuration for a given minVersionForCollab.
- */
-function getMinVersionForCollabDefaults(minVersionForCollab) {
-    return getConfigsForMinVersionForCollab(minVersionForCollab, runtimeOptionsAffectingDocSchemaConfigMap);
-}
-exports.getMinVersionForCollabDefaults = getMinVersionForCollabDefaults;
-/**
- * Returns a default configuration given minVersionForCollab and configuration version map.
- */
-function getConfigsForMinVersionForCollab(minVersionForCollab, configMap) {
-    const defaultConfigs = {};
-    // Iterate over configMap to get default values for each option.
-    for (const key of Object.keys(configMap)) {
-        const config = configMap[key];
-        // Sort the versions in ascending order so we can short circuit the loop.
-        const versions = Object.keys(config).sort(semver_ts_1.compare);
-        // For each config, we iterate over the keys and check if minVersionForCollab is greater than or equal to the version.
-        // If so, we set it as the default value for the option. At the end of the loop we should have the most recent default
-        // value that is compatible with the version specified as the minVersionForCollab.
-        for (const version of versions) {
-            if ((0, semver_ts_1.gte)(minVersionForCollab, version)) {
-                defaultConfigs[key] = config[version];
-            }
-            else {
-                // If the minVersionForCollab is less than the version, we break out of the loop since we don't need to check
-                // any later versions.
-                break;
-            }
-        }
-    }
-    return defaultConfigs;
-}
-exports.getConfigsForMinVersionForCollab = getConfigsForMinVersionForCollab;
-/**
- * Checks if the minVersionForCollab is valid.
- * A valid minVersionForCollab is a MinimumVersionForCollab that is at least `lowestMinVersionForCollab` and less than or equal to the current package version.
- */
-function isValidMinVersionForCollab(minVersionForCollab) {
-    return ((0, semver_ts_1.valid)(minVersionForCollab) !== null &&
-        (0, semver_ts_1.gte)(minVersionForCollab, lowestMinVersionForCollab) &&
-        (0, semver_ts_1.lte)(minVersionForCollab, packageVersion_js_1.pkgVersion));
-}
-exports.isValidMinVersionForCollab = isValidMinVersionForCollab;
-/**
- * Validates if the runtime options passed in from the user are compatible with the minVersionForCollab.
- * For example, if a user sets the `enableGroupedBatching` option to true, but the minVersionForCollab
- * is set to "1.0.0", then we should throw a UsageError since 1.x clients do not support batching.
- * */
-function validateRuntimeOptions(minVersionForCollab, runtimeOptions) {
-    getValidationForRuntimeOptions(minVersionForCollab, runtimeOptions, runtimeOptionsAffectingDocSchemaConfigValidationMap);
-}
-exports.validateRuntimeOptions = validateRuntimeOptions;
-/**
- * Generic function to validate runtime options against the minVersionForCollab.
- */
-function getValidationForRuntimeOptions(minVersionForCollab, runtimeOptions, validationMap) {
-    if (minVersionForCollab === exports.defaultMinVersionForCollab) {
-        // If the minVersionForCollab is set to the default value, then we will not validate the runtime options
-        // This is to avoid disruption to users who have not yet set the minVersionForCollab value explicitly.
-        return;
-    }
-    // Iterate through each runtime option passed in by the user
-    for (const [passedRuntimeOption, passedRuntimeOptionValue] of Object.entries(runtimeOptions)) {
-        // Skip if passedRuntimeOption is not in validation map
-        if (!(passedRuntimeOption in validationMap)) {
-            continue;
-        }
-        const requiredVersion = validationMap[passedRuntimeOption](passedRuntimeOptionValue);
-        if (requiredVersion !== undefined && (0, semver_ts_1.gt)(requiredVersion, minVersionForCollab)) {
-            throw new internal_3.UsageError(`Runtime option ${passedRuntimeOption}:${JSON.stringify(passedRuntimeOptionValue)} requires ` +
-                `runtime version ${requiredVersion}. Please update minVersionForCollab ` +
-                `(currently ${minVersionForCollab}) to ${requiredVersion} or later to proceed.`);
-        }
-    }
-}
-exports.getValidationForRuntimeOptions = getValidationForRuntimeOptions;
-/**
- * Helper function to map ContainerRuntimeOptionsInternal config values to
- * minVersionForCollab in {@link runtimeOptionsAffectingDocSchemaConfigValidationMap}.
- */
-function configValueToMinVersionForCollab(configToMinVer) {
-    const configValueToRequiredVersionMap = new Map(configToMinVer);
-    return (configValue) => {
-        // If the configValue is not an object then we can get the version required directly from the map.
-        if (typeof configValue !== "object") {
-            return configValueToRequiredVersionMap.get(configValue);
-        }
-        // When the input `configValue` is an object, this logic determines the minimum runtime version it requires.
-        // It iterates through each entry in `configValueToRequiredVersionMap`. If `possibleConfigValue` shares at
-        // least one key-value pair with the input `configValue`, its associated `versionRequired` is collected into
-        // `matchingVersions`. After checking all entries, the highest among the collected versions is returned.
-        // This represents the overall minimum version required to support the features implied by the input `configValue`.
-        const matchingVersions = [];
-        for (const [possibleConfigValue, versionRequired,] of configValueToRequiredVersionMap.entries()) {
-            (0, internal_1.assert)(typeof possibleConfigValue == "object", 0xbb9 /* possibleConfigValue should be an object */);
-            // Check if `possibleConfigValue` and the input `configValue` share at least one
-            // common key-value pair. If they do, the `versionRequired` for this `possibleConfigValue`
-            // is added to `matchingVersions`.
-            if (Object.entries(possibleConfigValue).some(([k, v]) => configValue[k] === v)) {
-                matchingVersions.push(versionRequired);
-            }
-        }
-        if (matchingVersions.length > 0) {
-            // Return the latest minVersionForCollab among all matches.
-            return matchingVersions.sort((a, b) => (0, semver_ts_1.compare)(b, a))[0];
-        }
-        // If no matches then we return undefined. This means that the config value passed in
-        // does not require a specific minVersionForCollab to be valid.
-        return undefined;
-    };
-}
-exports.configValueToMinVersionForCollab = configValueToMinVersionForCollab;
-//# sourceMappingURL=compatUtils.js.map

package/dist/compatUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"compatUtils.js","sourceRoot":"","sources":["../src/compatUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAC7D,2EAAyE;AACzE,uEAAsE;AACtE,yCAAyD;AAEzD,2EAGqC;AAErC,2DAAiD;AAEjD;;;;;;;;;;;;;;;;;GAiBG;AACU,QAAA,0BAA0B,GACtC,gBAA2D,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,yBAAyB,GAAG,OAAkD,CAAC;AAuErF;;;;;;;;;;;;GAYG;AACH,MAAM,yCAAyC,GAAG;IACjD,qBAAqB,EAAE;QACtB,OAAO,EAAE,KAAK;QACd,gBAAgB,EAAE,IAAI;KACtB;IACD,kBAAkB,EAAE;QACnB,OAAO,EAAE,qDAAyB;QAClC,gBAAgB,EAAE,oDAAwB;KAC1C;IACD,yBAAyB,EAAE;QAC1B,sEAAsE;QACtE,sDAAsD;QACtD,mEAAmE;QACnE,yDAAyD;QACzD,OAAO,EAAE,SAAS;QAClB,qEAAqE;QACrE,qEAAqE;QACrE,mEAAmE;QACnE,qEAAqE;QACrE,wBAAwB;KACxB;IACD,qBAAqB,EAAE;QACtB,OAAO,EAAE,KAAK;QACd,0EAA0E;QAC1E,wEAAwE;QACxE,qEAAqE;QACrE,uEAAuE;QACvE,yBAAyB;QACzB,wEAAwE;QACxE,qEAAqE;QACrE,iEAAiE;QACjE,sEAAsE;QACtE,UAAU;QACV,OAAO,EAAE,IAAI;KACb;IACD,SAAS,EAAE;QACV,gHAAgH;QAChH,8GAA8G;QAC9G,6CAA6C;QAC7C,OAAO,EAAE,oBAAS,CAAC,SAAS;QAC5B,gBAAgB,EAAE,oBAAS,CAAC,SAAS;KACrC;IACD,SAAS,EAAE;QACV,OAAO,EAAE,EAAE;QACX,mHAAmH;QACnH,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE;KAChC;IACD,wBAAwB,EAAE;QACzB,2GAA2G;QAC3G,4GAA4G;QAC5G,wCAAwC;QACxC,OAAO,EAAE,SAAS;KAClB;CAC8D,CAAC;AAEjE,MAAM,mDAAmD,GAAG;IAC3D,qBAAqB,EAAE,gCAAgC,CAAC;QACvD,CAAC,KAAK,EAAE,OAAO,CAAC;QAChB,CAAC,IAAI,EAAE,gBAAgB,CAAC;KACxB,CAAC;IACF,kBAAkB,EAAE,gCAAgC,CAAC;QACpD,CAAC,EAAE,GAAG,qDAAyB,EAAE,EAAE,OAAO,CAAC;QAC3C,CAAC,EAAE,GAAG,oDAAwB,EAAE,EAAE,gBAAgB,CAAC;KACnD,CAAC;IACF,yBAAyB,EAAE,gCAAgC,CAAC;QAC3D,CAAC,SAAS,EAAE,OAAO,CAAC;QACpB,CAAC,IAAI,EAAE,gBAAgB,CAAC;QACxB,CAAC,SAAS,EAAE,gBAAgB,CAAC;KAC7B,CAAC;IACF,qBAAqB,EAAE,gCAAgC,CAAC;QACvD,CAAC,KAAK,EAAE,OAAO,CAAC;QAChB,CAAC,IAAI,EAAE,gBAAgB,CAAC;KACxB,CAAC;IACF,SAAS,EAAE,gCAAgC,CAAC;QAC3C,CAAC,oBAAS,CAAC,SAAS,EAAE,OAAO,CAAC;QAC9B,CAAC,oBAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC;KACvC,CAAC;IACF,SAAS,EAAE,gCAAgC,CAAC;QAC3C,CAAC,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC;QACvC,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,gBAAgB,CAAC;KAC3C,CAAC;IACF,wBAAwB,EAAE,gCAAgC,CAAC;QAC1D,CAAC,SAAS,EAAE,OAAO,CAAC;QACpB,CAAC,IAAI,EAAE,QAAQ,CAAC;KAChB,CAAC;CACuE,CAAC;AAE3E;;GAEG;AACH,SAAgB,8BAA8B,CAC7C,mBAA4C;IAE5C,OAAO,gCAAgC,CACtC,mBAAmB,EACnB,yCAAyC,CAGL,CAAC;AACvC,CAAC;AATD,wEASC;AAED;;GAEG;AACH,SAAgB,gCAAgC,CAC/C,mBAAoC,EACpC,SAAuB;IAEvB,MAAM,cAAc,GAAe,EAAE,CAAC;IACtC,gEAAgE;IAChE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1C,MAAM,MAAM,GAAG,SAAS,CAAC,GAAc,CAAC,CAAC;QACzC,yEAAyE;QACzE,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,mBAAO,CAAC,CAAC;QACnD,sHAAsH;QACtH,sHAAsH;QACtH,kFAAkF;QAClF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAChC,IAAI,IAAA,eAAG,EAAC,mBAAmB,EAAE,OAAO,CAAC,EAAE,CAAC;gBACvC,cAAc,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,OAAsC,CAAC,CAAC;YACtE,CAAC;iBAAM,CAAC;gBACP,6GAA6G;gBAC7G,sBAAsB;gBACtB,MAAM;YACP,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,cAAc,CAAC;AACvB,CAAC;AAxBD,4EAwBC;AAED;;;GAGG;AACH,SAAgB,0BAA0B,CACzC,mBAA4C;IAE5C,OAAO,CACN,IAAA,iBAAK,EAAC,mBAAmB,CAAC,KAAK,IAAI;QACnC,IAAA,eAAG,EAAC,mBAAmB,EAAE,yBAAyB,CAAC;QACnD,IAAA,eAAG,EAAC,mBAAmB,EAAE,8BAAU,CAAC,CACpC,CAAC;AACH,CAAC;AARD,gEAQC;AAED;;;;KAIK;AACL,SAAgB,sBAAsB,CACrC,mBAA4C,EAC5C,cAAwD;IAExD,8BAA8B,CAC7B,mBAAmB,EACnB,cAA2D,EAC3D,mDAAmD,CACnD,CAAC;AACH,CAAC;AATD,wDASC;AAED;;GAEG;AACH,SAAgB,8BAA8B,CAC7C,mBAAoC,EACpC,cAA0B,EAC1B,aAAqC;IAErC,IAAI,mBAAmB,KAAK,kCAA0B,EAAE,CAAC;QACxD,wGAAwG;QACxG,sGAAsG;QACtG,OAAO;IACR,CAAC;IACD,4DAA4D;IAC5D,KAAK,MAAM,CAAC,mBAAmB,EAAE,wBAAwB,CAAC,IAAI,MAAM,CAAC,OAAO,CAC3E,cAAc,CAC+B,EAAE,CAAC;QAChD,uDAAuD;QACvD,IAAI,CAAC,CAAC,mBAAmB,IAAI,aAAa,CAAC,EAAE,CAAC;YAC7C,SAAS;QACV,CAAC;QAED,MAAM,eAAe,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAAC,wBAAwB,CAAC,CAAC;QACrF,IAAI,eAAe,KAAK,SAAS,IAAI,IAAA,cAAE,EAAC,eAAe,EAAE,mBAAmB,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,qBAAU,CACnB,kBAAkB,mBAAmB,IAAI,IAAI,CAAC,SAAS,CAAC,wBAAwB,CAAC,YAAY;gBAC5F,mBAAmB,eAAe,sCAAsC;gBACxE,cAAc,mBAAmB,QAAQ,eAAe,uBAAuB,CAChF,CAAC;QACH,CAAC;IACF,CAAC;AACF,CAAC;AA5BD,wEA4BC;AAED;;;GAGG;AACH,SAAgB,gCAAgC,CAG9C,cAAmB;IACpB,MAAM,+BAA+B,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;IAChE,OAAO,CAAC,WAAc,EAAE,EAAE;QACzB,kGAAkG;QAClG,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACrC,OAAO,+BAA+B,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACzD,CAAC;QACD,4GAA4G;QAC5G,0GAA0G;QAC1G,4GAA4G;QAC5G,wGAAwG;QACxG,mHAAmH;QACnH,MAAM,gBAAgB,GAAsB,EAAE,CAAC;QAC/C,KAAK,MAAM,CACV,mBAAmB,EACnB,eAAe,EACf,IAAI,+BAA+B,CAAC,OAAO,EAAE,EAAE,CAAC;YAChD,IAAA,iBAAM,EACL,OAAO,mBAAmB,IAAI,QAAQ,EACtC,KAAK,CAAC,6CAA6C,CACnD,CAAC;YACF,gFAAgF;YAChF,0FAA0F;YAC1F,kCAAkC;YAClC,IAAI,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBAChF,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACxC,CAAC;QACF,CAAC;QACD,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,2DAA2D;YAC3D,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAA,mBAAO,EAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,CAAC;QACD,qFAAqF;QACrF,+DAA+D;QAC/D,OAAO,SAAS,CAAC;IAClB,CAAC,CAAC;AACH,CAAC;AAvCD,4EAuCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { FlushMode } from \"@fluidframework/runtime-definitions/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\nimport { compare, gt, gte, lte, valid } from \"semver-ts\";\n\nimport {\n\tdisabledCompressionConfig,\n\tenabledCompressionConfig,\n} from \"./compressionDefinitions.js\";\nimport type { ContainerRuntimeOptionsInternal } from \"./containerRuntime.js\";\nimport { pkgVersion } from \"./packageVersion.js\";\n\n/**\n * Our policy is to support N/N-1 compatibility by default, where N is the most\n * recent public major release of the runtime.\n * Therefore, if the customer does not provide a minVersionForCollab, we will\n * default to use N-1.\n *\n * However, this is not consistent with today's behavior. Some options (i.e.\n * batching, compression) are enabled by default despite not being compatible\n * with 1.x clients. Since the policy was introduced during 2.x's lifespan,\n * N/N-1 compatibility by **default** will be in effect starting with 3.0.\n * Importantly though, N/N-2 compatibility is still guaranteed with the proper\n * configurations set.\n *\n * Further to distinguish unspecified `minVersionForCollab` from a specified\n * version and allow `enableExplicitSchemaControl` to default to `true` for\n * any 2.0.0+ version, we will use a special value of `2.0.0-defaults`, which\n * is semantically less than 2.0.0.\n */\nexport const defaultMinVersionForCollab =\n\t\"2.0.0-defaults\" as const satisfies MinimumVersionForCollab;\n\n/**\n * We don't want allow a version before the major public release of the LTS version.\n * Today we use \"1.0.0\", because our policy supports N/N-1 & N/N-2, which includes\n * all minor versions of N. Though LTS starts at 1.4.0, we should stay consistent\n * with our policy and allow all 1.x versions to be compatible with 2.x.\n */\nconst lowestMinVersionForCollab = \"1.0.0\" as const satisfies MinimumVersionForCollab;\n\n/**\n * String in a valid semver format specifying bottom of a minor version\n * or special \"defaults\" prerelease of a major.\n * @remarks Only 2.0.0-defaults is expected, but index signatures cannot be a\n * literal; so, just allow any major -defaults prerelease.\n */\nexport type MinimumMinorSemanticVersion = `${bigint}.${bigint}.0` | `${bigint}.0.0-defaults`;\n\n/**\n * String in a valid semver format of a specific version at least specifying minor.\n *\n * @legacy\n * @alpha\n */\nexport type MinimumVersionForCollab =\n\t| `${1 | 2}.${bigint}.${bigint}`\n\t| `${1 | 2}.${bigint}.${bigint}-${string}`;\n\n/**\n * String in a valid semver format of a specific version at least specifying minor.\n * Unlike {@link MinimumVersionForCollab}, this type allows any bigint for the major version.\n * Used as a more generic type that allows major versions other than 1 or 2.\n *\n * @internal\n */\nexport type SemanticVersion =\n\t| `${bigint}.${bigint}.${bigint}`\n\t| `${bigint}.${bigint}.${bigint}-${string}`;\n\n/**\n * Generic type for runtimeOptionsAffectingDocSchemaConfigMap\n */\nexport type ConfigMap<T extends Record<string, unknown>> = {\n\t[K in keyof T]-?: {\n\t\t[version: MinimumMinorSemanticVersion]: T[K];\n\t};\n};\n\n/**\n * Generic type for runtimeOptionsAffectingDocSchemaConfigValidationMap\n */\nexport type ConfigValidationMap<T extends Record<string, unknown>> = {\n\t[K in keyof T]-?: (configValue: T[K]) => SemanticVersion | undefined;\n};\n\n/**\n * Subset of the {@link ContainerRuntimeOptionsInternal} properties which\n * affect {@link IDocumentSchemaFeatures}.\n *\n * @remarks\n * When a new option is added to {@link ContainerRuntimeOptionsInternal}, we\n * must consider if it changes the DocumentSchema. If so, then a corresponding\n * entry must be added to {@link runtimeOptionsAffectingDocSchemaConfigMap}\n * below. If not, then it must be omitted from this type.\n *\n * Note: `Omit` is used instead of `Pick` to ensure that all new options are\n * included in this type by default. If any new properties are added to\n * {@link ContainerRuntimeOptionsInternal}, they will be included in this\n * type unless explicitly omitted. This will prevent us from forgetting to\n * account for any new properties in the future.\n */\nexport type RuntimeOptionsAffectingDocSchema = Omit<\n\tContainerRuntimeOptionsInternal,\n\t| \"chunkSizeInBytes\"\n\t| \"maxBatchSizeInBytes\"\n\t| \"loadSequenceNumberVerification\"\n\t| \"summaryOptions\"\n>;\n\n/**\n * Mapping of RuntimeOptionsAffectingDocSchema to their compatibility related configs.\n *\n * Each key in this map corresponds to a property in RuntimeOptionsAffectingDocSchema. The value is an object that maps MinimumVersionForCollab\n * to the appropriate default value for that property to supporting that MinimumVersionForCollab. If clients running MinimumVersionForCollab X are able to understand\n * the format changes introduced by the property, then the default value for that MinimumVersionForCollab will enable the feature associated with the property.\n * Otherwise, the feature will be disabled.\n *\n * For example if the minVersionForCollab is a 1.x version (i.e. \"1.5.0\"), then the default value for `enableGroupedBatching` will be false since 1.x\n * clients do not understand the document format when batching is enabled. If the minVersionForCollab is a 2.x client (i.e. \"2.0.0\" or later), then the\n * default value for `enableGroupedBatching` will be true because clients running 2.0 or later will be able to understand the format changes associated\n * with the batching feature.\n */\nconst runtimeOptionsAffectingDocSchemaConfigMap = {\n\tenableGroupedBatching: {\n\t\t\"1.0.0\": false,\n\t\t\"2.0.0-defaults\": true,\n\t},\n\tcompressionOptions: {\n\t\t\"1.0.0\": disabledCompressionConfig,\n\t\t\"2.0.0-defaults\": enabledCompressionConfig,\n\t},\n\tenableRuntimeIdCompressor: {\n\t\t// For IdCompressorMode, `undefined` represents a logical state (off).\n\t\t// However, to satisfy the Required<> constraint while\n\t\t// `exactOptionalPropertyTypes` is `false` (TODO: AB#8215), we need\n\t\t// to have it defined, so we trick the type checker here.\n\t\t\"1.0.0\": undefined,\n\t\t// We do not yet want to enable idCompressor by default since it will\n\t\t// increase bundle sizes, and not all customers will benefit from it.\n\t\t// Therefore, we will require customers to explicitly enable it. We\n\t\t// are keeping it as a DocSchema affecting option for now as this may\n\t\t// change in the future.\n\t},\n\texplicitSchemaControl: {\n\t\t\"1.0.0\": false,\n\t\t// This option's intention is to prevent 1.x clients from joining sessions\n\t\t// when enabled. This is set to true when the minVersionForCollab is set\n\t\t// to >=2.0.0 (explicitly). This is different than other 2.0 defaults\n\t\t// because it was not enabled by default prior to the implementation of\n\t\t// `minVersionForCollab`.\n\t\t// `defaultMinVersionForCollab` is set to \"2.0.0-defaults\" which \"2.0.0\"\n\t\t// does not satisfy to avoiding enabling this option by default as of\n\t\t// `minVersionForCollab` introduction, which could be unexpected.\n\t\t// Only enable as a default when `minVersionForCollab` is specified at\n\t\t// 2.0.0+.\n\t\t\"2.0.0\": true,\n\t},\n\tflushMode: {\n\t\t// Note: 1.x clients are compatible with TurnBased flushing, but here we elect to remain on Immediate flush mode\n\t\t// as a work-around for inability to send batches larger than 1Mb. Immediate flushing keeps batches smaller as\n\t\t// fewer messages will be included per flush.\n\t\t\"1.0.0\": FlushMode.Immediate,\n\t\t\"2.0.0-defaults\": FlushMode.TurnBased,\n\t},\n\tgcOptions: {\n\t\t\"1.0.0\": {},\n\t\t// Although sweep is supported in 2.x, it is disabled by default until minVersionForCollab>=3.0.0 to be extra safe.\n\t\t\"3.0.0\": { enableGCSweep: true },\n\t},\n\tcreateBlobPayloadPending: {\n\t\t// This feature is new and disabled by default. In the future we will enable it by default, but we have not\n\t\t// closed on the version where that will happen yet.  Probably a .10 release since blob functionality is not\n\t\t// exposed on the `@public` API surface.\n\t\t\"1.0.0\": undefined,\n\t},\n} as const satisfies ConfigMap<RuntimeOptionsAffectingDocSchema>;\n\nconst runtimeOptionsAffectingDocSchemaConfigValidationMap = {\n\tenableGroupedBatching: configValueToMinVersionForCollab([\n\t\t[false, \"1.0.0\"],\n\t\t[true, \"2.0.0-defaults\"],\n\t]),\n\tcompressionOptions: configValueToMinVersionForCollab([\n\t\t[{ ...disabledCompressionConfig }, \"1.0.0\"],\n\t\t[{ ...enabledCompressionConfig }, \"2.0.0-defaults\"],\n\t]),\n\tenableRuntimeIdCompressor: configValueToMinVersionForCollab([\n\t\t[undefined, \"1.0.0\"],\n\t\t[\"on\", \"2.0.0-defaults\"],\n\t\t[\"delayed\", \"2.0.0-defaults\"],\n\t]),\n\texplicitSchemaControl: configValueToMinVersionForCollab([\n\t\t[false, \"1.0.0\"],\n\t\t[true, \"2.0.0-defaults\"],\n\t]),\n\tflushMode: configValueToMinVersionForCollab([\n\t\t[FlushMode.Immediate, \"1.0.0\"],\n\t\t[FlushMode.TurnBased, \"2.0.0-defaults\"],\n\t]),\n\tgcOptions: configValueToMinVersionForCollab([\n\t\t[{ enableGCSweep: undefined }, \"1.0.0\"],\n\t\t[{ enableGCSweep: true }, \"2.0.0-defaults\"],\n\t]),\n\tcreateBlobPayloadPending: configValueToMinVersionForCollab([\n\t\t[undefined, \"1.0.0\"],\n\t\t[true, \"2.40.0\"],\n\t]),\n} as const satisfies ConfigValidationMap<RuntimeOptionsAffectingDocSchema>;\n\n/**\n * Returns the default RuntimeOptionsAffectingDocSchema configuration for a given minVersionForCollab.\n */\nexport function getMinVersionForCollabDefaults(\n\tminVersionForCollab: MinimumVersionForCollab,\n): RuntimeOptionsAffectingDocSchema {\n\treturn getConfigsForMinVersionForCollab(\n\t\tminVersionForCollab,\n\t\truntimeOptionsAffectingDocSchemaConfigMap,\n\t\t// This is a bad cast away from Partial that getConfigsForCompatMode provides.\n\t\t// ConfigMap should be restructured to provide RuntimeOptionsAffectingDocSchema guarantee.\n\t) as RuntimeOptionsAffectingDocSchema;\n}\n\n/**\n * Returns a default configuration given minVersionForCollab and configuration version map.\n */\nexport function getConfigsForMinVersionForCollab<T extends Record<SemanticVersion, unknown>>(\n\tminVersionForCollab: SemanticVersion,\n\tconfigMap: ConfigMap<T>,\n): Partial<T> {\n\tconst defaultConfigs: Partial<T> = {};\n\t// Iterate over configMap to get default values for each option.\n\tfor (const key of Object.keys(configMap)) {\n\t\tconst config = configMap[key as keyof T];\n\t\t// Sort the versions in ascending order so we can short circuit the loop.\n\t\tconst versions = Object.keys(config).sort(compare);\n\t\t// For each config, we iterate over the keys and check if minVersionForCollab is greater than or equal to the version.\n\t\t// If so, we set it as the default value for the option. At the end of the loop we should have the most recent default\n\t\t// value that is compatible with the version specified as the minVersionForCollab.\n\t\tfor (const version of versions) {\n\t\t\tif (gte(minVersionForCollab, version)) {\n\t\t\t\tdefaultConfigs[key] = config[version as MinimumMinorSemanticVersion];\n\t\t\t} else {\n\t\t\t\t// If the minVersionForCollab is less than the version, we break out of the loop since we don't need to check\n\t\t\t\t// any later versions.\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t}\n\treturn defaultConfigs;\n}\n\n/**\n * Checks if the minVersionForCollab is valid.\n * A valid minVersionForCollab is a MinimumVersionForCollab that is at least `lowestMinVersionForCollab` and less than or equal to the current package version.\n */\nexport function isValidMinVersionForCollab(\n\tminVersionForCollab: MinimumVersionForCollab,\n): boolean {\n\treturn (\n\t\tvalid(minVersionForCollab) !== null &&\n\t\tgte(minVersionForCollab, lowestMinVersionForCollab) &&\n\t\tlte(minVersionForCollab, pkgVersion)\n\t);\n}\n\n/**\n * Validates if the runtime options passed in from the user are compatible with the minVersionForCollab.\n * For example, if a user sets the `enableGroupedBatching` option to true, but the minVersionForCollab\n * is set to \"1.0.0\", then we should throw a UsageError since 1.x clients do not support batching.\n * */\nexport function validateRuntimeOptions(\n\tminVersionForCollab: MinimumVersionForCollab,\n\truntimeOptions: Partial<ContainerRuntimeOptionsInternal>,\n): void {\n\tgetValidationForRuntimeOptions<RuntimeOptionsAffectingDocSchema>(\n\t\tminVersionForCollab,\n\t\truntimeOptions as Partial<RuntimeOptionsAffectingDocSchema>,\n\t\truntimeOptionsAffectingDocSchemaConfigValidationMap,\n\t);\n}\n\n/**\n * Generic function to validate runtime options against the minVersionForCollab.\n */\nexport function getValidationForRuntimeOptions<T extends Record<string, unknown>>(\n\tminVersionForCollab: SemanticVersion,\n\truntimeOptions: Partial<T>,\n\tvalidationMap: ConfigValidationMap<T>,\n): void {\n\tif (minVersionForCollab === defaultMinVersionForCollab) {\n\t\t// If the minVersionForCollab is set to the default value, then we will not validate the runtime options\n\t\t// This is to avoid disruption to users who have not yet set the minVersionForCollab value explicitly.\n\t\treturn;\n\t}\n\t// Iterate through each runtime option passed in by the user\n\tfor (const [passedRuntimeOption, passedRuntimeOptionValue] of Object.entries(\n\t\truntimeOptions,\n\t) as [keyof T & string, T[keyof T & string]][]) {\n\t\t// Skip if passedRuntimeOption is not in validation map\n\t\tif (!(passedRuntimeOption in validationMap)) {\n\t\t\tcontinue;\n\t\t}\n\n\t\tconst requiredVersion = validationMap[passedRuntimeOption](passedRuntimeOptionValue);\n\t\tif (requiredVersion !== undefined && gt(requiredVersion, minVersionForCollab)) {\n\t\t\tthrow new UsageError(\n\t\t\t\t`Runtime option ${passedRuntimeOption}:${JSON.stringify(passedRuntimeOptionValue)} requires ` +\n\t\t\t\t\t`runtime version ${requiredVersion}. Please update minVersionForCollab ` +\n\t\t\t\t\t`(currently ${minVersionForCollab}) to ${requiredVersion} or later to proceed.`,\n\t\t\t);\n\t\t}\n\t}\n}\n\n/**\n * Helper function to map ContainerRuntimeOptionsInternal config values to\n * minVersionForCollab in {@link runtimeOptionsAffectingDocSchemaConfigValidationMap}.\n */\nexport function configValueToMinVersionForCollab<\n\tT extends string | number | boolean | undefined | object,\n\tArr extends readonly [T, SemanticVersion][],\n>(configToMinVer: Arr): (configValue: T) => SemanticVersion | undefined {\n\tconst configValueToRequiredVersionMap = new Map(configToMinVer);\n\treturn (configValue: T) => {\n\t\t// If the configValue is not an object then we can get the version required directly from the map.\n\t\tif (typeof configValue !== \"object\") {\n\t\t\treturn configValueToRequiredVersionMap.get(configValue);\n\t\t}\n\t\t// When the input `configValue` is an object, this logic determines the minimum runtime version it requires.\n\t\t// It iterates through each entry in `configValueToRequiredVersionMap`. If `possibleConfigValue` shares at\n\t\t// least one key-value pair with the input `configValue`, its associated `versionRequired` is collected into\n\t\t// `matchingVersions`. After checking all entries, the highest among the collected versions is returned.\n\t\t// This represents the overall minimum version required to support the features implied by the input `configValue`.\n\t\tconst matchingVersions: SemanticVersion[] = [];\n\t\tfor (const [\n\t\t\tpossibleConfigValue,\n\t\t\tversionRequired,\n\t\t] of configValueToRequiredVersionMap.entries()) {\n\t\t\tassert(\n\t\t\t\ttypeof possibleConfigValue == \"object\",\n\t\t\t\t0xbb9 /* possibleConfigValue should be an object */,\n\t\t\t);\n\t\t\t// Check if `possibleConfigValue` and the input `configValue` share at least one\n\t\t\t// common key-value pair. If they do, the `versionRequired` for this `possibleConfigValue`\n\t\t\t// is added to `matchingVersions`.\n\t\t\tif (Object.entries(possibleConfigValue).some(([k, v]) => configValue[k] === v)) {\n\t\t\t\tmatchingVersions.push(versionRequired);\n\t\t\t}\n\t\t}\n\t\tif (matchingVersions.length > 0) {\n\t\t\t// Return the latest minVersionForCollab among all matches.\n\t\t\treturn matchingVersions.sort((a, b) => compare(b, a))[0];\n\t\t}\n\t\t// If no matches then we return undefined. This means that the config value passed in\n\t\t// does not require a specific minVersionForCollab to be valid.\n\t\treturn undefined;\n\t};\n}\n"]}