@fluidframework/tree 2.0.2 → 2.1.0-276326

package/src/index.ts

@@ -248,6 +248,7 @@ export {
 	ForestType,
 	type SharedTreeContentSnapshot,
 	type FlexTreeView,
+	type FlexTreeViewGeneric,
 	type ITreeViewFork,
 	buildTreeConfiguration,
 	type ISharedTreeEditor,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/tree";
-export const pkgVersion = "2.0.2";
+export const pkgVersion = "2.1.0-276326";

package/src/shared-tree/index.ts

@@ -33,7 +33,12 @@ export {
 	buildTreeConfiguration,
 } from "./schematizeTree.js";
 
-export { type FlexTreeView, CheckoutFlexTreeView, type ITreeViewFork } from "./treeView.js";
+export {
+	type FlexTreeView,
+	CheckoutFlexTreeView,
+	type ITreeViewFork,
+	type FlexTreeViewGeneric,
+} from "./treeView.js";
 
 export type { ISharedTreeEditor, ISchemaEditor } from "./sharedTreeEditBuilder.js";
 

package/src/shared-tree/schematizingTreeView.ts

@@ -19,33 +19,29 @@ import {
 	ViewSchema,
 	defaultSchemaPolicy,
 	ContextSlot,
+	cursorForMapTreeNode,
+	type FlexTreeSchema,
 } from "../feature-libraries/index.js";
 import {
 	type FieldSchema,
 	type ImplicitFieldSchema,
 	type SchemaCompatibilityStatus,
 	type InsertableTreeFieldFromImplicitField,
-	// eslint-disable-next-line import/no-deprecated
-	type TreeConfiguration,
 	type TreeFieldFromImplicitField,
 	type TreeView,
 	type TreeViewEvents,
 	getProxyForField,
-	toFlexConfig,
+	toFlexSchema,
 	setField,
 	normalizeFieldSchema,
 	type InsertableContent,
-	cursorFromUnhydratedRoot,
 	type TreeViewConfiguration,
+	mapTreeFromNodeData,
+	prepareContentForHydration,
 } from "../simple-tree/index.js";
 import { disposeSymbol } from "../util/index.js";
 
-import {
-	type TreeContent,
-	canInitialize,
-	ensureSchema,
-	initialize,
-} from "./schematizeTree.js";
+import { canInitialize, ensureSchema, initialize } from "./schematizeTree.js";
 import type { TreeCheckout } from "./treeCheckout.js";
 import { CheckoutFlexTreeView } from "./treeView.js";
 
@@ -66,7 +62,7 @@ export class SchematizingSimpleTreeView<in out TRootSchema extends ImplicitField
 	 * Undefined iff uninitialized or disposed.
 	 */
 	private currentCompatibility: SchemaCompatibilityStatus | undefined;
-	private readonly flexConfig: TreeContent;
+	private readonly flexSchema: FlexTreeSchema;
 	public readonly events: Listenable<TreeViewEvents> &
 		IEmitter<TreeViewEvents> &
 		HasListeners<TreeViewEvents> = createEmitter();
@@ -88,8 +84,7 @@ export class SchematizingSimpleTreeView<in out TRootSchema extends ImplicitField
 
 	public constructor(
 		public readonly checkout: TreeCheckout,
-		public readonly config: // eslint-disable-next-line import/no-deprecated
-		TreeConfiguration<TRootSchema> | TreeViewConfiguration<TRootSchema>,
+		public readonly config: TreeViewConfiguration<TRootSchema>,
 		public readonly nodeKeyManager: NodeKeyManager,
 	) {
 		const policy = {
@@ -97,11 +92,9 @@ export class SchematizingSimpleTreeView<in out TRootSchema extends ImplicitField
 			validateSchema: config.enableSchemaValidation,
 		};
 		this.rootFieldSchema = normalizeFieldSchema(config.schema);
-		this.flexConfig = toFlexConfig(config, nodeKeyManager, {
-			schema: checkout.storedSchema,
-			policy,
-		});
-		this.viewSchema = new ViewSchema(policy, {}, this.flexConfig.schema);
+		this.flexSchema = toFlexSchema(config.schema);
+
+		this.viewSchema = new ViewSchema(policy, {}, this.flexSchema);
 		// This must be initialized before `update` can be called.
 		this.currentCompatibility = {
 			canView: false,
@@ -127,12 +120,23 @@ export class SchematizingSimpleTreeView<in out TRootSchema extends ImplicitField
 		}
 
 		this.runSchemaEdit(() => {
+			const mapTree = mapTreeFromNodeData(
+				content as InsertableContent,
+				this.rootFieldSchema.allowedTypes,
+				this.nodeKeyManager,
+				{
+					schema: this.checkout.storedSchema,
+					policy: {
+						...defaultSchemaPolicy,
+						validateSchema: this.config.enableSchemaValidation,
+					},
+				},
+			);
+
+			prepareContentForHydration(mapTree, this.checkout.forest);
 			initialize(this.checkout, {
-				schema: this.flexConfig.schema,
-				initialTree:
-					content === undefined
-						? undefined
-						: cursorFromUnhydratedRoot(this.config.schema, content, this.nodeKeyManager),
+				schema: this.flexSchema,
+				initialTree: mapTree === undefined ? undefined : cursorForMapTreeNode(mapTree),
 			});
 		});
 	}
@@ -155,10 +159,12 @@ export class SchematizingSimpleTreeView<in out TRootSchema extends ImplicitField
 		this.runSchemaEdit(() => {
 			const result = ensureSchema(
 				this.viewSchema,
-				// eslint-disable-next-line no-bitwise
-				AllowedUpdateType.SchemaCompatible | AllowedUpdateType.Initialize,
+				AllowedUpdateType.SchemaCompatible,
 				this.checkout,
-				this.flexConfig,
+				{
+					schema: this.flexSchema,
+					initialTree: undefined,
+				},
 			);
 			assert(result, 0x8bf /* Schema upgrade should always work if canUpgrade is set. */);
 		});

package/src/shared-tree/sharedTree.ts

@@ -53,8 +53,6 @@ import {
 import type {
 	ITree,
 	ImplicitFieldSchema,
-	// eslint-disable-next-line import/no-deprecated
-	TreeConfiguration,
 	TreeView,
 	TreeViewConfiguration,
 } from "../simple-tree/index.js";
@@ -322,22 +320,6 @@ export class SharedTree
 		);
 	}
 
-	public schematize<TRoot extends ImplicitFieldSchema>(
-		// eslint-disable-next-line import/no-deprecated
-		config: TreeConfiguration<TRoot>,
-	): TreeView<TRoot> {
-		const view = new SchematizingSimpleTreeView(
-			this.checkout,
-			config,
-			createNodeKeyManager(this.runtime.idCompressor),
-		);
-		// As a subjective API design choice, we initialize the tree here if it is not already initialized.
-		if (view.compatibility.canInitialize === true) {
-			view.initialize(config.initialTree());
-		}
-		return view;
-	}
-
 	public viewWith<TRoot extends ImplicitFieldSchema>(
 		config: TreeViewConfiguration<TRoot>,
 	): TreeView<TRoot> {

package/src/shared-tree/treeApi.ts

@@ -17,7 +17,7 @@ import {
 import { fail } from "../util/index.js";
 
 import { SchematizingSimpleTreeView } from "./schematizingTreeView.js";
-import type { TreeCheckout } from "./treeCheckout.js";
+import type { ITreeCheckout } from "./treeCheckout.js";
 import { contextToTreeView } from "./treeView.js";
 
 /**
@@ -445,7 +445,7 @@ export function runTransaction<
 }
 
 function runTransactionInCheckout<TResult>(
-	checkout: TreeCheckout,
+	checkout: ITreeCheckout,
 	transaction: () => TResult | typeof rollback,
 	preconditions: readonly TransactionConstraint[],
 ): TResult | typeof rollback {

package/src/shared-tree/treeView.ts

@@ -17,14 +17,12 @@ import { type IDisposable, disposeSymbol } from "../util/index.js";
 import type { ITreeCheckout, ITreeCheckoutFork, TreeCheckout } from "./treeCheckout.js";
 
 /**
- * An editable view of a (version control style) branch of a shared tree.
+ * The portion of {@link FlexTreeView} that does not depend on the schema's type.
  * @privateRemarks
- * TODO:
- * 1. Once ISharedTreeView is renamed this can become ISharedTreeView.
- * 2. This object should be combined with or accessible from the TreeContext to allow easy access to thinks like branching.
+ * Since {@link FlexTreeView}'s schema is invariant, `FlexTreeView<FlexFieldSchema>` does not cover this use case.
  * @internal
  */
-export interface FlexTreeView<in out TRoot extends FlexFieldSchema> extends IDisposable {
+export interface FlexTreeViewGeneric extends IDisposable {
 	/**
 	 * Context for controlling the FlexTree nodes produced from {@link FlexTreeView.flexTree}.
 	 *
@@ -40,7 +38,17 @@ export interface FlexTreeView<in out TRoot extends FlexFieldSchema> extends IDis
 	 * This is a non-owning reference: disposing of this view does not impact the branch.
 	 */
 	readonly checkout: ITreeCheckout;
+}
 
+/**
+ * An editable view of a (version control style) branch of a shared tree.
+ * @privateRemarks
+ * TODO:
+ * If schema aware APIs are removed from flex tree, this can be combined with {@link FlexTreeViewGeneric}.
+ * @internal
+ */
+export interface FlexTreeView<in out TRoot extends FlexFieldSchema>
+	extends FlexTreeViewGeneric {
 	/**
 	 * Get a typed view of the tree content using the flex-tree API.
 	 */
@@ -100,6 +108,4 @@ export class CheckoutFlexTreeView<
  * Maps the context of every {@link CheckoutFlexTreeView} to the view.
  * In practice, this allows the view or checkout to be obtained from a flex node by first getting the context from the flex node and then using this map.
  */
-// TODO: use something other than `any`
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const contextToTreeView = new WeakMap<Context, CheckoutFlexTreeView<any>>();
+export const contextToTreeView = new WeakMap<Context, FlexTreeViewGeneric>();

package/src/simple-tree/index.ts

@@ -7,7 +7,6 @@ export {
 	type ITree,
 	type TreeView,
 	type TreeViewEvents,
-	TreeConfiguration,
 	TreeViewConfiguration,
 	type ITreeViewConfiguration,
 	type SchemaCompatibilityStatus,
@@ -42,7 +41,7 @@ export {
 export { SchemaFactory, type ScopedSchemaName } from "./schemaFactory.js";
 export { getFlexNode } from "./proxyBinding.js";
 export { treeNodeApi, type TreeNodeApi, type TreeChangeEvents } from "./treeNodeApi.js";
-export { toFlexConfig, cursorFromUnhydratedRoot } from "./toFlexSchema.js";
+export { toFlexSchema, cursorFromUnhydratedRoot } from "./toFlexSchema.js";
 export type {
 	FieldHasDefaultUnsafe,
 	ObjectFromSchemaRecordUnsafe,
@@ -60,7 +59,11 @@ export type {
 	NodeFromSchemaUnsafe,
 } from "./typesUnsafe.js";
 export type { ValidateRecursiveSchema } from "./schemaFactoryRecursive.js";
-export { getProxyForField, type InsertableContent } from "./proxies.js";
+export {
+	getProxyForField,
+	type InsertableContent,
+	prepareContentForHydration,
+} from "./proxies.js";
 
 export {
 	adaptEnum,
@@ -93,3 +96,4 @@ export {
 	setField,
 } from "./objectNode.js";
 export type { TreeMapNode } from "./mapNode.js";
+export { mapTreeFromNodeData } from "./toMapTree.js";

package/src/simple-tree/objectNode.ts

@@ -200,6 +200,12 @@ function createProxyHandler(
 			setField(flexNode.getBoxed(fieldInfo.storedKey), fieldInfo.schema, value);
 			return true;
 		},
+		deleteProperty(target, viewKey): boolean {
+			// TODO: supporting delete when it makes sense (custom local fields, and optional field) could be added as a feature in the future.
+			throw new UsageError(
+				`Object nodes do not support the delete operator. Optional fields can be assigned to undefined instead.`,
+			);
+		},
 		has: (target, viewKey) => {
 			return (
 				flexKeyMap.has(viewKey) ||

package/src/simple-tree/proxies.ts

@@ -25,6 +25,7 @@ import {
 	type MapTreeNode,
 	tryGetMapTreeNode,
 	typeNameSymbol,
+	isFlexTreeNode,
 } from "../feature-libraries/index.js";
 import { type Mutable, fail, isReadonlyArray } from "../util/index.js";
 
@@ -55,27 +56,28 @@ export function isTreeNode(candidate: unknown): candidate is TreeNode | Unhydrat
  * Retrieve the associated proxy for the given field.
  * */
 export function getProxyForField(field: FlexTreeField): TreeNode | TreeValue | undefined {
+	function tryToUnboxLeaves(
+		flexField: FlexTreeTypedField<
+			FlexFieldSchema<typeof FieldKinds.required | typeof FieldKinds.optional>
+		>,
+	): TreeNode | TreeValue | undefined {
+		const maybeUnboxedContent = flexField.content;
+		return isFlexTreeNode(maybeUnboxedContent)
+			? getOrCreateNodeProxy(maybeUnboxedContent)
+			: maybeUnboxedContent;
+	}
 	switch (field.schema.kind) {
 		case FieldKinds.required: {
-			const asValue = field as FlexTreeTypedField<FlexFieldSchema<typeof FieldKinds.required>>;
-
-			// TODO: Ideally, we would return leaves without first boxing them.  However, this is not
-			//       as simple as calling '.content' since this skips the node and returns the FieldNode's
-			//       inner field.
-			return getOrCreateNodeProxy(asValue.boxedContent);
+			const typedField = field as FlexTreeTypedField<
+				FlexFieldSchema<typeof FieldKinds.required>
+			>;
+			return tryToUnboxLeaves(typedField);
 		}
 		case FieldKinds.optional: {
-			const asValue = field as FlexTreeTypedField<FlexFieldSchema<typeof FieldKinds.optional>>;
-
-			// TODO: Ideally, we would return leaves without first boxing them.  However, this is not
-			//       as simple as calling '.content' since this skips the node and returns the FieldNode's
-			//       inner field.
-
-			const maybeContent = asValue.boxedContent;
-
-			// Normally, empty fields are unreachable due to the behavior of 'tryGetField'.  However, the
-			// root field is a special case where the field is always present (even if empty).
-			return maybeContent === undefined ? undefined : getOrCreateNodeProxy(maybeContent);
+			const typedField = field as FlexTreeTypedField<
+				FlexFieldSchema<typeof FieldKinds.optional>
+			>;
+			return tryToUnboxLeaves(typedField);
 		}
 		// TODO: Remove if/when 'FieldNode' is removed.
 		case FieldKinds.sequence: {
@@ -84,9 +86,9 @@ export function getProxyForField(field: FlexTreeField): TreeNode | TreeValue | u
 			fail("'sequence' field is unexpected.");
 		}
 		case FieldKinds.identifier: {
-			const identifier = field.boxedAt(0);
-			assert(identifier !== undefined, 0x91a /* identifier must exist */);
-			return getOrCreateNodeProxy(identifier);
+			// Identifier fields are just value fields that hold strings
+			return (field as FlexTreeTypedField<FlexFieldSchema<typeof FieldKinds.required>>)
+				.content as string;
 		}
 
 		default:

package/src/simple-tree/schemaFactory.ts

@@ -10,13 +10,7 @@ import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import type { IFluidHandle as _dummyImport } from "@fluidframework/core-interfaces";
 
 import type { TreeValue } from "../core/index.js";
-import {
-	type FlexTreeNode,
-	type NodeKeyManager,
-	type Unenforced,
-	isFlexTreeNode,
-	isLazy,
-} from "../feature-libraries/index.js";
+import { type NodeKeyManager, type Unenforced, isLazy } from "../feature-libraries/index.js";
 import {
 	type RestrictiveReadonlyRecord,
 	getOrCreate,
@@ -641,26 +635,12 @@ export class SchemaFactory<
 		const Name extends TName,
 		const T extends Unenforced<ImplicitAllowedTypes>,
 	>(name: Name, allowedTypes: T) {
-		class RecursiveArray extends this.namedArray(
+		const RecursiveArray = this.namedArray(
 			name,
 			allowedTypes as T & ImplicitAllowedTypes,
 			true,
 			false,
-		) {
-			public constructor(
-				data:
-					| Iterable<InsertableTreeNodeFromImplicitAllowedTypes<T & ImplicitAllowedTypes>>
-					| FlexTreeNode,
-			) {
-				if (isFlexTreeNode(data)) {
-					// TODO: use something other than `any`
-					// eslint-disable-next-line @typescript-eslint/no-explicit-any
-					super(data as any);
-				} else {
-					super(data);
-				}
-			}
-		}
+		);
 
 		return RecursiveArray as TreeNodeSchemaClass<
 			ScopedSchemaName<TScope, Name>,
@@ -697,28 +677,12 @@ export class SchemaFactory<
 		name: Name,
 		allowedTypes: T,
 	) {
-		class MapSchema extends this.namedMap(
+		const MapSchema = this.namedMap(
 			name,
 			allowedTypes as T & ImplicitAllowedTypes,
 			true,
 			false,
-		) {
-			public constructor(
-				data:
-					| Iterable<
-							[string, InsertableTreeNodeFromImplicitAllowedTypes<T & ImplicitAllowedTypes>]
-					  >
-					| FlexTreeNode,
-			) {
-				if (isFlexTreeNode(data)) {
-					// TODO: use something other than `any`
-					// eslint-disable-next-line @typescript-eslint/no-explicit-any
-					super(data as any);
-				} else {
-					super(new Map(data));
-				}
-			}
-		}
+		);
 
 		return MapSchema as TreeNodeSchemaClass<
 			ScopedSchemaName<TScope, Name>,

package/src/simple-tree/toFlexSchema.ts

@@ -27,7 +27,6 @@ import {
 	schemaIsLeaf,
 } from "../feature-libraries/index.js";
 import { normalizeFlexListEager } from "../feature-libraries/typed-schema/flexList.js";
-import type { TreeContent } from "../shared-tree/index.js";
 import { brand, fail, isReadonlyArray, mapIterable } from "../util/index.js";
 
 import type { InsertableContent } from "./proxies.js";
@@ -48,8 +47,6 @@ import {
 	getStoredKey,
 } from "./schemaTypes.js";
 import { cursorFromNodeData } from "./toMapTree.js";
-// eslint-disable-next-line import/no-deprecated
-import { TreeConfiguration, type TreeViewConfiguration } from "./tree.js";
 
 /**
  * Returns a cursor (in nodes mode) for the root node.
@@ -77,50 +74,6 @@ export function cursorFromUnhydratedRoot(
 	);
 }
 
-/* eslint-disable import/no-deprecated */
-function isTreeConfiguration(
-	config: TreeViewConfiguration | TreeConfiguration,
-): config is TreeConfiguration {
-	return config instanceof TreeConfiguration;
-}
-/* eslint-enable import/no-deprecated */
-
-/**
- * Generates a configuration object (schema + initial tree) for a FlexTree.
- * @param config - Configuration for how to {@link ITree.schematize|schematize} a tree.
- * @param nodeKeyManager - See {@link NodeKeyManager}.
- * @param schemaValidationPolicy - Stored schema and policy for the tree. If the policy specifies
- * `{@link SchemaPolicy.validateSchema} === true`, new content inserted into the tree will be validated using this
- * object.
- * @returns A configuration object for a FlexTree.
- *
- * @privateremarks
- * I wrote these docs without a ton of context, they can probably be improved.
- */
-export function toFlexConfig(
-	// eslint-disable-next-line import/no-deprecated
-	config: TreeViewConfiguration | TreeConfiguration,
-	nodeKeyManager: NodeKeyManager,
-	schemaValidationPolicy: SchemaAndPolicy | undefined = undefined,
-): TreeContent {
-	const unhydrated = isTreeConfiguration(config) ? config.initialTree() : undefined;
-	const initialTree =
-		unhydrated === undefined
-			? undefined
-			: [
-					cursorFromUnhydratedRoot(
-						config.schema,
-						unhydrated,
-						nodeKeyManager,
-						schemaValidationPolicy,
-					),
-				];
-	return {
-		schema: toFlexSchema(config.schema),
-		initialTree,
-	};
-}
-
 interface SchemaInfo {
 	toFlex: () => FlexTreeNodeSchema;
 	original: TreeNodeSchema;

package/src/simple-tree/tree.ts

@@ -133,43 +133,6 @@ export class TreeViewConfiguration<TSchema extends ImplicitFieldSchema = Implici
 	}
 }
 
-/**
- * Configuration for how to {@link ITree.schematize | schematize} a tree.
- * @sealed @public
- * @deprecated Please migrate to use {@link TreeViewConfiguration} with {@link ITree.viewWith} instead.
- */
-export class TreeConfiguration<TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> {
-	/**
-	 * If `true`, the tree will validate new content against its stored schema at insertion time
-	 * and throw an error if the new content doesn't match the expected schema.
-	 *
-	 * @defaultValue `false`.
-	 *
-	 * @remarks Enabling schema validation has a performance penalty when inserting new content into the tree because
-	 * additional checks are done. Enable this option only in scenarios where you are ok with that operation being a
-	 * bit slower.
-	 */
-	public readonly enableSchemaValidation: boolean;
-
-	/**
-	 * @param schema - The schema which the application wants to view the tree with.
-	 * @param initialTree - A function that returns the default tree content to initialize the tree with iff the tree is uninitialized
-	 * (meaning it does not even have any schema set at all).
-	 * If `initialTree` returns any actual node instances, they should be recreated each time `initialTree` runs.
-	 * This is because if the config is used a second time any nodes that were not recreated could error since nodes cannot be inserted into the tree multiple times.
-	 * @param options - Additional options that can be specified when {@link ITree.schematize | schematizing } a tree.
-	 */
-	public constructor(
-		public readonly schema: TSchema,
-		public readonly initialTree: () => InsertableTreeFieldFromImplicitField<TSchema>,
-		options?: ITreeConfigurationOptions,
-	) {
-		this.enableSchemaValidation =
-			options?.enableSchemaValidation ??
-			defaultTreeConfigurationOptions.enableSchemaValidation;
-	}
-}
-
 /**
  * An editable view of a (version control style) branch of a shared tree based on some schema.
  *

package/src/treeFactory.ts

@@ -56,7 +56,7 @@ export class TreeFactory implements IChannelFactory<ITree> {
 /**
  * SharedTree is a hierarchical data structure for collaboratively editing strongly typed JSON-like trees
  * of objects, arrays, and other data types.
- * @alpha
+ * @internal
  */
 export const SharedTree = configuredSharedTree({});
 

package/src/util/brandedMap.ts

@@ -3,11 +3,16 @@
  * Licensed under the MIT License.
  */
 
+import type { Brand } from "./brand.js";
+import type { Opaque } from "./opaque.js";
 import type { Invariant } from "./typeCheck.js";
 import { getOrCreate } from "./utils.js";
 
 /**
  * Key in a {@link BrandedMapSubset}.
+ * @remarks
+ * 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`.
  * @internal
  */
 export type BrandedKey<TKey, TContent> = TKey & Invariant<TContent>;
@@ -49,16 +54,15 @@ export interface BrandedMapSubset<K extends BrandedKey<unknown, any>> {
 
 /**
  * Version of {@link getOrCreate} with better typing for {@link BrandedMapSubset}.
+ * @privateRemarks
+ * Only infers type from key to avoid inferring `any` from map's key.
  */
-export function getOrCreateSlotContent<
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	M extends BrandedMapSubset<BrandedKey<unknown, any>>,
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	K extends BrandedKey<unknown, any>,
->(map: M, key: K, defaultValue: (key: K) => BrandedKeyContent<K>): BrandedKeyContent<K> {
-	const result: BrandedKeyContent<K> = getOrCreate(map, key, defaultValue);
-	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
-	return result;
+export function getOrCreateSlotContent<K, V>(
+	map: NoInfer<BrandedMapSubset<BrandedKey<K, V>>>,
+	key: BrandedKey<K, V>,
+	defaultValue: NoInfer<(key: BrandedKey<K, V>) => V>,
+): V {
+	return getOrCreate<BrandedKey<K, V>, V>(map, key, defaultValue);
 }
 
 /**
@@ -72,7 +76,10 @@ let slotCounter = 0;
  * Define a strongly typed slot in which data can be stored in a {@link BrandedMapSubset}.
  * @internal
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function brandedSlot<TSlot extends BrandedKey<any, any>>(): TSlot {
+export function brandedSlot<
+	// See note on BrandedKey.
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	TSlot extends BrandedKey<number | Opaque<Brand<number, string>>, any>,
+>(): TSlot {
 	return slotCounter++ as TSlot;
 }