@fluidframework/tree 2.74.0-370705 → 2.80.0

package/lib/feature-libraries/optional-field/optionalFieldCodecV3.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"optionalFieldCodecV3.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/optional-field/optionalFieldCodecV3.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,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,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,iBAAiB,EAAW,MAAM,+BAA+B,CAAC;AAEhF,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,CA0DA"}

package/lib/feature-libraries/optional-field/optionalFieldCodecV3.js

@@ -1,53 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { makeChangeAtomIdCodec } from "../changeAtomIdCodec.js";
-import { EncodedNodeChangeset, } from "../modular-schema/index.js";
-import { EncodedOptionalChangeset } from "./optionalFieldChangeFormatV3.js";
-export function makeOptionalFieldCodec(revisionTagCodec) {
-    const changeAtomIdCodec = makeChangeAtomIdCodec(revisionTagCodec);
-    return {
-        encode: (change, context) => {
-            const encoded = {};
-            if (change.valueReplace !== undefined) {
-                encoded.r = {
-                    e: change.valueReplace.isEmpty,
-                    d: changeAtomIdCodec.encode(change.valueReplace.dst, context.baseContext),
-                };
-                if (change.valueReplace.src !== undefined) {
-                    encoded.r.s = changeAtomIdCodec.encode(change.valueReplace.src, context.baseContext);
-                }
-            }
-            if (change.nodeDetach !== undefined) {
-                encoded.d = changeAtomIdCodec.encode(change.nodeDetach, context.baseContext);
-            }
-            if (change.childChange !== undefined) {
-                encoded.c = context.encodeNode(change.childChange);
-            }
-            return encoded;
-        },
-        decode: (encoded, context) => {
-            const decoded = {};
-            if (encoded.r !== undefined) {
-                const replace = {
-                    isEmpty: encoded.r.e,
-                    dst: changeAtomIdCodec.decode(encoded.r.d, context.baseContext),
-                };
-                if (encoded.r.s !== undefined) {
-                    replace.src = changeAtomIdCodec.decode(encoded.r.s, context.baseContext);
-                }
-                decoded.valueReplace = replace;
-            }
-            if (encoded.d !== undefined) {
-                decoded.nodeDetach = changeAtomIdCodec.decode(encoded.d, context.baseContext);
-            }
-            if (encoded.c !== undefined) {
-                decoded.childChange = context.decodeNode(encoded.c);
-            }
-            return decoded;
-        },
-        encodedSchema: EncodedOptionalChangeset(EncodedNodeChangeset),
-    };
-}
-//# sourceMappingURL=optionalFieldCodecV3.js.map

package/lib/feature-libraries/optional-field/optionalFieldCodecV3.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"optionalFieldCodecV3.js","sourceRoot":"","sources":["../../../src/feature-libraries/optional-field/optionalFieldCodecV3.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAWH,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EACN,oBAAoB,GAEpB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAG5E,MAAM,UAAU,sBAAsB,CACrC,gBAKC;IAOD,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;IAElE,OAAO;QACN,MAAM,EAAE,CAAC,MAAyB,EAAE,OAAmC,EAAE,EAAE;YAC1E,MAAM,OAAO,GAAyC,EAAE,CAAC;YAEzD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;gBACvC,OAAO,CAAC,CAAC,GAAG;oBACX,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC,OAAO;oBAC9B,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC;iBACzE,CAAC;gBAEF,IAAI,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;oBAC3C,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;gBACtF,CAAC;YACF,CAAC;YAED,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBACrC,OAAO,CAAC,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;YAC9E,CAAC;YAED,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACtC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YACpD,CAAC;YAED,OAAO,OAAO,CAAC;QAChB,CAAC;QAED,MAAM,EAAE,CACP,OAA6C,EAC7C,OAAmC,EAClC,EAAE;YACH,MAAM,OAAO,GAA+B,EAAE,CAAC;YAE/C,IAAI,OAAO,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAqB;oBACjC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;oBACpB,GAAG,EAAE,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;iBAC/D,CAAC;gBACF,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;oBAC/B,OAAO,CAAC,GAAG,GAAG,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;gBAC1E,CAAC;gBACD,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC;YAChC,CAAC;YAED,IAAI,OAAO,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC7B,OAAO,CAAC,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;YAC/E,CAAC;YAED,IAAI,OAAO,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC7B,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACrD,CAAC;YAED,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,aAAa,EAAE,wBAAwB,CAAC,oBAAoB,CAAC;KAC7D,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TAnySchema } from \"@sinclair/typebox\";\n\nimport type { IJsonCodec } from \"../../codec/index.js\";\nimport type {\n\tChangeEncodingContext,\n\tEncodedRevisionTag,\n\tRevisionTag,\n} from \"../../core/index.js\";\nimport type { Mutable } from \"../../util/index.js\";\nimport { makeChangeAtomIdCodec } from \"../changeAtomIdCodec.js\";\nimport {\n\tEncodedNodeChangeset,\n\ttype FieldChangeEncodingContext,\n} from \"../modular-schema/index.js\";\n\nimport { EncodedOptionalChangeset } from \"./optionalFieldChangeFormatV3.js\";\nimport type { OptionalChangeset, Replace } from \"./optionalFieldChangeTypes.js\";\n\nexport function makeOptionalFieldCodec(\n\trevisionTagCodec: IJsonCodec<\n\t\tRevisionTag,\n\t\tEncodedRevisionTag,\n\t\tEncodedRevisionTag,\n\t\tChangeEncodingContext\n\t>,\n): IJsonCodec<\n\tOptionalChangeset,\n\tEncodedOptionalChangeset<TAnySchema>,\n\tEncodedOptionalChangeset<TAnySchema>,\n\tFieldChangeEncodingContext\n> {\n\tconst changeAtomIdCodec = makeChangeAtomIdCodec(revisionTagCodec);\n\n\treturn {\n\t\tencode: (change: OptionalChangeset, context: FieldChangeEncodingContext) => {\n\t\t\tconst encoded: EncodedOptionalChangeset<TAnySchema> = {};\n\n\t\t\tif (change.valueReplace !== undefined) {\n\t\t\t\tencoded.r = {\n\t\t\t\t\te: change.valueReplace.isEmpty,\n\t\t\t\t\td: changeAtomIdCodec.encode(change.valueReplace.dst, context.baseContext),\n\t\t\t\t};\n\n\t\t\t\tif (change.valueReplace.src !== undefined) {\n\t\t\t\t\tencoded.r.s = changeAtomIdCodec.encode(change.valueReplace.src, context.baseContext);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (change.nodeDetach !== undefined) {\n\t\t\t\tencoded.d = changeAtomIdCodec.encode(change.nodeDetach, context.baseContext);\n\t\t\t}\n\n\t\t\tif (change.childChange !== undefined) {\n\t\t\t\tencoded.c = context.encodeNode(change.childChange);\n\t\t\t}\n\n\t\t\treturn encoded;\n\t\t},\n\n\t\tdecode: (\n\t\t\tencoded: EncodedOptionalChangeset<TAnySchema>,\n\t\t\tcontext: FieldChangeEncodingContext,\n\t\t) => {\n\t\t\tconst decoded: Mutable<OptionalChangeset> = {};\n\n\t\t\tif (encoded.r !== undefined) {\n\t\t\t\tconst replace: Mutable<Replace> = {\n\t\t\t\t\tisEmpty: encoded.r.e,\n\t\t\t\t\tdst: changeAtomIdCodec.decode(encoded.r.d, context.baseContext),\n\t\t\t\t};\n\t\t\t\tif (encoded.r.s !== undefined) {\n\t\t\t\t\treplace.src = changeAtomIdCodec.decode(encoded.r.s, context.baseContext);\n\t\t\t\t}\n\t\t\t\tdecoded.valueReplace = replace;\n\t\t\t}\n\n\t\t\tif (encoded.d !== undefined) {\n\t\t\t\tdecoded.nodeDetach = changeAtomIdCodec.decode(encoded.d, context.baseContext);\n\t\t\t}\n\n\t\t\tif (encoded.c !== undefined) {\n\t\t\t\tdecoded.childChange = context.decodeNode(encoded.c);\n\t\t\t}\n\n\t\t\treturn decoded;\n\t\t},\n\t\tencodedSchema: EncodedOptionalChangeset(EncodedNodeChangeset),\n\t};\n}\n"]}

package/src/feature-libraries/default-schema/locationBasedEditBuilder.ts

@@ -1,180 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { UsageError } from "@fluidframework/telemetry-utils/internal";
-import {
-	type ChangeAtomId,
-	type FieldKey,
-	type FieldUpPath,
-	type UpPath,
-	type TreeChunk,
-	type NormalizedUpPath,
-	type NormalizedFieldUpPath,
-	rootFieldKey,
-	makeDetachedNodeId,
-} from "../../core/index.js";
-
-import type {
-	DetachedRootIds,
-	DataEditor,
-	OptionalFieldEditor,
-	RequiredFieldEditor,
-	SequenceFieldEditor,
-} from "./defaultEditBuilder.js";
-
-export type DetachedRootLocation = FieldKey;
-export type DetachedRootsLocation = readonly DetachedRootRangeLocation[];
-export interface DetachedRootRangeLocation {
-	readonly field: FieldKey;
-	readonly count: number;
-}
-
-export interface Locator {
-	locationFromId(id: ChangeAtomId): DetachedRootLocation;
-	idFromLocation(id: DetachedRootLocation): ChangeAtomId;
-	locationsFromIdRanges(id: DetachedRootIds): DetachedRootsLocation;
-	idRangesFromLocations(id: DetachedRootsLocation): DetachedRootIds;
-}
-
-export type ILocationBasedDataEditor = DataEditor<
-	TreeChunk,
-	DetachedRootLocation,
-	DetachedRootsLocation
->;
-
-/**
- * Implementation of {@link DataEditor} based on the default set of supported field kinds.
- * @sealed
- */
-export class LocationBasedDataEditor
-	implements DataEditor<TreeChunk, DetachedRootLocation, DetachedRootsLocation>
-{
-	public constructor(
-		private readonly idBasedEditor: DataEditor<TreeChunk, ChangeAtomId, DetachedRootIds>,
-		private readonly locator: Locator,
-	) {}
-
-	public addNodeExistsConstraint(path: UpPath): void {
-		const normal = normalizeUpPath(path, this.locator);
-		this.idBasedEditor.addNodeExistsConstraint(normal);
-	}
-
-	public addNodeExistsConstraintOnRevert(path: UpPath): void {
-		const normal = normalizeUpPath(path, this.locator);
-		this.idBasedEditor.addNodeExistsConstraintOnRevert(normal);
-	}
-
-	public buildRoots(content: TreeChunk): DetachedRootsLocation {
-		const roots = this.idBasedEditor.buildRoots(content);
-		const locations = this.locator.locationsFromIdRanges(roots);
-		return locations;
-	}
-
-	public valueField(field: FieldUpPath): RequiredFieldEditor<TreeChunk, DetachedRootLocation> {
-		const normal = normalizeFieldUpPath(field, this.locator);
-		const lowLevelEditor = this.idBasedEditor.valueField(normal);
-		const locator = this.locator;
-		const editBuilder = {
-			set: (newContent: TreeChunk): void => {
-				lowLevelEditor.set(newContent);
-			},
-			attach: (newContent: DetachedRootLocation): void => {
-				const changeAtom = locator.idFromLocation(newContent);
-				lowLevelEditor.attach(changeAtom);
-			},
-		};
-		return editBuilder;
-	}
-
-	public optionalField(
-		field: FieldUpPath,
-	): OptionalFieldEditor<TreeChunk, DetachedRootLocation> {
-		const normal = normalizeFieldUpPath(field, this.locator);
-		const lowLevelEditor = this.idBasedEditor.optionalField(normal);
-		const locator = this.locator;
-		const editBuilder = {
-			set: (newContent: TreeChunk | undefined, wasEmpty: boolean): void => {
-				lowLevelEditor.set(newContent, wasEmpty);
-			},
-			attach: (newContent: DetachedRootLocation | undefined, wasEmpty: boolean): void => {
-				if (newContent === undefined) {
-					editBuilder.clear(wasEmpty);
-					return;
-				}
-				const changeAtom = locator.idFromLocation(newContent);
-				lowLevelEditor.attach(changeAtom, wasEmpty);
-			},
-			clear: (wasEmpty: boolean): void => {
-				lowLevelEditor.clear(wasEmpty);
-			},
-		};
-		return editBuilder;
-	}
-
-	public move(
-		sourceField: FieldUpPath,
-		sourceIndex: number,
-		count: number,
-		destinationField: FieldUpPath,
-		destIndex: number,
-	): void {
-		const normalSource = normalizeFieldUpPath(sourceField, this.locator);
-		const normalDestination = normalizeFieldUpPath(destinationField, this.locator);
-		this.idBasedEditor.move(normalSource, sourceIndex, count, normalDestination, destIndex);
-	}
-
-	public sequenceField(
-		field: FieldUpPath,
-	): SequenceFieldEditor<TreeChunk, DetachedRootsLocation> {
-		const normal = normalizeFieldUpPath(field, this.locator);
-		const lowLevelEditor = this.idBasedEditor.sequenceField(normal);
-		const locator = this.locator;
-		const editBuilder = {
-			insert: (index: number, content: TreeChunk): void => {
-				lowLevelEditor.insert(index, content);
-			},
-			attach: (index: number, newContent: DetachedRootsLocation): void => {
-				const range = locator.idRangesFromLocations(newContent);
-				lowLevelEditor.attach(index, range);
-			},
-			remove: (index: number, count: number): void => {
-				lowLevelEditor.remove(index, count);
-			},
-		};
-		return editBuilder;
-	}
-}
-
-function normalizeUpPath(path: UpPath, locator: Locator): NormalizedUpPath {
-	if (path.parent === undefined) {
-		if (path.parentField === rootFieldKey) {
-			return { ...path, parent: undefined, detachedNodeId: undefined };
-		} else {
-			const nodeId = locator.idFromLocation(path.parentField);
-			const detachedNodeId = makeDetachedNodeId(nodeId.revision, nodeId.localId);
-			return { ...path, parent: undefined, detachedNodeId };
-		}
-	} else {
-		return {
-			parent: normalizeUpPath(path.parent, locator),
-			parentField: path.parentField,
-			parentIndex: path.parentIndex,
-		};
-	}
-}
-
-function normalizeFieldUpPath(path: FieldUpPath, locator: Locator): NormalizedFieldUpPath {
-	if (path.parent === undefined) {
-		if (path.field === rootFieldKey) {
-			return { parent: undefined, field: rootFieldKey };
-		} else {
-			throw new UsageError(
-				"Editing only allowed on the root field or on fields under nodes with TreeStatus.InDocument or TreeStatus.Removed status",
-			);
-		}
-	} else {
-		return { parent: normalizeUpPath(path.parent, locator), field: path.field };
-	}
-}

package/src/feature-libraries/optional-field/optionalFieldChangeFormatV3.ts

@@ -1,45 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { type ObjectOptions, type Static, type TSchema, Type } from "@sinclair/typebox";
-
-import { EncodedChangeAtomId } from "../modular-schema/index.js";
-
-const noAdditionalProps: ObjectOptions = { additionalProperties: false };
-
-// Type is intentionally derived.
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export const EncodedOptionalChangeset = <Schema extends TSchema>(tNodeChange: Schema) =>
-	Type.Object(
-		{
-			// Nested changes
-			c: Type.Optional(tNodeChange),
-
-			// How to replace the current value of the field.
-			r: Type.Optional(EncodedReplace),
-
-			// Node detach
-			d: Type.Optional(EncodedChangeAtomId),
-		},
-		noAdditionalProps,
-	);
-
-export type EncodedOptionalChangeset<Schema extends TSchema> = Static<
-	ReturnType<typeof EncodedOptionalChangeset<Schema>>
->;
-
-const EncodedReplace = Type.Object(
-	{
-		// Whether the field is empty in the input context of this change.
-		e: Type.Boolean(),
-		// The ID for the node to put in this field, or undefined if the field should be emptied.
-		// Will be "self" when the intention is to keep the current node in this field.
-		s: Type.Optional(EncodedChangeAtomId),
-		// An ID to associate with the node (if any) which is detached by this edit.
-		d: EncodedChangeAtomId,
-	},
-	noAdditionalProps,
-);
-export type EncodedReplace = Static<typeof EncodedReplace>;

package/src/feature-libraries/optional-field/optionalFieldCodecV3.ts

@@ -1,94 +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 { Mutable } from "../../util/index.js";
-import { makeChangeAtomIdCodec } from "../changeAtomIdCodec.js";
-import {
-	EncodedNodeChangeset,
-	type FieldChangeEncodingContext,
-} from "../modular-schema/index.js";
-
-import { EncodedOptionalChangeset } from "./optionalFieldChangeFormatV3.js";
-import type { OptionalChangeset, Replace } from "./optionalFieldChangeTypes.js";
-
-export function makeOptionalFieldCodec(
-	revisionTagCodec: IJsonCodec<
-		RevisionTag,
-		EncodedRevisionTag,
-		EncodedRevisionTag,
-		ChangeEncodingContext
-	>,
-): IJsonCodec<
-	OptionalChangeset,
-	EncodedOptionalChangeset<TAnySchema>,
-	EncodedOptionalChangeset<TAnySchema>,
-	FieldChangeEncodingContext
-> {
-	const changeAtomIdCodec = makeChangeAtomIdCodec(revisionTagCodec);
-
-	return {
-		encode: (change: OptionalChangeset, context: FieldChangeEncodingContext) => {
-			const encoded: EncodedOptionalChangeset<TAnySchema> = {};
-
-			if (change.valueReplace !== undefined) {
-				encoded.r = {
-					e: change.valueReplace.isEmpty,
-					d: changeAtomIdCodec.encode(change.valueReplace.dst, context.baseContext),
-				};
-
-				if (change.valueReplace.src !== undefined) {
-					encoded.r.s = changeAtomIdCodec.encode(change.valueReplace.src, context.baseContext);
-				}
-			}
-
-			if (change.nodeDetach !== undefined) {
-				encoded.d = changeAtomIdCodec.encode(change.nodeDetach, context.baseContext);
-			}
-
-			if (change.childChange !== undefined) {
-				encoded.c = context.encodeNode(change.childChange);
-			}
-
-			return encoded;
-		},
-
-		decode: (
-			encoded: EncodedOptionalChangeset<TAnySchema>,
-			context: FieldChangeEncodingContext,
-		) => {
-			const decoded: Mutable<OptionalChangeset> = {};
-
-			if (encoded.r !== undefined) {
-				const replace: Mutable<Replace> = {
-					isEmpty: encoded.r.e,
-					dst: changeAtomIdCodec.decode(encoded.r.d, context.baseContext),
-				};
-				if (encoded.r.s !== undefined) {
-					replace.src = changeAtomIdCodec.decode(encoded.r.s, context.baseContext);
-				}
-				decoded.valueReplace = replace;
-			}
-
-			if (encoded.d !== undefined) {
-				decoded.nodeDetach = changeAtomIdCodec.decode(encoded.d, context.baseContext);
-			}
-
-			if (encoded.c !== undefined) {
-				decoded.childChange = context.decodeNode(encoded.c);
-			}
-
-			return decoded;
-		},
-		encodedSchema: EncodedOptionalChangeset(EncodedNodeChangeset),
-	};
-}