@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/shared-tree-core/messageTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageTypes.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/messageTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEjD,MAAM,WAAW,cAAc,CAAC,OAAO;IACtC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7B,SAAS,EAAE,SAAS,CAAC;CACrB"}

package/dist/shared-tree-core/messageTypes.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=messageTypes.js.map

package/dist/shared-tree-core/messageTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageTypes.js","sourceRoot":"","sources":["../../src/shared-tree-core/messageTypes.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { GraphCommit, SessionId } from \"../core\";\n\nexport interface DecodedMessage<TChange> {\n\tcommit: GraphCommit<TChange>;\n\tsessionId: SessionId;\n}\n"]}

package/dist/shared-tree-core/revisionTagCodecs.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IJsonCodec } from "../codec";
+import { EncodedRevisionTag, RevisionTag } from "../core";
+export declare class RevisionTagCodec implements IJsonCodec<RevisionTag, EncodedRevisionTag> {
+    encode(tag: RevisionTag): EncodedRevisionTag;
+    decode(tag: EncodedRevisionTag): import("@fluidframework/id-compressor").StableId;
+}
+//# sourceMappingURL=revisionTagCodecs.d.ts.map

package/dist/shared-tree-core/revisionTagCodecs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"revisionTagCodecs.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/revisionTagCodecs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE1D,qBAAa,gBAAiB,YAAW,UAAU,CAAC,WAAW,EAAE,kBAAkB,CAAC;IAC5E,MAAM,CAAC,GAAG,EAAE,WAAW;IAGvB,MAAM,CAAC,GAAG,EAAE,kBAAkB;CAGrC"}

package/dist/shared-tree-core/revisionTagCodecs.js

@@ -0,0 +1,17 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RevisionTagCodec = void 0;
+class RevisionTagCodec {
+    encode(tag) {
+        return tag;
+    }
+    decode(tag) {
+        return tag;
+    }
+}
+exports.RevisionTagCodec = RevisionTagCodec;
+//# sourceMappingURL=revisionTagCodecs.js.map

package/dist/shared-tree-core/revisionTagCodecs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"revisionTagCodecs.js","sourceRoot":"","sources":["../../src/shared-tree-core/revisionTagCodecs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,MAAa,gBAAgB;IACrB,MAAM,CAAC,GAAgB;QAC7B,OAAO,GAAoC,CAAC;IAC7C,CAAC;IACM,MAAM,CAAC,GAAuB;QACpC,OAAO,GAA6B,CAAC;IACtC,CAAC;CACD;AAPD,4CAOC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IJsonCodec } from \"../codec\";\nimport { EncodedRevisionTag, RevisionTag } from \"../core\";\n\nexport class RevisionTagCodec implements IJsonCodec<RevisionTag, EncodedRevisionTag> {\n\tpublic encode(tag: RevisionTag) {\n\t\treturn tag as unknown as EncodedRevisionTag;\n\t}\n\tpublic decode(tag: EncodedRevisionTag) {\n\t\treturn tag as unknown as RevisionTag;\n\t}\n}\n"]}

package/dist/shared-tree-core/sharedTreeCore.d.ts

@@ -0,0 +1,112 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { ITelemetryContext, ISummaryTreeWithStats, IGarbageCollectionData, IExperimentalIncrementalSummaryContext } from "@fluidframework/runtime-definitions";
+import { IFluidSerializer, SharedObject } from "@fluidframework/shared-object-base";
+import { ICodecOptions } from "../codec";
+import { ChangeFamily, ChangeFamilyEditor } from "../core";
+import { JsonCompatibleReadOnly } from "../util";
+import { SharedTreeBranch } from "./branch";
+/**
+ * Generic shared tree, which needs to be configured with indexes, field kinds and a history policy to be used.
+ *
+ * TODO: actually implement
+ * TODO: is history policy a detail of what indexes are used, or is there something else to it?
+ */
+export declare class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange> extends SharedObject {
+    private readonly editManager;
+    private readonly summarizables;
+    /** Iff false, calls to `submitOp` will have no effect */
+    private submitOps;
+    /**
+     * The sequence number that this instance is at.
+     * This is number is artificial in that it is made up by this instance as opposed to being provided by the runtime.
+     * Is `undefined` after (and only after) this instance is attached.
+     */
+    private detachedRevision;
+    /**
+     * Used to edit the state of the tree. Edits will be immediately applied locally to the tree.
+     * If there is no transaction currently ongoing, then the edits will be submitted to Fluid immediately as well.
+     */
+    get editor(): TEditor;
+    /**
+     * Used to encode/decode messages sent to/received from the Fluid runtime.
+     *
+     * @remarks Since there is currently only one format, this can just be cached on the class.
+     * With more write formats active, it may make sense to keep around the "usual" format codec
+     * (the one for the current persisted configuration) and resolve codecs for different versions
+     * as necessary (e.g. an upgrade op came in, or the configuration changed within the collab window
+     * and an op needs to be interpreted which isn't written with the current configuration).
+     */
+    private readonly messageCodec;
+    /**
+     * @param summarizables - Summarizers for all indexes used by this tree
+     * @param changeFamily - The change family
+     * @param editManager - The edit manager
+     * @param id - The id of the shared object
+     * @param runtime - The IFluidDataStoreRuntime which contains the shared object
+     * @param attributes - Attributes of the shared object
+     * @param telemetryContextPrefix - the context for any telemetry logs/errors emitted
+     */
+    constructor(summarizables: readonly Summarizable[], changeFamily: ChangeFamily<TEditor, TChange>, options: ICodecOptions, id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, telemetryContextPrefix: string);
+    protected summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): ISummaryTreeWithStats;
+    protected loadCore(services: IChannelStorageService): Promise<void>;
+    /**
+     * Submits an op to the Fluid runtime containing the given commit
+     * @param commit - the commit to submit
+     */
+    private submitCommit;
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    /**
+     * @returns the head commit of the root local branch
+     */
+    protected getLocalBranch(): SharedTreeBranch<TEditor, TChange>;
+    protected onDisconnect(): void;
+    protected didAttach(): void;
+    protected reSubmitCore(content: JsonCompatibleReadOnly, localOpMetadata: unknown): void;
+    protected applyStashedOp(content: JsonCompatibleReadOnly): undefined;
+    getGCData(fullGC?: boolean): IGarbageCollectionData;
+}
+/**
+ * Specifies the behavior of a component that puts data in a summary.
+ */
+export interface Summarizable {
+    /**
+     * Field name in summary json under which this element stores its data.
+     */
+    readonly key: string;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
+     * @param stringify - Serializes the contents of the component (including {@link IFluidHandle}s) for storage.
+     */
+    getAttachSummary(stringify: SummaryElementStringifier, fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): ISummaryTreeWithStats;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
+     * @param stringify - Serializes the contents of the component (including {@link IFluidHandle}s) for storage.
+     */
+    summarize(stringify: SummaryElementStringifier, fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
+    /**
+     * {@inheritDoc (ISharedObject:interface).getGCData}
+     */
+    getGCData(fullGC?: boolean): IGarbageCollectionData;
+    /**
+     * Allows the component to perform custom loading. The storage service is scoped to this component and therefore
+     * paths in this component will not collide with those in other components, even if they are the same string.
+     * @param service - Storage used by the component
+     * @param parse - Parses serialized data from storage into runtime objects for the component
+     */
+    load(service: IChannelStorageService, parse: SummaryElementParser): Promise<void>;
+}
+/**
+ * Serializes the given contents into a string acceptable for storing in summaries, i.e. all
+ * Fluid handles have been replaced appropriately by an IFluidSerializer
+ */
+export type SummaryElementStringifier = (contents: unknown) => string;
+/**
+ * Parses a serialized/summarized string into an object, rehydrating any Fluid handles as necessary
+ */
+export type SummaryElementParser = (contents: string) => unknown;
+//# sourceMappingURL=sharedTreeCore.d.ts.map

package/dist/shared-tree-core/sharedTreeCore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedTreeCore.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/sharedTreeCore.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACN,iBAAiB,EACjB,qBAAqB,EACrB,sBAAsB,EACtB,sCAAsC,EACtC,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,EAAE,aAAa,EAAc,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAe,MAAM,SAAS,CAAC;AACxE,OAAO,EAAS,sBAAsB,EAAoB,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAwB,MAAM,UAAU,CAAC;AAalE;;;;;GAKG;AACH,qBAAa,cAAc,CAAC,OAAO,SAAS,kBAAkB,EAAE,OAAO,CAAE,SAAQ,YAAY;IAC5F,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAgE;IAC5F,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA0B;IAExD,yDAAyD;IACzD,OAAO,CAAC,SAAS,CAAQ;IAEzB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB,CAAwD;IAEhF;;;OAGG;IACH,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA+C;IAE5E;;;;;;;;OAQG;gBAEF,aAAa,EAAE,SAAS,YAAY,EAAE,EACtC,YAAY,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,EAC5C,OAAO,EAAE,aAAa,EAEtB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,sBAAsB,EAAE,MAAM;IAqD/B,SAAS,CAAC,aAAa,CACtB,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,qBAAqB;cAqBR,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAWzE;;;OAGG;IACH,OAAO,CAAC,YAAY;IA8BpB,SAAS,CAAC,WAAW,CACpB,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;IAazB;;OAEG;IACH,SAAS,CAAC,cAAc,IAAI,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC;IAI9D,SAAS,CAAC,YAAY;cAEH,SAAS,IAAI,IAAI;cAMjB,YAAY,CAAC,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAE,OAAO;IAQzF,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,sBAAsB,GAAG,SAAS;IAcpD,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;CAenE;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,gBAAgB,CACf,SAAS,EAAE,yBAAyB,EACpC,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,qBAAqB,CAAC;IAEzB;;;OAGG;IACH,SAAS,CACR,SAAS,EAAE,yBAAyB,EACpC,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;OAEG;IAGH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IAEpD;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,sBAAsB,EAAE,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClF;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,QAAQ,EAAE,OAAO,KAAK,MAAM,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC"}

package/dist/shared-tree-core/sharedTreeCore.js

@@ -0,0 +1,197 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharedTreeCore = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const runtime_utils_1 = require("@fluidframework/runtime-utils");
+const shared_object_base_1 = require("@fluidframework/shared-object-base");
+const util_1 = require("../util");
+const branch_1 = require("./branch");
+const editManagerSummarizer_1 = require("./editManagerSummarizer");
+const editManager_1 = require("./editManager");
+const messageCodecs_1 = require("./messageCodecs");
+const revisionTagCodecs_1 = require("./revisionTagCodecs");
+// TODO: How should the format version be determined?
+const formatVersion = 0;
+// TODO: Organize this to be adjacent to persisted types.
+const summarizablesTreeKey = "indexes";
+/**
+ * Generic shared tree, which needs to be configured with indexes, field kinds and a history policy to be used.
+ *
+ * TODO: actually implement
+ * TODO: is history policy a detail of what indexes are used, or is there something else to it?
+ */
+class SharedTreeCore extends shared_object_base_1.SharedObject {
+    /**
+     * Used to edit the state of the tree. Edits will be immediately applied locally to the tree.
+     * If there is no transaction currently ongoing, then the edits will be submitted to Fluid immediately as well.
+     */
+    get editor() {
+        return this.getLocalBranch().editor;
+    }
+    /**
+     * @param summarizables - Summarizers for all indexes used by this tree
+     * @param changeFamily - The change family
+     * @param editManager - The edit manager
+     * @param id - The id of the shared object
+     * @param runtime - The IFluidDataStoreRuntime which contains the shared object
+     * @param attributes - Attributes of the shared object
+     * @param telemetryContextPrefix - the context for any telemetry logs/errors emitted
+     */
+    constructor(summarizables, changeFamily, options, 
+    // Base class arguments
+    id, runtime, attributes, telemetryContextPrefix) {
+        super(id, runtime, attributes, telemetryContextPrefix);
+        /** Iff false, calls to `submitOp` will have no effect */
+        this.submitOps = true;
+        /**
+         * The sequence number that this instance is at.
+         * This is number is artificial in that it is made up by this instance as opposed to being provided by the runtime.
+         * Is `undefined` after (and only after) this instance is attached.
+         */
+        this.detachedRevision = editManager_1.minimumPossibleSequenceNumber;
+        /**
+         * A random ID that uniquely identifies this client in the collab session.
+         * This is sent alongside every op to identify which client the op originated from.
+         * This is used rather than the Fluid client ID because the Fluid client ID is not stable across reconnections.
+         */
+        // TODO: Change this type to be the Session ID type provided by the IdCompressor when available.
+        const localSessionId = (0, util_1.generateStableId)();
+        this.editManager = new editManager_1.EditManager(changeFamily, localSessionId);
+        this.editManager.localBranch.on("afterChange", (args) => {
+            const { type } = args;
+            switch (type) {
+                case "append":
+                    for (const c of args.newCommits) {
+                        if (!this.getLocalBranch().isTransacting()) {
+                            this.submitCommit(c);
+                        }
+                    }
+                    break;
+                case "replace":
+                    if ((0, branch_1.getChangeReplaceType)(args) === "transactionCommit") {
+                        if (!this.getLocalBranch().isTransacting()) {
+                            this.submitCommit(args.newCommits[0]);
+                        }
+                    }
+                    break;
+                default:
+                    break;
+            }
+        });
+        const revisionTagCodec = new revisionTagCodecs_1.RevisionTagCodec();
+        this.summarizables = [
+            new editManagerSummarizer_1.EditManagerSummarizer(this.editManager, revisionTagCodec, options),
+            ...summarizables,
+        ];
+        (0, core_utils_1.assert)(new Set(this.summarizables.map((e) => e.key)).size === this.summarizables.length, 0x350 /* Index summary element keys must be unique */);
+        this.messageCodec = (0, messageCodecs_1.makeMessageCodec)(changeFamily.codecs.resolve(formatVersion).json, new revisionTagCodecs_1.RevisionTagCodec(), options);
+    }
+    // TODO: SharedObject's merging of the two summary methods into summarizeCore is not what we want here:
+    // We might want to not subclass it, or override/reimplement most of its functionality.
+    summarizeCore(serializer, telemetryContext, incrementalSummaryContext) {
+        const builder = new runtime_utils_1.SummaryTreeBuilder();
+        const summarizableBuilder = new runtime_utils_1.SummaryTreeBuilder();
+        // Merge the summaries of all summarizables together under a single ISummaryTree
+        for (const s of this.summarizables) {
+            summarizableBuilder.addWithStats(s.key, s.getAttachSummary((contents) => serializer.stringify(contents, this.handle), undefined, undefined, telemetryContext, incrementalSummaryContext));
+        }
+        builder.addWithStats(summarizablesTreeKey, summarizableBuilder.getSummaryTree());
+        return builder.getSummaryTree();
+    }
+    async loadCore(services) {
+        const loadSummaries = this.summarizables.map(async (summaryElement) => summaryElement.load(scopeStorageService(services, summarizablesTreeKey, summaryElement.key), (contents) => this.serializer.parse(contents)));
+        await Promise.all(loadSummaries);
+    }
+    /**
+     * Submits an op to the Fluid runtime containing the given commit
+     * @param commit - the commit to submit
+     */
+    submitCommit(commit) {
+        if (!this.submitOps) {
+            return;
+        }
+        // Edits should not be submitted until all transactions finish
+        (0, core_utils_1.assert)(!this.getLocalBranch().isTransacting(), 0x68b /* Unexpected edit submitted during transaction */);
+        // Edits submitted before the first attach are treated as sequenced because they will be included
+        // in the attach summary that is uploaded to the service.
+        // Until this attach workflow happens, this instance essentially behaves as a centralized data structure.
+        if (this.detachedRevision !== undefined) {
+            const newRevision = (0, util_1.brand)(this.detachedRevision + 1);
+            this.detachedRevision = newRevision;
+            this.editManager.addSequencedChange({ ...commit, sessionId: this.editManager.localSessionId }, newRevision, this.detachedRevision);
+        }
+        const message = this.messageCodec.encode({
+            commit,
+            sessionId: this.editManager.localSessionId,
+        });
+        this.submitLocalMessage(this.serializer.encode(message, this.handle));
+    }
+    processCore(message, local, localOpMetadata) {
+        const contents = this.serializer.decode(message.contents);
+        const { commit, sessionId } = this.messageCodec.decode(contents);
+        this.editManager.addSequencedChange({ ...commit, sessionId }, (0, util_1.brand)(message.sequenceNumber), (0, util_1.brand)(message.referenceSequenceNumber));
+        this.editManager.advanceMinimumSequenceNumber((0, util_1.brand)(message.minimumSequenceNumber));
+    }
+    /**
+     * @returns the head commit of the root local branch
+     */
+    getLocalBranch() {
+        return this.editManager.localBranch;
+    }
+    onDisconnect() { }
+    didAttach() {
+        if (this.detachedRevision !== undefined) {
+            this.detachedRevision = undefined;
+        }
+    }
+    reSubmitCore(content, localOpMetadata) {
+        const { commit: { revision }, } = this.messageCodec.decode(content);
+        const [commit] = this.editManager.findLocalCommit(revision);
+        this.submitCommit(commit);
+    }
+    applyStashedOp(content) {
+        (0, core_utils_1.assert)(!this.getLocalBranch().isTransacting(), 0x674 /* Unexpected transaction is open while applying stashed ops */);
+        const { commit: { revision, change }, } = this.messageCodec.decode(content);
+        this.submitOps = false;
+        this.editManager.localBranch.apply(change, revision);
+        this.submitOps = true;
+        return;
+    }
+    getGCData(fullGC) {
+        const gcNodes = super.getGCData(fullGC).gcNodes;
+        for (const s of this.summarizables) {
+            for (const [id, routes] of Object.entries(s.getGCData(fullGC).gcNodes)) {
+                gcNodes[id] ?? (gcNodes[id] = []);
+                for (const route of routes) {
+                    gcNodes[id].push(route);
+                }
+            }
+        }
+        return {
+            gcNodes,
+        };
+    }
+}
+exports.SharedTreeCore = SharedTreeCore;
+/**
+ * Compose an {@link IChannelStorageService} which prefixes all paths before forwarding them to the original service
+ */
+function scopeStorageService(service, ...pathElements) {
+    const scope = `${pathElements.join("/")}/`;
+    return {
+        async readBlob(path) {
+            return service.readBlob(`${scope}${path}`);
+        },
+        async contains(path) {
+            return service.contains(`${scope}${path}`);
+        },
+        async list(path) {
+            return service.list(`${scope}${path}`);
+        },
+    };
+}
+//# sourceMappingURL=sharedTreeCore.js.map

package/dist/shared-tree-core/sharedTreeCore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedTreeCore.js","sourceRoot":"","sources":["../../src/shared-tree-core/sharedTreeCore.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AAapD,iEAAmE;AACnE,2EAAoF;AAGpF,kCAA0E;AAC1E,qCAAkE;AAClE,mEAAgE;AAChE,+CAA2E;AAG3E,mDAAmD;AACnD,2DAAuD;AAEvD,qDAAqD;AACrD,MAAM,aAAa,GAAG,CAAC,CAAC;AACxB,yDAAyD;AACzD,MAAM,oBAAoB,GAAG,SAAS,CAAC;AAEvC;;;;;GAKG;AACH,MAAa,cAA4D,SAAQ,iCAAY;IAc5F;;;OAGG;IACH,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC;IACrC,CAAC;IAaD;;;;;;;;OAQG;IACH,YACC,aAAsC,EACtC,YAA4C,EAC5C,OAAsB;IACtB,uBAAuB;IACvB,EAAU,EACV,OAA+B,EAC/B,UAA8B,EAC9B,sBAA8B;QAE9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,sBAAsB,CAAC,CAAC;QAhDxD,yDAAyD;QACjD,cAAS,GAAG,IAAI,CAAC;QAEzB;;;;WAIG;QACK,qBAAgB,GAA0B,2CAA6B,CAAC;QA0C/E;;;;WAIG;QACH,gGAAgG;QAChG,MAAM,cAAc,GAAG,IAAA,uBAAgB,GAAE,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACjE,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;YACvD,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YACtB,QAAQ,IAAI,EAAE;gBACb,KAAK,QAAQ;oBACZ,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE;wBAChC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,aAAa,EAAE,EAAE;4BAC3C,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;yBACrB;qBACD;oBACD,MAAM;gBACP,KAAK,SAAS;oBACb,IAAI,IAAA,6BAAoB,EAAC,IAAI,CAAC,KAAK,mBAAmB,EAAE;wBACvD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,aAAa,EAAE,EAAE;4BAC3C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;yBACtC;qBACD;oBACD,MAAM;gBACP;oBACC,MAAM;aACP;QACF,CAAC,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,IAAI,oCAAgB,EAAE,CAAC;QAChD,IAAI,CAAC,aAAa,GAAG;YACpB,IAAI,6CAAqB,CAAC,IAAI,CAAC,WAAW,EAAE,gBAAgB,EAAE,OAAO,CAAC;YACtE,GAAG,aAAa;SAChB,CAAC;QACF,IAAA,mBAAM,EACL,IAAI,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,aAAa,CAAC,MAAM,EAChF,KAAK,CAAC,+CAA+C,CACrD,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG,IAAA,gCAAgB,EACnC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,EAC/C,IAAI,oCAAgB,EAAE,EACtB,OAAO,CACP,CAAC;IACH,CAAC;IAED,uGAAuG;IACvG,uFAAuF;IAC7E,aAAa,CACtB,UAA4B,EAC5B,gBAAoC,EACpC,yBAAkE;QAElE,MAAM,OAAO,GAAG,IAAI,kCAAkB,EAAE,CAAC;QACzC,MAAM,mBAAmB,GAAG,IAAI,kCAAkB,EAAE,CAAC;QACrD,gFAAgF;QAChF,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE;YACnC,mBAAmB,CAAC,YAAY,CAC/B,CAAC,CAAC,GAAG,EACL,CAAC,CAAC,gBAAgB,CACjB,CAAC,QAAQ,EAAE,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,EACzD,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,yBAAyB,CACzB,CACD,CAAC;SACF;QAED,OAAO,CAAC,YAAY,CAAC,oBAAoB,EAAE,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC;QACjF,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;IAES,KAAK,CAAC,QAAQ,CAAC,QAAgC;QACxD,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE,CACrE,cAAc,CAAC,IAAI,CAClB,mBAAmB,CAAC,QAAQ,EAAE,oBAAoB,EAAE,cAAc,CAAC,GAAG,CAAC,EACvE,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAC7C,CACD,CAAC;QAEF,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACK,YAAY,CAAC,MAA4B;QAChD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACpB,OAAO;SACP;QAED,8DAA8D;QAC9D,IAAA,mBAAM,EACL,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,aAAa,EAAE,EACtC,KAAK,CAAC,kDAAkD,CACxD,CAAC;QAEF,iGAAiG;QACjG,yDAAyD;QACzD,yGAAyG;QACzG,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE;YACxC,MAAM,WAAW,GAAc,IAAA,YAAK,EAAE,IAAI,CAAC,gBAA2B,GAAG,CAAC,CAAC,CAAC;YAC5E,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC;YACpC,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAClC,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,EACzD,WAAW,EACX,IAAI,CAAC,gBAAgB,CACrB,CAAC;SACF;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;YACxC,MAAM;YACN,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,cAAc;SAC1C,CAAC,CAAC;QACH,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACvE,CAAC;IAES,WAAW,CACpB,OAAkC,EAClC,KAAc,EACd,eAAwB;QAExB,MAAM,QAAQ,GAAY,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACnE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjE,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAClC,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,EACxB,IAAA,YAAK,EAAC,OAAO,CAAC,cAAc,CAAC,EAC7B,IAAA,YAAK,EAAC,OAAO,CAAC,uBAAuB,CAAC,CACtC,CAAC;QAEF,IAAI,CAAC,WAAW,CAAC,4BAA4B,CAAC,IAAA,YAAK,EAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACO,cAAc;QACvB,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;IACrC,CAAC;IAES,YAAY,KAAI,CAAC;IAER,SAAS;QAC3B,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE;YACxC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;SAClC;IACF,CAAC;IAEkB,YAAY,CAAC,OAA+B,EAAE,eAAwB;QACxF,MAAM,EACL,MAAM,EAAE,EAAE,QAAQ,EAAE,GACpB,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC5D,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAES,cAAc,CAAC,OAA+B;QACvD,IAAA,mBAAM,EACL,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,aAAa,EAAE,EACtC,KAAK,CAAC,+DAA+D,CACrE,CAAC;QACF,MAAM,EACL,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,GAC5B,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACrD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,OAAO;IACR,CAAC;IAEe,SAAS,CAAC,MAAgB;QACzC,MAAM,OAAO,GAAsC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;QACnF,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE;YACnC,KAAK,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE;gBACvE,OAAO,CAAC,EAAE,MAAV,OAAO,CAAC,EAAE,IAAM,EAAE,EAAC;gBACnB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;oBAC3B,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACxB;aACD;SACD;QAED,OAAO;YACN,OAAO;SACP,CAAC;IACH,CAAC;CACD;AAjPD,wCAiPC;AA6DD;;GAEG;AACH,SAAS,mBAAmB,CAC3B,OAA+B,EAC/B,GAAG,YAAsB;IAEzB,MAAM,KAAK,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAE3C,OAAO;QACN,KAAK,CAAC,QAAQ,CAAC,IAAY;YAC1B,OAAO,OAAO,CAAC,QAAQ,CAAC,GAAG,KAAK,GAAG,IAAI,EAAE,CAAC,CAAC;QAC5C,CAAC;QACD,KAAK,CAAC,QAAQ,CAAC,IAAI;YAClB,OAAO,OAAO,CAAC,QAAQ,CAAC,GAAG,KAAK,GAAG,IAAI,EAAE,CAAC,CAAC;QAC5C,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI;YACd,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,IAAI,EAAE,CAAC,CAAC;QACxC,CAAC;KACD,CAAC;AACH,CAAC","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\";\nimport {\n\tIChannelAttributes,\n\tIChannelStorageService,\n\tIFluidDataStoreRuntime,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n\tITelemetryContext,\n\tISummaryTreeWithStats,\n\tIGarbageCollectionData,\n\tIExperimentalIncrementalSummaryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { SummaryTreeBuilder } from \"@fluidframework/runtime-utils\";\nimport { IFluidSerializer, SharedObject } from \"@fluidframework/shared-object-base\";\nimport { ICodecOptions, IJsonCodec } from \"../codec\";\nimport { ChangeFamily, ChangeFamilyEditor, GraphCommit } from \"../core\";\nimport { brand, JsonCompatibleReadOnly, generateStableId } from \"../util\";\nimport { SharedTreeBranch, getChangeReplaceType } from \"./branch\";\nimport { EditManagerSummarizer } from \"./editManagerSummarizer\";\nimport { EditManager, minimumPossibleSequenceNumber } from \"./editManager\";\nimport { SeqNumber } from \"./editManagerFormat\";\nimport { DecodedMessage } from \"./messageTypes\";\nimport { makeMessageCodec } from \"./messageCodecs\";\nimport { RevisionTagCodec } from \"./revisionTagCodecs\";\n\n// TODO: How should the format version be determined?\nconst formatVersion = 0;\n// TODO: Organize this to be adjacent to persisted types.\nconst summarizablesTreeKey = \"indexes\";\n\n/**\n * Generic shared tree, which needs to be configured with indexes, field kinds and a history policy to be used.\n *\n * TODO: actually implement\n * TODO: is history policy a detail of what indexes are used, or is there something else to it?\n */\nexport class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange> extends SharedObject {\n\tprivate readonly editManager: EditManager<TEditor, TChange, ChangeFamily<TEditor, TChange>>;\n\tprivate readonly summarizables: readonly Summarizable[];\n\n\t/** Iff false, calls to `submitOp` will have no effect */\n\tprivate submitOps = true;\n\n\t/**\n\t * The sequence number that this instance is at.\n\t * This is number is artificial in that it is made up by this instance as opposed to being provided by the runtime.\n\t * Is `undefined` after (and only after) this instance is attached.\n\t */\n\tprivate detachedRevision: SeqNumber | undefined = minimumPossibleSequenceNumber;\n\n\t/**\n\t * Used to edit the state of the tree. Edits will be immediately applied locally to the tree.\n\t * If there is no transaction currently ongoing, then the edits will be submitted to Fluid immediately as well.\n\t */\n\tpublic get editor(): TEditor {\n\t\treturn this.getLocalBranch().editor;\n\t}\n\n\t/**\n\t * Used to encode/decode messages sent to/received from the Fluid runtime.\n\t *\n\t * @remarks Since there is currently only one format, this can just be cached on the class.\n\t * With more write formats active, it may make sense to keep around the \"usual\" format codec\n\t * (the one for the current persisted configuration) and resolve codecs for different versions\n\t * as necessary (e.g. an upgrade op came in, or the configuration changed within the collab window\n\t * and an op needs to be interpreted which isn't written with the current configuration).\n\t */\n\tprivate readonly messageCodec: IJsonCodec<DecodedMessage<TChange>, unknown>;\n\n\t/**\n\t * @param summarizables - Summarizers for all indexes used by this tree\n\t * @param changeFamily - The change family\n\t * @param editManager - The edit manager\n\t * @param id - The id of the shared object\n\t * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n\t * @param attributes - Attributes of the shared object\n\t * @param telemetryContextPrefix - the context for any telemetry logs/errors emitted\n\t */\n\tpublic constructor(\n\t\tsummarizables: readonly Summarizable[],\n\t\tchangeFamily: ChangeFamily<TEditor, TChange>,\n\t\toptions: ICodecOptions,\n\t\t// Base class arguments\n\t\tid: string,\n\t\truntime: IFluidDataStoreRuntime,\n\t\tattributes: IChannelAttributes,\n\t\ttelemetryContextPrefix: string,\n\t) {\n\t\tsuper(id, runtime, attributes, telemetryContextPrefix);\n\n\t\t/**\n\t\t * A random ID that uniquely identifies this client in the collab session.\n\t\t * This is sent alongside every op to identify which client the op originated from.\n\t\t * This is used rather than the Fluid client ID because the Fluid client ID is not stable across reconnections.\n\t\t */\n\t\t// TODO: Change this type to be the Session ID type provided by the IdCompressor when available.\n\t\tconst localSessionId = generateStableId();\n\t\tthis.editManager = new EditManager(changeFamily, localSessionId);\n\t\tthis.editManager.localBranch.on(\"afterChange\", (args) => {\n\t\t\tconst { type } = args;\n\t\t\tswitch (type) {\n\t\t\t\tcase \"append\":\n\t\t\t\t\tfor (const c of args.newCommits) {\n\t\t\t\t\t\tif (!this.getLocalBranch().isTransacting()) {\n\t\t\t\t\t\t\tthis.submitCommit(c);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\tcase \"replace\":\n\t\t\t\t\tif (getChangeReplaceType(args) === \"transactionCommit\") {\n\t\t\t\t\t\tif (!this.getLocalBranch().isTransacting()) {\n\t\t\t\t\t\t\tthis.submitCommit(args.newCommits[0]);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\tdefault:\n\t\t\t\t\tbreak;\n\t\t\t}\n\t\t});\n\n\t\tconst revisionTagCodec = new RevisionTagCodec();\n\t\tthis.summarizables = [\n\t\t\tnew EditManagerSummarizer(this.editManager, revisionTagCodec, options),\n\t\t\t...summarizables,\n\t\t];\n\t\tassert(\n\t\t\tnew Set(this.summarizables.map((e) => e.key)).size === this.summarizables.length,\n\t\t\t0x350 /* Index summary element keys must be unique */,\n\t\t);\n\n\t\tthis.messageCodec = makeMessageCodec(\n\t\t\tchangeFamily.codecs.resolve(formatVersion).json,\n\t\t\tnew RevisionTagCodec(),\n\t\t\toptions,\n\t\t);\n\t}\n\n\t// TODO: SharedObject's merging of the two summary methods into summarizeCore is not what we want here:\n\t// We might want to not subclass it, or override/reimplement most of its functionality.\n\tprotected summarizeCore(\n\t\tserializer: IFluidSerializer,\n\t\ttelemetryContext?: ITelemetryContext,\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext,\n\t): ISummaryTreeWithStats {\n\t\tconst builder = new SummaryTreeBuilder();\n\t\tconst summarizableBuilder = new SummaryTreeBuilder();\n\t\t// Merge the summaries of all summarizables together under a single ISummaryTree\n\t\tfor (const s of this.summarizables) {\n\t\t\tsummarizableBuilder.addWithStats(\n\t\t\t\ts.key,\n\t\t\t\ts.getAttachSummary(\n\t\t\t\t\t(contents) => serializer.stringify(contents, this.handle),\n\t\t\t\t\tundefined,\n\t\t\t\t\tundefined,\n\t\t\t\t\ttelemetryContext,\n\t\t\t\t\tincrementalSummaryContext,\n\t\t\t\t),\n\t\t\t);\n\t\t}\n\n\t\tbuilder.addWithStats(summarizablesTreeKey, summarizableBuilder.getSummaryTree());\n\t\treturn builder.getSummaryTree();\n\t}\n\n\tprotected async loadCore(services: IChannelStorageService): Promise<void> {\n\t\tconst loadSummaries = this.summarizables.map(async (summaryElement) =>\n\t\t\tsummaryElement.load(\n\t\t\t\tscopeStorageService(services, summarizablesTreeKey, summaryElement.key),\n\t\t\t\t(contents) => this.serializer.parse(contents),\n\t\t\t),\n\t\t);\n\n\t\tawait Promise.all(loadSummaries);\n\t}\n\n\t/**\n\t * Submits an op to the Fluid runtime containing the given commit\n\t * @param commit - the commit to submit\n\t */\n\tprivate submitCommit(commit: GraphCommit<TChange>): void {\n\t\tif (!this.submitOps) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Edits should not be submitted until all transactions finish\n\t\tassert(\n\t\t\t!this.getLocalBranch().isTransacting(),\n\t\t\t0x68b /* Unexpected edit submitted during transaction */,\n\t\t);\n\n\t\t// Edits submitted before the first attach are treated as sequenced because they will be included\n\t\t// in the attach summary that is uploaded to the service.\n\t\t// Until this attach workflow happens, this instance essentially behaves as a centralized data structure.\n\t\tif (this.detachedRevision !== undefined) {\n\t\t\tconst newRevision: SeqNumber = brand((this.detachedRevision as number) + 1);\n\t\t\tthis.detachedRevision = newRevision;\n\t\t\tthis.editManager.addSequencedChange(\n\t\t\t\t{ ...commit, sessionId: this.editManager.localSessionId },\n\t\t\t\tnewRevision,\n\t\t\t\tthis.detachedRevision,\n\t\t\t);\n\t\t}\n\t\tconst message = this.messageCodec.encode({\n\t\t\tcommit,\n\t\t\tsessionId: this.editManager.localSessionId,\n\t\t});\n\t\tthis.submitLocalMessage(this.serializer.encode(message, this.handle));\n\t}\n\n\tprotected processCore(\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t\tlocalOpMetadata: unknown,\n\t) {\n\t\tconst contents: unknown = this.serializer.decode(message.contents);\n\t\tconst { commit, sessionId } = this.messageCodec.decode(contents);\n\t\tthis.editManager.addSequencedChange(\n\t\t\t{ ...commit, sessionId },\n\t\t\tbrand(message.sequenceNumber),\n\t\t\tbrand(message.referenceSequenceNumber),\n\t\t);\n\n\t\tthis.editManager.advanceMinimumSequenceNumber(brand(message.minimumSequenceNumber));\n\t}\n\n\t/**\n\t * @returns the head commit of the root local branch\n\t */\n\tprotected getLocalBranch(): SharedTreeBranch<TEditor, TChange> {\n\t\treturn this.editManager.localBranch;\n\t}\n\n\tprotected onDisconnect() {}\n\n\tprotected override didAttach(): void {\n\t\tif (this.detachedRevision !== undefined) {\n\t\t\tthis.detachedRevision = undefined;\n\t\t}\n\t}\n\n\tprotected override reSubmitCore(content: JsonCompatibleReadOnly, localOpMetadata: unknown) {\n\t\tconst {\n\t\t\tcommit: { revision },\n\t\t} = this.messageCodec.decode(content);\n\t\tconst [commit] = this.editManager.findLocalCommit(revision);\n\t\tthis.submitCommit(commit);\n\t}\n\n\tprotected applyStashedOp(content: JsonCompatibleReadOnly): undefined {\n\t\tassert(\n\t\t\t!this.getLocalBranch().isTransacting(),\n\t\t\t0x674 /* Unexpected transaction is open while applying stashed ops */,\n\t\t);\n\t\tconst {\n\t\t\tcommit: { revision, change },\n\t\t} = this.messageCodec.decode(content);\n\t\tthis.submitOps = false;\n\t\tthis.editManager.localBranch.apply(change, revision);\n\t\tthis.submitOps = true;\n\t\treturn;\n\t}\n\n\tpublic override getGCData(fullGC?: boolean): IGarbageCollectionData {\n\t\tconst gcNodes: IGarbageCollectionData[\"gcNodes\"] = super.getGCData(fullGC).gcNodes;\n\t\tfor (const s of this.summarizables) {\n\t\t\tfor (const [id, routes] of Object.entries(s.getGCData(fullGC).gcNodes)) {\n\t\t\t\tgcNodes[id] ??= [];\n\t\t\t\tfor (const route of routes) {\n\t\t\t\t\tgcNodes[id].push(route);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn {\n\t\t\tgcNodes,\n\t\t};\n\t}\n}\n\n/**\n * Specifies the behavior of a component that puts data in a summary.\n */\nexport interface Summarizable {\n\t/**\n\t * Field name in summary json under which this element stores its data.\n\t */\n\treadonly key: string;\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n\t * @param stringify - Serializes the contents of the component (including {@link IFluidHandle}s) for storage.\n\t */\n\tgetAttachSummary(\n\t\tstringify: SummaryElementStringifier,\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext,\n\t): ISummaryTreeWithStats;\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n\t * @param stringify - Serializes the contents of the component (including {@link IFluidHandle}s) for storage.\n\t */\n\tsummarize(\n\t\tstringify: SummaryElementStringifier,\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): Promise<ISummaryTreeWithStats>;\n\n\t/**\n\t * {@inheritDoc (ISharedObject:interface).getGCData}\n\t */\n\t// TODO: Change this interface (and the one in ISharedObject, if necessary) to support \"handles within handles\".\n\t// Consider the case of a document with history; the return value here currently grows unboundedly.\n\tgetGCData(fullGC?: boolean): IGarbageCollectionData;\n\n\t/**\n\t * Allows the component to perform custom loading. The storage service is scoped to this component and therefore\n\t * paths in this component will not collide with those in other components, even if they are the same string.\n\t * @param service - Storage used by the component\n\t * @param parse - Parses serialized data from storage into runtime objects for the component\n\t */\n\tload(service: IChannelStorageService, parse: SummaryElementParser): Promise<void>;\n}\n\n/**\n * Serializes the given contents into a string acceptable for storing in summaries, i.e. all\n * Fluid handles have been replaced appropriately by an IFluidSerializer\n */\nexport type SummaryElementStringifier = (contents: unknown) => string;\n\n/**\n * Parses a serialized/summarized string into an object, rehydrating any Fluid handles as necessary\n */\nexport type SummaryElementParser = (contents: string) => unknown;\n\n/**\n * Compose an {@link IChannelStorageService} which prefixes all paths before forwarding them to the original service\n */\nfunction scopeStorageService(\n\tservice: IChannelStorageService,\n\t...pathElements: string[]\n): IChannelStorageService {\n\tconst scope = `${pathElements.join(\"/\")}/`;\n\n\treturn {\n\t\tasync readBlob(path: string): Promise<ArrayBufferLike> {\n\t\t\treturn service.readBlob(`${scope}${path}`);\n\t\t},\n\t\tasync contains(path) {\n\t\t\treturn service.contains(`${scope}${path}`);\n\t\t},\n\t\tasync list(path) {\n\t\t\treturn service.list(`${scope}${path}`);\n\t\t},\n\t};\n}\n"]}

package/dist/shared-tree-core/transactionStack.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { RevisionTag } from "../core";
+/**
+ * A helper class that organizes the state needed for managing nesting transactions.
+ */
+export declare class TransactionStack {
+    private readonly stack;
+    /**
+     * The number of transactions currently ongoing.
+     */
+    get size(): number;
+    /**
+     * Pushes a new transaction onto the stack. That transaction becomes the current transaction.
+     * @param startRevision - the revision of the latest commit when this transaction begins
+     * @param repairStore - an optional repair data store for helping with undo or rollback operations
+     * @param disposables - an optional collection of disposable data to release after finishing a transaction
+     */
+    push(startRevision: RevisionTag, dispose: () => void): void;
+    /**
+     * Ends the current transaction. Fails if there is currently no ongoing transaction.
+     * @returns The revision that the closed transaction began on, and its repair data store if it has one.
+     */
+    pop(): {
+        startRevision: RevisionTag;
+    };
+}
+//# sourceMappingURL=transactionStack.d.ts.map

package/dist/shared-tree-core/transactionStack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionStack.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/transactionStack.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;GAEG;AACH,qBAAa,gBAAgB;IAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAGb;IAET;;OAEG;IACH,IAAW,IAAI,WAEd;IAED;;;;;OAKG;IACI,IAAI,CAAC,aAAa,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,IAAI,GAAG,IAAI;IAIlE;;;OAGG;IACI,GAAG,IAAI;QACb,aAAa,EAAE,WAAW,CAAC;KAC3B;CAKD"}

package/dist/shared-tree-core/transactionStack.js

@@ -0,0 +1,42 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionStack = void 0;
+const util_1 = require("../util");
+/**
+ * A helper class that organizes the state needed for managing nesting transactions.
+ */
+class TransactionStack {
+    constructor() {
+        this.stack = [];
+    }
+    /**
+     * The number of transactions currently ongoing.
+     */
+    get size() {
+        return this.stack.length;
+    }
+    /**
+     * Pushes a new transaction onto the stack. That transaction becomes the current transaction.
+     * @param startRevision - the revision of the latest commit when this transaction begins
+     * @param repairStore - an optional repair data store for helping with undo or rollback operations
+     * @param disposables - an optional collection of disposable data to release after finishing a transaction
+     */
+    push(startRevision, dispose) {
+        this.stack.push({ startRevision, dispose });
+    }
+    /**
+     * Ends the current transaction. Fails if there is currently no ongoing transaction.
+     * @returns The revision that the closed transaction began on, and its repair data store if it has one.
+     */
+    pop() {
+        const transaction = this.stack.pop() ?? (0, util_1.fail)("No transaction is currently in progress");
+        transaction.dispose();
+        return transaction;
+    }
+}
+exports.TransactionStack = TransactionStack;
+//# sourceMappingURL=transactionStack.js.map

package/dist/shared-tree-core/transactionStack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionStack.js","sourceRoot":"","sources":["../../src/shared-tree-core/transactionStack.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,kCAA+B;AAE/B;;GAEG;AACH,MAAa,gBAAgB;IAA7B;QACkB,UAAK,GAGhB,EAAE,CAAC;IA8BV,CAAC;IA5BA;;OAEG;IACH,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,aAA0B,EAAE,OAAmB;QAC1D,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,GAAG;QAGT,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,IAAA,WAAI,EAAC,yCAAyC,CAAC,CAAC;QACxF,WAAW,CAAC,OAAO,EAAE,CAAC;QACtB,OAAO,WAAW,CAAC;IACpB,CAAC;CACD;AAlCD,4CAkCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { RevisionTag } from \"../core\";\nimport { fail } from \"../util\";\n\n/**\n * A helper class that organizes the state needed for managing nesting transactions.\n */\nexport class TransactionStack {\n\tprivate readonly stack: {\n\t\tstartRevision: RevisionTag;\n\t\tdispose: () => void;\n\t}[] = [];\n\n\t/**\n\t * The number of transactions currently ongoing.\n\t */\n\tpublic get size() {\n\t\treturn this.stack.length;\n\t}\n\n\t/**\n\t * Pushes a new transaction onto the stack. That transaction becomes the current transaction.\n\t * @param startRevision - the revision of the latest commit when this transaction begins\n\t * @param repairStore - an optional repair data store for helping with undo or rollback operations\n\t * @param disposables - an optional collection of disposable data to release after finishing a transaction\n\t */\n\tpublic push(startRevision: RevisionTag, dispose: () => void): void {\n\t\tthis.stack.push({ startRevision, dispose });\n\t}\n\n\t/**\n\t * Ends the current transaction. Fails if there is currently no ongoing transaction.\n\t * @returns The revision that the closed transaction began on, and its repair data store if it has one.\n\t */\n\tpublic pop(): {\n\t\tstartRevision: RevisionTag;\n\t} {\n\t\tconst transaction = this.stack.pop() ?? fail(\"No transaction is currently in progress\");\n\t\ttransaction.dispose();\n\t\treturn transaction;\n\t}\n}\n"]}

package/dist/simple-tree/flexNode.d.ts

@@ -0,0 +1,34 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ObjectNodeSchema, AllowedTypes, FieldNodeSchema, MapNodeSchema, FlexTreeNode, FlexTreeObjectNode, FlexTreeFieldNode, FlexTreeMapNode } from "../feature-libraries";
+import { TreeObjectNode, TreeMapNode, TreeNode } from "./types";
+import { TreeListNodeOld } from "./treeListNode";
+/**
+ * Retrieves the flex node associated with the given target via {@link setFlexNode}.
+ * @remarks Fails if the flex node has not been set.
+ */
+export declare function getFlexNode<TSchema extends ObjectNodeSchema>(target: TreeObjectNode<TSchema>): FlexTreeObjectNode;
+export declare function getFlexNode<TTypes extends AllowedTypes>(target: TreeListNodeOld<TTypes>): FlexTreeFieldNode<FieldNodeSchema>;
+export declare function getFlexNode<TSchema extends MapNodeSchema>(target: TreeMapNode<TSchema>): FlexTreeMapNode<TSchema>;
+export declare function getFlexNode(target: TreeNode): FlexTreeNode;
+/**
+ * Retrieves the flex node associated with the given target via {@link setFlexNode}, if any.
+ */
+export declare function tryGetFlexNode(target: unknown): FlexTreeNode | undefined;
+/**
+ * Retrieves the target associated with the given flex node via {@link setFlexNode}, if any.
+ */
+export declare function tryGetFlexNodeTarget(flexNode: FlexTreeNode): TreeNode | undefined;
+/**
+ * Associate the given target object and the given flex node.
+ * @returns The target object
+ * @remarks
+ * This creates a 1:1 mapping between the target and tree node.
+ * Either can be retrieved from the other via {@link getFlexNode}/{@link tryGetFlexNode} or {@link tryGetFlexNodeTarget}.
+ * If the given target is already mapped to an flex node, the existing mapping will be overwritten.
+ * If the given flex node is already mapped to a different target, this function will fail.
+ */
+export declare function setFlexNode<T extends TreeNode>(target: T, flexNode: FlexTreeNode): T;
+//# sourceMappingURL=flexNode.d.ts.map

package/dist/simple-tree/flexNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flexNode.d.ts","sourceRoot":"","sources":["../../src/simple-tree/flexNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACN,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,EACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAgBjD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,OAAO,SAAS,gBAAgB,EAC3D,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,GAC7B,kBAAkB,CAAC;AACtB,wBAAgB,WAAW,CAAC,MAAM,SAAS,YAAY,EACtD,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,GAC7B,iBAAiB,CAAC,eAAe,CAAC,CAAC;AACtC,wBAAgB,WAAW,CAAC,OAAO,SAAS,aAAa,EACxD,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,GAC1B,eAAe,CAAC,OAAO,CAAC,CAAC;AAC5B,wBAAgB,WAAW,CAAC,MAAM,EAAE,QAAQ,GAAG,YAAY,CAAC;AAK5D;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,YAAY,GAAG,SAAS,CAKxE;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,YAAY,GAAG,QAAQ,GAAG,SAAS,CAEjF;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,YAAY,GAAG,CAAC,CASpF"}

package/dist/simple-tree/flexNode.js

@@ -0,0 +1,57 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setFlexNode = exports.tryGetFlexNodeTarget = exports.tryGetFlexNode = exports.getFlexNode = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const util_1 = require("../util");
+/** Associates an FlexTreeNode with a target object  */
+const targetSymbol = Symbol("FlexNodeTarget");
+/**
+ * This is intentionally a WeakMap, rather than a private symbol (e.g. like `targetSymbol`).
+ * The map behaves essentially the same, except that performing a lookup in the map will not perform a property read/get on the key object (as is the case with a symbol).
+ * Since `SharedTreeNodes` are proxies with non-trivial `get` traps, this choice is meant to prevent the confusion of the lookup passing through multiple objects
+ * via the trap, or the trap not properly handling the special symbol, etc.
+ */
+const flexNodeMap = new WeakMap();
+function getFlexNode(target) {
+    return flexNodeMap.get(target) ?? (0, util_1.fail)("Target is not associated with an flex node");
+}
+exports.getFlexNode = getFlexNode;
+/**
+ * Retrieves the flex node associated with the given target via {@link setFlexNode}, if any.
+ */
+function tryGetFlexNode(target) {
+    if (typeof target === "object" && target !== null) {
+        return flexNodeMap.get(target);
+    }
+    return undefined;
+}
+exports.tryGetFlexNode = tryGetFlexNode;
+/**
+ * Retrieves the target associated with the given flex node via {@link setFlexNode}, if any.
+ */
+function tryGetFlexNodeTarget(flexNode) {
+    return flexNode[targetSymbol];
+}
+exports.tryGetFlexNodeTarget = tryGetFlexNodeTarget;
+/**
+ * Associate the given target object and the given flex node.
+ * @returns The target object
+ * @remarks
+ * This creates a 1:1 mapping between the target and tree node.
+ * Either can be retrieved from the other via {@link getFlexNode}/{@link tryGetFlexNode} or {@link tryGetFlexNodeTarget}.
+ * If the given target is already mapped to an flex node, the existing mapping will be overwritten.
+ * If the given flex node is already mapped to a different target, this function will fail.
+ */
+function setFlexNode(target, flexNode) {
+    (0, core_utils_1.assert)(tryGetFlexNodeTarget(flexNode) === undefined, 0x7f5 /* Cannot associate an flex node with multiple targets */);
+    delete flexNodeMap.get(target)?.[targetSymbol];
+    flexNodeMap.set(target, flexNode);
+    Object.defineProperty(flexNode, targetSymbol, { value: target, configurable: true });
+    return target;
+}
+exports.setFlexNode = setFlexNode;
+//# sourceMappingURL=flexNode.js.map

package/dist/simple-tree/flexNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flexNode.js","sourceRoot":"","sources":["../../src/simple-tree/flexNode.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AACpD,kCAA+B;AAc/B,uDAAuD;AACvD,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAK9C;;;;;GAKG;AACH,MAAM,WAAW,GAAG,IAAI,OAAO,EAA0B,CAAC;AAgB1D,SAAgB,WAAW,CAAC,MAAgB;IAC3C,OAAO,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,IAAA,WAAI,EAAC,4CAA4C,CAAC,CAAC;AACtF,CAAC;AAFD,kCAEC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,MAAe;IAC7C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE;QAClD,OAAO,WAAW,CAAC,GAAG,CAAC,MAAkB,CAAC,CAAC;KAC3C;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AALD,wCAKC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAAC,QAAsB;IAC1D,OAAQ,QAA+B,CAAC,YAAY,CAAC,CAAC;AACvD,CAAC;AAFD,oDAEC;AAED;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAAqB,MAAS,EAAE,QAAsB;IAChF,IAAA,mBAAM,EACL,oBAAoB,CAAC,QAAQ,CAAC,KAAK,SAAS,EAC5C,KAAK,CAAC,yDAAyD,CAC/D,CAAC;IACF,OAAQ,WAAW,CAAC,GAAG,CAAC,MAAM,CAAwB,EAAE,CAAC,YAAY,CAAC,CAAC;IACvE,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAClC,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;IACrF,OAAO,MAAM,CAAC;AACf,CAAC;AATD,kCASC","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\";\nimport { fail } from \"../util\";\nimport {\n\tObjectNodeSchema,\n\tAllowedTypes,\n\tFieldNodeSchema,\n\tMapNodeSchema,\n\tFlexTreeNode,\n\tFlexTreeObjectNode,\n\tFlexTreeFieldNode,\n\tFlexTreeMapNode,\n} from \"../feature-libraries\";\nimport { TreeObjectNode, TreeMapNode, TreeNode } from \"./types\";\nimport { TreeListNodeOld } from \"./treeListNode\";\n\n/** Associates an FlexTreeNode with a target object  */\nconst targetSymbol = Symbol(\"FlexNodeTarget\");\ninterface HasTarget {\n\t[targetSymbol]: TreeNode;\n}\n\n/**\n * This is intentionally a WeakMap, rather than a private symbol (e.g. like `targetSymbol`).\n * The map behaves essentially the same, except that performing a lookup in the map will not perform a property read/get on the key object (as is the case with a symbol).\n * Since `SharedTreeNodes` are proxies with non-trivial `get` traps, this choice is meant to prevent the confusion of the lookup passing through multiple objects\n * via the trap, or the trap not properly handling the special symbol, etc.\n */\nconst flexNodeMap = new WeakMap<TreeNode, FlexTreeNode>();\n\n/**\n * Retrieves the flex node associated with the given target via {@link setFlexNode}.\n * @remarks Fails if the flex node has not been set.\n */\nexport function getFlexNode<TSchema extends ObjectNodeSchema>(\n\ttarget: TreeObjectNode<TSchema>,\n): FlexTreeObjectNode;\nexport function getFlexNode<TTypes extends AllowedTypes>(\n\ttarget: TreeListNodeOld<TTypes>,\n): FlexTreeFieldNode<FieldNodeSchema>;\nexport function getFlexNode<TSchema extends MapNodeSchema>(\n\ttarget: TreeMapNode<TSchema>,\n): FlexTreeMapNode<TSchema>;\nexport function getFlexNode(target: TreeNode): FlexTreeNode;\nexport function getFlexNode(target: TreeNode): FlexTreeNode {\n\treturn flexNodeMap.get(target) ?? fail(\"Target is not associated with an flex node\");\n}\n\n/**\n * Retrieves the flex node associated with the given target via {@link setFlexNode}, if any.\n */\nexport function tryGetFlexNode(target: unknown): FlexTreeNode | undefined {\n\tif (typeof target === \"object\" && target !== null) {\n\t\treturn flexNodeMap.get(target as TreeNode);\n\t}\n\treturn undefined;\n}\n\n/**\n * Retrieves the target associated with the given flex node via {@link setFlexNode}, if any.\n */\nexport function tryGetFlexNodeTarget(flexNode: FlexTreeNode): TreeNode | undefined {\n\treturn (flexNode as Partial<HasTarget>)[targetSymbol];\n}\n\n/**\n * Associate the given target object and the given flex node.\n * @returns The target object\n * @remarks\n * This creates a 1:1 mapping between the target and tree node.\n * Either can be retrieved from the other via {@link getFlexNode}/{@link tryGetFlexNode} or {@link tryGetFlexNodeTarget}.\n * If the given target is already mapped to an flex node, the existing mapping will be overwritten.\n * If the given flex node is already mapped to a different target, this function will fail.\n */\nexport function setFlexNode<T extends TreeNode>(target: T, flexNode: FlexTreeNode): T {\n\tassert(\n\t\ttryGetFlexNodeTarget(flexNode) === undefined,\n\t\t0x7f5 /* Cannot associate an flex node with multiple targets */,\n\t);\n\tdelete (flexNodeMap.get(target) as Partial<HasTarget>)?.[targetSymbol];\n\tflexNodeMap.set(target, flexNode);\n\tObject.defineProperty(flexNode, targetSymbol, { value: target, configurable: true });\n\treturn target;\n}\n"]}

package/dist/simple-tree/index.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { getProxyForField } from "./proxies";
+export { TreeObjectNodeFields, TreeField, TreeFieldInner, TypedNode, TreeNodeUnion, TreeMapNode, TreeObjectNode, TreeNode, Unhydrated, TreeArrayNodeBase, TreeMapNodeBase, } from "./types";
+export { TreeListNodeOld, TreeArrayNode, IterableTreeListContent } from "./treeListNode";
+export { TreeObjectFactory, FactoryTreeSchema, addFactory } from "./objectFactory";
+export { InsertableTreeRoot, InsertableTreeField, InsertableTreeFieldInner, InsertableTreeNodeUnion, InsertableTreeObjectNode, InsertableTreeObjectNodeFields, InsertableTypedNode, } from "./insertable";
+//# sourceMappingURL=index.d.ts.map

package/dist/simple-tree/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/simple-tree/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EACN,oBAAoB,EACpB,SAAS,EACT,cAAc,EACd,SAAS,EACT,aAAa,EACb,WAAW,EACX,cAAc,EACd,QAAQ,EACR,UAAU,EACV,iBAAiB,EACjB,eAAe,GACf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AACzF,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACnF,OAAO,EACN,kBAAkB,EAClB,mBAAmB,EACnB,wBAAwB,EACxB,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,mBAAmB,GACnB,MAAM,cAAc,CAAC"}