@fluidframework/tree 2.23.0 → 2.30.0

package/src/simple-tree/treeNodeValid.ts

@@ -64,6 +64,8 @@ export abstract class TreeNodeValid<TInput> extends TreeNode {
 	/**
 	 * Schema classes can override to provide a callback that is called once when the first node is constructed.
 	 * This is a good place to perform extra validation and cache schema derived data needed for the implementation of the node.
+	 * @remarks
+	 * It is valid to dereference LazyItem schema references in this function (or anything that runs after it).
 	 */
 	protected static oneTimeSetup<T>(this: typeof TreeNodeValid<T>): Context {
 		fail(0xae5 /* Missing oneTimeSetup */);
@@ -146,7 +148,7 @@ export abstract class TreeNodeValid<TInput> extends TreeNode {
 	}
 
 	/**
-	 * @see {@link TreeNodeSchemaCore.createFromInsertable}.
+	 * See {@link TreeNodeSchemaCore.createFromInsertable}.
 	 */
 	public static createFromInsertable<TInput, TOut, TThis extends new (args: TInput) => TOut>(
 		this: TThis,
@@ -155,13 +157,22 @@ export abstract class TreeNodeValid<TInput> extends TreeNode {
 		return new this(input);
 	}
 
+	/**
+	 * Idempotent initialization function that pre-caches data and can dereference lazy schema references.
+	 */
+	public static oneTimeInitialize(
+		this: typeof TreeNodeValid & TreeNodeSchema,
+	): Required<MostDerivedData> {
+		const cache = this.markMostDerived();
+		cache.oneTimeInitialized ??= this.oneTimeSetup();
+		// TypeScript fails to narrow the type of `oneTimeInitialized` to `Context` here, so use a cast:
+		return cache as MostDerivedData & { oneTimeInitialized: Context };
+	}
+
 	public constructor(input: TInput | InternalTreeNode) {
 		super(privateToken);
 		const schema = this.constructor as typeof TreeNodeValid & TreeNodeSchema;
-		const cache = schema.markMostDerived();
-		if (cache.oneTimeInitialized === undefined) {
-			cache.oneTimeInitialized = schema.oneTimeSetup();
-		}
+		const cache = schema.oneTimeInitialize();
 
 		if (isTreeNode(input)) {
 			// TODO: update this once we have better support for deep-copying and move operations.

package/src/util/cloneWithReplacements.ts

@@ -0,0 +1,41 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Like `JSON.stringify`, but returns a clone instead of stringifying the result.
+ *
+ * @remarks Only considers enumerable own properties with string keys.
+ *
+ * @param root - Data to clone.
+ * @param rootKey - The key to pass to replacer for the root.
+ * @param replacer - Like `JSON.stringify`'s replacer: called for every value while walking data. Unlike `JSON.stringify`'s replacer, this
+ * returns a wrapper around the value with a "clone" flag to indicate if the clone should recurse into that object (true) or use it as is (false).
+ * @returns A clone of `root`.
+ * @alpha
+ */
+export function cloneWithReplacements(
+	root: unknown,
+	rootKey: string,
+	replacer: (key: string, value: unknown) => { clone: boolean; value: unknown },
+): unknown {
+	const { clone, value } = replacer(rootKey, root);
+	if (clone === false) {
+		return value;
+	}
+
+	if (root === null || typeof root !== "object") {
+		return root;
+	}
+
+	if (Array.isArray(root)) {
+		return root.map((item, index) => cloneWithReplacements(item, index.toString(), replacer));
+	}
+
+	const result: Record<string, unknown> = {};
+	for (const [key, field] of Object.entries(root)) {
+		result[key] = cloneWithReplacements(field, key, replacer);
+	}
+	return result;
+}

package/src/util/index.ts

@@ -144,3 +144,5 @@ export {
 } from "./breakable.js";
 
 export { type TupleBTree, newTupleBTree, mergeTupleBTrees } from "./bTreeUtils.js";
+
+export { cloneWithReplacements } from "./cloneWithReplacements.js";

package/src/util/referenceCounting.ts

@@ -5,9 +5,26 @@
 
 import { assert } from "@fluidframework/core-utils/internal";
 
+/**
+ * An object which counts the number of users / references to it.
+ * @remarks
+ * This implements the [Reference counting](https://en.wikipedia.org/wiki/Reference_counting) pattern.
+ * Getting the reference count correct is difficult in TypeScript and great care must be used.
+ * Because of this, this interface should not be used in the public API.
+ */
 export interface ReferenceCounted {
+	/**
+	 * Called to increase the reference count tracked by this object.
+	 * @remarks
+	 * When a user of this object allows something else to use it,
+	 * this should be called.
+	 */
 	referenceAdded(): void;
-
+	/**
+	 * Called to decrease the reference count tracked by this object.
+	 * @remarks
+	 * When a user of this object will no longer use it, this should be called.
+	 */
 	referenceRemoved(): void;
 
 	/**

package/dist/feature-libraries/chunked-forest/codec/schemaBasedEncoding.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaBasedEncoding.d.ts","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/schemaBasedEncoding.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAIN,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAI7B,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEtE,OAAO,EACN,YAAY,EACZ,KAAK,YAAY,EACjB,KAAK,WAAW,EAEhB,KAAK,UAAU,EAIf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,KAAK,iBAAiB,EAAwC,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAEnE;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACrC,MAAM,EAAE,sBAAsB,EAC9B,MAAM,EAAE,gBAAgB,EACxB,UAAU,EAAE,UAAU,EACtB,YAAY,EAAE,aAAa,GACzB,iBAAiB,CAEnB;AAED,wBAAgB,UAAU,CACzB,MAAM,EAAE,sBAAsB,EAC9B,MAAM,EAAE,gBAAgB,EACxB,YAAY,EAAE,aAAa,GACzB,YAAY,CAUd;AAED;;GAEG;AACH,wBAAgB,WAAW,CAC1B,WAAW,EAAE,UAAU,EACvB,KAAK,EAAE,qBAAqB,EAC5B,KAAK,EAAE,YAAY,EACnB,YAAY,EAAE,sBAAsB,GAClC,YAAY,CA6Bd;AAED;;GAEG;AACH,wBAAgB,UAAU,CACzB,UAAU,EAAE,sBAAsB,EAClC,MAAM,EAAE,gBAAgB,EACxB,YAAY,EAAE,WAAW,EACzB,UAAU,EAAE,wBAAwB,GAClC,SAAS,CAoCX;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,SAAS,CAU5E"}

package/dist/feature-libraries/chunked-forest/codec/schemaBasedEncoding.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaBasedEncoding.js","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/schemaBasedEncoding.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA8E;AAE9E,qDAUgC;AAChC,qDAA8C;AAG9C,+DAS+B;AAE/B,2CAA2F;AAC3F,iDAA2C;AAG3C;;;;;GAKG;AACH,SAAgB,sBAAsB,CACrC,MAA8B,EAC9B,MAAwB,EACxB,UAAsB,EACtB,YAA2B;IAE3B,OAAO,IAAA,sCAAgB,EAAC,UAAU,EAAE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;AAC/E,CAAC;AAPD,wDAOC;AAED,SAAgB,UAAU,CACzB,MAA8B,EAC9B,MAAwB,EACxB,YAA2B;IAE3B,MAAM,KAAK,GAAiB,IAAI,kCAAY,CAC3C,CAAC,YAAyB,EAAE,UAAoC,EAAE,EAAE,CACnE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,EACrD,CAAC,WAAuB,EAAE,KAA4B,EAAE,EAAE,CACzD,WAAW,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,EAC/C,MAAM,CAAC,UAAU,EACjB,YAAY,CACZ,CAAC;IACF,OAAO,KAAK,CAAC;AACd,CAAC;AAdD,gCAcC;AAED;;GAEG;AACH,SAAgB,WAAW,CAC1B,WAAuB,EACvB,KAA4B,EAC5B,KAAmB,EACnB,YAAoC;IAEpC,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAA,eAAI,EAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACtF,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrC,MAAM,WAAW,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,oCAAc,CAAC;IAC1F,IAAI,IAAI,CAAC,YAAY,KAAK,uBAAY,CAAC,MAAM,EAAE,CAAC;QAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,wCAA6B,EAAE,CAAC;YAClD,IAAA,iBAAM,EAAC,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,oDAAoD,CAAC,CAAC;YACvF,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACrD,IAAA,iBAAM,EAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;YACzE,IAAA,iBAAM,EACL,UAAU,YAAY,+BAAoB,EAC1C,KAAK,CAAC,6CAA6C,CACnD,CAAC;YACF,IAAA,iBAAM,EACL,UAAU,CAAC,SAAS,KAAK,sBAAW,CAAC,MAAM,EAC3C,KAAK,CAAC,8CAA8C,CACpD,CAAC;YACF,MAAM,qBAAqB,GAAG,IAAI,wBAAS,CAC1C,IAAI,EACJ,wBAAY,CAAC,UAAU,EACvB,EAAE,EACF,SAAS,CACT,CAAC;YACF,OAAO,IAAA,oCAAc,EAAC,qBAAqB,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,IAAA,oCAAc,EAAC,WAAW,CAAC,CAAC;IACpC,CAAC;SAAM,CAAC;QACP,OAAO,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;AACF,CAAC;AAlCD,kCAkCC;AAED;;GAEG;AACH,SAAgB,UAAU,CACzB,UAAkC,EAClC,MAAwB,EACxB,YAAyB,EACzB,UAAoC;IAEpC,MAAM,MAAM,GACX,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,IAAA,eAAI,EAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAEhF,IAAI,MAAM,YAAY,iCAAsB,EAAE,CAAC;QAC9C,oBAAoB;QACpB,+FAA+F;QAC/F,0BAA0B;QAE1B,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QACjD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,gBAAgB,IAAI,EAAE,EAAE,CAAC;YAC1D,gBAAgB,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC3E,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,wBAAS,CAAC,UAAU,EAAE,KAAK,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;QAC5E,OAAO,KAAK,CAAC;IACd,CAAC;IACD,IAAI,MAAM,YAAY,+BAAoB,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG,IAAI,wBAAS,CAC1B,UAAU,EACV,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,EACtC,EAAE,EACF,SAAS,CACT,CAAC;QACF,OAAO,KAAK,CAAC;IACd,CAAC;IACD,IAAI,MAAM,YAAY,8BAAmB,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAG,IAAI,wBAAS,CAC1B,UAAU,EACV,KAAK,EACL,EAAE,EACF,YAAY,CAAC,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAC7C,CAAC;QACF,OAAO,KAAK,CAAC;IACd,CAAC;IACD,IAAA,eAAI,EAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;AACzC,CAAC;AAzCD,gCAyCC;AAED,SAAgB,UAAU,CAAI,GAA+B;IAC5D,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACb,CAAC;AACF,CAAC;AAVD,gCAUC;AAED,SAAS,oBAAoB,CAAC,MAA+B;IAC5D,QAAQ,MAAM,EAAE,CAAC;QAChB,KAAK,SAAS;YACb,OAAO,KAAK,CAAC;QACd,KAAK,sBAAW,CAAC,MAAM,CAAC;QACxB,KAAK,sBAAW,CAAC,MAAM,CAAC;QACxB,KAAK,sBAAW,CAAC,OAAO,CAAC;QACzB,KAAK,sBAAW,CAAC,WAAW;YAC3B,OAAO,IAAI,CAAC;QACb,KAAK,sBAAW,CAAC,IAAI;YACpB,OAAO,CAAC,IAAI,CAAC,CAAC;QACf;YACC,IAAA,0BAAe,EAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, unreachableCase } from \"@fluidframework/core-utils/internal\";\n\nimport {\n\tLeafNodeStoredSchema,\n\tMapNodeStoredSchema,\n\tObjectNodeStoredSchema,\n\ttype StoredSchemaCollection,\n\ttype TreeFieldStoredSchema,\n\ttype TreeNodeSchemaIdentifier,\n\tValueSchema,\n\tMultiplicity,\n\tidentifierFieldKindIdentifier,\n} from \"../../../core/index.js\";\nimport { fail } from \"../../../util/index.js\";\nimport type { FullSchemaPolicy } from \"../../modular-schema/index.js\";\n\nimport {\n\tEncoderCache,\n\ttype FieldEncoder,\n\ttype FieldShaper,\n\ttype KeyedFieldEncoder,\n\ttype TreeShaper,\n\tanyNodeEncoder,\n\tasFieldEncoder,\n\tcompressedEncode,\n} from \"./compressedEncode.js\";\nimport type { FieldBatch } from \"./fieldBatch.js\";\nimport { type EncodedFieldBatch, type EncodedValueShape, SpecialField } from \"./format.js\";\nimport { NodeShape } from \"./nodeShape.js\";\nimport type { IIdCompressor } from \"@fluidframework/id-compressor\";\n\n/**\n * Encode data from `fieldBatch` in into an `EncodedChunk`.\n *\n * Optimized for encoded size and encoding performance.\n * TODO: This function should eventually also take in the root FieldSchema to more efficiently compress the nodes.\n */\nexport function schemaCompressedEncode(\n\tschema: StoredSchemaCollection,\n\tpolicy: FullSchemaPolicy,\n\tfieldBatch: FieldBatch,\n\tidCompressor: IIdCompressor,\n): EncodedFieldBatch {\n\treturn compressedEncode(fieldBatch, buildCache(schema, policy, idCompressor));\n}\n\nexport function buildCache(\n\tschema: StoredSchemaCollection,\n\tpolicy: FullSchemaPolicy,\n\tidCompressor: IIdCompressor,\n): EncoderCache {\n\tconst cache: EncoderCache = new EncoderCache(\n\t\t(fieldHandler: FieldShaper, schemaName: TreeNodeSchemaIdentifier) =>\n\t\t\ttreeShaper(schema, policy, fieldHandler, schemaName),\n\t\t(treeHandler: TreeShaper, field: TreeFieldStoredSchema) =>\n\t\t\tfieldShaper(treeHandler, field, cache, schema),\n\t\tpolicy.fieldKinds,\n\t\tidCompressor,\n\t);\n\treturn cache;\n}\n\n/**\n * Selects shapes to use to encode fields.\n */\nexport function fieldShaper(\n\ttreeHandler: TreeShaper,\n\tfield: TreeFieldStoredSchema,\n\tcache: EncoderCache,\n\tstoredSchema: StoredSchemaCollection,\n): FieldEncoder {\n\tconst kind = cache.fieldShapes.get(field.kind) ?? fail(0xb52 /* missing FieldKind */);\n\tconst type = oneFromSet(field.types);\n\tconst nodeEncoder = type !== undefined ? treeHandler.shapeFromTree(type) : anyNodeEncoder;\n\tif (kind.multiplicity === Multiplicity.Single) {\n\t\tif (field.kind === identifierFieldKindIdentifier) {\n\t\t\tassert(type !== undefined, 0x999 /* field type must be defined in identifier field */);\n\t\t\tconst nodeSchema = storedSchema.nodeSchema.get(type);\n\t\t\tassert(nodeSchema !== undefined, 0x99a /* nodeSchema must be defined */);\n\t\t\tassert(\n\t\t\t\tnodeSchema instanceof LeafNodeStoredSchema,\n\t\t\t\t0x99b /* nodeSchema must be LeafNodeStoredSchema */,\n\t\t\t);\n\t\t\tassert(\n\t\t\t\tnodeSchema.leafValue === ValueSchema.String,\n\t\t\t\t0x99c /* identifier field can only be type string */,\n\t\t\t);\n\t\t\tconst identifierNodeEncoder = new NodeShape(\n\t\t\t\ttype,\n\t\t\t\tSpecialField.Identifier,\n\t\t\t\t[],\n\t\t\t\tundefined,\n\t\t\t);\n\t\t\treturn asFieldEncoder(identifierNodeEncoder);\n\t\t}\n\t\treturn asFieldEncoder(nodeEncoder);\n\t} else {\n\t\treturn cache.nestedArray(nodeEncoder);\n\t}\n}\n\n/**\n * Selects shapes to use to encode trees.\n */\nexport function treeShaper(\n\tfullSchema: StoredSchemaCollection,\n\tpolicy: FullSchemaPolicy,\n\tfieldHandler: FieldShaper,\n\tschemaName: TreeNodeSchemaIdentifier,\n): NodeShape {\n\tconst schema =\n\t\tfullSchema.nodeSchema.get(schemaName) ?? fail(0xb53 /* missing node schema */);\n\n\tif (schema instanceof ObjectNodeStoredSchema) {\n\t\t// TODO:Performance:\n\t\t// consider moving some optional and sequence fields to extra fields if they are commonly empty\n\t\t// to reduce encoded size.\n\n\t\tconst objectNodeFields: KeyedFieldEncoder[] = [];\n\t\tfor (const [key, field] of schema.objectNodeFields ?? []) {\n\t\t\tobjectNodeFields.push({ key, shape: fieldHandler.shapeFromField(field) });\n\t\t}\n\n\t\tconst shape = new NodeShape(schemaName, false, objectNodeFields, undefined);\n\t\treturn shape;\n\t}\n\tif (schema instanceof LeafNodeStoredSchema) {\n\t\tconst shape = new NodeShape(\n\t\t\tschemaName,\n\t\t\tvalueShapeFromSchema(schema.leafValue),\n\t\t\t[],\n\t\t\tundefined,\n\t\t);\n\t\treturn shape;\n\t}\n\tif (schema instanceof MapNodeStoredSchema) {\n\t\tconst shape = new NodeShape(\n\t\t\tschemaName,\n\t\t\tfalse,\n\t\t\t[],\n\t\t\tfieldHandler.shapeFromField(schema.mapFields),\n\t\t);\n\t\treturn shape;\n\t}\n\tfail(0xb54 /* unsupported node kind */);\n}\n\nexport function oneFromSet<T>(set: ReadonlySet<T> | undefined): T | undefined {\n\tif (set === undefined) {\n\t\treturn undefined;\n\t}\n\tif (set.size !== 1) {\n\t\treturn undefined;\n\t}\n\tfor (const item of set) {\n\t\treturn item;\n\t}\n}\n\nfunction valueShapeFromSchema(schema: ValueSchema | undefined): undefined | EncodedValueShape {\n\tswitch (schema) {\n\t\tcase undefined:\n\t\t\treturn false;\n\t\tcase ValueSchema.Number:\n\t\tcase ValueSchema.String:\n\t\tcase ValueSchema.Boolean:\n\t\tcase ValueSchema.FluidHandle:\n\t\t\treturn true;\n\t\tcase ValueSchema.Null:\n\t\t\treturn [null];\n\t\tdefault:\n\t\t\tunreachableCase(schema);\n\t}\n}\n"]}

package/dist/feature-libraries/node-key/index.d.ts

@@ -1,8 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export { MockNodeKeyManager } from "./mockNodeKeyManager.js";
-export { compareLocalNodeKeys, type LocalNodeKey, type StableNodeKey, nodeKeyTreeIdentifier, } from "./nodeKey.js";
-export { createNodeKeyManager, isStableNodeKey, type NodeKeyManager, } from "./nodeKeyManager.js";
-//# sourceMappingURL=index.d.ts.map

package/dist/feature-libraries/node-key/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EACN,oBAAoB,EACpB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,qBAAqB,GACrB,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,oBAAoB,EACpB,eAAe,EACf,KAAK,cAAc,GACnB,MAAM,qBAAqB,CAAC"}

package/dist/feature-libraries/node-key/index.js

@@ -1,16 +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.isStableNodeKey = exports.createNodeKeyManager = exports.nodeKeyTreeIdentifier = exports.compareLocalNodeKeys = exports.MockNodeKeyManager = void 0;
-var mockNodeKeyManager_js_1 = require("./mockNodeKeyManager.js");
-Object.defineProperty(exports, "MockNodeKeyManager", { enumerable: true, get: function () { return mockNodeKeyManager_js_1.MockNodeKeyManager; } });
-var nodeKey_js_1 = require("./nodeKey.js");
-Object.defineProperty(exports, "compareLocalNodeKeys", { enumerable: true, get: function () { return nodeKey_js_1.compareLocalNodeKeys; } });
-Object.defineProperty(exports, "nodeKeyTreeIdentifier", { enumerable: true, get: function () { return nodeKey_js_1.nodeKeyTreeIdentifier; } });
-var nodeKeyManager_js_1 = require("./nodeKeyManager.js");
-Object.defineProperty(exports, "createNodeKeyManager", { enumerable: true, get: function () { return nodeKeyManager_js_1.createNodeKeyManager; } });
-Object.defineProperty(exports, "isStableNodeKey", { enumerable: true, get: function () { return nodeKeyManager_js_1.isStableNodeKey; } });
-//# sourceMappingURL=index.js.map

package/dist/feature-libraries/node-key/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iEAA6D;AAApD,2HAAA,kBAAkB,OAAA;AAC3B,2CAKsB;AAJrB,kHAAA,oBAAoB,OAAA;AAGpB,mHAAA,qBAAqB,OAAA;AAEtB,yDAI6B;AAH5B,yHAAA,oBAAoB,OAAA;AACpB,oHAAA,eAAe,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { MockNodeKeyManager } from \"./mockNodeKeyManager.js\";\nexport {\n\tcompareLocalNodeKeys,\n\ttype LocalNodeKey,\n\ttype StableNodeKey,\n\tnodeKeyTreeIdentifier,\n} from \"./nodeKey.js\";\nexport {\n\tcreateNodeKeyManager,\n\tisStableNodeKey,\n\ttype NodeKeyManager,\n} from \"./nodeKeyManager.js\";\n"]}

package/dist/feature-libraries/node-key/mockNodeKeyManager.d.ts

@@ -1,22 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { StableId } from "@fluidframework/id-compressor";
-import type { LocalNodeKey, StableNodeKey } from "./nodeKey.js";
-import { type NodeKeyManager } from "./nodeKeyManager.js";
-/**
- * Mock {@link NodeKeyManager} that generates deterministic {@link StableNodeKey}s and {@link LocalNodeKey}s.
- * @remarks This is useful for test environments because it will always yield the same keys in the same order.
- * It should not be used for production environments for the same reason; the {@link StableNodeKey}s are not universally unique.
- */
-export declare class MockNodeKeyManager implements NodeKeyManager {
-    private count;
-    generateStableNodeKey(): StableNodeKey;
-    generateLocalNodeKey(): LocalNodeKey;
-    localizeNodeKey(key: StableNodeKey): LocalNodeKey;
-    stabilizeNodeKey(key: LocalNodeKey): StableNodeKey;
-    tryLocalizeNodeKey(key: string): LocalNodeKey | undefined;
-    getId(offset: number): StableId;
-}
-//# sourceMappingURL=mockNodeKeyManager.d.ts.map

package/dist/feature-libraries/node-key/mockNodeKeyManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mockNodeKeyManager.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/mockNodeKeyManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAA4B,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAExF,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAmB,KAAK,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAG3E;;;;GAIG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACxD,OAAO,CAAC,KAAK,CAAK;IAEX,qBAAqB,IAAI,aAAa;IAItC,oBAAoB,IAAI,YAAY;IAIpC,eAAe,CAAC,GAAG,EAAE,aAAa,GAAG,YAAY;IAIjD,gBAAgB,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa;IAIlD,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAUzD,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ;CAOtC"}

package/dist/feature-libraries/node-key/mockNodeKeyManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mockNodeKeyManager.js","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/mockNodeKeyManager.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAE7D,qEAA0E;AAE1E,2DAA2E;AAC3E,kDAAqE;AAErE;;;;GAIG;AACH,MAAa,kBAAkB;IAA/B;QACS,UAAK,GAAG,CAAC,CAAC;IAmCnB,CAAC;IAjCO,qBAAqB;QAC3B,OAAO,IAAA,gBAAK,EAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACxC,CAAC;IAEM,oBAAoB;QAC1B,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC3D,CAAC;IAEM,eAAe,CAAC,GAAkB;QACxC,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,IAAA,eAAI,EAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAClF,CAAC;IAEM,gBAAgB,CAAC,GAAiB;QACxC,OAAO,IAAA,gBAAK,EAAC,IAAI,CAAC,KAAK,CAAC,IAAA,4BAAiB,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC;IAEM,kBAAkB,CAAC,GAAW;QACpC,IAAI,CAAC,IAAA,mCAAe,EAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,0BAA0B,CAAC,EAAE,CAAC;YAC1E,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5D,OAAO,YAAY,GAAG,IAAI,CAAC,KAAK;YAC/B,CAAC,CAAC,IAAA,gBAAK,EAAC,YAAwC,CAAC;YACjD,CAAC,CAAC,SAAS,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,MAAc;QAC1B,IAAA,iBAAM,EAAC,MAAM,IAAI,CAAC,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACjE,IAAA,iBAAM,EAAC,MAAM,GAAG,mBAAmB,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACpF,OAAO,IAAA,2BAAgB,EACtB,2BAA2B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAC9E,CAAC;IACH,CAAC;CACD;AApCD,gDAoCC","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 type { SessionSpaceCompressedId, StableId } from \"@fluidframework/id-compressor\";\nimport { assertIsStableId } from \"@fluidframework/id-compressor/internal\";\nimport type { LocalNodeKey, StableNodeKey } from \"./nodeKey.js\";\nimport { isStableNodeKey, type NodeKeyManager } from \"./nodeKeyManager.js\";\nimport { brand, extractFromOpaque, fail } from \"../../util/index.js\";\n\n/**\n * Mock {@link NodeKeyManager} that generates deterministic {@link StableNodeKey}s and {@link LocalNodeKey}s.\n * @remarks This is useful for test environments because it will always yield the same keys in the same order.\n * It should not be used for production environments for the same reason; the {@link StableNodeKey}s are not universally unique.\n */\nexport class MockNodeKeyManager implements NodeKeyManager {\n\tprivate count = 0;\n\n\tpublic generateStableNodeKey(): StableNodeKey {\n\t\treturn brand(this.getId(this.count++));\n\t}\n\n\tpublic generateLocalNodeKey(): LocalNodeKey {\n\t\treturn this.localizeNodeKey(this.generateStableNodeKey());\n\t}\n\n\tpublic localizeNodeKey(key: StableNodeKey): LocalNodeKey {\n\t\treturn this.tryLocalizeNodeKey(key) ?? fail(0xb26 /* Key is not compressible */);\n\t}\n\n\tpublic stabilizeNodeKey(key: LocalNodeKey): StableNodeKey {\n\t\treturn brand(this.getId(extractFromOpaque(key)));\n\t}\n\n\tpublic tryLocalizeNodeKey(key: string): LocalNodeKey | undefined {\n\t\tif (!isStableNodeKey(key) || !key.startsWith(\"a110ca7e-add1-4000-8000-\")) {\n\t\t\treturn undefined;\n\t\t}\n\t\tconst localNodeKey = Number.parseInt(key.substring(24), 16);\n\t\treturn localNodeKey < this.count\n\t\t\t? brand(localNodeKey as SessionSpaceCompressedId)\n\t\t\t: undefined;\n\t}\n\n\tpublic getId(offset: number): StableId {\n\t\tassert(offset >= 0, 0x6e7 /* UUID offset may not be negative */);\n\t\tassert(offset < 281_474_976_710_656, 0x6e8 /* UUID offset must be at most 16^12 */);\n\t\treturn assertIsStableId(\n\t\t\t`a110ca7e-add1-4000-8000-${Math.round(offset).toString(16).padStart(12, \"0\")}`,\n\t\t);\n\t}\n}\n"]}

package/dist/feature-libraries/node-key/nodeKey.d.ts

@@ -1,38 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { SessionSpaceCompressedId, StableId } from "@fluidframework/id-compressor";
-import type { TreeNodeSchemaIdentifier } from "../../core/index.js";
-import { type Brand, type Opaque } from "../../util/index.js";
-/**
- * A key which uniquely identifies a node in the tree within this session.
- * @remarks {@link LocalNodeKey}s must not be serialized and stored as data without first being converted into a {@link StableNodeKey}.
- * They are local to the current session and equivalent nodes in another session will not necessarily have the same {@link LocalNodeKey}.
- * However, they are otherwise preferential to use over {@link StableNodeKey}s as they are much smaller.
- * For example, they are more efficient than {@link StableNodeKey}s when used as keys in a map.
- * {@link LocalNodeKey}s may be compared or equated via {@link compareLocalNodeKeys}.
- */
-export interface LocalNodeKey extends Opaque<Brand<SessionSpaceCompressedId, "Local Node Key">> {
-}
-/**
- * A UUID which identifies a node in the tree.
- * This key is universally unique and stable forever; therefore it is safe to persist as data in a SharedTree or other DDS/database.
- * When not persisted or serialized, it is preferable to use a {@link LocalNodeKey} instead for better performance.
- */
-export type StableNodeKey = Brand<StableId, "Stable Node Key">;
-/**
- * Compares two {@link LocalNodeKey}s.
- * All {@link LocalNodeKey}s retrieved from a single SharedTree client can be totally ordered using this comparator.
- * @param a - the first key to compare
- * @param b - the second key to compare
- * @returns `0` if `a` and `b` are the same key, otherwise `-1` if `a` is ordered before `b` or `1` if `a` is ordered after `b`.
- */
-export declare function compareLocalNodeKeys(a: LocalNodeKey, b: LocalNodeKey): -1 | 0 | 1;
-/**
- * The TreeNodeSchemaIdentifier for node keys.
- * @privateRemarks TODO: Come up with a unified and collision-resistant naming schema for types defined by the system.
- * For now, we'll use `__` to reduce the change of collision, since this is what other internal properties use in Fluid.
- */
-export declare const nodeKeyTreeIdentifier: TreeNodeSchemaIdentifier;
-//# sourceMappingURL=nodeKey.d.ts.map

package/dist/feature-libraries/node-key/nodeKey.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKey.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/nodeKey.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAExF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,MAAM,EAAS,MAAM,qBAAqB,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,YAChB,SAAQ,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,CAAC;CAAG;AAErE;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;AAE/D;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAEjF;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,EAAE,wBAEnC,CAAC"}

package/dist/feature-libraries/node-key/nodeKey.js

@@ -1,26 +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.nodeKeyTreeIdentifier = exports.compareLocalNodeKeys = void 0;
-const index_js_1 = require("../../util/index.js");
-/**
- * Compares two {@link LocalNodeKey}s.
- * All {@link LocalNodeKey}s retrieved from a single SharedTree client can be totally ordered using this comparator.
- * @param a - the first key to compare
- * @param b - the second key to compare
- * @returns `0` if `a` and `b` are the same key, otherwise `-1` if `a` is ordered before `b` or `1` if `a` is ordered after `b`.
- */
-function compareLocalNodeKeys(a, b) {
-    return a === b ? 0 : a > b ? 1 : -1;
-}
-exports.compareLocalNodeKeys = compareLocalNodeKeys;
-/**
- * The TreeNodeSchemaIdentifier for node keys.
- * @privateRemarks TODO: Come up with a unified and collision-resistant naming schema for types defined by the system.
- * For now, we'll use `__` to reduce the change of collision, since this is what other internal properties use in Fluid.
- */
-exports.nodeKeyTreeIdentifier = (0, index_js_1.brand)("com.fluidframework.nodeKey.NodeKey");
-//# sourceMappingURL=nodeKey.js.map

package/dist/feature-libraries/node-key/nodeKey.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKey.js","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/nodeKey.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,kDAAqE;AAoBrE;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,CAAe,EAAE,CAAe;IACpE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACrC,CAAC;AAFD,oDAEC;AAED;;;;GAIG;AACU,QAAA,qBAAqB,GAA6B,IAAA,gBAAK,EACnE,oCAAoC,CACpC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { SessionSpaceCompressedId, StableId } from \"@fluidframework/id-compressor\";\n\nimport type { TreeNodeSchemaIdentifier } from \"../../core/index.js\";\nimport { type Brand, type Opaque, brand } from \"../../util/index.js\";\n\n/**\n * A key which uniquely identifies a node in the tree within this session.\n * @remarks {@link LocalNodeKey}s must not be serialized and stored as data without first being converted into a {@link StableNodeKey}.\n * They are local to the current session and equivalent nodes in another session will not necessarily have the same {@link LocalNodeKey}.\n * However, they are otherwise preferential to use over {@link StableNodeKey}s as they are much smaller.\n * For example, they are more efficient than {@link StableNodeKey}s when used as keys in a map.\n * {@link LocalNodeKey}s may be compared or equated via {@link compareLocalNodeKeys}.\n */\nexport interface LocalNodeKey\n\textends Opaque<Brand<SessionSpaceCompressedId, \"Local Node Key\">> {}\n\n/**\n * A UUID which identifies a node in the tree.\n * This key is universally unique and stable forever; therefore it is safe to persist as data in a SharedTree or other DDS/database.\n * When not persisted or serialized, it is preferable to use a {@link LocalNodeKey} instead for better performance.\n */\nexport type StableNodeKey = Brand<StableId, \"Stable Node Key\">;\n\n/**\n * Compares two {@link LocalNodeKey}s.\n * All {@link LocalNodeKey}s retrieved from a single SharedTree client can be totally ordered using this comparator.\n * @param a - the first key to compare\n * @param b - the second key to compare\n * @returns `0` if `a` and `b` are the same key, otherwise `-1` if `a` is ordered before `b` or `1` if `a` is ordered after `b`.\n */\nexport function compareLocalNodeKeys(a: LocalNodeKey, b: LocalNodeKey): -1 | 0 | 1 {\n\treturn a === b ? 0 : a > b ? 1 : -1;\n}\n\n/**\n * The TreeNodeSchemaIdentifier for node keys.\n * @privateRemarks TODO: Come up with a unified and collision-resistant naming schema for types defined by the system.\n * For now, we'll use `__` to reduce the change of collision, since this is what other internal properties use in Fluid.\n */\nexport const nodeKeyTreeIdentifier: TreeNodeSchemaIdentifier = brand(\n\t\"com.fluidframework.nodeKey.NodeKey\",\n);\n"]}

package/dist/feature-libraries/node-key/nodeKeyManager.d.ts

@@ -1,37 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { IIdCompressor } from "@fluidframework/id-compressor";
-import type { LocalNodeKey, StableNodeKey } from "./nodeKey.js";
-/**
- * An object which handles the generation of node keys as well as conversion between their two types ({@link StableNodeKey} and {@link LocalNodeKey}).
- */
-export interface NodeKeyManager {
-    /**
-     * Generate a {@link StableNodeKey}.
-     */
-    generateLocalNodeKey(): LocalNodeKey;
-    /**
-     * Convert the given {@link StableNodeKey} into its {@link LocalNodeKey} form.
-     */
-    localizeNodeKey(key: StableNodeKey): LocalNodeKey;
-    /**
-     * Convert the given {@link LocalNodeKey} into its {@link StableNodeKey} form.
-     */
-    stabilizeNodeKey(key: LocalNodeKey): StableNodeKey;
-    /**
-     * Attempts to recompress a StableNodeKey.
-     * @param key - The key that is attempted to recompress.
-     * @returns The `LocalNodeKey` associated with `key` or undefined if the key was not generated by any session known to this compressor.
-     */
-    tryLocalizeNodeKey(key: string): LocalNodeKey | undefined;
-}
-/**
- * Creates a {@link NodeKeyManager} from the given {@link IIdCompressor}.
- * @param idCompressor - the compressor to use for key generation, compression, and decompression.
- * If undefined, then attempts to generate or convert keys will throw an error.
- */
-export declare function createNodeKeyManager(idCompressor?: IIdCompressor | undefined): NodeKeyManager;
-export declare function isStableNodeKey(key: string): key is StableNodeKey;
-//# sourceMappingURL=nodeKeyManager.d.ts.map

package/dist/feature-libraries/node-key/nodeKeyManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKeyManager.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/nodeKeyManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAKnE,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,oBAAoB,IAAI,YAAY,CAAC;IAErC;;OAEG;IACH,eAAe,CAAC,GAAG,EAAE,aAAa,GAAG,YAAY,CAAC;IAElD;;OAEG;IACH,gBAAgB,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa,CAAC;IAEnD;;;;OAIG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;CAC1D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CACnC,YAAY,CAAC,EAAE,aAAa,GAAG,SAAS,GACtC,cAAc,CAyChB;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,aAAa,CAEjE"}

package/dist/feature-libraries/node-key/nodeKeyManager.js

@@ -1,48 +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.isStableNodeKey = exports.createNodeKeyManager = void 0;
-const internal_1 = require("@fluidframework/core-utils/internal");
-const internal_2 = require("@fluidframework/id-compressor/internal");
-const index_js_1 = require("../../util/index.js");
-/**
- * Creates a {@link NodeKeyManager} from the given {@link IIdCompressor}.
- * @param idCompressor - the compressor to use for key generation, compression, and decompression.
- * If undefined, then attempts to generate or convert keys will throw an error.
- */
-function createNodeKeyManager(idCompressor) {
-    return {
-        generateLocalNodeKey: () => {
-            (0, internal_1.assert)(idCompressor !== undefined, 0x6e4 /* Runtime IdCompressor must be available to generate local node keys */);
-            return (0, index_js_1.brand)(idCompressor.generateCompressedId());
-        },
-        localizeNodeKey: (key) => {
-            (0, internal_1.assert)(idCompressor !== undefined, 0x6e5 /* Runtime IdCompressor must be available to convert node keys */);
-            return (0, index_js_1.brand)(idCompressor.recompress(key));
-        },
-        stabilizeNodeKey: (key) => {
-            (0, internal_1.assert)(idCompressor !== undefined, 0x6e6 /* Runtime IdCompressor must be available to convert node keys */);
-            return (0, index_js_1.brand)(
-            // TODO: The assert below is required for type safety but is maybe slow
-            (0, internal_2.assertIsStableId)(idCompressor.decompress((0, index_js_1.extractFromOpaque)(key))));
-        },
-        tryLocalizeNodeKey: (key) => {
-            (0, internal_1.assert)(idCompressor !== undefined, 0x6e9 /* Runtime IdCompressor must be available to convert node keys */);
-            if (isStableNodeKey(key)) {
-                const compressedKey = idCompressor.tryRecompress(key);
-                if (compressedKey !== undefined) {
-                    return (0, index_js_1.brand)(compressedKey);
-                }
-            }
-        },
-    };
-}
-exports.createNodeKeyManager = createNodeKeyManager;
-function isStableNodeKey(key) {
-    return (0, internal_2.isStableId)(key);
-}
-exports.isStableNodeKey = isStableNodeKey;
-//# sourceMappingURL=nodeKeyManager.js.map

package/dist/feature-libraries/node-key/nodeKeyManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKeyManager.js","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/nodeKeyManager.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAE7D,qEAAsF;AAEtF,kDAA+D;AA+B/D;;;;GAIG;AACH,SAAgB,oBAAoB,CACnC,YAAwC;IAExC,OAAO;QACN,oBAAoB,EAAE,GAAG,EAAE;YAC1B,IAAA,iBAAM,EACL,YAAY,KAAK,SAAS,EAC1B,KAAK,CAAC,wEAAwE,CAC9E,CAAC;YACF,OAAO,IAAA,gBAAK,EAAC,YAAY,CAAC,oBAAoB,EAAE,CAAC,CAAC;QACnD,CAAC;QAED,eAAe,EAAE,CAAC,GAAkB,EAAE,EAAE;YACvC,IAAA,iBAAM,EACL,YAAY,KAAK,SAAS,EAC1B,KAAK,CAAC,iEAAiE,CACvE,CAAC;YACF,OAAO,IAAA,gBAAK,EAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5C,CAAC;QAED,gBAAgB,EAAE,CAAC,GAAiB,EAAE,EAAE;YACvC,IAAA,iBAAM,EACL,YAAY,KAAK,SAAS,EAC1B,KAAK,CAAC,iEAAiE,CACvE,CAAC;YACF,OAAO,IAAA,gBAAK;YACX,uEAAuE;YACvE,IAAA,2BAAgB,EAAC,YAAY,CAAC,UAAU,CAAC,IAAA,4BAAiB,EAAC,GAAG,CAAC,CAAC,CAAC,CACjE,CAAC;QACH,CAAC;QACD,kBAAkB,EAAE,CAAC,GAAW,EAAE,EAAE;YACnC,IAAA,iBAAM,EACL,YAAY,KAAK,SAAS,EAC1B,KAAK,CAAC,iEAAiE,CACvE,CAAC;YACF,IAAI,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,MAAM,aAAa,GAAG,YAAY,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;gBACtD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;oBACjC,OAAO,IAAA,gBAAK,EAAC,aAAa,CAAC,CAAC;gBAC7B,CAAC;YACF,CAAC;QACF,CAAC;KACD,CAAC;AACH,CAAC;AA3CD,oDA2CC;AAED,SAAgB,eAAe,CAAC,GAAW;IAC1C,OAAO,IAAA,qBAAU,EAAC,GAAG,CAAC,CAAC;AACxB,CAAC;AAFD,0CAEC","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 type { IIdCompressor } from \"@fluidframework/id-compressor\";\nimport { assertIsStableId, isStableId } from \"@fluidframework/id-compressor/internal\";\n\nimport { brand, extractFromOpaque } from \"../../util/index.js\";\n\nimport type { LocalNodeKey, StableNodeKey } from \"./nodeKey.js\";\n\n/**\n * An object which handles the generation of node keys as well as conversion between their two types ({@link StableNodeKey} and {@link LocalNodeKey}).\n */\nexport interface NodeKeyManager {\n\t/**\n\t * Generate a {@link StableNodeKey}.\n\t */\n\tgenerateLocalNodeKey(): LocalNodeKey;\n\n\t/**\n\t * Convert the given {@link StableNodeKey} into its {@link LocalNodeKey} form.\n\t */\n\tlocalizeNodeKey(key: StableNodeKey): LocalNodeKey;\n\n\t/**\n\t * Convert the given {@link LocalNodeKey} into its {@link StableNodeKey} form.\n\t */\n\tstabilizeNodeKey(key: LocalNodeKey): StableNodeKey;\n\n\t/**\n\t * Attempts to recompress a StableNodeKey.\n\t * @param key - The key that is attempted to recompress.\n\t * @returns The `LocalNodeKey` associated with `key` or undefined if the key was not generated by any session known to this compressor.\n\t */\n\ttryLocalizeNodeKey(key: string): LocalNodeKey | undefined;\n}\n\n/**\n * Creates a {@link NodeKeyManager} from the given {@link IIdCompressor}.\n * @param idCompressor - the compressor to use for key generation, compression, and decompression.\n * If undefined, then attempts to generate or convert keys will throw an error.\n */\nexport function createNodeKeyManager(\n\tidCompressor?: IIdCompressor | undefined,\n): NodeKeyManager {\n\treturn {\n\t\tgenerateLocalNodeKey: () => {\n\t\t\tassert(\n\t\t\t\tidCompressor !== undefined,\n\t\t\t\t0x6e4 /* Runtime IdCompressor must be available to generate local node keys */,\n\t\t\t);\n\t\t\treturn brand(idCompressor.generateCompressedId());\n\t\t},\n\n\t\tlocalizeNodeKey: (key: StableNodeKey) => {\n\t\t\tassert(\n\t\t\t\tidCompressor !== undefined,\n\t\t\t\t0x6e5 /* Runtime IdCompressor must be available to convert node keys */,\n\t\t\t);\n\t\t\treturn brand(idCompressor.recompress(key));\n\t\t},\n\n\t\tstabilizeNodeKey: (key: LocalNodeKey) => {\n\t\t\tassert(\n\t\t\t\tidCompressor !== undefined,\n\t\t\t\t0x6e6 /* Runtime IdCompressor must be available to convert node keys */,\n\t\t\t);\n\t\t\treturn brand(\n\t\t\t\t// TODO: The assert below is required for type safety but is maybe slow\n\t\t\t\tassertIsStableId(idCompressor.decompress(extractFromOpaque(key))),\n\t\t\t);\n\t\t},\n\t\ttryLocalizeNodeKey: (key: string) => {\n\t\t\tassert(\n\t\t\t\tidCompressor !== undefined,\n\t\t\t\t0x6e9 /* Runtime IdCompressor must be available to convert node keys */,\n\t\t\t);\n\t\t\tif (isStableNodeKey(key)) {\n\t\t\t\tconst compressedKey = idCompressor.tryRecompress(key);\n\t\t\t\tif (compressedKey !== undefined) {\n\t\t\t\t\treturn brand(compressedKey);\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t};\n}\n\nexport function isStableNodeKey(key: string): key is StableNodeKey {\n\treturn isStableId(key);\n}\n"]}

package/lib/feature-libraries/chunked-forest/codec/schemaBasedEncoding.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaBasedEncoding.d.ts","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/schemaBasedEncoding.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAIN,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAI7B,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEtE,OAAO,EACN,YAAY,EACZ,KAAK,YAAY,EACjB,KAAK,WAAW,EAEhB,KAAK,UAAU,EAIf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,KAAK,iBAAiB,EAAwC,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAEnE;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACrC,MAAM,EAAE,sBAAsB,EAC9B,MAAM,EAAE,gBAAgB,EACxB,UAAU,EAAE,UAAU,EACtB,YAAY,EAAE,aAAa,GACzB,iBAAiB,CAEnB;AAED,wBAAgB,UAAU,CACzB,MAAM,EAAE,sBAAsB,EAC9B,MAAM,EAAE,gBAAgB,EACxB,YAAY,EAAE,aAAa,GACzB,YAAY,CAUd;AAED;;GAEG;AACH,wBAAgB,WAAW,CAC1B,WAAW,EAAE,UAAU,EACvB,KAAK,EAAE,qBAAqB,EAC5B,KAAK,EAAE,YAAY,EACnB,YAAY,EAAE,sBAAsB,GAClC,YAAY,CA6Bd;AAED;;GAEG;AACH,wBAAgB,UAAU,CACzB,UAAU,EAAE,sBAAsB,EAClC,MAAM,EAAE,gBAAgB,EACxB,YAAY,EAAE,WAAW,EACzB,UAAU,EAAE,wBAAwB,GAClC,SAAS,CAoCX;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,SAAS,CAU5E"}

package/lib/feature-libraries/chunked-forest/codec/schemaBasedEncoding.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaBasedEncoding.js","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/schemaBasedEncoding.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAE9E,OAAO,EACN,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EAItB,WAAW,EACX,YAAY,EACZ,6BAA6B,GAC7B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAG9C,OAAO,EACN,YAAY,EAKZ,cAAc,EACd,cAAc,EACd,gBAAgB,GAChB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAkD,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CACrC,MAA8B,EAC9B,MAAwB,EACxB,UAAsB,EACtB,YAA2B;IAE3B,OAAO,gBAAgB,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED,MAAM,UAAU,UAAU,CACzB,MAA8B,EAC9B,MAAwB,EACxB,YAA2B;IAE3B,MAAM,KAAK,GAAiB,IAAI,YAAY,CAC3C,CAAC,YAAyB,EAAE,UAAoC,EAAE,EAAE,CACnE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,EACrD,CAAC,WAAuB,EAAE,KAA4B,EAAE,EAAE,CACzD,WAAW,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,EAC/C,MAAM,CAAC,UAAU,EACjB,YAAY,CACZ,CAAC;IACF,OAAO,KAAK,CAAC;AACd,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAC1B,WAAuB,EACvB,KAA4B,EAC5B,KAAmB,EACnB,YAAoC;IAEpC,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACtF,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrC,MAAM,WAAW,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;IAC1F,IAAI,IAAI,CAAC,YAAY,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;QAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,6BAA6B,EAAE,CAAC;YAClD,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,oDAAoD,CAAC,CAAC;YACvF,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACrD,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;YACzE,MAAM,CACL,UAAU,YAAY,oBAAoB,EAC1C,KAAK,CAAC,6CAA6C,CACnD,CAAC;YACF,MAAM,CACL,UAAU,CAAC,SAAS,KAAK,WAAW,CAAC,MAAM,EAC3C,KAAK,CAAC,8CAA8C,CACpD,CAAC;YACF,MAAM,qBAAqB,GAAG,IAAI,SAAS,CAC1C,IAAI,EACJ,YAAY,CAAC,UAAU,EACvB,EAAE,EACF,SAAS,CACT,CAAC;YACF,OAAO,cAAc,CAAC,qBAAqB,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,cAAc,CAAC,WAAW,CAAC,CAAC;IACpC,CAAC;SAAM,CAAC;QACP,OAAO,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;AACF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CACzB,UAAkC,EAClC,MAAwB,EACxB,YAAyB,EACzB,UAAoC;IAEpC,MAAM,MAAM,GACX,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAEhF,IAAI,MAAM,YAAY,sBAAsB,EAAE,CAAC;QAC9C,oBAAoB;QACpB,+FAA+F;QAC/F,0BAA0B;QAE1B,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QACjD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,gBAAgB,IAAI,EAAE,EAAE,CAAC;YAC1D,gBAAgB,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC3E,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC,UAAU,EAAE,KAAK,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;QAC5E,OAAO,KAAK,CAAC;IACd,CAAC;IACD,IAAI,MAAM,YAAY,oBAAoB,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG,IAAI,SAAS,CAC1B,UAAU,EACV,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,EACtC,EAAE,EACF,SAAS,CACT,CAAC;QACF,OAAO,KAAK,CAAC;IACd,CAAC;IACD,IAAI,MAAM,YAAY,mBAAmB,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAG,IAAI,SAAS,CAC1B,UAAU,EACV,KAAK,EACL,EAAE,EACF,YAAY,CAAC,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAC7C,CAAC;QACF,OAAO,KAAK,CAAC;IACd,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,UAAU,CAAI,GAA+B;IAC5D,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACb,CAAC;AACF,CAAC;AAED,SAAS,oBAAoB,CAAC,MAA+B;IAC5D,QAAQ,MAAM,EAAE,CAAC;QAChB,KAAK,SAAS;YACb,OAAO,KAAK,CAAC;QACd,KAAK,WAAW,CAAC,MAAM,CAAC;QACxB,KAAK,WAAW,CAAC,MAAM,CAAC;QACxB,KAAK,WAAW,CAAC,OAAO,CAAC;QACzB,KAAK,WAAW,CAAC,WAAW;YAC3B,OAAO,IAAI,CAAC;QACb,KAAK,WAAW,CAAC,IAAI;YACpB,OAAO,CAAC,IAAI,CAAC,CAAC;QACf;YACC,eAAe,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, unreachableCase } from \"@fluidframework/core-utils/internal\";\n\nimport {\n\tLeafNodeStoredSchema,\n\tMapNodeStoredSchema,\n\tObjectNodeStoredSchema,\n\ttype StoredSchemaCollection,\n\ttype TreeFieldStoredSchema,\n\ttype TreeNodeSchemaIdentifier,\n\tValueSchema,\n\tMultiplicity,\n\tidentifierFieldKindIdentifier,\n} from \"../../../core/index.js\";\nimport { fail } from \"../../../util/index.js\";\nimport type { FullSchemaPolicy } from \"../../modular-schema/index.js\";\n\nimport {\n\tEncoderCache,\n\ttype FieldEncoder,\n\ttype FieldShaper,\n\ttype KeyedFieldEncoder,\n\ttype TreeShaper,\n\tanyNodeEncoder,\n\tasFieldEncoder,\n\tcompressedEncode,\n} from \"./compressedEncode.js\";\nimport type { FieldBatch } from \"./fieldBatch.js\";\nimport { type EncodedFieldBatch, type EncodedValueShape, SpecialField } from \"./format.js\";\nimport { NodeShape } from \"./nodeShape.js\";\nimport type { IIdCompressor } from \"@fluidframework/id-compressor\";\n\n/**\n * Encode data from `fieldBatch` in into an `EncodedChunk`.\n *\n * Optimized for encoded size and encoding performance.\n * TODO: This function should eventually also take in the root FieldSchema to more efficiently compress the nodes.\n */\nexport function schemaCompressedEncode(\n\tschema: StoredSchemaCollection,\n\tpolicy: FullSchemaPolicy,\n\tfieldBatch: FieldBatch,\n\tidCompressor: IIdCompressor,\n): EncodedFieldBatch {\n\treturn compressedEncode(fieldBatch, buildCache(schema, policy, idCompressor));\n}\n\nexport function buildCache(\n\tschema: StoredSchemaCollection,\n\tpolicy: FullSchemaPolicy,\n\tidCompressor: IIdCompressor,\n): EncoderCache {\n\tconst cache: EncoderCache = new EncoderCache(\n\t\t(fieldHandler: FieldShaper, schemaName: TreeNodeSchemaIdentifier) =>\n\t\t\ttreeShaper(schema, policy, fieldHandler, schemaName),\n\t\t(treeHandler: TreeShaper, field: TreeFieldStoredSchema) =>\n\t\t\tfieldShaper(treeHandler, field, cache, schema),\n\t\tpolicy.fieldKinds,\n\t\tidCompressor,\n\t);\n\treturn cache;\n}\n\n/**\n * Selects shapes to use to encode fields.\n */\nexport function fieldShaper(\n\ttreeHandler: TreeShaper,\n\tfield: TreeFieldStoredSchema,\n\tcache: EncoderCache,\n\tstoredSchema: StoredSchemaCollection,\n): FieldEncoder {\n\tconst kind = cache.fieldShapes.get(field.kind) ?? fail(0xb52 /* missing FieldKind */);\n\tconst type = oneFromSet(field.types);\n\tconst nodeEncoder = type !== undefined ? treeHandler.shapeFromTree(type) : anyNodeEncoder;\n\tif (kind.multiplicity === Multiplicity.Single) {\n\t\tif (field.kind === identifierFieldKindIdentifier) {\n\t\t\tassert(type !== undefined, 0x999 /* field type must be defined in identifier field */);\n\t\t\tconst nodeSchema = storedSchema.nodeSchema.get(type);\n\t\t\tassert(nodeSchema !== undefined, 0x99a /* nodeSchema must be defined */);\n\t\t\tassert(\n\t\t\t\tnodeSchema instanceof LeafNodeStoredSchema,\n\t\t\t\t0x99b /* nodeSchema must be LeafNodeStoredSchema */,\n\t\t\t);\n\t\t\tassert(\n\t\t\t\tnodeSchema.leafValue === ValueSchema.String,\n\t\t\t\t0x99c /* identifier field can only be type string */,\n\t\t\t);\n\t\t\tconst identifierNodeEncoder = new NodeShape(\n\t\t\t\ttype,\n\t\t\t\tSpecialField.Identifier,\n\t\t\t\t[],\n\t\t\t\tundefined,\n\t\t\t);\n\t\t\treturn asFieldEncoder(identifierNodeEncoder);\n\t\t}\n\t\treturn asFieldEncoder(nodeEncoder);\n\t} else {\n\t\treturn cache.nestedArray(nodeEncoder);\n\t}\n}\n\n/**\n * Selects shapes to use to encode trees.\n */\nexport function treeShaper(\n\tfullSchema: StoredSchemaCollection,\n\tpolicy: FullSchemaPolicy,\n\tfieldHandler: FieldShaper,\n\tschemaName: TreeNodeSchemaIdentifier,\n): NodeShape {\n\tconst schema =\n\t\tfullSchema.nodeSchema.get(schemaName) ?? fail(0xb53 /* missing node schema */);\n\n\tif (schema instanceof ObjectNodeStoredSchema) {\n\t\t// TODO:Performance:\n\t\t// consider moving some optional and sequence fields to extra fields if they are commonly empty\n\t\t// to reduce encoded size.\n\n\t\tconst objectNodeFields: KeyedFieldEncoder[] = [];\n\t\tfor (const [key, field] of schema.objectNodeFields ?? []) {\n\t\t\tobjectNodeFields.push({ key, shape: fieldHandler.shapeFromField(field) });\n\t\t}\n\n\t\tconst shape = new NodeShape(schemaName, false, objectNodeFields, undefined);\n\t\treturn shape;\n\t}\n\tif (schema instanceof LeafNodeStoredSchema) {\n\t\tconst shape = new NodeShape(\n\t\t\tschemaName,\n\t\t\tvalueShapeFromSchema(schema.leafValue),\n\t\t\t[],\n\t\t\tundefined,\n\t\t);\n\t\treturn shape;\n\t}\n\tif (schema instanceof MapNodeStoredSchema) {\n\t\tconst shape = new NodeShape(\n\t\t\tschemaName,\n\t\t\tfalse,\n\t\t\t[],\n\t\t\tfieldHandler.shapeFromField(schema.mapFields),\n\t\t);\n\t\treturn shape;\n\t}\n\tfail(0xb54 /* unsupported node kind */);\n}\n\nexport function oneFromSet<T>(set: ReadonlySet<T> | undefined): T | undefined {\n\tif (set === undefined) {\n\t\treturn undefined;\n\t}\n\tif (set.size !== 1) {\n\t\treturn undefined;\n\t}\n\tfor (const item of set) {\n\t\treturn item;\n\t}\n}\n\nfunction valueShapeFromSchema(schema: ValueSchema | undefined): undefined | EncodedValueShape {\n\tswitch (schema) {\n\t\tcase undefined:\n\t\t\treturn false;\n\t\tcase ValueSchema.Number:\n\t\tcase ValueSchema.String:\n\t\tcase ValueSchema.Boolean:\n\t\tcase ValueSchema.FluidHandle:\n\t\t\treturn true;\n\t\tcase ValueSchema.Null:\n\t\t\treturn [null];\n\t\tdefault:\n\t\t\tunreachableCase(schema);\n\t}\n}\n"]}

package/lib/feature-libraries/node-key/index.d.ts

@@ -1,8 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export { MockNodeKeyManager } from "./mockNodeKeyManager.js";
-export { compareLocalNodeKeys, type LocalNodeKey, type StableNodeKey, nodeKeyTreeIdentifier, } from "./nodeKey.js";
-export { createNodeKeyManager, isStableNodeKey, type NodeKeyManager, } from "./nodeKeyManager.js";
-//# sourceMappingURL=index.d.ts.map

package/lib/feature-libraries/node-key/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EACN,oBAAoB,EACpB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,qBAAqB,GACrB,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,oBAAoB,EACpB,eAAe,EACf,KAAK,cAAc,GACnB,MAAM,qBAAqB,CAAC"}

package/lib/feature-libraries/node-key/index.js

@@ -1,8 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export { MockNodeKeyManager } from "./mockNodeKeyManager.js";
-export { compareLocalNodeKeys, nodeKeyTreeIdentifier, } from "./nodeKey.js";
-export { createNodeKeyManager, isStableNodeKey, } from "./nodeKeyManager.js";
-//# sourceMappingURL=index.js.map

package/lib/feature-libraries/node-key/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EACN,oBAAoB,EAGpB,qBAAqB,GACrB,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,oBAAoB,EACpB,eAAe,GAEf,MAAM,qBAAqB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { MockNodeKeyManager } from \"./mockNodeKeyManager.js\";\nexport {\n\tcompareLocalNodeKeys,\n\ttype LocalNodeKey,\n\ttype StableNodeKey,\n\tnodeKeyTreeIdentifier,\n} from \"./nodeKey.js\";\nexport {\n\tcreateNodeKeyManager,\n\tisStableNodeKey,\n\ttype NodeKeyManager,\n} from \"./nodeKeyManager.js\";\n"]}

package/lib/feature-libraries/node-key/mockNodeKeyManager.d.ts

@@ -1,22 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { StableId } from "@fluidframework/id-compressor";
-import type { LocalNodeKey, StableNodeKey } from "./nodeKey.js";
-import { type NodeKeyManager } from "./nodeKeyManager.js";
-/**
- * Mock {@link NodeKeyManager} that generates deterministic {@link StableNodeKey}s and {@link LocalNodeKey}s.
- * @remarks This is useful for test environments because it will always yield the same keys in the same order.
- * It should not be used for production environments for the same reason; the {@link StableNodeKey}s are not universally unique.
- */
-export declare class MockNodeKeyManager implements NodeKeyManager {
-    private count;
-    generateStableNodeKey(): StableNodeKey;
-    generateLocalNodeKey(): LocalNodeKey;
-    localizeNodeKey(key: StableNodeKey): LocalNodeKey;
-    stabilizeNodeKey(key: LocalNodeKey): StableNodeKey;
-    tryLocalizeNodeKey(key: string): LocalNodeKey | undefined;
-    getId(offset: number): StableId;
-}
-//# sourceMappingURL=mockNodeKeyManager.d.ts.map

package/lib/feature-libraries/node-key/mockNodeKeyManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mockNodeKeyManager.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/mockNodeKeyManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAA4B,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAExF,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAmB,KAAK,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAG3E;;;;GAIG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACxD,OAAO,CAAC,KAAK,CAAK;IAEX,qBAAqB,IAAI,aAAa;IAItC,oBAAoB,IAAI,YAAY;IAIpC,eAAe,CAAC,GAAG,EAAE,aAAa,GAAG,YAAY;IAIjD,gBAAgB,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa;IAIlD,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAUzD,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ;CAOtC"}

package/lib/feature-libraries/node-key/mockNodeKeyManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mockNodeKeyManager.js","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/mockNodeKeyManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAE7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAE1E,OAAO,EAAE,eAAe,EAAuB,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAErE;;;;GAIG;AACH,MAAM,OAAO,kBAAkB;IAA/B;QACS,UAAK,GAAG,CAAC,CAAC;IAmCnB,CAAC;IAjCO,qBAAqB;QAC3B,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACxC,CAAC;IAEM,oBAAoB;QAC1B,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC3D,CAAC;IAEM,eAAe,CAAC,GAAkB;QACxC,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAClF,CAAC;IAEM,gBAAgB,CAAC,GAAiB;QACxC,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC;IAEM,kBAAkB,CAAC,GAAW;QACpC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,0BAA0B,CAAC,EAAE,CAAC;YAC1E,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5D,OAAO,YAAY,GAAG,IAAI,CAAC,KAAK;YAC/B,CAAC,CAAC,KAAK,CAAC,YAAwC,CAAC;YACjD,CAAC,CAAC,SAAS,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,MAAc;QAC1B,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACjE,MAAM,CAAC,MAAM,GAAG,mBAAmB,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACpF,OAAO,gBAAgB,CACtB,2BAA2B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAC9E,CAAC;IACH,CAAC;CACD","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 type { SessionSpaceCompressedId, StableId } from \"@fluidframework/id-compressor\";\nimport { assertIsStableId } from \"@fluidframework/id-compressor/internal\";\nimport type { LocalNodeKey, StableNodeKey } from \"./nodeKey.js\";\nimport { isStableNodeKey, type NodeKeyManager } from \"./nodeKeyManager.js\";\nimport { brand, extractFromOpaque, fail } from \"../../util/index.js\";\n\n/**\n * Mock {@link NodeKeyManager} that generates deterministic {@link StableNodeKey}s and {@link LocalNodeKey}s.\n * @remarks This is useful for test environments because it will always yield the same keys in the same order.\n * It should not be used for production environments for the same reason; the {@link StableNodeKey}s are not universally unique.\n */\nexport class MockNodeKeyManager implements NodeKeyManager {\n\tprivate count = 0;\n\n\tpublic generateStableNodeKey(): StableNodeKey {\n\t\treturn brand(this.getId(this.count++));\n\t}\n\n\tpublic generateLocalNodeKey(): LocalNodeKey {\n\t\treturn this.localizeNodeKey(this.generateStableNodeKey());\n\t}\n\n\tpublic localizeNodeKey(key: StableNodeKey): LocalNodeKey {\n\t\treturn this.tryLocalizeNodeKey(key) ?? fail(0xb26 /* Key is not compressible */);\n\t}\n\n\tpublic stabilizeNodeKey(key: LocalNodeKey): StableNodeKey {\n\t\treturn brand(this.getId(extractFromOpaque(key)));\n\t}\n\n\tpublic tryLocalizeNodeKey(key: string): LocalNodeKey | undefined {\n\t\tif (!isStableNodeKey(key) || !key.startsWith(\"a110ca7e-add1-4000-8000-\")) {\n\t\t\treturn undefined;\n\t\t}\n\t\tconst localNodeKey = Number.parseInt(key.substring(24), 16);\n\t\treturn localNodeKey < this.count\n\t\t\t? brand(localNodeKey as SessionSpaceCompressedId)\n\t\t\t: undefined;\n\t}\n\n\tpublic getId(offset: number): StableId {\n\t\tassert(offset >= 0, 0x6e7 /* UUID offset may not be negative */);\n\t\tassert(offset < 281_474_976_710_656, 0x6e8 /* UUID offset must be at most 16^12 */);\n\t\treturn assertIsStableId(\n\t\t\t`a110ca7e-add1-4000-8000-${Math.round(offset).toString(16).padStart(12, \"0\")}`,\n\t\t);\n\t}\n}\n"]}

package/lib/feature-libraries/node-key/nodeKey.d.ts

@@ -1,38 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { SessionSpaceCompressedId, StableId } from "@fluidframework/id-compressor";
-import type { TreeNodeSchemaIdentifier } from "../../core/index.js";
-import { type Brand, type Opaque } from "../../util/index.js";
-/**
- * A key which uniquely identifies a node in the tree within this session.
- * @remarks {@link LocalNodeKey}s must not be serialized and stored as data without first being converted into a {@link StableNodeKey}.
- * They are local to the current session and equivalent nodes in another session will not necessarily have the same {@link LocalNodeKey}.
- * However, they are otherwise preferential to use over {@link StableNodeKey}s as they are much smaller.
- * For example, they are more efficient than {@link StableNodeKey}s when used as keys in a map.
- * {@link LocalNodeKey}s may be compared or equated via {@link compareLocalNodeKeys}.
- */
-export interface LocalNodeKey extends Opaque<Brand<SessionSpaceCompressedId, "Local Node Key">> {
-}
-/**
- * A UUID which identifies a node in the tree.
- * This key is universally unique and stable forever; therefore it is safe to persist as data in a SharedTree or other DDS/database.
- * When not persisted or serialized, it is preferable to use a {@link LocalNodeKey} instead for better performance.
- */
-export type StableNodeKey = Brand<StableId, "Stable Node Key">;
-/**
- * Compares two {@link LocalNodeKey}s.
- * All {@link LocalNodeKey}s retrieved from a single SharedTree client can be totally ordered using this comparator.
- * @param a - the first key to compare
- * @param b - the second key to compare
- * @returns `0` if `a` and `b` are the same key, otherwise `-1` if `a` is ordered before `b` or `1` if `a` is ordered after `b`.
- */
-export declare function compareLocalNodeKeys(a: LocalNodeKey, b: LocalNodeKey): -1 | 0 | 1;
-/**
- * The TreeNodeSchemaIdentifier for node keys.
- * @privateRemarks TODO: Come up with a unified and collision-resistant naming schema for types defined by the system.
- * For now, we'll use `__` to reduce the change of collision, since this is what other internal properties use in Fluid.
- */
-export declare const nodeKeyTreeIdentifier: TreeNodeSchemaIdentifier;
-//# sourceMappingURL=nodeKey.d.ts.map

package/lib/feature-libraries/node-key/nodeKey.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKey.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/nodeKey.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAExF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,MAAM,EAAS,MAAM,qBAAqB,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,YAChB,SAAQ,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,CAAC;CAAG;AAErE;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;AAE/D;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAEjF;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,EAAE,wBAEnC,CAAC"}

package/lib/feature-libraries/node-key/nodeKey.js

@@ -1,22 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { brand } from "../../util/index.js";
-/**
- * Compares two {@link LocalNodeKey}s.
- * All {@link LocalNodeKey}s retrieved from a single SharedTree client can be totally ordered using this comparator.
- * @param a - the first key to compare
- * @param b - the second key to compare
- * @returns `0` if `a` and `b` are the same key, otherwise `-1` if `a` is ordered before `b` or `1` if `a` is ordered after `b`.
- */
-export function compareLocalNodeKeys(a, b) {
-    return a === b ? 0 : a > b ? 1 : -1;
-}
-/**
- * The TreeNodeSchemaIdentifier for node keys.
- * @privateRemarks TODO: Come up with a unified and collision-resistant naming schema for types defined by the system.
- * For now, we'll use `__` to reduce the change of collision, since this is what other internal properties use in Fluid.
- */
-export const nodeKeyTreeIdentifier = brand("com.fluidframework.nodeKey.NodeKey");
-//# sourceMappingURL=nodeKey.js.map

package/lib/feature-libraries/node-key/nodeKey.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKey.js","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/nodeKey.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAA2B,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAoBrE;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAAC,CAAe,EAAE,CAAe;IACpE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACrC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAA6B,KAAK,CACnE,oCAAoC,CACpC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { SessionSpaceCompressedId, StableId } from \"@fluidframework/id-compressor\";\n\nimport type { TreeNodeSchemaIdentifier } from \"../../core/index.js\";\nimport { type Brand, type Opaque, brand } from \"../../util/index.js\";\n\n/**\n * A key which uniquely identifies a node in the tree within this session.\n * @remarks {@link LocalNodeKey}s must not be serialized and stored as data without first being converted into a {@link StableNodeKey}.\n * They are local to the current session and equivalent nodes in another session will not necessarily have the same {@link LocalNodeKey}.\n * However, they are otherwise preferential to use over {@link StableNodeKey}s as they are much smaller.\n * For example, they are more efficient than {@link StableNodeKey}s when used as keys in a map.\n * {@link LocalNodeKey}s may be compared or equated via {@link compareLocalNodeKeys}.\n */\nexport interface LocalNodeKey\n\textends Opaque<Brand<SessionSpaceCompressedId, \"Local Node Key\">> {}\n\n/**\n * A UUID which identifies a node in the tree.\n * This key is universally unique and stable forever; therefore it is safe to persist as data in a SharedTree or other DDS/database.\n * When not persisted or serialized, it is preferable to use a {@link LocalNodeKey} instead for better performance.\n */\nexport type StableNodeKey = Brand<StableId, \"Stable Node Key\">;\n\n/**\n * Compares two {@link LocalNodeKey}s.\n * All {@link LocalNodeKey}s retrieved from a single SharedTree client can be totally ordered using this comparator.\n * @param a - the first key to compare\n * @param b - the second key to compare\n * @returns `0` if `a` and `b` are the same key, otherwise `-1` if `a` is ordered before `b` or `1` if `a` is ordered after `b`.\n */\nexport function compareLocalNodeKeys(a: LocalNodeKey, b: LocalNodeKey): -1 | 0 | 1 {\n\treturn a === b ? 0 : a > b ? 1 : -1;\n}\n\n/**\n * The TreeNodeSchemaIdentifier for node keys.\n * @privateRemarks TODO: Come up with a unified and collision-resistant naming schema for types defined by the system.\n * For now, we'll use `__` to reduce the change of collision, since this is what other internal properties use in Fluid.\n */\nexport const nodeKeyTreeIdentifier: TreeNodeSchemaIdentifier = brand(\n\t\"com.fluidframework.nodeKey.NodeKey\",\n);\n"]}