@fluidframework/tree 2.71.0 → 2.73.0

package/src/treeFactory.ts

@@ -26,8 +26,12 @@ import {
 } from "./shared-tree/index.js";
 import { SharedTreeFactoryType, SharedTreeAttributes } from "./sharedTreeAttributes.js";
 import type { ITree } from "./simple-tree/index.js";
-import { Breakable } from "./util/index.js";
+import { Breakable, copyProperty } from "./util/index.js";
 import { FluidClientVersion } from "./codec/index.js";
+import {
+	editManagerFormatVersionSelectorForSharedBranches,
+	messageFormatVersionSelectorForSharedBranches,
+} from "./shared-tree-core/index.js";
 
 /**
  * {@link ITreePrivate} extended with ISharedObject.
@@ -169,6 +173,13 @@ export function configuredSharedTreeBetaLegacy(
  */
 export function configuredSharedTree(
 	options: SharedTreeOptions,
+): ISharedObjectKind<ITree> & SharedObjectKind<ITree> {
+	const internalOptions = resolveOptions(options);
+	return configuredSharedTreeInternal(internalOptions);
+}
+
+export function configuredSharedTreeInternal(
+	options: SharedTreeOptionsInternal,
 ): ISharedObjectKind<ITree> & SharedObjectKind<ITree> {
 	const sharedObjectOptions: SharedObjectOptions<ITree> = {
 		type: SharedTreeFactoryType,
@@ -179,3 +190,24 @@ export function configuredSharedTree(
 
 	return makeSharedObjectKind<ITree>(sharedObjectOptions);
 }
+
+export function resolveOptions(options: SharedTreeOptions): SharedTreeOptionsInternal {
+	const internal: SharedTreeOptionsInternal = {
+		...resolveSharedBranchesOptions(options.enableSharedBranches),
+	};
+	copyProperty(options, "forest", internal);
+	copyProperty(options, "jsonValidator", internal);
+	copyProperty(options, "minVersionForCollab", internal);
+	copyProperty(options, "treeEncodeType", internal);
+	return internal;
+}
+
+function resolveSharedBranchesOptions(
+	enableSharedBranches: boolean | undefined,
+): SharedTreeOptionsInternal {
+	return enableSharedBranches === true ? sharedBranchesOptions : {};
+}
+const sharedBranchesOptions: SharedTreeOptionsInternal = {
+	messageFormatSelector: messageFormatVersionSelectorForSharedBranches,
+	editManagerFormatSelector: editManagerFormatVersionSelectorForSharedBranches,
+};

package/src/util/arrayUtilities.ts

@@ -0,0 +1,88 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
+
+/**
+ * Validates that the provided index is a safe integer.
+ * @throws If the index is invalid.
+ * @param index - The index to validate.
+ * @param apiName - The name of the API performing the validation.
+ * @throws If the index is invalid.
+ */
+export function validateSafeInteger(index: number, apiName: string): void {
+	if (!Number.isSafeInteger(index)) {
+		throw new UsageError(`Expected a safe integer passed to ${apiName}, got ${index}.`);
+	}
+}
+
+/**
+ * Validates that the provided index is a 0 or greater safe integer.
+ * @param index - The index to validate.
+ * @param apiName - The name of the API performing the validation.
+ * @throws If the index is invalid.
+ */
+export function validatePositiveIndex(index: number, apiName: string): void {
+	validateSafeInteger(index, apiName);
+	if (index < 0) {
+		throw new UsageError(`Expected non-negative index passed to ${apiName}, got ${index}.`);
+	}
+}
+
+/**
+ * Validates that the provided index is a non-negative safe integer within the bounds of the provided array (or, optionally, 1 past its end).
+ * @throws If the index is invalid.
+ * @param index - The index to validate.
+ * @param array - The array to validate against.
+ * @param apiName - The name of the API performing the validation.
+ * @param allowOnePastEnd - Whether to allow the index to be one past the end of the array.
+ */
+export function validateIndex(
+	index: number,
+	array: { readonly length: number },
+	apiName: string,
+	allowOnePastEnd: boolean = false,
+): void {
+	validatePositiveIndex(index, apiName);
+	if (allowOnePastEnd) {
+		if (index > array.length) {
+			throw new UsageError(
+				`Index value passed to ${apiName} is out of bounds. Expected at most ${array.length}, got ${index}.`,
+			);
+		}
+	} else {
+		if (index >= array.length) {
+			throw new UsageError(
+				`Index value passed to ${apiName} is out of bounds. Expected at most ${array.length - 1}, got ${index}.`,
+			);
+		}
+	}
+}
+
+/**
+ * Validates that the provided range `[startIndex, endIndex)` is valid and within the bounds of the provided array.
+ * @remarks
+ * This is intended for ranges which are inclusive for the lower bound, and exclusive for the upper bound,
+ * and permits 0 length ranges, even `[array.length, array.length)`.
+ * @throws If the index is invalid.
+ * @param startIndex - The index that starts the range (inclusive).
+ * @param endIndex - The index that ends the range (exclusive).
+ * @param array - The array to validate against.
+ * @param apiName - The name of the API performing the validation.
+ */
+export function validateIndexRange(
+	startIndex: number,
+	endIndex: number,
+	array: { readonly length: number },
+	apiName: string,
+): void {
+	if (startIndex > endIndex) {
+		throw new UsageError(
+			`Malformed range passed to ${apiName}. Start index ${startIndex} is greater than end index ${endIndex}.`,
+		);
+	}
+	validateIndex(startIndex, array, apiName, true);
+	validateIndex(endIndex, array, apiName, true);
+}

package/src/util/brand.ts

@@ -9,7 +9,7 @@ import type { Covariant } from "./typeCheck.js";
 
 /**
  * Constructs a "Branded" type, adding a type-checking only field to `ValueType`.
- *
+ * @remarks
  * Two usages of `Brand` should never use the same `Name`.
  * If they do, the resulting types will be assignable which defeats the point of this type.
  *
@@ -18,11 +18,17 @@ import type { Covariant } from "./typeCheck.js";
  * `Type 'Name1' is not assignable to type 'Name2'.`
  *
  * These branded types are not opaque: A `Brand<A, B>` can still be used as a `A`.
+ *
+ * @example Simple usage:
+ * ```typescript
+ * export type StrongId = Brand<string, "tree.StrongId">;
+ * const x: StrongId = brand("myId");
+ * ```
  */
 export type Brand<ValueType, Name> = ValueType & BrandedType<ValueType, Name>;
 
 /**
- * Helper for {@link Brand}.
+ * Implementation detail for {@link Brand}.
  *
  * See `MakeNominal` for some more details.
  *
@@ -98,6 +104,11 @@ export type NameFromBranded<T extends BrandedType<unknown, unknown>> = T extends
  * Adds a type {@link Brand} to a value.
  *
  * Only do this when specifically allowed by the requirements of the type being converted to.
+ * @remarks
+ * This infers the branded type from context so it can very easily be used to a semantically invalid conversion.
+ * Treat this like "as" casts: they are an indicator that the user/reader must ensure the conversion is valid.
+ *
+ * If branding a constant, and wanting to preserve the exact typing of the constant, use {@link brandConst} instead.
  * @privateRemarks
  * Leaving `T` unconstrained here allows for better type inference when branding unions.
  * For example when assigning `brand(number)` a number to an optional branded number field,
@@ -111,3 +122,30 @@ export function brand<T>(
 ): T {
 	return value as T;
 }
+
+/**
+ * Adds a type {@link Brand} to a value, while preserving the exact type of the value being branded.
+ * @remarks
+ * This takes in the type to brand to as a required type parameter, unlike {@link brand} which infers it from context.
+ * This also preserves the exact type of the value being branded.
+ * TypeScript has no way to take an explicit type parameter and infer another in a single generic context.
+ * To work around this, two generic contexts are used, first a function to infer the parameter type,
+ * and a second function (returned) to take the explicit type parameter.
+ *
+ * This is intended for use when branding constants.
+ * @example
+ * ```typescript
+ * const requiredIdentifier = brandConst("Value")<FieldKindIdentifier>();
+ * ```
+ * @privateRemarks
+ * The dummy parameter is used to produce a compile error in the event where the value being branded is incompatible with the branded type.
+ */
+export function brandConst<const T>(
+	value: T,
+): <T2 extends BrandedType<unknown, unknown>>(
+	...dummy: T extends (T2 extends BrandedType<infer ValueType, unknown> ? ValueType : never)
+		? []
+		: [never]
+) => T2 & T {
+	return <T2>() => value as T2 & T;
+}

package/src/util/brandedMap.ts

@@ -11,10 +11,12 @@ import { getOrCreate } from "./utils.js";
 /**
  * Key in a {@link BrandedMapSubset}.
  * @remarks
+ * `TContent` is used as part of the brand to strongly associate the key type with the type of the values it looks up.
+ *
  * Due to the `TContent` type parameter being invariant (which it has to be since keys are used to both read and write data),
  * generic collections end up needing to constrain their key's `TContent` to `any`.
  */
-export type BrandedKey<TKey, TContent> = TKey & Invariant<TContent>;
+export type BrandedKey<TKey, TContent> = Brand<TKey, ["BrandedKey", Invariant<TContent>]>;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type BrandedKeyContent<TKey extends BrandedKey<unknown, any>> = TKey extends BrandedKey<

package/src/util/index.ts

@@ -3,12 +3,19 @@
  * Licensed under the MIT License.
  */
 
+export {
+	validateIndex,
+	validateIndexRange,
+	validatePositiveIndex,
+	validateSafeInteger,
+} from "./arrayUtilities.js";
 export {
 	brand,
 	type Brand,
 	BrandedType,
 	type NameFromBranded,
 	type ValueFromBranded,
+	brandConst,
 } from "./brand.js";
 export { brandedNumberType, brandedStringType } from "./typeboxBrand.js";
 export {

package/dist/feature-libraries/default-schema/defaultSchema.d.ts

@@ -1,10 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { FullSchemaPolicy } from "../modular-schema/index.js";
-/**
- * FullSchemaPolicy with the default field kinds.
- */
-export declare const defaultSchemaPolicy: FullSchemaPolicy;
-//# sourceMappingURL=defaultSchema.d.ts.map

package/dist/feature-libraries/default-schema/defaultSchema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"defaultSchema.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/defaultSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAInE;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,gBAEjC,CAAC"}

package/dist/feature-libraries/default-schema/defaultSchema.js

@@ -1,15 +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.defaultSchemaPolicy = void 0;
-const defaultFieldKinds_js_1 = require("./defaultFieldKinds.js");
-/**
- * FullSchemaPolicy with the default field kinds.
- */
-exports.defaultSchemaPolicy = {
-    fieldKinds: defaultFieldKinds_js_1.fieldKinds,
-};
-//# sourceMappingURL=defaultSchema.js.map

package/dist/feature-libraries/default-schema/defaultSchema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"defaultSchema.js","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/defaultSchema.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,iEAAoD;AAEpD;;GAEG;AACU,QAAA,mBAAmB,GAAqB;IACpD,UAAU,EAAV,iCAAU;CACV,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { FullSchemaPolicy } from \"../modular-schema/index.js\";\n\nimport { fieldKinds } from \"./defaultFieldKinds.js\";\n\n/**\n * FullSchemaPolicy with the default field kinds.\n */\nexport const defaultSchemaPolicy: FullSchemaPolicy = {\n\tfieldKinds,\n};\n"]}

package/dist/feature-libraries/default-schema/schemaChecker.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaChecker.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/schemaChecker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EACN,KAAK,qBAAqB,EAI1B,YAAY,EACZ,KAAK,eAAe,EACpB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAG3F,oBAAY,qBAAqB;IAChC,2BAA2B,IAAA;IAC3B,0BAA0B,IAAA;IAC1B,gCAAgC,IAAA;IAChC,2BAA2B,IAAA;IAC3B,wBAAwB,IAAA;IACxB,qBAAqB,IAAA;IACrB,yBAAyB,IAAA;IACzB,2BAA2B,IAAA;IAC3B,2BAA2B,IAAA;IAC3B,kBAAkB,IAAA;CAClB;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,qBAAqB,GAAG,KAAK,CAIzE;AAED,KAAK,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzE;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,YAAY,EACpD,IAAI,EAAE,sBAAsB,EAC5B,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,CAAC,GAC1C,CAAC,GAAG,SAAS,CA6Df;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,YAAY,EACrD,UAAU,EAAE,uBAAuB,CAAC,sBAAsB,CAAC,EAC3D,MAAM,EAAE,qBAAqB,EAC7B,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,CAAC,GAC1C,CAAC,GAAG,SAAS,CA6Bf;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACvC,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,YAAY,GACxB,qBAAqB,GAAG,SAAS,CAuBnC"}

package/dist/feature-libraries/default-schema/schemaChecker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaChecker.js","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/schemaChecker.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA4E;AAC5E,uEAAsE;AAEtE,kDAO6B;AAC7B,4DAAmD;AAEnD,kDAAmE;AAEnE,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAChC,+GAA2B,CAAA;IAC3B,6GAA0B,CAAA;IAC1B,yHAAgC,CAAA;IAChC,+GAA2B,CAAA;IAC3B,yGAAwB,CAAA;IACxB,mGAAqB,CAAA;IACrB,2GAAyB,CAAA;IACzB,+GAA2B,CAAA;IAC3B,+GAA2B,CAAA;IAC3B,6FAAkB,CAAA;AACnB,CAAC,EAXW,qBAAqB,qCAArB,qBAAqB,QAWhC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAC,UAAiC;IACjE,MAAM,IAAI,qBAAU,CACnB,oCAAoC,qBAAqB,CAAC,UAAU,CAAC,EAAE,CACvE,CAAC;AACH,CAAC;AAJD,4CAIC;AAID;;;;;;GAMG;AACH,SAAgB,cAAc,CAC7B,IAA4B,EAC5B,eAAgC,EAChC,OAA4C;IAE5C,kDAAkD;IAClD,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,OAAO,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAC1D,CAAC;IAED,2DAA2D;IAE3D,IAAI,MAAM,YAAY,+BAAoB,EAAE,CAAC;QAC5C,IAAI,IAAA,0BAAe,EAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,OAAO,OAAO,CAAC,qBAAqB,CAAC,yBAAyB,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,IAAA,+BAAW,EAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,OAAO,OAAO,CAAC,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;QAC7D,CAAC;IACF,CAAC;SAAM,CAAC;QACP,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,OAAO,CAAC,qBAAqB,CAAC,2BAA2B,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,MAAM,YAAY,iCAAsB,EAAE,CAAC;YAC9C,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAC,IAAA,sBAAW,EAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACzF,KAAK,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;gBAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAClD,MAAM,mBAAmB,GAAG,eAAe,CAC1C,SAAS,EACT,WAAW,EACX,eAAe,EACf,OAAO,CACP,CAAC;gBACF,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACvC,OAAO,mBAAmB,CAAC;gBAC5B,CAAC;gBACD,uBAAuB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;YACD,4GAA4G;YAC5G,yIAAyI;YACzI,qLAAqL;YACrL,0HAA0H;YAC1H,IAAI,uBAAuB,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBACxC,OAAO,OAAO,CAAC,qBAAqB,CAAC,2BAA2B,CAAC,CAAC;YACnE,CAAC;QACF,CAAC;aAAM,IAAI,MAAM,YAAY,8BAAmB,EAAE,CAAC;YAClD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACzC,MAAM,mBAAmB,GAAG,eAAe,CAC1C,KAAK,EACL,MAAM,CAAC,SAAS,EAChB,eAAe,EACf,OAAO,CACP,CAAC;gBACF,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACvC,OAAO,mBAAmB,CAAC;gBAC5B,CAAC;YACF,CAAC;QACF,CAAC;aAAM,CAAC;YACP,IAAA,eAAI,EAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACrD,CAAC;IACF,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAjED,wCAiEC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAC9B,UAA2D,EAC3D,MAA6B,EAC7B,eAAgC,EAChC,OAA4C;IAE5C,+DAA+D;IAC/D,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAChE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,OAAO,CAAC,qBAAqB,CAAC,2BAA2B,CAAC,CAAC;IACnE,CAAC;IAED,4EAA4E;IAC5E,CAAC;QACA,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACzF,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACnC,CAAC;IACF,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC/B,kEAAkE;QAClE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAChE,OAAO,OAAO,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC;QAChE,CAAC;QAED,8DAA8D;QAC9D,MAAM,kBAAkB,GAAG,cAAc,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;QAC1E,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;YACtC,OAAO,kBAAkB,CAAC;QAC3B,CAAC;IACF,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAlCD,0CAkCC;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CACvC,aAAqB,EACrB,YAA0B;IAE1B,QAAQ,YAAY,EAAE,CAAC;QACtB,KAAK,uBAAY,CAAC,MAAM;YACvB,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBACvB,OAAO,qBAAqB,CAAC,0BAA0B,CAAC;YACzD,CAAC;iBAAM,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBAC9B,OAAO,qBAAqB,CAAC,gCAAgC,CAAC;YAC/D,CAAC;iBAAM,CAAC;gBACP,OAAO,SAAS,CAAC;YAClB,CAAC;QACF,KAAK,uBAAY,CAAC,QAAQ;YACzB,OAAO,aAAa,GAAG,CAAC;gBACvB,CAAC,CAAC,qBAAqB,CAAC,gCAAgC;gBACxD,CAAC,CAAC,SAAS,CAAC;QACd,KAAK,uBAAY,CAAC,QAAQ;YACzB,OAAO,SAAS,CAAC;QAClB,KAAK,uBAAY,CAAC,SAAS;YAC1B,OAAO,aAAa,KAAK,CAAC;gBACzB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,qBAAqB,CAAC,2BAA2B,CAAC;QACtD;YACC,IAAA,0BAAe,EAAC,YAAY,CAAC,CAAC;IAChC,CAAC;AACF,CAAC;AA1BD,4DA0BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { unreachableCase, fail } from \"@fluidframework/core-utils/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport {\n\ttype TreeFieldStoredSchema,\n\tLeafNodeStoredSchema,\n\tObjectNodeStoredSchema,\n\tMapNodeStoredSchema,\n\tMultiplicity,\n\ttype SchemaAndPolicy,\n} from \"../../core/index.js\";\nimport { allowsValue } from \"../valueUtilities.js\";\nimport type { MapTreeFieldViewGeneric, MinimalMapTreeNodeView } from \"../mapTreeCursor.js\";\nimport { iterableHasSome, mapIterable } from \"../../util/index.js\";\n\nexport enum SchemaValidationError {\n\tField_KindNotInSchemaPolicy,\n\tField_MissingRequiredChild,\n\tField_MultipleChildrenNotAllowed,\n\tField_ChildInForbiddenField,\n\tField_NodeTypeNotAllowed,\n\tLeafNode_InvalidValue,\n\tLeafNode_FieldsNotAllowed,\n\tObjectNode_FieldNotInSchema,\n\tNonLeafNode_ValueNotAllowed,\n\tNode_MissingSchema,\n}\n\n/**\n * Throws a UsageError indicating a tree is out of schema.\n */\nexport function throwOutOfSchema(maybeError: SchemaValidationError): never {\n\tthrow new UsageError(\n\t\t`Tree does not conform to schema: ${SchemaValidationError[maybeError]}`,\n\t);\n}\n\ntype NotUndefined = number | string | boolean | bigint | symbol | object;\n\n/**\n * Deeply checks that the provided node complies with the schema based on its identifier.\n *\n * @param onError - Called with the first error (if any).\n *\n * @returns the return value from `onError` if the node or anything inside of it is out of schema, otherwise `undefined`.\n */\nexport function isNodeInSchema<T extends NotUndefined>(\n\tnode: MinimalMapTreeNodeView,\n\tschemaAndPolicy: SchemaAndPolicy,\n\tonError: (error: SchemaValidationError) => T,\n): T | undefined {\n\t// Validate the schema declared by the node exists\n\tconst schema = schemaAndPolicy.schema.nodeSchema.get(node.type);\n\tif (schema === undefined) {\n\t\treturn onError(SchemaValidationError.Node_MissingSchema);\n\t}\n\n\t// Validate the node is well formed according to its schema\n\n\tif (schema instanceof LeafNodeStoredSchema) {\n\t\tif (iterableHasSome(node.fields)) {\n\t\t\treturn onError(SchemaValidationError.LeafNode_FieldsNotAllowed);\n\t\t}\n\t\tif (!allowsValue(schema.leafValue, node.value)) {\n\t\t\treturn onError(SchemaValidationError.LeafNode_InvalidValue);\n\t\t}\n\t} else {\n\t\tif (node.value !== undefined) {\n\t\t\treturn onError(SchemaValidationError.NonLeafNode_ValueNotAllowed);\n\t\t}\n\n\t\tif (schema instanceof ObjectNodeStoredSchema) {\n\t\t\tconst uncheckedFieldsFromNode = new Set(mapIterable(node.fields, ([key, field]) => key));\n\t\t\tfor (const [fieldKey, fieldSchema] of schema.objectNodeFields) {\n\t\t\t\tconst nodeField = node.fields.get(fieldKey) ?? [];\n\t\t\t\tconst fieldInSchemaResult = isFieldInSchema(\n\t\t\t\t\tnodeField,\n\t\t\t\t\tfieldSchema,\n\t\t\t\t\tschemaAndPolicy,\n\t\t\t\t\tonError,\n\t\t\t\t);\n\t\t\t\tif (fieldInSchemaResult !== undefined) {\n\t\t\t\t\treturn fieldInSchemaResult;\n\t\t\t\t}\n\t\t\t\tuncheckedFieldsFromNode.delete(fieldKey);\n\t\t\t}\n\t\t\t// The node has fields that we did not check as part of looking at every field defined in the node's schema.\n\t\t\t// Since this is testing compatibility with a stored schema (not view schema), \"allowUnknownOptionalFields\" does not exist at this layer.\n\t\t\t// Code using this with a stored schema derived from a view schema rather than the document can be problematic because it may be missing unknown fields that the actual document has.\n\t\t\t// Other schema evolution features like \"staged\" allowed types will likely cause similar issues elsewhere in this checker.\n\t\t\tif (uncheckedFieldsFromNode.size !== 0) {\n\t\t\t\treturn onError(SchemaValidationError.ObjectNode_FieldNotInSchema);\n\t\t\t}\n\t\t} else if (schema instanceof MapNodeStoredSchema) {\n\t\t\tfor (const [_key, field] of node.fields) {\n\t\t\t\tconst fieldInSchemaResult = isFieldInSchema(\n\t\t\t\t\tfield,\n\t\t\t\t\tschema.mapFields,\n\t\t\t\t\tschemaAndPolicy,\n\t\t\t\t\tonError,\n\t\t\t\t);\n\t\t\t\tif (fieldInSchemaResult !== undefined) {\n\t\t\t\t\treturn fieldInSchemaResult;\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tfail(0xb0e /* Unknown TreeNodeStoredSchema type */);\n\t\t}\n\t}\n\n\treturn undefined;\n}\n\n/**\n * Deeply checks that the nodes comply with the field schema and included schema.\n *\n * @param onError - Called with the first error (if any).\n *\n * @returns the return value from `onError` if the field or anything inside of it is out of schema, otherwise `undefined`.\n */\nexport function isFieldInSchema<T extends NotUndefined>(\n\tchildNodes: MapTreeFieldViewGeneric<MinimalMapTreeNodeView>,\n\tschema: TreeFieldStoredSchema,\n\tschemaAndPolicy: SchemaAndPolicy,\n\tonError: (error: SchemaValidationError) => T,\n): T | undefined {\n\t// Validate that the field kind is handled by the schema policy\n\tconst kind = schemaAndPolicy.policy.fieldKinds.get(schema.kind);\n\tif (kind === undefined) {\n\t\treturn onError(SchemaValidationError.Field_KindNotInSchemaPolicy);\n\t}\n\n\t// Validate that the field doesn't contain more nodes than its type supports\n\t{\n\t\tconst multiplicityCheck = compliesWithMultiplicity(childNodes.length, kind.multiplicity);\n\t\tif (multiplicityCheck !== undefined) {\n\t\t\treturn onError(multiplicityCheck);\n\t\t}\n\t}\n\n\tfor (const node of childNodes) {\n\t\t// Validate the type declared by the node is allowed in this field\n\t\tif (schema.types !== undefined && !schema.types.has(node.type)) {\n\t\t\treturn onError(SchemaValidationError.Field_NodeTypeNotAllowed);\n\t\t}\n\n\t\t// Validate the node complies with the type it declares to be.\n\t\tconst nodeInSchemaResult = isNodeInSchema(node, schemaAndPolicy, onError);\n\t\tif (nodeInSchemaResult !== undefined) {\n\t\t\treturn nodeInSchemaResult;\n\t\t}\n\t}\n\n\treturn undefined;\n}\n\n/**\n * Validates that a given number of items complies with the specified {@link Multiplicity | multiplicity}.\n * @param numberOfItems - Number of items.\n * @param multiplicity - Kind of multiplicity to validate against.\n * @returns `true` if the specified number of items complies with the specified multiplicity; otherwise, `false`.\n */\nexport function compliesWithMultiplicity(\n\tnumberOfItems: number,\n\tmultiplicity: Multiplicity,\n): SchemaValidationError | undefined {\n\tswitch (multiplicity) {\n\t\tcase Multiplicity.Single:\n\t\t\tif (numberOfItems < 1) {\n\t\t\t\treturn SchemaValidationError.Field_MissingRequiredChild;\n\t\t\t} else if (numberOfItems > 1) {\n\t\t\t\treturn SchemaValidationError.Field_MultipleChildrenNotAllowed;\n\t\t\t} else {\n\t\t\t\treturn undefined;\n\t\t\t}\n\t\tcase Multiplicity.Optional:\n\t\t\treturn numberOfItems > 1\n\t\t\t\t? SchemaValidationError.Field_MultipleChildrenNotAllowed\n\t\t\t\t: undefined;\n\t\tcase Multiplicity.Sequence:\n\t\t\treturn undefined;\n\t\tcase Multiplicity.Forbidden:\n\t\t\treturn numberOfItems === 0\n\t\t\t\t? undefined\n\t\t\t\t: SchemaValidationError.Field_ChildInForbiddenField;\n\t\tdefault:\n\t\t\tunreachableCase(multiplicity);\n\t}\n}\n"]}

package/dist/feature-libraries/modular-schema/fieldKindWithEditor.d.ts

@@ -1,50 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { FieldKindIdentifier, TreeFieldStoredSchema, TreeStoredSchema, TreeTypeSet, Multiplicity } from "../../core/index.js";
-import type { FieldChangeHandler, FieldEditor } from "./fieldChangeHandler.js";
-import { FlexFieldKind, type FullSchemaPolicy } from "./fieldKind.js";
-/**
- * Functionality for FieldKinds that is stable,
- * meaning that it can not change in any measurable way without providing a new identifier.
- *
- * It is assumed that this information and policy is available on all clients interacting with a document
- * using the identifier.
- *
- * This must contain enough information to process remote edits to this FieldKind consistently with all clients.
- * All behavior must be deterministic, and not change across versions of the app/library.
- *
- * These policies include the data encoding, change encoding, change rebase and change application.
- */
-export declare class FieldKindWithEditor<TEditor extends FieldEditor<any> = FieldEditor<any>, TMultiplicity extends Multiplicity = Multiplicity, TName extends string = string> extends FlexFieldKind<TName, TMultiplicity> {
-    readonly changeHandler: FieldChangeHandler<any, TEditor>;
-    private readonly allowsTreeSupersetOf;
-    readonly handlesEditsFrom: ReadonlySet<FieldKindIdentifier>;
-    /**
-     * @param identifier - Globally scoped identifier.
-     * @param multiplicity - bound on the number of children that fields of this kind may have.
-     * TODO: replace with numeric upper and lower bounds.
-     * @param changeHandler - Change handling policy.
-     * @param allowsTreeSupersetOf - returns true iff `superset` supports all that this does
-     * and `superset` is an allowed upgrade. Does not have to handle the `never` cases.
-     * See {@link isNeverField}.
-     * TODO: when used as a method (instead of a free function like the other superset related functions),
-     * this name is/signature is confusing and seems backwards.
-     * @param handlesEditsFrom - Kinds (in addition to this) whose edits can be processed by changeHandler.
-     * If the kind of a field changes, and edits are rebased across that kind change,
-     * listing the other old kind here can prevent those edits from being conflicted and
-     * provide a chance to handle them.
-     */
-    constructor(identifier: TName, multiplicity: TMultiplicity, changeHandler: FieldChangeHandler<any, TEditor>, allowsTreeSupersetOf: (originalTypes: TreeTypeSet, superset: TreeFieldStoredSchema) => boolean, handlesEditsFrom: ReadonlySet<FieldKindIdentifier>);
-    /**
-     * Returns true if and only if `superset` permits a (non-strict) superset of the subtrees
-     * allowed by field made from `this` and `originalTypes`.
-     */
-    allowsFieldSuperset(policy: FullSchemaPolicy, originalData: TreeStoredSchema, originalTypes: TreeTypeSet, superset: TreeFieldStoredSchema): boolean;
-}
-/**
- * Downcasts to {@link FieldKindWithEditor}.
- */
-export declare function withEditor<TName extends string = string, TMultiplicity extends Multiplicity = Multiplicity>(kind: FlexFieldKind<TName, TMultiplicity>): FieldKindWithEditor<FieldEditor<any>, TMultiplicity, TName>;
-//# sourceMappingURL=fieldKindWithEditor.d.ts.map

package/dist/feature-libraries/modular-schema/fieldKindWithEditor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fieldKindWithEditor.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/modular-schema/fieldKindWithEditor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EACX,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,EAChB,WAAW,EACX,YAAY,EACZ,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAMtE;;;;;;;;;;;GAWG;AACH,qBAAa,mBAAmB,CAC/B,OAAO,SAAS,WAAW,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,EACnD,aAAa,SAAS,YAAY,GAAG,YAAY,EACjD,KAAK,SAAS,MAAM,GAAG,MAAM,CAC5B,SAAQ,aAAa,CAAC,KAAK,EAAE,aAAa,CAAC;aAmB3B,aAAa,EAAE,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC;IAC/D,OAAO,CAAC,QAAQ,CAAC,oBAAoB;aAIrB,gBAAgB,EAAE,WAAW,CAAC,mBAAmB,CAAC;IAvBnE;;;;;;;;;;;;;;OAcG;gBAEF,UAAU,EAAE,KAAK,EACjB,YAAY,EAAE,aAAa,EACX,aAAa,EAAE,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,EAC9C,oBAAoB,EAAE,CACtC,aAAa,EAAE,WAAW,EAC1B,QAAQ,EAAE,qBAAqB,KAC3B,OAAO,EACI,gBAAgB,EAAE,WAAW,CAAC,mBAAmB,CAAC;IAKnE;;;OAGG;IACI,mBAAmB,CACzB,MAAM,EAAE,gBAAgB,EACxB,YAAY,EAAE,gBAAgB,EAC9B,aAAa,EAAE,WAAW,EAC1B,QAAQ,EAAE,qBAAqB,GAC7B,OAAO;CAgBV;AAED;;GAEG;AACH,wBAAgB,UAAU,CACzB,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,aAAa,SAAS,YAAY,GAAG,YAAY,EAEjD,IAAI,EAAE,aAAa,CAAC,KAAK,EAAE,aAAa,CAAC,GACvC,mBAAmB,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,KAAK,CAAC,CAG7D"}

package/dist/feature-libraries/modular-schema/fieldKindWithEditor.js

@@ -1,76 +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.withEditor = exports.FieldKindWithEditor = void 0;
-const internal_1 = require("@fluidframework/core-utils/internal");
-const fieldKind_js_1 = require("./fieldKind.js");
-const isNeverTree_js_1 = require("./isNeverTree.js");
-// TODO: stronger typing
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/**
- * Functionality for FieldKinds that is stable,
- * meaning that it can not change in any measurable way without providing a new identifier.
- *
- * It is assumed that this information and policy is available on all clients interacting with a document
- * using the identifier.
- *
- * This must contain enough information to process remote edits to this FieldKind consistently with all clients.
- * All behavior must be deterministic, and not change across versions of the app/library.
- *
- * These policies include the data encoding, change encoding, change rebase and change application.
- */
-class FieldKindWithEditor extends fieldKind_js_1.FlexFieldKind {
-    /**
-     * @param identifier - Globally scoped identifier.
-     * @param multiplicity - bound on the number of children that fields of this kind may have.
-     * TODO: replace with numeric upper and lower bounds.
-     * @param changeHandler - Change handling policy.
-     * @param allowsTreeSupersetOf - returns true iff `superset` supports all that this does
-     * and `superset` is an allowed upgrade. Does not have to handle the `never` cases.
-     * See {@link isNeverField}.
-     * TODO: when used as a method (instead of a free function like the other superset related functions),
-     * this name is/signature is confusing and seems backwards.
-     * @param handlesEditsFrom - Kinds (in addition to this) whose edits can be processed by changeHandler.
-     * If the kind of a field changes, and edits are rebased across that kind change,
-     * listing the other old kind here can prevent those edits from being conflicted and
-     * provide a chance to handle them.
-     */
-    constructor(identifier, multiplicity, changeHandler, allowsTreeSupersetOf, handlesEditsFrom) {
-        super(identifier, multiplicity);
-        this.changeHandler = changeHandler;
-        this.allowsTreeSupersetOf = allowsTreeSupersetOf;
-        this.handlesEditsFrom = handlesEditsFrom;
-    }
-    /**
-     * Returns true if and only if `superset` permits a (non-strict) superset of the subtrees
-     * allowed by field made from `this` and `originalTypes`.
-     */
-    allowsFieldSuperset(policy, originalData, originalTypes, superset) {
-        if ((0, isNeverTree_js_1.isNeverField)(policy, originalData, {
-            kind: this.identifier,
-            types: originalTypes,
-            // Metadata is not used for this check.
-            persistedMetadata: undefined,
-        })) {
-            return true;
-        }
-        if ((0, isNeverTree_js_1.isNeverField)(policy, originalData, superset)) {
-            return false;
-        }
-        return this.allowsTreeSupersetOf(originalTypes, superset);
-    }
-}
-exports.FieldKindWithEditor = FieldKindWithEditor;
-/**
- * Downcasts to {@link FieldKindWithEditor}.
- */
-function withEditor(kind) {
-    (0, internal_1.assert)(kind instanceof FieldKindWithEditor, 0x7b5 /* kind must be FieldKindWithEditor */);
-    return kind;
-}
-exports.withEditor = withEditor;
-/* eslint-enable @typescript-eslint/no-explicit-any */
-//# sourceMappingURL=fieldKindWithEditor.js.map

package/dist/feature-libraries/modular-schema/fieldKindWithEditor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fieldKindWithEditor.js","sourceRoot":"","sources":["../../../src/feature-libraries/modular-schema/fieldKindWithEditor.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAW7D,iDAAsE;AACtE,qDAAgD;AAEhD,wBAAwB;AACxB,uDAAuD;AAEvD;;;;;;;;;;;GAWG;AACH,MAAa,mBAIX,SAAQ,4BAAmC;IAC5C;;;;;;;;;;;;;;OAcG;IACH,YACC,UAAiB,EACjB,YAA2B,EACX,aAA+C,EAC9C,oBAGL,EACI,gBAAkD;QAElE,KAAK,CAAC,UAAyC,EAAE,YAAY,CAAC,CAAC;QAP/C,kBAAa,GAAb,aAAa,CAAkC;QAC9C,yBAAoB,GAApB,oBAAoB,CAGzB;QACI,qBAAgB,GAAhB,gBAAgB,CAAkC;IAGnE,CAAC;IAED;;;OAGG;IACI,mBAAmB,CACzB,MAAwB,EACxB,YAA8B,EAC9B,aAA0B,EAC1B,QAA+B;QAE/B,IACC,IAAA,6BAAY,EAAC,MAAM,EAAE,YAAY,EAAE;YAClC,IAAI,EAAE,IAAI,CAAC,UAAU;YACrB,KAAK,EAAE,aAAa;YACpB,uCAAuC;YACvC,iBAAiB,EAAE,SAAS;SAC5B,CAAC,EACD,CAAC;YACF,OAAO,IAAI,CAAC;QACb,CAAC;QACD,IAAI,IAAA,6BAAY,EAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;YAClD,OAAO,KAAK,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,oBAAoB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;CACD;AA1DD,kDA0DC;AAED;;GAEG;AACH,SAAgB,UAAU,CAIzB,IAAyC;IAEzC,IAAA,iBAAM,EAAC,IAAI,YAAY,mBAAmB,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC1F,OAAO,IAAmE,CAAC;AAC5E,CAAC;AARD,gCAQC;AAED,sDAAsD","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\";\n\nimport type {\n\tFieldKindIdentifier,\n\tTreeFieldStoredSchema,\n\tTreeStoredSchema,\n\tTreeTypeSet,\n\tMultiplicity,\n} from \"../../core/index.js\";\n\nimport type { FieldChangeHandler, FieldEditor } from \"./fieldChangeHandler.js\";\nimport { FlexFieldKind, type FullSchemaPolicy } from \"./fieldKind.js\";\nimport { isNeverField } from \"./isNeverTree.js\";\n\n// TODO: stronger typing\n/* eslint-disable @typescript-eslint/no-explicit-any */\n\n/**\n * Functionality for FieldKinds that is stable,\n * meaning that it can not change in any measurable way without providing a new identifier.\n *\n * It is assumed that this information and policy is available on all clients interacting with a document\n * using the identifier.\n *\n * This must contain enough information to process remote edits to this FieldKind consistently with all clients.\n * All behavior must be deterministic, and not change across versions of the app/library.\n *\n * These policies include the data encoding, change encoding, change rebase and change application.\n */\nexport class FieldKindWithEditor<\n\tTEditor extends FieldEditor<any> = FieldEditor<any>,\n\tTMultiplicity extends Multiplicity = Multiplicity,\n\tTName extends string = string,\n> extends FlexFieldKind<TName, TMultiplicity> {\n\t/**\n\t * @param identifier - Globally scoped identifier.\n\t * @param multiplicity - bound on the number of children that fields of this kind may have.\n\t * TODO: replace with numeric upper and lower bounds.\n\t * @param changeHandler - Change handling policy.\n\t * @param allowsTreeSupersetOf - returns true iff `superset` supports all that this does\n\t * and `superset` is an allowed upgrade. Does not have to handle the `never` cases.\n\t * See {@link isNeverField}.\n\t * TODO: when used as a method (instead of a free function like the other superset related functions),\n\t * this name is/signature is confusing and seems backwards.\n\t * @param handlesEditsFrom - Kinds (in addition to this) whose edits can be processed by changeHandler.\n\t * If the kind of a field changes, and edits are rebased across that kind change,\n\t * listing the other old kind here can prevent those edits from being conflicted and\n\t * provide a chance to handle them.\n\t */\n\tpublic constructor(\n\t\tidentifier: TName,\n\t\tmultiplicity: TMultiplicity,\n\t\tpublic readonly changeHandler: FieldChangeHandler<any, TEditor>,\n\t\tprivate readonly allowsTreeSupersetOf: (\n\t\t\toriginalTypes: TreeTypeSet,\n\t\t\tsuperset: TreeFieldStoredSchema,\n\t\t) => boolean,\n\t\tpublic readonly handlesEditsFrom: ReadonlySet<FieldKindIdentifier>,\n\t) {\n\t\tsuper(identifier as TName & FieldKindIdentifier, multiplicity);\n\t}\n\n\t/**\n\t * Returns true if and only if `superset` permits a (non-strict) superset of the subtrees\n\t * allowed by field made from `this` and `originalTypes`.\n\t */\n\tpublic allowsFieldSuperset(\n\t\tpolicy: FullSchemaPolicy,\n\t\toriginalData: TreeStoredSchema,\n\t\toriginalTypes: TreeTypeSet,\n\t\tsuperset: TreeFieldStoredSchema,\n\t): boolean {\n\t\tif (\n\t\t\tisNeverField(policy, originalData, {\n\t\t\t\tkind: this.identifier,\n\t\t\t\ttypes: originalTypes,\n\t\t\t\t// Metadata is not used for this check.\n\t\t\t\tpersistedMetadata: undefined,\n\t\t\t})\n\t\t) {\n\t\t\treturn true;\n\t\t}\n\t\tif (isNeverField(policy, originalData, superset)) {\n\t\t\treturn false;\n\t\t}\n\t\treturn this.allowsTreeSupersetOf(originalTypes, superset);\n\t}\n}\n\n/**\n * Downcasts to {@link FieldKindWithEditor}.\n */\nexport function withEditor<\n\tTName extends string = string,\n\tTMultiplicity extends Multiplicity = Multiplicity,\n>(\n\tkind: FlexFieldKind<TName, TMultiplicity>,\n): FieldKindWithEditor<FieldEditor<any>, TMultiplicity, TName> {\n\tassert(kind instanceof FieldKindWithEditor, 0x7b5 /* kind must be FieldKindWithEditor */);\n\treturn kind as FieldKindWithEditor<FieldEditor<any>, TMultiplicity, TName>;\n}\n\n/* eslint-enable @typescript-eslint/no-explicit-any */\n"]}

package/dist/feature-libraries/optional-field/optionalFieldCodecV1.d.ts

@@ -1,12 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { TAnySchema } from "@sinclair/typebox";
-import type { IJsonCodec } from "../../codec/index.js";
-import type { ChangeEncodingContext, EncodedRevisionTag, RevisionTag } from "../../core/index.js";
-import { type FieldChangeEncodingContext } from "../modular-schema/index.js";
-import { EncodedOptionalChangeset } from "./optionalFieldChangeFormatV1.js";
-import type { OptionalChangeset } from "./optionalFieldChangeTypes.js";
-export declare function makeOptionalFieldCodec(revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext>): IJsonCodec<OptionalChangeset, EncodedOptionalChangeset<TAnySchema>, EncodedOptionalChangeset<TAnySchema>, FieldChangeEncodingContext>;
-//# sourceMappingURL=optionalFieldCodecV1.d.ts.map

package/dist/feature-libraries/optional-field/optionalFieldCodecV1.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"optionalFieldCodecV1.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/optional-field/optionalFieldCodecV1.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EACX,qBAAqB,EACrB,kBAAkB,EAClB,WAAW,EACX,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAEN,KAAK,0BAA0B,EAC/B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,wBAAwB,EAAqB,MAAM,kCAAkC,CAAC;AAC/F,OAAO,KAAK,EAAQ,iBAAiB,EAAc,MAAM,+BAA+B,CAAC;AA4BzF,wBAAgB,sBAAsB,CACrC,gBAAgB,EAAE,UAAU,CAC3B,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,CACrB,GACC,UAAU,CACZ,iBAAiB,EACjB,wBAAwB,CAAC,UAAU,CAAC,EACpC,wBAAwB,CAAC,UAAU,CAAC,EACpC,0BAA0B,CAC1B,CAiJA"}

package/dist/feature-libraries/optional-field/optionalFieldCodecV1.js

@@ -1,158 +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.makeOptionalFieldCodec = void 0;
-const internal_1 = require("@fluidframework/core-utils/internal");
-const changeAtomIdCodec_js_1 = require("../changeAtomIdCodec.js");
-const index_js_1 = require("../modular-schema/index.js");
-const optionalFieldChangeFormatV1_js_1 = require("./optionalFieldChangeFormatV1.js");
-function makeRegisterIdCodec(revisionTagCodec) {
-    const changeAtomIdCodec = (0, changeAtomIdCodec_js_1.makeChangeAtomIdCodec)(revisionTagCodec);
-    return {
-        encode: (registerId, context) => {
-            if (registerId === "self") {
-                return null;
-            }
-            return changeAtomIdCodec.encode(registerId, context);
-        },
-        decode: (registerId, context) => {
-            if (registerId === null) {
-                return "self";
-            }
-            return changeAtomIdCodec.decode(registerId, context);
-        },
-        encodedSchema: optionalFieldChangeFormatV1_js_1.EncodedRegisterId,
-    };
-}
-function makeOptionalFieldCodec(revisionTagCodec) {
-    const registerIdCodec = makeRegisterIdCodec(revisionTagCodec);
-    return {
-        encode: (change, context) => {
-            const encoded = {};
-            encoded.m = [];
-            if (change.valueReplace !== undefined) {
-                if (change.valueReplace.src !== undefined) {
-                    encoded.m.push([
-                        registerIdCodec.encode(change.valueReplace.src, context.baseContext),
-                        registerIdCodec.encode("self", context.baseContext),
-                        true,
-                    ]);
-                }
-                // When the source of the replace is "self", the destination is a reserved ID that will only be used if
-                // the tree in the field is concurrently replaced.
-                if (change.valueReplace.isEmpty || change.valueReplace.src === "self") {
-                    encoded.d = registerIdCodec.encode(change.valueReplace.dst, context.baseContext);
-                }
-                else {
-                    encoded.m.push([
-                        registerIdCodec.encode("self", context.baseContext),
-                        registerIdCodec.encode(change.valueReplace.dst, context.baseContext),
-                        false,
-                    ]);
-                }
-            }
-            for (const [src, dst] of change.moves) {
-                encoded.m.push([
-                    registerIdCodec.encode(src, context.baseContext),
-                    registerIdCodec.encode(dst, context.baseContext),
-                    true,
-                ]);
-            }
-            if (encoded.m.length === 0) {
-                delete encoded.m;
-            }
-            if (change.childChanges.length > 0) {
-                encoded.c = [];
-                for (const [id, childChange] of change.childChanges) {
-                    encoded.c.push([
-                        registerIdCodec.encode(id, context.baseContext),
-                        context.encodeNode(childChange),
-                    ]);
-                }
-            }
-            return encoded;
-        },
-        decode: (encoded, context) => {
-            // The register that the node in the optional field is moved to upon detach
-            let detached;
-            // The register that the node is moved from to upon attaching that node in the optional field
-            let attached;
-            const moves = [];
-            if (encoded.m !== undefined) {
-                for (const [encodedSrc, encodedDst] of encoded.m) {
-                    const src = registerIdCodec.decode(encodedSrc, context.baseContext);
-                    const dst = registerIdCodec.decode(encodedDst, context.baseContext);
-                    if (src === "self" || dst === "self") {
-                        if (src === "self") {
-                            (0, internal_1.assert)(detached === undefined, 0x8d0 /* Multiple detached nodes */);
-                            detached = dst;
-                        }
-                        if (dst === "self") {
-                            (0, internal_1.assert)(attached === undefined, 0x8d1 /* Multiple attached nodes */);
-                            attached = src;
-                        }
-                    }
-                    else {
-                        moves.push([src, dst]);
-                    }
-                }
-            }
-            const decoded = {
-                moves,
-                childChanges: encoded.c?.map(([id, encodedChange]) => [
-                    registerIdCodec.decode(id, context.baseContext),
-                    context.decodeNode(encodedChange),
-                ]) ?? [],
-            };
-            if (detached !== undefined && attached !== undefined) {
-                if (detached === "self" || attached === "self") {
-                    (0, internal_1.assert)(encoded.d !== undefined, 0x8d2 /* Invalid change: pin must have a reserved detach ID */);
-                    const reserved = registerIdCodec.decode(encoded.d, context.baseContext);
-                    (0, internal_1.assert)(reserved !== "self", 0x8d3 /* Invalid reserved detach ID */);
-                    decoded.valueReplace = { isEmpty: false, dst: reserved, src: "self" };
-                }
-                else {
-                    (0, internal_1.assert)(encoded.d === undefined, 0x8d4 /* Invalid change: unexpected reserved detach ID on a change that detaches a node from the field */);
-                    decoded.valueReplace = {
-                        isEmpty: false,
-                        dst: detached,
-                        src: attached,
-                    };
-                }
-            }
-            else if (attached !== undefined) {
-                (0, internal_1.assert)(encoded.d !== undefined, 0x8d5 /* Invalid change: attach must have a reserved detach ID */);
-                const reserved = registerIdCodec.decode(encoded.d, context.baseContext);
-                (0, internal_1.assert)(reserved !== "self", 0x8d6 /* Invalid reserved detach ID */);
-                decoded.valueReplace = {
-                    isEmpty: true,
-                    dst: reserved,
-                    src: attached,
-                };
-            }
-            else if (detached !== undefined) {
-                (0, internal_1.assert)(encoded.d === undefined, 0x8d7 /* Invalid change: unexpected reserved detach ID on a change that detaches a node from the field */);
-                (0, internal_1.assert)(detached !== "self", 0x8d8 /* Invalid detach ID */);
-                decoded.valueReplace = {
-                    isEmpty: false,
-                    dst: detached,
-                };
-            }
-            else if (encoded.d !== undefined) {
-                const detachId = registerIdCodec.decode(encoded.d, context.baseContext);
-                (0, internal_1.assert)(detachId !== "self", 0x8d9 /* Invalid detach ID */);
-                decoded.valueReplace = {
-                    isEmpty: true,
-                    dst: detachId,
-                };
-            }
-            return decoded;
-        },
-        encodedSchema: (0, optionalFieldChangeFormatV1_js_1.EncodedOptionalChangeset)(index_js_1.EncodedNodeChangeset),
-    };
-}
-exports.makeOptionalFieldCodec = makeOptionalFieldCodec;
-//# sourceMappingURL=optionalFieldCodecV1.js.map